org.apache.poi.xdgf.usermodel

## Class XmlVisioDocument

- java.lang.Object
- - org.apache.poi.ooxml.POIXMLDocumentPart
  - - org.apache.poi.ooxml.POIXMLDocument
    - - org.apache.poi.xdgf.usermodel.XmlVisioDocument

- All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable

      public class XmlVisioDocument
      extends POIXMLDocument

  This is your high-level starting point for working with Visio XML documents (.vsdx). Currently, only read support has been implemented, and the API is not mature and is subject to change. For more information about the visio XML format (with an XSD 1.0 schema), you can find documentation at https://msdn.microsoft.com/en-us/library/hh645006(v=office.12).aspx That document lacks in some areas, but you can find additional documentation and an updated XSD 1.1 schema at https://msdn.microsoft.com/en-us/library/office/jj684209(v=office.15).aspx Each provides different details, but the SharePoint reference has better documentation and is more useful.

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

      `POIXMLDocumentPart.RelationPart`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected XDGFDocument` | `_document`
    `protected XDGFMasters` | `_masters`
    `protected XDGFPages` | `_pages`

    - ### Fields inherited from class org.apache.poi.ooxml.POIXMLDocument

      `DOCUMENT_CREATOR, OLE_OBJECT_REL_TYPE, PACK_OBJECT_REL_TYPE`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `XmlVisioDocument(java.io.InputStream is)`
    `XmlVisioDocument(OPCPackage pkg)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.util.List<PackagePart>` | `getAllEmbeddedParts()` Not currently implemented
    `java.util.Collection<XDGFPage>` | `getPages()`
    `XDGFStyleSheet` | `getStyleById(long id)`
    `protected void` | `onDocumentRead()` Fired when a package part is read

    - ### Methods inherited from class org.apache.poi.ooxml.POIXMLDocument

      `close, getAllEmbedds, getCorePart, getPackage, getProperties, getRelatedByType, load, openPackage, write`

    - ### Methods inherited from class org.apache.poi.ooxml.POIXMLDocumentPart

      `_invokeOnDocumentRead, addRelation, commit, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationPartById, getRelationParts, getRelations, getTargetPart, isCommited, isCommitted, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, removeRelation, setCommited, setCommitted, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Field Detail

    - #### _pages

          protected XDGFPages _pages

    - #### _masters

          protected XDGFMasters _masters

    - #### _document

          protected XDGFDocument _document

  - ### Constructor Detail

    - #### XmlVisioDocument

          public XmlVisioDocument(OPCPackage pkg)
                           throws java.io.IOException

      Throws:
        `java.io.IOException`

    - #### XmlVisioDocument

          public XmlVisioDocument(java.io.InputStream is)
                           throws java.io.IOException

      Throws:
        `java.io.IOException`

  - ### Method Detail

    - #### onDocumentRead

          protected void onDocumentRead()

      Description copied from class: `POIXMLDocumentPart`
      Fired when a package part is read
      Overrides:
        `onDocumentRead` in class `POIXMLDocumentPart`

    - #### getAllEmbeddedParts

          public java.util.List<PackagePart> getAllEmbeddedParts()

      Not currently implemented
      Specified by:
        `getAllEmbeddedParts` in class `POIXMLDocument`
      Returns:
        the document's embedded files

    - #### getPages

          public java.util.Collection<XDGFPage> getPages()

      Returns:
        pages ordered by page number

    - #### getStyleById

          public XDGFStyleSheet getStyleById(long id)

Copyright 2020 The Apache Software Foundation or its licensors, as applicable.