# GC.Spread.Sheets.Designer.ICommand

## Content

# Interface: ICommand

[Sheets](../modules/GC.Spread.Sheets).[Designer](../modules/GC.Spread.Sheets.Designer).ICommand

## Table of contents

### Properties

- [bigButton](GC.Spread.Sheets.Designer.ICommand#bigbutton)
- [comboHeight](GC.Spread.Sheets.Designer.ICommand#comboheight)
- [comboWidth](GC.Spread.Sheets.Designer.ICommand#combowidth)
- [commandMap](GC.Spread.Sheets.Designer.ICommand#commandmap)
- [commandName](GC.Spread.Sheets.Designer.ICommand#commandname)
- [commandOptions](GC.Spread.Sheets.Designer.ICommand#commandoptions)
- [direction](GC.Spread.Sheets.Designer.ICommand#direction)
- [dropdownList](GC.Spread.Sheets.Designer.ICommand#dropdownlist)
- [dropdownMaxHeight](GC.Spread.Sheets.Designer.ICommand#dropdownmaxheight)
- [dropdownMaxWidth](GC.Spread.Sheets.Designer.ICommand#dropdownmaxwidth)
- [enableContext](GC.Spread.Sheets.Designer.ICommand#enablecontext)
- [group](GC.Spread.Sheets.Designer.ICommand#group)
- [hidden](GC.Spread.Sheets.Designer.ICommand#hidden)
- [iconClass](GC.Spread.Sheets.Designer.ICommand#iconclass)
- [iconHeight](GC.Spread.Sheets.Designer.ICommand#iconheight)
- [iconWidth](GC.Spread.Sheets.Designer.ICommand#iconwidth)
- [isGroupItem](GC.Spread.Sheets.Designer.ICommand#isgroupitem)
- [keepFocusInSpread](GC.Spread.Sheets.Designer.ICommand#keepfocusinspread)
- [listContent](GC.Spread.Sheets.Designer.ICommand#listcontent)
- [maxHeight](GC.Spread.Sheets.Designer.ICommand#maxheight)
- [maxWidth](GC.Spread.Sheets.Designer.ICommand#maxwidth)
- [needAsyncUpdate](GC.Spread.Sheets.Designer.ICommand#needasyncupdate)
- [showDropdownButton](GC.Spread.Sheets.Designer.ICommand#showdropdownbutton)
- [subCommands](GC.Spread.Sheets.Designer.ICommand#subcommands)
- [text](GC.Spread.Sheets.Designer.ICommand#text)
- [textBoxHeight](GC.Spread.Sheets.Designer.ICommand#textboxheight)
- [textBoxWidth](GC.Spread.Sheets.Designer.ICommand#textboxwidth)
- [title](GC.Spread.Sheets.Designer.ICommand#title)
- [type](GC.Spread.Sheets.Designer.ICommand#type)
- [visibleContext](GC.Spread.Sheets.Designer.ICommand#visiblecontext)
- [visiblePriority](GC.Spread.Sheets.Designer.ICommand#visiblepriority)

### Methods

- [execute](GC.Spread.Sheets.Designer.ICommand#execute)
- [getState](GC.Spread.Sheets.Designer.ICommand#getstate)
- [init](GC.Spread.Sheets.Designer.ICommand#init)

## Properties

### <a id="bigbutton" name="bigbutton"></a> bigButton

• `Optional` **bigButton**: `string` \| `boolean`

___

### <a id="comboheight" name="comboheight"></a> comboHeight

• `Optional` **comboHeight**: `number`

___

### <a id="combowidth" name="combowidth"></a> comboWidth

• `Optional` **comboWidth**: `number`

___

### <a id="commandmap" name="commandmap"></a> commandMap

• `Optional` **commandMap**: `Object`

___

### <a id="commandname" name="commandname"></a> commandName

• **commandName**: `string`

___

### <a id="commandoptions" name="commandoptions"></a> commandOptions

• `Optional` **commandOptions**: `any`

___

### <a id="direction" name="direction"></a> direction

• `Optional` **direction**: `string`

___

### <a id="dropdownlist" name="dropdownlist"></a> dropdownList

• `Optional` **dropdownList**: [`IListGroupItemData`](GC.Spread.Sheets.Designer.IListGroupItemData)[]

___

### <a id="dropdownmaxheight" name="dropdownmaxheight"></a> dropdownMaxHeight

• `Optional` **dropdownMaxHeight**: `number`

___

### <a id="dropdownmaxwidth" name="dropdownmaxwidth"></a> dropdownMaxWidth

• `Optional` **dropdownMaxWidth**: `number`

___

### <a id="enablecontext" name="enablecontext"></a> enableContext

• `Optional` **enableContext**: `string`

___

### <a id="group" name="group"></a> group

• `Optional` **group**: `string`

___

### <a id="hidden" name="hidden"></a> hidden

• `Optional` **hidden**: `boolean`

___

### <a id="iconclass" name="iconclass"></a> iconClass

• `Optional` **iconClass**: `string`

___

### <a id="iconheight" name="iconheight"></a> iconHeight

• `Optional` **iconHeight**: `number`

___

### <a id="iconwidth" name="iconwidth"></a> iconWidth

• `Optional` **iconWidth**: `number`

___

### <a id="isgroupitem" name="isgroupitem"></a> isGroupItem

• `Optional` **isGroupItem**: `boolean`

___

### <a id="keepfocusinspread" name="keepfocusinspread"></a> keepFocusInSpread

• `Optional` **keepFocusInSpread**: `boolean`

___

### <a id="listcontent" name="listcontent"></a> listContent

• `Optional` **listContent**: [`IListGroupItemData`](GC.Spread.Sheets.Designer.IListGroupItemData)[]

___

### <a id="maxheight" name="maxheight"></a> maxHeight

• `Optional` **maxHeight**: `number`

___

### <a id="maxwidth" name="maxwidth"></a> maxWidth

• `Optional` **maxWidth**: `number`

___

### <a id="needasyncupdate" name="needasyncupdate"></a> needAsyncUpdate

• `Optional` **needAsyncUpdate**: `boolean`

___

### <a id="showdropdownbutton" name="showdropdownbutton"></a> showDropdownButton

• `Optional` **showDropdownButton**: `boolean`

___

### <a id="subcommands" name="subcommands"></a> subCommands

• `Optional` **subCommands**: `string`[]

___

### <a id="text" name="text"></a> text

• `Optional` **text**: `string`

___

### <a id="textboxheight" name="textboxheight"></a> textBoxHeight

• `Optional` **textBoxHeight**: `number`

___

### <a id="textboxwidth" name="textboxwidth"></a> textBoxWidth

• `Optional` **textBoxWidth**: `number`

___

### <a id="title" name="title"></a> title

• `Optional` **title**: `string`

___

### <a id="type" name="type"></a> type

• `Optional` **type**: `string`

___

### <a id="visiblecontext" name="visiblecontext"></a> visibleContext

• `Optional` **visibleContext**: `string`

___

### <a id="visiblepriority" name="visiblepriority"></a> visiblePriority

• `Optional` **visiblePriority**: `number`

## Methods

### <a id="execute" name="execute"></a> 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`](../classes/GC.Spread.Sheets.Designer.Designer) |
| `propertyName?` | `string` |
| `value?` | `any` |

#### Returns

`void`

___

### <a id="getstate" name="getstate"></a> 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`](../classes/GC.Spread.Sheets.Designer.Designer) |

#### Returns

`any`

___

### <a id="init" name="init"></a> 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`](../classes/GC.Spread.Sheets.Designer.Designer) |

#### Returns

`void`