Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FoxitPDFSDKPython3.Font类 参考
类 FoxitPDFSDKPython3.Font 继承关系图:

## Public 成员函数
def | Font (font_file_path, face_index, charset)
| 从字体文件的构造函数。 更多...
def | Font (font_id)
| 通过标准字体ID的构造函数。 更多...
def | Font (other)
| 使用另一个字体对象的构造函数。 更多...
def | Font (stream)
| 通过使用 FoxitPDFSDKPython3.StreamCallback 从字体流的构造函数。 更多...
def | AddUnicodes (document, unicode_array)
| 向当前嵌入字体添加Unicode字符。 更多...
def | Embed (document, is_add_all_unicodes)
| 将当前字体嵌入到指定的PDF文档中。 更多...
def | GetAscent ()
| 获取上升值，以1/1000 em大小为单位（PDF单位）。 更多...
def | GetBaseFontName (document)
| 获取基础字体名称。 更多...
def | GetCharBBox (unicode, document)
| 获取PDF文档中由Unicode指定的字符的边界框。 更多...
def | GetCharWidth (unicode, document)
| 获取PDF文档中由Unicode指定的字符的宽度（以1/1000 em大小为单位，作为PDF单位）。 更多...
def | GetCIDCharset (document)
| 获取CID字体字符集。 更多...
def | GetDescent ()
| 获取下降值，以1/1000 em大小为单位（PDF单位）。 更多...
def | GetEncoding (document)
| 获取当前字体编码。 更多...
def | GetFamilyName ()
| 检索字体族名称。 更多...
def | GetFontType (document)
| 获取字体类型。 更多...
def | GetName ()
| 检索PostScript名称。 更多...
def | GetStandard14Font (document)
| 获取标准字体ID。 更多...
def | GetStyles (document)
| 获取字体样式。 更多...
def | IsBold ()
| 判断当前字体是否为粗体。 更多...
def | IsCharSupported (unicode, document)
| 检查当前字体是否支持某字符。 更多...
def | IsEmbedded (document)
| 判断当前字体是否嵌入在指定的PDF文档中。 更多...
def | IsEmpty ()
| 检查当前对象是否为空。 更多...
def | IsItalic ()
| 判断当前字体对象是否为斜体。 更多...
def | IsStandardFont (document)
| 检查当前字体是否为标准字体。 更多...
def | IsSupportEmbedded (document)
| 检查当前字体是否支持嵌入到指定的PDF文档中。 更多...
def | IsVertWriting (document)
| 检查当前字体是否为垂直书写。 更多...
def | SetEncoding (document, value)
| 设置当前字体编码。 更多...

