Foxit PDF SDK

Public 成员函数 | Public 属性 | 所有成员列表
FSDK::HeaderFooter类 参考

## Public 成员函数
| constructor ()
| 构造函数。
| constructor (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)
| 带参数的构造函数。 更多...
| 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)
| 设置值。 更多...

## Public 属性
| content
| 页眉页脚内容。
| font
| 用于页眉页脚内容的有效字体对象。 更多...
| has_fixedsize_for_print
| 决定打印时是否使用固定大小的布尔值。
| has_text_shrinked
| 决定是否缩小文本的布尔值。
| is_replace_font
| （保留）决定是否替换字体的布尔值。目前Foxit PDF SDK始终将此值用作 true。
| is_to_embed_font
| 决定是否嵌入字体的布尔值。
| is_underline
| 决定是否为文本添加下划线的布尔值。
| page_margin
| 指定页眉页脚内容位置的页边距。 如果用户未设置边距值，Foxit PDF SDK将使用定义为(72.0, 36.0, 72.0, 36.0)的边距作为默认值。 更多...
| page_range
| 指定使用当前页眉页脚的页面的页码范围对象。 更多...
| start_page_number
| 用于参数 page_range 中指定的第一页的虚拟页码。 这可以是任何数字，甚至可以与指定页面的实际页码不同。 更多...
| text_color
| 用于页眉页脚内容的文本颜色。
| text_size
| 页眉页脚内容的文本大小。

## 详细描述

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

## 成员函数说明

## ◆ constructor()

FSDK::HeaderFooter::constructor | ( | 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 | 决定是否为文本添加下划线的布尔值。

## ◆ Set()

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 | 决定是否为文本添加下划线的布尔值。

返回
  无。

## 类成员变量说明

## ◆ font

FSDK::HeaderFooter::font

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

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

## ◆ page_margin

FSDK::HeaderFooter::page_margin

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

注解
  此值不代表矩形。它仅定义PDF页面的左边距、下边距、右边距和上边距。 这些边距可用于在不同位置定位页眉页脚内容：
  - 左边距用于指定左侧页眉或页脚内容的起始位置。
  - 右边距用于指定右侧页眉或页脚内容的结束位置。
  - 下边距用于指定任何页脚内容放置的顶部位置。 如果下边距不大于0，页脚内容将不可见。
  - 上边距用于指定任何页眉内容放置的底部位置。 如果上边距不大于0，页眉内容将不可见。

## ◆ page_range

FSDK::HeaderFooter::page_range

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

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

## ◆ start_page_number

FSDK::HeaderFooter::start_page_number

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

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