Foxit PDF SDK
foxit.pdf.HeaderFooter Class Reference

Inherits SystemIDisposable.

Public Member Functions

 HeaderFooter (Font font, float text_size, int text_color, PageNumberRange page_range, RectF page_margin, bool has_text_shrinked, bool has_fixedsize_for_print, int start_page_number, HeaderFooterContent content, bool is_to_embed_font, bool is_underline)
 Constructor, with parameters.
More...
 
 HeaderFooter ()
 Constructor.

 
 HeaderFooter (HeaderFooter other)
 Constructor, with another header-footer object.
More...
 
void Set (Font font, float text_size, int text_color, PageNumberRange page_range, RectF page_margin, bool has_text_shrinked, bool has_fixedsize_for_print, int start_page_number, HeaderFooterContent content, bool is_to_embed_font, bool is_underline)
 Set value.
More...
 

Properties

HeaderFooterContentcontent [get, set]
 Header-footer content.

 
Fontfont [get, set]
 A valid font object which is expected to be used for header-footer content.
More...
 
bool has_fixedsize_for_print [get, set]
 A boolean value that decides whether to use fixed size for print or not.

 
bool has_text_shrinked [get, set]
 A boolean value that decides whether to shrink text or not.

 
bool is_replace_font [get, set]
 (Reserved) A boolean value that decides whether to replace font or not. Currently Foxit PDF SDK will use this as true all the time.

 
bool is_to_embed_font [get, set]
 A boolean value that decides whether to embed font or not.

 
bool is_underline [get, set]
 A boolean value that decides whether to underline text or not.

 
RectFpage_margin [get, set]
 Page margin which specifies the location for header-footer content. Foxit PDF SDK will use a maring defined as (72.0, 36.0, 72.0, 36.0) as default if no margin value is set by user.
More...
 
PageNumberRangepage_range [get, set]
 A page number range object which specifies pages where current header-footer is used.
More...
 
int start_page_number [get, set]
 A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page.
More...
 
int text_color [get, set]
 Text color used for header-footer content.

 
float text_size [get, set]
 Text size of header-footer content.

 

Detailed Description

This class represents properties and data for a header-footer.

Constructor & Destructor Documentation

◆ HeaderFooter() [1/2]

foxit.pdf.HeaderFooter.HeaderFooter ( Font  font,
float  text_size,
int  text_color,
PageNumberRange  page_range,
RectF  page_margin,
bool  has_text_shrinked,
bool  has_fixedsize_for_print,
int  start_page_number,
HeaderFooterContent  content,
bool  is_to_embed_font,
bool  is_underline 
)
inline

Constructor, with parameters.

Parameters
[in]fontA valid font object used for header-footer content. Please refer to comment of font of current object.
[in]text_sizeText size of header-footer content.
[in]text_colorText color used for header-footer content.
[in]page_rangeA page number range object which specifies pages where current header-footer is used. Please refer to comment of page_range of current object.
[in]page_marginPage margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object.
[in]has_text_shrinkedA boolean value that decides whether to shrink text or not.
[in]has_fixedsize_for_printA boolean value that decides whether to use fixed size for print or not.
[in]start_page_numberA virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. If this value is less than 1, Foxit PDF SDK will use 1 for this value when current header-footer object is used in a PDF document.
[in]contentHeader-footer content.
[in]is_to_embed_fontA boolean value that decides whether to embed font or not.
[in]is_underlineA boolean value that decides whether to underline text or not.

◆ HeaderFooter() [2/2]

foxit.pdf.HeaderFooter.HeaderFooter ( HeaderFooter  other)
inline

Constructor, with another header-footer object.

Parameters
[in]otherAnother header-footer object.

Member Function Documentation

◆ Set()

void foxit.pdf.HeaderFooter.Set ( Font  font,
float  text_size,
int  text_color,
PageNumberRange  page_range,
RectF  page_margin,
bool  has_text_shrinked,
bool  has_fixedsize_for_print,
int  start_page_number,
HeaderFooterContent  content,
bool  is_to_embed_font,
bool  is_underline 
)
inline

Set value.

Parameters
[in]fontA valid font object which is expected to be used for header-footer content. Please refer to comment of font of current object.
[in]text_sizeText size of header-footer content.
[in]text_colorText color used for header-footer content.
[in]page_rangeA page number range object which specifies pages where current header-footer is used. Please refer to comment of page_range of current object.
[in]page_marginPage margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object.
[in]has_text_shrinkedA boolean value that decides whether to shrink text or not.
[in]has_fixedsize_for_printA boolean value that decides whether to use fixed size for print or not.
[in]start_page_numberA virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. If this value is less than 1, Foxit PDF SDK will use 1 for this value when current header-footer object is used in a PDF document.
[in]contentHeader-footer content.
[in]is_to_embed_fontA boolean value that decides whether to embed font or not.
[in]is_underlineA boolean value that decides whether to underline text or not.
Returns
None.

Property Documentation

◆ font

Font foxit.pdf.HeaderFooter.font
getset

A valid font object which is expected to be used for header-footer content.

Note
Sometimes, Foxit PDF SDK cannot match an extract font with this font object. In this case, Foxit PDF SDK will match a similar font (which is not exactly same as this font object) for heasder-footer content instead.

◆ page_margin

RectF foxit.pdf.HeaderFooter.page_margin
getset

Page margin which specifies the location for header-footer content. Foxit PDF SDK will use a maring defined as (72.0, 36.0, 72.0, 36.0) as default if no margin value is set by user.

Note
This value does not represent a rectangle. It just defines the left margin, bottom margin, right margin and top margin of a PDF page. These margins can be used to locate header-footer content in different places:
  • Left margin is used to specify the location for left header or footer content to be started.
  • Right margin is used to specify the location for right header or footer content to be ended.
  • Bottom margin is used to specify the top location for any footer content to be placed. If bottom margin is no more than 0, the footer content will be invisible.
  • Top margin is used to specify the bottom location for any header content to be placed. If top margin is no more than 0, the header content will be invisible.

◆ page_range

PageNumberRange foxit.pdf.HeaderFooter.page_range
getset

A page number range object which specifies pages where current header-footer is used.

All the values represented in this range should start from 1 and no more than page count of the PDF document, in which current header-footer object is used.

◆ start_page_number

int foxit.pdf.HeaderFooter.start_page_number
getset

A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page.

Note
If this value is less than 1, Foxit PDF SDK will use 1 for this value when current header-footer object is used in a PDF document.