WordprocessingDocument.Open Method (Stream, Boolean, OpenSettings)

Creates a new instance of the WordprocessingDocument class from the IO stream.

Namespace:  DocumentFormat.OpenXml.Packaging
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Shared Function Open ( _
    stream As Stream, _
    isEditable As Boolean, _
    openSettings As OpenSettings _
) As WordprocessingDocument
'Usage
Dim stream As Stream
Dim isEditable As Boolean
Dim openSettings As OpenSettings
Dim returnValue As WordprocessingDocument

returnValue = WordprocessingDocument.Open(stream, isEditable, _
    openSettings)
public static WordprocessingDocument Open(
    Stream stream,
    bool isEditable,
    OpenSettings openSettings
)

Parameters

  • stream
    Type: System.IO.Stream
    The IO stream on which to open the WordprocessingDocument.
  • isEditable
    Type: System.Boolean
    In ReadWrite mode. False for Read only mode.

Return Value

Type: DocumentFormat.OpenXml.Packaging.WordprocessingDocument
A new instance of WordprocessingDocument.

Exceptions

Exception Condition
ArgumentNullException

Thrown when "stream" is null reference.

IOException

Thrown when "stream" is not opened with Read (ReadWrite) access.

OpenXmlPackageException

Thrown when the package is not valid Open XML WordprocessingDocument.

ArgumentException

Thrown when specified to process the markup compatibility but the given target FileFormatVersion is incorrect.

See Also

Reference

WordprocessingDocument Class

WordprocessingDocument Members

Open Overload

DocumentFormat.OpenXml.Packaging Namespace