PDFApplication Object

Description

A PDF application object. A separate PDFApplication object is created for each PDF file you test.

Operations

The sections below list the built-in methods and properties that you can use as operations for the PDFApplication object.

Note: You can also view a list and descriptions of the PDFApplication description properties, for use in object repository descriptions, programmatic descriptions, checkpoint and output value steps, and as argument values for the GetTOProperty and GetROProperty methods.

IMPORTANT

To open a PDF document for testing, you must use the PDF Testing Utility. You can open the utility from within UFT One or using a PDFUtility.Open step.

Methods

Common Method CaptureBitmapSaves a screen capture of the object as a .png or .bmp image using the specified file name.
Common Method CheckChecks whether the actual value of an item matches the expected value.
Common Method CheckPropertyChecks whether the actual value of the specified object property matches the specified expected value within the specified timeout.
Common Method ChildObjectsReturns the collection of child objects contained within the object.
Method ClickClicks the object.
Method CloseCloses the PDF application.
Method DblClickDouble-clicks the object.
Common Method GetAllROProperties

Returns the collection of properties and current values from the object in the application.

Common Method GetROProperty

Returns the current value of the description property from the object in the application.

Method GetTextReturns all of the text contained in the PDF document.
Common Method GetTOPropertiesReturns the collection of properties and values used to identify the object.
Common Method GetTOPropertyReturns the value of the specified description property from the test object description.
Common Method HighlightHighlights the object in the application.
Method GoToPageNavigates to the specified page in the open PDF document.
Method MaximizeMaximizes the PDF application's window to fill the entire screen.
Method MinimizeMinimizes the PDF application's window to an icon.
Common Method OutputRetrieves the current value of an item and stores it in a specified location.
Common Method RefreshObjectInstructs UFT One to re-identify the object in the application being tested the next time a step refers to this object.
Method RestoreRestores the PDF application's window to its previous size.
Method SaveSaves the PDF document.
Method SetFocusActivates the selected object and brings it into focus.
Common Method SetTOPropertySets the value of the specified description property in the test object description.
Common Method ToStringReturns a string that represents the test object.
Method TypeSimulates keyboard input on the object.
Common Method WaitPropertyWaits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step.

Properties

Common Property ExistChecks whether the object currently exists in the open application.

Back to top

 

Click Method

Description

Clicks the object.

Syntax

object.Click [X], [Y], [MouseButton]

Arguments

ParameterDescription
X Optional. An integer value.
The x-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object. The default value is the center of the object.
Default value = -9999
Y Optional. An integer value.
The y-coordinate of the click. Note that the specified coordinates are relative to the upper left corner of the object.  The default value is the center of the object.


Tip: You can enter micNoCoordinate (-9999) for the x and y argument values if you want to enter a value for the button argument without specifying x- and y- coordinates for the click. micNoCoordinate indicates the center of the object.


Default value = -9999
MouseButton Optional. A predefined constant or number.
The mouse button to use for the click.
Default value = micLeftBtn

Return Type

None

Example

'The following example left-clicks in the center of the open PDF application
'and then right-clicks a specific point in it. 

PDFApplication("Sample.pdf").Click
PDFApplication("Sample.pdf").Click 50, 100, Right_Mouse_Button

Back to top

 

Close Method

Description

Closes the PDF application.

Syntax

object.Close

Return Type

None

Example

'The following example closes the PDF application window 

PDFApplication("Sample.pdf").Close

Back to top

 

DblClick Method

Description

Double-clicks the object.

Syntax

object.DblClick X, Y, [MouseButton]

Arguments

ParameterDescription
X Required. An integer value.
The x-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object.
Y Required. An integer value.
The y-coordinate of the double-click. Note that the specified coordinates are relative to the upper left corner of the object.
MouseButton Optional. A predefined constant or number.
The mouse button to use for the double-click.
Default value = micLeftBtn

Return Type

None

Back to top

 

GetText Method

Description

Returns all of the text contained in the PDF document.

Syntax

object.GetText

IMPORTANT

The text is returned in one string, without any of the text formatting that exists in the PDF Document.

Return Type

None

Example

The following example retrieves the PDF's text 

PDFApplication("Sample.pdf").GetText

Back to top

 

GoToPage Method

Description

Navigates to the specified page in the open PDF document.

Syntax

object.GoToPage PageNumber

Arguments

ParameterDescription
PageNumber

Required. An integer value.

The page to which you want to navigate.

Return Type

None

Example

'The following example opens page 3 in the open document 

PDFApplication("Sample.pdf").GoToPage 3

Back to top

 

Maximize Method

Description

Maximizes the PDF application's window to fill the entire screen.

Syntax

object.Maximize

Return Type

None

Example

'The following example maximizes the PDF application window

PDFApplication("Sample.pdf").Maximize

Back to top

 

Minimize Method

Description

Minimizes the PDF application's window to an icon.

Syntax

object.Minimize

Return Type

None

Example

'The following example minimizes the PDF application window

