FlexTree

Top  Previous  Next

 

FlexTree

 

Behavior Pattern: FlexTreeBehavior

 

Property Summary

 

Property

Description

Getter

Setter

AllowMultipleSelection

 

GetAllowMultipleSelection


Alpha

 

GetAlpha


AlternatingRowColors

 

GetAlternatingRowColors


AutomationClassName

 

GetAutomationClassName


AutomationIndex

 

GetAutomationIndex


AutomationName

 

GetAutomationName


BackgroundDisabledColor

 

GetBackgroundDisabledColor


ClassName

 

GetClassName


ColumnCount

 

GetColumnCount


ColumnWidth

 

GetColumnWidth


CurrentState

 

GetCurrentState


DataTipField

 

GetDataTipField


DepthColors

 

GetDepthColors


Editable

 

GetEditable


Enabled

 

GetEnabled


ErrorColor

 

GetErrorColor


ErrorString

 

GetErrorString


FlexX

 

GetFlexX


FlexY

 

GetFlexY


FocusAlpha

 

GetFocusAlpha


FocusEnabled

 

GetFocusEnabled


Height

 

GetHeight


IconField

 

GetIconField


Id

 

GetId


Indentation

 

GetIndentation


LabelField

 

GetLabelField


LockedColumnCount

 

GetLockedColumnCount


LockedRowCount

 

GetLockedRowCount


MouseEnabled

 

GetMouseEnabled


NumAutomationChildren

 

GetNumAutomationChildren


PercentHeight

 

GetPercentHeight


PercentWidth

 

GetPercentWidth


RollOverColor

 

GetRollOverColor


RowCount

 

GetRowCount


RowHeight

 

GetRowHeight


ScaleX

 

GetScaleX


ScaleY

 

GetScaleY


Selectable

 

GetSelectable


SelectedIndex

 

GetSelectedIndex


SelectedIndices

 

GetSelectedIndices


SelectedItem

 

GetSelectedItem


SelectedItems

 

GetSelectedItems


SelectionColor

 

GetSelectionColor


SelectionDisabledColor

 

GetSelectionDisabledColor


ShowDataTips

 

GetShowDataTips


TabChildren

 

GetTabChildren


TabEnabled

 

GetTabEnabled


TabIndex

 

GetTabIndex


TextDisabledColor

 

GetTextDisabledColor


TextRollOverColor

 

GetTextRollOverColor


TextSelectedColor

 

GetTextSelectedColor


ThemeColor

 

GetThemeColor


ToolTip

 

GetToolTip


UseHandCursor

 

GetUseHandCursor


UseRollOver

 

GetUseRollOver


VariableRowHeight

 

GetVariableRowHeight


VerticalAlign

 

GetVerticalAlign


Visible

 

GetVisible


Width

 

GetWidth


WordWrap

 

GetWordWrap


X

 

GetX


Y

 

GetY


 

Action Summary

 

Action

Description

DoChangeFocus

 

DoClick

 

DoClose

 

DoDeselect

 

DoDoubleClick

 

DoDragCancel

 

DoDragDrop

 

DoDragStart

 

DoMouseMove

 

DoMouseScroll

 

DoMultiSelect

 

DoOpen

 

DoScroll

 

DoSelect

 

DoType

 

 

Property Detail

 

AllowMultipleSelection

 

Accessors: GetAllowMultipleSelection

 

Alpha

 

Accessors: GetAlpha

 

AlternatingRowColors

 

Accessors: GetAlternatingRowColors

 

AutomationClassName

 

Accessors: GetAutomationClassName

 

AutomationIndex

 

Accessors: GetAutomationIndex

 

AutomationName

 

Accessors: GetAutomationName

 

BackgroundDisabledColor

 

Accessors: GetBackgroundDisabledColor

 

ClassName

 

Accessors: GetClassName

 

ColumnCount

 

Accessors: GetColumnCount

 

ColumnWidth

 

Accessors: GetColumnWidth

 

CurrentState

 

Accessors: GetCurrentState

 

DataTipField

 

Accessors: GetDataTipField

 

DepthColors

 

Accessors: GetDepthColors

 

Editable

 

Accessors: GetEditable

 

Enabled

 

Accessors: GetEnabled

 

ErrorColor

 

Accessors: GetErrorColor

 

ErrorString

 

Accessors: GetErrorString

 

FlexX

 

Accessors: GetFlexX

 

FlexY

 

