ListBox.SetProperties

OverviewExamples

ListBox.SetProperties (

string ObjectName,

table Properties )

Description

Sets the properties of a listbox object.

Parameters

ObjectName

(string) The name of the listbox object.

Properties

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

KEY

TYPE

DESCRIPTION

ListBoxType

number

A number representing the type of list box:

CONSTANT

VALUE

DESCRIPTION

LB_LISTBOX

0

The object is a normal list box.

LB_CHECKLISTBOX

1

The object is a checklist box. Each item in the list box has an associated checkbox that can be checked or unchecked.

MultipleSelection

boolean

True if multiple selection should be enabled, false if it should not be.

Sort

boolean

True if the listbox should be sorted, false if it should not be.

VScrollbar

boolean

True if the vertical scrollbar should be enabled, false if it should not be.

HScrollbar

boolean

True if the horizontal scrollbar should be enabled, false if it should not be.

FontName

string

The font name.

FontSize

number

The font size (in points).

FontStrikeout

boolean

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

FontUnderline

boolean

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

FontAntiAlias

boolean

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

FontItalic

boolean

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

FontWeight

number

The weight of the font (how 'dark' the text should 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'.

FontScript

number

The character set that should be used by the listbox object:

CONSTANT

VALUE

DESCRIPTION

ANSI_CHARSET

0

ANSI character set.

BALTIC_CHARSET

186

Baltic character set.

CHINESEBIG5_CHARSET

136

Chinese character set.

DEFAULT_CHARSET

1

Default character set.

EASTEUROPE_CHARSET

238

Eastern European character set.

GB2312_CHARSET

134

GB2312 character set.

GREEK_CHARSET

161

Greek character set.

HANGUL_CHARSET

129

Hangul character set.

MAC_CHARSET

77

MAC character set.

OEM_CHARSET

255

OEM character set.

RUSSIAN_CHARSET

204

Russian character set.

SHIFTJIS_CHARSET

128

Shiftjis character set.

SYMBOL_CHARSET

2

Symbol character set.

TURKISH_CHARSET

162

Turkish character set.

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 should 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 should be enabled, false if it should not be.

Visible

boolean

True if the listbox object should be visible, false if it should not be.

X

number

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

Note: The top left corner of the current page or dialog 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 or dialog.

Note: The top left corner of the current page or dialog 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.

ResizeLeft

boolean

True if the left side of the object should move when the application is resized, false if it should not.

ResizeRight

boolean

True if the right side of the object should move when the application is resized, false if it should not.

ResizeTop

boolean

True if the top of the object should move when the application is resized, false if it should not.

ResizeBottom

boolean

True if the bottom of the object should move when the application is resized, false if it should not.

TooltipText

string

The mouseover tooltip of the listbox object. Tip: If you want a "&" character in the text, you must enter "&&&".

Returns

Nothing. You can use Application.GetLastError to determine whether this action failed, and why.

See also: Related Actions