Foxit PDF SDK

Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
foxit.pdf.graphics.TextObject类 参考
类 foxit.pdf.graphics.TextObject 继承关系图:

## Public 成员函数
int | GetCharCount ()
| 获取当前文本对象中的字符数量。 更多...
float | GetCharHeightByIndex (int index)
| 获取当前文本对象中指定索引字符的高度。 更多...
PointF | GetCharPos (int index)
| 获取当前文本对象中指定索引字符的位置。 更多...
float | GetCharWidthByIndex (int index)
| 获取当前文本对象中指定索引字符的宽度。 更多...
string | GetText ()
| 获取文本字符串。 更多...
TextState | GetTextState (PDFPage page)
| 获取文本状态信息。 更多...
void | SetText (string text)
| 设置文本字符串。 更多...
void | SetTextState (PDFPage page, TextState text_state, bool is_italic, int weight)
| 设置文本状态信息。 更多...
Public 成员函数 继承自 foxit.pdf.graphics.GraphicsObject
bool | AddClipPath (Path path, FillMode fill_mode)
| 添加用于裁剪的路径。 更多...
bool | AddClipTextObject (TextObject textobject)
| 添加用于裁剪的文本对象。 更多...
bool | ClearClips ()
| 清除所有裁剪。 更多...
GraphicsObject | Clone ()
| 克隆新的图形对象。 更多...
GraphicsObject | Clone (GraphicsObjects src_graphicsobjects, GraphicsObjects dest_graphicsobjects)
| 克隆新的图形对象。 更多...
bool | Equal (GraphicsObject other)
| 检查输入对象是否与当前对象相等。 更多...
GraphicsObject.BlendMode | GetBlendMode ()
| 获取透明成像模型的混合模式。 更多...
Path | GetClipPath (int index)
| 根据索引获取路径裁剪。 更多...
int | GetClipPathCount ()
| 获取路径裁剪的数量。 更多...
FillMode | GetClipPathFillMode (int index)
| 根据索引获取路径裁剪的填充模式。 更多...
RectF | GetClipRect ()
| 获取裁剪矩形。 更多...
TextObject | GetClipTextObject (int index)
| 根据索引获取文本裁剪的文本对象。 更多...
int | GetClipTextObjectCount ()
| 获取文本裁剪的数量。 更多...
ColorState | GetColorState ()
| 获取颜色状态。 更多...
uint | GetFillColor ()
| 获取填充颜色。 更多...
float | GetFillOpacity ()
| 获取除描边外的绘制操作的不透明度值。 更多...
FormXObject | GetFormXObject ()
| 如果当前图形对象表示表单XObject对象，则获取表单XObject图形对象。 更多...
GraphState | GetGraphState ()
| 获取图形状态。 更多...
ImageObject | GetImageObject ()
| 如果当前图形对象表示图像对象，则获取图像图形对象。 更多...
LayerNodeArray | GetLayers (LayerTree layer_tree)
| 获取与当前图形对象关联的所有图层。 更多...
MarkedContent | GetMarkedContent ()
| 获取标记内容对象。 更多...
Matrix2D | GetMatrix ()
| 获取矩阵。 更多...
PathObject | GetPathObject ()
| 如果当前图形对象表示路径对象，则获取路径图形对象。 更多...
RectF | GetRect ()
| 获取当前图形对象的矩形。 更多...
ShadingObject | GetShadingObject ()
| 如果当前图形对象表示阴影对象，则获取阴影图形对象。 更多...
uint | GetStrokeColor ()
| 获取描边颜色。 更多...
float | GetStrokeOpacity ()
| 获取路径和字形轮廓的描边绘制操作的不透明度值。 更多...
TextObject | GetTextObject ()
| 如果当前图形对象表示文本对象，则获取文本图形对象。 更多...
GraphicsObject.Type | GetType ()
| 获取当前图形对象的类型。 更多...
bool | HasTransparency ()
| 检查当前图形对象是否具有透明度。 更多...
void | Release ()
| 释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。 更多...
bool | RemoveClipPath (int index)
| 根据索引删除路径裁剪。 更多...
bool | RemoveClipTextObject (int index)
| 根据索引删除用于裁剪的文本裁剪。 更多...
void | Rotate (int angle)
| 从当前状态以指定的角度顺时针旋转当前图形对象。 更多...
void | SetBlendMode (GraphicsObject.BlendMode blend_mode)
| 设置透明成像模型的混合模式。 更多...
void | SetClipRect (RectF clip_rect)
| 设置裁剪矩形。 更多...
void | SetColorState (ColorState color_state)
| 设置颜色状态。 更多...
void | SetFillColor (uint color)
| 设置填充颜色。 更多...
void | SetFillOpacity (float opacity)
| 设置除描边外的绘制操作的不透明度值。 更多...
void | SetGraphState (GraphState graph_state)
| 设置图形状态。 更多...
void | SetMatrix (Matrix2D matrix)
| 设置矩阵。 更多...
void | SetStrokeColor (uint color)
| 设置描边颜色。 更多...
void | SetStrokeOpacity (float opacity)
| 设置路径和字形轮廓的描边绘制操作的不透明度值。 更多...
bool | Transform (Matrix2D matrix, bool need_transform_clippath)
| 变换当前图形对象。 更多...

