Foxit PDF Conversion SDK
PDFConversionSDK::Range类 参考

Public 成员函数

 constructor ()
 构造函数。
 
 constructor (index)
 带单个索引的构造函数。 更多...
 
 constructor (start_index, end_index, filter)
 带指定索引范围的构造函数。 更多...
 
AddSingle(index) GetSegmentCount ()
 添加一个索引作为新的范围段。 更多...
 
 GetSegmentEnd (index)
 获取指定范围段的结束索引。 更多...
 
 GetSegmentStart (index)
 获取指定范围段的起始索引。 更多...
 
 IsEmpty ()
 检查当前对象是否为空。 更多...
 
 RemoveAll ()
 移除所有范围段。 更多...
 

详细描述

此类表示索引范围。这里,一个范围由一个或多个段组成,每个段由 一个单一索引或一组连续索引组成。
对于某些特殊情况,例如在 PDFConversionSDK.PDF2OfficeSettingData 中使用,此范围中指定的索引值直接表示页码而不是页索引。

参见
PDFConversionSDK.PDF2OfficeSettingData

成员函数说明

◆ constructor() [1/2]

PDFConversionSDK::Range::constructor ( index  )

带单个索引的构造函数。

参数
[in]index单个索引。

◆ constructor() [2/2]

PDFConversionSDK::Range::constructor ( start_index  ,
end_index  ,
filter   
)

带指定索引范围的构造函数。

参数
[in]start_index范围段的起始索引。
[in]end_index范围段的结束索引。
[in]filter过滤器类型,用于决定将使用此范围的哪些索引。请参考从 PDFConversionSDK.Filter.e_All 开始的值,并且应为这些值之一。 默认值:PDFConversionSDK.Filter.e_All
特别地,当此值为 PDFConversionSDK.Filter.e_EvenPDFConversionSDK.Filter.e_Odd 时, 这意味着指定范围段内的每个偶数或奇数将 被视为单个段。

◆ GetSegmentCount()

AddSingle (index) PDFConversionSDK::Range::GetSegmentCount ( )

添加一个索引作为新的范围段。

参数
[in]index要作为新范围段添加的索引。添加一个新的范围段。(允许反向排序。)
[in]start_index新范围段的起始索引。
[in]end_index新范围段的结束索引。
[in]filter过滤器类型,用于决定将使用此范围的哪些索引。请参考从 PDFConversionSDK.Filter.e_All 开始的值,并且应为这些值之一。 默认值:PDFConversionSDK.Filter.e_All
特别地,当此值为 PDFConversionSDK.Filter.e_EvenPDFConversionSDK.Filter.e_Odd 时, 这意味着指定范围段内的每个偶数或奇数将 被视为单个段。
返回
无。获取范围段的数量。
范围段的数量。

◆ GetSegmentEnd()

PDFConversionSDK::Range::GetSegmentEnd ( index  )

获取指定范围段的结束索引。

参数
[in]segment_index段索引。有效范围:0 到 (count-1)。 count 由函数 PDFConversionSDK.Range.GetSegmentCount 返回。
返回
指定范围段的结束索引。

◆ GetSegmentStart()

PDFConversionSDK::Range::GetSegmentStart ( index  )

获取指定范围段的起始索引。

参数
[in]segment_index段索引。有效范围:0 到 (count-1)。 count 由函数 PDFConversionSDK.Range.GetSegmentCount 返回。
返回
指定范围段的起始索引。

◆ IsEmpty()

PDFConversionSDK::Range::IsEmpty ( )

检查当前对象是否为空。

当当前对象为空时,这意味着当前对象无用。

返回
true 表示当前对象为空,false 表示不为空。

◆ RemoveAll()

PDFConversionSDK::Range::RemoveAll ( )

移除所有范围段。

返回
无。