Foxit PDF SDK
|
Public Member Functions | |
XFAWidget (XFAWidget other) | |
Constructor, with another XFA widget object. More... | |
Bitmap | GetBitmap () |
Get the bitmap of current XFA widget. More... | |
XFAWidget.WidgetHAlignType | GetHAlign () |
Get text horizontal alignment. More... | |
int | GetIndex () |
Get the index of XFA Widget in related XFA page. More... | |
string | GetName (XFAWidget.WidgetNameType type) |
Get Widget name. More... | |
WidgetChoiceOptionArray | GetOptions () |
Get options of a choice list or an Exclusion Group (for radion button only). More... | |
XFAWidget.PresenceProperty | GetPresence () |
Get the presence property of the XFA widget. More... | |
RectF | GetRect () |
Get rectangle of XFA widget. More... | |
Signature | GetSignature () |
Get the signature object from current XFA widget. More... | |
string | GetToolTip () |
Get tooltip string. More... | |
XFAWidget.WidgetType | GetType () |
Get type of XFA widget. More... | |
XFAWidget.WidgetVAlignType | GetVAlign () |
Get text vertical alignment. More... | |
string | GetValue () |
Get the value string. More... | |
XFAPage | GetXFAPage () |
Get the related XFA page, to which current XFA widget belongs. More... | |
bool | HasEdge (XFAWidget.WidgetEdgePosition edge_pos) |
Check if the edge for specified position exists. More... | |
bool | IsChecked () |
Check if current XFA widget is checked when it is a check box or a radio button. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | OnChar (int input_char, int flags) |
Call this function when a character code is being input. More... | |
XFAWidget.HitTestArea | OnHitTest (PointF point) |
Call this function to do hit test for a specified point. More... | |
bool | OnKeyDown (int key_code, int flags) |
Call this function when key on the keyboard is down. More... | |
bool | OnKeyUp (int key_code, int flags) |
Call this function when key on the keyboard is up. More... | |
bool | OnLButtonDoubleClick (PointF point, int flags) |
Call this function when left mouse button is double-clicked . More... | |
bool | OnLButtonDown (PointF point, int flags) |
Call this function when left mouse button is down. More... | |
bool | OnLButtonUp (PointF point, int 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 (PointF point, int flags) |
Call this function when mouse moves. More... | |
bool | OnRButtonDown (PointF point, int flags) |
Call this function when right mouse is down. More... | |
bool | OnRButtonUp (PointF point, int flags) |
Call this function when right button is up. More... | |
void | ResetData () |
Reset XFA Widget Data. More... | |
void | SetImage (Image image) |
Set the image for current XFA widget. More... | |
void | SetValue (string value) |
Set the value string. More... | |
Class XFAWidget represents the XFA widget which is retrieved from XFA page object.
To access the menu of XFA widget, please construct a foxit.addon.xfa.WidgetMenu object with XFAWidget object.
|
strong |
|
strong |
Enumeration for presence attribute of XFA widget.
Values of this enumeration should be used alone.
The presence property controls the participation of the associated object in different phases of processing.
|
strong |
Enumeration for the positon of XFA widget edge position.
Values of this enumeration should be used alone.
Enumerator | |
---|---|
e_WidgetEdgePositionTop | Egde position: top. |
e_WidgetEdgePositionRight | Egde position: right. |
e_WidgetEdgePositionBottom | Egde position: bottom. |
e_WidgetEdgePositionLeft | Egde position: left. |
|
strong |
Enumeration for the type of text horizontal alignment of XFA widget.
Values of this enumeration should be used alone.
|
strong |
Enumeration for the type of XFA widget name.
Values of this enumeration should be used alone.
|
strong |
Enumeration for the type of XFA widget.
Values of this enumeration should be used alone.
|
strong |
Enumeration for the type of text vertical alignment of XFA widget.
Values of this enumeration should be used alone.
|
inline |
Constructor, with another XFA widget object.
[in] | other | Another XFA widget object. |
|
inline |
Get the bitmap of current XFA widget.
Applicable only when the type of current XFA widget is foxit.addon.xfa.XFAWidget.WidgetType.e_WidgetTypeImageEdit or foxit.addon.xfa.XFAWidget.WidgetType.e_WidgetTypeImage . For types that are not applicable, this function will throw exception foxit.common.ErrorCode.e_ErrUnsupported .
|
inline |
Get text horizontal alignment.
|
inline |
Get the index of XFA Widget in related XFA page.
|
inline |
Get Widget name.
[in] | type | Name type. Please refer to values starting from foxit.addon.xfa.XFAWidget.WidgetNameType.e_WidgetNameTypeField and this should be one of these values. |
|
inline |
Get options of a choice list or an Exclusion Group (for radion button only).
Applicable for choice list and Exclusion Group (for radion button only). For types that are not applicable, this function will return an empty array.
|
inline |
Get the presence property of the XFA widget.
The presence property controls the participation of the associated object in different phases of processing.
|
inline |
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.
|
inline |
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 foxit.common.ErrorCode.e_ErrUnsupported .
|
inline |
Get tooltip string.
|
inline |
Get type of XFA widget.
|
inline |
Get text vertical alignment.
|
inline |
Get the value string.
|
inline |
Get the related XFA page, to which current XFA widget belongs.
|
inline |
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 foxit.addon.xfa.XFAWidget.WidgetEdgePosition.e_WidgetEdgePositionTop and this should be one of these values. |
|
inline |
Check if current XFA widget is checked when it is a check box or a radio button.
Applicable for check box or radio button as related XFA widget. For types that are not applicable, this function will return false.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
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 foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
Call this function to do hit test for a specified point.
[in] | point | A point to be tested. |
|
inline |
Call this function when key on the keyboard is down.
[in] | key_code | The key code. Please refer to values starting from foxit.pdf.interform.Filler.VirtualKeyCode.e_VkeyUnknown and this should be one of these values. |
[in] | flags | Event flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
Call this function when key on the keyboard is up.
[in] | key_code | The key code. Please refer to values starting from foxit.pdf.interform.Filler.VirtualKeyCode.e_VkeyUnknown and this should be one of these values. |
[in] | flags | Event flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
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 foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
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 foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
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 foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
Call this function when mouse enters current XFA widget.
|
inline |
Call this function when mouse exits.
|
inline |
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 foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
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 foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
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 foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values. |
|
inline |
Reset XFA Widget Data.
|
inline |
Set the image for current XFA widget.
Applicable only when the type of current XFA widget is foxit.addon.xfa.XFAWidget.WidgetType.e_WidgetTypeImageEdit . For types that are not applicable, this function will throw exception foxit.common.ErrorCode.e_ErrUnsupported .
[in] | image | An image will be set to current XFA widget. Currently, this function only supports the following image types: |
|
inline |
Set the value string.
[in] | value | A string as value to be set. It can be an empty string. |