Foxit PDF SDK
|
Public Member Functions | |
constructor () | |
Constructor. | |
constructor (font, text_size, text_color, page_range, page_margin, has_text_shrinked, has_fixedsize_for_print, start_page_number, content, is_to_embed_font, is_underline) | |
Constructor, with parameters. More... | |
Set (font, text_size, text_color, page_range, page_margin, has_text_shrinked, has_fixedsize_for_print, start_page_number, content, is_to_embed_font, is_underline) | |
Set value. More... | |
Public Attributes | |
content | |
Header-footer content. | |
font | |
A valid font object which is expected to be used for header-footer content. More... | |
has_fixedsize_for_print | |
A boolean value that decides whether to use fixed size for print or not. | |
has_text_shrinked | |
A boolean value that decides whether to shrink text or not. | |
is_replace_font | |
(Reserved) A boolean value that decides whether to replace font or not. Currently Foxit PDF SDK will use this as true all the time. | |
is_to_embed_font | |
A boolean value that decides whether to embed font or not. | |
is_underline | |
A boolean value that decides whether to underline text or not. | |
page_margin | |
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... | |
page_range | |
A page number range object which specifies pages where current header-footer is used. More... | |
start_page_number | |
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... | |
text_color | |
Text color used for header-footer content. | |
text_size | |
Text size of header-footer content. | |
This class represents properties and data for a header-footer.
FSDK.HeaderFooter.constructor | ( | font | , |
text_size | , | ||
text_color | , | ||
page_range | , | ||
page_margin | , | ||
has_text_shrinked | , | ||
has_fixedsize_for_print | , | ||
start_page_number | , | ||
content | , | ||
is_to_embed_font | , | ||
is_underline | |||
) |
Constructor, with parameters.
[in] | font | A valid font object used for header-footer content. Please refer to comment of font of current object. |
[in] | text_size | Text size of header-footer content. |
[in] | text_color | Text color used for header-footer content. |
[in] | page_range | A 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_margin | Page margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object. |
[in] | has_text_shrinked | A boolean value that decides whether to shrink text or not. |
[in] | has_fixedsize_for_print | A boolean value that decides whether to use fixed size for print or not. |
[in] | start_page_number | 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. 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] | content | Header-footer content. |
[in] | is_to_embed_font | A boolean value that decides whether to embed font or not. |
[in] | is_underline | A boolean value that decides whether to underline text or not. |
FSDK.HeaderFooter.Set | ( | font | , |
text_size | , | ||
text_color | , | ||
page_range | , | ||
page_margin | , | ||
has_text_shrinked | , | ||
has_fixedsize_for_print | , | ||
start_page_number | , | ||
content | , | ||
is_to_embed_font | , | ||
is_underline | |||
) |
Set value.
[in] | font | A valid font object which is expected to be used for header-footer content. Please refer to comment of font of current object. |
[in] | text_size | Text size of header-footer content. |
[in] | text_color | Text color used for header-footer content. |
[in] | page_range | A 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_margin | Page margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object. |
[in] | has_text_shrinked | A boolean value that decides whether to shrink text or not. |
[in] | has_fixedsize_for_print | A boolean value that decides whether to use fixed size for print or not. |
[in] | start_page_number | 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. 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] | content | Header-footer content. |
[in] | is_to_embed_font | A boolean value that decides whether to embed font or not. |
[in] | is_underline | A boolean value that decides whether to underline text or not. |
FSDK.HeaderFooter.font |
A valid font object which is expected to be used for header-footer content.
FSDK.HeaderFooter.page_margin |
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.
FSDK.HeaderFooter.page_range |
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.
FSDK.HeaderFooter.start_page_number |
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.