Foxit PDF SDK

Public 类型 | Public 成员函数 | Public 属性 | 所有成员列表
foxit::ofd::PageNumberParameter类 参考

继承自 Object .

## Public 类型
enum | PageNumberLocationType { e_PageNumberLocationTypeLeftTop = 0, e_PageNumberLocationTypeTopMiddle = 1, e_PageNumberLocationTypeRightTop = 2, e_PageNumberLocationTypeLeftBottom = 3, e_PageNumberLocationTypeBottomMiddle = 4, e_PageNumberLocationTypeRightBottom = 5 }
| OFD添加页码位置枚举类型。 更多...
enum | PageNumberMarginType { e_PageNumberMarginTypeSmall = 0, e_PageNumberMarginTypeNormal = 1, e_PageNumberMarginTypeLarge = 2 }
| OFD添加页码边距枚举类型。 更多...

## Public 成员函数
| PageNumberParameter ()
| 构造函数。
| PageNumberParameter (PageNumberLocationType location, const WString &font_name, float font_size, foxit::RGB text_color, int start_page, int end_page, bool is_first_page_cover, int first_page_number, bool is_folio, PageNumberMarginType margin, bool skip_blank_page)
| 带参数的构造函数。 更多...
| PageNumberParameter (const PageNumberParameter &other)
| 用另一个页码参数对象的构造函数。 更多...
PageNumberParameter & | operator= (const PageNumberParameter &other)
| 赋值操作符。 更多...
void | Set (PageNumberLocationType location, const WString &font_name, float font_size, foxit::RGB text_color, int start_page, int end_page, bool is_first_page_cover, int first_page_number, bool is_folio, PageNumberMarginType margin, bool skip_blank_page)
| 设置值。 更多...

## Public 属性
int | end_page
| 终止页面，有效范围：从1到(count)。count 由函数 OFDPagckage::GetDocumentCount 返回。
int | first_page_number
| 起始页码的数值，默认为1。
WString | font_name
| 页码文本字体名字。
float | font_size
| 页码文本字体大小。这应该是一个正值，默认为12。
bool | is_first_page_cover
| 首页是否为封面，true代表首页，false代表非首页。
bool | is_folio
| 是否为对开页面，true代表是对开页面，false代表不是。
PageNumberLocationType | location
| 页码位置类型。 更多...
PageNumberMarginType | margin
| 页码位置类型。 更多...
bool | skip_blank_page
| 是否跳过空白页。true代表跳过空白页，false代表不跳过空白页。
int | start_page
| 起始页面，有效范围：从1到(count)。count 由函数 OFDPagckage::GetDocumentCount 返回。
foxit::RGB | text_color
| 页码文本颜色。

## 详细描述

此类代表了页码参数信息。

## 成员枚举类型说明

## ◆ PageNumberLocationType

enum foxit::ofd::PageNumberParameter::PageNumberLocationType

OFD添加页码位置枚举类型。

该枚举值应单独使用。

枚举值
e_PageNumberLocationTypeLeftTop | 位置左上。
e_PageNumberLocationTypeTopMiddle | 位置上中。
e_PageNumberLocationTypeRightTop | 位置右上。
e_PageNumberLocationTypeLeftBottom | 位置左下。
e_PageNumberLocationTypeBottomMiddle | 位置下中。
e_PageNumberLocationTypeRightBottom | 位置右下。

## ◆ PageNumberMarginType

enum foxit::ofd::PageNumberParameter::PageNumberMarginType

OFD添加页码边距枚举类型。

该枚举值应单独使用。

枚举值
e_PageNumberMarginTypeSmall | 边距小。
e_PageNumberMarginTypeNormal | 边距正常。
e_PageNumberMarginTypeLarge | 边距大。

## 构造及析构函数说明

## ◆ PageNumberParameter() [1/2]

foxit::ofd::PageNumberParameter::PageNumberParameter | ( | PageNumberLocationType | location,
|  | const WString & | font_name,
|  | float | font_size,
|  | foxit::RGB | text_color,
|  | int | start_page,
|  | int | end_page,
|  | bool | is_first_page_cover,
|  | int | first_page_number,
|  | bool | is_folio,
|  | PageNumberMarginType | margin,
|  | bool | skip_blank_page
| ) |  |
| inline explicit

