Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IToolbarButtonControlConfig

Configuration object for defining new toolbar button control

Hierarchy

Index

Properties

Properties

class

class: string
property

{string} class classes to bind to for the css style.

Optional disable

disable: function

Optional - override method to disable the toolbar control. This method gets called when a toolbar containing the control gets disabled during navigation. If the control needs to do additional sync/async taks (e.x checking on user permission) before disabling, use this to override the default behavior.

returns

Type declaration

    • (): void

    • Returns void

Optional enable

enable: function

Optional - override method to enable the toolbar control. This method gets called when a toolbar containing the control gets enabled during navigation. If the control needs to do additional sync/async taks (e.x checking on user permission) before enabling, use this to override the default behavior.

returns

Type declaration

    • (): void

    • Returns void

Optional enableOnCreation

enableOnCreation: boolean
property

{boolean} enableOnCreation Optional - whether to enable the toolbar control on creation. Set to true by default. If you don't want the control to be enabled on creation, set this to false.

id

id: string
property

{string} id unique toolbar control ID.

imageUrl

imageUrl: string
property

{string} imageUrl Url to an image to use as the button's icon. If you want to use application resource for the image, use getResourceFileUrl method under IExtensionParameters to generate URL for your resource file. For example, ...

const buttonConfig = { imageUrl: extensionParams.getResourceFileUrl("fileName.png"), ... }

Icon will be displayed at 20px x 20px by default.

onClick

onClick: function
property

{() => any} onClick delegate for the on click event

Type declaration

    • (): any

    • Returns any

Optional permissionCheck

permissionCheck: IPermissionCheckRequest
property

{IPermissionCheckRequest} permissionCheck Optional - permission check object to be used to check on permission before creating the toolbar control.

title

title: string
property

{string} title title/name for the toolbar control. Used for hover text.

type

type: ToolbarControlType
property

{toolbarControlType} type the toolbar control's type.