Foxit PDF SDK

Public 成员函数 | Public 属性 | 静态 Public 属性 | 所有成员列表
FSDK::TextState类 参考

## Public 成员函数
| constructor ()
| 构造函数。
| constructor (version, font, font_size, charspace, wordspace, textmode, origin_position, textmatrix[])
| 带参数的构造函数。 更多...
| Set (version, font, font_size, charspace, wordspace, textmode, origin_position, textmatrix[])
| 设置值。 更多...

## Public 属性
textmatrix | __pad0__: number[]
| Text transformation matrix. 更多...
| charspace
| Character spacing. 更多...
| font
| 字体对象。 更多...
| font_horizontal_size
| Font horizontal size in device units (read-only). If valid, it would be above 0. 更多...
| font_size
| "Tf" 中的字体大小。如果有效，应大于 0。 更多...
| font_vertical_size
| Font vertical size in device units (read-only). If valid, it would be above 0. 更多...
| origin_position
| 原点位置，位于 PDF 坐标系统 中。 更多...
| textmode
| Text rendering mode. Please refer to values starting from FSDK.TextState.e_ModeFill and this should be one of these values. 更多...
| version
| Version of this class. 更多...
| wordspace
| Word spacing (only apply to space character). 更多...

## 静态 Public 属性
static | e_ModeClip
| 文本模式：将文本添加到路径用于剪裁。
static | e_ModeFill
| 文本模式的枚举。 更多...
static | e_ModeFillClip
| 文本模式：填充文本并添加到路径用于剪裁。
static | e_ModeFillStroke
| 文本模式：填充和描边文本。
static | e_ModeFillStrokeClip
| 文本模式：填充和描边文本，并添加到路径用于剪裁。
static | e_ModeInvisible
| 文本模式：既不填充也不描边文本，使其不可见。
static | e_ModeStroke
| 文本模式：描边文本。
static | e_ModeStrokeClip
| 文本模式：描边文本并添加到路径用于剪裁。

## 详细描述

This class represents an array of FSDK.GraphicsObject objects. 此类表示 PDF 文本状态。

## 成员函数说明

## ◆ constructor()

FSDK::TextState::constructor | ( | version | ,
|  | font | ,
|  | font_size | ,
|  | charspace | ,
|  | wordspace | ,
|  | textmode | ,
|  | origin_position | ,
|  | textmatrix | []
| ) |  |

带参数的构造函数。

参数

  [in] | version | Version of this structure, which is used to decide which members are useful. Currently, only 1 is valid.
  [in] | font | (Version 1) A valid font object.
  [in] | font_size | (Version 1) The font size in "Tf", It should be above 0.
  [in] | charspace | (Version 1) Character spacing.
  [in] | wordspace | (Version 1) Word spacing (only apply to space character).
  [in] | textmode | (Version 1) Text rendering mode. Please refer to values starting from FSDK.TextState.e_ModeFill and this should be one of these values.
  [in] | origin_position | (Version 1) The origin point, in PDF coordinate system.
  [in] | textmatrix | (Version 1) Text transformation matrix. This is an array of four numbers.

返回
  None.

## ◆ Set()

FSDK::TextState::Set | ( | version | ,
|  | font | ,
|  | font_size | ,
|  | charspace | ,
|  | wordspace | ,
|  | textmode | ,
|  | origin_position | ,
|  | textmatrix | []
| ) |  |

设置值。

参数

  [in] | version | 此结构的版本，用于决定哪些成员有用。 目前，仅 1 有效。
  [in] | font | (版本 1) 有效的字体对象。
  [in] | font_size | (版本 1) "Tf" 中的字体大小。它应大于 0。
  [in] | charspace | (版本 1) 字符间距。
  [in] | wordspace | (版本 1) 单词间距（仅适用于空格字符）。
  [in] | textmode | (版本 1) 文本渲染模式。请参阅从 FSDK.TextState.e_ModeFill 开始的值，这应该是这些值之一。
  [in] | origin_position | (版本 1) 原点，在 PDF 坐标系统 中。
  [in] | textmatrix | (版本 1) 文本变换矩阵。这是一个包含四个数字的数组。

返回
  None.

## 类成员变量说明

## ◆ __pad0__

textmatrix FSDK::TextState::__pad0__

Text transformation matrix.

版本
  1

This is an array of four numbers. The first number is the input coefficient a, the second number is the input coefficient b, the third number is the input coefficient c, the forth number is the input coefficient d.

## ◆ charspace

FSDK::TextState::charspace

Character spacing.

版本
  1

For horizontal writing, a positive value has the effect of expanding the distance between glyphs, whereas for vertical writing, a negative value has this effect.

## ◆ e_ModeFill

FSDK::TextState::e_ModeFill
| static

文本模式的枚举。

此枚举的值应单独使用。

文本模式：填充文本。

## ◆ font

FSDK::TextState::font

字体对象。

版本
  1

## ◆ font_horizontal_size

FSDK::TextState::font_horizontal_size

Font horizontal size in device units (read-only). If valid, it would be above 0.

版本
  1

## ◆ font_size

FSDK::TextState::font_size

"Tf" 中的字体大小。如果有效，应大于 0。

版本
  1

## ◆ font_vertical_size

FSDK::TextState::font_vertical_size

Font vertical size in device units (read-only). If valid, it would be above 0.

版本
  1

## ◆ origin_position

FSDK::TextState::origin_position

原点位置，位于 PDF 坐标系统 中。

版本
  1

## ◆ textmode

FSDK::TextState::textmode

Text rendering mode. Please refer to values starting from FSDK.TextState.e_ModeFill and this should be one of these values.

版本
  1

## ◆ version

FSDK::TextState::version

Version of this class.

版本
  1

Members of this class may be extended in the future. This version can be used to separate the different extended members.

## ◆ wordspace

FSDK::TextState::wordspace

Word spacing (only apply to space character).

版本
  1

For horizontal writing, a positive value has the effect of increasing the spacing between words. For vertical writing, a positive value decreases the spacing between words (and a negative value increases it), since vertical coordinates increase from bottom to top. This will not take effect if font of current object is an embedded font.