Class TMP_Dropdown

Inheritance

Object

TMP_Dropdown

Namespace: TMPro

Syntax

public class TMP_Dropdown : Selectable, IPointerClickHandler, ISubmitHandler, ICancelHandler

Constructors

TMP_Dropdown()

Declaration

protected TMP_Dropdown()

Properties

captionImage

Declaration

public Image captionImage { get; set; }

Property Value

Type	Description
Image

captionText

Declaration

public TMP_Text captionText { get; set; }

Property Value

Type	Description
TMP_Text

IsExpanded

Declaration

public bool IsExpanded { get; }

Property Value

Type	Description
Boolean

itemImage

Declaration

public Image itemImage { get; set; }

Property Value

Type	Description
Image

itemText

Declaration

public TMP_Text itemText { get; set; }

Property Value

Type	Description
TMP_Text

onValueChanged

Declaration

public TMP_Dropdown.DropdownEvent onValueChanged { get; set; }

Property Value

Type	Description
TMP_Dropdown.DropdownEvent

options

Declaration

public List<TMP_Dropdown.OptionData> options { get; set; }

Property Value

Type	Description
List<TMP_Dropdown.OptionData>

template

Declaration

public RectTransform template { get; set; }

Property Value

Type	Description
RectTransform

value

Declaration

public int value { get; set; }

Property Value

Type	Description
Int32

Methods

AddOptions(List<Sprite>)

Declaration

public void AddOptions(List<Sprite> options)

Parameters

Type	Name	Description
List<Sprite>	options

AddOptions(List<String>)

Declaration

public void AddOptions(List<string> options)

Parameters

Type	Name	Description
List<String>	options

AddOptions(List<TMP_Dropdown.OptionData>)

Declaration

public void AddOptions(List<TMP_Dropdown.OptionData> options)

Parameters

Type	Name	Description
List<TMP_Dropdown.OptionData>	options

Awake()

Declaration

protected override void Awake()

ClearOptions()

Declaration

public void ClearOptions()

CreateBlocker(Canvas)

Declaration

protected virtual GameObject CreateBlocker(Canvas rootCanvas)

Parameters

Type	Name	Description
Canvas	rootCanvas

Returns

Type	Description
GameObject

CreateDropdownList(GameObject)

Declaration

protected virtual GameObject CreateDropdownList(GameObject template)

Parameters

Type	Name	Description
GameObject	template

Returns

Type	Description
GameObject

CreateItem(TMP_Dropdown.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

DestroyBlocker(GameObject)

Declaration

protected virtual void DestroyBlocker(GameObject blocker)

Parameters

Type	Name	Description
GameObject	blocker

DestroyDropdownList(GameObject)

Declaration

protected virtual void DestroyDropdownList(GameObject dropdownList)

Parameters

Type	Name	Description
GameObject	dropdownList

DestroyItem(TMP_Dropdown.DropdownItem)

Declaration

protected virtual void DestroyItem(TMP_Dropdown.DropdownItem item)

Parameters

Type	Name	Description
TMP_Dropdown.DropdownItem	item

Hide()

Declaration

public void Hide()

OnCancel(BaseEventData)

Declaration

public virtual void OnCancel(BaseEventData eventData)

Parameters

Type	Name	Description
BaseEventData	eventData

OnPointerClick(PointerEventData)

Declaration

public virtual void OnPointerClick(PointerEventData eventData)

Parameters

Type	Name	Description
PointerEventData	eventData

OnSubmit(BaseEventData)

Declaration

public virtual void OnSubmit(BaseEventData eventData)

Parameters

Type	Name	Description
BaseEventData	eventData

RefreshShownValue()

Declaration

public void RefreshShownValue()

Show()

Declaration

public void Show()