Foxit PDF SDK
FSFormXObject类 参考
类 FSFormXObject 继承关系图:
FSGraphicsObject

构造函数

(FSGraphicsObjects *) - getGraphicsObjects
 获取与当前表单XObject关联的图形对象。
更多...
 
(FSPDFStream *) - getStream
 获取流。
更多...
 
(BOOL) - importPageContent:is_annots_included:
 从指定的PDF页面将页面内容导入到当前表单XObject。
更多...
 
- 构造函数 继承自 FSGraphicsObject
(BOOL) - addClipPath:fill_mode:
 添加用于裁剪的路径。
更多...
 
(BOOL) - addClipTextObject:
 添加用于裁剪的文本对象。
更多...
 
(BOOL) - clearClips
 清除所有裁剪。
更多...
 
(FSGraphicsObject *) - clone
 克隆新的图形对象。
更多...
 
(FSGraphicsObject *) - cloneWithSrcGraphicsobjects:dest_graphicsobjects:
 克隆新的图形对象。
更多...
 
(FSPath *) - getClipPath:
 根据索引获取路径裁剪。
更多...
 
(int) - getClipPathCount
 获取路径裁剪的数量。
更多...
 
(FSFillMode) - getClipPathFillMode:
 根据索引获取路径裁剪的填充模式。
更多...
 
(FSTextObject *) - getClipTextObject:
 根据索引获取文本裁剪的文本对象。
更多...
 
(int) - getClipTextObjectCount
 获取文本裁剪的数量。
更多...
 
(FSFormXObject *) - getFormXObject
 如果当前图形对象表示表单XObject对象,则获取表单XObject图形对象。
更多...
 
(FSImageObject *) - getImageObject
 如果当前图形对象表示图像对象,则获取图像图形对象。
更多...
 
(FSLayerNodeArray *) - getLayers:
 获取与当前图形对象关联的所有图层。
更多...
 
(FSMarkedContent *) - getMarkedContent
 获取标记内容对象。
更多...
 
(FSPathObject *) - getPathObject
 如果当前图形对象表示路径对象,则获取路径图形对象。
更多...
 
(FSRectF *) - getRect
 获取当前图形对象的矩形。
更多...
 
(FSShadingObject *) - getShadingObject
 如果当前图形对象表示阴影对象,则获取阴影图形对象。
更多...
 
(FSTextObject *) - getTextObject
 如果当前图形对象表示文本对象,则获取文本图形对象。
更多...
 
(FSGraphicsObjectType) - getType
 获取当前图形对象的类型。
更多...
 
(BOOL) - hasTransparency
 检查当前图形对象是否具有透明度。
更多...
 
(BOOL) - removeClipPath:
 根据索引删除路径裁剪。
更多...
 
(BOOL) - removeClipTextObject:
 根据索引删除用于裁剪的文本裁剪。
更多...
 
(void) - rotate:
 从当前状态以指定的角度顺时针旋转当前图形对象。
更多...
 
(BOOL) - transform:need_transform_clippath:
 变换当前图形对象。
更多...
 

类方法

(FSFormXObject *) + create:
 创建新的表单XObject图形对象。
更多...
 

额外继承的成员函数

- 属性 继承自 FSGraphicsObject
FSGraphicsObjectBlendMode blendMode
 获取透明成像模型的混合模式。

 
FSRectF * clipRect
 获取裁剪矩形。

 
FSColorState * colorState
 获取颜色状态。
更多...
 
unsigned int fillColor
 获取填充颜色。
更多...
 
float fillOpacity
 获取除描边外的绘制操作的不透明度值。

 
FSGraphState * graphState
 获取图形状态。
更多...
 
FSMatrix2D * matrix
 获取矩阵。

 
unsigned int strokeColor
 获取描边颜色。
更多...
 
float strokeOpacity
 获取路径和字形轮廓的描边绘制操作的不透明度值。

 

详细描述

表单XObject不仅是图形对象,也是容器。表单XObject由一组图形对象或子表单XObject组成。 表单XObject是一种PDF图形对象,因此 FSFormXObject 类派生自 FSGraphicsObject 类。 它提供了获取/设置表单XObject数据的函数。
要创建新的表单XObject图形对象,请使用 FSPathObject::create 函数,然后 将页面内容导入到新的表单XObject中,或通过 FSFormXObject::getGraphicsObjects 函数 返回的 FSGraphicsObjects 对象将新的图形对象插入到表单XObject中。

参见
FSGraphicsObject

函数文档

◆ create:()

+ (FSFormXObject *) create: (FSPDFDoc*)  document

创建新的表单XObject图形对象。

新创建的表单XObject图形对象尚未包含任何数据。然后,可以调用设置函数 为新的表单XObject图形对象设置数据。 如果新创建的表单XObject不会插入到任何页面或其他对象中, 请记住在不使用时调用 GraphicsObject::Release 函数来释放它。

参数
[in]document有效的PDF文档对象。新的表单XObject图形对象随后应插入到 此PDF文档的某个页面中。
返回
新的表单XObject。如果有任何错误,此函数将返回nil。

◆ getGraphicsObjects()

- (FSGraphicsObjects *) getGraphicsObjects

获取与当前表单XObject关联的图形对象。

返回
FSGraphicsObjects 对象。

◆ getStream()

- (FSPDFStream *) getStream

获取流。

返回
表示当前表单XObject流数据的 FSPDFStream 。 如果有任何错误,此函数将返回nil。

◆ importPageContent:is_annots_included:()

- (BOOL) importPageContent: (FSPDFPage*)  source_page
is_annots_included: (BOOL)  is_annots_included 

从指定的PDF页面将页面内容导入到当前表单XObject。

如果此函数成功,当前表单XObject的边界框将与页面大小相同。

参数
[in]source_page有效的PDF页面对象,表示其内容将被 导入到当前表单XObject的源PDF页面。
[in]is_annots_includedYES 表示注释应与参数source_page的内容一起包含。 NO 表示注释应从参数source_page的内容中忽略。
返回
YES 表示成功,NO 表示失败。
注解
当此函数成功时,应调用 FSGraphicsObjects::generateContent 函数。 更多详细信息请参阅 FSGraphicsObjects::generateContent 函数。