## 静态 Public 属性
| e_CharsetANSI = _fsdk.Font_e_CharsetANSI
| 字体字符集：ANSI（美国、西欧）。
| e_CharsetArabic = _fsdk.Font_e_CharsetArabic
| 字体字符集：阿拉伯文。
| e_CharsetBaltic = _fsdk.Font_e_CharsetBaltic
| 字体字符集：波罗的海文。
| e_CharsetChineseBig5 = _fsdk.Font_e_CharsetChineseBig5
| 字体字符集：繁体中文。
| e_CharsetDefault = _fsdk.Font_e_CharsetDefault
| 字体字符集：系统默认，用于未知或映射目的。
| e_CharsetEastEurope = _fsdk.Font_e_CharsetEastEurope
| 字体字符集：东欧。
| e_CharsetGB2312 = _fsdk.Font_e_CharsetGB2312
| 字体字符集：简体中文。
| e_CharsetGreek = _fsdk.Font_e_CharsetGreek
| 字体字符集：希腊文。
| e_CharsetHangeul = _fsdk.Font_e_CharsetHangeul
| 字体字符集：韩文（Wansung）。
| e_CharsetHebrew = _fsdk.Font_e_CharsetHebrew
| 字体字符集：希伯来文。
| e_CharsetRussian = _fsdk.Font_e_CharsetRussian
| 字体字符集：俄文。
| e_CharsetShift_JIS = _fsdk.Font_e_CharsetShift_JIS
| 字体字符集：日文（Shift-JIS）。
| e_CharsetSymbol = _fsdk.Font_e_CharsetSymbol
| 字体字符集：标准符号。
| e_CharsetThai = _fsdk.Font_e_CharsetThai
| 字体字符集：泰文。
| e_CharsetTurkish = _fsdk.Font_e_CharsetTurkish
| 字体字符集：土耳其文。
| e_CIDCharsetCNS1 = _fsdk.Font_e_CIDCharsetCNS1
| CID字体字符集：Adobe-CNS1。
| e_CIDCharsetGB1 = _fsdk.Font_e_CIDCharsetGB1
| CID字体字符集：Adobe-GB1。
| e_CIDCharsetJAPAN1 = _fsdk.Font_e_CIDCharsetJAPAN1
| CID字体字符集：Adobe-Japan1。
| e_CIDCharsetKOREA1 = _fsdk.Font_e_CIDCharsetKOREA1
| CID字体字符集：Adobe-Korea1。
| e_CIDCharsetUNICODE = _fsdk.Font_e_CIDCharsetUNICODE
| CID字体字符集：Unicode。
| e_CIDCharsetUnknown = _fsdk.Font_e_CIDCharsetUnknown
| CID字体字符集：未知。
| e_FontTypeCIDFont = _fsdk.Font_e_FontTypeCIDFont
| 字体类型：CID 字体。
| e_FontTypeTrueType = _fsdk.Font_e_FontTypeTrueType
| 字体类型：TrueType。
| e_FontTypeType1 = _fsdk.Font_e_FontTypeType1
| 字体类型：Type1。
| e_FontTypeType3 = _fsdk.Font_e_FontTypeType3
| 字体类型：Type3。
| e_StdIDCourier = _fsdk.Font_e_StdIDCourier
| 标准字体：Courier。
| e_StdIDCourierB = _fsdk.Font_e_StdIDCourierB
| 标准字体：Courier-Bold。
| e_StdIDCourierBI = _fsdk.Font_e_StdIDCourierBI
| 标准字体：Courier-BoldOblique，粗斜体。
| e_StdIDCourierI = _fsdk.Font_e_StdIDCourierI
| 标准字体：Courier-Oblique，斜体。
| e_StdIDHelvetica = _fsdk.Font_e_StdIDHelvetica
| 标准字体：Helvetica。
| e_StdIDHelveticaB = _fsdk.Font_e_StdIDHelveticaB
| 标准字体：Helvetica-Bold。
| e_StdIDHelveticaBI = _fsdk.Font_e_StdIDHelveticaBI
| 标准字体：Helvetica-BoldOblique，粗斜体。
| e_StdIDHelveticaI = _fsdk.Font_e_StdIDHelveticaI
| 标准字体：Helvetica-Oblique，斜体。
| e_StdIDSymbol = _fsdk.Font_e_StdIDSymbol
| 标准字体：Symbol。
| e_StdIDTimes = _fsdk.Font_e_StdIDTimes
| 标准字体：Times-Roman。
| e_StdIDTimesB = _fsdk.Font_e_StdIDTimesB
| 标准字体：Times-Bold。
| e_StdIDTimesBI = _fsdk.Font_e_StdIDTimesBI
| 标准字体：Times-BoldItalic。
| e_StdIDTimesI = _fsdk.Font_e_StdIDTimesI
| 标准字体：Times-Italic。
| e_StdIDZapfDingbats = _fsdk.Font_e_StdIDZapfDingbats
| 标准字体：ZapfDingbats。
| e_StyleAllCap = _fsdk.Font_e_StyleAllCap
| 字体样式：全大写。
| e_StyleFixedPitch = _fsdk.Font_e_StyleFixedPitch
| 字体样式：等宽字体。
| e_StyleItalic = _fsdk.Font_e_StyleItalic
| 字体样式：斜体。
| e_StyleNonSymbolic = _fsdk.Font_e_StyleNonSymbolic
| 字体样式：非符号字体。
| e_StylesBold = _fsdk.Font_e_StylesBold
| 字体样式：强制粗体。
| e_StyleScript = _fsdk.Font_e_StyleScript
| 字体样式：手写字体。
| e_StyleSerif = _fsdk.Font_e_StyleSerif
| 字体样式：衬线字体。
| e_StylesSmallCap = _fsdk.Font_e_StylesSmallCap
| 字体样式：小型大写。
| e_StyleSymbolic = _fsdk.Font_e_StyleSymbolic
| 字体样式：符号字体。

## 详细描述

在PDF文档中，字体用于在PDF页面中绘制文本。
此类表示在Foxit PDF SDK中使用的字体。此类为用户提供不同的构造函数来构造 新的字体对象，通过指定参数、标准字体ID或从字体文件路径。 字体对象也可以直接从PDF文档中的其他对象（如自由文本注释、 文本图形对象等）中检索。 此类还提供一些函数来获取字体的一些基本信息。

## 构造及析构函数说明

## ◆ Font() [1/4]

