Foxit PDF SDK
 All Classes Namespaces Functions Enumerations Enumerator Properties Pages
foxit.pdf.PagingSealConfig Class Reference

Inherits SystemIDisposable.

Public Types

enum  PagingSealPosition { PagingSealPosition.e_PagingSealPositionLeft = 1, PagingSealPosition.e_PagingSealPositionRight = 2, PagingSealPosition.e_PagingSealPositionTop = 3, PagingSealPosition.e_PagingSealPositionBottom = 4 }
 Enumeration for paging seal position. More...
 

Public Member Functions

 PagingSealConfig (PagingSealConfig.PagingSealPosition paging_seal_position, float offset, float first_page_percent, bool is_on_perforation)
 Constructor, with parameter. More...
 
void Set (PagingSealConfig.PagingSealPosition paging_seal_position, float offset, float first_page_percent, bool is_on_perforation)
 Set value. More...
 

Properties

float first_page_percent [get, 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.
 
bool is_on_perforation [get, set]
 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.
 
float offset [get, set]
 The offset of paging seal signature. More...
 
PagingSealConfig.PagingSealPosition paging_seal_position [get, set]
 The position of paging seal. Please refer to values starting from endlinkandthiswouldbeoneofthesevalues.
 

Detailed Description

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

Member Enumeration Documentation

Enumeration for paging seal position.

Values of this enumeration should be used alone.

Enumerator
e_PagingSealPositionLeft 

Left Paging Seal.

e_PagingSealPositionRight 

Right Paging Seal.

e_PagingSealPositionTop 

Top Paging Seal.

e_PagingSealPositionBottom 

Bottom Paging Seal.

Constructor & Destructor Documentation

foxit.pdf.PagingSealConfig.PagingSealConfig ( PagingSealConfig.PagingSealPosition  paging_seal_position,
float  offset,
float  first_page_percent,
bool  is_on_perforation 
)
inline

Constructor, with parameter.

Parameters
[in]paging_seal_positionThe position of paging seal. Please refer to values starting from endlinkandthiswouldbeoneofthesevalues.@param[in]offsetTheoffsetofpagingseal.Thisvalueshouldnotbeanegativenumber.@param[in]first_page_percentThepercentofthefirstpagingseal.Thisparametershouldlargerthan0.0,lessthan1.0.@param[in]is_on_perforationDecidewhethertochopasealthatcoveringthemarginofeachtwopages.

Member Function Documentation

void foxit.pdf.PagingSealConfig.Set ( PagingSealConfig.PagingSealPosition  paging_seal_position,
float  offset,
float  first_page_percent,
bool  is_on_perforation 
)
inline

Set value.

Parameters
[in]paging_seal_positionThe position of paging seal. Please refer to values starting from endlinkandthiswouldbeoneofthesevalues.@param[in]offsetTheoffsetofpagingseal.Thisvalueshouldnotbeanegativenumber.@param[in]first_page_percentThepercentofthefirstpagingseal.Thisparametershouldlargerthan0.0,lessthan1.0.@param[in]is_on_perforationDecidewhethertochopasealthatcoveringthemarginofeachtwopages.@returnNone.

Property Documentation

float foxit.pdf.PagingSealConfig.offset
getset

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.