|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetContent () |
| Get header-footer content. More... | |
| def | GetFont () |
| Get a valid font object which is expected to be used for header-footer content. More... | |
| def | GetHas_fixedsize_for_print () |
| Get a boolean value that decides whether to use fixed size for print or not. More... | |
| def | GetHas_text_shrinked () |
| Get a boolean value that decides whether to shrink text or not. More... | |
| def | GetIs_replace_font () |
| Get (Reserved) A boolean value that decides whether to replace font or not. More... | |
| def | GetIs_to_embed_font () |
| Get a boolean value that decides whether to embed font or not. More... | |
| def | GetIs_underline () |
| Get a boolean value that decides whether to underline text or not. More... | |
| def | GetPage_margin () |
| Get page margin which specifies the location for header-footer content. More... | |
| def | GetPage_range () |
| Get a page number range object which specifies pages where current header-footer is used. More... | |
| def | GetStart_page_number () |
| Get a virtual page number used for the first page specified in parameter page_range. More... | |
| def | GetText_color () |
| Get text color used for header-footer content. More... | |
| def | GetText_size () |
| Get text size of header-footer content. 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... | |
| def | SetContent (value) |
| Set header-footer content. More... | |
| def | SetFont (value) |
| Set a valid font object which is expected to be used for header-footer content. More... | |
| def | SetHas_fixedsize_for_print (value) |
| Set a boolean value that decides whether to use fixed size for print or not. More... | |
| def | SetHas_text_shrinked (value) |
| Set a boolean value that decides whether to shrink text or not. More... | |
| def | SetIs_replace_font (value) |
| Set (Reserved) A boolean value that decides whether to replace font or not. More... | |
| def | SetIs_to_embed_font (value) |
| Set a boolean value that decides whether to embed font or not. More... | |
| def | SetIs_underline (value) |
| Set a boolean value that decides whether to underline text or not. More... | |
| def | SetPage_margin (value) |
| Set page margin which specifies the location for header-footer content. More... | |
| def | SetPage_range (value) |
| Set a page number range object which specifies pages where current header-footer is used. More... | |
| def | SetStart_page_number (value) |
| Set a virtual page number used for the first page specified in parameter page_range. More... | |
| def | SetText_color (value) |
| Set text color used for header-footer content. More... | |
| def | SetText_size (value) |
| Set text size of header-footer content. More... | |
This class represents properties and data for a header-footer.
| fsdk.HeaderFooter.GetContent | ( | ) |
Get header-footer content.
| fsdk.HeaderFooter.GetFont | ( | ) |
Get a valid font object which is expected to be used for header-footer content.
| fsdk.HeaderFooter.GetHas_fixedsize_for_print | ( | ) |
Get a boolean value that decides whether to use fixed size for print or not.
| fsdk.HeaderFooter.GetHas_text_shrinked | ( | ) |
Get a boolean value that decides whether to shrink text or not.
| fsdk.HeaderFooter.GetIs_replace_font | ( | ) |
Get (Reserved) A boolean value that decides whether to replace font or not.
| fsdk.HeaderFooter.GetIs_to_embed_font | ( | ) |
Get a boolean value that decides whether to embed font or not.
| fsdk.HeaderFooter.GetIs_underline | ( | ) |
Get a boolean value that decides whether to underline text or not.
| fsdk.HeaderFooter.GetPage_margin | ( | ) |
Get page margin which specifies the location for header-footer content.
| fsdk.HeaderFooter.GetPage_range | ( | ) |
Get 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.GetStart_page_number | ( | ) |
Get a virtual page number used for the first page specified in parameter page_range.
| fsdk.HeaderFooter.GetText_color | ( | ) |
Get text color used for header-footer content.
| fsdk.HeaderFooter.GetText_size | ( | ) |
Get text size of header-footer content.
| def 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.SetContent | ( | value | ) |
Set header-footer content.
| [in] | value | Header-footer content. |
| fsdk.HeaderFooter.SetFont | ( | value | ) |
Set a valid font object which is expected to be used for header-footer content.
| [in] | value | A valid font object which is expected to be used for header-footer content. |
| fsdk.HeaderFooter.SetHas_fixedsize_for_print | ( | value | ) |
Set a boolean value that decides whether to use fixed size for print or not.
| [in] | value | A boolean value that decides whether to use fixed size for print or not. |
| fsdk.HeaderFooter.SetHas_text_shrinked | ( | value | ) |
Set a boolean value that decides whether to shrink text or not.
| [in] | value | A boolean value that decides whether to shrink text or not. |
| fsdk.HeaderFooter.SetIs_replace_font | ( | value | ) |
Set (Reserved) A boolean value that decides whether to replace font or not.
| [in] | value | (Reserved) A boolean value that decides whether to replace font or not. Currently Foxit PDF SDK will use this as true all the time. |
| fsdk.HeaderFooter.SetIs_to_embed_font | ( | value | ) |
Set a boolean value that decides whether to embed font or not.
| [in] | value | A boolean value that decides whether to embed font or not. |
| fsdk.HeaderFooter.SetIs_underline | ( | value | ) |
Set a boolean value that decides whether to underline text or not.
| [in] | value | A boolean value that decides whether to underline text or not. |
| fsdk.HeaderFooter.SetPage_margin | ( | value | ) |
Set page margin which specifies the location for header-footer content.
| [in] | value | 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.SetPage_range | ( | value | ) |
Set 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.
| [in] | value | A page number range object which specifies pages where current header-footer is used. |
| fsdk.HeaderFooter.SetStart_page_number | ( | value | ) |
Set a virtual page number used for the first page specified in parameter page_range.
| [in] | value | 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. |
| fsdk.HeaderFooter.SetText_color | ( | value | ) |
Set text color used for header-footer content.
| [in] | value | Text color used for header-footer content. |
| fsdk.HeaderFooter.SetText_size | ( | value | ) |
Set text size of header-footer content.
| [in] | value | Text size of header-footer content. |