---

PDFActionResetForm Class Reference

Overview

PDFActionResetForm, a subclass of PDFAction, defines methods for getting and clearing fields in a PDF form.

A PDFActionResetForm object represents an action associated with a PDF form.

Tasks

Initializing a Reset Form Action

• – init

Accessing and Changing Fields

• – fields
• – setFields:

Determining Whether Fields Are Cleared When the Action Is Performed

• – fieldsIncludedAreCleared
• – setFieldsIncludedAreCleared:

Instance Methods

fields

Returns an array of fields associated with the reset action.

- (NSArray *)fields

Return Value

An array of NSString objects that corresponds to the fieldNames property of widget annotations (such as PDFAnnotationButtonWidget) on the PDF page. This method can return NULL.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – setFields

Declared In

PDFActionResetForm.h

fieldsIncludedAreCleared

Returns whether the fields associated with the reset action are cleared when the action is performed.

- (BOOL)fieldsIncludedAreCleared

Discussion

If YES, the reset action’s fields are cleared when the action is performed. If NO, the fields are excluded from the reset action; that is, they are not cleared, but all other fields in the document are cleared.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – setFieldsIncludedAreCleared:

Declared In

PDFActionResetForm.h

init

Initializes a reset form action.

- (id)init

Return Value

An initialized PDFActionResetForm instance, or NULL if the object could not be initialized.

Discussion

Initially, there are no fields and fieldsIncludedAreCleared returns YES.

Availability

• Available in Mac OS X v10.5 and later.

Declared In

PDFActionResetForm.h

setFields:

Sets the array of fields associated with the reset action.

- (void)setFields:(NSArray *)fields

Parameters

fields

An array of strings that represent field names.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – fields

Declared In

PDFActionResetForm.h

setFieldsIncludedAreCleared:

Sets whether the fields associated with the reset action are cleared when the action is performed.

- (void)setFieldsIncludedAreCleared:(BOOL)include

Parameters

include

Pass YES to clear the fields associated with the action when the reset action is performed. Pass NO to exclude from the reset action only the fields associated with the action.

Availability

• Available in Mac OS X v10.5 and later.

See Also

• – fieldsIncludedAreCleared

Declared In

PDFActionResetForm.h

---