Foxit PDF SDK
fsdk.TextObject类 参考

Public 成员函数

def GetCharCount ()
 获取当前文本对象中的字符数量。 更多...
 
def GetCharHeightByIndex (index)
 获取当前文本对象中指定索引字符的高度。 更多...
 
def GetCharPos (index)
 获取当前文本对象中指定索引字符的位置。 更多...
 
def GetCharWidthByIndex (index)
 获取当前文本对象中指定索引字符的宽度。 更多...
 
def GetText ()
 获取文本字符串。 更多...
 
def GetTextState (page)
 获取文本状态信息。 更多...
 
def SetText (text)
 设置文本字符串。 更多...
 
def SetTextState (page, text_state, is_italic, weight)
 设置文本状态信息。 更多...
 

详细描述

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

参见
GraphicsObject

成员函数说明

◆ GetCharCount()

def fsdk.TextObject.GetCharCount ( )

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

返回
字符数量。

◆ GetCharHeightByIndex()

def fsdk.TextObject.GetCharHeightByIndex (   index)

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

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

◆ GetCharPos()

def fsdk.TextObject.GetCharPos (   index)

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

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

◆ GetCharWidthByIndex()

def fsdk.TextObject.GetCharWidthByIndex (   index)

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

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

◆ GetText()

def fsdk.TextObject.GetText ( )

获取文本字符串。

返回
文本字符串。

◆ GetTextState()

def fsdk.TextObject.GetTextState (   page)

获取文本状态信息。

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

◆ SetText()

def fsdk.TextObject.SetText (   text)

设置文本字符串。

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

◆ SetTextState()

def 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 函数。