Foxit PDF SDK
fsdk.PrintParams Class Reference

Public Member Functions

def GetBinding ()
 Get the value determines the paper binding direction and the page arrange order. More...
 
def GetBooklet_duplex_mode ()
 Get the value determines the duplex printing mode when printing a booklet. More...
 
def GetDuplex_type ()
 Get sets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed. More...
 
def GetHandling ()
 Get the print handling type. More...
 
def GetIs_print_as_image ()
 Get true means that pages should be printed as image. More...
 
def GetIs_print_auto_center ()
 Get true means that each page is automatically centered relative to the paper. More...
 
def GetIs_print_auto_rotate ()
 Get true means that automatically rotates each page to match the page orientation to the available paper area during Multiple Pages Per Sheet printing. More...
 
def GetIs_print_page_border ()
 Get a boolean value that if true, draws and prints a page boundary around each of the pages during Multiple Pages Per Sheet printing. More...
 
def GetIs_reverse ()
 Get true means that the printing order should be from parameter end to parameter start. More...
 
def GetIs_show_ui ()
 Get true means that a UI should be presented to the user to obtain printing information and confirm the action. More...
 
def GetIs_simulate_overprinting ()
 Get true means to do overprint preview when printing. More...
 
def GetIs_tile_label ()
 Get label each page of tiled output. More...
 
def GetNum_copies ()
 Get the number of copies to be printed. More...
 
def GetNum_pages_h ()
 Get the number of pages to lay out in the horizontal direction when printing Multiple Pages Per Sheet. More...
 
def GetNum_pages_v ()
 Get the number of pages to lay out in the vertical direction when printing Multiple Pages Per Sheet. More...
 
def GetOutput_file_name ()
 Get the device-independent path for a file name to be used instead of sending the print job to the printer (Print to File). More...
 
def GetPage_order ()
 Get the value determines how the multiple pages are laid out on the sheet. More...
 
def GetPage_range ()
 Get a range object to specify the page range for printing. More...
 
def GetPrint_content ()
 Get specif content for printing. More...
 
def GetPrinter_name ()
 Get the default printer name for printing. More...
 
def GetTile_mark ()
 Get true means to cut the page, and false means not. More...
 
def GetTile_overlap ()
 Get the number of points that tiled pages have in common. More...
 
def GetTile_scale ()
 Get the amount that tiled pages are scaled. More...
 
def SetBinding (value)
 Set the value determines the paper binding direction and the page arrange order. More...
 
def SetBooklet_duplex_mode (value)
 Set the value determines the duplex printing mode when printing a booklet. More...
 
def SetDuplex_type (value)
 Set sets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed. More...
 
def SetHandling (value)
 Set the print handling type. More...
 
def SetIs_print_as_image (value)
 Set true means that pages should be printed as image. More...
 
def SetIs_print_auto_center (value)
 Set true means that each page is automatically centered relative to the paper. More...
 
def SetIs_print_auto_rotate (value)
 Set true means that automatically rotates each page to match the page orientation to the available paper area during Multiple Pages Per Sheet printing. More...
 
def SetIs_print_page_border (value)
 Set a boolean value that if true, draws and prints a page boundary around each of the pages during Multiple Pages Per Sheet printing. More...
 
def SetIs_reverse (value)
 Set true means that the printing order should be from parameter end to parameter start. More...
 
def SetIs_show_ui (value)
 Set true means that a UI should be presented to the user to obtain printing information and confirm the action. More...
 
def SetIs_simulate_overprinting (value)
 Set true means to do overprint preview when printing. More...
 
def SetIs_tile_label (value)
 Set label each page of tiled output. More...
 
def SetNum_copies (value)
 Set the number of copies to be printed. More...
 
def SetNum_pages_h (value)
 Set the number of pages to lay out in the horizontal direction when printing Multiple Pages Per Sheet. More...
 
def SetNum_pages_v (value)
 Set the number of pages to lay out in the vertical direction when printing Multiple Pages Per Sheet. More...
 
def SetOutput_file_name (value)
 Set the device-independent path for a file name to be used instead of sending the print job to the printer (Print to File). More...
 
def SetPage_order (value)
 Set the value determines how the multiple pages are laid out on the sheet. More...
 
