GemBox.Document
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    DocumentModelPaginator Class

    Namespace:
    GemBox.Document
    Assembly:
    GemBox.Document.dll

    Provides a functionality to paginate the document content.

    • C#
    • VB.NET
    public sealed class DocumentModelPaginator
    Public NotInheritable Class DocumentModelPaginator
    Inheritance:
    Object
    DocumentModelPaginator

    Properties

    Pages

    Gets the document pages.

    • C#
    • VB.NET
    public ReadOnlyCollection<DocumentModelPage> Pages { get; }
    Public ReadOnly Property Pages As ReadOnlyCollection(Of DocumentModelPage)
    Property Value
    ReadOnlyCollection<DocumentModelPage>

    The document pages.

    Methods

    ConvertToImageSource(ImageSaveOptions)

    Converts single page specified in options of this DocumentModelPaginator instance to an ImageSource instance.

    • C#
    • VB.NET
    public ImageSource ConvertToImageSource(ImageSaveOptions options)
    Public Function ConvertToImageSource(options As ImageSaveOptions) As ImageSource
    Parameters
    options
    ImageSaveOptions

    The options used when converting a single document's page to an image.

    Returns
    ImageSource

    A new ImageSource instance created from a single document's page specified in options.

    See Also
    ImageSaveOptions

    ConvertToXpsDocument(XpsSaveOptions)

    Converts this DocumentModelPaginator instance to an XpsDocument instance.

    • C#
    • VB.NET
    public XpsDocument ConvertToXpsDocument(XpsSaveOptions options)
    Public Function ConvertToXpsDocument(options As XpsSaveOptions) As XpsDocument
    Parameters
    options
    XpsSaveOptions

    The options used when converting to XML Paper Specification (XPS) document.

    Returns
    XpsDocument

    A new XpsDocument instance created from this DocumentModelPaginator instance.

    See Also
    XpsSaveOptions

    Print()

    Prints the paginated document to the default printer.

    • C#
    • VB.NET
    public void Print()
    Public Sub Print

    Print(String)

    Prints the paginated document to the specified printer.

    • C#
    • VB.NET
    public void Print(string printerName)
    Public Sub Print(printerName As String)
    Parameters
    printerName
    String

    Printer name.

    Print(String, PrintOptions)

    Prints the paginated document to the specified printer according to specified options.

    • C#
    • VB.NET
    public void Print(string printerName, PrintOptions options)
    Public Sub Print(printerName As String, options As PrintOptions)
    Parameters
    printerName
    String

    Printer name.

    options
    PrintOptions

    Print options.

    Save(Stream, SaveOptions)

    Saves the paginated document to the specified stream.

    • C#
    • VB.NET
    public void Save(Stream stream, SaveOptions options)
    Public Sub Save(stream As Stream, options As SaveOptions)
    Parameters
    stream
    Stream

    The stream in which to save the paginated document.

    options
    SaveOptions

    The saving options which can be used to define settings for save operation.

    Remarks

    Parameter options, currently, must be of type PdfSaveOptions, XpsSaveOptions or ImageSaveOptions.

    Save(String)

    Saves the paginated document to a file with the specified path. Path must include file extension.

    • C#
    • VB.NET
    public void Save(string path)
    Public Sub Save(path As String)
    Parameters
    path
    String

    The path to which to save the paginated document.

    Remarks

    File extension that is extracted from the path is used to create the appropriate SaveOptions derived class instance that is then passed to the Save(String, SaveOptions) method.

    Following file extensions are supported:

    • Portable Document Format: .pdf
    • XML Paper Specification: .xps
    • Image: .bmp, .gif, .jpg, .jpeg, .png, .tif, .tiff, .wdp
    Exceptions
    InvalidOperationException

    If file extension is not specified or not supported. If file extension is not recognized, use Save(String, SaveOptions) method overload instead.

    Save(String, SaveOptions)

    Saves the paginated document to a file with the specified path.

    • C#
    • VB.NET
    public void Save(string path, SaveOptions options)
    Public Sub Save(path As String, options As SaveOptions)
    Parameters
    path
    String

    The path to which to save the paginated document.

    options
    SaveOptions

    The saving options which can be used to define settings for save operation.

    Remarks

    Parameter options, currently, must be of type PdfSaveOptions, XpsSaveOptions or ImageSaveOptions.

    Examples

    Export Word to ImageSource in WPF
    Export Word to XpsDocument in WPF
    Print Word files in C# and VB.NET
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.