Skip to content

DocumentFilters::MakeOutputCanvas method

Creates a new canvas that is used for rendering page content. The output data will be written to the file specified in Filename.

Overloads

MakeOutputCanvas(string, int, string) Create a new canvas writing to a file.
MakeOutputCanvas(stream, int, string) Create a new canvas writing to a stream.

MakeOutputCanvas(string, int, string)

Prototype

Canvas MakeOutputCanvas(string filename, int canvasType, string options)
Canvas MakeOutputCanvas(string filename, int canvasType, string options) throws IGRException;
def MakeOutputCanvas(self, filename: string, canvasType: int, options: string) -> Canvas

Parameters

filename: string : Filename where canvas is to be created

canvasType: int : Indicates the type of output device to create; see Canvas Types for details.

options: string : Semicolon separated list of name value pair options; see Constants and Codes for details.

Return value

Canvas : Canvas


MakeOutputCanvas(stream, int, string)

Prototype

Canvas MakeOutputCanvas(System.IO.Stream stream, int canvasType, string options)
Canvas MakeOutputCanvas(IGRStream stream, int canvasType, string options) throws IGRException;
def MakeOutputCanvas(self, stream: Stream, canvasType: int, options: string) -> Canvas

Parameters

stream: stream : Stream where canvas is to be created

canvasType: int : Indicates the type of output device to create; see Canvas Types for details.

options: string : Semicolon separated list of name value pair options; see Constants and Codes for details.

Return value

Canvas : Canvas


Sample code

var Canvas = Filters.MakeOutputCanvas("C:\\OUTPUT.PDF", IGR_DEVICE_IMAGE_PDF, "");
Canvas.Close();

Additional Information

For output formats that support multiple pages, you may choose to write multiple input documents to a single output document.

See also