Foxit PDF SDK
|
Instance Methods | |
(FSBitmap *) | - getBitmap |
Get the bitmap of current XFA widget. More... | |
(FSXFAWidgetWidgetHAlignType) | - getHAlign |
Get text horizontal alignment. More... | |
(int) | - getIndex |
Get the index of XFA Widget in related XFA page. More... | |
(NSString *) | - getJavaScript |
Get the JavaScript of validation for current XFA widget. More... | |
(NSString *) | - getName: |
Get Widget name. More... | |
(FSWidgetChoiceOptionArray *) | - getOptions |
Get options of a choice list or an Exclusion Group (for radio button only). More... | |
(FSXFAWidgetPresenceProperty) | - getPresence |
Get the presence property of the XFA widget. More... | |
(FSRectF *) | - getRect |
Get rectangle of XFA widget. More... | |
(FSSignature *) | - getSignature |
Get the signature object from current XFA widget. More... | |
(NSString *) | - getToolTip |
Get tooltip string. More... | |
(FSXFAWidgetWidgetType) | - getType |
Get type of XFA widget. More... | |
(FSXFAWidgetWidgetVAlignType) | - getVAlign |
Get text vertical alignment. More... | |
(FSXFAPage *) | - getXFAPage |
Get the related XFA page, to which current XFA widget belongs. More... | |
(BOOL) | - hasEdge: |
Check if the edge for specified position exists. More... | |
(id) | - initWithOther: |
Constructor, with another XFA widget object. More... | |
(BOOL) | - isAllowRichText |
Check whether the widget allows rich text formatting. More... | |
(BOOL) | - isChecked |
Check if current XFA widget is checked. More... | |
(BOOL) | - isEmpty |
Check whether current object is empty or not. More... | |
(BOOL) | - isListBox |
Check whether the widget is listbox or not. More... | |
(BOOL) | - isReadOnly |
Check whether the widget is read only. More... | |
(BOOL) | - isRequired |
Check whether the widget requires a value at the time it is exported by a submit-form action. More... | |
(BOOL) | - isSupportMultiline |
Check whether the widget supports multiple lines. More... | |
(BOOL) | - isSupportMultiSelect |
Check whether the widget supports multiple selections. More... | |
(BOOL) | - onChar:flags: |
Call this function when a character code is being input. More... | |
(FSXFAWidgetHitTestArea) | - onHitTest: |
Call this function to do hit test for a specified point. More... | |
(BOOL) | - onKeyDown:flags: |
Call this function when key on the keyboard is down. More... | |
(BOOL) | - onKeyUp:flags: |
Call this function when key on the keyboard is up. More... | |
(BOOL) | - onLButtonDoubleClick:flags: |
Call this function when left mouse button is double-clicked . More... | |
(BOOL) | - onLButtonDown:flags: |
Call this function when left mouse button is down. More... | |
(BOOL) | - onLButtonUp:flags: |
Call this function when left mouse button is up. More... | |
(BOOL) | - onMouseEnter |
Call this function when mouse enters current XFA widget. More... | |
(BOOL) | - onMouseExit |
Call this function when mouse exits. More... | |
(BOOL) | - onMouseMove:flags: |
Call this function when mouse moves. More... | |
(BOOL) | - onRButtonDown:flags: |
Call this function when right mouse is down. More... | |
(BOOL) | - onRButtonUp:flags: |
Call this function when right button is up. More... | |
(void) | - resetData |
Reset XFA Widget Data. More... | |
(void) | - setCheckState: |
Set the checked state of the current XFA widget. More... | |
(void) | - setImage: |
Set the image for current XFA widget. More... | |
(BOOL) | - setOptions: |
Set options of a choice list or an Exclusion Group (for radio button only). More... | |
(BOOL) | - validateValue:format: |
Validate whether the value conforms to the format of current XFA widget. More... | |
Properties | |
NSString * | defaultValue |
Get or Set the default value string. | |
NSString * | value |
Get or Set the value string. | |
Class FSXFAWidget represents the XFA widget which is retrieved from XFA page object.
To access the menu of XFA widget, please construct a FSWidgetMenu object with FSXFAWidget object.
- (FSBitmap *) getBitmap |
Get the bitmap of current XFA widget.
Applicable only when the type of current XFA widget is FSXFAWidgetWidgetTypeImageEdit or FSXFAWidgetWidgetTypeImage. For types that are not applicable, this function will throw exception FSErrUnsupported.
- (FSXFAWidgetWidgetHAlignType) getHAlign |
Get text horizontal alignment.
- (int) getIndex |
Get the index of XFA Widget in related XFA page.
- (NSString *) getJavaScript |
Get the JavaScript of validation for current XFA widget.
- (NSString *) getName: | (FSXFAWidgetWidgetNameType) | type |
Get Widget name.
[in] | type | Name type. Please refer to values starting from FSXFAWidgetWidgetNameTypeField and this should be one of these values. |
- (FSWidgetChoiceOptionArray *) getOptions |
Get options of a choice list or an Exclusion Group (for radio button only).
Applicable for choice list and Exclusion Group (for radio button only). For types that are not applicable, this function will return an empty array.
- (FSXFAWidgetPresenceProperty) getPresence |
Get the presence property of the XFA widget.
The presence property controls the participation of the associated object in different phases of processing.
- (FSRectF *) getRect |
Get rectangle of XFA widget.
Widget rectangle is defined in XFA coordinate. XFA coordinate is defined as original point in left top, x-axis pointing to right and y-axis pointing down.
- (FSSignature *) getSignature |
Get the signature object from current XFA widget.
Applicable only when current XFA widget represents a signature. For types that are not applicable, this function will throw exception FSErrUnsupported.
- (NSString *) getToolTip |
Get tooltip string.
- (FSXFAWidgetWidgetType) getType |
Get type of XFA widget.
- (FSXFAWidgetWidgetVAlignType) getVAlign |
Get text vertical alignment.
- (FSXFAPage *) getXFAPage |
Get the related XFA page, to which current XFA widget belongs.
- (BOOL) hasEdge: | (FSXFAWidgetWidgetEdgePosition) | edge_pos |
Check if the edge for specified position exists.
[in] | edge_pos | Edge position to specify which edge will be checked. Please refer to values starting from FSXFAWidgetWidgetEdgePositionTop and this should be one of these values. |
- (id) initWithOther: | (FSXFAWidget*) | other |
Constructor, with another XFA widget object.
[in] | other | Another XFA widget object. |
- (BOOL) isAllowRichText |
Check whether the widget allows rich text formatting.
Only text edit widget which type is FSXFAWidgetWidgetTypeTextEdit supports rich text.
- (BOOL) isChecked |
Check if current XFA widget is checked.
Applicable for check box or radio button as related XFA widget. For types that are not applicable, 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.
- (BOOL) isListBox |
Check whether the widget is listbox or not.
- (BOOL) isReadOnly |
Check whether the widget is read only.
- (BOOL) isRequired |
Check whether the widget requires a value at the time it is exported by a submit-form action.
- (BOOL) isSupportMultiline |
Check whether the widget supports multiple lines.
Only text edit widget which type is FSXFAWidgetWidgetTypeTextEdit supports multiple lines.
- (BOOL) isSupportMultiSelect |
Check whether the widget supports multiple selections.
Only the list box widget supports multiline selections, whose type is FSXFAWidgetWidgetTypeChoiceList and the return value of function FSXFAWidget::isListBox is YES.
- (BOOL) onChar: | (int) | input_char | |
flags: | (unsigned int) | flags | |
Call this function when a character code is being input.
[in] | input_char | A character code, in UTF16-LE encoding. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (FSXFAWidgetHitTestArea) onHitTest: | (FSPointF*) | point |
Call this function to do hit test for a specified point.
[in] | point | A point to be tested. |
- (BOOL) onKeyDown: | (unsigned int) | key_code | |
flags: | (unsigned int) | flags | |
Call this function when key on the keyboard is down.
[in] | key_code | The key code. Please refer to values starting from FSFillerVkeyUnknown and this should be one of these values. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onKeyUp: | (unsigned int) | key_code | |
flags: | (unsigned int) | flags | |
Call this function when key on the keyboard is up.
[in] | key_code | The key code. Please refer to values starting from FSFillerVkeyUnknown and this should be one of these values. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onLButtonDoubleClick: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when left mouse button is double-clicked .
[in] | point | A point where left mouse button is double-clicked in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onLButtonDown: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when left mouse button is down.
[in] | point | A point where left mouse button is down in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onLButtonUp: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when left mouse button is up.
[in] | point | A point where left mouse button is up in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onMouseEnter |
Call this function when mouse enters current XFA widget.
- (BOOL) onMouseExit |
Call this function when mouse exits.
- (BOOL) onMouseMove: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when mouse moves.
[in] | point | A point where left mouse button moves in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onRButtonDown: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when right mouse is down.
[in] | point | A point where right mouse button is down in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (BOOL) onRButtonUp: | (FSPointF*) | point | |
flags: | (unsigned int) | flags | |
Call this function when right button is up.
[in] | point | A point where right mouse button is up in XFA page, in PDF coordinate system. |
[in] | flags | Event flags. Please refer to values starting from FSFillerEventFlagShiftKey and this should be one or a combination of these values. |
- (void) resetData |
Reset XFA Widget Data.
- (void) setCheckState: | (BOOL) | is_checked |
Set the checked state of the current XFA widget.
Applicable for check box or radio button as related XFA widget. For types that are not applicable, this function will throw exception FSErrUnsupported.
[in] | is_checked | YES means the current XFA widget will be checked, while NO means it will not be checked. |
- (void) setImage: | (FSImage*) | image |
Set the image for current XFA widget.
Applicable only when the type of current XFA widget is FSXFAWidgetWidgetTypeImageEdit. For types that are not applicable, this function will throw exception FSErrUnsupported.
[in] | image | An image will be set to current XFA widget. Currently, this function only supports the following image types:
If try to set rest unsupported image types, exception FSErrUnsupported will be thrown. |
- (BOOL) setOptions: | (FSWidgetChoiceOptionArray*) | option_array |
Set options of a choice list or an Exclusion Group (for radio button only).
Applicable for choice list and Exclusion Group (for radio button only). For types that are not applicable, this function will return NO.
[in] | option_array | An array of choice options to be set. |
- (BOOL) validateValue: | (NSString *) | value | |
format: | (NSString *) | format | |
Validate whether the value conforms to the format of current XFA widget.
This function can be called before the function FSXFAWidget::value to check whether the value conforms to the format of current XFA widget.
[in] | value | A string value to be validated. |
[out] | format | A string value that receives the format of current XFA widget. It will be an empty string if current XFA widget has no format. |