Accessors: GetFlexY

 

FocusAlpha

 

Accessors: GetFocusAlpha

 

FocusEnabled

 

Accessors: GetFocusEnabled

 

Height

 

Accessors: GetHeight

 

IconField

 

Accessors: GetIconField

 

Id

 

Accessors: GetId

 

Indentation

 

Accessors: GetIndentation

 

LabelField

 

Accessors: GetLabelField

 

LockedColumnCount

 

Accessors: GetLockedColumnCount

 

LockedRowCount

 

Accessors: GetLockedRowCount

 

MouseEnabled

 

Accessors: GetMouseEnabled

 

NumAutomationChildren

 

Accessors: GetNumAutomationChildren

 

PercentHeight

 

Accessors: GetPercentHeight

 

PercentWidth

 

Accessors: GetPercentWidth

 

RollOverColor

 

Accessors: GetRollOverColor

 

RowCount

 

Accessors: GetRowCount

 

RowHeight

 

Accessors: GetRowHeight

 

ScaleX

 

Accessors: GetScaleX

 

ScaleY

 

Accessors: GetScaleY

 

Selectable

 

Accessors: GetSelectable

 

SelectedIndex

 

Accessors: GetSelectedIndex

 

SelectedIndices

 

Accessors: GetSelectedIndices

 

SelectedItem

 

Accessors: GetSelectedItem

 

SelectedItems

 

Accessors: GetSelectedItems

 

SelectionColor

 

Accessors: GetSelectionColor

 

SelectionDisabledColor

 

Accessors: GetSelectionDisabledColor

 

ShowDataTips

 

Accessors: GetShowDataTips

 

TabChildren

 

Accessors: GetTabChildren

 

TabEnabled

 

Accessors: GetTabEnabled

 

TabIndex

 

Accessors: GetTabIndex

 

TextDisabledColor

 

Accessors: GetTextDisabledColor

 

TextRollOverColor

 

Accessors: GetTextRollOverColor

 

TextSelectedColor

 

Accessors: GetTextSelectedColor

 

ThemeColor

 

Accessors: GetThemeColor

 

ToolTip

 

Accessors: GetToolTip

 

UseHandCursor

 

Accessors: GetUseHandCursor

 

UseRollOver

 

Accessors: GetUseRollOver

 

VariableRowHeight

 

Accessors: GetVariableRowHeight

 

VerticalAlign

 

Accessors: GetVerticalAlign

 

Visible

 

Accessors: GetVisible

 

Width

 

Accessors: GetWidth

 

WordWrap

 

Accessors: GetWordWrap

 

X

 

Accessors: GetX

 

Y

 

Accessors: GetY

 

Action Detail

 

DoChangeFocus(shiftKey, keyCode)

 

 

Parameters:

 

Name

Type

Description

shiftKey

Boolean


Optional, Default: false.

keyCode

String


Optional, Default: TAB.

 

DoClick(keyModifier)

 

 

Parameters:

 

Name

Type

Description

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

DoClose(itemRenderer, triggerEvent)

 

 

Parameters:

 

Name

Type

Description

itemRenderer

String

triggerEvent

Number


FlexTriggerEventValues
1flexMouse
2flexKeyboard


Optional, Default: 1.

 

DoDeselect(itemRenderer, triggerEvent, keyModifier)

 

 

Parameters:

 

Name

Type

Description

itemRenderer

String

triggerEvent

Number


FlexTriggerEventValues
1flexMouse
2flexKeyboard


Optional, Default: 1.

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

DoDoubleClick(itemRenderer)

 

 

Parameters:

 

Name

Type

Description

itemRenderer

String

 

DoDragCancel(keyModifier)

 

 

Parameters:

 

Name

Type

Description

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

DoDragDrop(action, draggedItem, keyModifier)

 

 

Parameters:

 

Name

Type

Description

action

String

draggedItem

String


Optional.

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

DoDragStart(draggedItem, keyModifier)

 

 

Parameters:

 

Name

Type

Description

draggedItem

String

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

DoMouseMove(localX, localY, keyModifier)

 

 

Parameters:

 

Name

Type

Description

localX

Number


Optional, Default: 0.

localY

Number


Optional, Default: 0.

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

DoMouseScroll(delta)

 

 

Parameters:

 

Name

Type

Description

delta

Number


Optional, Default: 0.

 

DoMultiSelect(itemRenderer, triggerEvent, keyModifier)

 

 

Parameters:

 

