Foxit PDF SDK
FoxitPDFSDKPython3.PagingSealConfig Class Reference

Inherits FoxitPDFSDKPython3._object.

Public Member Functions

def PagingSealConfig (paging_seal_position, offset, first_page_percent, is_on_perforation)
 Constructor, with parameter. More...
 
def Set (paging_seal_position, offset, first_page_percent, is_on_perforation)
 Set value. More...
 

Static Public Attributes

 e_PagingSealPositionBottom = _fsdk.PagingSealConfig_e_PagingSealPositionBottom
 Bottom Paging Seal.
 
 e_PagingSealPositionLeft = _fsdk.PagingSealConfig_e_PagingSealPositionLeft
 Left Paging Seal.
 
 e_PagingSealPositionRight = _fsdk.PagingSealConfig_e_PagingSealPositionRight
 Right Paging Seal.
 
 e_PagingSealPositionTop = _fsdk.PagingSealConfig_e_PagingSealPositionTop
 Top Paging Seal.
 
 first_page_percent = _swig_property(_fsdk.PagingSealConfig_first_page_percent_get, _fsdk.PagingSealConfig_first_page_percent_set)
 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.
 
 offset = _swig_property(_fsdk.PagingSealConfig_offset_get, _fsdk.PagingSealConfig_offset_set)
 The offset of paging seal signature. More...
 
 paging_seal_position = _swig_property(_fsdk.PagingSealConfig_paging_seal_position_get, _fsdk.PagingSealConfig_paging_seal_position_set)
 The position of paging seal. Please refer to values starting from FoxitPDFSDKPython3.PagingSealConfig.e_PagingSealPositionLeft and this would be one of these values.
 

Detailed Description

This class represents paging seal configuration. This configuration can be set by function FoxitPDFSDKPython3.PagingSealSignature.SetPagingSealConfig .

Constructor & Destructor Documentation

◆ PagingSealConfig()

def FoxitPDFSDKPython3.PagingSealConfig.PagingSealConfig (   paging_seal_position,
  offset,
  first_page_percent,
  is_on_perforation 
)

Constructor, with parameter.

Parameters
[in]paging_seal_positionThe position of paging seal. Please refer to values starting from FoxitPDFSDKPython3.PagingSealConfig.e_PagingSealPositionLeft and this would be one of these values.
[in]offsetThe offset of paging seal. This value should not be a negative number.
[in]first_page_percentThe percent of the first paging seal. This parameter should larger than 0.0, less than 1.0.
[in]is_on_perforationDecide whether to chop a seal that covering the margin of each two pages.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython3.PagingSealConfig.Set (   paging_seal_position,
  offset,
  first_page_percent,
  is_on_perforation 
)

Set value.

Parameters
[in]paging_seal_positionThe position of paging seal. Please refer to values starting from FoxitPDFSDKPython3.PagingSealConfig.e_PagingSealPositionLeft and this would be one of these values.
[in]offsetThe offset of paging seal. This value should not be a negative number.
[in]first_page_percentThe percent of the first paging seal. This parameter should larger than 0.0, less than 1.0.
[in]is_on_perforationDecide whether to chop a seal that covering the margin of each two pages.

@ return None.

Member Data Documentation

◆ offset

FoxitPDFSDKPython3.PagingSealConfig.offset = _swig_property(_fsdk.PagingSealConfig_offset_get, _fsdk.PagingSealConfig_offset_set)
static

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.