Foxit PDF SDK
FSPagingSealConfig Class Reference

Inherits NSObject.

Instance Methods

(id) - initWithPaging_seal_position:offset:first_page_percent:is_on_perforation:
 Constructor, with parameter.
More...
 
(void) - set:offset:first_page_percent:is_on_perforation:
 Set value.
More...
 

Properties

float first_page_percent
 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
 Decide whether to chop a seal that covering the left or right margin of each two pages. YES 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. NO means not.

 
float offset
 The offset of paging seal signature.
More...
 
FSPagingSealConfigPagingSealPosition paging_seal_position
 The position of paging seal. Please refer to values starting from FSPagingSealConfigPagingSealPositionLeft and this would be one of these values.

 

Detailed Description

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

Method Documentation

◆ initWithPaging_seal_position:offset:first_page_percent:is_on_perforation:()

- (id) initWithPaging_seal_position: (FSPagingSealConfigPagingSealPosition paging_seal_position
offset: (float)  offset
first_page_percent: (float)  first_page_percent
is_on_perforation: (BOOL)  is_on_perforation 

Constructor, with parameter.

Parameters
[in]paging_seal_positionThe position of paging seal. Please refer to values starting from FSPagingSealConfigPagingSealPositionLeft 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.

◆ set:offset:first_page_percent:is_on_perforation:()

- (void) set: (FSPagingSealConfigPagingSealPosition paging_seal_position
offset: (float)  offset
first_page_percent: (float)  first_page_percent
is_on_perforation: (BOOL)  is_on_perforation 

Set value.

Parameters
[in]paging_seal_positionThe position of paging seal. Please refer to values starting from FSPagingSealConfigPagingSealPositionLeft 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.

Property Documentation

◆ offset

- (float) offset
readwritenonatomicassign

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 YES, this value will be the vertical offset of the bottom of signature rectangle.