Name

Type

Description

itemRenderer

String

triggerEvent

Number


FlexTriggerEventValues
1flexMouse
2flexKeyboard


Optional, Default: 1.

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

DoOpen(itemRenderer, triggerEvent)

 

 

Parameters:

 

Name

Type

Description

itemRenderer

String

triggerEvent

Number


FlexTriggerEventValues
1flexMouse
2flexKeyboard


Optional, Default: 1.

 

DoScroll(position, direction, detail)

 

 

Parameters:

 

Name

Type

Description

position

Number

direction

Number


FlexScrollDirectionValues
1flexScrollHorizontal
2flexScrollVertical

detail

Number


FlexScrollDetailValues
1flexAtBottom
2flexAtLeft
3flexAtRight
4flexAtTop
5flexLineDown
6flexLineLeft
7flexLineRight
8flexLineUp
9flexPageDown
10flexPageLeft
11flexPageRight
12flexPageUp
13flexThumbPosition
14flexThumbTrack


Optional, Default: null.

 

DoSelect(itemRenderer, triggerEvent, keyModifier)

 

 

Parameters:

 

Name

Type

Description

itemRenderer

String

triggerEvent

Number


FlexTriggerEventValues
1flexMouse
2flexKeyboard


Optional, Default: 1.

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

DoType(keyCode, keyModifier)

 

 

Parameters:

 

Name

Type

Description

keyCode

String

keyModifier

Number


FlexKeyModifierValues
1flexControl
2flexShift
4flexAlt
3flexControlShift
5flexControlAlt
6flexShiftAlt
7flexControlShiftAlt


Optional, Default: 0.

 

Behavior Pattern: Win32Generic

 

Property Summary

 

Property

Description

Getter

Setter

Bitmap

UI Image of the object.

GetBitmap


BWBitmap

UI Image of the object in 1-bit format (black&white).

GetBWBitmap


Class

Class of the object.

GetClass


Height

Height of the object.

GetHeight


Name

Name of the object.

GetName


ObjectType

SeSMatcherRule type for this object.

GetObjectType


State

State of the object.

GetState


Value

Value of the object.

GetValue

SetValue

Width

Width of the object.

GetWidth


WindowText

Window text of the object.

GetWindowText

SetWindowText

X

X-coordinate of the top left corner of the object.

GetX


Y

Y-coordinate of the top left corner of the object.

GetY


 

Action Summary

 

Action

Description

DoAction

Performs default action for an object.

DoAnalogPlay

Plays analog recording using coordinates relative to this object.

DoClick

Performs left click at the center of an object.

DoEnsureVisible

Makes sure specified element is visible on the screen.

DoLButtonDown

Performs left mouse button down.

DoLButtonUp

Performs left mouse button up.

DoLClick

Performs a left click at the center of an object or at the specified location.

DoLDClick

Performs a left double click at the center of an object or at the specified location.

DoMButtonDown

Performs middle mouse button down.

DoMButtonUp

Performs middle mouse button up.

DoMClick

Performs a middle click at the center of an object or at the specified location.

DoMDClick

Performs a middle double click at the center of an object or at the specified location.

DoMouseMove

Moves mouse cursor to a location relative to this object position.

DoRButtonDown

Performs right mouse button down.

DoRButtonUp

Performs right mouse button up.

DoRClick

Performs a right click at the center of an object or at the specified location.

DoRDClick

Performs a right double click at the center of an object or at the specified location.

DoSendKeys

Sends series of keystrokes to an object.

 

Property Detail

 

Bitmap

UI Image of the object.

Accessors: GetBitmap

 

BWBitmap

UI Image of the object in 1-bit format (black&white).

Accessors: GetBWBitmap

 

Class

Class of the object.

Accessors: GetClass

 

Height

Height of the object.

Accessors: GetHeight

 

Name

Name of the object.

Accessors: GetName

 

ObjectType

SeSMatcherRule type for this object.

Accessors: GetObjectType

 

State

State of the object.

Accessors: GetState

 

Value

Value of the object.

Accessors: GetValue, SetValue

 

Width

Width of the object.

Accessors: GetWidth

 

WindowText

Window text of the object.

Accessors: GetWindowText, SetWindowText

 

X

X-coordinate of the top left corner of the object.

Accessors: GetX

 

Y

Y-coordinate of the top left corner of the object.

Accessors: GetY

 

Action Detail

 

DoAction()

