PDFFormFieldPushButton object

PDFFormFieldPushButton object is one of the PDF Builder objects, and is derived from PDFFormField. PDFFormFieldPushButton is used for executing certain action on the form fields.

To view the full hierarchy of the PDF Builder objects, find "pdfobject" in the Browser, right-click the object, and then select "Show Hierarchy” in the pop-up menu.

Properties

PDFFormFieldPushButton provides the following properties. In addition, it inherits the properties from its parent, PDFFormField.

PDFFormFieldPushButton property

Datatype

Description

Alignment

PDFFormFieldTextAlignment

Gets or sets the alignment mode of the caption.

ButtonLayout

PDFFormFieldButtonLayout

Gets or sets the layout of the caption relative to the icon.

Caption

String

Gets or sets the caption.

CaptionDown

String

The caption to show when the button is pressed down.

CaptionRollover

String

The caption to show when the mouse has hovered over the button.

CharSpacing

Real

Gets or sets the bold font style.

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

FitMethod

PDFFormField

Gets or sets the fit method of the icon in the button.

Font

PDFFont

Gets or sets the font.

Icon

PDFImage

Gets or sets the icon, however, SVG-format icon is not supported.

IconDown

PDFImage

Has the icon pressed down. SVG-format icon is not supported.

IconRollover

PDFImage

Has hovered over the icon. SVG-format icon is not supported.

Tooltip

String

Gets or sets the tooltip.


Events

PDFFormFieldPushButton event

Occurs

Constructor

Immediately before the Open event occurs in the window.

Destructor

Immediately after the Close event occurs in the window.


Functions

PDFFormFieldPushButton provides the following functions.

PDFFormFieldPushButton function

Datatype returned

Description

AddAction

Long

Adds an action to be taken.

ClassName

String

Returns the name assigned to the control.

Clone

PDFFormFieldPushButton

Clones the current object.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent

PowerObject

Returns a reference to the name of the parent object.

GetReadOnly

Boolean

Gets the readonly state.

PostEvent

Boolean

Adds an event to the end of the message queue for the control.

RemoveAllAction

Long

Removes all the specified actions.

RemoveAction

Long

Removes the action to be taken at the specified event.

SetReadOnly

None

Sets the readonly state.

TriggerEvent

Integer

Triggers a specified event in the control and executes the script for the event.

TypeOf

Object

Returns the type of the control.