Foxit PDF SDK
foxit::pdf::PagingSealConfig类 参考

继承自 Object .

Public 类型

enum  PagingSealPosition { e_PagingSealPositionLeft = 1, e_PagingSealPositionRight = 2, e_PagingSealPositionTop = 3, e_PagingSealPositionBottom = 4 }
 分页印章位置的枚举。 更多...
 
enum  PagingSealStyle { e_PagingSealStyleMultipleSignatures = 0, e_PagingSealStyleOneSignature = 1 }
 分页印章签名样式的枚举。 更多...
 

Public 成员函数

 PagingSealConfig (PagingSealPosition paging_seal_position, float offset, float first_page_percent, bool is_on_perforation, PagingSealStyle paging_seal_style=PagingSealConfig::e_PagingSealStyleMultipleSignatures, bool is_display_multiple_seal=false, int page_count_for_each_seal=30)
 带参数的构造函数。 更多...
 
bool operator != (const PagingSealConfig &paging_seal_config) const
 不相等操作符。 更多...
 
PagingSealConfigoperator= (const PagingSealConfig &paging_seal_config)
 赋值操作符。 更多...
 
bool operator== (const PagingSealConfig &paging_seal_config) const
 相等操作符。 更多...
 
void Set (PagingSealPosition paging_seal_position, float offset, float first_page_percent, bool is_on_perforation, PagingSealStyle paging_seal_style, bool is_display_multiple_seal=false, int page_count_for_each_seal=30)
 设置值。 更多...
 

Public 属性

float first_page_percent
 第一个分页印章的百分比。其余百分比将由其他分页印章平均分配。 此参数应大于0.0,小于1.0。
 
bool is_display_multiple_seal
 决定是否为当前分页印章签名显示多个分页印章外观。true表示显示多个分页印章 外观,每count页使用一个分页印章外观,countpage_count_for_each_seal设置。false表示不显示。 当参数is_on_perforationtrue时,此参数无效。
 
bool is_on_perforation
 决定是否切断覆盖每两页左边距或右边距的印章。true表示分页印章签名 将成对添加到页面中,参数paging_seal_position和参数first_page_percent 将不起作用。false表示不切断。
 
float offset
 分页印章签名的偏移量。 更多...
 
int page_count_for_each_seal
 每个印章的页数。此值仅在参数is_display_multiple_sealtrue时有用。 此值应大于1。如果最后一个印章的页数为1,它将与前一个印章合并形成一个印章。
 
PagingSealPosition paging_seal_position
 分页印章的位置。请参考从PagingSealConfig::e_PagingSealPositionLeft 开始的值,这将是这些值中的一个。
 
PagingSealStyle paging_seal_style
 分页印章签名的样式。请参考从PagingSealConfig::e_PagingSealStyleMultipleSignatures 开始的值,这将是这些值中的一个。 更多...
 

详细描述

此类表示分页印章配置。 此配置可以通过函数PagingSealSignature::SetPagingSealConfig设置。

成员枚举类型说明

◆ PagingSealPosition

分页印章位置的枚举。

此枚举的值应单独使用。

枚举值
e_PagingSealPositionLeft 

左侧分页印章。

e_PagingSealPositionRight 

右侧分页印章。

e_PagingSealPositionTop 

顶部分页印章。

e_PagingSealPositionBottom 

底部分页印章。

◆ PagingSealStyle

分页印章签名样式的枚举。

此枚举的值应单独使用。

枚举值
e_PagingSealStyleMultipleSignatures 

添加多个签名。使用Signature显示分页印章签名的外观, 这些签名共享相同的签名数据。

e_PagingSealStyleOneSignature 

仅添加一个签名。此签名用于签名和验证,在PDF文档中将被隐藏。 使用annots::PagingSeal注释显示分页印章签名的外观。

构造及析构函数说明

◆ PagingSealConfig()

