Foxit PDF SDK
fsdk.PageNumberRange Class Reference

Public Member Functions

def GetEnd_number ()
 Get page number of the end page in current range, starting from 1. More...
 
def GetFilter ()
 Get filter type to decide which page numbers of this range would be used. More...
 
def GetStart_number ()
 Get page number of the start page in current range, starting from 1. More...
 
def Set (start_number, end_number, filter)
 Set value.
More...
 
def SetEnd_number (value)
 Set page number of the end page in current range, starting from 1. More...
 
def SetFilter (value)
 Set filter type to decide which page numbers of this range would be used. More...
 
def SetStart_number (value)
 Set page number of the start page in current range, starting from 1. More...
 

Detailed Description

This class represents the page number range (not index range) which is used for class HeaderFooter .

See also
HeaderFooter

Member Function Documentation

◆ GetEnd_number()

fsdk.PageNumberRange.GetEnd_number ( )

Get page number of the end page in current range, starting from 1.

Returns
Page number of the end page in current range, starting from 1.

◆ GetFilter()

fsdk.PageNumberRange.GetFilter ( )

Get filter type to decide which page numbers of this range would be used.

Returns
Filter type to decide which page numbers of this range would be used. Please refer to values starting from fsdk.RangeE_All and this should be one of these values.

◆ GetStart_number()

fsdk.PageNumberRange.GetStart_number ( )

Get page number of the start page in current range, starting from 1.

Returns
Page number of the start page in current range, starting from 1.

◆ Set()

def fsdk.PageNumberRange.Set (   start_number,
  end_number,
  filter 
)

Set value.

Parameters
[in]start_numberPage number of the start page in current range, starting from 1.
[in]end_numberPage number of the end page in current range, starting from 1.
[in]filterFilter type to decide which page numbers of this range would be used. Please refer to values starting from fsdk.RangeE_All and this should be one of these values.
Returns
None.

◆ SetEnd_number()

fsdk.PageNumberRange.SetEnd_number (   value)

Set page number of the end page in current range, starting from 1.

Parameters
[in]valuePage number of the end page in current range, starting from 1.
Returns
None.

◆ SetFilter()

fsdk.PageNumberRange.SetFilter (   value)

Set filter type to decide which page numbers of this range would be used.

Parameters
[in]valueFilter type to decide which page numbers of this range would be used. Please refer to values starting from fsdk.RangeE_All and this should be one of these values.
Returns
None.

◆ SetStart_number()

fsdk.PageNumberRange.SetStart_number (   value)

Set page number of the start page in current range, starting from 1.

Parameters
[in]valuePage number of the start page in current range, starting from 1.
Returns
None.