def SetPage_range (value)
 Set a range object to specify the page range for printing. More...
 
def SetPrint_content (value)
 Set specif content for printing. More...
 
def SetPrinter_name (value)
 Set the default printer name for printing. More...
 
def SetTile_mark (value)
 Set true means to cut the page, and false means not. More...
 
def SetTile_overlap (value)
 Set the number of points that tiled pages have in common. More...
 
def SetTile_scale (value)
 Set the amount that tiled pages are scaled. More...
 

Detailed Description

This class represents print parameters.

Member Function Documentation

◆ GetBinding()

fsdk.PrintParams.GetBinding ( )

Get the value determines the paper binding direction and the page arrange order.

Returns
The value determines the paper binding direction and the page arrange order. Please refer to values starting from fsdk.PrintParamsE_BookletBindingRight and this should be one of these values.

◆ GetBooklet_duplex_mode()

fsdk.PrintParams.GetBooklet_duplex_mode ( )

Get the value determines the duplex printing mode when printing a booklet.

Returns
The value determines the duplex printing mode when printing a booklet.Please refer to values starting from fsdk.PrintParamsE_BookletDuplexModeBothSides and this should be one of these values.

◆ GetDuplex_type()

fsdk.PrintParams.GetDuplex_type ( )

Get sets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed.

Returns
Sets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed. Please refer to values starting from fsdk.PrintParamsE_DuplexTypeSimplex and this should be one of these values.

◆ GetHandling()

fsdk.PrintParams.GetHandling ( )

Get the print handling type.

Returns
The print handling type.Please refer to values starting from fsdk.PrintParamsE_PrintHandlingNone and this should be one of these values.

◆ GetIs_print_as_image()

fsdk.PrintParams.GetIs_print_as_image ( )

Get true means that pages should be printed as image.

Returns
true means that pages should be printed as image.

◆ GetIs_print_auto_center()

fsdk.PrintParams.GetIs_print_auto_center ( )

Get true means that each page is automatically centered relative to the paper.

Returns
true means that each page is automatically centered relative to the paper.

◆ GetIs_print_auto_rotate()

fsdk.PrintParams.GetIs_print_auto_rotate ( )

Get true means that automatically rotates each page to match the page orientation to the available paper area during Multiple Pages Per Sheet printing.

Returns
true means that automatically rotates each page to match the page orientation to the available paper area during Multiple Pages Per Sheet printing. false means not.

◆ GetIs_print_page_border()

fsdk.PrintParams.GetIs_print_page_border ( )

Get a boolean value that if true, draws and prints a page boundary around each of the pages during Multiple Pages Per Sheet printing.

Returns
A boolean value that if true, draws and prints a page boundary around each of the pages during Multiple Pages Per Sheet printing.

◆ GetIs_reverse()

fsdk.PrintParams.GetIs_reverse ( )

Get true means that the printing order should be from parameter end to parameter start.

Returns
true means that the printing order should be from parameter end to parameter start.

◆ GetIs_show_ui()

fsdk.PrintParams.GetIs_show_ui ( )

Get true means that a UI should be presented to the user to obtain printing information and confirm the action.

Returns
true means that a UI should be presented to the user to obtain printing information and confirm the action.

◆ GetIs_simulate_overprinting()

fsdk.PrintParams.GetIs_simulate_overprinting ( )

Get true means to do overprint preview when printing.

Returns
true means to do overprint preview when printing. false means not.

◆ GetIs_tile_label()

fsdk.PrintParams.GetIs_tile_label ( )

Get label each page of tiled output.

Returns
Label each page of tiled output. Labeled pages indicate row and column, file name, and print date.

◆ GetNum_copies()

fsdk.PrintParams.GetNum_copies ( )

Get the number of copies to be printed.

Returns
The number of copies to be printed.

◆ GetNum_pages_h()

fsdk.PrintParams.GetNum_pages_h ( )

Get the number of pages to lay out in the horizontal direction when printing Multiple Pages Per Sheet.

Returns
The number of pages to lay out in the horizontal direction when printing Multiple Pages Per Sheet.

◆ GetNum_pages_v()

fsdk.PrintParams.GetNum_pages_v ( )

Get the number of pages to lay out in the vertical direction when printing Multiple Pages Per Sheet.

Returns
The number of pages to lay out in the vertical direction when printing Multiple Pages Per Sheet.

◆ GetOutput_file_name()

fsdk.PrintParams.GetOutput_file_name ( )

Get the device-independent path for a file name to be used instead of sending the print job to the printer (Print to File).

Returns
The device-independent path for a file name to be used instead of sending the print job to the printer (Print to File).

◆ GetPage_order()

fsdk.PrintParams.GetPage_order ( )

Get the value determines how the multiple pages are laid out on the sheet.

Returns
The value determines how the multiple pages are laid out on the sheet. Please refer to values starting from fsdk.PrintParamsE_PageOrderHorizontal and this should be one of these values.

◆ GetPage_range()

fsdk.PrintParams.GetPage_range ( )

Get a range object to specify the page range for printing.

Returns
A range object to specify the page range for printing. All the indexes represented in this range would start from 0 and less than page count of the specified document.

◆ GetPrint_content()

fsdk.PrintParams.GetPrint_content ( )

Get specif content for printing.

Returns
Specif content for printing. Please refer to values starting from fsdk.PrintParamsE_PrintContentDocument and this should be one of these values.

◆ GetPrinter_name()

fsdk.PrintParams.GetPrinter_name ( )

Get the default printer name for printing.

Returns
The default printer name for printing.

◆ GetTile_mark()

fsdk.PrintParams.GetTile_mark ( )

Get true means to cut the page, and false means not.

Returns
true means to cut the page, and false means not.

◆ GetTile_overlap()

fsdk.PrintParams.GetTile_overlap ( )

Get the number of points that tiled pages have in common.

Returns
The number of points that tiled pages have in common.

◆ GetTile_scale()

fsdk.PrintParams.GetTile_scale ( )

Get the amount that tiled pages are scaled.

Returns
The amount that tiled pages are scaled.

◆ SetBinding()

fsdk.PrintParams.SetBinding (   value)

Set the value determines the paper binding direction and the page arrange order.

Parameters
[in]valueThe value determines the paper binding direction and the page arrange order. Please refer to values starting from fsdk.PrintParamsE_BookletBindingRight and this should be one of these values.
Returns
None.

◆ SetBooklet_duplex_mode()

fsdk.PrintParams.SetBooklet_duplex_mode (   value)

Set the value determines the duplex printing mode when printing a booklet.

Parameters
[in]valueThe value determines the duplex printing mode when printing a booklet.Please refer to values starting from fsdk.PrintParamsE_BookletDuplexModeBothSides and this should be one of these values.
Returns
None.

◆ SetDuplex_type()

fsdk.PrintParams.SetDuplex_type (   value)

Set sets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed.

Parameters
[in]valueSets the printing duplex mode to simplex, duplex long edge, or duplex short edge feed. Please refer to values starting from fsdk.PrintParamsE_DuplexTypeSimplex and this should be one of these values.
Returns
None.

◆ SetHandling()

fsdk.PrintParams.SetHandling (   value)

Set the print handling type.

Parameters
[in]valueThe print handling type.Please refer to values starting from fsdk.PrintParamsE_PrintHandlingNone and this should be one of these values.
Returns
None.

◆ SetIs_print_as_image()

fsdk.PrintParams.SetIs_print_as_image (   value)

Set true means that pages should be printed as image.

Parameters
[in]valuetrue means that pages should be printed as image.
Returns
None.

◆ SetIs_print_auto_center()

fsdk.PrintParams.SetIs_print_auto_center (   value)

Set true means that each page is automatically centered relative to the paper.

Parameters
[in]valuetrue means that each page is automatically centered relative to the paper.
Returns
None.

◆ SetIs_print_auto_rotate()

fsdk.PrintParams.SetIs_print_auto_rotate (   value)

Set true means that automatically rotates each page to match the page orientation to the available paper area during Multiple Pages Per Sheet printing.

Parameters
[in]valuetrue means that automatically rotates each page to match the page orientation to the available paper area during Multiple Pages Per Sheet printing. false means not.
Returns
None.

◆ SetIs_print_page_border()

fsdk.PrintParams.SetIs_print_page_border (   value)

