PDFRadioButton Object
Description
A radio button in an interactive PDF document.
Operations
The sections below list the built-in methods and properties that you can use as operations for the PDFRadioButton object.
Note: You can also view a list and descriptions of the PDFRadioButton 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
CaptureBitmap | Saves a screen capture of the object as a .png or .bmp image using the specified file name. |
Check | Checks whether the actual value of an item matches the expected value. |
CheckProperty | Checks whether the actual value of the specified object property matches the specified expected value within the specified timeout. |
ChildObjects | Returns the collection of child objects contained within the object. |
Click | Clicks the object. |
DblClick | Double-clicks the object. |
GetAllROProperties | Returns the collection of properties and current values from the object in the application. |
GetROProperty | Returns the current value of the description property from the object in the application. |
GetTOProperties | Returns the collection of properties and values used to identify the object. |
GetTOProperty | Returns the value of the specified description property from the test object description. |
Highlight | Highlights the object in the application. |
Output | Retrieves the current value of an item and stores it in a specified location. |
RefreshObject | Instructs OpenText Functional Testing to re-identify the object in the application the next time a step refers to this object. |
Set | Sets the radio button as the selected radio button. |
SetFocus | Activates the selected object and brings it into focus. |
SetTOProperty | Sets the value of the specified description property in the test object description. |
ToString | Returns a string that represents the test object. |
Type | Simulates keyboard input on the object. |
WaitProperty | Waits until the specified object property achieves the specified value or exceeds the specified timeout before continuing to the next step. |
Properties
Exist | Checks whether the object currently exists in the open application. |
Click Method
Description
Clicks the object.
Syntax
object.Click [X], [Y], [BUTTON]
Arguments
Parameter | Description |
---|---|
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.
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 radio button 'and then right-clicks a specific point on another radio button in the group. PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("Choice3").Click PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("Choice2").Click 10, 3, Right_Mouse_Button
DblClick Method
Description
Double-clicks the object.
Syntax
object.DblClick X, Y, [BUTTON]
Arguments
Parameter | Description |
---|---|
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
'The following example double-left-clicks in the center of the radio button 'and then double-right-clicks a specific point on another radio button in the group. PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("Choice3").DblClick PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("Choice2").DblClick 10, 3, Right_Mouse_Button
Set Method
Description
Sets the radio button as the selected radio button.
Syntax
object.Set
Return Type
None.
Example
'The following example sets the status of a radio button in a PDF application 'to 'selected'. PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("Choice2").Set
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 radio button in an open PDF application. PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("Choice2").SetFocus
Type Method
Description
Simulates keyboard input on the object.
Syntax
object.Type (KeyboardInput)
Arguments
Parameter | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
KeyboardInput |
Required. A String value.
|
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.
Example
'The following example selects a PDF radio button, then presses 'TAB to switch to the next radio button in the group, and selects it 'by pressing ENTER. PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("choice1").Set PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("choice1").Type micTab PDFApplication("Sample.pdf").PDFPage("Page 1").PDFRadioButton("choice2").Type micReturn
See also: