Foxit PDF SDK
fsdk.Range Class Reference

Public Member Functions

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

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()

def 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.RangeE_All and this should be one of these values. Default value: fsdk.RangeE_All .
Specially, when this value is fsdk.RangeE_Even or fsdk.RangeE_Odd , that means each even or odd number within the specified range segment will be treated as a single segment.
Returns
None.

◆ AddSingle()

def fsdk.Range.AddSingle (   index)

Add an index as a new range segment.

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

◆ GetSegmentCount()

def fsdk.Range.GetSegmentCount ( )

Get the count of range segments.

Returns
The count of range segments.

◆ GetSegmentEnd()

def 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()

def 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()

def 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()

def fsdk.Range.RemoveAll ( )

Remove all range segments.

Returns
None.