Foxit PDF SDK
fsdk.RichTextStyle类 参考

Public 成员函数

def GetChar_space ()
 Get 字符间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。 更多...
 
def GetFont ()
 Get 富文本样式中使用的字体。应该是有效的字体对象。 更多...
 
def GetIs_bold ()
 Get 指示是否将文本设为粗体的布尔值。 更多...
 
def GetIs_italic ()
 Get 指示是否将文本设为斜体的布尔值。 更多...
 
def GetIs_strikethrough ()
 Get 指示是否为文本添加删除线的布尔值。 更多...
 
def GetIs_underline ()
 Get 指示是否为文本添加下划线的布尔值。 更多...
 
def GetMark_style ()
 Get 角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从fsdk.RichTextStyleE_CornerMarkNone 开始的值,这应该是这些值中的一个。 更多...
 
def GetText_alignment ()
 Get 对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这应该是这些值中的一个。 更多...
 
def GetText_color ()
 Get 文本颜色。格式:0xRRGGBB。 更多...
 
def GetText_size ()
 Get 文本大小。不应为负值。0表示文本不会显示。 更多...
 
def GetWord_space ()
 Get 单词间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。 更多...
 
def Set (font, text_size, text_alignment, text_color, is_bold, is_italic, is_underline, is_strikethrough, mark_style, char_space, word_space)
 设置值。 更多...
 
def SetChar_space (value)
 Set 字符间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。 更多...
 
def SetFont (value)
 Set 富文本样式中使用的字体。应该是有效的字体对象。 更多...
 
def SetIs_bold (value)
 Set 指示是否将文本设为粗体的布尔值。 更多...
 
def SetIs_italic (value)
 Set 指示是否将文本设为斜体的布尔值。 更多...
 
def SetIs_strikethrough (value)
 Set 指示是否为文本添加删除线的布尔值。 更多...
 
def SetIs_underline (value)
 Set 指示是否为文本添加下划线的布尔值。 更多...
 
def SetMark_style (value)
 Set 角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从fsdk.RichTextStyleE_CornerMarkNone 开始的值,这应该是这些值中的一个。 更多...
 
def SetText_alignment (value)
 Set 对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这应该是这些值中的一个。 更多...
 
def SetText_color (value)
 Set 文本颜色。格式:0xRRGGBB。 更多...
 
def SetText_size (value)
 Set 文本大小。不应为负值。0表示文本不会显示。 更多...
 
def SetWord_space (value)
 Set 单词间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。 更多...
 

详细描述

此类表示富文本样式数据,用于指定富文本的样式。

成员函数说明

◆ GetChar_space()

fsdk.RichTextStyle.GetChar_space ( )

Get 字符间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。

返回
字符间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。

◆ GetFont()

fsdk.RichTextStyle.GetFont ( )

Get 富文本样式中使用的字体。应该是有效的字体对象。

  • 当当前样式用于设置富文本或添加/插入新富文本时,此字体表示"用户期望为富文本使用此字体"。 然后在重置外观过程中,Foxit PDF SDK将检查期望的字体是否合适,并决定使用它或 更改为更合适的字体以显示文本内容。

  • 当从富文本中检索当前样式时,此字体表示富文本的已使用字体。

返回
富文本样式中使用的字体。应该是有效的字体对象。

◆ GetIs_bold()

fsdk.RichTextStyle.GetIs_bold ( )

Get 指示是否将文本设为粗体的布尔值。

返回
指示是否将文本设为粗体的布尔值。

◆ GetIs_italic()

fsdk.RichTextStyle.GetIs_italic ( )

Get 指示是否将文本设为斜体的布尔值。

返回
指示是否将文本设为斜体的布尔值。

◆ GetIs_strikethrough()

fsdk.RichTextStyle.GetIs_strikethrough ( )

Get 指示是否为文本添加删除线的布尔值。

返回
指示是否为文本添加删除线的布尔值。

◆ GetIs_underline()

fsdk.RichTextStyle.GetIs_underline ( )

Get 指示是否为文本添加下划线的布尔值。

返回
指示是否为文本添加下划线的布尔值。

◆ GetMark_style()

fsdk.RichTextStyle.GetMark_style ( )

Get 角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从fsdk.RichTextStyleE_CornerMarkNone 开始的值,这应该是这些值中的一个。

返回
角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从fsdk.RichTextStyleE_CornerMarkNone 开始的值,这应该是这些值中的一个。

◆ GetText_alignment()

fsdk.RichTextStyle.GetText_alignment ( )

Get 对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这应该是这些值中的一个。

返回
对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这应该是这些值中的一个。

◆ GetText_color()

fsdk.RichTextStyle.GetText_color ( )

