Foxit PDF SDK
Public 类型 | Public 成员函数 | 所有成员列表
foxit.pdf.HeaderFooterContentGenerator类 参考
类 foxit.pdf.HeaderFooterContentGenerator 继承关系图:
foxit.common.Base

Public 类型

enum  DateFormatType {
  DateFormatType.e_DateFormatMSlashD = 0, DateFormatType.e_DateFormatMSlashDSlashYY = 1, DateFormatType.e_DateFormatMSlashDSlashYYYY = 2, DateFormatType.e_DateFormatMMSlashDDSlashYY = 3,
  DateFormatType.e_DateFormatMMSlashDDSlashYYYY = 4, DateFormatType.e_DateFormatDSlashMSlashYY = 5, DateFormatType.e_DateFormatDSlashMSlashYYYY = 6, DateFormatType.e_DateFormatDDSlashMMSlashYY = 7,
  DateFormatType.e_DateFormatDDSlashMMSlashYYYY = 8, DateFormatType.e_DateFormatMMSlashYY = 9, DateFormatType.e_DateFormatMMSlashYYYY = 10, DateFormatType.e_DateFormatMDotDDotYY = 11,
  DateFormatType.e_DateFormatMDotDDotYYYY = 12, DateFormatType.e_DateFormatMMDotDDDotYY = 13, DateFormatType.e_DateFormatMMDotDDDotYYYY = 14, DateFormatType.e_DateFormatMMDotYY = 15,
  DateFormatType.e_DateFormatDDotMDotYYYY = 16, DateFormatType.e_DateFormatDDDotMMDotYY = 17, DateFormatType.e_DateFormatDDDotMMDotYYYY = 18, DateFormatType.e_DateFormatYYHyphenMMHyphenDD = 19,
  DateFormatType.e_DateFormatYYYYHyphenMMHyphenDD = 20
}
 日期格式类型的枚举。 更多...
 
enum  PageNumberFormat {
  PageNumberFormat.e_PageNumberFormatDefault = 0, PageNumberFormat.e_PageNumberFormatNumberOfCount = 1, PageNumberFormat.e_PageNumberFormatNumberSlashCount = 2, PageNumberFormat.e_PageNumberFormatPageNumber = 3,
  PageNumberFormat.e_PageNumberFormatPageNumberOfCount = 4
}
 页码格式类型的枚举。 更多...
 

Public 成员函数

 HeaderFooterContentGenerator ()
 Constructor.
 
 HeaderFooterContentGenerator (HeaderFooterContentGenerator other)
 Constructor, with another header-footer content generator object. 更多...
 
void AddDate (HeaderFooterContentGenerator.DateFormatType format_type)
 Add a format string for a specified date format type. 更多...
 
void AddPageNumber (HeaderFooterContentGenerator.PageNumberFormat format_type)
 Add a format string for a specified page number format type. 更多...
 
void AddString (string new_string)
 Add a string. 更多...
 
void Clear ()
 Clear strings (including format strings) which have been added to current content generator. 更多...
 
string GenerateContent ()
 Generate a final string which can be used as header-footer content. 更多...
 
bool IsEmpty ()
 Check whether current object is empty or not. 更多...
 

详细描述

This class is the generator for header-footer content. It can help user to combine dates in specified format, page numbers in specified format and any customized text content to one string which can be used as header-footer content.

成员枚举类型说明

◆ DateFormatType

enum foxit.pdf.HeaderFooterContentGenerator.DateFormatType
strong

日期格式类型的枚举。

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

枚举值
e_DateFormatMSlashD 

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

e_DateFormatMSlashDSlashYY 

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

e_DateFormatMSlashDSlashYYYY 

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

e_DateFormatMMSlashDDSlashYY 

如果使用此项，"mm/dd/yy" 将被用作日期格式字符串。

e_DateFormatMMSlashDDSlashYYYY 

如果使用此项，"mm/dd/yyyy" 将被用作日期格式字符串。

e_DateFormatDSlashMSlashYY 

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

e_DateFormatDSlashMSlashYYYY 

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

e_DateFormatDDSlashMMSlashYY 

如果使用此项，"dd/mm/yy" 将被用作日期格式字符串。

e_DateFormatDDSlashMMSlashYYYY 

如果使用此项，"dd/mm/yyyy" 将被用作日期格式字符串。

e_DateFormatMMSlashYY 

