Show / Hide Table of Contents

Class TMP_Dropdown

Inheritance
object
Object
Component
Behaviour
MonoBehaviour
UIBehaviour
Selectable
TMP_Dropdown
Implements
IMoveHandler
IPointerDownHandler
IPointerUpHandler
IPointerEnterHandler
IPointerExitHandler
ISelectHandler
IDeselectHandler
IPointerClickHandler
ISubmitHandler
ICancelHandler
IEventSystemHandler
Inherited Members
Selectable.s_Selectables
Selectable.s_SelectableCount
Selectable.m_CurrentIndex
Selectable.AllSelectablesNoAlloc(Selectable[])
Selectable.OnCanvasGroupChanged()
Selectable.IsInteractable()
Selectable.OnDidApplyAnimationProperties()
Selectable.OnEnable()
Selectable.OnTransformParentChanged()
Selectable.OnDisable()
Selectable.OnValidate()
Selectable.Reset()
Selectable.InstantClearState()
Selectable.DoStateTransition(Selectable.SelectionState, bool)
Selectable.FindSelectable(Vector3)
Selectable.FindSelectableOnLeft()
Selectable.FindSelectableOnRight()
Selectable.FindSelectableOnUp()
Selectable.FindSelectableOnDown()
Selectable.OnMove(AxisEventData)
Selectable.IsHighlighted()
Selectable.IsPressed()
Selectable.OnPointerDown(PointerEventData)
Selectable.OnPointerUp(PointerEventData)
Selectable.OnPointerEnter(PointerEventData)
Selectable.OnPointerExit(PointerEventData)
Selectable.OnSelect(BaseEventData)
Selectable.OnDeselect(BaseEventData)
Selectable.Select()
Selectable.allSelectablesArray
Selectable.allSelectableCount
Selectable.allSelectables
Selectable.navigation
Selectable.transition
Selectable.colors
Selectable.spriteState
Selectable.animationTriggers
Selectable.targetGraphic
Selectable.interactable
Selectable.image
Selectable.animator
Selectable.currentSelectionState
UIBehaviour.Start()
UIBehaviour.OnDestroy()
UIBehaviour.IsActive()
UIBehaviour.OnRectTransformDimensionsChange()
UIBehaviour.OnBeforeTransformParentChanged()
UIBehaviour.OnCanvasHierarchyChanged()
UIBehaviour.IsDestroyed()
Namespace: TMPro
Assembly: HollowKnight.dll
Syntax
[AddComponentMenu("UI/TMP Dropdown", 35)]
[RequireComponent(typeof(RectTransform))]
public class TMP_Dropdown : Selectable, IMoveHandler, IPointerDownHandler, IPointerUpHandler, IPointerEnterHandler, IPointerExitHandler, ISelectHandler, IDeselectHandler, IPointerClickHandler, ISubmitHandler, ICancelHandler, IEventSystemHandler

Constructors

| Edit this page View Source

TMP_Dropdown()

Declaration
protected TMP_Dropdown()

Properties

| Edit this page View Source

IsExpanded

Declaration
public bool IsExpanded { get; }
Property Value
Type Description
bool
| Edit this page View Source

captionImage

Declaration
public Image captionImage { get; set; }
Property Value
Type Description
Image
| Edit this page View Source

captionText

Declaration
public TMP_Text captionText { get; set; }
Property Value
Type Description
TMP_Text
| Edit this page View Source

itemImage

Declaration
public Image itemImage { get; set; }
Property Value
Type Description
Image
| Edit this page View Source

itemText

Declaration
public TMP_Text itemText { get; set; }
Property Value
Type Description
TMP_Text
| Edit this page View Source

onValueChanged

Declaration
public TMP_Dropdown.DropdownEvent onValueChanged { get; set; }
Property Value
Type Description
TMP_Dropdown.DropdownEvent
| Edit this page View Source

options

Declaration
public List<TMP_Dropdown.OptionData> options { get; set; }
Property Value
Type Description
List<TMP_Dropdown.OptionData>
| Edit this page View Source

template

Declaration
public RectTransform template { get; set; }
Property Value
Type Description
RectTransform
| Edit this page View Source

value

Declaration
public int value { get; set; }
Property Value
Type Description
int

Methods

| Edit this page View Source

AddOptions(List<string>)

