Skip to content

@sheetkit/node / JsFormControlConfig

Interface: JsFormControlConfig

Defined in: binding.d.ts:609

Configuration for adding a form control to a worksheet.

Properties

cell

cell: string

Defined in: binding.d.ts:616

Anchor cell (top-left corner), e.g. "B2".


optional cellLink: string

Defined in: binding.d.ts:626

Linked cell reference for value binding.


checked?

optional checked: boolean

Defined in: binding.d.ts:628

Initial checked state (CheckBox, OptionButton).


controlType

controlType: string

Defined in: binding.d.ts:614

Control type: "button", "checkbox", "optionButton", "spinButton", "scrollBar", "groupBox", "label".


currentValue?

optional currentValue: number

Defined in: binding.d.ts:638

Current value (SpinButton, ScrollBar).


height?

optional height: number

Defined in: binding.d.ts:620

Height in points.


increment?

optional increment: number

Defined in: binding.d.ts:634

Step increment (SpinButton, ScrollBar).


macroName?

optional macroName: string

Defined in: binding.d.ts:624

VBA macro name (Button only).


maxValue?

optional maxValue: number

Defined in: binding.d.ts:632

Maximum value (SpinButton, ScrollBar).


minValue?

optional minValue: number

Defined in: binding.d.ts:630

Minimum value (SpinButton, ScrollBar).


pageIncrement?

optional pageIncrement: number

Defined in: binding.d.ts:636

Page increment (ScrollBar only).


text?

optional text: string

Defined in: binding.d.ts:622

Display text (Button, CheckBox, OptionButton, GroupBox, Label).


threeD?

optional threeD: boolean

Defined in: binding.d.ts:640

Enable 3D shading.


width?

optional width: number

Defined in: binding.d.ts:618

Width in points.

Released under the MIT / Apache-2.0 License.