ListBox.GetProperties

 OverviewExamples

table ListBox.GetProperties ( 

string ObjectName )

Description

Returns a table containing the properties of a listbox object.

Parameters

ObjectName

(string) The name of the listbox object.

Returns

(table) A table containing the listbox object's properties, indexed by the following keys:

KEY

TYPE

DESCRIPTION

ObjectName

string

The name of the listbox object.

MultipleSelection

boolean

True if multiple selection is enabled, false if it is not.

Sort

boolean

True if the listbox is sorted, false if it is not.

VScrollbar

boolean

True if the vertical scrollbar is enabled, false if it is not.

HScrollbar

boolean

True if the horizontal scrollbar is enabled, false if it is not.

FontName

string

The font name.

FontSize

number

The font size (in points).

FontStrikeout

boolean

True if the font is set to strikeout, false if it is not.

FontUnderline

boolean

True if the font is set to underline, false if it is not.

FontAntiAlias

boolean

True if the font is set to anti alias, false if it is not.

FontItalic

boolean

True if the font is set to italic, false if it is not.

FontWeight

number

The weight of the font (how 'dark' the text will appear):

CONSTANT

VALUE

DESCRIPTION

FW_DONTCARE

0

Font weight not specified.

FW_THIN

100

Font weight 'thin'.

FW_EXTRALIGHT

200

Font weight 'extra-light'.

FW_LIGHT

300

Font weight 'light'.

FW_NORMAL

400

Font weight 'normal'.

FW_MEDIUM

500

Font weight 'medium'.

FW_SEMIBOLD

600

Font weight 'semi-bold'.

FW_BOLD

700

Font weight 'bold'.

FW_EXTRABOLD

800

Font weight 'extra bold'.

FW_HEAVY

900

Font weight 'heavy'.

TextColor

number

The color of the text in the listbox object.

BackgroundColor

number

The color of the listbox object's background.

Border

number

The style of the listbox object's border:

CONSTANT

VALUE

DESCRIPTION

BORDER_NONE

0

No border.

BORDER_FLAT

1

'Flat' border.

BORDER_SUNKEN

2

Sunken border.

ReadOrder

number

How text will be displayed in the listbox object:

CONSTANT

VALUE

DESCRIPTION

READ_STANDARD

0

Display the characters left to right.

READ_RIGHT_TO_LEFT

1

Display the characters right to left.

Enabled

boolean

True if the listbox object is enabled, false if it is not.

Visible

boolean

True if the listbox object is visible, false if it is not.

X

number

The horizontal position (in pixels) of the top left corner of the listbox object in relation to the current page.

Note: The top left corner of the current page has an X value of 0

Y

number

The vertical position (in pixels) of the top left corner of the listbox object in relation to the current page.

Note: The top left corner of the current page has a Y value of 0

Width

number

The width (in pixels) of the listbox object.

Height

number

The height (in pixels) of the listbox object.

TooltipText

string

The mouseover tooltip of the listbox object.

WindowHandle

number

The integer value that represents the object's window. (Commonly referred to as an hWnd.)

If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.

ResultVariable

When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.

See also:  Related Actions