Public 成员函数
def	GetContent ()
	Get 页眉页脚内容。更多...

def	GetFont ()
	Get 期望用于页眉页脚内容的有效字体对象。更多...

def	GetHas_fixedsize_for_print ()
	Get 决定是否为打印使用固定大小的布尔值。更多...

def	GetHas_text_shrinked ()
	Get 决定是否缩小文本的布尔值。更多...

def	GetIs_replace_font ()
	Get （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。更多...

def	GetIs_to_embed_font ()
	Get 决定是否嵌入字体的布尔值。更多...

def	GetIs_underline ()
	Get 决定是否给文本加下划线的布尔值。更多...

def	GetPage_margin ()
	Get 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72. 更多...

def	GetPage_range ()
	Get 指定当前页眉页脚使用页面的页码范围对象。更多...

def	GetStart_page_number ()
	Get 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。更多...

def	GetText_color ()
	Get 用于页眉页脚内容的文本颜色。更多...

def	GetText_size ()
	Get 页眉页脚内容的文本大小。更多...

def	Set (font, text_size, text_color, page_range, page_margin, has_text_shrinked, has_fixedsize_for_print, start_page_number, content, is_to_embed_font, is_underline)
	设置值。更多...

def	SetContent (value)
	Set 页眉页脚内容。更多...

def	SetFont (value)
	Set 期望用于页眉页脚内容的有效字体对象。更多...

def	SetHas_fixedsize_for_print (value)
	Set 决定是否为打印使用固定大小的布尔值。更多...

def	SetHas_text_shrinked (value)
	Set 决定是否缩小文本的布尔值。更多...

def	SetIs_replace_font (value)
	Set （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。更多...

def	SetIs_to_embed_font (value)
	Set 决定是否嵌入字体的布尔值。更多...

def	SetIs_underline (value)
	Set 决定是否给文本加下划线的布尔值。更多...

def	SetPage_margin (value)
	Set 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72. 更多...

def	SetPage_range (value)
	Set 指定当前页眉页脚使用页面的页码范围对象。更多...

def	SetStart_page_number (value)
	Set 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。更多...

def	SetText_color (value)
	Set 用于页眉页脚内容的文本颜色。更多...

def	SetText_size (value)
	Set 页眉页脚内容的文本大小。更多...

详细描述

This class represents properties and data for a header-footer.

成员函数说明

◆ GetContent()

fsdk.HeaderFooter.GetContent ( )

Get 页眉页脚内容。

返回: 页眉页脚内容。

◆ GetFont()

fsdk.HeaderFooter.GetFont ( )

Get 期望用于页眉页脚内容的有效字体对象。

注解: 有时，Foxit PDF SDK 无法将提取的字体与此字体对象匹配。在这种情况下，Foxit PDF SDK 将为页眉页脚内容匹配一个类似的字体（与此字体对象不完全相同）。

返回: 期望用于页眉页脚内容的有效字体对象。

◆ GetHas_fixedsize_for_print()

fsdk.HeaderFooter.GetHas_fixedsize_for_print ( )

Get 决定是否为打印使用固定大小的布尔值。

返回: 决定是否为打印使用固定大小的布尔值。

◆ GetHas_text_shrinked()

fsdk.HeaderFooter.GetHas_text_shrinked ( )

Get 决定是否缩小文本的布尔值。

返回: 决定是否缩小文本的布尔值。

◆ GetIs_replace_font()

fsdk.HeaderFooter.GetIs_replace_font ( )

Get （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。

返回: （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。

◆ GetIs_to_embed_font()

fsdk.HeaderFooter.GetIs_to_embed_font ( )

Get 决定是否嵌入字体的布尔值。

返回: 决定是否嵌入字体的布尔值。

◆ GetIs_underline()

fsdk.HeaderFooter.GetIs_underline ( )

Get 决定是否给文本加下划线的布尔值。

返回: 决定是否给文本加下划线的布尔值。

◆ GetPage_margin()

fsdk.HeaderFooter.GetPage_margin ( )

Get 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72.

注解

此值不表示矩形。它只是定义 PDF 页面的左边距、下边距、右边距和上边距。这些边距可用于将页眉页脚内容定位在不同的位置：

左边距用于指定左页眉或页脚内容开始的位置。
右边距用于指定右页眉或页脚内容结束的位置。
下边距用于指定任何页脚内容放置的顶部位置。如果下边距不大于 0，页脚内容将不可见。
上边距用于指定任何页眉内容放置的底部位置。如果上边距不大于 0，页眉内容将不可见。

返回: 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72.0, 36.0, 72.0, 36.0) 的边距作为默认值。

◆ GetPage_range()

fsdk.HeaderFooter.GetPage_range ( )

Get 指定当前页眉页脚使用页面的页码范围对象。

此范围中表示的所有值应从 1 开始且不超过使用当前页眉页脚对象的 PDF 文档的页数。

返回: 指定当前页眉页脚使用页面的页码范围对象。

◆ GetStart_page_number()

fsdk.HeaderFooter.GetStart_page_number ( )

Get 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。

注解: 如果此值小于 1，当当前页眉页脚对象在 PDF 文档中使用时，Foxit PDF SDK 将对此值使用 1。

返回: 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。

◆ GetText_color()

fsdk.HeaderFooter.GetText_color ( )

Get 用于页眉页脚内容的文本颜色。

返回: 用于页眉页脚内容的文本颜色。

◆ GetText_size()

fsdk.HeaderFooter.GetText_size ( )

Get 页眉页脚内容的文本大小。

返回: 页眉页脚内容的文本大小。

◆ Set()

