Foxit PDF SDK
|
Public Member Functions | |
HideAction (const Action &action) | |
Constructor, with parent class object. More... | |
WStringArray | GetFieldNames () |
Get all field names from the array of current hide action. More... | |
bool | GetHideState () |
Get the hide state. More... | |
void | SetFieldNames (const WStringArray &field_names) |
Set field name array. More... | |
void | SetHideState (bool is_hide) |
Set the hide state. 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 | |
![]() | |
enum | NewWindowFlag { e_NewWindowFlagFalse = 0, e_NewWindowFlagTrue = 1, e_NewWindowFlagNone = 2 } |
Enumeration for new window flag. More... | |
enum | Type { e_TypeUnknown = 0, e_TypeGoto = 1, e_TypeGoToR = 2, e_TypeGoToE = 3, e_TypeLaunch = 4, e_TypeThread = 5, e_TypeURI = 6, e_TypeSound = 7, e_TypeMovie = 8, e_TypeHide = 9, e_TypeNamed = 10, e_TypeSubmitForm = 11, e_TypeResetForm = 12, e_TypeImportData = 13, e_TypeJavaScript = 14, e_TypeSetOCGState = 15, e_TypeRendition = 16, e_TypeTrans = 17, e_TypeGoTo3DView = 18 } |
Enumeration for action type. More... | |
![]() | |
static Action | Create (const foxit::pdf::PDFDoc &document, Type action_type) |
Create a new action, for specified action type. More... | |
Hide action is to hide or show specified form fields. Class actions::HideAction is derived from Action and offers functions to get/set hide action data.
|
explicit |
Constructor, with parent class object.
[in] | action | Parent class object. |
WStringArray foxit::pdf::actions::HideAction::GetFieldNames | ( | ) |
Get all field names from the array of current hide action.
A hide action can have an array identifying which fields to hide or to show. This array is necessary to a hide action.
bool foxit::pdf::actions::HideAction::GetHideState | ( | ) |
Get the hide state.
void foxit::pdf::actions::HideAction::SetFieldNames | ( | const WStringArray & | field_names | ) |
Set field name array.
A hide action can have an array identifying which fields to hide or to show. This array is necessary to a hide action. So, for a new hide action, user should call this function to set the array.
[in] | field_names | An array of form fields' names, to specify which fields is to hide or show. Field name can be retrieved by function interform::Field::GetName. |
void foxit::pdf::actions::HideAction::SetHideState | ( | bool | is_hide | ) |
Set the hide state.
For a new hide action, if no hide state is set, true would be used by default,
[in] | is_hide | true means to hide specified fields, and false means to show specified fields. |