构造函数 | |
| (void) | - addDate: |
| Add a format string for a specified date format type. 更多... | |
| (void) | - addPageNumber: |
| Add a format string for a specified page number format type. 更多... | |
| (void) | - addString: |
| Add a string. 更多... | |
| (void) | - clear |
| Clear strings (including format strings) which have been added to current content generator. 更多... | |
| (NSString *) | - generateContent |
| Generate a final string which can be used as header-footer content. 更多... | |
| (id) | - init |
| Constructor. | |
| (id) | - initWithOther: |
| Constructor, with another header-footer content generator object. 更多... | |
| (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.
函数文档
◆ addDate:()
| - (void) addDate: | (FSHeaderFooterContentGeneratorDateFormatType) | 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 FSHeaderFooterContentGeneratorDateFormatMSlashD and this should be one of these values.
- 返回
- None.
◆ addPageNumber:()
| - (void) addPageNumber: | (FSHeaderFooterContentGeneratorPageNumberFormat) | 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 FSHeaderFooterContentGeneratorPageNumberFormatDefault and this should be one of these values.
- 返回
- None.
◆ addString:()
| - (void) addString: | (NSString *) | new_string |
Add a string.
- 参数
-
[in] new_string A string.
- 返回
- None.
◆ clear()
| - (void) 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()
| - (NSString *) generateContent |
Generate a final string which can be used as header-footer content.
- 返回
- The final string which can be used as header-footer content.
◆ initWithOther:()
| - (id) initWithOther: | (FSHeaderFooterContentGenerator*) | other |
Constructor, with another header-footer content generator object.
- 参数
-
[in] other Another header-footer content generator object.
◆ isEmpty()
| - (BOOL) isEmpty |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- 返回
- YES means current object is empty, while NO means not.
