Foxit PDF SDK
FoxitPDFSDKPython2.Range Class Reference
Inheritance diagram for FoxitPDFSDKPython2.Range:
FoxitPDFSDKPython2.Base

Public Member Functions

def Range ()
 Constructor.

 
def Range (index)
 Constructor, with a single index.
More...
 
def Range (other)
 Constructor, with another range object.
More...
 
def Range (start_index, end_index, filter)
 Constructor, with a specified index range.
More...
 
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...
 

Static Public Attributes

 e_Even = _fsdk.Range_e_Even
 Only even numbers in a range will be used (discards odd numbers).

 
 e_Odd = _fsdk.Range_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 FoxitPDFSDKPython2.HeaderFooter , index values specified in this range represent page numbers directly instead of page indexes.

See also
FoxitPDFSDKPython2.HeaderFooter

Constructor & Destructor Documentation

◆ Range() [1/3]

def FoxitPDFSDKPython2.Range.Range (   index)

Constructor, with a single index.

Parameters
[in]indexA single index.

◆ Range() [2/3]

def FoxitPDFSDKPython2.Range.Range (   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 FoxitPDFSDKPython2.Range.e_All and this should be one of these values.
Specially, when this value is FoxitPDFSDKPython2.Range.e_Even or FoxitPDFSDKPython2.Range.e_Odd , that means each even or odd number within the specified range segment will be treated as a single segment.

◆ Range() [3/3]

def FoxitPDFSDKPython2.Range.Range (   other)

Constructor, with another range object.

Parameters
[in]otherAnother range object.

Member Function Documentation

◆ AddSegment()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.Range.e_All and this should be one of these values.
Specially, when this value is FoxitPDFSDKPython2.Range.e_Even or FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.Range.GetSegmentCount ( )

Get the count of range segments.

Returns
The count of range segments.

◆ GetSegmentEnd()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.Range.GetSegmentCount .
Returns
The end index of a specified range segment.

◆ GetSegmentStart()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.Range.GetSegmentCount .
Returns
The start index of a specified range segment.

◆ IsEmpty()

def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.Range.RemoveAll ( )

Remove all range segments.

Returns
None.