def FoxitPDFSDKPython3.Font.Font | ( |  | font_id | ) |

通过标准字体ID的构造函数。

参数

  [in] | font_id | 要创建的字体的标准字体ID。请参考从 FoxitPDFSDKPython3.Font.e_StdIDCourier 开始的值，应该是这些值中的一个。

## ◆ Font() [2/4]

def FoxitPDFSDKPython3.Font.Font | ( |  | font_file_path,
|  |  | face_index,
|  |  | charset
| ) |  |

从字体文件的构造函数。

参数

  [in] | font_file_path | 现有字体文件的完整路径。
  [in] | face_index | 基于零的字体面索引。有效范围：从0到(face_count-1)。 请调用系统函数获取face_count。
  [in] | charset | 要创建的字体的字符集。请参考从 FoxitPDFSDKPython3.Font.e_CharsetANSI 开始的值，应该是这些值中的一个。

## ◆ Font() [3/4]

def FoxitPDFSDKPython3.Font.Font | ( |  | other | ) |

使用另一个字体对象的构造函数。

参数

  [in] | other | 另一个字体对象。

## ◆ Font() [4/4]

def FoxitPDFSDKPython3.Font.Font | ( |  | stream | ) |

通过使用 FoxitPDFSDKPython3.StreamCallback 从字体流的构造函数。

参数

  [in] | stream | 由用户实现的 FoxitPDFSDKPython3.StreamCallback 对象 用于读取字体文件内容。

## 成员函数说明

## ◆ AddUnicodes()

def FoxitPDFSDKPython3.Font.AddUnicodes | ( |  | document,
|  |  | unicode_array
| ) |  |

向当前嵌入字体添加Unicode字符。

此函数仅支持新嵌入的字体。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | unicode_array | 要嵌入的Unicode数组。

返回
  成功嵌入到字体中的结果Unicode数组。

## ◆ Embed()

def FoxitPDFSDKPython3.Font.Embed | ( |  | document,
|  |  | is_add_all_unicodes
| ) |  |

将当前字体嵌入到指定的PDF文档中。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | is_add_all_unicodes | 如果没有添加文档中的Unicode字符，是否将从0x0到0xFFFF的Unicode字符 添加到当前嵌入字体中。 true 表示嵌入从0x0到0xFFFF的Unicode字符， false 表示只嵌入一个Unicode字符。默认值：true。 用户可以通过 FoxitPDFSDKPython3.Font.AddUnicodes 添加Unicode字符。

返回
  嵌入的字体。

## ◆ GetAscent()

def FoxitPDFSDKPython3.Font.GetAscent | ( |  | ) |

获取上升值，以1/1000 em大小为单位（PDF单位）。

返回
  上升值，以1/1000 em大小为单位（PDF单位）。

## ◆ GetBaseFontName()

def FoxitPDFSDKPython3.Font.GetBaseFontName | ( |  | document | ) |

获取基础字体名称。

参数

  [in] | document | 有效的PDF文档对象。

返回
  基础字体名称。

## ◆ GetCharBBox()

def FoxitPDFSDKPython3.Font.GetCharBBox | ( |  | unicode,
|  |  | document
| ) |  |

获取PDF文档中由Unicode指定的字符的边界框。

参数

  [in] | unicode | 字符的Unicode值。
  [in] | document | 有效的PDF文档对象。

返回
  字符边界框。

## ◆ GetCharWidth()

def FoxitPDFSDKPython3.Font.GetCharWidth | ( |  | unicode,
|  |  | document
| ) |  |

获取PDF文档中由Unicode指定的字符的宽度（以1/1000 em大小为单位，作为PDF单位）。

参数

  [in] | unicode | 字符的Unicode值。
  [in] | document | 有效的PDF文档对象。

返回
  字符宽度，以1/1000 em大小为单位（PDF单位）。

## ◆ GetCIDCharset()

def FoxitPDFSDKPython3.Font.GetCIDCharset | ( |  | document | ) |

获取CID字体字符集。

适用于基于CID的字体。对于其他类型的字体，将抛出异常 FoxitPDFSDKPython3.e_ErrUnsupported 。

参数

  [in] | document | 有效的PDF文档对象。

返回
  字体字符集。请参考从 FoxitPDFSDKPython3.Font.e_CIDCharsetUnknown 开始的值， 这将是这些值中的一个。

## ◆ GetDescent()

def FoxitPDFSDKPython3.Font.GetDescent | ( |  | ) |

获取下降值，以1/1000 em大小为单位（PDF单位）。

返回
  下降值，以1/1000 em大小为单位（PDF单位）。

