SpinButtonActiveXControl

SpinButtonActiveXControl class

Represents the SpinButton control.

class SpinButtonActiveXControl extends ActiveXControl;

Constructors

Name	Description
constructor(ActiveXControl)	Constructs from a parent object convertible to this.

Methods

Method	Description
getType()	Gets the type of the ActiveX control.
getMin()	Gets and sets the minimum acceptable value.
setMin(number)	Gets and sets the minimum acceptable value.
getMax()	Gets and sets the maximum acceptable value.
setMax(number)	Gets and sets the maximum acceptable value.
getPosition()	Gets and sets the value.
setPosition(number)	Gets and sets the value.
getSmallChange()	Gets and sets the amount by which the Position property changes
setSmallChange(number)	Gets and sets the amount by which the Position property changes
getOrientation()	Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.
setOrientation(ControlScrollOrientation)	Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.
isNull()	Checks whether the implementation object is null.
getWorkbook()	Gets the Workbook object.
getMouseIcon()	Gets and sets a custom icon to display as the mouse pointer for the control.
setMouseIcon(number[])	Gets and sets a custom icon to display as the mouse pointer for the control.
getMousePointer()	Gets and sets the type of icon displayed as the mouse pointer for the control.
setMousePointer(ControlMousePointerType)	Gets and sets the type of icon displayed as the mouse pointer for the control.
getLinkedCell()	Gets and sets the linked cell.
setLinkedCell(string)	Gets and sets the linked cell.
getListFillRange()	Gets and sets the list fill range.
setListFillRange(string)	Gets and sets the list fill range.
isEnabled()	Indicates whether the control can receive the focus and respond to user-generated events.
setIsEnabled(boolean)	Indicates whether the control can receive the focus and respond to user-generated events.
isLocked()	Indicates whether data in the control is locked for editing.
setIsLocked(boolean)	Indicates whether data in the control is locked for editing.
isTransparent()	Indicates whether the control is transparent.
setIsTransparent(boolean)	Indicates whether the control is transparent.
getIMEMode()	Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
setIMEMode(InputMethodEditorMode)	Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
getFont()	Represents the font of the control.
getTextAlign()	Represents how to align the text used by the control.
setTextAlign(TextAlignmentType)	Represents how to align the text used by the control.
getData()	Gets and sets the binary data of the control.
getWidth()	Gets and sets the width of the control in unit of points.
setWidth(number)	Gets and sets the width of the control in unit of points.
getHeight()	Gets and sets the height of the control in unit of points.
setHeight(number)	Gets and sets the height of the control in unit of points.
getForeOleColor()	Gets and sets the ole color of the foreground.
setForeOleColor(number)	Gets and sets the ole color of the foreground.
getBackOleColor()	Gets and sets the ole color of the background.
setBackOleColor(number)	Gets and sets the ole color of the background.
isVisible()	Indicates whether this control is visible.
setIsVisible(boolean)	Indicates whether this control is visible.
getShadow()	Indicates whether to show a shadow.
setShadow(boolean)	Indicates whether to show a shadow.
isAutoSize()	Indicates whether the control will automatically resize to display its entire contents.
setIsAutoSize(boolean)	Indicates whether the control will automatically resize to display its entire contents.

constructor(ActiveXControl)

Constructs from a parent object convertible to this.

constructor(obj: ActiveXControl);

Parameters:

Parameter	Type	Description
obj	ActiveXControl	The parent object.

getType()

Gets the type of the ActiveX control.

getType() : ControlType;

Returns

ControlType

getMin()

Gets and sets the minimum acceptable value.

getMin() : number;

setMin(number)

Gets and sets the minimum acceptable value.

