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

构造函数

(int) - getCharCount
 获取当前文本对象中的字符数量。
更多...
 
(float) - getCharHeightByIndex:
 获取当前文本对象中指定索引字符的高度。
更多...
 
(FSPointF *) - getCharPos:
 获取当前文本对象中指定索引字符的位置。
更多...
 
(float) - getCharWidthByIndex:
 获取当前文本对象中指定索引字符的宽度。
更多...
 
(FSTextState *) - getTextState:
 获取文本状态信息。
更多...
 
(void) - setTextState:text_state:is_italic:weight:
 设置文本状态信息。
更多...
 
- 构造函数 继承自 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:
 变换当前图形对象。
更多...
 

类方法

(FSTextObject *) + create
 创建新的文本图形对象。
更多...
 

属性

NSString * text
 获取文本字符串。

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

 
FSRectF * clipRect
 获取裁剪矩形。

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

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

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

 

详细描述

文本图形对象是一种PDF图形对象,因此 FSTextObject 类派生自 FSGraphicsObject 类。它提供了获取/设置文本图形对象数据的函数。
要创建新的文本图形对象,请使用 FSTextObject::create 函数,然后 使用设置函数为新的文本图形对象设置信息。

参见
FSGraphicsObject

函数文档

◆ create()

+ (FSTextObject *) create

创建新的文本图形对象。

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

返回
新的文本图形对象。如果有任何错误,此函数将返回nil。

◆ getCharCount()

- (int) getCharCount

获取当前文本对象中的字符数量。

返回
字符数量。

◆ getCharHeightByIndex:()

- (float) getCharHeightByIndex: (int)  index

获取当前文本对象中指定索引字符的高度。

参数
[in]index要检索其位置的字符索引。有效范围:从0到(count-1)。 count由 FSTextObject::getCharCount 函数返回。
返回
指定字符的高度。

◆ getCharPos:()

- (FSPointF *) getCharPos: (int)  index

获取当前文本对象中指定索引字符的位置。

参数
[in]index要检索其位置的字符索引。有效范围:从0到(count-1)。 count由 FSTextObject::getCharCount 函数返回。
返回
指定字符的位置,在中。

◆ getCharWidthByIndex:()

- (float) getCharWidthByIndex: (int)  index

获取当前文本对象中指定索引字符的宽度。

参数
[in]index要检索其位置的字符索引。有效范围:从0到(count-1)。 count由 FSTextObject::getCharCount 函数返回。
返回
指定字符的宽度。

◆ getTextState:()

- (FSTextState *) getTextState: (FSPDFPage*)  page

获取文本状态信息。

参数
[in]page有效的PDF页面。请确保当前图形对象正好属于此页面。
返回
文本状态信息。

◆ setTextState:text_state:is_italic:weight:()

- (void) setTextState: (FSPDFPage*)  page
text_state: (FSTextState*)  text_state
is_italic: (BOOL)  is_italic
weight: (int)  weight 

设置文本状态信息。

参数
[in]page有效的PDF页面。请确保当前图形对象正好属于此页面。
[in]text_state新的文本状态信息。
[in]is_italicYES 表示当前图形对象的文本是斜体, NO 表示不是。
[in]weight原始字体粗细。如果值大于500,表示使用粗体。
返回
无。
注解
当此函数成功时,应调用 FSGraphicsObjects::generateContent 函数。 更多详细信息请参阅 FSGraphicsObjects::generateContent 函数。