API
Return to top
Dropdown
编辑

界面 / Dropdown

Dropdown Class
​

Dropdown

Hierarchy ​

Table of contents ​

Properties
​

click

Properties
​

onCustomPropertyChange: Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client
监听自定义属性同步事件

Accessors
​

defaultFont(): string UIFontFamily client
获取默认字体
dropdownStyle(): DropdownStyle client
菜单样式
fallbackFont(): string UIFontFamily client
获取退却字体
glyph(): UIFontGlyph client
获取字体字形
isOpened(): boolean client
获取菜单是否打开
menuRowStyle(): ListItemStyle client
ListItemStyle样式
onOpeningEvent(): MulticastDelegate<() => void> client
打开下拉菜单前触发事件
onSelectionChangedEvent(): MulticastDelegate<(item: string, select: SelectInfo) => void> client
选中改动事件
optionCount(): number client
获取菜单项数量
options(): string[] client
获取所有菜单项
scrollbarStyle(): ScrollbarStyle client
滚动条样式
selectedOption(): string client
获取当前选中项
selectedOptionIndex(): number client
获取选中项下拉索引
textStyle(): TextStyle client
文本样式
click

Accessors
​

alignPosition(): Readonly<Vector2> client
获取控件的对齐位置,在对齐方式为靠右对齐、靠下对齐、中心对齐时，alignPosition的值与positon不同；
autoSizeHorizontalEnable(): boolean client
获取是否自动水平设置大小
autoSizeVerticalEnable(): boolean client
获取是否自动垂直设置大小
cachedGeometry(): Geometry client
获取上一次的GetTickSpaceGeometry
constraints(): Readonly<UIConstraintAnchors> client
获取控件的布局
desiredSize(): Vector2 client
获取期望大小
enable(): boolean client
是否可用
guid(): string client
获取控件GUID
isHovered(): boolean client
是否是hovered
mouseCursor(): MouseCursor client
获取控件上光标类型
name(): string client
获取名字
paintSpaceGeometry(): Geometry client
获取最后一次用于渲染Widget的几何信息
parent(): Widget client
获取父节点
pivot(): Vector2 client
获取控件锚点位置,这个属性决定了控件图形与锚点的相对位置；(0,0)时，锚点位于控件左上角；(0.5,0.5)时，锚点位于控件正中心
position(): Readonly<Vector2> client
获取控件的位置
renderOpacity(): number client
获取渲染透明度
renderScale(): Vector2 client
获取渲染缩放
renderShear(): Vector2 client
获取渲染错切形变
renderTransformAngle(): number client
获取渲染的角度
renderTransformPivot(): Vector2 client
获取渲染锚点
size(): Vector2 client
获取大小
tickSpaceGeometry(): Geometry client
获取最后一次用于驱动Widget Tick的几何信息
transform(): Readonly<UITransform> client
得到控件的大小和位置
visibility(): SlateVisibility client
获取可见性
visible(): boolean client
是否可见
zOrder(): number client
获取zorder

Methods
​

addOption(option: string): void client
添加菜单项
clearOptions(): void client
清空所有菜单项
clearSelection(): void client
清空所有选中
findOptionIndex(option: string): number client
获取下拉顺序坐标
getOptionByIndex(index: number): string client
菜单项内容
getShowTextVisible(): boolean client
获取显示的选中文本的可见性
removeOption(option: string): void client
移除菜单项
setIsOpen(bOpen: boolean): void client
设置下拉菜单打开/关闭
setOptionByIndex(index: number, value: string): void client
修改索引处的值
setShowTextVisible(bVisible: boolean): void client
设置显示的选中文本的可见性
newObject(parent?: Canvas, inName?: string): Dropdown client
创建Canvas控件 当parent和inName与已有的对象相同时，旧的对象会被销毁
click

Methods
​

addChild(child: Widget): void client
添加子节点
clone(position: Vector2, Parent?: Widget): Widget client
克隆UI控件及其子节点到指定父控件位置（默认到其父节点）
destroyObject(): void client
立刻移除并销毁 不可以在使用
equal(that: Widget): boolean client
判断是不是同一个对象
findChildByPath(inPath: string): Widget client
通过相对路径查找节点
getChildAt(index: number): Widget client
获取第几位子节点
getChildByName<T: extends Widget<T>>(name: string): T: extends Widget<T> client
通过名字查找节点
getChildrenCount(): number client
获取子节点数量
getCustomProperties(): string[] client
获取所有自定义属性
getCustomProperty<T: extends CustomPropertyType>(propertyName: string): T: extends CustomPropertyType client
获取自定义属性
getCustomPropertyChangeDelegate(property): Readonly<MulticastDelegate<(path: string, value: unknown, oldValue: unknown) => void>> client
给定对象属性修改时触发的事件代理
invalidateLayoutAndVolatility(): void client
立刻触发重新渲染的和排布计算
isValid(): boolean client
判断控件有没有被销毁，是否是有效的控件
removeAllChildren(): void client
清除所有子节点,会销毁UI无法再使用
removeChild(child: Widget): void client
移除节点,会销毁UI无法在使用
removeChildAt(index: number): void client
移除第几个节点,会销毁UI无法再使用
removeObject(): void client
立刻移除并添加到根节点 可以再使用
serialize(): string client
序列化UI控件
setCustomProperty(propertyName: string, value: undefined CustomPropertyType): void client
设置自定义属性
deserialize(Data: string, Parent?: Widget): Widget client
反序列化UI

