Foxit PDF SDK
|
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). | |
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.
FSDK.Range.AddSegment | ( | start_index | , |
end_index | , | ||
filter | |||
) |
Add a new range segment. (Reverse ordering is legal.)
[in] | start_index | The start index of a new range segment. |
[in] | end_index | The end index of a new range segment. |
[in] | filter | Filter 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. |
FSDK.Range.AddSingle | ( | index | ) |
Add an index as a new range segment.
[in] | index | An index to be added as a new range segment. |
FSDK.Range.constructor | ( | index | ) |
Constructor, with a single index.
[in] | index | A single index. |
FSDK.Range.constructor | ( | start_index | , |
end_index | , | ||
filter | |||
) |
Constructor, with a specified index range.
[in] | start_index | The start index of a range segment. |
[in] | end_index | The end index of a range segment. |
[in] | filter | Filter 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. |
FSDK.Range.GetSegmentCount | ( | ) |
Get the count of range segments.
FSDK.Range.GetSegmentEnd | ( | segment_index | ) |
Get the end index of a specified range segment.
[in] | segment_index | The segment index. Valid range: 0 to (count-1). count is returned by function FSDK.Range.GetSegmentCount. |
FSDK.Range.GetSegmentStart | ( | segment_index | ) |
Get the start index of a specified range segment.
[in] | segment_index | The segment index. Valid range: 0 to (count-1). count is returned by function FSDK.Range.GetSegmentCount. |
FSDK.Range.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
FSDK.Range.RemoveAll | ( | ) |
Remove all range segments.
|
static |
Enumeration for range filter.
Values of this enumeration should be used alone.
All the indexes within a range will be used.