Feedback
Interface: IControlCollection
A dynamic toolbar control to group and organize related controls
Extends
Extended by
Properties
class
class:
string
Inherited from
controls
readonlycontrols:IToolbarControl[]
disabled
readonlydisabled:boolean
Inherited from
id
id:
string
Inherited from
isControlCollection
readonlyisControlCollection:boolean
Inherited from
IToolbarControl.isControlCollection
isFlexible
readonlyisFlexible:boolean
Inherited from
isHidden
readonlyisHidden:boolean
Inherited from
leftDivider
leftDivider:
boolean
order
order:
number
Inherited from
permissionCheck?
optionalpermissionCheck:IPermissionCheckRequest|IPermissionCheckRequest[]
Inherited from
IToolbarControl.permissionCheck
rightDivider
rightDivider:
boolean
scrollDimensions
scrollDimensions:
object
x
x:
number
y
y:
number
Inherited from
IToolbarControl.scrollDimensions
title
title:
string
Inherited from
viewModelPath
readonlyviewModelPath:string
Inherited from
Methods
addControl()
addControl(
control,position?):void
Adds the provided control to the collection
Parameters
• control: IToolbarControl
The toolbar control to add to the collection
• position?: number
The 0 based position to insert the control at in the collection, inserted at the end if not passed
Returns
void
disable()
disable():
void
Disables the toolbar control. This will also gets called when toolbar containing the control gets disabled. Note: If the control needs to do additional sync/async taks (e.x checking on user permission), create override method for disable.
Returns
void
Inherited from
enable()
enable():
void
Enables the toolbar control. This will also gets called when toolbar containing the control gets enabled. Note: If the control needs to do additional sync/async taks (e.x checking on user permission), create override method for enable.
Returns
void
Inherited from
getControlById()
getControlById(
id):IToolbarControl
Retrieves the toolbar control with the specified identifier
Parameters
• id: string
The element identifier
Returns
First toolbar control element matching $ or null if none present
hide()
hide():
void
Hides the toolbar control.
Returns
void
Inherited from
removeControl()
removeControl(
control):boolean
Removes the provided toolbar control from the collection
Parameters
• control: IToolbarControl
The toolbar control to remove from the collection
Returns
boolean
Whether or not item was removed
show()
show():
void
Shows the toolbar control.
Returns
void
