Class: TabControlProxy¶
TabControlProxy is a developer-facing class that provides access to a BottomnNvigation and Tabs and its items for application specific customizations.
Hierarchy¶
-
TabControlProxy
Implements¶
Summary¶
Constructors¶
Properties¶
Class Properties¶
Inherited Properties¶
Accessors¶
Class Accessors¶
Inherited Accessors¶
Methods¶
Class Methods¶
- getItemCaption
- getSelectedTabItemIndex
- getSelectedTabItemName
- isContainer
- setItemCaption
- setSelectedTabItemByIndex
- setSelectedTabItemByName
Inherited Methods¶
Constructors¶
constructor¶
+ new TabControlProxy(context
: IContext): TabControlProxy
Overrides ControlProxy.constructor
Parameters:
Name | Type |
---|---|
context |
IContext |
Returns: TabControlProxy
Properties¶
Accessors¶
tabItems¶
• get tabItems(): IControlProxy[]
Returns: IControlProxy[]
list of items in the tab control
Methods¶
getItemCaption¶
▸ getItemCaption(tabItemName
: string): string
Implementation of ITabControlProxy
Parameters:
Name | Type |
---|---|
tabItemName |
string |
Returns: string
tab item caption based on tab item name
getSelectedTabItemIndex¶
▸ getSelectedTabItemIndex(): number
Implementation of ITabControlProxy
Returns: number
selected tab item index
getSelectedTabItemName¶
▸ getSelectedTabItemName(): number
Implementation of ITabControlProxy
Returns: number
selected tab item name
isContainer¶
▸ isContainer(): boolean
Implementation of ITabControlProxy
Overrides ControlProxy.isContainer
Determine if the tab control is a container.
Returns: boolean
true/false. It always returns true for BottomNavigation.
setItemCaption¶
▸ setItemCaption(tabItemName
: string, newCaption
: string): void
Implementation of ITabControlProxy
Set tab item caption by tab item name
Parameters:
Name | Type |
---|---|
tabItemName |
string |
newCaption |
string |
Returns: void
setSelectedTabItemByIndex¶
▸ setSelectedTabItemByIndex(tabItemIndex
: number): void
Implementation of ITabControlProxy
Set selected tab item by index for tab control
Parameters:
Name | Type |
---|---|
tabItemIndex |
number |
Returns: void
setSelectedTabItemByName¶
▸ setSelectedTabItemByName(tabItemName
: string): void
Implementation of ITabControlProxy
Set selected tab item by name for tab control
Parameters:
Name | Type |
---|---|
tabItemName |
string |
Returns: void