类 foxit.pdf.actions.SetOCGStateAction 继承关系图:

Public 类型
enum	OCGState { OCGState.e_OCGStateOn = 0, OCGState.e_OCGStateOff = 1, OCGState.e_OCGStateToggle = 2 }
	当设置OCG状态动作被触发时要执行的设置OCG状态的枚举。更多...

Public 类型继承自 foxit.pdf.actions.Action
enum	NewWindowFlag { NewWindowFlag.e_NewWindowFlagFalse = 0, NewWindowFlag.e_NewWindowFlagTrue = 1, NewWindowFlag.e_NewWindowFlagNone = 2 }
	新窗口标志枚举。更多...

enum	Type { Type.e_TypeUnknown = 0, Type.e_TypeGoto = 1, Type.e_TypeGoToR = 2, Type.e_TypeGoToE = 3, Type.e_TypeLaunch = 4, Type.e_TypeThread = 5, Type.e_TypeURI = 6, Type.e_TypeSound = 7, Type.e_TypeMovie = 8, Type.e_TypeHide = 9, Type.e_TypeNamed = 10, Type.e_TypeSubmitForm = 11, Type.e_TypeResetForm = 12, Type.e_TypeImportData = 13, Type.e_TypeJavaScript = 14, Type.e_TypeSetOCGState = 15, Type.e_TypeRendition = 16, Type.e_TypeTrans = 17, Type.e_TypeGoTo3DView = 18 }
	动作类型枚举。更多...

Public 成员函数
	SetOCGStateAction (Action action)
	构造函数，使用父类对象。更多...

SetOCGStateAction.OCGState	GetOCGState (int index)
	获取OCG的状态。更多...

PDFDictionaryArray	GetOCGStateArray (int index)
	获取OCG字典数组。更多...

int	GetOCGStateCount ()
	获取OCG状态的数量。更多...

int	InsertOCGStates (PDFDoc document, int index, SetOCGStateAction.OCGState state, PDFDictionaryArray ocg_dict_array)
	将OCG状态插入到动作中。更多...

bool	IsRadioButtonStatePreserved ()
	获取单选按钮保留状态。更多...

void	RemoveOCGStates (int index)
	移除OCG状态。更多...

bool	ReplaceOCGStates (PDFDoc document, int index, PDFDictionaryArray ocg_dict_array)
	替换OCG状态数组。更多...

void	SetRadioButtonStatePreserved (bool is_preserved)
	设置单选按钮保留状态。更多...

Public 成员函数继承自 foxit.pdf.actions.Action
	Action (PDFDoc document, PDFDictionary action_dict)
	构造函数，带参数。更多...

	Action (Action action)
	构造函数，使用另一个动作对象。更多...

PDFDictionary	GetDict ()
	获取当前对象的PDF字典。更多...

PDFDoc	GetDocument ()
	获取当前动作所属的PDF文档。更多...

Action	GetSubAction (int index)
	按索引获取子动作。更多...

int	GetSubActionCount ()
	获取子动作的数量。更多...

Action.Type	GetType ()
	获取动作类型。更多...

void	InsertSubAction (int index, Action sub_action)
	在指定索引位置插入新的子动作。更多...

bool	IsEmpty ()
	检查当前对象是否为空。更多...

void	RemoveAllSubActions ()
	移除所有子动作。更多...

void	RemoveSubAction (int index)
	移除指定索引的子动作。更多...

void	SetSubAction (int index, Action sub_action)
	按索引设置子动作。更多...

额外继承的成员函数
静态 Public 成员函数继承自 foxit.pdf.actions.Action
static Action	Create (PDFDoc document, Action.Type action_type)
	为指定的动作类型创建新动作。更多...

详细描述

设置OCG状态动作是设置一个或多个可选内容组的状态。(更多详情，请参考 <PDF参考1.7> P667 "设置OCG状态动作") 类foxit.pdf.actions.SetOCGStateAction 派生自Action ，提供用于获取/设置设置OCG状态动作数据的函数。

参见: Action

成员枚举类型说明

◆ OCGState

enum foxit.pdf.actions.SetOCGStateAction.OCGState

strong

当设置OCG状态动作被触发时要执行的设置OCG状态的枚举。

此枚举的值应单独使用。

