Class

PDFCheckBox


Description

A standard checkbox control that can be embedded into a PDFDocument.

Properties

Name

Type

Read-Only

Shared

Action

PDFButton.Actions = PDFButton.Actions.ResetForm

Caption

String

Height

Integer

Name

String

PageNumber

Integer

TextSize

Integer

URL

String

Value

Boolean

Width

Integer

X

Integer

Y

Integer

Methods

Name

Parameters

Returns

Shared

Constructor

pageNumber As Integer, x As Integer, y As Integer, width As Integer, height As Integer, name As String

Constructor

pageNumber As Integer, x As Integer, y As Integer, width As Integer, height As Integer

Property descriptions


PDFCheckBox.Action

Action As PDFButton.Actions = PDFButton.Actions.ResetForm

The action the button will take when pressed.


PDFCheckBox.Caption

Caption As String

The text of the button.


PDFCheckBox.Height

Height As Integer

The height of the control.


PDFCheckBox.Name

Name As String

The name of the control.


PDFCheckBox.PageNumber

PageNumber As Integer

The number of the page upon which the control was created.

This property is read-only.


PDFCheckBox.TextSize

TextSize As Integer

The size of the text of the control.


PDFCheckBox.URL

URL As String

The URL to which the values of controls will be submitted.


PDFCheckBox.Value

Value As Boolean

The checked state of the control.


PDFCheckBox.Width

Width As Integer

The width of the control.


PDFCheckBox.X

X As Integer

The location on the X axis of the upper-left corner of the control.


PDFCheckBox.Y

Y As Integer

The location on the Y axis of the upper-left corner of the control.

Method descriptions


PDFCheckBox.Constructor

Constructor(pageNumber As Integer, x As Integer, y As Integer, width As Integer, height As Integer, name As String)

Note

Constructors are special methods called when you create an object with the New keyword and pass in the parameters above.

Returns an instance of a PDFCheckBox that can be added to a PDFDocument.


PDFCheckBox.Constructor

Constructor(pageNumber As Integer, x As Integer, y As Integer, width As Integer, height As Integer)

Note

Constructors are special methods called when you create an object with the New keyword and pass in the parameters above.

Creates an instance of the button with the values passed.

Notes

Only the checkbox itself is drawn. If you want a label, you’ll have to draw that yourself.

Compatibility

All projects types on all supported operating systems.

See also

PDFButton parent class; PDFButton class, PDFDocument.AddControl method.