Interface: IDocumentActionControl
Base Type for a toolbar control that can be added to an IToolbar
Extends
Properties
class
class: string
Inherited from
IToolbarControl
.class
disabled
readonly
disabled: boolean
Inherited from
IToolbarControl
.disabled
documentActionCollection
documentActionCollection: IDocumentActionCollection
id
id: string
Inherited from
IToolbarControl
.id
isControlCollection
readonly
isControlCollection: boolean
Inherited from
IToolbarControl
.isControlCollection
isFlexible
readonly
isFlexible: boolean
Inherited from
IToolbarControl
.isFlexible
isHidden
readonly
isHidden: boolean
Inherited from
IToolbarControl
.isHidden
order
order: number
Inherited from
IToolbarControl
.order
permissionCheck?
optional
permissionCheck: IPermissionCheckRequest
| IPermissionCheckRequest
[]
Inherited from
IToolbarControl
.permissionCheck
scrollDimensions: object
x
x: number
y
y: number
Inherited from
IToolbarControl
.scrollDimensions
title
title: string
Inherited from
IToolbarControl
.title
viewModelPath
readonly
viewModelPath: string
Inherited from
IToolbarControl
.viewModelPath
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
IToolbarControl
.disable
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
IToolbarControl
.enable
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
IToolbarControl
.hide
show()
show(): void
Shows the toolbar control.
Returns
void
Inherited from
IToolbarControl
.show
updateVisible()
updateVisible(): Promise
<boolean
>
Returns
Promise
<boolean
>