Foxit PDF SDK
|
Instance Methods | |
(FSField *) | - getField |
Get the related form field. More... | |
(int) | - getIndex |
Get the index of current form control among all the controls of related form field. More... | |
(FSWidget *) | - getWidget |
Get the related widget annotation. More... | |
(FSPDFDictionary *) | - getWidgetDict |
Get the dictionary of related widget annotation. More... | |
(id) | - initWithOther: |
Constructor, with another form control object. More... | |
(BOOL) | - isChecked |
Check if the current form control is checked when related form field is check box or radio button. More... | |
(BOOL) | - isDefaultChecked |
Check if the current form control is checked by default when related form field is check box or radio button. More... | |
(BOOL) | - isEmpty |
Check whether current object is empty or not. More... | |
(void) | - setChecked: |
Set the check state of current form control when related form field is check box or radio button. More... | |
(void) | - setDefaultChecked: |
Set the default check state of current form control when related form field is check box or radio button. More... | |
Properties | |
FSAlignment | alignment |
Get or Set the alignment value. More... | |
FSDefaultAppearance * | defaultAppearance |
Get or Set the default appearance data. | |
NSString * | exportValue |
Get or Set export mapping name when related form field is check box or radio button. More... | |
Foxit PDF SDK defines "form control" to associate form field with its related widget annotations. A form field may have one or more form controls, and each form control is associated with a widget annotation. A form control object can be retrieved by following functions:
Form control also offers functions to get related form field object and widget annotation object.
Function FSForm::addControl:field_name:field_type:rect: can be used to add a new form control to a form field, and function FSForm::removeControl: can be used to remove a form control.
- (FSField *) getField |
Get the related form field.
- (int) getIndex |
Get the index of current form control among all the controls of related form field.
- (FSWidget *) getWidget |
Get the related widget annotation.
- (FSPDFDictionary *) getWidgetDict |
Get the dictionary of related widget annotation.
- (id) initWithOther: | (FSControl*) | other |
Constructor, with another form control object.
[in] | other | Another form control object. |
- (BOOL) isChecked |
Check if the current form control is checked when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return NO.
- (BOOL) isDefaultChecked |
Check if the current form control is checked by default when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return NO.
- (BOOL) isEmpty |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- (void) setChecked: | (BOOL) | checked_status |
Set the check state of current form control when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.
[in] | checked_status | YES means checked, and NO means not checked. |
- (void) setDefaultChecked: | (BOOL) | checked_status |
Set the default check state of current form control when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will do nothing.
[in] | checked_status | YES means checked by default, and NO means not checked by default. |
|
readwritenonatomicassign |
Get or Set the alignment value.
Alignment is a property for variable text and it is only useful for text field, list box and combo box as related form field, which may contain variable text as their content.
If related form field is a text field or list box and it has its own alignment value, the document-wide default alignment value will be ignored; otherwise, the document-wide default alignment value will be used in this case.
|
readwritenonatomicweak |
Get or Set export mapping name when related form field is check box or radio button.
Applicable for check box and radio button as related form field. If related form field is other field type, this function will return an empty string.