Declaration
public void AddOptions(List<string> options)
Parameters
Type Name Description
List<string> options
| Edit this page View Source

AddOptions(List<OptionData>)

Declaration
public void AddOptions(List<TMP_Dropdown.OptionData> options)
Parameters
Type Name Description
List<TMP_Dropdown.OptionData> options
| Edit this page View Source

AddOptions(List<Sprite>)

Declaration
public void AddOptions(List<Sprite> options)
Parameters
Type Name Description
List<Sprite> options
| Edit this page View Source

Awake()

Declaration
protected override void Awake()
Overrides
UnityEngine.UI.Selectable.Awake()
| Edit this page View Source

ClearOptions()

Declaration
public void ClearOptions()
| Edit this page View Source

CreateBlocker(Canvas)

Declaration
protected virtual GameObject CreateBlocker(Canvas rootCanvas)
Parameters
Type Name Description
Canvas rootCanvas
Returns
Type Description
GameObject
| Edit this page View Source

CreateDropdownList(GameObject)

Declaration
protected virtual GameObject CreateDropdownList(GameObject template)
Parameters
Type Name Description
GameObject template
Returns
Type Description
GameObject
| Edit this page View Source

CreateItem(DropdownItem)

Declaration
protected virtual TMP_Dropdown.DropdownItem CreateItem(TMP_Dropdown.DropdownItem itemTemplate)
Parameters
Type Name Description
TMP_Dropdown.DropdownItem itemTemplate
Returns
Type Description
TMP_Dropdown.DropdownItem
| Edit this page View Source

DestroyBlocker(GameObject)

Declaration
protected virtual void DestroyBlocker(GameObject blocker)
Parameters
Type Name Description
GameObject blocker
| Edit this page View Source

DestroyDropdownList(GameObject)

Declaration
protected virtual void DestroyDropdownList(GameObject dropdownList)
Parameters
Type Name Description
GameObject dropdownList
| Edit this page View Source

DestroyItem(DropdownItem)

Declaration
protected virtual void DestroyItem(TMP_Dropdown.DropdownItem item)
Parameters
Type Name Description
TMP_Dropdown.DropdownItem item
| Edit this page View Source

Hide()

Declaration
public void Hide()
| Edit this page View Source

OnCancel(BaseEventData)

Declaration
public virtual void OnCancel(BaseEventData eventData)
Parameters
Type Name Description
BaseEventData eventData
| Edit this page View Source

OnPointerClick(PointerEventData)

Declaration
public virtual void OnPointerClick(PointerEventData eventData)
Parameters
Type Name Description
PointerEventData eventData
| Edit this page View Source

OnSubmit(BaseEventData)

Declaration
public virtual void OnSubmit(BaseEventData eventData)
Parameters
Type Name Description
BaseEventData eventData
| Edit this page View Source

RefreshShownValue()

Declaration
public void RefreshShownValue()
| Edit this page View Source

Show()

Declaration
public void Show()

Implements

UnityEngine.EventSystems.IMoveHandler
UnityEngine.EventSystems.IPointerDownHandler
UnityEngine.EventSystems.IPointerUpHandler
UnityEngine.EventSystems.IPointerEnterHandler
UnityEngine.EventSystems.IPointerExitHandler
UnityEngine.EventSystems.ISelectHandler
UnityEngine.EventSystems.IDeselectHandler
UnityEngine.EventSystems.IPointerClickHandler
UnityEngine.EventSystems.ISubmitHandler
UnityEngine.EventSystems.ICancelHandler
UnityEngine.EventSystems.IEventSystemHandler

Extension Methods

ReflectionUtilities.ReflectCallMethod(object, string, object[], BindingFlags)
ReflectionUtilities.ReflectGetField(object, string, BindingFlags)
ReflectionUtilities.ReflectGetMethod(object, string, BindingFlags)
ReflectionUtilities.ReflectGetProperty(object, string, BindingFlags)
ReflectionUtilities.ReflectSetField(object, string, object, BindingFlags)
ReflectionUtilities.ReflectSetProperty(object, string, object, BindingFlags)
CoroutineUtilities.RunCoroutineWhile<T>(T, IEnumerator, Func<bool>)
Extensions.GetFirstInteractable(Selectable)
  • Edit this page
  • View Source
☀
☾
In this article
Back to top
Generated by DocFX
☀
☾