PDFApplication("Sample.pdf").Minimize

Back to top

 

Restore Method

Description

Restores the PDF application's window to its previous size.

Syntax

object.Restore

Return Type

None

Example

'The following example restores the PDF application window
'to its previous size

PDFApplication("Sample.pdf").Restore

Back to top

 

Save Method

Description

Saves the PDF document.

Syntax

object.Save [path] [encryptedPassword]

Arguments

ParameterDescription
path

Optional. A string value.

The full path for the PDF document. The document is saved to that location, overwriting any existing file.

Note:

  • If you do not provide a path, the document is saved in its current location, overwriting the existing file.
  • If you save the document with a different name, all subsequent steps must be performed on a different PDFApplication test object, representing the new file.
encryptedPassword

Optional. A string value. An encoded string specifying the password required to open the PDF file the next time it is opened.

To encode the password before entering it here, use the Password Encoder utility (available from the Windows Start menu).

Note:

  • This enables you to obscure password visibility, but it is not intended to be a secure way to protect password information.

  • If you do not provide a password when saving the file, this file can be opened without providing a password, even if previously opening the file required a password.

Return Type

Boolean.

True. The document was saved successfully.

False. Failed to save the file.

Example

'The following example saves the current open document, and then
'saves a copy of the file with a different name.

PDFApplication("Sample.pdf").Save
PDFApplication("Sample.pdf").Save "C:\Temp\myDocument.pdf"
'The open document switches to the new saved file. However, the
'test object expects the old name property.
'To refer to the document that is now open, you must specify a description:

PDFApplication("name:=myDocument.pdf").Click

Back to top

 

SetFocus Method

Description

Activates the selected object and brings it into focus.

Syntax

object.SetFocus

Return Type

None.

Example

'The following example sets the focus on an open PDF application.

PDFApplication("Sample.pdf").SetFocus

Back to top

 

Type Method

Description

Simulates keyboard input on the object.

Syntax

object.Type KeyboardInput

 

Arguments

ParameterDescription
KeyboardInput Required. A String value.
The text string to type or a constant representing a non-alphanumeric key. The following constants are available:
Constant
Action
micCtrlDwn
Presses the Ctrl key.
micCtrlUp
Releases the Ctrl key.
micLCtrlDwn
Presses the left Ctrl key.
micLCtrlUp
Releases the left Ctrl key.
micRCtrlDwn
Presses the right Ctrl key.
micRCtrlUp
Releases the right Ctrl key.
micAltDwn
Presses the Alt key.
micAltUp
Releases the Alt key.
micLAltDwn
Presses the left Alt key.
micLAltUp
Releases the left Alt key.
micRAltDwn
Presses the right Alt key.
micRAltUp
Releases the right Alt key.
micShiftDwn
Presses the Shift key.
micShiftUp
Releases the Shift key.
micLShiftDwn
Presses the left Shift key.
micLShiftUp
Releases the left Shift key.
micRShiftDwn
Presses the right Shift key.
micRShiftUp
Releases the right Shift key.
micIns
Presses the Insert key.
micDel
Presses the Delete key.
micHome
Presses the Home key.
micEnd
Presses the End key.
micPgUp
Presses the Page Up key.
micPgDwn
Presses the Page Down key.
micUp
Presses the Up arrow key.
micDwn
Presses the Down arrow key.
micLeft
Presses the Left arrow key.
micRight
Presses the Right arrow key.
micEsc
Presses the Esc key.
micBack
Presses the Backspace key.
micReturn
Presses the Return key.
micTab
Presses the Tab key.
micBreak
Presses the Break key.
micPause
Presses the Pause key.
micPrintScr
Presses the Print Screen key.
micWinLogoDwn
Presses the WindowsLogo key.
micWinLogoUp
Releases the WindowsLogo key.
micLWinLogoDwn
Presses the left WindowsLogo key.
micLWinLogoUp
Releases the left WindowsLogo key.
micRWinLogoDwn
Presses the right WindowsLogo key.
micRWinLogoUp
Releases the right WindowsLogo key.
micAppKey
Presses the Application key.
micF1
Presses the F1 key.
micF2
Presses the F2 key.
micF3
Presses the F3 key.
micF4
Presses the F4 key.
micF5
Presses the F5 key.
micF6
Presses the F6 key.
micF7
Presses the F7 key.
micF8
Presses the F8 key.
micF9
Presses the F9 key.
micF10
Presses the F10 key.
micF11
Presses the F11 key.
micF12
Presses the F12 key.
micNumLockOn
Turns on the Num Lock.
micCapsLockOn
Turns on the Caps Lock.
micScrollOn
Turns on the Scroll Lock.
micNumLockOff
Turns off the Num Lock.
micCapsLockOff
Turns off the Caps Lock.
micScrollOff
Turns off the Scroll Lock.

Return Type

None.

IMPORTANT

Although the Type method is supported for most objects, if you enter a Type statement for an object in which a user cannot enter text, the method has no visual effect.

Back to top

See also: