fsdk.HeaderFooterContentGenerator类 参考

Public 成员函数
def	AddDate (format_type)
	Add a format string for a specified date format type. 更多...
def	AddPageNumber (format_type)
	Add a format string for a specified page number format type. 更多...
def	AddString (new_string)
	Add a string. 更多...
def	Clear ()
	Clear strings (including format strings) which have been added to current content generator. 更多...
def	GenerateContent ()
	Generate a final string which can be used as header-footer content. 更多...
def	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.

成员函数说明

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.

参数

[in]

format_type

Date format type. Please refer to values starting from fsdk.HeaderFooterContentGeneratorE_DateFormatMSlashD and this should be one of these values.

返回

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.

参数

[in]

format_type

Page number format type. Please refer to values starting from fsdk.HeaderFooterContentGeneratorE_PageNumberFormatDefault and this should be one of these values.

返回

None.

AddString()

def fsdk.HeaderFooterContentGenerator.AddString

(

new_string

)

Add a string.

参数

[in]

new_string

A string.

返回

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.

返回

None.

GenerateContent()

def fsdk.HeaderFooterContentGenerator.GenerateContent

(

)

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

返回

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.

返回

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