Foxit PDF SDK
Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::Range类 参考

Public 成员函数

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

静态 Public 属性

static e_All
 范围过滤器的枚举。 更多...
 
static e_Even
 范围中只有偶数将被使用（丢弃奇数）。
 
static e_Odd
 范围中只有奇数将被使用（丢弃偶数）。
 

详细描述

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

参见
FSDK.HeaderFooter

成员函数说明

◆ AddSegment()

FSDK::Range::AddSegment (   start_index,
  end_index,
  filter 
)
inline

添加一个新的范围段。（允许反向排序。）

参数
[in]start_index新范围段的起始索引。
[in]end_index新范围段的结束索引。
[in]filter过滤器类型，用于决定将使用此范围的哪些索引。请参阅从 FSDK.Range.e_All 开始的值，并且应为这些值之一。 默认值：FSDK.Range.e_All。
特别是，当此值为 FSDK.Range.e_Even 或 FSDK.Range.e_Odd 时， 表示指定范围段内的每个偶数或奇数将被视为单个段。
返回
无。

◆ AddSingle()

FSDK::Range::AddSingle (   index)
inline

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

参数
[in]index要添加为新范围段的索引。

◆ constructor() [1/2]

FSDK::Range::constructor (   index)
inline

带有单个索引的构造函数。

参数
[in]index单个索引。

◆ constructor() [2/2]

FSDK::Range::constructor (   start_index,
  end_index,
  filter 
)
inline

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

参数
[in]start_index范围段的起始索引。
[in]end_index范围段的结束索引。
[in]filter过滤器类型，用于决定将使用此范围的哪些索引。请参阅从 FSDK.Range.e_All 开始的值，并且应为这些值之一。 默认值：FSDK.Range.e_All。
特别是，当此值为 FSDK.Range.e_Even 或 FSDK.Range.e_Odd 时， 表示指定范围段内的每个偶数或奇数将被视为单个段。

◆ GetSegmentCount()

FSDK::Range::GetSegmentCount ( )
inline

获取范围段的数量。

返回
范围段的数量。

◆ GetSegmentEnd()

FSDK::Range::GetSegmentEnd (   segment_index)
inline

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

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

◆ GetSegmentStart()

FSDK::Range::GetSegmentStart (   segment_index)
inline

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

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

◆ IsEmpty()

FSDK::Range::IsEmpty ( )
inline

检查当前对象是否为空。

当当前对象为空时，表示当前对象不可用。

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

◆ RemoveAll()

FSDK::Range::RemoveAll ( )
inline

移除所有范围段。

返回
无。

类成员变量说明

◆ e_All

FSDK::Range::e_All
static

范围过滤器的枚举。

此枚举的值应单独使用。范围内的所有索引都将被使用。