Properties ​

Accessors ​

defaultFont
​

• get defaultFont(): string UIFontFamily client

• set defaultFont(inFont): void client

获取默认字体

Returns ​

string UIFontFamily默认字体

设置默认字体

Parameters ​

inFont string UIFontFamily需设置的默认字体

• get dropdownStyle(): DropdownStyle client

菜单样式

Returns ​

DropdownStyle返回菜单样式

fallbackFont
​

• get fallbackFont(): string UIFontFamily client

• set fallbackFont(inFont): void client

获取退却字体

Returns ​

string UIFontFamily退却字体

设置退却字体

Parameters ​

inFont string UIFontFamily需设置的退却字体

glyph
​

• get glyph(): UIFontGlyph client

• set glyph(inGlyph): void client

获取字体字形

Returns ​

UIFontGlyph字体字形

设置字体字形

Parameters ​

inGlyph UIFontGlyph字体字形的类型

isOpened
​

• get isOpened(): boolean client

获取菜单是否打开

Returns ​

boolean菜单是否打开

• get menuRowStyle(): ListItemStyle client

ListItemStyle样式

Returns ​

ListItemStyle返回ListItemStyle样式

onOpeningEvent
​

• get onOpeningEvent(): MulticastDelegate<() => void> client

打开下拉菜单前触发事件

Returns ​

MulticastDelegate<() => void>返回事件

onSelectionChangedEvent
​

• get onSelectionChangedEvent(): MulticastDelegate<(item: string, select: SelectInfo) => void> client

选中改动事件

Returns ​

MulticastDelegate<(item: string, select: SelectInfo) => void>返回选中改动事件

optionCount
​

• get optionCount(): number client

获取菜单项数量

Returns ​

number菜单项数量

options
​

• get options(): string[] client

• set options(value): void client

获取所有菜单项

Returns ​

string[]所有菜单项

获取所有菜单项

Parameters ​

value string[]传进来的字符串数组
range: 无

scrollbarStyle
​

• get scrollbarStyle(): ScrollbarStyle client

滚动条样式

Returns ​

ScrollbarStyle返回滚动条样式

selectedOption
​

• get selectedOption(): string client

• set selectedOption(value): void client

获取当前选中项

Returns ​

string当前选中项

设置前选中项

Parameters ​

value string传进来的文本 range: 无

selectedOptionIndex
​

• get selectedOptionIndex(): number client

• set selectedOptionIndex(value): void client

获取选中项下拉索引

Returns ​

number选中项下拉索引

设置选中项下拉索引

Parameters ​

value number设置的索引值 range: 无 type: 整形

textStyle
​

• get textStyle(): TextStyle client

文本样式

Returns ​

TextStyle返回文本样式

Methods ​

addOption
​

• addOption(option): void client

添加菜单项

Parameters ​

option string菜单项
range: 无

clearOptions
​

• clearOptions(): void client

清空所有菜单项

clearSelection
​

• clearSelection(): void client

清空所有选中

findOptionIndex
​

• findOptionIndex(option): number client

获取下拉顺序坐标

Parameters ​

option string菜单项
range: 无

Returns ​

number下拉顺序坐标

getOptionByIndex
​

• getOptionByIndex(index): string client

菜单项内容

Parameters ​

index number下拉顺序坐标
range: 无 type: 整形

Returns ​

string获取菜单项内容

getShowTextVisible
​

• getShowTextVisible(): boolean client

获取显示的选中文本的可见性

Returns ​

boolean文本的可见性

removeOption
​

• removeOption(option): void client

移除菜单项

Parameters ​

option string菜单项
range: 无

setIsOpen
​

• setIsOpen(bOpen): void client

设置下拉菜单打开/关闭

Parameters ​

bOpen boolean是否打开菜单

setOptionByIndex
​

• setOptionByIndex(index, value): void client

修改索引处的值

Parameters ​

index number索引
range: 对应的索引值，不做限制。
type: 整形
value string值
range: 无

setShowTextVisible
​

• setShowTextVisible(bVisible): void client

设置显示的选中文本的可见性

Parameters ​

bVisible boolean自定义UI的GUID range: [true,false]

newObject
​

• Static newObject(parent?, inName?): Dropdown client

创建Canvas控件 当parent和inName与已有的对象相同时，旧的对象会被销毁

Parameters ​

parent? Canvas创建控件的外parent对象 default:null
inName? string创建控件的名称 default:null
range: 无

Returns ​

Dropdown返回创建的对象