NPOI.OOXML.XML

Raw

<? xml version = " 1.0 " ?>

< doc >

< assembly >

< name >NPOI.OOXML</ name >

</ assembly >

< members >

< member name = " T:NPOI.POIXMLDocumentPart " >

Represents an entry of a OOXML namespace.

Each POIXMLDocumentPart keeps a reference to the underlying a {@link org.apache.poi.openxml4j.opc.PackagePart}.

@author Yegor Kozlov

</ member >

< member name = " F:NPOI.POIXMLDocumentPart.relationCounter " >

Counter that provides the amount of incoming relations from other parts

to this part.

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.OPCPackage) " >

Construct POIXMLDocumentPart representing a "core document" namespace part.

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.#ctor " >

Creates new POIXMLDocumentPart - called by client code to create new parts from scratch.

@see #CreateRelationship(POIXMLRelation, POIXMLFactory, int, bool)

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.#ctor(NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship) " >

Creates an POIXMLDocumentPart representing the given namespace part and relationship.

Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.

@param part - The namespace part that holds xml data represenring this sheet.

@param rel - the relationship of the given namespace part

@see #read(POIXMLFactory, java.util.Map)

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.#ctor(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackagePart,NPOI.OpenXml4Net.OPC.PackageRelationship) " >

Creates an POIXMLDocumentPart representing the given namespace part, relationship and parent