Performs default action for an object. If the object doesn't have default action then 'LClick' is performed.

 

DoAnalogPlay(path, left, top)

Plays analog recording using coordinates relative to this object.

 

Parameters:

 

Name

Type

Description

path

string

Path to analog recording (usually an .arf file).

left

number

X-coordinate of top-left corner of the analog area, relative to object top-left corner
Optional.

top

number

Y-coordinate of the top-left corner of the analog area, relative to object top-left corner.
Optional.

 

DoClick(clickType, xOffset, yOffset)

Performs left click at the center of an object. It is a customizable variant of LClick action.

 

Parameters:

 

Name

Type

Description

clickType

string

Type of click, can be one of "L" - left click, "LD" - double left click, "R" - right click, "RD" - double right click, "M" - middle click, "MD" - double middle click, "N" - don't click
Optional, Default: L.

xOffset

number

X offset to click within object. Default is a center.
Optional.

yOffset

number

X offset to click within object. Default is a center.
Optional.

 

Returns:

 

'true' if operation is successful, 'false' otherwise

 

DoEnsureVisible()

Makes sure specified element is visible on the screen.

 

DoLButtonDown()

Performs left mouse button down. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: This action must be followed by 'DoLButtonUp', otherwise it may lock mouse cursor.

 

DoLButtonUp()

Performs left mouse button up. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: Use this action after 'DoLButtonDown', otherwise it will have no effect.

 

DoLClick(x, y)

Performs a left click at the center of an object or at the specified location.

 

Parameters:

 

Name

Type

Description

x

number

X-coordinate of location relative to object's left border

y

number

Y-coordinate of location relative to object's top border

 

Returns:

 

'true' if operation is successful, 'false' otherwise

 

DoLDClick(x, y)

Performs a left double click at the center of an object or at the specified location.

 

Parameters:

 

Name

Type

Description

x

number

X-coordinate of location relative to object's left border

y

number

Y-coordinate of location relative to object's top border

 

Returns:

 

'true' if operation is successful, 'false' otherwise

 

DoMButtonDown()

Performs middle mouse button down. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: This action must be followed by 'DoMButtonUp', otherwise it may lock mouse cursor.

 

DoMButtonUp()

Performs middle mouse button up. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: Use this action after 'DoMButtonDown', otherwise it will have no effect.

 

DoMClick(x, y)

Performs a middle click at the center of an object or at the specified location.

 

Parameters:

 

Name

Type

Description

x

number

X-coordinate of location relative to object's left border

y

number

Y-coordinate of location relative to object's top border

 

Returns:

 

'true' if operation is successful, 'false' otherwise

 

DoMDClick(x, y)

Performs a middle double click at the center of an object or at the specified location.

 

Parameters:

 

Name

Type

Description

x

number

X-coordinate of location relative to object's left border

y

number

Y-coordinate of location relative to object's top border

 

Returns:

 

'true' if operation is successful, 'false' otherwise

 

DoMouseMove(x, y)

Moves mouse cursor to a location relative to this object position.

 

Parameters:

 

Name

Type

Description

x

number

X-coordinate of location relative to object's left border

y

number

Y-coordinate of location relative to object's top border

 

DoRButtonDown()

Performs right mouse button down. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: This action must be followed by 'DoRButtonUp', otherwise it may lock mouse cursor.

 

DoRButtonUp()

Performs right mouse button up. This method does not change cursor coordinates. Make sure that you use 'DoMouseMove' to position mouse cursor properly before calling this method. Note: Use this action after 'DoRButtonDown', otherwise it will have no effect.

 

DoRClick(x, y)

Performs a right click at the center of an object or at the specified location.

 

Parameters:

 

Name

Type

Description

x

number

X-coordinate of location relative to object's left border

y

number

Y-coordinate of location relative to object's top border

 

Returns:

 

'true' if operation is successful, 'false' otherwise

 

DoRDClick(x, y)

Performs a right double click at the center of an object or at the specified location.

 

Parameters:

 

Name

Type

Description

x

number

X-coordinate of location relative to object's left border

y

number

Y-coordinate of location relative to object's top border

 

Returns:

 

'true' if operation is successful, 'false' otherwise

 

DoSendKeys(keys)

Sends series of keystrokes to an object. For example: DoSendKeys('^F') - sends {CTRL} + {F}. See MSDN Article for SendKeys

 

Parameters:

 

Name

Type

Description

keys

string

A sequence of keystrokes.