FSDK::SetOCGStateAction类 参考

Public 成员函数
	constructor (action)
	带有 parent class object. 更多...
	GetOCGState (index)
	获取OCG的状态。 更多...
	GetOCGStateArray (index)
	获取OCG字典数组。 更多...
	GetOCGStateCount ()
	获取OCG状态的数量。 更多...
	InsertOCGStates (document, index, state, ocg_dict_array)
	将OCG状态插入到操作中。 更多...
	IsRadioButtonStatePreserved ()
	获取单选按钮保留状态。 更多...
	RemoveOCGStates (index)
	移除OCG状态。 更多...
	ReplaceOCGStates (document, index, ocg_dict_array)
	替换OCG状态数组。 更多...
	SetRadioButtonStatePreserved (is_preserved)
	设置单选按钮保留状态。 更多...

静态 Public 属性
static	e_OCGStateOff
	将后续组的状态设置为OFF。
static	e_OCGStateOn
	将后续组的状态设置为ON。
static	e_OCGStateToggle
	反转后续组的状态。

详细描述

设置OCG状态操作用于设置一个或多个可选内容组的状态。（有关更多详细信息，请参阅 <PDF Reference 1.7> P667 "Set-OCG-State Actions"） 类 FSDK..SetOCGStateAction 派生自 Action，提供 获取/设置设置OCG状态操作数据的功能。

参见

Action

成员函数说明

constructor()

FSDK::SetOCGStateAction::constructor

(

action

)

带有 parent class object.

参数

[in]

action

Parent class object.

GetOCGState()

FSDK::SetOCGStateAction::GetOCGState

(

index

)

获取OCG的状态。

参数

[in]

index

OCG状态的索引。 有效范围：从 0 到（count-1）。 count 由函数 FSDK.SetOCGStateAction.GetOCGStateCount 返回。

返回

OCG的状态。

GetOCGStateArray()

FSDK::SetOCGStateAction::GetOCGStateArray

(

index

)

获取OCG字典数组。

参数

[in]

index

OCG状态的索引。 有效范围：从 0 到（count-1）。 count 由函数 FSDK.SetOCGStateAction.GetOCGStateCount 返回。

返回

OCG字典数组。

GetOCGStateCount()

FSDK::SetOCGStateAction::GetOCGStateCount

(

)

获取OCG状态的数量。

返回

OCG状态的数量。

InsertOCGStates()

FSDK::SetOCGStateAction::InsertOCGStates	(	document	,
		index	,
		state	,
		ocg_dict_array
	)

将OCG状态插入到操作中。

参数

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

返回

插入的OCG状态的索引。

IsRadioButtonStatePreserved()

FSDK::SetOCGStateAction::IsRadioButtonStatePreserved

(

)

获取单选按钮保留状态。

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

返回

保留状态值。

RemoveOCGStates()

FSDK::SetOCGStateAction::RemoveOCGStates

(

index

)

移除OCG状态。

参数

[in]

index

要移除的OCG的索引。 有效范围：从 0 到（count-1）。 count 由函数 FSDK.SetOCGStateAction.GetOCGStateCount 返回。

返回

无。

ReplaceOCGStates()

FSDK::SetOCGStateAction::ReplaceOCGStates	(	document	,
		index	,
		ocg_dict_array
	)

替换OCG状态数组。

参数

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

返回

true 表示成功，而 false 表示失败。

SetRadioButtonStatePreserved()

FSDK::SetOCGStateAction::SetRadioButtonStatePreserved

(

is_preserved

)

设置单选按钮保留状态。

参数

[in]

is_preserved

保留状态值。

返回

无。