Foxit PDF SDK
fsdk.HideAction Class Reference

Public Member Functions

def GetFieldNames ()
 Get all field names from the array of current hide action.
More...
 
def GetHideState ()
 Get the hide state.
More...
 
def SetFieldNames (field_names)
 Set field name array.
More...
 
def SetHideState (is_hide)
 Set the hide state.
More...
 

Detailed Description

Hide action is to hide or show specified form fields. Class fsdk.HideAction is derived from Action and offers functions to get/set hide action data.

See also
Action

Member Function Documentation

◆ GetFieldNames()

def fsdk.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.

Returns
An array of field names.

◆ GetHideState()

def fsdk.HideAction.GetHideState ( )

Get the hide state.

Returns
true means to hide specified fields , and false means to show specified fields.

◆ SetFieldNames()

def fsdk.HideAction.SetFieldNames (   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.

Parameters
[in]field_namesAn array of form fields' names, to specify which fields is to hide or show. Field name can be retrieved by function fsdk.Field.GetName .
Returns
None.

◆ SetHideState()

def fsdk.HideAction.SetHideState (   is_hide)

Set the hide state.

For a new hide action, if no hide state is set, true would be used by default,

Parameters
[in]is_hidetrue means to hide specified fields, and false means to show specified fields.
Returns
None.