PDFSignatureField Object

Description

A box for signing documents with a digital signature.

IMPORTANT

Recording on PDFSignatureField test objects is not supported.

Operations

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

Note: You can also view a list and descriptions of the PDFSignatureField 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.

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

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.
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 the next time a step refers to this object.
Method SetSets the digital signature file for the signature element.
Method SetFocusActivates the selected object and brings it into focus.
Method SetSecureSets the digital signature file for the signature element using an encrypted password.
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], [BUTTON]

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
BUTTON Optional. A predefined constant or number.
The mouse button used to click the object.
Default value = micLeftBtn

Return Type

None

Example

'The following example left-clicks in the center of the signature field
'and then right-clicks a specific point in the field. 

PDFApplication("Sample.pdf").PDFPage("Page 1").PDFSignatureField("SignatureField").Click
PDFApplication("Sample.pdf").PDFPage("Page 1").PDFSignatureField("SignatureField").Click 200, 350, Right_Mouse_Button

Back to top

 

DblClick Method

Description

Double-clicks the object.

Syntax

object.DblClick X, Y, [BUTTON]

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.
BUTTON Optional. A predefined constant or number.
The mouse button used to double-click the object.
Default value = micLeftBtn

Return Type

None

Example

'The following example double-left-clicks in the center of the signature field
'and then double-right-clicks a specific point in the field. 

PDFApplication("Sample.pdf").PDFPage("Page 1").PDFSignatureField("SignatureField").DblClick
PDFApplication("Sample.pdf").PDFPage("Page 1").PDFSignatureField("SignatureField").DblClick 200, 350, Right_Mouse_Button

Back to top

 

Set Method

Description

Sets the digital signature file for the signature element.

Syntax

object.Set fullSignaturePath, signaturePassword, [signImagePath], [signContactInfo], [signLocation], [signName], [signReason]

Arguments

ParameterDescription
fullSignaturePath

Required. A string value.

The full path to the digital signature file to use.

The file must be of type .pfx.

signaturePassword

Required. A string value.

The password for the digital signature file.

signImagePath

Optional. A string value.

A path to an image file used to sign the signature.

signContactInfo

Optional. A string value.

Contact information to use when setting the signature.

signLocation

Optional. A string value.

Location information to use when setting the signature.

signName

Optional. A string value.

Name information to use when setting the signature.

signReason

Optional. A string value.

Reason information to use when setting the signature.

Return Type

Boolean. True if the document is signed successfully, otherwise False .

Example

'The following example enters a signature file in a PDF signature field
'providing the signature's password.

PDFApplication("Sample.pdf").PDFPage("Page 1").PDFSignatureField("Signature1").Set "C:\Temp\Demo.pfx", "P@ssword"

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 a signature field  in an open PDF application.

PDFApplication("Sample.pdf").PDFPage("Page 1").PDFSignatureField("SignatureField").SetFocus

Back to top

 

SetSecure Method

Description

Sets the digital signature file for the signature element using an encrypted password.

Syntax

object.SetSecure fullSignaturePath, encryptedSignaturePassword, [signImagePath], [signContactInfo], [signLocation], [signName], [signReason]

Arguments

ParameterDescription
fullSignaturePath

Required. A string value.

The full path to the digital signature file to use.

The file must be of type .pfx.

encryptedSignaturePassword

Required. A string value.

The encrypted password for the digital signature file.

signImagePath

Optional. A string value.

A path to an image file used to sign the signature.

signContactInfo

Optional. A string value.

Contact information to use when setting the signature.

signLocation

Optional. A string value.

Location information to use when setting the signature.

signName

Optional. A string value.

Name information to use when setting the signature.

signReason

Optional. A string value.

Reason information to use when setting the signature.

Return Type

Boolean. True if the document is signed successfully, otherwise False .

IMPORTANT

To find the encrypted value to use as the argument for the SetSecure method, use the Password Encoder utility (Start > All Programs > Micro Focus > Password Encoder) or parameterize the argument using a Data Table parameter and use the Data Table encryption option (right-click each unencrypted value in the password column and choose Data > Encrypt). For more information, refer to the UFT One User Guide.

While the SetSecure method enables you to hide passwords on the screen during a run session, it is not intended to be a secure way to protect password information.

Example

'The following example enters a signature file in a PDF signature field
'providing an encrypted password for the signature file.

PDFApplication("Sample.pdf").PDFPage("Page 1").PDFSignatureField("Signature1").SetSecure "C:\Temp\Demo.pfx", "5cd12f246ca2c35fc0f143b41a0893afe15d1b63724e"

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: