Foxit PDF SDK

构造函数 | 所有成员列表
FSSetOCGStateAction类 参考
类 FSSetOCGStateAction 继承关系图:

## 构造函数
(FSSetOCGStateActionOCGState) | - getOCGState:
| 获取OCG的状态。 更多...
(PDFDictionaryArray *) | - getOCGStateArray:
| 获取OCG字典数组。 更多...
(int) | - getOCGStateCount
| 获取OCG状态的数量。 更多...
(id) | - initWithAction:
| 构造函数，使用父类对象。 更多...
(int) | - insertOCGStates:index:state:ocg_dict_array:
| 将OCG状态插入到动作中。 更多...
(BOOL) | - isRadioButtonStatePreserved
| 获取单选按钮保留状态。 更多...
(void) | - removeOCGStates:
| 移除OCG状态。 更多...
(BOOL) | - replaceOCGStates:index:ocg_dict_array:
| 替换OCG状态数组。 更多...
(void) | - setRadioButtonStatePreserved:
| 设置单选按钮保留状态。 更多...
构造函数 继承自 FSAction
(FSPDFDictionary *) | - getDict
| 获取当前对象的PDF字典。 更多...
(FSPDFDoc *) | - getDocument
| 获取当前动作所属的PDF文档。 更多...
(FSAction *) | - getSubAction:
| 按索引获取子动作。 更多...
(int) | - getSubActionCount
| 获取子动作的数量。 更多...
(FSActionType) | - getType
| 获取动作类型。 更多...
(id) | - initWithDocument:action_dict:
| 构造函数，带参数。 更多...
(void) | - insertSubAction:sub_action:
| 在指定索引位置插入新的子动作。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(void) | - removeAllSubActions
| 移除所有子动作。 更多...
(void) | - removeSubAction:
| 移除指定索引的子动作。 更多...
(void) | - setSubAction:sub_action:
| 按索引设置子动作。 更多...

## 额外继承的成员函数
类方法 继承自 FSAction
(FSAction *) | + create:action_type:
| 为指定的动作类型创建新动作。 更多...

## 详细描述

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

参见
  FSAction

## 函数文档

## ◆ getOCGState:()

- (FSSetOCGStateActionOCGState) getOCGState: |  | (int) | index |

获取OCG的状态。

参数

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

返回
  OCG的状态。

## ◆ getOCGStateArray:()

- (PDFDictionaryArray *) getOCGStateArray: |  | (int) | index |

获取OCG字典数组。

参数

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

返回
  OCG字典数组。

## ◆ getOCGStateCount()

- (int) getOCGStateCount |  |  |

获取OCG状态的数量。

返回
  OCG状态的数量。

## ◆ initWithAction:()

- (id) initWithAction: |  | (FSAction*) | action |

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

参数

  [in] | action | 父类对象。

重载 FSAction .

## ◆ insertOCGStates:index:state:ocg_dict_array:()

- (int) insertOCGStates: |  | (FSPDFDoc*) | document
index: |  | (int) | index
state: |  | (FSSetOCGStateActionOCGState) | state
ocg_dict_array: |  | (PDFDictionaryArray*) | ocg_dict_array

将OCG状态插入到动作中。

参数

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

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

## ◆ isRadioButtonStatePreserved()

- (BOOL) isRadioButtonStatePreserved |  |  |

获取单选按钮保留状态。

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

返回
  保留状态值。

## ◆ removeOCGStates:()

- (void) removeOCGStates: |  | (int) | index |

移除OCG状态。

参数

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

返回
  无。

## ◆ replaceOCGStates:index:ocg_dict_array:()

- (BOOL) replaceOCGStates: |  | (FSPDFDoc*) | document
index: |  | (int) | index
ocg_dict_array: |  | (PDFDictionaryArray*) | ocg_dict_array

替换OCG状态数组。

参数

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

返回
  YES表示成功，而NO表示失败。

## ◆ setRadioButtonStatePreserved:()

- (void) setRadioButtonStatePreserved: |  | (BOOL) | is_preserved |

设置单选按钮保留状态。

参数

  [in] | is_preserved | 保留状态值。

返回
  无。