Foxit PDF SDK
|
Public Member Functions | |
SubmitFormAction (const Action &action) | |
Constructor, with parent class object. More... | |
WStringArray | GetFieldNames () |
Get all field names from the array in current submit form action. More... | |
uint32 | GetFlags () |
Get the flag value used for submission. More... | |
String | GetURL () |
Get the URI string of the script at the Web server that will process the submission. More... | |
void | SetFieldNames (const WStringArray &field_names) |
Set field name array. More... | |
void | SetFlags (uint32 flags) |
Set the flag value used for submission. More... | |
void | SetURL (const String &url) |
Set the URI string of the script at the Web server that will process the submission. More... | |
![]() | |
Action (const PDFDoc &document, objects::PDFDictionary *action_dict) | |
Constructor, with parameters. More... | |
Action (const Action &action) | |
Constructor, with another action object. More... | |
~Action () | |
Destructor. | |
objects::PDFDictionary * | GetDict () const |
Get PDF dictionary of current object. More... | |
PDFDoc | GetDocument () |
Get the PDF document, to which current action belongs. More... | |
Action | GetSubAction (int index) |
Get a sub-action by index. More... | |
int | GetSubActionCount () |
Get the count of sub-actions. More... | |
Type | GetType () |
Get action type. More... | |
void | InsertSubAction (int index, const Action &sub_action) |
Insert a new sub-action to the location specified by index. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator != (const Action &other) const |
Not equal operator. More... | |
Action & | operator= (const Action &other) |
Assign operator. More... | |
bool | operator== (const Action &other) const |
Equal operator. More... | |
void | RemoveAllSubActions () |
Remove all the sub-actions. More... | |
void | RemoveSubAction (int index) |
Remove a sub-action, specified by index. More... | |
void | SetSubAction (int index, const Action &sub_action) |
Set a sub-action by index. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
Additional Inherited Members | |
![]() | |
static Action | Create (const foxit::pdf::PDFDoc &document, Type action_type) |
Create a new action, for specified action type. More... | |
Submit-form action is to send data to a uniform resource locator. Class actions::SubmitFormAction is derived from Action and offers functions to get/set submit-form action data.
Enumeration for flags of submit form action.
Values of this enumeration could be used alone or in a combination.
Enumerator | |
---|---|
e_FlagExclude | Bit 1. If set, fields name defined in submit form action should be excluded from submitting; if not set, only these fields name (including their descendants) are to be submit. |
e_FlagIncludeNoValueFields | Bit 2. Submit fields regardless of whether they have a value.
|
e_FlagExportFormat | Bit 3. Field names and values are submitted in HTML Form format.
|
e_FlagGetMethod | Bit 4. Field names and values are submitted using an HTTP GET request.
|
e_FlagWithCoordinates | Bit 5. Coordinates of the mouse are transmitted as part of the form data. |
e_FlagAsXFDF | Bit 6. Field names and values are submitted as XFDF. |
e_FlagIncludeAppendSaves | Bit 7. Submitted FDF file includes contents as contained in differences entry in the FDF dictionary.
|
e_FlagIncludeAnnotations | Bit 8. Submitted FDF file includes all markup annotations in underlying PDF document.
|
e_FlagSubmitAsPDF | Bit 9. The document is submitted as PDF. |
e_FlagCanonicalFormat | Bit 10. Any submitted field values representing dates are converted to the standard format. |
e_FlagExclNonUserAnnots | Bit 11. Only those markup annotations whose "T" entry matches the name of the current user are being submitted. |
e_FlagExclFKey | Bit 12. Submitted FDF excludes "F" entry. |
e_FlagEmbedForm | Bit 14. "F" entry of submitted FDF is an embedded file stream. |
|
explicit |
Constructor, with parent class object.
[in] | action | Parent class object. |
WStringArray foxit::pdf::actions::SubmitFormAction::GetFieldNames | ( | ) |
Get all field names from the array in current submit form action.
A submit form action can have an array identifying which fields to include in the submission or which to exclude, depending on the flag value.
uint32 foxit::pdf::actions::SubmitFormAction::GetFlags | ( | ) |
Get the flag value used for submission.
String foxit::pdf::actions::SubmitFormAction::GetURL | ( | ) |
Get the URI string of the script at the Web server that will process the submission.
void foxit::pdf::actions::SubmitFormAction::SetFieldNames | ( | const WStringArray & | field_names | ) |
Set field name array.
A submit form action can have an array identifying which fields to include in the submission or which to exclude, depending on the flag value.
[in] | field_names | An array of form fields' names, to identify which fields to include in or exclude from submission. This parameter can be an empty array. Field name can be retrieved by function interform::Field::GetName. |
void foxit::pdf::actions::SubmitFormAction::SetFlags | ( | uint32 | flags | ) |
Set the flag value used for submission.
[in] | flags | New flag value. Please refer to values starting from SubmitFormAction::e_FlagExclude and this can be one or a combination of these values It could also be 0, which means all bits in the flag are 0. |
void foxit::pdf::actions::SubmitFormAction::SetURL | ( | const String & | url | ) |
Set the URI string of the script at the Web server that will process the submission.
[in] | url | URI string. It should not be an empty string. |