foxit::pdf::PagingSealConfig::PagingSealConfig ( PagingSealPosition  paging_seal_position,
float  offset,
float  first_page_percent,
bool  is_on_perforation,
PagingSealStyle  paging_seal_style = PagingSealConfig::e_PagingSealStyleMultipleSignatures,
bool  is_display_multiple_seal = false,
int  page_count_for_each_seal = 30 
)

带参数的构造函数。

参数
[in]paging_seal_position分页印章的位置。请参考从 PagingSealConfig::e_PagingSealPositionLeft 开始的值,这将是这些值中的一个。
[in]offset分页印章的偏移量。此值不应为负数。
[in]first_page_percent第一个分页印章的百分比。此参数应大于0.0,小于1.0。
[in]is_on_perforation决定是否切断覆盖每两页边距的印章。
[in]paging_seal_style分页印章签名样式。请参考从 PagingSealConfig::e_PagingSealStyleMultipleSignatures 开始的值,这将是这些值中的一个。
[in]is_display_multiple_seal决定是否为当前分页印章签名显示多个分页印章外观,默认值:false
[in]page_count_for_each_seal每个印章的页数。此值应大于1,默认值:30。

成员函数说明

◆ operator !=()

bool foxit::pdf::PagingSealConfig::operator != ( const PagingSealConfig paging_seal_config) const
inline

不相等操作符。

参数
[in]paging_seal_config另一个分页印章配置对象。此函数将检查当前对象是否与此对象不相等。
返回
true表示不相等,false表示相等。

◆ operator=()

PagingSealConfig& foxit::pdf::PagingSealConfig::operator= ( const PagingSealConfig paging_seal_config)
inline

赋值操作符。

参数
[in]paging_seal_config另一个分页印章配置对象,其值将被赋给当前对象。
返回
对当前对象本身的引用。

◆ operator==()

bool foxit::pdf::PagingSealConfig::operator== ( const PagingSealConfig paging_seal_config) const
inline

相等操作符。

参数
[in]paging_seal_config另一个分页印章配置对象。此函数将检查当前对象是否与此对象相等。
返回
true表示相等,false表示不相等。

◆ Set()

void foxit::pdf::PagingSealConfig::Set ( PagingSealPosition  paging_seal_position,
float  offset,
float  first_page_percent,
bool  is_on_perforation,
PagingSealStyle  paging_seal_style,
bool  is_display_multiple_seal = false,
int  page_count_for_each_seal = 30 
)

设置值。

参数
[in]paging_seal_position分页印章的位置。请参考从 PagingSealConfig::e_PagingSealPositionLeft 开始的值,这将是这些值中的一个。
[in]offset分页印章的偏移量。此值不应为负数。
[in]first_page_percent第一个分页印章的百分比。此参数应大于0.0,小于1.0。
[in]is_on_perforation决定是否切断覆盖每两页边距的印章。
[in]paging_seal_style分页印章签名样式。请参考从 PagingSealConfig::e_PagingSealStyleMultipleSignatures 开始的值,这将是这些值中的一个。
[in]is_display_multiple_seal决定是否为当前分页印章签名显示多个分页印章外观,默认值:false
[in]page_count_for_each_seal每个印章的页数。此值应大于1,默认值:30。
返回
None.

类成员变量说明

◆ offset

float foxit::pdf::PagingSealConfig::offset

分页印章签名的偏移量。

此值不应为负数。偏移量的最大值是页面宽度或页面高度减去 分页印章签名矩形的宽度或高度的值。如果偏移量大于最大值,将使用最大值。

  • 对于顶部分页印章和底部分页印章,此值将是签名矩形左侧的水平偏移量。
  • 对于右侧分页印章和左侧分页印章,此值将是签名矩形底部的垂直偏移量。
  • 对于参数is_on_perforationtrue的情况,此值将是签名矩形底部的垂直偏移量。

◆ paging_seal_style

PagingSealStyle foxit::pdf::PagingSealConfig::paging_seal_style

分页印章签名的样式。请参考从PagingSealConfig::e_PagingSealStyleMultipleSignatures 开始的值,这将是这些值中的一个。

不同样式之间无法相互转换。默认值:PagingSealConfig::e_PagingSealStyleMultipleSignatures