Foxit PDF SDK
FSDK.Range Class Reference

Public Member Functions

 AddSegment (start_index, end_index, filter)
 Add a new range segment. (Reverse ordering is legal.) More...
 
 AddSingle (index)
 Add an index as a new range segment. More...
 
 constructor ()
 Constructor.
 
 constructor (index)
 Constructor, with a single index. More...
 
 constructor (start_index, end_index, filter)
 Constructor, with a specified index range. More...
 
 GetSegmentCount ()
 Get the count of range segments. More...
 
 GetSegmentEnd (segment_index)
 Get the end index of a specified range segment. More...
 
 GetSegmentStart (segment_index)
 Get the start index of a specified range segment. More...
 
 IsEmpty ()
 Check whether current object is empty or not. More...
 
 RemoveAll ()
 Remove all range segments. More...
 

Static Public Attributes

static e_All
 Enumeration for range filter. More...
 
static e_Even
 Only even numbers in a range will be used (discards odd numbers).
 
static e_Odd
 Only odd numbers in a range will be used (discards even numbers).
 

Detailed Description

This class represents index range. Here, a range consists of one or more segments and each segment consists of one single index or a group of consecutive indexes.
For some special case, such as used in FSDK.HeaderFooter, index values specified in this range represent page numbers directly instead of page indexes.

See also
FSDK.HeaderFooter

Member Function Documentation

◆ AddSegment()

FSDK.Range.AddSegment ( start_index  ,
end_index  ,
filter   
)

Add a new range segment. (Reverse ordering is legal.)

Parameters
[in]start_indexThe start index of a new range segment.
[in]end_indexThe end index of a new range segment.
[in]filterFilter type to decide which indexes of this range would be used. Please refer to values starting from FSDK.Range.e_All and this should be one of these values. Default value: FSDK.Range.e_All.
Specially, when this value is FSDK.Range.e_Even or FSDK.Range.e_Odd, that means each even or odd number within the specified range segment will be treated as a single segment.
Returns
None.

◆ AddSingle()

FSDK.Range.AddSingle ( index  )

Add an index as a new range segment.

Parameters
[in]indexAn index to be added as a new range segment.

◆ constructor() [1/2]

FSDK.Range.constructor ( index  )

Constructor, with a single index.

Parameters
[in]indexA single index.

◆ constructor() [2/2]

FSDK.Range.constructor ( start_index  ,
end_index  ,
filter   
)

Constructor, with a specified index range.

Parameters
[in]start_indexThe start index of a range segment.
[in]end_indexThe end index of a range segment.
[in]filterFilter type to decide which indexes of this range would be used. Please refer to values starting from FSDK.Range.e_All and this should be one of these values. Default value: FSDK.Range.e_All.
Specially, when this value is FSDK.Range.e_Even or FSDK.Range.e_Odd, that means each even or odd number within the specified range segment will be treated as a single segment.

◆ GetSegmentCount()

FSDK.Range.GetSegmentCount ( )

Get the count of range segments.

Returns
The count of range segments.

◆ GetSegmentEnd()

FSDK.Range.GetSegmentEnd ( segment_index  )

Get the end index of a specified range segment.

Parameters
[in]segment_indexThe segment index. Valid range: 0 to (count-1). count is returned by function FSDK.Range.GetSegmentCount.
Returns
The end index of a specified range segment.

◆ GetSegmentStart()

FSDK.Range.GetSegmentStart ( segment_index  )

Get the start index of a specified range segment.

Parameters
[in]segment_indexThe segment index. Valid range: 0 to (count-1). count is returned by function FSDK.Range.GetSegmentCount.
Returns
The start index of a specified range segment.

◆ IsEmpty()

FSDK.Range.IsEmpty ( )

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ RemoveAll()

FSDK.Range.RemoveAll ( )

Remove all range segments.

Returns
None.

Member Data Documentation

◆ e_All

FSDK.Range.e_All
static

Enumeration for range filter.

Values of this enumeration should be used alone.

All the indexes within a range will be used.