Foxit PDF SDK
|
Inherits FoxitPDFSDKPython3._object.
Public Member Functions | |
def | HeaderFooter () |
Constructor. | |
def | HeaderFooter (other) |
Constructor, with another header-footer object. More... | |
def | 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... | |
Static Public Attributes | |
content = _swig_property(_fsdk.HeaderFooter_content_get, _fsdk.HeaderFooter_content_set) | |
Header-footer content. | |
font = _swig_property(_fsdk.HeaderFooter_font_get, _fsdk.HeaderFooter_font_set) | |
A valid font object which is expected to be used for header-footer content. More... | |
has_fixedsize_for_print = _swig_property(_fsdk.HeaderFooter_has_fixedsize_for_print_get, _fsdk.HeaderFooter_has_fixedsize_for_print_set) | |
A boolean value that decides whether to use fixed size for print or not. | |
has_text_shrinked = _swig_property(_fsdk.HeaderFooter_has_text_shrinked_get, _fsdk.HeaderFooter_has_text_shrinked_set) | |
A boolean value that decides whether to shrink text or not. | |
is_replace_font = _swig_property(_fsdk.HeaderFooter_is_replace_font_get, _fsdk.HeaderFooter_is_replace_font_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. | |
is_to_embed_font = _swig_property(_fsdk.HeaderFooter_is_to_embed_font_get, _fsdk.HeaderFooter_is_to_embed_font_set) | |
A boolean value that decides whether to embed font or not. | |
is_underline = _swig_property(_fsdk.HeaderFooter_is_underline_get, _fsdk.HeaderFooter_is_underline_set) | |
A boolean value that decides whether to underline text or not. | |
page_margin = _swig_property(_fsdk.HeaderFooter_page_margin_get, _fsdk.HeaderFooter_page_margin_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... | |
page_range = _swig_property(_fsdk.HeaderFooter_page_range_get, _fsdk.HeaderFooter_page_range_set) | |
A page number range object which specifies pages where current header-footer is used. More... | |
start_page_number = _swig_property(_fsdk.HeaderFooter_start_page_number_get, _fsdk.HeaderFooter_start_page_number_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... | |
text_color = _swig_property(_fsdk.HeaderFooter_text_color_get, _fsdk.HeaderFooter_text_color_set) | |
Text color used for header-footer content. | |
text_size = _swig_property(_fsdk.HeaderFooter_text_size_get, _fsdk.HeaderFooter_text_size_set) | |
Text size of header-footer content. | |
This class represents properties and data for a header-footer.
def FoxitPDFSDKPython3.HeaderFooter.HeaderFooter | ( | other | ) |
Constructor, with another header-footer object.
[in] | other | Another header-footer object. |
def FoxitPDFSDKPython3.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. |
|
static |
A valid font object which is expected to be used for header-footer content.
|
static |
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.
|
static |
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.
|
static |
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.