Foxit PDF SDK

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

## 构造函数
(FSBitmap *) | - getBitmap
| 从当前屏幕注释获取位图。 更多...
(id) | - init
| 构造函数。
(id) | - initWithAnnot:
| 构造函数，使用父类对象。 更多...
(void) | - removeAction
| 移除动作。 更多...
(void) | - setImage:frame_index:compress:
| 为当前屏幕注释设置图像，使用指定的帧索引。 更多...
构造函数 继承自 FSAnnot
(BOOL) | - FSMoveWithResetAppearance:is_reset_appearance:
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
(BOOL) | - FSResetApStreamWithIsGenerateNewAppearanceObj:
| 重置外观流。 更多...
(FSPDFStream *) | - getAppearanceStream:appearance_state:
| 获取具有指定类型和状态的注释外观流。 更多...
(FSRectI *) | - getDeviceRect:
| 获取设备坐标系统中的注释矩形。 更多...
(FSPDFDictionary *) | - getDict
| 获取注释的字典对象。 更多...
(FSMatrix2D *) | - getDisplayMatrix:
| 获取显示矩阵，从到 目标设备坐标系统。 更多...
(int) | - getIndex
| 获取当前注释在其所属页面中的索引。 更多...
(FSPDFDictionary *) | - getOptionalContent
| 获取注释可选内容的PDF字典。 更多...
(FSPDFPage *) | - getPage
| 获取相关的PDF页面。 更多...
(FSRectF *) | - getRect
| 获取矩形，以表示。 更多...
(FSAnnotType) | - getType
| 获取当前注释的实际注释类型。 更多...
(BOOL) | - hasProperty:
| 当前注释是否具有指定的注释属性。 更多...
(id) | - initWithPage:annot_dict:
| 构造函数，使用PDF页面和注释的PDF字典。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(BOOL) | - isMarkup
| 检查当前注释是否为标记注释。 更多...
(BOOL) | - move:
| 将当前注释移动到新位置，由中的新矩形指定。 更多...
(BOOL) | - removeProperty:
| 删除指定的注释属性。 更多...
(BOOL) | - resetAppearanceStream
| 重置外观流。 更多...

## 属性
FSAction * | action
| 获取动作。 更多...
FSPDFDictionary * | mKDict
| 获取外观特征字典（也称为"MK"字典）。 更多...
float | opacity
| 获取不透明度值。 更多...
FSRotation | rotation
| 获取用于当前屏幕注释外观的图像旋转。
NSString * | title
| 获取当前屏幕注释的标题。
属性 继承自 FSAnnot
unsigned int | borderColor
| 获取边框颜色。 更多...
FSBorderInfo * | borderInfo
| 获取边框信息。 更多...
NSString * | content
| 获取内容。
unsigned int | flags
| 获取注释标志。
FSDateTime * | modifiedDateTime
| 获取最后修改日期时间。
NSString * | uniqueID
| 获取唯一ID。

## 详细描述

屏幕注释指定页面上可以播放媒体剪辑的区域。它还作为可以触发动作的对象。 通常，演出动作被设置给屏幕注释，以便屏幕注释可以用于播放媒体剪辑。
类FSScreen派生自FSAnnot ，并提供获取/设置链接注释属性和 重置屏幕注释外观流的函数。屏幕注释的外观流用于打印（如果可能） 以及当相关媒体剪辑未播放时。

注解
  对于新创建的屏幕注释，它没有边框信息和边框颜色。

参见
  FSAnnot

## 函数文档

## ◆ getBitmap()

- (FSBitmap *) getBitmap |  |  |

从当前屏幕注释获取位图。

返回
  位图对象。如果返回的位图对象的函数FSBitmap::isEmpty 的返回值为YES，那意味着当前屏幕注释没有位图。

## ◆ initWithAnnot:()

- (id) initWithAnnot: |  | (FSAnnot*) | annot |

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

参数

  [in] | annot | 父类对象。

重载 FSAnnot .

## ◆ removeAction()

- (void) removeAction |  |  |

移除动作。

此函数不能用于移除用作附加动作的动作。 如果用户想要移除任何附加动作，请参考类FSAdditionalAction了解更多详细信息。

返回
  无。

## ◆ setImage:frame_index:compress:()

- (void) setImage: |  | (FSImage*) | image
frame_index: |  | (int) | frame_index
compress: |  | (int) | compress

为当前屏幕注释设置图像，使用指定的帧索引。

输入图像可能包含多个帧，只有图像的一个帧可以设置给当前屏幕注释。
如果用户希望效果显示在注释的外观中，请在此函数后调用函数 FSAnnot::resetAppearanceStream。

参数

  [in] | image | 图像。其中一个帧将被设置给当前屏幕。 此图像至少包含一个帧，且图像类型不应为 FSImageUnknown。
  [in] | frame_index | 帧索引。有效范围：从0到（count-1）。 count由函数FSImage::getFrameCount返回。
  [in] | compress | 用于压缩图像数据的压缩算法类型。 目前，它只支持2个有效值： 0：不压缩。 1：执行默认压缩。

返回
  无。

## 属性说明

## ◆ action

- (FSAction *) action
| read write nonatomic weak

获取动作。

此函数不能用于获取用作附加动作的动作。 如果用户想要获取任何附加动作，请参考类FSAdditionalAction了解更多详细信息。

## ◆ mKDict

- (FSPDFDictionary *) mKDict
| read write nonatomic weak

获取外观特征字典（也称为"MK"字典）。

如果此字典未设置给屏幕注释（包括当前注释）， 请调用函数FSPDFObject::destroy （从FSPDFDictionary的父类继承）来释放它。

## ◆ opacity

- (float) opacity
| read write nonatomic assign

获取不透明度值。

此属性对注释的外观有影响。