ListBoxActiveXControl
ListBoxActiveXControl class
Represents a ListBox ActiveX control.
class ListBoxActiveXControl extends ActiveXControl;
Constructors
Constructor | Description |
---|---|
constructor(ActiveXControl) | Constructs from a parent object convertible to this. |
Properties
Property | Type | Description |
---|---|---|
scrollBars | ControlScrollBarType | Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. |
listWidth | number | Gets and set the width in unit of points. |
boundColumn | number | Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle). |
textColumn | number | Represents the column in a ComboBox or ListBox to display to the user. |
columnCount | number | Represents the number of columns to display in a ComboBox or ListBox. |
matchEntry | ControlMatchEntryType | Indicates how a ListBox or ComboBox searches its list as the user types. |
listStyle | ControlListStyle | Gets and sets the visual appearance. |
selectionType | SelectionType | Indicates whether the control permits multiple selections. |
value | string | Gets and sets the value of the control. |
borderStyle | ControlBorderType | Gets and set the type of border used by the control. |
borderOleColor | number | Gets and sets the ole color of the background. |
specialEffect | ControlSpecialEffectType | Gets and sets the special effect of the control. |
showColumnHeads | boolean | Indicates whether column headings are displayed. |
integralHeight | boolean | Indicates whether the control will only show complete lines of text without showing any partial lines. |
columnWidths | number | Gets and sets the width of the column. |
workbook | Workbook | Readonly. Gets the Workbook object. |
mouseIcon | Uint8Array | Gets and sets a custom icon to display as the mouse pointer for the control. |
mousePointer | ControlMousePointerType | Gets and sets the type of icon displayed as the mouse pointer for the control. |
linkedCell | string | Gets and sets the linked cell. |
listFillRange | string | Gets and sets the list fill range. |
isEnabled | boolean | Indicates whether the control can receive the focus and respond to user-generated events. |
isLocked | boolean | Indicates whether data in the control is locked for editing. |
isTransparent | boolean | Indicates whether the control is transparent. |
iMEMode | InputMethodEditorMode | Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. |
font | Font | Readonly. Represents the font of the control. |
textAlign | TextAlignmentType | Represents how to align the text used by the control. |
Methods
Method | Description |
---|---|
getScrollBars() | @deprecated. Please use the ‘scrollBars’ property instead. Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. |
setScrollBars(ControlScrollBarType) | @deprecated. Please use the ‘scrollBars’ property instead. Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither. |
getListWidth() | @deprecated. Please use the ’listWidth’ property instead. Gets and set the width in unit of points. |
setListWidth(number) | @deprecated. Please use the ’listWidth’ property instead. Gets and set the width in unit of points. |
getBoundColumn() | @deprecated. Please use the ‘boundColumn’ property instead. Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle). |
setBoundColumn(number) | @deprecated. Please use the ‘boundColumn’ property instead. Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle). |
getTextColumn() | @deprecated. Please use the ’textColumn’ property instead. Represents the column in a ComboBox or ListBox to display to the user. |
setTextColumn(number) | @deprecated. Please use the ’textColumn’ property instead. Represents the column in a ComboBox or ListBox to display to the user. |
getColumnCount() | @deprecated. Please use the ‘columnCount’ property instead. Represents the number of columns to display in a ComboBox or ListBox. |
setColumnCount(number) | @deprecated. Please use the ‘columnCount’ property instead. Represents the number of columns to display in a ComboBox or ListBox. |
getMatchEntry() | @deprecated. Please use the ‘matchEntry’ property instead. Indicates how a ListBox or ComboBox searches its list as the user types. |
setMatchEntry(ControlMatchEntryType) | @deprecated. Please use the ‘matchEntry’ property instead. Indicates how a ListBox or ComboBox searches its list as the user types. |
getListStyle() | @deprecated. Please use the ’listStyle’ property instead. Gets and sets the visual appearance. |
setListStyle(ControlListStyle) | @deprecated. Please use the ’listStyle’ property instead. Gets and sets the visual appearance. |
getSelectionType() | @deprecated. Please use the ‘selectionType’ property instead. Indicates whether the control permits multiple selections. |
setSelectionType(SelectionType) | @deprecated. Please use the ‘selectionType’ property instead. Indicates whether the control permits multiple selections. |
getValue() | @deprecated. Please use the ‘value’ property instead. Gets and sets the value of the control. |
setValue(string) | @deprecated. Please use the ‘value’ property instead. Gets and sets the value of the control. |
getBorderStyle() | @deprecated. Please use the ‘borderStyle’ property instead. Gets and set the type of border used by the control. |
setBorderStyle(ControlBorderType) | @deprecated. Please use the ‘borderStyle’ property instead. Gets and set the type of border used by the control. |
getBorderOleColor() | @deprecated. Please use the ‘borderOleColor’ property instead. Gets and sets the ole color of the background. |
setBorderOleColor(number) | @deprecated. Please use the ‘borderOleColor’ property instead. Gets and sets the ole color of the background. |
getSpecialEffect() | @deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control. |
setSpecialEffect(ControlSpecialEffectType) | @deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control. |
getShowColumnHeads() | @deprecated. Please use the ‘showColumnHeads’ property instead. Indicates whether column headings are displayed. |
setShowColumnHeads(boolean) | @deprecated. Please use the ‘showColumnHeads’ property instead. Indicates whether column headings are displayed. |
getIntegralHeight() | @deprecated. Please use the ‘integralHeight’ property instead. Indicates whether the control will only show complete lines of text without showing any partial lines. |
setIntegralHeight(boolean) | @deprecated. Please use the ‘integralHeight’ property instead. Indicates whether the control will only show complete lines of text without showing any partial lines. |
getColumnWidths() | @deprecated. Please use the ‘columnWidths’ property instead. Gets and sets the width of the column. |
setColumnWidths(number) | @deprecated. Please use the ‘columnWidths’ property instead. Gets and sets the width of the column. |
isNull() | Checks whether the implementation object is null. |
getWorkbook() | @deprecated. Please use the ‘workbook’ property instead. Gets the Workbook object. |
getMouseIcon() | @deprecated. Please use the ‘mouseIcon’ property instead. Gets and sets a custom icon to display as the mouse pointer for the control. |
setMouseIcon(Uint8Array) | @deprecated. Please use the ‘mouseIcon’ property instead. Gets and sets a custom icon to display as the mouse pointer for the control. |
getMousePointer() | @deprecated. Please use the ‘mousePointer’ property instead. Gets and sets the type of icon displayed as the mouse pointer for the control. |
setMousePointer(ControlMousePointerType) | @deprecated. Please use the ‘mousePointer’ property instead. Gets and sets the type of icon displayed as the mouse pointer for the control. |
getLinkedCell() | @deprecated. Please use the ’linkedCell’ property instead. Gets and sets the linked cell. |
setLinkedCell(string) | @deprecated. Please use the ’linkedCell’ property instead. Gets and sets the linked cell. |
getListFillRange() | @deprecated. Please use the ’listFillRange’ property instead. Gets and sets the list fill range. |
setListFillRange(string) | @deprecated. Please use the ’listFillRange’ property instead. Gets and sets the list fill range. |
isEnabled() | @deprecated. Please use the ‘isEnabled’ property instead. Indicates whether the control can receive the focus and respond to user-generated events. |
setIsEnabled(boolean) | @deprecated. Please use the ‘isEnabled’ property instead. Indicates whether the control can receive the focus and respond to user-generated events. |
isLocked() | @deprecated. Please use the ‘isLocked’ property instead. Indicates whether data in the control is locked for editing. |
setIsLocked(boolean) | @deprecated. Please use the ‘isLocked’ property instead. Indicates whether data in the control is locked for editing. |
isTransparent() | @deprecated. Please use the ‘isTransparent’ property instead. Indicates whether the control is transparent. |
setIsTransparent(boolean) | @deprecated. Please use the ‘isTransparent’ property instead. Indicates whether the control is transparent. |
getIMEMode() | @deprecated. Please use the ‘iMEMode’ property instead. Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. |
setIMEMode(InputMethodEditorMode) | @deprecated. Please use the ‘iMEMode’ property instead. Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus. |
getFont() | @deprecated. Please use the ‘font’ property instead. Represents the font of the control. |
getTextAlign() | @deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control. |
setTextAlign(TextAlignmentType) | @deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control. |
getType() | Gets the type of the ActiveX 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. |
getData() | Gets and sets the binary data of the control. |
constructor(ActiveXControl)
Constructs from a parent object convertible to this.
constructor(obj: ActiveXControl);
Parameters:
Parameter | Type | Description |
---|---|---|
obj | ActiveXControl | The parent object. |
scrollBars
Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
scrollBars : ControlScrollBarType;
listWidth
Gets and set the width in unit of points.
listWidth : number;
boundColumn
Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).
boundColumn : number;
textColumn
Represents the column in a ComboBox or ListBox to display to the user.
textColumn : number;
columnCount
Represents the number of columns to display in a ComboBox or ListBox.
columnCount : number;
matchEntry
Indicates how a ListBox or ComboBox searches its list as the user types.
matchEntry : ControlMatchEntryType;
listStyle
Gets and sets the visual appearance.
listStyle : ControlListStyle;
selectionType
Indicates whether the control permits multiple selections.
selectionType : SelectionType;
value
Gets and sets the value of the control.
value : string;
Remarks
Only effects when ListBoxActiveXControl.SelectionType is SelectionType.Single;
borderStyle
Gets and set the type of border used by the control.
borderStyle : ControlBorderType;
borderOleColor
Gets and sets the ole color of the background.
borderOleColor : number;
specialEffect
Gets and sets the special effect of the control.
specialEffect : ControlSpecialEffectType;
showColumnHeads
Indicates whether column headings are displayed.
showColumnHeads : boolean;
integralHeight
Indicates whether the control will only show complete lines of text without showing any partial lines.
integralHeight : boolean;
columnWidths
Gets and sets the width of the column.
columnWidths : number;
workbook
Readonly. Gets the Workbook object.
workbook : Workbook;
mouseIcon
Gets and sets a custom icon to display as the mouse pointer for the control.
mouseIcon : Uint8Array;
mousePointer
Gets and sets the type of icon displayed as the mouse pointer for the control.
mousePointer : ControlMousePointerType;
linkedCell
Gets and sets the linked cell.
linkedCell : string;
listFillRange
Gets and sets the list fill range.
listFillRange : string;
isEnabled
Indicates whether the control can receive the focus and respond to user-generated events.
isEnabled : boolean;
isLocked
Indicates whether data in the control is locked for editing.
isLocked : boolean;
isTransparent
Indicates whether the control is transparent.
isTransparent : boolean;
iMEMode
Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
iMEMode : InputMethodEditorMode;
font
Readonly. Represents the font of the control.
font : Font;
textAlign
Represents how to align the text used by the control.
textAlign : TextAlignmentType;
getScrollBars()
@deprecated. Please use the ‘scrollBars’ property instead. Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
getScrollBars() : ControlScrollBarType;
Returns
setScrollBars(ControlScrollBarType)
@deprecated. Please use the ‘scrollBars’ property instead. Indicates specifies whether the control has vertical scroll bars, horizontal scroll bars, both, or neither.
setScrollBars(value: ControlScrollBarType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | ControlScrollBarType | The value to set. |
getListWidth()
@deprecated. Please use the ’listWidth’ property instead. Gets and set the width in unit of points.
getListWidth() : number;
setListWidth(number)
@deprecated. Please use the ’listWidth’ property instead. Gets and set the width in unit of points.
setListWidth(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getBoundColumn()
@deprecated. Please use the ‘boundColumn’ property instead. Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).
getBoundColumn() : number;
setBoundColumn(number)
@deprecated. Please use the ‘boundColumn’ property instead. Represents how the Value property is determined for a ComboBox or ListBox when the MultiSelect properties value (fmMultiSelectSingle).
setBoundColumn(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getTextColumn()
@deprecated. Please use the ’textColumn’ property instead. Represents the column in a ComboBox or ListBox to display to the user.
getTextColumn() : number;
setTextColumn(number)
@deprecated. Please use the ’textColumn’ property instead. Represents the column in a ComboBox or ListBox to display to the user.
setTextColumn(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getColumnCount()
@deprecated. Please use the ‘columnCount’ property instead. Represents the number of columns to display in a ComboBox or ListBox.
getColumnCount() : number;
setColumnCount(number)
@deprecated. Please use the ‘columnCount’ property instead. Represents the number of columns to display in a ComboBox or ListBox.
setColumnCount(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getMatchEntry()
@deprecated. Please use the ‘matchEntry’ property instead. Indicates how a ListBox or ComboBox searches its list as the user types.
getMatchEntry() : ControlMatchEntryType;
Returns
setMatchEntry(ControlMatchEntryType)
@deprecated. Please use the ‘matchEntry’ property instead. Indicates how a ListBox or ComboBox searches its list as the user types.
setMatchEntry(value: ControlMatchEntryType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | ControlMatchEntryType | The value to set. |
getListStyle()
@deprecated. Please use the ’listStyle’ property instead. Gets and sets the visual appearance.
getListStyle() : ControlListStyle;
Returns
setListStyle(ControlListStyle)
@deprecated. Please use the ’listStyle’ property instead. Gets and sets the visual appearance.
setListStyle(value: ControlListStyle) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | ControlListStyle | The value to set. |
getSelectionType()
@deprecated. Please use the ‘selectionType’ property instead. Indicates whether the control permits multiple selections.
getSelectionType() : SelectionType;
Returns
setSelectionType(SelectionType)
@deprecated. Please use the ‘selectionType’ property instead. Indicates whether the control permits multiple selections.
setSelectionType(value: SelectionType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | SelectionType | The value to set. |
getValue()
@deprecated. Please use the ‘value’ property instead. Gets and sets the value of the control.
getValue() : string;
Remarks
Only effects when ListBoxActiveXControl.SelectionType is SelectionType.Single;
setValue(string)
@deprecated. Please use the ‘value’ property instead. Gets and sets the value of the control.
setValue(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
Remarks
Only effects when ListBoxActiveXControl.SelectionType is SelectionType.Single;
getBorderStyle()
@deprecated. Please use the ‘borderStyle’ property instead. Gets and set the type of border used by the control.
getBorderStyle() : ControlBorderType;
Returns
setBorderStyle(ControlBorderType)
@deprecated. Please use the ‘borderStyle’ property instead. Gets and set the type of border used by the control.
setBorderStyle(value: ControlBorderType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | ControlBorderType | The value to set. |
getBorderOleColor()
@deprecated. Please use the ‘borderOleColor’ property instead. Gets and sets the ole color of the background.
getBorderOleColor() : number;
setBorderOleColor(number)
@deprecated. Please use the ‘borderOleColor’ property instead. Gets and sets the ole color of the background.
setBorderOleColor(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
getSpecialEffect()
@deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control.
getSpecialEffect() : ControlSpecialEffectType;
Returns
setSpecialEffect(ControlSpecialEffectType)
@deprecated. Please use the ‘specialEffect’ property instead. Gets and sets the special effect of the control.
setSpecialEffect(value: ControlSpecialEffectType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | ControlSpecialEffectType | The value to set. |
getShowColumnHeads()
@deprecated. Please use the ‘showColumnHeads’ property instead. Indicates whether column headings are displayed.
getShowColumnHeads() : boolean;
setShowColumnHeads(boolean)
@deprecated. Please use the ‘showColumnHeads’ property instead. Indicates whether column headings are displayed.
setShowColumnHeads(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getIntegralHeight()
@deprecated. Please use the ‘integralHeight’ property instead. Indicates whether the control will only show complete lines of text without showing any partial lines.
getIntegralHeight() : boolean;
setIntegralHeight(boolean)
@deprecated. Please use the ‘integralHeight’ property instead. Indicates whether the control will only show complete lines of text without showing any partial lines.
setIntegralHeight(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getColumnWidths()
@deprecated. Please use the ‘columnWidths’ property instead. Gets and sets the width of the column.
getColumnWidths() : number;
setColumnWidths(number)
@deprecated. Please use the ‘columnWidths’ property instead. Gets and sets the width of the column.
setColumnWidths(value: number) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
getWorkbook()
@deprecated. Please use the ‘workbook’ property instead. Gets the Workbook object.
getWorkbook() : Workbook;
Returns
getMouseIcon()
@deprecated. Please use the ‘mouseIcon’ property instead. Gets and sets a custom icon to display as the mouse pointer for the control.
getMouseIcon() : Uint8Array;
setMouseIcon(Uint8Array)
@deprecated. Please use the ‘mouseIcon’ property instead. Gets and sets a custom icon to display as the mouse pointer for the control.
setMouseIcon(value: Uint8Array) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | number[] | The value to set. |
getMousePointer()
@deprecated. Please use the ‘mousePointer’ property instead. Gets and sets the type of icon displayed as the mouse pointer for the control.
getMousePointer() : ControlMousePointerType;
Returns
setMousePointer(ControlMousePointerType)
@deprecated. Please use the ‘mousePointer’ property instead. 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()
@deprecated. Please use the ’linkedCell’ property instead. Gets and sets the linked cell.
getLinkedCell() : string;
setLinkedCell(string)
@deprecated. Please use the ’linkedCell’ property instead. Gets and sets the linked cell.
setLinkedCell(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
getListFillRange()
@deprecated. Please use the ’listFillRange’ property instead. Gets and sets the list fill range.
getListFillRange() : string;
setListFillRange(string)
@deprecated. Please use the ’listFillRange’ property instead. Gets and sets the list fill range.
setListFillRange(value: string) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | string | The value to set. |
isEnabled()
@deprecated. Please use the ‘isEnabled’ property instead. Indicates whether the control can receive the focus and respond to user-generated events.
isEnabled() : boolean;
setIsEnabled(boolean)
@deprecated. Please use the ‘isEnabled’ property instead. 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()
@deprecated. Please use the ‘isLocked’ property instead. Indicates whether data in the control is locked for editing.
isLocked() : boolean;
setIsLocked(boolean)
@deprecated. Please use the ‘isLocked’ property instead. 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()
@deprecated. Please use the ‘isTransparent’ property instead. Indicates whether the control is transparent.
isTransparent() : boolean;
setIsTransparent(boolean)
@deprecated. Please use the ‘isTransparent’ property instead. Indicates whether the control is transparent.
setIsTransparent(value: boolean) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean | The value to set. |
getIMEMode()
@deprecated. Please use the ‘iMEMode’ property instead. Gets and sets the default run-time mode of the Input Method Editor for the control as it receives focus.
getIMEMode() : InputMethodEditorMode;
Returns
setIMEMode(InputMethodEditorMode)
@deprecated. Please use the ‘iMEMode’ property instead. 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()
@deprecated. Please use the ‘font’ property instead. Represents the font of the control.
getFont() : Font;
Returns
getTextAlign()
@deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control.
getTextAlign() : TextAlignmentType;
Returns
setTextAlign(TextAlignmentType)
@deprecated. Please use the ’textAlign’ property instead. Represents how to align the text used by the control.
setTextAlign(value: TextAlignmentType) : void;
Parameters:
Parameter | Type | Description |
---|---|---|
value | TextAlignmentType | The value to set. |
getType()
Gets the type of the ActiveX control.
getType() : ControlType;
Returns
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. |
getData()
Gets and sets the binary data of the control.
getData() : Uint8Array;