枚举值
e_OCGStateOn	将后续组的状态设置为ON。
e_OCGStateOff	将后续组的状态设置为OFF。
e_OCGStateToggle	反转后续组的状态。

构造及析构函数说明

◆ SetOCGStateAction()

foxit.pdf.actions.SetOCGStateAction.SetOCGStateAction ( Action action )

inline

构造函数，使用父类对象。

参数

[in] action 父类对象。

成员函数说明

◆ GetOCGState()

SetOCGStateAction.OCGState foxit.pdf.actions.SetOCGStateAction.GetOCGState ( int index )

inline

获取OCG的状态。

参数

[in] index OCG状态的索引。有效范围：从0到(count-1)。 count由函数SetOCGStateAction.GetOCGStateCount 返回。

返回: OCG的状态。

◆ GetOCGStateArray()

PDFDictionaryArray foxit.pdf.actions.SetOCGStateAction.GetOCGStateArray ( int index )

inline

获取OCG字典数组。

参数

[in] index OCG状态的索引。有效范围：从0到(count-1)。 count由函数SetOCGStateAction.GetOCGStateCount 返回。

返回: OCG字典数组。

◆ GetOCGStateCount()

int foxit.pdf.actions.SetOCGStateAction.GetOCGStateCount ( )

inline

获取OCG状态的数量。

返回: OCG状态的数量。

◆ InsertOCGStates()

int foxit.pdf.actions.SetOCGStateAction.InsertOCGStates	(	PDFDoc	document,
		int	index,
		SetOCGStateAction.OCGState	state,
		PDFDictionaryArray	ocg_dict_array
	)

inline

将OCG状态插入到动作中。

参数

[in]	document	有效的PDF文档对象。
[in]	index	要插入的OCG的索引。OCG状态将在该索引之后插入。有效范围：从0到(count-1)。 count由函数SetOCGStateAction.GetOCGStateCount 返回。如果此值小于0或当前动作中OCG状态的数量为0，参数state将被插入到第一个位置。如果此值大于当前动作中OCG状态的数量，参数state将被添加到末尾。
[in]	state	要插入的OCG状态。
[in]	ocg_dict_array	要插入的OCG字典数组。

返回: 插入的OCG状态的索引。

◆ IsRadioButtonStatePreserved()

bool foxit.pdf.actions.SetOCGStateAction.IsRadioButtonStatePreserved ( )

inline

获取单选按钮保留状态。

如果为true，表示当应用State数组中的状态时，应保留可选内容组之间的单选按钮状态关系。如果为false，则忽略单选按钮状态关系（如果有的话）。默认值：true。

返回: 保留状态值。

◆ RemoveOCGStates()

void foxit.pdf.actions.SetOCGStateAction.RemoveOCGStates ( int index )

inline

移除OCG状态。

参数

[in] index 要移除的OCG的索引。有效范围：从0到(count-1)。 count由函数SetOCGStateAction.GetOCGStateCount 返回。

返回: 无。

◆ ReplaceOCGStates()

bool foxit.pdf.actions.SetOCGStateAction.ReplaceOCGStates	(	PDFDoc	document,
		int	index,
		PDFDictionaryArray	ocg_dict_array
	)

inline

替换OCG状态数组。

参数

[in]	document	有效的PDF文档对象。
[in]	index	要替换的OCG的索引。有效范围：从0到(count-1)。 count由函数SetOCGStateAction.GetOCGStateCount 返回。
[in]	ocg_dict_array	要插入的OCG字典数组。

返回: true表示成功，而false表示失败。

◆ SetRadioButtonStatePreserved()

void foxit.pdf.actions.SetOCGStateAction.SetRadioButtonStatePreserved ( bool is_preserved )

inline

设置单选按钮保留状态。

参数

[in] is_preserved 保留状态值。

返回: 无。

Public 类型

Public 成员函数

额外继承的成员函数

详细描述

成员枚举类型说明

◆ OCGState

构造及析构函数说明

◆ SetOCGStateAction()

成员函数说明

◆ GetOCGState()

◆ GetOCGStateArray()

◆ GetOCGStateCount()

◆ InsertOCGStates()

◆ IsRadioButtonStatePreserved()

◆ RemoveOCGStates()

◆ ReplaceOCGStates()

◆ SetRadioButtonStatePreserved()