## 静态 Public 成员函数
static TextObject | Create ()
| 创建新的文本图形对象。 更多...

## 额外继承的成员函数
Public 类型 继承自 foxit.pdf.graphics.GraphicsObject
enum | BlendMode { BlendMode.e_BlendNormal = 0, BlendMode.e_BlendMultiply = 1, BlendMode.e_BlendScreen = 2, BlendMode.e_BlendOverlay = 3, BlendMode.e_BlendDarken = 4, BlendMode.e_BlendLighten = 5, BlendMode.e_BlendColorDodge = 6, BlendMode.e_BlendColorBurn = 7, BlendMode.e_BlendHardlight = 8, BlendMode.e_BlendSoftlight = 9, BlendMode.e_BlendDifference = 10, BlendMode.e_BlendExclusion = 11, BlendMode.e_BlendHue = 21, BlendMode.e_BlendSaturation = 22, BlendMode.e_BlendColor = 23, BlendMode.e_BlendLuminosity = 24 }
| 渲染混合模式的枚举。 更多...
enum | Type { Type.e_TypeAll = 0, Type.e_TypeText = 1, Type.e_TypePath = 2, Type.e_TypeImage = 3, Type.e_TypeShading = 4, Type.e_TypeFormXObject = 5, Type.e_TypeInlines = 6, Type.e_TypeEmptyMarkedContent = 7 }
| PDF图形对象类型的枚举。 更多...

## 详细描述

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

参见
  GraphicsObject

## 成员函数说明

## ◆ Create()

static TextObject foxit.pdf.graphics.TextObject.Create | ( |  | ) |
| inline static

创建新的文本图形对象。

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

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

## ◆ GetCharCount()

int foxit.pdf.graphics.TextObject.GetCharCount | ( |  | ) |
| inline

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

返回
  字符数量。

## ◆ GetCharHeightByIndex()

float foxit.pdf.graphics.TextObject.GetCharHeightByIndex | ( | int | index | ) |
| inline

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

参数

  [in] | index | 要检索其位置的字符索引。有效范围：从0到(count-1)。 count由TextObject.GetCharCount 函数返回。

返回
  指定字符的高度。

## ◆ GetCharPos()

PointF foxit.pdf.graphics.TextObject.GetCharPos | ( | int | index | ) |
| inline

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

参数

  [in] | index | 要检索其位置的字符索引。有效范围：从0到(count-1)。 count由TextObject.GetCharCount 函数返回。

返回
  指定字符的位置，在中。

## ◆ GetCharWidthByIndex()

float foxit.pdf.graphics.TextObject.GetCharWidthByIndex | ( | int | index | ) |
| inline

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

参数

  [in] | index | 要检索其位置的字符索引。有效范围：从0到(count-1)。 count由TextObject.GetCharCount 函数返回。

返回
  指定字符的宽度。

## ◆ GetText()

string foxit.pdf.graphics.TextObject.GetText | ( |  | ) |
| inline

获取文本字符串。

返回
  文本字符串。

## ◆ GetTextState()

TextState foxit.pdf.graphics.TextObject.GetTextState | ( | PDFPage | page | ) |
| inline

获取文本状态信息。

参数

  [in] | page | 有效的PDF页面。请确保当前图形对象正好属于此页面。

返回
  文本状态信息。

## ◆ SetText()

void foxit.pdf.graphics.TextObject.SetText | ( | string | text | ) |
| inline

设置文本字符串。

参数

  [in] | text | 新的文本字符串。

返回
  无。

注解
  在设置文本之前，请确保当前文本图形对象具有有效的字体， 该字体是文本状态的一部分。如果没有，请先调用TextObject.SetTextState 函数 设置有效字体；否则设置文本将失败。
  当此函数成功时，应调用GraphicsObjects.GenerateContent 函数。 更多详细信息请参阅GraphicsObjects.GenerateContent 函数。

## ◆ SetTextState()

void foxit.pdf.graphics.TextObject.SetTextState | ( | PDFPage | page,
|  | TextState | text_state,
|  | bool | is_italic,
|  | int | weight
| ) |  |
| inline

设置文本状态信息。

参数

  [in] | page | 有效的PDF页面。请确保当前图形对象正好属于此页面。
  [in] | text_state | 新的文本状态信息。
  [in] | is_italic | true 表示当前图形对象的文本是斜体， false 表示不是。
  [in] | weight | 原始字体粗细。如果值大于500，表示使用粗体。

返回
  无。

注解
  当此函数成功时，应调用GraphicsObjects.GenerateContent 函数。 更多详细信息请参阅GraphicsObjects.GenerateContent 函数。