Class TMP_Dropdown

Inheritance

object

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.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.OnDestroy()

UIBehaviour.IsActive()

UIBehaviour.OnRectTransformDimensionsChange()

UIBehaviour.OnBeforeTransformParentChanged()

UIBehaviour.OnCanvasHierarchyChanged()

UIBehaviour.IsDestroyed()

Namespace: TMPro

Assembly: solution.dll

Syntax

[AddComponentMenu("UI/Dropdown - TextMeshPro", 35)]
[RequireComponent(typeof(RectTransform))]
public class TMP_Dropdown : Selectable, IMoveHandler, IPointerDownHandler, IPointerUpHandler, IPointerEnterHandler, IPointerExitHandler, ISelectHandler, IDeselectHandler, IPointerClickHandler, ISubmitHandler, ICancelHandler, IEventSystemHandler

Constructors

Name	Description
TMP_Dropdown()

Properties

Name	Description
IsExpanded
alphaFadeSpeed	The time interval at which a drop down will appear and disappear
captionImage	The Image component to hold the image of the currently selected option.
captionText	The Text component to hold the text of the currently selected option.
itemImage	The Image component to hold the image of the item
itemText	The Text component to hold the text of the item.
onValueChanged
options
placeholder	The placeholder Graphic component. Shown when no option is selected.
template	The Rect Transform of the template for the dropdown list.
value

Methods

Name	Description
AddOptions(List<string>)
AddOptions(List<OptionData>)
AddOptions(List<Sprite>)
Awake()
ClearOptions()	Clear the list of options in the Dropdown.
CreateBlocker(Canvas)	Create a blocker that blocks clicks to other controls while the dropdown list is open.
CreateDropdownList(GameObject)	Create the dropdown list to be shown when the dropdown is clicked. The dropdown list should correspond to the provided template GameObject, equivalent to instantiating a copy of it.
CreateItem(DropdownItem)	Create a dropdown item based upon the item template.
DestroyBlocker(GameObject)	Convenience method to explicitly destroy the previously generated blocker object
DestroyDropdownList(GameObject)	Convenience method to explicitly destroy the previously generated dropdown list
DestroyItem(DropdownItem)	Convenience method to explicitly destroy the previously generated Items.
Hide()	Hide the dropdown list. I.e. close it.
OnCancel(BaseEventData)	This will hide the dropdown list.
OnDisable()
OnPointerClick(PointerEventData)	Handling for when the dropdown is initially 'clicked'. Typically shows the dropdown
OnSubmit(BaseEventData)	Handling for when the dropdown is selected and a submit event is processed. Typically shows the dropdown
RefreshShownValue()	Refreshes the text and image (if available) of the currently selected option.
SetValueWithoutNotify(int)	Set index number of the current selection in the Dropdown without invoking onValueChanged callback.
Show()	Show the dropdown. Plan for dropdown scrolling to ensure dropdown is contained within screen. We assume the Canvas is the screen that the dropdown must be kept inside. This is always valid for screen space canvas modes. For world space canvases we don't know how it's used, but it could be e.g. for an in-game monitor. We consider it a fair constraint that the canvas must be big enough to contain dropdowns.
Start()