|
FlexButtonBar
Behavior Pattern: FlexButtonBarBehavior
Property Summary
Action Summary
Property Detail
Alpha
Accessors: GetAlpha
AutomationClassName
Accessors: GetAutomationClassName
AutomationIndex
Accessors: GetAutomationIndex
AutomationName
Accessors: GetAutomationName
BackgroundAlpha
Accessors: GetBackgroundAlpha
BackgroundColor
Accessors: GetBackgroundColor
BackgroundDisabledColor
Accessors: GetBackgroundDisabledColor
BackgroundImage
Accessors: GetBackgroundImage
BackgroundSize
Accessors: GetBackgroundSize
ClassName
Accessors: GetClassName
CreationIndex
Accessors: GetCreationIndex
CreationPolicy
Accessors: GetCreationPolicy
CurrentState
Accessors: GetCurrentState
Direction
Accessors: GetDirection
Enabled
Accessors: GetEnabled
ErrorColor
Accessors: GetErrorColor
ErrorString
Accessors: GetErrorString
FillAlphas
Accessors: GetFillAlphas
FillColors
Accessors: GetFillColors
FlexX
Accessors: GetFlexX
FlexY
Accessors: GetFlexY
FocusEnabled
Accessors: GetFocusEnabled
FontFamily
Accessors: GetFontFamily
FontSize
Accessors: GetFontSize
FontStyle
Accessors: GetFontStyle
FontWeight
Accessors: GetFontWeight
Height
Accessors: GetHeight
HorizontalAlign
Accessors: GetHorizontalAlign
Id
Accessors: GetId
Label
Accessors: GetLabel
MouseEnabled
Accessors: GetMouseEnabled
NumAutomationChildren
Accessors: GetNumAutomationChildren
NumChildren
Accessors: GetNumChildren
PercentHeight
Accessors: GetPercentHeight
PercentWidth
Accessors: GetPercentWidth
ScaleX
Accessors: GetScaleX
ScaleY
Accessors: GetScaleY
SelectedIndex
Accessors: GetSelectedIndex
TabChildren
Accessors: GetTabChildren
TabEnabled
Accessors: GetTabEnabled
TabIndex
Accessors: GetTabIndex
ThemeColor
Accessors: GetThemeColor
ToolTip
Accessors: GetToolTip
UseHandCursor
Accessors: GetUseHandCursor
VerticalAlign
Accessors: GetVerticalAlign
Visible
Accessors: GetVisible
Width
Accessors: GetWidth
X
Accessors: GetX
Y
Accessors: GetY
Action Detail
DoChange(relatedObject)
Parameters:
Name
|
Type
|
Description
|
relatedObject
|
String
|
|
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 |
| 1 | flexControl |
| 2 | flexShift |
| 4 | flexAlt |
| 3 | flexControlShift |
| 5 | flexControlAlt |
| 6 | flexShiftAlt |
| 7 | flexControlShiftAlt |
Optional, Default: 0.
|
DoDragCancel(keyModifier)
Parameters:
Name
|
Type
|
Description
|
keyModifier
|
Number
|
| FlexKeyModifierValues |
| 1 | flexControl |
| 2 | flexShift |
| 4 | flexAlt |
| 3 | flexControlShift |
| 5 | flexControlAlt |
| 6 | flexShiftAlt |
| 7 | flexControlShiftAlt |
Optional, Default: 0.
|
DoDragDrop(action, draggedItem, keyModifier)
Parameters:
Name
|
Type
|
Description
|
action
|
String
|
|
draggedItem
|
String
|
Optional.
|
keyModifier
|
Number
|
| FlexKeyModifierValues |
| 1 | flexControl |
| 2 | flexShift |
| 4 | flexAlt |
| 3 | flexControlShift |
| 5 | flexControlAlt |
| 6 | flexShiftAlt |
| 7 | flexControlShiftAlt |
Optional, Default: 0.
|
DoDragStart(draggedItem, keyModifier)
Parameters:
Name
|
Type
|
Description
|
draggedItem
|
String
|
|
keyModifier
|
Number
|
| FlexKeyModifierValues |
| 1 | flexControl |
| 2 | flexShift |
| 4 | flexAlt |
| 3 | flexControlShift |
| 5 | flexControlAlt |
| 6 | flexShiftAlt |
| 7 | flexControlShiftAlt |
Optional, Default: 0.
|
DoMouseMove(localX, localY, keyModifier)
Parameters:
Name
|
Type
|
Description
|
localX
|
Number
|
Optional, Default: 0.
|
localY
|
Number
|
Optional, Default: 0.
|
keyModifier
|
Number
|
| FlexKeyModifierValues |
| 1 | flexControl |
| 2 | flexShift |
| 4 | flexAlt |
| 3 | flexControlShift |
| 5 | flexControlAlt |
| 6 | flexShiftAlt |
| 7 | flexControlShiftAlt |
Optional, Default: 0.
|
DoMouseScroll(delta)
Parameters:
Name
|
Type
|
Description
|
delta
|
Number
|
Optional, Default: 0.
|
DoScroll(position, direction, detail)
Parameters:
Name
|
Type
|
Description
|
position
|
Number
|
|
direction
|
Number
|
| FlexScrollDirectionValues |
| 1 | flexScrollHorizontal |
| 2 | flexScrollVertical |
|
detail
|
Number
|
| FlexScrollDetailValues |
| 1 | flexAtBottom |
| 2 | flexAtLeft |
| 3 | flexAtRight |
| 4 | flexAtTop |
| 5 | flexLineDown |
| 6 | flexLineLeft |
| 7 | flexLineRight |
| 8 | flexLineUp |
| 9 | flexPageDown |
| 10 | flexPageLeft |
| 11 | flexPageRight |
| 12 | flexPageUp |
| 13 | flexThumbPosition |
| 14 | flexThumbTrack |
Optional, Default: null.
|
DoType(keyCode, keyModifier)
Parameters:
Name
|
Type
|
Description
|
keyCode
|
String
|
|
keyModifier
|
Number
|
| FlexKeyModifierValues |
| 1 | flexControl |
| 2 | flexShift |
| 4 | flexAlt |
| 3 | flexControlShift |
| 5 | flexControlAlt |
| 6 | flexShiftAlt |
| 7 | flexControlShiftAlt |
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.
|
|