Foxit PDF SDK
fsdk.HeaderFooterContentGenerator Class Reference

Public Member Functions

def AddDate (format_type)
 Add a format string for a specified date format type.
More...
 
def AddPageNumber (format_type)
 Add a format string for a specified page number format type.
More...
 
def AddString (new_string)
 Add a string.
More...
 
def Clear ()
 Clear strings (including format strings) which have been added to current content generator.
More...
 
def GenerateContent ()
 Generate a final string which can be used as header-footer content.
More...
 
def IsEmpty ()
 Check whether current object is empty or not.
More...
 

Detailed Description

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.

Member Function Documentation

◆ AddDate()

def fsdk.HeaderFooterContentGenerator.AddDate (   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.

Parameters
[in]format_typeDate format type. Please refer to values starting from fsdk.HeaderFooterContentGeneratorE_DateFormatMSlashD and this should be one of these values.
Returns
None.

◆ AddPageNumber()

def fsdk.HeaderFooterContentGenerator.AddPageNumber (   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.

Parameters
[in]format_typePage number format type. Please refer to values starting from fsdk.HeaderFooterContentGeneratorE_PageNumberFormatDefault and this should be one of these values.
Returns
None.

◆ AddString()

def fsdk.HeaderFooterContentGenerator.AddString (   new_string)

Add a string.

Parameters
[in]new_stringA string.
Returns
None.

◆ Clear()

def fsdk.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.

Returns
None.

◆ GenerateContent()

def fsdk.HeaderFooterContentGenerator.GenerateContent ( )

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

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

◆ IsEmpty()

def fsdk.HeaderFooterContentGenerator.IsEmpty ( )

Check whether current object is empty or not.

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

Returns
true means current object is empty, while false means not.