Class

PDFAnnotationButtonWidget

A PDFAnnotationButtonWidget object provides user interactivity on a page of a PDF document. There are three types of buttons available: push button, radio button, and checkbox.

Declaration

@interface PDFAnnotationButtonWidget : PDFAnnotation

Overview

PDFAnnotationButtonWidget inherits general annotation behavior from the PDFAnnotation class. If you use a PDFAnnotationButtonWidget object, your application must handle hit testing, unless you are simply using PDFView to display content. This is because PDFView automatically handles hit testing for you.

Topics

Getting and Setting the Control Type

- controlType

Returns the type of the control.

- setControlType:

Sets the type of the control.

- parentID

Gets the ID of the parent object.

Getting and Setting the Control’s State

- state

Returns the state of the control.

- setState:

Sets the state of the control.

Getting and Setting the Control’s Appearance

- backgroundColor

Returns the background color of the control.

- setBackgroundColor:

Sets the control’s background color.

Getting and Setting the Control Label Font Attributes

- font

Returns the font used in the control’s label.

- setFont:

Sets the font of the control’s label.

- fontColor

Returns the font color used in the control’s label.

- setFontColor:

Sets the font color used in the control’s label.

Getting and Setting the Control Label Text

- caption

Returns the text of the label on a push button control.

- setCaption:

Sets the text of the label on a push button control.

Managing Radio Button Behavior

- allowsToggleToOff

Returns a Boolean value indicating whether a radio button behaves in a toggling manner.

Managing Control State Values and Form Fields

- onStateValue

Returns the string associated with the on state of a radio button or checkbox control.

- setOnStateValue:

Sets the string that is associated with the on state of a radio button or checkbox control.

- fieldName

Returns the internal name of a field (used for reset-form actions).

- setFieldName:

Sets the internal name of a field (used for reset-form actions).

Constants

PDFWidgetControlType

The types of annotation buttons.

Instance Methods

Relationships

Inherits From

Conforms To

See Also

Annotation Types

PDFAnnotationChoiceWidget

A PDFAnnotationChoiceWidget object provides user interactivity on a page of a PDF document, in the form of pop-up menus and lists.

Deprecated
PDFAnnotationFreeText

A PDFAnnotationFreeText object displays text on a page.

Deprecated
PDFAnnotationLine

A PDFAnnotationLine object displays a single line on a page.

Deprecated
PDFAnnotationMarkup

A PDFAnnotationMarkup object appears as highlighting, underlining, or a strikethrough style applied to the text of a document.

Deprecated
PDFAnnotationPopup

A PDFAnnotationPopup object provides user interactivity on a PDF page in the form of a pop-up menu.

Deprecated
PDFAnnotationStamp

A PDFAnnotationStamp object allows you to display a word or phrase, such as “Confidential,“ in a PDF page.

Deprecated
PDFAnnotationText

A PDFAnnotationText object displays as an icon (such as a “sticky note”) attached to a specified point in the PDF document.

Deprecated
PDFAnnotationTextWidget

A PDFAnnotationTextWidget object allows you to manage the appearance and content of text fields.

Deprecated