Foxit PDF SDK
FSDK::TextObject类 参考
类 FSDK::TextObject 继承关系图:
FSDK::GraphicsObject

Public 成员函数

 GetCharCount ()
 获取当前文本对象中的字符数。 更多...
 
 GetCharHeightByIndex (index)
 获取当前文本对象中由索引指定的字符的高度。 更多...
 
 GetCharPos (index)
 获取当前文本对象中由索引指定的字符的位置。 更多...
 
 GetCharWidthByIndex (index)
 获取当前文本对象中由索引指定的字符的宽度。 更多...
 
 GetText ()
 获取文本字符串。 更多...
 
 GetTextState (page)
 获取文本状态信息。 更多...
 
 SetText (text)
 设置文本字符串。 更多...
 
 SetText (text)
 Set text string. 更多...
 
 SetTextState (page, text_state, is_italic, weight)
 设置文本状态信息。 更多...
 
- Public 成员函数 继承自 FSDK::GraphicsObject
 AddClipPath (path, fill_mode)
 添加路径用于剪裁。 更多...
 
 AddClipTextObject (textobject)
 添加文本对象用于剪裁。 更多...
 
 ClearClips ()
 Clear all clips. 更多...
 
 Clone ()
 克隆一个新的图形对象。 更多...
 
 Clone (src_graphicsobjects, dest_graphicsobjects)
 克隆一个新的图形对象。 更多...
 
 GetBlendMode ()
 获取透明成像模型的混合模式。 更多...
 
 GetClipPath (index)
 通过索引获取路径剪裁。 更多...
 
 GetClipPathCount ()
 获取路径剪裁的数量。 更多...
 
 GetClipPathFillMode (index)
 通过索引获取路径剪裁的填充模式。 更多...
 
 GetClipRect ()
 获取裁剪矩形。 更多...
 
 GetClipTextObject (index)
 通过索引获取文本剪裁的文本对象。 更多...
 
 GetClipTextObjectCount ()
 获取文本剪裁的数量。 更多...
 
 GetColorState ()
 获取颜色状态。 更多...
 
 GetFillColor ()
 获取填充颜色。 更多...
 
 GetFillOpacity ()
 获取除描边以外的绘画操作的不透明度值。 更多...
 
 GetFormXObject ()
 如果当前图形对象表示表单 XObject 对象,则获取表单 XObject 图形对象。 更多...
 
 GetGraphState ()
 获取图形状态。 更多...
 
 GetImageObject ()
 如果当前图形对象表示图像对象,则获取图像图形对象。 更多...
 
 GetLayers (layer_tree)
 获取与当前图形对象关联的所有图层。 更多...
 
 GetMarkedContent ()
 获取标记内容对象。 更多...
 
 GetMatrix ()
 获取矩阵。 更多...
 
 GetPathObject ()
 如果当前图形对象表示路径对象,则获取路径图形对象。 更多...
 
 GetRect ()
 获取当前图形对象的矩形。 更多...
 
 GetShadingObject ()
 如果当前图形对象表示阴影对象,则获取阴影图形对象。 更多...
 
 GetStrokeColor ()
 获取描边颜色。 更多...
 
 GetStrokeOpacity ()
 获取路径和字形轮廓的描边绘画操作的不透明度值。 更多...
 
 GetTextObject ()
 如果当前图形对象表示文本对象,则获取文本图形对象。 更多...
 
 GetType ()
 获取当前图形对象的类型。 更多...
 
 HasTransparency ()
 检查当前 PDF 页面是否具有透明度。 更多...
 
 IsScanned ()
 检查当前 PDF 页面是否为扫描页。 更多...
 
 Release ()
 释放尚未插入到任何 PDF 页面或其他对象的克隆或新创建的 PDF 图形对象。 更多...
 
 RemoveClipPath (index)
 通过索引移除路径剪裁。 更多...
 
 RemoveClipTextObject (index)
 通过索引移除文本剪裁。 更多...
 
 Rotate (angle)
 Rotate current graphics object from current state with specified angle degree in clockwise. 更多...
 
 SetBlendMode (blend_mode)
 设置透明成像模型的混合模式。 更多...
 
 SetClipRect (clip_rect)
 设置裁剪矩形。 更多...
 
 SetColorState (color_state)
 设置颜色状态。 更多...
 
 SetFillColor (color)
 设置填充颜色。 更多...
 
 SetFillOpacity (opacity)
 为除描边以外的绘画操作设置不透明度值。 更多...
 
 SetGraphState (graph_state)
 设置图形状态。 更多...
 
 SetMatrix (matrix)
 设置矩阵。 更多...
 
 SetStrokeColor (color)
 设置描边颜色。 更多...
 
 SetStrokeOpacity (opacity)
 为路径和字形轮廓的描边绘画操作设置不透明度值。 更多...
 
 Transform (matrix, need_transform_clippath)
 变换当前图形对象。 更多...
 

