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
PDF.GetProperties
OverviewExamples
table PDF.GetProperties ( string ObjectName )
De s cr ip t ion
Returns a table containing the properties of a PDF object.
P arame t er s
ObjectName
(string) The name of the PDF object.
Re t u r n s
(table) A table containing the PDF object's properties, indexed by the following keys:
|
CONSTANT |
VALUE DESCRIPTION |
|
|
LAYOUT_USER_PREF |
"DontCare" |
Current user preference. |
|
LAYOUT_SINGLE_PAGE |
"SinglePage" |
Showing single page. |
|
LAYOUT_ONE_COLUMN |
"OneColumn" |
Showing one column in continu |
|
LAYOUT_TWO_COLUMN_L |
"TwoColumnLeft" |
Showing two columns in contin on the left. |
|
LAYOUT_TWO_COLUMN_R |
"TwoColumnRight" |
Showing two columns in contin on right. |
|
KEY |
TYPE DESCRIPTION |
|
|
ObjectName |
string |
The name of the PDF object. |
|
File |
string |
The currently loaded PDF File (*.pdf). |
|
ShowScrollbars |
boolean |
True if vertical and horizontal scrollbars are shown, false if they are not. |
|
ShowToolbar |
boolean |
True if the toolbar is shown, false if it is not. |
|
ShowBorder |
boolean |
True if a border is shown, false if it is not. |
|
Layout |
string |
The layout mode set for the page: |
u
u
|
CONSTANT |
VALUE DESCRIPTION |
|
|
VIEW_PAGE |
"Fit" |
Fit entire page, both vertically and ho |
|
VIEW_WIDTH |
"FitH" |
Fit the width of the page. |
|
VIEW_HEIGHT |
"FitV" |
Fit the height of the page. |
|
VIEW_BOUNDING |
"FitB" |
Fit the bounding box (visible text are horizontally. |
|
VIEW_BOUNDING_WIDTH |
"FitBH" |
Fit the width of the bounding box (vis |
|
VIEW_BOUNDING_HEIGHT |
"FitBV" |
Fit the height of the bounding box (vi |
|
VIEW_ACTUAL_SIZE |
"ActualSize" |
Show the document at its actual size |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
PAGE_STANDARD |
"none" |
Just showing document, no book |
|
PAGE_BOOKMARKS |
"bookmarks" |
Showing document and bookmar |
|
PAGE_THUMBS |
"thumbs" |
Showing document and thumbna |
|
Page |
string |
The page mode set for the object: |
|
View |
string |
The view of the page currently set within the object: |
|
ViewOffset |
number |
The horizontal (left), or vertical (top) offset based on the View setting. |
|
Enabled |
boolean |
True if the PDF object is enabled, false if it is not. |
|
Visible |
boolean |
True if the PDF object is visible, false if it is not. |
|
X |
number |
The horizontal position (in pixels) of the top left corner of the PDF object in relation to the |
|
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 PDF object in relation to the cu |
|
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 PDF object. |
|
Height |
number |
The height (in pixels) of the PDF 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 n |
|
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 |
o
If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.