Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.xdgf.usermodel
Class XmlVisioDocument

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

All Implemented Interfaces:
  java.io.Closeable

    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.POIXMLDocumentPart
`POIXMLDocumentPart.RelationPart`

Field Summary
`protected XDGFDocument` | `_document`
`protected XDGFMasters` | `_masters`
`protected XDGFPages` | `_pages`

Fields inherited from class org.apache.poi.POIXMLDocument
`DOCUMENT_CREATOR, OLE_OBJECT_REL_TYPE, PACK_OBJECT_REL_TYPE`

Constructor Summary
`XmlVisioDocument(java.io.InputStream is)`
`XmlVisioDocument(OPCPackage pkg)`

Method Summary
`java.util.List<PackagePart>` | `getAllEmbedds()` 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.POIXMLDocument
`close, getCorePart, getPackage, getProperties, getRelatedByType, load, openPackage, write`

Methods inherited from class org.apache.poi.POIXMLDocumentPart
`_invokeOnDocumentRead, addRelation, commit, createRelationship, createRelationship, createRelationship, getNextPartNumber, getPackagePart, getParent, getRelationById, getRelationId, getRelationParts, getRelations, getTargetPart, onDocumentCreate, onDocumentRemove, onSave, prepareForCommit, read, rebase, removeRelation, removeRelation, 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()
                           throws java.io.IOException

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

  Overrides:
    `onDocumentRead` in class `POIXMLDocumentPart`
  Throws:
    `java.io.IOException` - a subclass may throw an IOException when a document is read

### getAllEmbedds

    public java.util.List<PackagePart> getAllEmbedds()
                                              throws OpenXML4JException

  Not currently implemented

  Specified by:
    `getAllEmbedds` in class `POIXMLDocument`
  Returns:
    the document's embedded files
  Throws:
    `OpenXML4JException` - if the embedded parts can't be determined

### getPages

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

  Returns:
    pages ordered by page number

### getStyleById

    public XDGFStyleSheet getStyleById(long id)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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