fsdk.SetOCGStateAction类 参考

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

详细描述

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

参见

Action

成员函数说明

GetOCGState()

def fsdk.SetOCGStateAction.GetOCGState

(

index

)

获取OCG的状态。

参数

[in]

index

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

返回

OCG的状态。

GetOCGStateArray()

def fsdk.SetOCGStateAction.GetOCGStateArray

(

index

)

获取OCG字典数组。

参数

[in]

index

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

返回

OCG字典数组。

GetOCGStateCount()

def fsdk.SetOCGStateAction.GetOCGStateCount

(

)

获取OCG状态的数量。

返回

OCG状态的数量。

InsertOCGStates()

def 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()

def fsdk.SetOCGStateAction.IsRadioButtonStatePreserved

(

)

获取单选按钮保留状态。

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

返回

保留状态值。

RemoveOCGStates()

def fsdk.SetOCGStateAction.RemoveOCGStates

(

index

)

移除OCG状态。

参数

[in]

index

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

返回

无。

ReplaceOCGStates()

def 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()

def fsdk.SetOCGStateAction.SetRadioButtonStatePreserved

(

is_preserved

)

设置单选按钮保留状态。

参数

[in]

is_preserved

保留状态值。

返回

无。