Tree.SetProperties

 OverviewExamples

Tree.SetProperties ( 

string ObjectName,

table  Properties )

Description

Sets the properties of a tree object.

Parameters

ObjectName

(string) The name of the tree object.

Properties

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

KEY

TYPE

DESCRIPTION

ShowCheckBoxes

boolean

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

HasLines

boolean

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

LinesAtRoot

boolean

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

HasButtons

boolean

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

EditLabels

boolean

True if the user should be able to edit the item labels, false if they should not be.

AlwaysShowSelection

boolean

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

FontName

string

The name of the font to be used in the tree object.

FontSize

number

The font size to be displayed in the tree object.

FontStrikeout

boolean

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

FontUnderline

boolean

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

FontItalic

boolean

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

FontAntiAlias

boolean

True if the current font should be set to anti alias, 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 to be used 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 background color to use.

TextColor

number

The text color to use.

BorderMode

number

The border mode to use for 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 should use an image list, false if it should not.

ImageList

string

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

ImageListTransColor

number

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

ReadOrder

number

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

Visible

boolean

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

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.

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 tree 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