带参数的构造函数。

参数

  [in] | location | 页码位置类型。 请参考从 PageNumberLocationType::e_PageNumberLocationTypeLeftTop 开始的值， 这应该是这些值中的一个。默认为位置左上。
  [in] | font_name | 页码文本字体名字。默认为"宋体"。
  [in] | font_size | 页码文本字体大小。这应该是一个正值，默认为12。
  [in] | text_color | 页码文本颜色。默认为黑色。
  [in] | start_page | 起始页面索引，有效范围：从0到(count-1)。 count 由函数 OFDPagckage::GetDocumentCount 返回。 默认为0。
  [in] | end_page | 终止页面索引，有效范围：从0到(count-1)。 count 由函数 OFDPagckage::GetDocumentCount 返回。 默认为0。
  [in] | is_first_page_cover | 首页是否为封面，true代表首页，false代表非首页。默认为非首页。
  [in] | first_page_number | 起始页码的数值，默认为1。
  [in] | is_folio | 是否为对开页面，true代表是对开页面，false代表不是。默认为不是对开页面。
  [in] | margin | 页码边距类型。 请参考从 PageNumberMarginType::e_PageNumberMarginTypeSmall 开始的值， 这应该是这些值中的一个。默认为正常边距。
  [in] | skip_blank_page | 是否跳过空白页。true代表跳过空白页，false代表不跳过空白页。默认为不跳过空白页。

## ◆ PageNumberParameter() [2/2]

foxit::ofd::PageNumberParameter::PageNumberParameter | ( | const PageNumberParameter & | other | ) |
| inline

用另一个页码参数对象的构造函数。

参数

  [in] | other | 另一个页码参数对象。

## 成员函数说明

## ◆ operator=()

PageNumberParameter& foxit::ofd::PageNumberParameter::operator= | ( | const PageNumberParameter & | other | ) |
| inline

赋值操作符。

参数

  [in] | char_info | 另一个页码参数对象，其值将被赋给当前对象。

返回
  对当前对象自身的引用。

## ◆ Set()

void foxit::ofd::PageNumberParameter::Set | ( | PageNumberLocationType | location,
|  | const WString & | font_name,
|  | float | font_size,
|  | foxit::RGB | text_color,
|  | int | start_page,
|  | int | end_page,
|  | bool | is_first_page_cover,
|  | int | first_page_number,
|  | bool | is_folio,
|  | PageNumberMarginType | margin,
|  | bool | skip_blank_page
| ) |  |
| inline

设置值。

参数

  [in] | location | 页码位置类型。 请参考从 PageNumberLocationType::e_PageNumberLocationTypeLeftTop 开始的值， 这应该是这些值中的一个。
  [in] | font_name | 页码文本字体名字。
  [in] | font_size | 页码文本字体大小。这应该是一个正值，默认为12。
  [in] | text_color | 页码文本颜色。
  [in] | start_page | 起始页面，有效范围：从1到(count)。 count 由函数 OFDPagckage::GetDocumentCount 返回。
  [in] | end_page | 终止页面索引，有效范围：从1到(count)。 count 由函数 OFDPagckage::GetDocumentCount 返回。
  [in] | is_first_page_cover | 首页是否为封面，true代表首页，false代表非首页。
  [in] | first_page_number | 起始页码的数值，默认为1。
  [in] | is_folio | 是否为对开页面，true代表是对开页面，false代表不是。
  [in] | margin | 页码边距类型。 请参考从 PageNumberMarginType::e_PageNumberMarginTypeSmall 开始的值， 这应该是这些值中的一个。
  [in] | skip_blank_page | 是否跳过空白页。true代表跳过空白页，false代表不跳过空白页。

返回
  无。

## 类成员变量说明

## ◆ location

PageNumberLocationType foxit::ofd::PageNumberParameter::location

页码位置类型。

请参考从 PageNumberLocationType::e_PageNumberLocationTypeLeftTop 开始的值， 这应该是这些值中的一个。

## ◆ margin

PageNumberMarginType foxit::ofd::PageNumberParameter::margin

页码位置类型。

请参考从 PageNumberLocationType::e_PageNumberLocationTypeLeftTop 开始的值， 这应该是这些值中的一个。