|

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


image

image

xButton.GetProperties

OverviewExamples

table xButton.GetProperties ( string ObjectName )


De s cr ip t ion


Returns a table containing the properties of an xButton object.


P arame t er s


ObjectName


(string) The name of the xButton object.


Re t u r n s


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



KEY


TYPE DESCRIPTION


ObjectName


string


The name of the xButton object.


Text


string


The text displayed on the xButton object.


ButtonImage


string


The full path to the image file displayed on the xButton object.


TextColor


number


The color of the text.


EnableMarkup


boolean


True if text markup is enabled, false if it is not.


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


GB2312_CHARSET


134


GB2312 character set.


GREEK_CHARSET


161


Greek character set.


HANGUL_CHARSET


129


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



TextAlignment


number


The text alignment in use:


CONSTANT


VALUE DESCRIPTION


XBTN_ALIGN_MIDDLE_LEFT


0


Text is middle left aligned.


XBTN_ALIGN_MIDDLE_RIGHT


1


Text is middle right aligned.


XBTN_ALIGN_MIDDLE_CENTER


2


Text is middle center aligned.


XBTN_ALIGN_TOP_LEFT


3


Text is top left aligned.


XBTN_ALIGN_TOP_RIGHT


4


Text is top right aligned.


XBTN_ALIGN_TOP_CENTER


5


Text is top center aligned.


XBTN_ALIGN_BOTTOM_LEFT


6


Text is bottom left aligned.


XBTN_ALIGN_BOTTOM_RIGHT


7


Text is bottom right aligned.


XBTN_ALIGN_BOTTOM_CENTER


8


Text is bottom center aligned.


CONSTANT


VALUE DESCRIPTION


XBTN_ALIGN_MIDDLE_LEFT


0


Image is middle left aligned.


XBTN_ALIGN_MIDDLE_RIGHT


1


Image is middle right aligned.


XBTN_ALIGN_MIDDLE_CENTER


2


Image is middle center aligned.


XBTN_ALIGN_TOP_LEFT


3


Image is top left aligned.


XBTN_ALIGN_TOP_RIGHT


4


Image is top right aligned.


XBTN_ALIGN_TOP_CENTER


5


Image is top center aligned.


XBTN_ALIGN_BOTTOM_LEFT


6


Image is bottom left aligned.


XBTN_ALIGN_BOTTOM_RIGHT


7


Image is bottom right aligned.


XBTN_ALIGN_BOTTOM_CENTER


8


Image is bottom center aligned.

image



XBTN_ALIGN_BOTTOM_CENTER 8 Text is bottom

center aligned.


ImageAlignment


number


The image alignment in use:


ImageTextRelation


number


The relationship between the text and image:


CONSTANT


VALUE DESCRIPTION

RELATION_OVERLAY

0

Image is

displayed over top of


CONSTANT


VALUE DESCRIPTION


THEME_STANDARD


0


Standard theme.


THEME_FLAT


1


Flat theme.


THEME_ULTRA_FLAT


2


Ultra flat theme.


THEME_OFFICE_2000


3


Office 2000 theme.


THEME_OFFICE_XP


4


Office XP theme.


THEME_OFFICE_2003


5


Office 2003 theme.


THEME_OFFICE_2007


6


Office 2007 theme.


displayed over top of the text.


RELATION_IMAGE_ABOVE_TEXT


1


Image is displayed above the text.


RELATION_TEXT_ABOVE_IMAGE


2


Text is displayed above the image.


RELATION_IMAGE_BEFORE_TEXT


3


Image is displayed before (to the left) of the text.


RELATION_TEXT_BEFORE_IMAGE


4


Text is displayed before (to the left) of the image.



Theme


number


The visual theme of the xButton:


Style


number


The style of the xButton object:


CONSTANT


VALUE DESCRIPTION


BTN_UP


0


xButton is in its up state.


BTN_DOWN


1


xButton is in its down state.


CONSTANT


VALUE DESCRIPTION


BTNSTYLE_STANDARD


0


xButton is a standard button.


BTNSTYLE_TOGGLE


1


xButton is a toggle button.



ToggleState


number


The current toggle state of the xButton object.


Enabled


boolean


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


Visible


boolean


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


X


number


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


Height


number


The height (in pixels) of the xButton object.


TooltipText


string


The mouseover tooltip of the xButton object.


Cursor


number


The mouse cursor that will be displayed when the mouse is over the xButton object:


CONSTANT


VALUE DESCRIPTION


CURSOR_ARROW


0


Standard mouse


CURSOR_HAND


1


Hand cursor.


CURSOR_HAND


1


Hand cursor.


CURSOR_BLACK_ARROW


2


Black arrow cursor.


CURSOR_CROSSHAIR


3


Crosshair cursor.


CURSOR_EXPLORE


4


Explore cursor.


CURSOR_HELP


5


Help cursor.


CURSOR_MAGNIFY


6


Magnify cursor.


CURSOR_MEDIA


7


Media cursor.


CURSOR_MONEY


8


Money cursor.


CURSOR_NOTEPAD


9


Notepad cursor.


CURSOR_PENCIL


10


Pencil cursor.


CURSOR_PRINTER


11


Printer cursor.


CURSOR_SPEAKER


12


Speaker cursor.


CURSOR_UP_ARROW


13


Up arrow cursor.



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.


HighlightSound


number


The type of sound that will be played when the mouse moves over the xButton object.


CONSTANT


VALUE DESCRIPTION

SND_NONE

0

No highlight sound.



HighlightSoundFile


string


The path to the xButton object's custom highlight sound file. If the xButton object does not use a custom sound, this value will be an empty string ("").


ClickSound


number


The type of sound that will be played when the mouse clicks the xButton object.


ClickSoundFile


string


The path to the xButton object's custom click sound file. If the xButton object does not use a custom sound, this value will be an empty string ("").


WindowHandle


number


The integer value that represents the object's window. (Commonly referred to as an hWnd.)



SND_NONE


0


No highlight sound.


SND_STANDARD


1


Standard highlight sound.


SND_CUSTOM


2


Custom highlight sound.


CONSTANT


VALUE DESCRIPTION


SND_NONE


0


No click sound.


SND_STANDARD


1


Standard click sound.


SND_CUSTOM


2


Custom click sound.

If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.


|