Foxit PDF SDK  9.1
FSResetFormAction Class Reference
Inheritance diagram for FSResetFormAction:
FSAction FSBase

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - initWithAction:
 Constructor, with parent class object.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - NS_UNAVAILABLE
 
- Instance Methods inherited from FSAction
(FSPDFDictionary *) - getDict
 Get PDF dictionary of current object.
More...
 
(FSPDFDoc *) - getDocument
 Get the PDF document, to which current action belongs.
More...
 
(FSAction *) - getSubAction:
 Get a sub-action by index.
More...
 
(int) - getSubActionCount
 Get the count of sub-actions.
More...
 
(FSActionType- getType
 Get action type.
More...
 
(id) - initWithDocument:action_dict:
 Constructor, with parameters.
More...
 
(void) - insertSubAction:sub_action:
 Insert a new sub-action to the location specified by index.
More...
 
(BOOL) - isEmpty
 Check whether current object is empty or not.
More...
 
(void) - removeAllSubActions
 Remove all the sub-actions.
More...
 
(void) - removeSubAction:
 Remove a sub-action, specified by index.
More...
 
(void) - setSubAction:sub_action:
 Set a sub-action by index.
More...
 

Properties

NSArray< NSString * > * fieldNames
 Get or Set all field names from the array of current reset form action.
More...
 
unsigned int flags
 Get or Set the flag value used for resetting.
More...
 

Additional Inherited Members

- Class Methods inherited from FSAction
(FSAction *) + create:action_type:
 Create a new action, for specified action type.
More...
 
- Protected Attributes inherited from FSBase
BOOL swigCMemOwn
 
void * swigCPtr
 

Detailed Description

Reset-form action is to set fields to their default values Class FSResetFormAction is derived from FSAction and offers functions to get/set reset-form action data.

See also
FSAction

Method Documentation

◆ dealloc

- (void) dealloc

Reimplemented from FSAction.

◆ getCptr

- (void*) getCptr

Reimplemented from FSAction.

◆ initWithAction:

- (id) initWithAction: (FSAction*)  action

Constructor, with parent class object.

Parameters
[in]actionParent class object.

Reimplemented from FSAction.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

Reimplemented from FSAction.

◆ NS_UNAVAILABLE

- (id) NS_UNAVAILABLE

Property Documentation

◆ fieldNames

- (NSArray< NSString * > *) fieldNames
readwritenonatomiccopy

Get or Set all field names from the array of current reset form action.

A reset form action can have an array identifying which fields to reset or to exclude from resetting, depending on the flag value.

◆ flags

- (unsigned int) flags
readwritenonatomicassign

Get or Set the flag value used for resetting.