Interface: ICommand

Sheets.Designer.ICommand

Table of contents

Properties

• bigButton
• comboHeight
• comboWidth
• commandMap
• commandName
• commandOptions
• direction
• dropdownList
• dropdownMaxHeight
• dropdownMaxWidth
• enableContext
• group
• hidden
• iconClass
• iconHeight
• iconWidth
• isGroupItem
• keepFocusInSpread
• listContent
• maxHeight
• maxWidth
• needAsyncUpdate
• showDropdownButton
• subCommands
• text
• textBoxHeight
• textBoxWidth
• title
• type
• visibleContext
• visiblePriority

Methods

• execute
• getState
• init

Properties

bigButton

• Optional bigButton: string | boolean

---

comboHeight

• Optional comboHeight: number

---

comboWidth

• Optional comboWidth: number

---

commandMap

• Optional commandMap: Object

---

commandName

• commandName: string

---

commandOptions

• Optional commandOptions: any

---

direction

• Optional direction: string

---

dropdownList

• Optional dropdownList: IListGroupItemData[]

---

dropdownMaxHeight

• Optional dropdownMaxHeight: number

---

dropdownMaxWidth

• Optional dropdownMaxWidth: number

---

enableContext

• Optional enableContext: string

---

group

• Optional group: string

---

hidden

• Optional hidden: boolean

---

iconClass

• Optional iconClass: string

---

iconHeight

• Optional iconHeight: number

---

iconWidth

• Optional iconWidth: number

---

isGroupItem

• Optional isGroupItem: boolean

---

keepFocusInSpread

• Optional keepFocusInSpread: boolean

---

listContent

• Optional listContent: IListGroupItemData[]

---

maxHeight

• Optional maxHeight: number

---

maxWidth

• Optional maxWidth: number

---

needAsyncUpdate

• Optional needAsyncUpdate: boolean

---

showDropdownButton

• Optional showDropdownButton: boolean

---

subCommands

• Optional subCommands: string[]

---

text

• Optional text: string

---

textBoxHeight

• Optional textBoxHeight: number

---

textBoxWidth

• Optional textBoxWidth: number

---

title

• Optional title: string

---

type

• Optional type: string

---

visibleContext

• Optional visibleContext: string

---

visiblePriority

• Optional visiblePriority: number

Methods

execute

▸ Optional execute(context, propertyName?, value?): void

Executes the command logic. The context is the Designer instance, propertyName identifies the trigger source, and value is the input value.

Parameters

Name	Type
context	Designer
propertyName?	string
value?	any

Returns

void

---

getState

▸ Optional getState(context): any

Gets the current state of the command. The context parameter is the Designer instance. Returns an object containing the command's current state (e.g., value, enabled, visible).

Parameters

Name	Type
context	Designer

Returns

any

---

init

▸ Optional init(context): void

Initializes the command when first loaded. Called once during command registration. Use it to set up event listeners or register actions.

Parameters

Name	Type
context	Designer

Returns

void