Interface: IActionBarItemProxy¶
Hierarchy¶
-
IActionBarItemProxy
Implemented by¶
Summary¶
Properties¶
Class Properties¶
Currently none in this class.
Inherited Properties¶
Methods¶
Class Methods¶
- getCaption
- getEnabled
- getIcon
- getIconText
- getIsIconCircular
- getPageProxy
- getParent
- getPosition
- getStyle
- getSystemItem
- getVisible
- reset
- setCaption
- setEnabled
- setIcon
- setIconText
- setIsIconCircular
- setPosition
- setSystemItem
Inherited Methods¶
Methods¶
getCaption¶
▸ getCaption(): string
Overrides IControlProxy.getCaption
Returns: string
getEnabled¶
▸ getEnabled(): boolean
Returns: boolean
getIcon¶
▸ getIcon(): string
Returns: string
getIconText¶
▸ getIconText(): string
Returns: string
getIsIconCircular¶
▸ getIsIconCircular(): boolean
Returns: boolean
getPageProxy¶
▸ getPageProxy(): IPageProxy
Overrides IControlProxy.getPageProxy
Returns: IPageProxy
the page, which the element belongs to
getParent¶
▸ getParent(): IActionBarProxy
Returns: IActionBarProxy
The control of the actionbar container that contains this item
getPosition¶
▸ getPosition(): string
Returns: string
getStyle¶
▸ getStyle(): string
Returns: string
getSystemItem¶
▸ getSystemItem(): string
Returns: string
getVisible¶
▸ getVisible(): boolean
Returns: boolean
returns true if the control is visible otherwise false.
reset¶
▸ reset(): Promise‹any›
Returns: Promise‹any›
setCaption¶
▸ setCaption(caption: string): void
Parameters:
| Name | Type | Description |
|---|---|---|
caption |
string | value to set. |
Returns: void
setEnabled¶
▸ setEnabled(isEnabled: boolean): void
Parameters:
| Name | Type | Description |
|---|---|---|
isEnabled |
boolean | true enables and false disables. |
Returns: void
setIcon¶
▸ setIcon(icon: string): void
Parameters:
| Name | Type | Description |
|---|---|---|
icon |
string | value to set. |
Returns: void
setIconText¶
▸ setIconText(iconText: string): void
Parameters:
| Name | Type | Description |
|---|---|---|
iconText |
string | value to set. |
Returns: void
setIsIconCircular¶
▸ setIsIconCircular(isIconCircular: boolean): void
Parameters:
| Name | Type | Description |
|---|---|---|
isIconCircular |
boolean | value to set. |
Returns: void
setPosition¶
▸ setPosition(position: string): void
Parameters:
| Name | Type | Description |
|---|---|---|
position |
string | value to set. |
Returns: void
setSystemItem¶
▸ setSystemItem(systemItem: string): void
Parameters:
| Name | Type | Description |
|---|---|---|
systemItem |
string | value to set. |
Returns: void