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
Application.GetPageProperties
OverviewExamples
table Application.GetPageProperties ( string PageName )
De s cr ip t ion
Returns a table containing the properties of the specified page.
P arame t er s
PageName
(string) The name of the page whose properties you want.
Re t u r n s
(table) A table containing the page's properties indexed by the following keys. If the page doesn't exist or an error occurs, nil is returned.
|
KEY |
TYPE DESCRIPTION |
|
|
UseCustomSettings |
boolean |
True if custom colors are being used, or false if the default background color for windows applications is being used. Note: If you skin your application, the default color will come from your skin file. |
|
BackgroundType |
number |
The type of background: BG_SOLID (0), BG_GRADIENT (1), BG_IMAGE (2) |
|
BackgroundColor |
number |
The numeric value of the background color. |
|
GradientColorTop |
number |
The numeric value of the gradient top color. Only applicable if BackgroundType = BG_GRADIENT. |
|
ImageFilename |
string |
The path to the image file to be used for the background image if BackgroundType = BG_IMAGE. |
|
ImageStretchMode |
number |
The type of image stretching to be performed if BackgroundType = BG_IMAGE. Choose from BG_IMAGE_FITPAGE (0), BG_IMAGE_TILE (1), BG_IMAGE_ACTUALSIZE (2). |
|
Description |
string |
The page's description value. |
|
Keywords |
table |
A one-based numerically indexed list of keywords for the page. |