Set a boolean value that if true, draws and prints a page boundary around each of the pages during Multiple Pages Per Sheet printing.

Parameters
[in]valueA boolean value that if true, draws and prints a page boundary around each of the pages during Multiple Pages Per Sheet printing.
Returns
None.

◆ SetIs_reverse()

fsdk.PrintParams.SetIs_reverse (   value)

Set true means that the printing order should be from parameter end to parameter start.

Parameters
[in]valuetrue means that the printing order should be from parameter end to parameter start.
Returns
None.

◆ SetIs_show_ui()

fsdk.PrintParams.SetIs_show_ui (   value)

Set true means that a UI should be presented to the user to obtain printing information and confirm the action.

Parameters
[in]valuetrue means that a UI should be presented to the user to obtain printing information and confirm the action.
Returns
None.

◆ SetIs_simulate_overprinting()

fsdk.PrintParams.SetIs_simulate_overprinting (   value)

Set true means to do overprint preview when printing.

Parameters
[in]valuetrue means to do overprint preview when printing. false means not.
Returns
None.

◆ SetIs_tile_label()

fsdk.PrintParams.SetIs_tile_label (   value)

Set label each page of tiled output.

Parameters
[in]valueLabel each page of tiled output. Labeled pages indicate row and column, file name, and print date.
Returns
None.

◆ SetNum_copies()

fsdk.PrintParams.SetNum_copies (   value)

Set the number of copies to be printed.

Parameters
[in]valueThe number of copies to be printed.
Returns
None.

◆ SetNum_pages_h()

fsdk.PrintParams.SetNum_pages_h (   value)

Set the number of pages to lay out in the horizontal direction when printing Multiple Pages Per Sheet.

Parameters
[in]valueThe number of pages to lay out in the horizontal direction when printing Multiple Pages Per Sheet.
Returns
None.

◆ SetNum_pages_v()

fsdk.PrintParams.SetNum_pages_v (   value)

Set the number of pages to lay out in the vertical direction when printing Multiple Pages Per Sheet.

Parameters
[in]valueThe number of pages to lay out in the vertical direction when printing Multiple Pages Per Sheet.
Returns
None.

◆ SetOutput_file_name()

fsdk.PrintParams.SetOutput_file_name (   value)

Set the device-independent path for a file name to be used instead of sending the print job to the printer (Print to File).

Parameters
[in]valueThe device-independent path for a file name to be used instead of sending the print job to the printer (Print to File).
Returns
None.

◆ SetPage_order()

fsdk.PrintParams.SetPage_order (   value)

Set the value determines how the multiple pages are laid out on the sheet.

Parameters
[in]valueThe value determines how the multiple pages are laid out on the sheet. Please refer to values starting from fsdk.PrintParamsE_PageOrderHorizontal and this should be one of these values.
Returns
None.

◆ SetPage_range()

fsdk.PrintParams.SetPage_range (   value)

Set a range object to specify the page range for printing.

Parameters
[in]valueA range object to specify the page range for printing. All the indexes represented in this range would start from 0 and less than page count of the specified document.
Returns
None.

◆ SetPrint_content()

fsdk.PrintParams.SetPrint_content (   value)

Set specif content for printing.

Parameters
[in]valueSpecif content for printing. Please refer to values starting from fsdk.PrintParamsE_PrintContentDocument and this should be one of these values.
Returns
None.

◆ SetPrinter_name()

fsdk.PrintParams.SetPrinter_name (   value)

Set the default printer name for printing.

Parameters
[in]valueThe default printer name for printing.
Returns
None.

◆ SetTile_mark()

fsdk.PrintParams.SetTile_mark (   value)

Set true means to cut the page, and false means not.

Parameters
[in]valuetrue means to cut the page, and false means not.
Returns
None.

◆ SetTile_overlap()

fsdk.PrintParams.SetTile_overlap (   value)

Set the number of points that tiled pages have in common.

Parameters
[in]valueThe number of points that tiled pages have in common.
Returns
None.

◆ SetTile_scale()

fsdk.PrintParams.SetTile_scale (   value)

Set the amount that tiled pages are scaled.

Parameters
[in]valueThe amount that tiled pages are scaled.
Returns
None.