Interface: IToolbarControl

Base Type for a toolbar control that can be added to an IToolbar

Extended by

• IDocumentActionControl
• IControlCollection
• ICustomControl
• IImageButtonControl

Properties

ariaLabel?

optionalariaLabel: string

---

class

class: string

---

disabled

readonlydisabled: boolean

---

id

id: string

---

isControlCollection

readonlyisControlCollection: boolean

---

isFlexible

readonlyisFlexible: boolean

---

isHidden

readonlyisHidden: boolean

---

order

order: number

---

permissionCheck?

optionalpermissionCheck: IPermissionCheckRequest | IPermissionCheckRequest[]

---

role?

optionalrole: string

---

scrollDimensions

scrollDimensions: object

x

x: number

y

y: number

---

title

title: string

---

viewModelPath

readonlyviewModelPath: string

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

---

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

---

hide()

hide(): void

Hides the toolbar control.

Returns

void

---

show()

show(): void

Shows the toolbar control.

Returns

void