|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetFirst_page_percent () |
| Get the percent of the first paging seal. More... | |
| def | GetIs_display_multiple_seal () |
| Get decide whether to display multiple paging seal appearance for current paging seal signature. More... | |
| def | GetIs_on_perforation () |
| Get decide whether to chop a seal that covering the left or right margin of each two pages. More... | |
| def | GetOffset () |
| Get the offset of paging seal signature. More... | |
| def | GetPage_count_for_each_seal () |
| Get the page count of each seal. More... | |
| def | GetPaging_seal_position () |
| Get the position of paging seal. More... | |
| def | GetPaging_seal_style () |
| Get the style of paging seal signature. More... | |
| def | Set (paging_seal_position, offset, first_page_percent, is_on_perforation, paging_seal_style, is_display_multiple_seal, page_count_for_each_seal) |
| Set value. More... | |
| def | SetFirst_page_percent (value) |
| Set the percent of the first paging seal. More... | |
| def | SetIs_display_multiple_seal (value) |
| Set decide whether to display multiple paging seal appearance for current paging seal signature. More... | |
| def | SetIs_on_perforation (value) |
| Set decide whether to chop a seal that covering the left or right margin of each two pages. More... | |
| def | SetOffset (value) |
| Set the offset of paging seal signature. More... | |
| def | SetPage_count_for_each_seal (value) |
| Set the page count of each seal. More... | |
| def | SetPaging_seal_position (value) |
| Set the position of paging seal. More... | |
| def | SetPaging_seal_style (value) |
| Set the style of paging seal signature. More... | |
This class represents paging seal configuration. This configuration can be set by function fsdk.PagingSealSignature.SetPagingSealConfig .
| fsdk.PagingSealConfig.GetFirst_page_percent | ( | ) |
Get the percent of the first paging seal.
| fsdk.PagingSealConfig.GetIs_display_multiple_seal | ( | ) |
Get decide whether to display multiple paging seal appearance for current paging seal signature.
| fsdk.PagingSealConfig.GetIs_on_perforation | ( | ) |
Get decide whether to chop a seal that covering the left or right margin of each two pages.
| fsdk.PagingSealConfig.GetOffset | ( | ) |
Get the offset of paging seal signature.
This value should not be a negative number. The maximum value of offset is the value of page width or page height minus the width or height of rectangle of paging seal signature. If offset bigger than the maximum value, the maximum will be used.
For top paging seal and bottom paging seal, this value will be the horizontal offset of the left of signature rectangle.
For right paging seal,left paging seal, this value will be the vertical offset of the bottom of signature rectangle.
For the parameter is_on_perforation is true, this value will be the vertical offset of the bottom of signature rectangle.
| fsdk.PagingSealConfig.GetPage_count_for_each_seal | ( | ) |
Get the page count of each seal.
| fsdk.PagingSealConfig.GetPaging_seal_position | ( | ) |
Get the position of paging seal.
| fsdk.PagingSealConfig.GetPaging_seal_style | ( | ) |
Get the style of paging seal signature.
Different styles cannot be converted to each other. Default value: fsdk.PagingSealConfigE_PagingSealStyleMultipleSignatures .
| def fsdk.PagingSealConfig.Set | ( | paging_seal_position, | |
| offset, | |||
| first_page_percent, | |||
| is_on_perforation, | |||
| paging_seal_style, | |||
| is_display_multiple_seal, | |||
| page_count_for_each_seal | |||
| ) |
Set value.
| [in] | paging_seal_position | The position of paging seal. Please refer to values starting from fsdk.PagingSealConfigE_PagingSealPositionLeft and this would be one of these values. |
| [in] | offset | The offset of paging seal. This value should not be a negative number. |
| [in] | first_page_percent | The percent of the first paging seal. This parameter should larger than 0.0, less than 1.0. |
| [in] | is_on_perforation | Decide whether to chop a seal that covering the margin of each two pages. |
| [in] | paging_seal_style | The paging seal signature style. Please refer to values starting from fsdk.PagingSealConfigE_PagingSealStyleMultipleSignatures and this would be one of these values. |
| [in] | is_display_multiple_seal | Decide whether to display multiple paging seal appearance for current paging seal signature, default value: false. |
| [in] | page_count_for_each_seal | The page count each seal. This value should be larger than 1, default value: 30. |
| fsdk.PagingSealConfig.SetFirst_page_percent | ( | value | ) |
Set the percent of the first paging seal.
| [in] | value | The percent of the first paging seal. The rest percent will be divided equally by the other paging seals. This parameter should bigger than 0.0, less than 1.0. |
| fsdk.PagingSealConfig.SetIs_display_multiple_seal | ( | value | ) |
Set decide whether to display multiple paging seal appearance for current paging seal signature.
| [in] | value | Decide whether to display multiple paging seal appearance for current paging seal signature. true means to display multiple paging seal appearance, each count pages use one paging seal appearance, count is set by page_count_for_each_seal. While false means not. This parameter has no effect when the parameter is_on_perforation is true. |
| fsdk.PagingSealConfig.SetIs_on_perforation | ( | value | ) |
Set decide whether to chop a seal that covering the left or right margin of each two pages.
| [in] | value | Decide whether to chop a seal that covering the left or right margin of each two pages. true means the paging seal signatures will be added to pages in pairs, and the parameter paging_seal_position and the parameter first_page_percent will have no effect. false means not. |
| fsdk.PagingSealConfig.SetOffset | ( | value | ) |
Set the offset of paging seal signature.
This value should not be a negative number. The maximum value of offset is the value of page width or page height minus the width or height of rectangle of paging seal signature. If offset bigger than the maximum value, the maximum will be used.
For top paging seal and bottom paging seal, this value will be the horizontal offset of the left of signature rectangle.
For right paging seal,left paging seal, this value will be the vertical offset of the bottom of signature rectangle.
For the parameter is_on_perforation is true, this value will be the vertical offset of the bottom of signature rectangle.
| [in] | value | The offset of paging seal signature. |
| fsdk.PagingSealConfig.SetPage_count_for_each_seal | ( | value | ) |
Set the page count of each seal.
| [in] | value | The page count of each seal. This value only useful when the parameter is_display_multiple_seal is true. This value should be larger than 1. If the page count of the last seal is 1, it will be merged with the previous seal to form one seal. |
| fsdk.PagingSealConfig.SetPaging_seal_position | ( | value | ) |
Set the position of paging seal.
| [in] | value | The position of paging seal. Please refer to values starting from fsdk.PagingSealConfigE_PagingSealPositionLeft and this would be one of these values. |
| fsdk.PagingSealConfig.SetPaging_seal_style | ( | value | ) |
Set the style of paging seal signature.
Different styles cannot be converted to each other. Default value: fsdk.PagingSealConfigE_PagingSealStyleMultipleSignatures .
| [in] | value | The style of paging seal signature. Please refer to values starting from fsdk.PagingSealConfigE_PagingSealStyleMultipleSignatures and this would be one of these values. |