## ◆ GetEncoding()

def FoxitPDFSDKPython3.Font.GetEncoding | ( |  | document | ) |

获取当前字体编码。

参数

  [in] | document | 有效的PDF文档对象。

返回
  字体编码的值，请参考<PDF reference 1.7>第442页中的 "TABLE 5.15 Predefined CJK CMap names"。

## ◆ GetFamilyName()

def FoxitPDFSDKPython3.Font.GetFamilyName | ( |  | ) |

检索字体族名称。

返回
  字体族名称。

## ◆ GetFontType()

def FoxitPDFSDKPython3.Font.GetFontType | ( |  | document | ) |

获取字体类型。

参数

  [in] | document | 有效的PDF文档对象。

返回
  字体类型。请参考从 FoxitPDFSDKPython3.Font.e_FontTypeType1 开始的值， 这将是这些值中的一个。

## ◆ GetName()

def FoxitPDFSDKPython3.Font.GetName | ( |  | ) |

检索PostScript名称。

返回
  PostScript名称。

## ◆ GetStandard14Font()

def FoxitPDFSDKPython3.Font.GetStandard14Font | ( |  | document | ) |

获取标准字体ID。

适用于标准字体。对于其他类型的字体，将抛出异常 FoxitPDFSDKPython3.e_ErrUnsupported 。

参数

  [in] | document | 有效的PDF文档对象。

返回
  标准字体ID。请参考从 FoxitPDFSDKPython3.Font.e_StdIDCourier 开始的值，这将是这些值中的一个。

## ◆ GetStyles()

def FoxitPDFSDKPython3.Font.GetStyles | ( |  | document | ) |

获取字体样式。

参数

  [in] | document | 有效的PDF文档对象。

返回
  字体样式。请参考从 FoxitPDFSDKPython3.Font.e_StyleFixedPitch 开始的值， 这将是这些值中的一个或组合。

## ◆ IsBold()

def FoxitPDFSDKPython3.Font.IsBold | ( |  | ) |

判断当前字体是否为粗体。

返回
  true 表示当前字体为粗体，false 表示不是。

## ◆ IsCharSupported()

def FoxitPDFSDKPython3.Font.IsCharSupported | ( |  | unicode,
|  |  | document
| ) |  |

检查当前字体是否支持某字符。

参数

  [in] | unicode | 字符unicode码。
  [in] | document | 文档对象，如果字体没有内嵌到文档中，这个参数是空对象。

返回
  true 表示字符在字体中支持， false 则不是。

## ◆ IsEmbedded()

def FoxitPDFSDKPython3.Font.IsEmbedded | ( |  | document | ) |

判断当前字体是否嵌入在指定的PDF文档中。

参数

  [in] | document | 有效的PDF文档对象。

返回
  true 表示字体嵌入在指定的PDF文档中，false 表示不是。

## ◆ IsEmpty()

def FoxitPDFSDKPython3.Font.IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ IsItalic()

def FoxitPDFSDKPython3.Font.IsItalic | ( |  | ) |

判断当前字体对象是否为斜体。

返回
  true 表示当前字体为斜体，false 表示不是。

## ◆ IsStandardFont()

def FoxitPDFSDKPython3.Font.IsStandardFont | ( |  | document | ) |

检查当前字体是否为标准字体。

参数

  [in] | document | 有效的PDF文档对象。

返回
  true 表示当前字体是标准字体，false 表示不是。

## ◆ IsSupportEmbedded()

def FoxitPDFSDKPython3.Font.IsSupportEmbedded | ( |  | document | ) |

检查当前字体是否支持嵌入到指定的PDF文档中。

参数

  [in] | document | 有效的PDF文档对象。

返回
  true 表示当前字体支持嵌入到指定的PDF文档中， false 表示不支持。

## ◆ IsVertWriting()

def FoxitPDFSDKPython3.Font.IsVertWriting | ( |  | document | ) |

检查当前字体是否为垂直书写。

参数

  [in] | document | 有效的PDF文档对象。

返回
  true 表示当前字体是垂直书写， false 表示当前字体不是垂直书写。

## ◆ SetEncoding()

def FoxitPDFSDKPython3.Font.SetEncoding | ( |  | document,
|  |  | value
| ) |  |

设置当前字体编码。

参数

  [in] | document | 有效的PDF文档对象。
  [in] | value | 要设置的字体编码。有关编码值，请参考 <PDF reference 1.7>第442页中的"TABLE 5.15 Predefined CJK CMap names"。 此参数不应为空字符串。

返回
  true 表示成功，false 表示失败。