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

    Show / Hide Table of Contents

    PresentationDocumentPaginator Class

    Namespace:
    GemBox.Presentation
    Assembly:
    GemBox.Presentation.dll

    Provides functionality to paginate the presentation content.

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

    Properties

    Pages

    Gets the presentation pages.

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

    The presentation pages.

    Methods

    ConvertToImageSource(ImageSaveOptions)

    Converts single slide specified in options of this PresentationDocumentPaginator instance to an System.Windows.Media.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 presentation's slide to an image.

    Returns
    System.Windows.Media.ImageSource

    A new System.Windows.Media.ImageSource instance created from a single presentation's slide specified in options.

    See Also
    ImageSaveOptions

    ConvertToXpsDocument(XpsSaveOptions)

    Converts this PresentationDocumentPaginator instance to an System.Windows.Xps.Packaging.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
    System.Windows.Xps.Packaging.XpsDocument

    A new System.Windows.Xps.Packaging.XpsDocument instance created from this PresentationDocumentPaginator instance.

    See Also
    XpsSaveOptions

    Print()

    Prints the paginated presentation to the default printer.

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

    Print(String)

    Prints the paginated presentation to the specified printer.

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

    Printer name.

    Print(String, PrintOptions)

    Prints the paginated presentation 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
    System.String

    Printer name.

    options
    PrintOptions

    Print options.

    Save(Stream, SaveOptions)

    Saves the paginated presentation 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
    System.IO.Stream

    The stream in which to save the paginated presentation.

    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 presentation 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
    System.String

    The path to which to save the paginated presentation.

    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
    System.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 presentation 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
    System.String

    The path to which to save the paginated presentation.

    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 PowerPoint in WPF
    Print PowerPoint file in C# and VB.NET
    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.