SKDocument Class

Definition

A high-level API for creating a document-based canvas.

public class SKDocument : SkiaSharp.SKObject
Inheritance

Remarks

For each page, call BeginPage to get the canvas, and then complete the page with a call to EndPage. Finally, call Close to complete the document.

Fields

DefaultRasterDpi

Gets the default DPI for raster graphics.

Methods

Abort()

Stops producing the document immediately.

BeginPage(Single, Single)

Begins a new page for the document, returning the canvas that will draw into the page.

BeginPage(Single, Single, SKRect)

Begins a new page for the document, returning the canvas that will draw into the page.

Close()

Closes the current file or stream holding the document's contents.

CreatePdf(SKWStream)

Create a PDF-backed document, writing the results into a stream.

CreatePdf(SKWStream, Single)

Create a PDF-backed document, writing the results into a stream.

CreatePdf(SKWStream, SKDocumentPdfMetadata)

Create a PDF-backed document, writing the results into a stream.

CreatePdf(SKWStream, SKDocumentPdfMetadata, Single)

Create a PDF-backed document with the specified metadata, writing the results into a stream.

CreatePdf(Stream)

Create a PDF-backed document, writing the results into a stream.

CreatePdf(Stream, Single)

Create a PDF-backed document, writing the results into a stream.

CreatePdf(Stream, SKDocumentPdfMetadata)

Create a PDF-backed document with the specified metadata, writing the results into a stream.

CreatePdf(String)

Create a PDF-backed document, writing the results into a file.

CreatePdf(String, Single)

Create a PDF-backed document, writing the results into a file.

CreatePdf(String, SKDocumentPdfMetadata)

Create a PDF-backed document with the specified metadata, writing the results into a file.

CreateXps(SKWStream)

Create a XPS-backed document, writing the results into a stream.

CreateXps(SKWStream, Single)

Create a XPS-backed document, writing the results into a stream.

CreateXps(Stream)

Create a XPS-backed document, writing the results into a stream.

CreateXps(Stream, Single)

Create a XPS-backed document, writing the results into a stream.

CreateXps(String)

Create a XPS-backed document, writing the results into a file.

CreateXps(String, Single)

Create a XPS-backed document, writing the results into a file.

Dispose()

Releases all resources used by this SKNativeObject.

(Inherited from SKNativeObject)
Dispose(Boolean)

Releases the unmanaged resources used by the SKDocument and optionally releases the managed resources.

EndPage()

Completes the drawing for the current page created by BeginPage(Single, Single).

Properties

Handle

Gets or sets the handle to the underlying native object.

(Inherited from SKObject)
OwnsHandle

Gets a value indicating whether this object should destroy the underlying native object.

(Inherited from SKObject)

Applies to