def fsdk.HeaderFooter.Set	(	font,
		text_size,
		text_color,
		page_range,
		page_margin,
		has_text_shrinked,
		has_fixedsize_for_print,
		start_page_number,
		content,
		is_to_embed_font,
		is_underline
	)

设置值。

参数

[in]	font	期望用于页眉页脚内容的有效字体对象。请参阅当前对象的 font 注释。
[in]	text_size	页眉页脚内容的文本大小。
[in]	text_color	用于页眉页脚内容的文本颜色。
[in]	page_range	指定当前页眉页脚使用页面的页码范围对象。请参阅当前对象的 page_range 注释。
[in]	page_margin	指定页眉页脚内容位置的页边距。请参阅当前对象的 page_margin 注释。
[in]	has_text_shrinked	决定是否缩小文本的布尔值。
[in]	has_fixedsize_for_print	决定是否为打印使用固定大小的布尔值。
[in]	start_page_number	用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。如果此值小于 1，当当前页眉页脚对象在 PDF 文档中使用时，Foxit PDF SDK 将对此值使用 1。
[in]	content	页眉页脚内容。
[in]	is_to_embed_font	决定是否嵌入字体的布尔值。
[in]	is_underline	决定是否给文本加下划线的布尔值。

返回: 无。

◆ SetContent()

fsdk.HeaderFooter.SetContent ( value )

Set 页眉页脚内容。

参数

[in] value 页眉页脚内容。

返回: None.

◆ SetFont()

fsdk.HeaderFooter.SetFont ( value )

Set 期望用于页眉页脚内容的有效字体对象。

注解: 有时，Foxit PDF SDK 无法将提取的字体与此字体对象匹配。在这种情况下，Foxit PDF SDK 将为页眉页脚内容匹配一个类似的字体（与此字体对象不完全相同）。

参数

[in] value 期望用于页眉页脚内容的有效字体对象。

返回: None.

◆ SetHas_fixedsize_for_print()

fsdk.HeaderFooter.SetHas_fixedsize_for_print ( value )

Set 决定是否为打印使用固定大小的布尔值。

参数

[in] value 决定是否为打印使用固定大小的布尔值。

返回: None.

◆ SetHas_text_shrinked()

fsdk.HeaderFooter.SetHas_text_shrinked ( value )

Set 决定是否缩小文本的布尔值。

参数

[in] value 决定是否缩小文本的布尔值。

返回: None.

◆ SetIs_replace_font()

fsdk.HeaderFooter.SetIs_replace_font ( value )

Set （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。

参数

[in] value （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。

返回: None.

◆ SetIs_to_embed_font()

fsdk.HeaderFooter.SetIs_to_embed_font ( value )

Set 决定是否嵌入字体的布尔值。

参数

[in] value 决定是否嵌入字体的布尔值。

返回: None.

◆ SetIs_underline()

fsdk.HeaderFooter.SetIs_underline ( value )

Set 决定是否给文本加下划线的布尔值。

参数

[in] value 决定是否给文本加下划线的布尔值。

返回: None.

◆ SetPage_margin()

fsdk.HeaderFooter.SetPage_margin ( value )

Set 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72.

注解

此值不表示矩形。它只是定义 PDF 页面的左边距、下边距、右边距和上边距。这些边距可用于将页眉页脚内容定位在不同的位置：

左边距用于指定左页眉或页脚内容开始的位置。
右边距用于指定右页眉或页脚内容结束的位置。
下边距用于指定任何页脚内容放置的顶部位置。如果下边距不大于 0，页脚内容将不可见。
上边距用于指定任何页眉内容放置的底部位置。如果上边距不大于 0，页眉内容将不可见。

参数

[in] value 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72.0, 36.0, 72.0, 36.0) 的边距作为默认值。

返回: None.

◆ SetPage_range()

fsdk.HeaderFooter.SetPage_range ( value )

Set 指定当前页眉页脚使用页面的页码范围对象。

此范围中表示的所有值应从 1 开始且不超过使用当前页眉页脚对象的 PDF 文档的页数。

参数

[in] value 指定当前页眉页脚使用页面的页码范围对象。

返回: None.

◆ SetStart_page_number()

fsdk.HeaderFooter.SetStart_page_number ( value )

Set 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。

注解: 如果此值小于 1，当当前页眉页脚对象在 PDF 文档中使用时，Foxit PDF SDK 将对此值使用 1。

参数

[in] value 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。

返回: None.

◆ SetText_color()

fsdk.HeaderFooter.SetText_color ( value )

Set 用于页眉页脚内容的文本颜色。

参数

[in] value 用于页眉页脚内容的文本颜色。

返回: None.

◆ SetText_size()

fsdk.HeaderFooter.SetText_size ( value )

Set 页眉页脚内容的文本大小。

参数

[in] value 页眉页脚内容的文本大小。

返回: None.

Public 成员函数

详细描述

成员函数说明

◆ GetContent()

◆ GetFont()

◆ GetHas_fixedsize_for_print()

◆ GetHas_text_shrinked()

◆ GetIs_replace_font()

◆ GetIs_to_embed_font()

◆ GetIs_underline()

◆ GetPage_margin()

◆ GetPage_range()

◆ GetStart_page_number()

◆ GetText_color()

◆ GetText_size()

◆ Set()

◆ SetContent()

◆ SetFont()

◆ SetHas_fixedsize_for_print()

◆ SetHas_text_shrinked()

◆ SetIs_replace_font()

◆ SetIs_to_embed_font()

◆ SetIs_underline()

◆ SetPage_margin()

◆ SetPage_range()

◆ SetStart_page_number()

◆ SetText_color()

◆ SetText_size()