Called by {@link #read(POIXMLFactory, java.util.Map)} when Reading in an exisiting file.

@param parent - Parent part

@param part - The namespace part that holds xml data represenring this sheet.

@param rel - the relationship of the given namespace part

@see #read(POIXMLFactory, java.util.Map)

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.Rebase(NPOI.OpenXml4Net.OPC.OPCPackage) " >

When you open something like a theme, call this to

re-base the XML Document onto the core child of the

current core document

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.GetPackagePart " >

Provides access to the underlying PackagePart

@return the underlying PackagePart

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.GetPackageRelationship " >

Provides access to the PackageRelationship that identifies this POIXMLDocumentPart

@return the PackageRelationship that identifies this POIXMLDocumentPart

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.GetRelations " >

Returns the list of child relations for this POIXMLDocumentPart

@return child relations

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.GetRelationById(System.String) " >

Returns the target {@link POIXMLDocumentPart}, where a

{@link PackageRelationship} is set from the {@link PackagePart} of this

{@link POIXMLDocumentPart} to the {@link PackagePart} of the target

{@link POIXMLDocumentPart} with a {@link PackageRelationship#GetId()}

matching the given parameter value.

@param id

The relation id to look for

@return the target part of the relation, or null, if none exists

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.GetRelationId(NPOI.POIXMLDocumentPart) " >

Returns the {@link PackageRelationship#GetId()} of the

{@link PackageRelationship}, that sources from the {@link PackagePart} of

this {@link POIXMLDocumentPart} to the {@link PackagePart} of the given

parameter value.

@param part

The {@link POIXMLDocumentPart} for which the according

relation-id shall be found.

@return The value of the {@link PackageRelationship#GetId()} or null, if

parts are not related.

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.AddRelation(System.String,NPOI.POIXMLDocumentPart) " >

Add a new child POIXMLDocumentPart

@param part the child to add

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart) " >

Remove the relation to the specified part in this namespace and remove the

part, if it is no longer needed.

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.RemoveRelation(NPOI.POIXMLDocumentPart,System.Boolean) " >

Remove the relation to the specified part in this namespace and remove the

part, if it is no longer needed and flag is set to true.

@param part

The related part, to which the relation shall be Removed.

@param RemoveUnusedParts

true, if the part shall be Removed from the namespace if not

needed any longer.

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.GetParent " >

Returns the parent POIXMLDocumentPart. All parts except root have not-null parent.

@return the parent POIXMLDocumentPart or < code >null</ code > for the root element.

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.Commit " >

Save the content in the underlying namespace part.

Default implementation is empty meaning that the namespace part is left unmodified.

Sub-classes should override and add logic to marshal the "model" into Ooxml4J.

For example, the code saving a generic XML entry may look as follows:

< pre >< code >

protected void commit() {

PackagePart part = GetPackagePart();

Stream out = part.GetStream();

XmlObject bean = GetXmlBean(); //the "model" which holds Changes in memory

bean.save(out, DEFAULT_XML_OPTIONS);

out.close();

}

</ code ></ pre >

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.OnSave(System.Collections.Generic.List{NPOI.OpenXml4Net.OPC.PackagePart}) " >

Save Changes in the underlying OOXML namespace.

Recursively fires {@link #commit()} for each namespace part

@param alreadySaved context set Containing already visited nodes

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory) " >

Create a new child POIXMLDocumentPart

@param descriptor the part descriptor

@param factory the factory that will create an instance of the requested relation

@return the Created child POIXMLDocumentPart

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.CreateRelationship(NPOI.POIXMLRelation,NPOI.POIXMLFactory,System.Int32,System.Boolean) " >

Create a new child POIXMLDocumentPart

@param descriptor the part descriptor

@param factory the factory that will create an instance of the requested relation

@param idx part number

@param noRelation if true, then no relationship is Added.

@return the Created child POIXMLDocumentPart

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.Read(NPOI.POIXMLFactory,System.Collections.Generic.Dictionary{NPOI.OpenXml4Net.OPC.PackagePart,NPOI.POIXMLDocumentPart}) " >

Iterate through the underlying PackagePart and create child POIXMLFactory instances

using the specified factory

@param factory the factory object that Creates POIXMLFactory instances

@param context context map Containing already visited noted keyed by tarGetURI

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.GetTargetPart(NPOI.OpenXml4Net.OPC.PackageRelationship) " >

Get the PackagePart that is the target of a relationship.

@param rel The relationship

@return The target part

@throws InvalidFormatException

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.OnDocumentCreate " >

Fired when a new namespace part is Created

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.OnDocumentRead " >

Fired when a namespace part is read

</ member >

< member name = " M:NPOI.POIXMLDocumentPart.onDocumentRemove " >

Fired when a namespace part is about to be Removed from the namespace

</ member >

< member name = " F:NPOI.POIXMLDocument.pkg " >

The OPC Package

</ member >

< member name = " F:NPOI.POIXMLDocument.properties " >

The properties of the OPC namespace, opened as needed

</ member >

< member name = " M:NPOI.POIXMLDocument.OpenPackage(System.String) " >

Wrapper to open a namespace, returning an IOException

in the event of a problem.

Works around shortcomings in java's this() constructor calls

</ member >

< member name = " M:NPOI.POIXMLDocument.GetRelatedByType(System.String) " >

Retrieves all the PackageParts which are defined as

relationships of the base document with the

specified content type.

</ member >

< member name = " M:NPOI.POIXMLDocument.HasOOXMLHeader(System.IO.Stream) " >

Checks that the supplied Stream (which MUST

support mark and reSet, or be a PushbackStream)

has a OOXML (zip) header at the start of it.

If your Stream does not support mark / reSet,

then wrap it in a PushBackStream, then be

sure to always use that, and not the original!

@param inp An Stream which supports either mark/reSet, or is a PushbackStream

</ member >

< member name = " M:NPOI.POIXMLDocument.GetProperties " >

Get the document properties. This gives you access to the

core ooxml properties, and the extended ooxml properties.

</ member >

< member name = " M:NPOI.POIXMLDocument.GetAllEmbedds " >

Get the document's embedded files.

</ member >

< member name = " M:NPOI.POIXMLDocument.Write(System.IO.Stream) " >

Write out this document to an Outputstream.

@param stream - the java Stream you wish to write the file to

@exception IOException if anything can't be written.

</ member >

< member name = " T:NPOI.POIXMLFactory " >

Defines a factory API that enables sub-classes to create instances of < code >POIXMLDocumentPart</ code >

@author Yegor Kozlov

</ member >

< member name = " M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLDocumentPart,NPOI.OpenXml4Net.OPC.PackageRelationship,NPOI.OpenXml4Net.OPC.PackagePart) " >

Create a POIXMLDocumentPart from existing namespace part and relation. This method is called

from {@link POIXMLDocument#load(POIXMLFactory)} when parsing a document

@param parent parent part

@param rel the namespace part relationship

@param part the PackagePart representing the Created instance

@return A new instance of a POIXMLDocumentPart.

</ member >

< member name = " M:NPOI.POIXMLFactory.CreateDocumentPart(NPOI.POIXMLRelation) " >

Create a new POIXMLDocumentPart using the supplied descriptor. This method is used when Adding new parts

to a document, for example, when Adding a sheet to a workbook, slide to a presentation, etc.

@param descriptor describes the object to create

@return A new instance of a POIXMLDocumentPart.

</ member >

< member name = " T:NPOI.CoreProperties " >

The core document properties

</ member >

< member name = " T:NPOI.ExtendedProperties " >

Extended document properties

</ member >

< member name = " T:NPOI.CustomProperties " >

Custom document properties

</ member >

< member name = " F:NPOI.CustomProperties.FORMAT_ID " >

Each custom property element Contains an fmtid attribute

with the same GUID value ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}).

</ member >

< member name = " M:NPOI.CustomProperties.Add(System.String) " >

Add a new property

@param name the property name