Feedback
Last date modified: 2026-Aug-07
Interface: IDocumentActionControl
Base Type for a toolbar control that can be added to an IToolbar
Extends
Properties
ariaLabel?
optionalariaLabel:string
Inherited from
class
class:
string
Inherited from
disabled
readonlydisabled:boolean
Inherited from
documentActionCollection
documentActionCollection:
IDocumentActionCollection
id
id:
string
Inherited from
isControlCollection
readonlyisControlCollection:boolean
Inherited from
IToolbarControl.isControlCollection
isFlexible
readonlyisFlexible:boolean
Inherited from
isHidden
readonlyisHidden:boolean
Inherited from
order
order:
number
Inherited from
permissionCheck?
optionalpermissionCheck:IPermissionCheckRequest|IPermissionCheckRequest[]
Inherited from
IToolbarControl.permissionCheck
role?
optionalrole:string
Inherited from
scrollDimensions
scrollDimensions:
object
x
x:
number
y
y:
number
Inherited from
IToolbarControl.scrollDimensions
title
title:
string
Inherited from
viewModelPath
readonlyviewModelPath:string
Inherited from
Methods
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
handleAction()
handleAction():
Promise<any>
Returns
Promise<any>
handleVCUpdate()
handleVCUpdate():
Promise<any>
Returns
Promise<any>
hide()
hide():
void
Hides the toolbar control.
Returns
void
Inherited from
show()
show():
void
Shows the toolbar control.
Returns
void
Inherited from
updateVisible()
updateVisible():
Promise<boolean>
Returns
Promise<boolean>
On this page
