Foxit PDF SDK
fsdk.Font类 参考

Public 成员函数

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)
 获取由Unicode指定的字符的边界框。 更多...
 
def GetCharBBox (unicode, document)
 获取PDF文档中由Unicode指定的字符的边界框。 更多...
 
def GetCharWidth (unicode)
 获取由Unicode指定的字符的宽度(以1/1000 em大小为单位(PDF单位))。 更多...
 
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)
 设置当前字体编码。 更多...
 

详细描述

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

成员函数说明

◆ AddUnicodes()

def fsdk.Font.AddUnicodes (   document,
  unicode_array 
)

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

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

参数
[in]document有效的PDF文档对象。
[in]unicode_array要嵌入的Unicode数组。
返回
成功嵌入到字体中的结果Unicode数组。

◆ Embed()

def fsdk.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。 用户可以通过 fsdk.Font.AddUnicodes 添加Unicode字符。
返回
嵌入的字体。

◆ GetAscent()

def fsdk.Font.GetAscent ( )

获取上升值,以1/1000 em大小为单位(PDF单位)。

返回
上升值,以1/1000 em大小为单位(PDF单位)。

◆ GetBaseFontName()

def fsdk.Font.GetBaseFontName (   document)

获取基础字体名称。

参数
[in]document有效的PDF文档对象。
返回
基础字体名称。

◆ GetCharBBox() [1/2]

def fsdk.Font.GetCharBBox (   unicode)

获取由Unicode指定的字符的边界框。

参数
[in]unicode字符的Unicode值。
返回
字符边界框。

◆ GetCharBBox() [2/2]

def fsdk.Font.GetCharBBox (   unicode,
  document 
)

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

参数
[in]unicode字符的Unicode值。
[in]document有效的PDF文档对象。
返回
字符边界框。

◆ GetCharWidth() [1/2]

def fsdk.Font.GetCharWidth (   unicode)

获取由Unicode指定的字符的宽度(以1/1000 em大小为单位(PDF单位))。

参数
[in]unicode字符的Unicode值。
返回
字符宽度,以1/1000 em大小为单位(PDF单位)。

◆ GetCharWidth() [2/2]

def fsdk.Font.GetCharWidth (   unicode,
  document 
)

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

参数
[in]unicode字符的Unicode值。
[in]document有效的PDF文档对象。
返回
字符宽度,以1/1000 em大小为单位(PDF单位)。

◆ GetCIDCharset()

def fsdk.Font.GetCIDCharset (   document)

获取CID字体字符集。

适用于基于CID的字体。对于其他类型的字体,将抛出异常 fsdk.E_ErrUnsupported

参数
[in]document有效的PDF文档对象。
返回
字体字符集。请参考从 fsdk.FontE_CIDCharsetUnknown 开始的值, 这将是这些值中的一个。

◆ GetDescent()

def fsdk.Font.GetDescent ( )

获取下降值,以1/1000 em大小为单位(PDF单位)。

返回
下降值,以1/1000 em大小为单位(PDF单位)。

◆ GetEncoding()

def fsdk.Font.GetEncoding (   document)

获取当前字体编码。

参数
[in]document有效的PDF文档对象。
返回
字体编码的值,请参考<PDF reference 1.7>第442页中的 "TABLE 5.15 Predefined CJK CMap names"。

◆ GetFamilyName()

def fsdk.Font.GetFamilyName ( )

检索字体族名称。

返回
字体族名称。

◆ GetFontType()

def fsdk.Font.GetFontType (   document)

获取字体类型。

参数
[in]document有效的PDF文档对象。
返回
字体类型。请参考从 fsdk.FontE_FontTypeType1 开始的值, 这将是这些值中的一个。

◆ GetName()

def fsdk.Font.GetName ( )

检索PostScript名称。

返回
PostScript名称。

◆ GetStandard14Font()

def fsdk.Font.GetStandard14Font (   document)

获取标准字体ID。

适用于标准字体。对于其他类型的字体,将抛出异常 fsdk.E_ErrUnsupported

参数
[in]document有效的PDF文档对象。
返回
标准字体ID。请参考从 fsdk.FontE_StdIDCourier 开始的值,这将是这些值中的一个。

◆ GetStyles()

def fsdk.Font.GetStyles (   document)

获取字体样式。

参数
[in]document有效的PDF文档对象。
返回
字体样式。请参考从 fsdk.FontE_StyleFixedPitch 开始的值, 这将是这些值中的一个或组合。

◆ IsBold()

def fsdk.Font.IsBold ( )

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

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

◆ IsCharSupported()

def fsdk.Font.IsCharSupported (   unicode,
  document 
)

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

参数
[in]unicode字符unicode码。
[in]document文档对象,如果字体没有内嵌到文档中,这个参数是空对象。
返回
true 表示字符在字体中支持, false 则不是。

◆ IsEmbedded()

def fsdk.Font.IsEmbedded (   document)

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

参数
[in]document有效的PDF文档对象。
返回
true 表示字体嵌入在指定的PDF文档中,false 表示不是。

◆ IsEmpty()

def fsdk.Font.IsEmpty ( )

检查当前对象是否为空。

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

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

◆ IsItalic()

def fsdk.Font.IsItalic ( )

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

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

◆ IsStandardFont()

def fsdk.Font.IsStandardFont (   document)

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

参数
[in]document有效的PDF文档对象。
返回
true 表示当前字体是标准字体,false 表示不是。

◆ IsSupportEmbedded()

def fsdk.Font.IsSupportEmbedded (   document)

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

参数
[in]document有效的PDF文档对象。
返回
true 表示当前字体支持嵌入到指定的PDF文档中, false 表示不支持。

◆ IsVertWriting()

def fsdk.Font.IsVertWriting (   document)

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

参数
[in]document有效的PDF文档对象。
返回
true 表示当前字体是垂直书写, false 表示当前字体不是垂直书写。

◆ SetEncoding()

def fsdk.Font.SetEncoding (   document,
  value 
)

设置当前字体编码。

参数
[in]document有效的PDF文档对象。
[in]value要设置的字体编码。有关编码值,请参考 <PDF reference 1.7>第442页中的"TABLE 5.15 Predefined CJK CMap names"。 此参数不应为空字符串。
返回
true 表示成功,false 表示失败。