<?xml version="1.0"?>
<doc>
<assembly>
<name>NPOI</name>
</assembly>
<members>
<member name="T:NPOI.DDF.AbstractEscherOptRecord">
Common abstract class for {@link EscherOptRecord} and
{@link EscherTertiaryOptRecord}
@author Sergey Vladimirov (vlsergey {at} gmail {dot} com)
@author Glen Stampoultzis
</member>
<member name="T:NPOI.DDF.EscherRecord">
<summary>
The base abstract record from which all escher records are defined. Subclasses will need
to define methods for serialization/deserialization and for determining the record size.
@author Glen Stampoultzis
</summary>
</member>
<member name="M:NPOI.DDF.EscherRecord.#ctor">
<summary>
Initializes a new instance of the <see cref="T:NPOI.DDF.EscherRecord"/> class.
</summary>
</member>
<member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],NPOI.DDF.IEscherRecordFactory)">
<summary>
Delegates to FillFields(byte[], int, EscherRecordFactory)
</summary>
<param name="data">The data.</param>
<param name="f">The f.</param>
<returns></returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.FillFields(System.Byte[],System.Int32,NPOI.DDF.IEscherRecordFactory)">
<summary>
The contract of this method is to deSerialize an escher record including
it's children.
</summary>
<param name="data">The byte array containing the Serialized escher
records.</param>
<param name="offset">The offset into the byte array.</param>
<param name="recordFactory">A factory for creating new escher records.</param>
<returns>The number of bytes written.</returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.ReadHeader(System.Byte[],System.Int32)">
<summary>
Reads the 8 byte header information and populates the
<c>options</c>
and
<c>recordId</c>
records.
</summary>
<param name="data">the byte array to Read from</param>
<param name="offset">the offset to start Reading from</param>
<returns>the number of bytes remaining in this record. This</returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.ReadInstance(System.Byte[],System.Int32)">
<summary>
Read the options field from header and return instance part of it.
</summary>
<param name="data">the byte array to read from</param>
<param name="offset">the offset to start reading from</param>
<returns>value of instance part of options field</returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.Serialize">
<summary>
Serializes to a new byte array. This is done by delegating to
Serialize(int, byte[]);
</summary>
<returns>the Serialized record.</returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[])">
<summary>
Serializes to an existing byte array without serialization listener.
This is done by delegating to Serialize(int, byte[], EscherSerializationListener).
</summary>
<param name="offset">the offset within the data byte array.</param>
<param name="data">the data array to Serialize to.</param>
<returns>The number of bytes written.</returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.Serialize(System.Int32,System.Byte[],NPOI.DDF.EscherSerializationListener)">
<summary>
Serializes the record to an existing byte array.
</summary>
<param name="offset">the offset within the byte array.</param>
<param name="data">the offset within the byte array</param>
<param name="listener">a listener for begin and end serialization events. This.
is useful because the serialization is
hierarchical/recursive and sometimes you need to be able
break into that.
</param>
<returns></returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.Clone">
<summary>
Creates a new object that is a copy of the current instance.
</summary>
<returns>
A new object that is a copy of this instance.
</returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.GetChild(System.Int32)">
<summary>
Returns the indexed child record.
</summary>
<param name="index">The index.</param>
<returns></returns>
</member>
<member name="M:NPOI.DDF.EscherRecord.Display(System.Int32)">
<summary>
The display methods allows escher variables to print the record names
according to their hierarchy.
</summary>
<param name="indent">The current indent level.</param>
</member>
<member name="M:NPOI.DDF.EscherRecord.ToXml(System.String)">
@param tab - each children must be a right of his parent
@return xml representation of this record
</member>
<member name="P:NPOI.DDF.EscherRecord.IsContainerRecord">
<summary>
Determine whether this is a container record by inspecting the option
field.
</summary>
<value>
<c>true</c> if this instance is container record; otherwise, <c>false</c>.
</value>
</member>
<member name="P:NPOI.DDF.EscherRecord.Options">
<summary>
Gets or sets the options field for this record. All records have one
</summary>
<value>The options.</value>
</member>
<member name="P:NPOI.DDF.EscherRecord.RecordSize">
<summary>
Subclasses should effeciently return the number of bytes required to
Serialize the record.
</summary>
<value>number of bytes</value>
</member>
<member name="P:NPOI.DDF.EscherRecord.RecordId">
<summary>
Return the current record id.
</summary>
<value>The 16 bit record id.</value>
</member>
<member name="P:NPOI.DDF.EscherRecord.ChildRecords">
<summary>
Gets or sets the child records.
</summary>
<value>Returns the children of this record. By default this will
be an empty list. EscherCotainerRecord is the only record that may contain children.</value>
</member>
<member name="P:NPOI.DDF.EscherRecord.RecordName">
<summary>
Gets the name of the record.
</summary>
<value>The name of the record.</value>
</member>
<member name="P:NPOI.DDF.EscherRecord.Instance">
<summary>
Get or set the instance part of the option record.
</summary>
</member>
<member name="P:NPOI.DDF.EscherRecord.Version">
<summary>
Get or set the version part of the option record.
</summary>
</member>
<member name="T:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader">
<summary>
This class Reads the standard escher header.
</summary>
</member>
<member name="M:NPOI.DDF.EscherRecord.DeleteEscherRecordHeader.ReadHeader(System.Byte[],System.Int32)">
<summary>
Reads the header.
</summary>
<param name="data">The data.</param>