|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetOCGState (index) |
| Get the state of OCG. More... | |
| def | GetOCGStateArray (index) |
| Get the OCG dictionary array. More... | |
| def | GetOCGStateCount () |
| Get the count of OCG states. More... | |
| def | InsertOCGStates (document, index, state, ocg_dict_array) |
| Insert the OCG states to action. More... | |
| def | IsRadioButtonStatePreserved () |
| Get the radio-button preserved state. More... | |
| def | RemoveOCGStates (index) |
| Remove the OCG state. More... | |
| def | ReplaceOCGStates (document, index, ocg_dict_array) |
| Replace the OCG states array. More... | |
| def | SetRadioButtonStatePreserved (is_preserved) |
| Set the radio-button preserved state. More... | |
Set-OCG-state action is to sets the state of one or more optional content groups. (For more details, please refer to <PDF Reference 1.7> P667 "Set-OCG-State Actions") Class fsdk.SetOCGStateAction is derived from Action and offers functions to get/set set-OCG-state action data.
| def fsdk.SetOCGStateAction.GetOCGState | ( | index | ) |
Get the state of OCG.
| [in] | index | The index of OCG state. Valid range: from 0 to (count-1). count is returned by function fsdk.SetOCGStateAction.GetOCGStateCount . |
| def fsdk.SetOCGStateAction.GetOCGStateArray | ( | index | ) |
Get the OCG dictionary array.
| [in] | index | The index of OCG state. Valid range: from 0 to (count-1). count is returned by function fsdk.SetOCGStateAction.GetOCGStateCount . |
| def fsdk.SetOCGStateAction.GetOCGStateCount | ( | ) |
Get the count of OCG states.
| def fsdk.SetOCGStateAction.InsertOCGStates | ( | document, | |
| index, | |||
| state, | |||
| ocg_dict_array | |||
| ) |
Insert the OCG states to action.
| [in] | document | A valid PDF document object. |
| [in] | index | The index of OCG want to insert. The OCG state will be inserted after the index. Valid range: from 0 to (count-1). count is returned by function fsdk.SetOCGStateAction.GetOCGStateCount . If this is below 0 or count of OCG state in current action is 0, parameter state is to be inserted to the first position. If this is larger than count of OCG state in current action, parameter state is to be added to the end. |
| [in] | state | The OCG state to insert. |
| [in] | ocg_dict_array | The OCG dictionary array to insert. |
| def fsdk.SetOCGStateAction.IsRadioButtonStatePreserved | ( | ) |
Get the radio-button preserved state.
If true, indicates that radio-button state relationships between optional content groups should be preserved when the states in the State array are applied. If false, radio-button state relationships, if any, are ignored. Default value: true.
| def fsdk.SetOCGStateAction.RemoveOCGStates | ( | index | ) |
Remove the OCG state.
| [in] | index | The index of OCG to remove. Valid range: from 0 to (count-1). count is returned by function fsdk.SetOCGStateAction.GetOCGStateCount . |
| def fsdk.SetOCGStateAction.ReplaceOCGStates | ( | document, | |
| index, | |||
| ocg_dict_array | |||
| ) |
Replace the OCG states array.
| [in] | document | A valid PDF document object. |
| [in] | index | The index of OCG want to replace. Valid range: from 0 to (count-1). count is returned by function fsdk.SetOCGStateAction.GetOCGStateCount . |
| [in] | ocg_dict_array | The OCG dictionary array to insert. |
| def fsdk.SetOCGStateAction.SetRadioButtonStatePreserved | ( | is_preserved | ) |
Set the radio-button preserved state.
| [in] | is_preserved | The preserved state value. |