Class TMP_Dropdown
Namespace: TMPro
Syntax
public class TMP_Dropdown : Selectable, IPointerClickHandler, ISubmitHandler, ICancelHandler
Constructors
TMP_Dropdown()
Declaration
Properties
captionImage
Declaration
public Image captionImage { get; set; }
Property Value
captionText
Declaration
public TMP_Text captionText { get; set; }
Property Value
IsExpanded
Declaration
public bool IsExpanded { get; }
Property Value
itemImage
Declaration
public Image itemImage { get; set; }
Property Value
itemText
Declaration
public TMP_Text itemText { get; set; }
Property Value
onValueChanged
Declaration
public TMP_Dropdown.DropdownEvent onValueChanged { get; set; }
Property Value
options
Declaration
public List<TMP_Dropdown.OptionData> options { get; set; }
Property Value
template
Declaration
public RectTransform template { get; set; }
Property Value
| Type |
Description |
| RectTransform |
|
value
Declaration
public int value { get; set; }
Property Value
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
AddOptions(List<TMP_Dropdown.OptionData>)
Declaration
public void AddOptions(List<TMP_Dropdown.OptionData> options)
Parameters
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
Returns
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
Hide()
Declaration
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
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.