Foxit PDF SDK

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

## Public 成员函数
| AddDate (format_type)
| 为指定的日期格式类型添加格式字符串。 更多...
| AddPageNumber (format_type)
| 为指定的页码格式类型添加格式字符串。 更多...
| AddString (new_string)
| 添加字符串。 更多...
| Clear ()
| 清除已添加到当前内容生成器的字符串（包括格式字符串）。 更多...
| constructor ()
| 构造函数。
| GenerateContent ()
| 生成可用作页眉页脚内容的最终字符串。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...

## 静态 Public 属性
static | e_DateFormatDDDotMMDotYY
| 如果使用此值，将使用"dd.mm.yy"作为日期格式字符串。
static | e_DateFormatDDDotMMDotYYYY
| 如果使用此值，将使用"dd.mm.yyyy"作为日期格式字符串。
static | e_DateFormatDDotMDotYYYY
| 如果使用此值，将使用"d.m.yyyy"作为日期格式字符串。
static | e_DateFormatDDSlashMMSlashYY
| 如果使用此值，将使用"dd/mm/yy"作为日期格式字符串。
static | e_DateFormatDDSlashMMSlashYYYY
| 如果使用此值，将使用"dd/mm/yyyy"作为日期格式字符串。
static | e_DateFormatDSlashMSlashYY
| 如果使用此值，将使用"d/m/yy"作为日期格式字符串。
static | e_DateFormatDSlashMSlashYYYY
| 如果使用此值，将使用"d/m/yyyy"作为日期格式字符串。
static | e_DateFormatMDotDDotYY
| 如果使用此值，将使用"m.d.yy"作为日期格式字符串。
static | e_DateFormatMDotDDotYYYY
| 如果使用此值，将使用"m.d.yyyy"作为日期格式字符串。
static | e_DateFormatMMDotDDDotYY
| 如果使用此值，将使用"mm.dd.yy"作为日期格式字符串。
static | e_DateFormatMMDotDDDotYYYY
| 如果使用此值，将使用"mm.dd.yyyy"作为日期格式字符串。
static | e_DateFormatMMDotYY
| 如果使用此值，将使用"mm.yy"作为日期格式字符串。
static | e_DateFormatMMSlashDDSlashYY
| 如果使用此值，将使用"mm/dd/yy"作为日期格式字符串。
static | e_DateFormatMMSlashDDSlashYYYY
| 如果使用此值，将使用"mm/dd/yyyy"作为日期格式字符串。
static | e_DateFormatMMSlashYY
| 如果使用此值，将使用"mm/yy"作为日期格式字符串。
static | e_DateFormatMMSlashYYYY
| 如果使用此值，将使用"mm/yyyy"作为日期格式字符串。
static | e_DateFormatMSlashD
| 日期格式类型的枚举。 更多...
static | e_DateFormatMSlashDSlashYY
| 如果使用此值，将使用"m/d/yy"作为日期格式字符串。
static | e_DateFormatMSlashDSlashYYYY
| 如果使用此值，将使用"m/d/yyyy"作为日期格式字符串。
static | e_DateFormatYYHyphenMMHyphenDD
| 如果使用此值，将使用"yy-mm-dd"作为日期格式字符串。
static | e_DateFormatYYYYHyphenMMHyphenDD
| 如果使用此值，将使用"yyyy-mm-dd"作为日期格式字符串。
static | e_PageNumberFormatDefault
| 页码格式类型的枚举。 更多...
static | e_PageNumberFormatNumberOfCount
| 如果使用此值，将使用"1 of n"作为页码格式字符串。
static | e_PageNumberFormatNumberSlashCount
| 如果使用此值，将使用"1/n"作为页码格式字符串。
static | e_PageNumberFormatPageNumber
| 如果使用此值，将使用"Page 1"作为页码格式字符串。
static | e_PageNumberFormatPageNumberOfCount
| 如果使用此值，将使用"Page 1 of n"作为页码格式字符串。

## 详细描述

此类是页眉页脚内容的生成器。它可以帮助用户将指定格式的日期、 指定格式的页码和任何自定义文本内容组合成一个字符串，该字符串可用作页眉页脚内容。

## 成员函数说明

## ◆ AddDate()

FSDK::HeaderFooterContentGenerator::AddDate | ( | format_type |  | ) |

为指定的日期格式类型添加格式字符串。

页眉页脚内容可以包含日期的格式字符串。 当页眉页脚在PDF文档中使用时，日期格式字符串将被替换为指定格式的实际日期时间。

参数

  [in] | format_type | 日期格式类型。请参考从 FSDK.HeaderFooterContentGenerator.e_DateFormatMSlashD 开始的值， 应为这些值之一。

返回
  无。

## ◆ AddPageNumber()

FSDK::HeaderFooterContentGenerator::AddPageNumber | ( | format_type |  | ) |

为指定的页码格式类型添加格式字符串。

页眉页脚内容可以包含页码的格式字符串。 当页眉页脚在PDF文档中使用时，页码格式字符串将被替换为指定格式的页码。

参数

  [in] | format_type | 页码格式类型。请参考从 FSDK.HeaderFooterContentGenerator.e_PageNumberFormatDefault 开始的值， 应为这些值之一。

返回
  无。

## ◆ AddString()

FSDK::HeaderFooterContentGenerator::AddString | ( | new_string |  | ) |

添加字符串。

参数

  [in] | new_string | 字符串。

返回
  无。

## ◆ Clear()

FSDK::HeaderFooterContentGenerator::Clear | ( |  | ) |

清除已添加到当前内容生成器的字符串（包括格式字符串）。

调用此函数后，当前内容生成器将与新构造的对象相同。

返回
  无。

## ◆ GenerateContent()

FSDK::HeaderFooterContentGenerator::GenerateContent | ( |  | ) |

生成可用作页眉页脚内容的最终字符串。

返回
  可用作页眉页脚内容的最终字符串。

## ◆ IsEmpty()

FSDK::HeaderFooterContentGenerator::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
  true 表示当前对象为空，而 false 表示不为空。

## 类成员变量说明

## ◆ e_DateFormatMSlashD

FSDK::HeaderFooterContentGenerator::e_DateFormatMSlashD
| static

日期格式类型的枚举。

此枚举的值可以单独使用。

如果使用此值，将使用"m/d"作为日期格式字符串。

## ◆ e_PageNumberFormatDefault

FSDK::HeaderFooterContentGenerator::e_PageNumberFormatDefault
| static

页码格式类型的枚举。

此枚举的值可以单独使用。

如果使用此值，将使用"1"作为页码格式字符串。