Foxit PDF SDK
|
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). | |
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.
def FoxitPDFSDKPython2.Range.Range | ( | index | ) |
Constructor, with a single index.
[in] | index | A single index. |
def FoxitPDFSDKPython2.Range.Range | ( | 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 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. |
def FoxitPDFSDKPython2.Range.Range | ( | other | ) |
Constructor, with another range object.
[in] | other | Another range object. |
def FoxitPDFSDKPython2.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 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. |
def FoxitPDFSDKPython2.Range.AddSingle | ( | index | ) |
Add an index as a new range segment.
[in] | index | An index to be added as a new range segment. |
def FoxitPDFSDKPython2.Range.GetSegmentCount | ( | ) |
Get the count of range segments.
def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.Range.GetSegmentCount . |
def FoxitPDFSDKPython2.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 FoxitPDFSDKPython2.Range.GetSegmentCount . |
def FoxitPDFSDKPython2.Range.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
def FoxitPDFSDKPython2.Range.RemoveAll | ( | ) |
Remove all range segments.