SKDocument Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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. |
Properties
| Handle |
Gets or sets the handle to the underlying native object. (Inherited from SKObject) |
| IgnorePublicDispose |
Gets or sets a value indicating whether the call the public Dispose() should be no-op. (Inherited from SKNativeObject) |
| IsDisposed |
Gets or sets a value indicating whether the object has already been disposed. (Inherited from SKNativeObject) |
| OwnsHandle |
Gets a value indicating whether this object should destroy the underlying native object. (Inherited from SKObject) |
Methods
| Abort() |
Stops producing the document immediately. |
| BeginPage(Single, Single, SKRect) |
Begins a new page for the document, returning the canvas that will draw into the page. |
| BeginPage(Single, Single) |
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, Single) |
Create a PDF-backed document, writing the results into a stream. |
| CreatePdf(SKWStream, SKDocumentPdfMetadata, Single) |
Obsolete.
Create a PDF-backed document with the specified metadata, writing the results into a stream. |
| CreatePdf(SKWStream, SKDocumentPdfMetadata) |
Create a PDF-backed document, writing the results into a stream. |
| CreatePdf(SKWStream) |
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(Stream) |
Create a PDF-backed document, writing the results into a stream. |
| 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. |
| CreatePdf(String) |
Create a PDF-backed document, writing the results into a file. |
| CreateXps(SKWStream, Single) |
Create a XPS-backed document, writing the results into a stream. |
| CreateXps(SKWStream) |
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(Stream) |
Create a XPS-backed document, writing the results into a stream. |
| CreateXps(String, Single) |
Obsolete.
Create a XPS-backed document, writing the results into a file. |
| CreateXps(String) |
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. |
| DisposeInternal() |
Triggers a dispose, ignoring the value of IgnorePublicDispose. (Inherited from SKNativeObject) |
| DisposeManaged() |
Implemented by derived SKObject types to destroy any managed objects. (Inherited from SKObject) |
| DisposeNative() |
Implemented by derived SKObject types to destroy any native objects. (Inherited from SKObject) |
| DisposeUnownedManaged() | (Inherited from SKObject) |
| EndPage() |
Completes the drawing for the current page created by BeginPage(Single, Single). |
Applies to
SkiaSharp