setMin(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getMax()

Gets and sets the maximum acceptable value.

getMax() : number;

setMax(number)

Gets and sets the maximum acceptable value.

setMax(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getPosition()

Gets and sets the value.

getPosition() : number;

setPosition(number)

Gets and sets the value.

setPosition(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getSmallChange()

Gets and sets the amount by which the Position property changes

getSmallChange() : number;

setSmallChange(number)

Gets and sets the amount by which the Position property changes

setSmallChange(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getOrientation()

Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.

getOrientation() : ControlScrollOrientation;

Returns

ControlScrollOrientation

setOrientation(ControlScrollOrientation)

Gets and sets whether the SpinButton or ScrollBar is oriented vertically or horizontally.

setOrientation(value: ControlScrollOrientation) : void;

Parameters:

Parameter	Type	Description
value	ControlScrollOrientation	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;

getWorkbook()

Gets the Workbook object.

getWorkbook() : Workbook;

Returns

Workbook

getMouseIcon()

Gets and sets a custom icon to display as the mouse pointer for the control.

getMouseIcon() : number[];

Returns

number[]

setMouseIcon(number[])

Gets and sets a custom icon to display as the mouse pointer for the control.

setMouseIcon(value: number[]) : void;

Parameters:

Parameter	Type	Description
value	number[]	The value to set.

getMousePointer()

Gets and sets the type of icon displayed as the mouse pointer for the control.

getMousePointer() : ControlMousePointerType;

Returns

ControlMousePointerType

setMousePointer(ControlMousePointerType)

Gets and sets the type of icon displayed as the mouse pointer for the control.

setMousePointer(value: ControlMousePointerType) : void;

Parameters:

Parameter	Type	Description
value	ControlMousePointerType	The value to set.

getLinkedCell()

Gets and sets the linked cell.

getLinkedCell() : string;

setLinkedCell(string)

Gets and sets the linked cell.

setLinkedCell(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getListFillRange()

Gets and sets the list fill range.

getListFillRange() : string;

setListFillRange(string)

Gets and sets the list fill range.

setListFillRange(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

isEnabled()

Indicates whether the control can receive the focus and respond to user-generated events.

isEnabled() : boolean;

setIsEnabled(boolean)

Indicates whether the control can receive the focus and respond to user-generated events.

setIsEnabled(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isLocked()

Indicates whether data in the control is locked for editing.

isLocked() : boolean;

setIsLocked(boolean)

Indicates whether data in the control is locked for editing.

setIsLocked(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isTransparent()

Indicates whether the control is transparent.

isTransparent() : boolean;

setIsTransparent(boolean)

Indicates whether the control is transparent.

setIsTransparent(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getIMEMode()

Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.

getIMEMode() : InputMethodEditorMode;

Returns

InputMethodEditorMode

setIMEMode(InputMethodEditorMode)

Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.

setIMEMode(value: InputMethodEditorMode) : void;

Parameters:

Parameter	Type	Description
value	InputMethodEditorMode	The value to set.

getFont()

Represents the font of the control.

getFont() : Font;

Returns

Font

getTextAlign()

Represents how to align the text used by the control.

getTextAlign() : TextAlignmentType;

Returns

TextAlignmentType

setTextAlign(TextAlignmentType)

Represents how to align the text used by the control.

setTextAlign(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

getData()

Gets and sets the binary data of the control.

getData() : number[];

Returns

number[]

getWidth()

Gets and sets the width of the control in unit of points.

getWidth() : number;

setWidth(number)

Gets and sets the width of the control in unit of points.

setWidth(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHeight()

Gets and sets the height of the control in unit of points.

getHeight() : number;

setHeight(number)

Gets and sets the height of the control in unit of points.

setHeight(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getForeOleColor()

Gets and sets the ole color of the foreground.

getForeOleColor() : number;

Remarks

Not applies to Image control.

setForeOleColor(number)

Gets and sets the ole color of the foreground.

setForeOleColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

Not applies to Image control.

getBackOleColor()

Gets and sets the ole color of the background.

getBackOleColor() : number;

setBackOleColor(number)

Gets and sets the ole color of the background.

setBackOleColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

isVisible()

Indicates whether this control is visible.

isVisible() : boolean;

setIsVisible(boolean)

Indicates whether this control is visible.

setIsVisible(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShadow()

Indicates whether to show a shadow.

getShadow() : boolean;

setShadow(boolean)

Indicates whether to show a shadow.

setShadow(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isAutoSize()

Indicates whether the control will automatically resize to display its entire contents.

isAutoSize() : boolean;

setIsAutoSize(boolean)

Indicates whether the control will automatically resize to display its entire contents.

setIsAutoSize(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.