如果使用此项，"mm/yy" 将被用作日期格式字符串。

e_DateFormatMMSlashYYYY 

如果使用此项，"mm/yyyy" 将被用作日期格式字符串。

e_DateFormatMDotDDotYY 

如果使用此项，"m.d.yy" 将被用作日期格式字符串。

e_DateFormatMDotDDotYYYY 

如果使用此项，"m.d.yyyy" 将被用作日期格式字符串。

e_DateFormatMMDotDDDotYY 

如果使用此项，"mm.dd.yy" 将被用作日期格式字符串。

e_DateFormatMMDotDDDotYYYY 

如果使用此项，"mm.dd.yyyy" 将被用作日期格式字符串。

e_DateFormatMMDotYY 

如果使用此项，"mm.yy" 将被用作日期格式字符串。

e_DateFormatDDotMDotYYYY 

如果使用此项，"d.m.yyyy" 将被用作日期格式字符串。

e_DateFormatDDDotMMDotYY 

如果使用此项，"dd.mm.yy" 将被用作日期格式字符串。

e_DateFormatDDDotMMDotYYYY 

如果使用此项，"dd.mm.yyyy" 将被用作日期格式字符串。

e_DateFormatYYHyphenMMHyphenDD 

如果使用此项，"yy-mm-dd" 将被用作日期格式字符串。

e_DateFormatYYYYHyphenMMHyphenDD 

如果使用此项，"yyyy-mm-dd" 将被用作日期格式字符串。

◆ PageNumberFormat

enum foxit.pdf.HeaderFooterContentGenerator.PageNumberFormat
strong

页码格式类型的枚举。

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

枚举值
e_PageNumberFormatDefault 

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

e_PageNumberFormatNumberOfCount 

如果使用此项，"1 of n" 将被用作页码格式字符串。

e_PageNumberFormatNumberSlashCount 

如果使用此项，"1/n" 将被用作页码格式字符串。

e_PageNumberFormatPageNumber 

如果使用此项，"Page 1" 将被用作页码格式字符串。

e_PageNumberFormatPageNumberOfCount 

如果使用此项，"Page 1 of n" 将被用作页码格式字符串。

构造及析构函数说明

◆ HeaderFooterContentGenerator()

foxit.pdf.HeaderFooterContentGenerator.HeaderFooterContentGenerator ( HeaderFooterContentGenerator  other)
inline

Constructor, with another header-footer content generator object.

参数
[in]otherAnother header-footer content generator object.

成员函数说明

◆ AddDate()

void foxit.pdf.HeaderFooterContentGenerator.AddDate ( HeaderFooterContentGenerator.DateFormatType  format_type)
inline

Add a format string for a specified date format type.

Header-footer content can contain format string for date. The date format string will be replaced by actual date time in specified format when the header-footer is used in PDF document.

参数
[in]format_typeDate format type. Please refer to values starting from foxit.pdf.HeaderFooterContentGenerator.DateFormatType.e_DateFormatMSlashD and this should be one of these values.
返回
None.

◆ AddPageNumber()

void foxit.pdf.HeaderFooterContentGenerator.AddPageNumber ( HeaderFooterContentGenerator.PageNumberFormat  format_type)
inline

Add a format string for a specified page number format type.

Header-footer content can contain format string for page number. The page number format string will be replaced by page number in specified format when the header-footer is used in PDF document.

参数
[in]format_typePage number format type. Please refer to values starting from foxit.pdf.HeaderFooterContentGenerator.PageNumberFormat.e_PageNumberFormatDefault and this should be one of these values.
返回
None.

◆ AddString()

void foxit.pdf.HeaderFooterContentGenerator.AddString ( string  new_string)
inline

Add a string.

参数
[in]new_stringA string.
返回
None.

◆ Clear()

void foxit.pdf.HeaderFooterContentGenerator.Clear ( )
inline

Clear strings (including format strings) which have been added to current content generator.

After this function is called, current content generator will be the same as a newly constructed object.

返回
None.

◆ GenerateContent()

string foxit.pdf.HeaderFooterContentGenerator.GenerateContent ( )
inline

Generate a final string which can be used as header-footer content.

返回
The final string which can be used as header-footer content.

◆ IsEmpty()

bool foxit.pdf.HeaderFooterContentGenerator.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

返回
true means current object is empty, while false means not.