Search Results for

    Show / Hide Table of Contents

    Interface IPresentationDocumentWrap

    Namespace: IronPPT.Interfaces
    Assembly: IronPPT.dll
    Syntax
    public interface IPresentationDocumentWrap

    Opening, creating, and saving a presentation file go through IPresentationDocumentWrap, the contract that wraps the document-level entry points a developer calls at the start and end of a workflow. It abstracts where a presentation comes from and where it lands, so the code that builds slides does not depend on the file plumbing underneath it. Reach for this contract when reasoning about the open-edit-save lifecycle as a whole rather than any single slide.

    The contract defines four methods that bracket a workflow. OpenDocumentFromFile takes a path and returns an IParentElement, the root of the slide tree to edit; OpenNewDocument returns the same root for a fresh, empty presentation. On the way out, SaveAs writes the presentation to a file path, while Save persists into a supplied IContainer. Because the open methods return an IParentElement, the rest of an editing session works through that container contract, adding and arranging child elements before a save call commits the result.

    The create empty presentation example shows the open-new path, and the add slide how-to covers the editing that happens between opening and saving.

    Methods

    OpenDocumentFromFile(String)

    Declaration
    IParentElement OpenDocumentFromFile(string documentPath)
    Parameters
    Type Name Description
    System.String documentPath
    Returns
    Type Description
    IParentElement

    OpenNewDocument()

    Declaration
    IParentElement OpenNewDocument()
    Returns
    Type Description
    IParentElement

    Save(IContainer)

    Declaration
    void Save(IContainer WordDocument)
    Parameters
    Type Name Description
    IContainer WordDocument

    SaveAs(String)

    Declaration
    void SaveAs(string filePath)
    Parameters
    Type Name Description
    System.String filePath
    ☀
    ☾
    Downloads
    • Download with NuGet
    • Start for Free
    In This Article
    Back to top
    Install with NuGet