Progress.GetProperties

OverviewExamples

table Progress.GetProperties (

string ObjectName )

Description

Returns a table containing the properties of a progress object.

Parameters

ObjectName

(string) The name of the progress object.

Returns

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

KEY

TYPE

DESCRIPTION

ObjectName

string

The name of the progress object.

Text

string

The text displayed in the progress object.

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'.

FontScript

number

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

Style

number

The style of the progress bar:

CONSTANT

VALUE

DESCRIPTION

STYLE_BARS

0

The progress bar is divided into 'blocks'.

STYLE_SMOOTH

1

The progress bar is 'smooth'.

Orientation

number

The orientation of the progress bar:

CONSTANT

VALUE

DESCRIPTION

ORIENT_HORIZONTAL

0

Horizontal progress bar.

ORIENT_VERTICAL

1

Vertical progress bar.

MinRange

number

The beginning position of the progress bar.

MaxRange

number

The ending position of the progress bar.

Step

number

The step size that will be used whenever Progress.StepIt is called.

UseCustomColors

boolean

True if the object is set to use custom colors, or false if it is set to use the default Windows style.

BarColor

number

The color of the progress portion of the progress bar.

BackgroundColor

number

The color of the background of the progress bar.

TextColor

number

The color of the text in the progress bar.

XPStyle

boolean

True if the bar is 'XP' styled, false if it is not.

Enabled

boolean

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

Visible

boolean

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

X

number

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

Height

number

The height (in pixels) of the progress object.

TooltipText

string

The mouseover tooltip of the progress 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