Tree.GetProperties

 OverviewExamples

table Tree.GetProperties ( 

string ObjectName )

Description

Returns a table containing the properties of a tree object.

Parameters

ObjectName

(string) The name of the tree object.

Returns

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

KEY

TYPE

DESCRIPTION

ObjectName

string

The name of the tree object.

ShowCheckBoxes

boolean

True if checkboxes will be shown, false if they will not be.

HasLines

boolean

True if the tree object will display lines, false if it will not.

LinesAtRoot

boolean

True if the tree object will display lines at the root level, false if it will not.

HasButtons

boolean

True if the tree object will have expand/collapse buttons, false if it will not.

EditLabels

boolean

True if the user can edit the item labels, false if they can't.

AlwaysShowSelection

boolean

True if the current item will remain selected when the tree object looses focus, false if it will not.

FontName

string

The name of the font currently in use in the tree object.

FontSize

number

The font size currently displayed in the tree object.

FontStrikeout

boolean

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

FontUnderline

boolean

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

FontItalic

boolean

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

FontAntiAlias

boolean

True if the current font is set to anti alias, 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'.

FontScript

number

The character set in use by the paragraph 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.

BackgroundColor

number

The currently displayed background color.

TextColor

number

The currently displayed text color.

BorderMode

number

The border mode in use by the tree object. Choose from:

CONSTANT

VALUE

DESCRIPTION

BORDER_NONE

0

No border.

BORDER_FLAT

1

Flat border.

BORDER_SUNKEN

2

Sunken border.

UseImageList

boolean

True if the tree object uses an image list, false if it does not.

ImageList

string

The path to a bitmap file (24bit max) containing 16x16 icons being used as icons for items in the tree list.

ImageListTransColor

number

The decimal value of the color that is transparent in the image list. This color is used to represent transparency in the image.

ReadOrder

number

How text will be displayed in the tree 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 tree object is enabled, false if it is not.

Visible

boolean

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

X

number

The horizontal position (in pixels) of the top left corner of the tree 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 tree 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 tree object.

Height

number

The height (in pixels) of the tree object.

TooltipText

string

The mouseover tooltip of the tree object.

ResizeLeft

boolean

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

ResizeRight

boolean

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

ResizeTop

boolean

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

ResizeBottom

boolean

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

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