Foxit PDF SDK
|
Public Member Functions | |
HeaderFooterContentGenerator () | |
Constructor. | |
HeaderFooterContentGenerator (const HeaderFooterContentGenerator &other) | |
Constructor, with another header-footer content generator object. More... | |
~HeaderFooterContentGenerator () | |
Destructor. | |
void | AddDate (DateFormatType format_type) |
Add a format string for a specified date format type. More... | |
void | AddPageNumber (PageNumberFormat format_type) |
Add a format string for a specified page number format type. More... | |
void | AddString (const WString &new_string) |
Add a string. More... | |
void | Clear () |
Clear strings (including format strings) which have been added to current content generator. More... | |
WString | GenerateContent () |
Generate a final string which can be used as header-footer content. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | operator!= (const HeaderFooterContentGenerator &other) const |
Not equal operator. More... | |
HeaderFooterContentGenerator & | operator= (const HeaderFooterContentGenerator &other) |
Assign operator. More... | |
bool | operator== (const HeaderFooterContentGenerator &other) const |
Equal operator. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
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.
Enumeration for date format type.
Values of this enumeration can be used alone.
Enumeration for page number format type.
Values of this enumeration can be used alone.
foxit::pdf::HeaderFooterContentGenerator::HeaderFooterContentGenerator | ( | const HeaderFooterContentGenerator & | other | ) |
Constructor, with another header-footer content generator object.
[in] | other | Another header-footer content generator object. |
void foxit::pdf::HeaderFooterContentGenerator::AddDate | ( | DateFormatType | format_type | ) |
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_type | Date format type. Please refer to values starting from HeaderFooterContentGenerator::e_DateFormatMSlashD and this should be one of these values. |
void foxit::pdf::HeaderFooterContentGenerator::AddPageNumber | ( | PageNumberFormat | format_type | ) |
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_type | Page number format type. Please refer to values starting from HeaderFooterContentGenerator::e_PageNumberFormatDefault and this should be one of these values. |
void foxit::pdf::HeaderFooterContentGenerator::AddString | ( | const WString & | new_string | ) |
Add a string.
[in] | new_string | A string. |
void foxit::pdf::HeaderFooterContentGenerator::Clear | ( | ) |
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.
WString foxit::pdf::HeaderFooterContentGenerator::GenerateContent | ( | ) |
Generate a final string which can be used as header-footer content.
bool foxit::pdf::HeaderFooterContentGenerator::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::pdf::HeaderFooterContentGenerator::operator!= | ( | const HeaderFooterContentGenerator & | other | ) | const |
Not equal operator.
[in] | other | Another header-footer content generator object. This function will check if current object is not equal to this one. |
HeaderFooterContentGenerator& foxit::pdf::HeaderFooterContentGenerator::operator= | ( | const HeaderFooterContentGenerator & | other | ) |
Assign operator.
[in] | other | Another header-footer content generator object, whose value would be assigned to current object. |
bool foxit::pdf::HeaderFooterContentGenerator::operator== | ( | const HeaderFooterContentGenerator & | other | ) | const |
Equal operator.
[in] | other | Another header-footer content generator object. This function will check if current object is equal to this one. |