Get 文本颜色。格式:0xRRGGBB。

返回
文本颜色。格式:0xRRGGBB。

◆ GetText_size()

fsdk.RichTextStyle.GetText_size ( )

Get 文本大小。不应为负值。0表示文本不会显示。

返回
文本大小。不应为负值。0表示文本不会显示。

◆ GetWord_space()

fsdk.RichTextStyle.GetWord_space ( )

Get 单词间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。

返回
单词间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。

◆ Set()

def fsdk.RichTextStyle.Set (   font,
  text_size,
  text_alignment,
  text_color,
  is_bold,
  is_italic,
  is_underline,
  is_strikethrough,
  mark_style,
  char_space,
  word_space 
)

设置值。

参数
[in]font有效的字体对象。
[in]text_size文本大小。不应为负值。0表示文本不会显示。
[in]text_alignment对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这应该是这些值中的一个。
[in]text_color文本颜色。格式:0xRRGGBB。
[in]is_bold指示是否将文本设为粗体的布尔值。
[in]is_italic指示是否将文本设为斜体的布尔值。
[in]is_underline指示是否为文本添加下划线的布尔值。
[in]is_strikethrough指示是否为文本添加删除线的布尔值。
[in]mark_style角标样式,可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从fsdk.RichTextStyleE_CornerMarkNone 开始的值, 这应该是这些值中的一个。
[in]char_space字符间距。对于表格生成器,不应为负值。仅在fsdk.PDFPage.AddText 中使用。
[in]word_space单词间距。对于表格生成器,不应为负值。仅在fsdk.PDFPage.AddText 中使用。
返回
无。

◆ SetChar_space()

fsdk.RichTextStyle.SetChar_space (   value)

Set 字符间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。

参数
[in]value字符间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。
返回
None.

◆ SetFont()

fsdk.RichTextStyle.SetFont (   value)

Set 富文本样式中使用的字体。应该是有效的字体对象。

  • 当当前样式用于设置富文本或添加/插入新富文本时,此字体表示"用户期望为富文本使用此字体"。 然后在重置外观过程中,Foxit PDF SDK将检查期望的字体是否合适,并决定使用它或 更改为更合适的字体以显示文本内容。

  • 当从富文本中检索当前样式时,此字体表示富文本的已使用字体。

参数
[in]value富文本样式中使用的字体。应该是有效的字体对象。
返回
None.

◆ SetIs_bold()

fsdk.RichTextStyle.SetIs_bold (   value)

Set 指示是否将文本设为粗体的布尔值。

参数
[in]value指示是否将文本设为粗体的布尔值。
返回
None.

◆ SetIs_italic()

fsdk.RichTextStyle.SetIs_italic (   value)

Set 指示是否将文本设为斜体的布尔值。

参数
[in]value指示是否将文本设为斜体的布尔值。
返回
None.

◆ SetIs_strikethrough()

fsdk.RichTextStyle.SetIs_strikethrough (   value)

Set 指示是否为文本添加删除线的布尔值。

参数
[in]value指示是否为文本添加删除线的布尔值。
返回
None.

◆ SetIs_underline()

fsdk.RichTextStyle.SetIs_underline (   value)

Set 指示是否为文本添加下划线的布尔值。

参数
[in]value指示是否为文本添加下划线的布尔值。
返回
None.

◆ SetMark_style()

fsdk.RichTextStyle.SetMark_style (   value)

Set 角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从fsdk.RichTextStyleE_CornerMarkNone 开始的值,这应该是这些值中的一个。

参数
[in]value角标样式。角标样式可用于将文本设为上标或下标或不作为任何类型的角标。 请参考从fsdk.RichTextStyleE_CornerMarkNone 开始的值,这应该是这些值中的一个。
返回
None.

◆ SetText_alignment()

fsdk.RichTextStyle.SetText_alignment (   value)

Set 对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这应该是这些值中的一个。

参数
[in]value对齐值。请参考从fsdk.E_AlignmentLeft 开始的值, 这应该是这些值中的一个。
返回
None.

◆ SetText_color()

fsdk.RichTextStyle.SetText_color (   value)

Set 文本颜色。格式:0xRRGGBB。

参数
[in]value文本颜色。格式:0xRRGGBB。
返回
None.

◆ SetText_size()

fsdk.RichTextStyle.SetText_size (   value)

Set 文本大小。不应为负值。0表示文本不会显示。

参数
[in]value文本大小。不应为负值。0表示文本不会显示。
返回
None.

◆ SetWord_space()

fsdk.RichTextStyle.SetWord_space (   value)

Set 单词间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。

参数
[in]value单词间距。对于表格生成器不应为负值。仅在fsdk.PDFPage.AddText 中使用。
返回
None.