静态 Public 成员函数

static Create ()
 创建新的文本图形对象。 更多...
 

额外继承的成员函数

- 静态 Public 属性 继承自 FSDK::GraphicsObject
static e_BlendColor
 创建具有源颜色的色调和饱和度以及背景颜色的亮度的颜色。 更多...
 
static e_BlendColorBurn
 Darkens backdrop color to reflect the source color. 更多...
 
static e_BlendColorDodge
 Brightens backdrop color to reflect source colors. 更多...
 
static e_BlendDarken
 Select darker one of backdrop and source colors. 更多...
 
static e_BlendDifference
 Subtracts the darker of the two constituent colors from lighter colors. 更多...
 
static e_BlendExclusion
 创建具有源颜色的色调、 以及背景颜色的饱和度和亮度的颜色。 更多...
 
static e_BlendHardlight
 Multiply or screens colors, depending on source color value. 更多...
 
static e_BlendHue
 创建具有源颜色的色调、 以及背景颜色的饱和度和亮度的颜色。 更多...
 
static e_BlendLighten
 Select lighter one of backdrop and source colors. 更多...
 
static e_BlendLuminosity
 创建具有源颜色的亮度以及背景颜色的色调和饱和度的颜色。 更多...
 
static e_BlendMultiply
 Multiply backdrop by source color values. 更多...
 
static e_BlendNormal
 Enumeration for render blend mode. 更多...
 
static e_BlendOverlay
 Multiply or screens colors, depending on backdrop color value. 更多...
 
static e_BlendSaturation
 创建具有源颜色的饱和度、 以及背景颜色的色调和亮度的颜色。 更多...
 
static e_BlendScreen
 Multiply complements of backdrop by source color values, and then complement the result. 更多...
 
static e_BlendSoftlight
 Darkens or lightens colors, depending on source color value. 更多...
 
static e_TypeAll
 PDF 图形对象类型的枚举。 更多...
 
static e_TypeFormXObject
 表单 XObject 图形对象。
 
static e_TypeImage
 图像图形对象。
 
static e_TypePath
 路径图形对象。
 
static e_TypeShading
 渐变图形对象。
 
static e_TypeText
 文本图形对象。
 

详细描述

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

参见
FSDK.GraphicsObject

成员函数说明

◆ Create()

static FSDK::TextObject::Create ( )
static

创建新的文本图形对象。

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

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

◆ GetCharCount()

FSDK::TextObject::GetCharCount ( )

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

返回
字符数。

◆ GetCharHeightByIndex()

FSDK::TextObject::GetCharHeightByIndex ( index  )

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

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

◆ GetCharPos()

FSDK::TextObject::GetCharPos ( index  )

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

参数
[in]index要检索其位置的字符的索引。有效范围:从 0 到 (count-1)。 count 由函数 FSDK.TextObject.GetCharCount 返回。
返回
指定字符的位置,采用 PDF坐标系统

◆ GetCharWidthByIndex()

FSDK::TextObject::GetCharWidthByIndex ( index  )

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

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

◆ GetText()

FSDK::TextObject::GetText ( )

获取文本字符串。

返回
文本字符串。

◆ GetTextState()

FSDK::TextObject::GetTextState ( page  )

获取文本状态信息。

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

◆ SetText() [1/2]

FSDK::TextObject::SetText ( text  )

设置文本字符串。

参数
[in]text新的文本字符串。
返回
无。
注解
在设置文本之前,请确保当前文本图形对象具有有效的字体, 该字体是文本状态的一部分。如果没有,请先调用函数 FSDK.TextObject.SetTextState 设置有效字体;否则设置文本将失败。
当此函数成功时,应调用函数 FSDK.GraphicsObjects.GenerateContent。 有关更多详细信息,请参考函数 FSDK.GraphicsObjects.GenerateContent

◆ SetText() [2/2]

FSDK::TextObject::SetText ( text  )

Set text string.

参数
[in]textNew text string.
返回
None.
注解
Before setting text, please ensure that current text graphics object has valid font which is a part of text state. If not, please call function FSDK.TextObject.SetTextState to set valid font first; otherwise setting text will fail.
When this function succeeds, function FSDK.GraphicsObjects.GenerateContent should be called. Please refer to function FSDK.GraphicsObjects.GenerateContent for more details.

◆ SetTextState()

FSDK::TextObject::SetTextState ( page  ,
text_state  ,
is_italic  ,
weight   
)

设置文本状态信息。

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