foxit.common.Range类 参考

类 foxit.common.Range 继承关系图:

Public 类型
enum	Filter { Filter.e_All = 0, Filter.e_Even = 1, Filter.e_Odd = 2 }
	范围过滤器的枚举。 更多...

Public 成员函数
	Range ()
	构造函数。
	Range (int index)
	构造函数，使用单个索引。 更多...
	Range (int start_index, int end_index, Range.Filter filter)
	构造函数，使用指定的索引范围。 更多...
	Range (Range other)
	构造函数，使用另一个范围对象。 更多...
void	AddSegment (int start_index, int end_index, Range.Filter filter)
	添加新的范围段。（反向排序是合法的。） 更多...
void	AddSingle (int index)
	添加一个索引作为新的范围段。 更多...
int	GetSegmentCount ()
	获取范围段的数量。 更多...
int	GetSegmentEnd (int segment_index)
	获取指定范围段的结束索引。 更多...
int	GetSegmentStart (int segment_index)
	获取指定范围段的起始索引。 更多...
bool	IsEmpty ()
	检查当前对象是否为空。 更多...
void	RemoveAll ()
	移除所有范围段。 更多...

详细描述

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

参见

foxit.conversion.pdf2office.PDF2OfficeSettingData

成员枚举类型说明

Filter

enum foxit.common.Range.Filter

strong

范围过滤器的枚举。

此枚举的值应单独使用。

枚举值
e_All	将使用范围内的所有索引。
e_Even	将仅使用范围内的偶数（丢弃奇数）。
e_Odd	将仅使用范围内的奇数（丢弃偶数）。

构造及析构函数说明

Range() [1/3]

foxit.common.Range.Range ( int  index )

inline

构造函数，使用单个索引。

参数

[in]

index

单个索引。

Range() [2/3]

foxit.common.Range.Range ( int  start_index, int  end_index, Range.Filter  filter  )

inline

构造函数，使用指定的索引范围。

参数

[in]	start_index	范围段的起始索引。
[in]	end_index	范围段的结束索引。
[in]	filter	过滤器类型，用于决定使用此范围的哪些索引。请参考从 foxit.common.Range.Filter.e_All 开始的值，这应该是这些值中的一个。 默认值：foxit.common.Range.Filter.e_All 。 特别地，当此值为 foxit.common.Range.Filter.e_Even 或 foxit.common.Range.Filter.e_Odd 时， 这意味着指定范围段内的每个偶数或奇数都将 被视为单个段。

Range() [3/3]

foxit.common.Range.Range ( Range  other )

inline

构造函数，使用另一个范围对象。

参数

[in]

other

另一个范围对象。

成员函数说明

AddSegment()

void foxit.common.Range.AddSegment ( int  start_index, int  end_index, Range.Filter  filter  )

inline

添加新的范围段。（反向排序是合法的。）

参数

[in]	start_index	新范围段的起始索引。
[in]	end_index	新范围段的结束索引。
[in]	filter	过滤器类型，用于决定使用此范围的哪些索引。请参考从 foxit.common.Range.Filter.e_All 开始的值，这应该是这些值中的一个。 默认值：foxit.common.Range.Filter.e_All 。 特别地，当此值为 foxit.common.Range.Filter.e_Even 或 foxit.common.Range.Filter.e_Odd 时， 这意味着指定范围段内的每个偶数或奇数都将 被视为单个段。

返回

无。

AddSingle()

void foxit.common.Range.AddSingle ( int  index )

inline

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

参数

[in]

index

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

GetSegmentCount()

int foxit.common.Range.GetSegmentCount ( )

inline

获取范围段的数量。

返回

范围段的数量。

GetSegmentEnd()

int foxit.common.Range.GetSegmentEnd ( int  segment_index )

inline

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

参数

[in]

segment_index

段索引。有效范围：0 到 (count-1)。 count 由函数 Range.GetSegmentCount 返回。

返回

指定范围段的结束索引。

GetSegmentStart()

int foxit.common.Range.GetSegmentStart ( int  segment_index )

inline

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

参数

[in]

segment_index

段索引。有效范围：0 到 (count-1)。 count 由函数 Range.GetSegmentCount 返回。

返回

指定范围段的起始索引。

IsEmpty()

bool foxit.common.Range.IsEmpty ( )

inline

检查当前对象是否为空。

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

返回

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

RemoveAll()

void foxit.common.Range.RemoveAll ( )

inline

移除所有范围段。

返回

无。