Creates the most specific {@link PropertySet} from an entry in the specified POIFS Directory. This is preferrably a {@link DocumentSummaryInformation} or a {@link SummaryInformation}. If the specified entry does not contain a property Set stream, an exception is thrown. If no entry is found with the given name, an exception is thrown.

• The other object is not a {@link Section}.
• The format IDs of the two sections are not equal.
• The sections have a different number of properties. However, properties with ID 1 (codepage) are not counted.
• The other object is not a {@link Section}.
• The properties have different values. The order of the properties is irrelevant.

• {@link Thumbnail#CFTAG_WINDOWS}
• {@link Thumbnail#CFTAG_MACINTOSH}
• {@link Thumbnail#CFTAG_NODATA}
• {@link Thumbnail#CFTAG_FMTID}

typedef struct tagCLIPDATA {
             // cbSize is the size of the buffer pointed To
             // by pClipData, plus sizeof(ulClipFmt)
             ULONG              cbSize;
             long               ulClipFmt;
             BYTE*              pClipData;
             } CLIPDATA;

Turns a codepage number into the equivalent character encoding's name.

Returns much (but not all) of the textual content of the file, suitable for indexing by something like Apache Lucene, or used by Apache Tika, but not really intended for display to the user.

The main data of all types of references is stored in the Link Table inside the Workbook Globals Substream (4.2.5). The Link Table itself is optional and occurs only, if there are any references in the document.

In BIFF8 the Link Table consists of

• zero or more EXTERNALBOOK Blocks

  each consisting of

  • exactly one EXTERNALBOOK (0x01AE) record
  • zero or more EXTERNALNAME (0x0023) records
  • zero or more CRN Blocks

    each consisting of

    • exactly one XCT (0x0059)record
    • zero or more CRN (0x005A) records (documentation says one or more)
• zero or one EXTERNSHEET (0x0017) record
• zero or more DEFINEDNAME (0x0018) records

See OOO excelfileformat.pdf sec. 4.2.5 'Record Order in a BIFF8 Workbook Stream' @author Josh Micich Adds the specified new record in the correct place in sheet records list

See OOO exelfileformat.pdf sec 4.12 'Conditional Formatting Table' @author Josh Micich Creates an empty ConditionalFormattingTable @return index of the newly added CF header aggregate Manages the all the records associated with a 'Custom View Settings' sub-stream.
Includes the Initial USERSVIEWBEGIN(0x01AA) and USERSVIEWEND(0x01AB). @author Josh Micich All the records between BOF and EOF

See OOO excelfileformat.pdf sec 4.4 'Page Settings Block' @author Josh Micich Creates a PageSettingsBlock with default settings @return true if the specified Record sid is one belonging to the 'Page Settings Block'. Sets a page break at the indicated column Removes a page break at the indicated column Creates the HCenter Record and sets it to false (don't horizontally center) Creates the VCenter Record and sets it to false (don't horizontally center) Creates the PrintSetup Record and sets it to defaults and marks it invalid @see org.apache.poi.hssf.record.PrintSetupRecord @see org.apache.poi.hssf.record.Record @return record containing a PrintSetupRecord Returns the HeaderRecord. @return HeaderRecord for the sheet. Returns the FooterRecord. @return FooterRecord for the sheet. Returns the PrintSetupRecord. @return PrintSetupRecord for the sheet. Gets the size of the margin in inches. @param margin which margin to Get @return the size of the margin Sets the size of the margin in inches. @param margin which margin to Get @param size the size of the margin Shifts all the page breaks in the range "count" number of rows/columns @param breaks The page record to be shifted @param start Starting "main" value to shift breaks @param stop Ending "main" value to shift breaks @param count number of units (rows/columns) to shift by Sets a page break at the indicated row @param row Removes a page break at the indicated row @param row Queries if the specified row has a page break @param row @return true if the specified row has a page break Queries if the specified column has a page break @return true if the specified column has a page break Shifts the horizontal page breaks for the indicated count @param startingRow @param endingRow @param count Shifts the vertical page breaks for the indicated count @param startingCol @param endingCol @param count @return all the horizontal page breaks, never null @return the number of row page breaks @return all the column page breaks, never null @return the number of column page breaks

The row blocks are goupings of rows that contain the DBCell record after them Returns the number of physical rows within a block Returns the physical row number of the first row in a block Returns the physical row number of the end row in a block Create a row record. @param row number @return RowRecord Created for the passed in row number @see org.apache.poi.hssf.record.RowRecord

This method may also be used for Setting breakpoints to help diagnose Issues regarding the abnormally-Set 'shared formula' flags. (see TestValueRecordsAggregate.testSpuriousSharedFormulaFlag()).

The method currently does nothing but do not delete it without Finding a nice home for this comment. Tallies a count of the size of the cell records that are attached to the rows in the range specified. Returns true if the row has cells attached to it Serializes the cells that are allocated to a certain row range Groups the sheet protection records for a worksheet.

See OOO excelfileformat.pdf sec 4.18.2 'Sheet Protection in a Workbook (BIFF5-BIFF8)' @author Josh Micich Creates an empty WorksheetProtectionBlock @return true if the specified Record sid is one belonging to the 'Page Settings Block'. This method Reads {@link WorksheetProtectionBlock} records from the supplied RecordStream until the first non-WorksheetProtectionBlock record is encountered. As each record is Read, it is incorporated into this WorksheetProtectionBlock.

As per the OOO documentation, the protection block records can be expected to be written toGether (with no intervening records), but earlier versions of POI (prior to Jun 2009) didn't do this. Workbooks with sheet protection Created by those earlier POI versions seemed to be valid (Excel opens them OK). So PO allows continues to support Reading of files with non continuous worksheet protection blocks.

Note - when POI Writes out this WorksheetProtectionBlock, the records will always be written in one consolidated block (in the standard ordering) regardless of how scattered the records were when they were originally Read.

Treated in a similar way to SharedFormulaRecord @author Josh Micich

Description: the default characterset. for the workbook

REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

Use {@link CodePageUtil} to turn these values into Java code pages to encode/decode strings.

Description: Defines with width and formatting for a range of columns

REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

@author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a ColumnInfo record and Sets its fields appropriately @param in the RecordInputstream to Read the record from @return true if the format, options and column width match Get the first column this record defines formatting info for @return the first column index (0-based) Get the last column this record defines formatting info for @return the last column index (0-based) Get the columns' width in 1/256 of a Char width @return column width Get the columns' default format info @return the extended format index @see org.apache.poi.hssf.record.ExtendedFormatRecord Get the options bitfield - use the bitSetters instead @return the bitfield raw value Get whether or not these cells are hidden @return whether the cells are hidden. @see #SetOptions(short) Get the outline level for the cells @see #SetOptions(short) @return outline level for the cells Get whether the cells are collapsed @return wether the cells are collapsed @see #SetOptions(short) FeatFormulaErr2 (Formula Evaluation Shared Feature) common record part This record part specifies Formula Evaluation & Error Ignoring data for a sheet, stored as part of a Shared Feature. It can be found in records such as {@link FeatRecord}. For the full meanings of the flags, see pages 669 and 670 of the Excel binary file format documentation. What errors we should ignore Title: FeatProtection (Protection Shared Feature) common record part This record part specifies Protection data for a sheet, stored as part of a Shared Feature. It can be found in records such as {@link FeatRecord} 0 means no password. Otherwise indicates the password verifier algorithm (same kind as {@link PasswordRecord} and {@link PasswordRev4Record}) Title: FeatSmartTag (Smart Tag Shared Feature) common record part This record part specifies Smart Tag data for a sheet, stored as part of a Shared Feature. It can be found in records such as {@link FeatRecord}. It is made up of a hash, and a Set of Factoid Data that Makes up the smart tags. For more details, see page 669 of the Excel binary file format documentation. Title: FtrHeader (Future Record Header) common record part This record part specifies a header for a Ftr (Future) style record, which includes extra attributes above and beyond those of a traditional record. This MUST match the type on the Containing record This is a FrtFlags MUST be 8 bytes and all zero Common Interface for all Shared Features Title: Unicode String

Description: Unicode String - just standard fields that are in several records. It is considered more desirable then repeating it in all of them.

This is often called a XLUnicodeRichExtendedString in MS documentation.

REFERENCE: PG 264 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

REFERENCE: PG 951 Excel Binary File Format (.xls) Structure Specification v20091214 Returns our size, excluding our 4 byte header Our handling of Equals is inconsistent with CompareTo. The trouble is because we don't truely understand rich text fields yet it's difficult to make a sound comparison. @param o The object to Compare. @return true if the object is actually Equal. construct a unicode string record and fill its fields, ID is ignored @param in the RecordInputstream to read the record from get the number of characters in the string, as an un-wrapped int @return number of characters Get the option flags which among other things return if this is a 16-bit or 8 bit string @return optionflags bitmask @return the actual string this Contains as a java String object Adds a font run to the formatted string. If a font run exists at the current charcter location, then it is Replaced with the font run to be Added. Swaps all use in the string of one font index for use of a different font index. Normally only called when fonts have been Removed / re-ordered unlike the real records we return the same as "getString()" rather than debug info @see #getDebugInfo() @return String value of the record return a character representation of the fields of this record @return String of output for biffviewer etc. Serialises out the String. There are special rules about where we can and can't split onto Continue records.

Most records construct themselves from {@link RecordInputStream}. This class assumes that a {@link ContinueRecord} record break always occurs at the type boundary, however, it is not always so.

{@link RecordInputStream} greedily requests the bytes to be read and stumbles on such files with a "Not enough data (1) to read requested (2) bytes" exception. The ContinuableRecordInput class circumvents this "type boundary" rule and Reads data byte-by-byte rolling over CONTINUE if necessary.

YK: For now (March 2011) this class is only used to read @link NPOI.HSSF.Record.Common.UnicodeString.ExtRst} blocks of a UnicodeString.

• byte optionFlags
• encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)

• The value of the 'is16bitEncoded' flag is determined by the actual character data of text
• The string options flag is never separated (by a {@link ContinueRecord}) from the first chunk of character data it refers to.
• The 'ushort Length' field is assumed to have been explicitly written earlier. Hence, there may be an intervening {@link ContinueRecord}

• ushort Length
• byte optionFlags
• ushort numberOfRichTextRuns (optional)
• ushort extendedDataSize (optional)
• encoded character data (in "ISO-8859-1" or "UTF-16LE" encoding)

• The value of the 'is16bitEncoded' flag is determined by the actual character data of text
• The string header fields are never separated (by a {@link ContinueRecord}) from the first chunk of character data (i.e. the first character is always encoded in the same record as the string header).

                     _______________________________
                    |          DConRef              |
            (bytes) +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
                    |    ref    |cch|  stFile   | un|
                    +-+-+-+-+-+-+-+-+-+-+...+-+-+-+-+
                                          |
                                 _________|_____________________
                                |DConFile / XLUnicodeStringNoCch|
                                +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
                         (bits) |h|   reserved  |      rgb      |
                                +-+-+-+-+-+-+-+-+-+-+-+...+-+-+-+
             

• DConFile.h = 0x00 if the characters inrgb are single byte, and DConFile.h = 0x01 if they are double byte.
  If they are double byte, then
  
  • If it exists, the length of DConRef.un = 2. Otherwise it is 1.
  • The length of DConFile.rgb = (2 * DConRef.cch). Otherwise it is equal to DConRef.cch
  .
• DConRef.rgb starts with 0x01 if it is an external reference, and with 0x02 if it is a self-reference.

@see DConFile [MS-XLS s. 2.5.77] and VirtualPath [MS-XLS s. 2.5.69]

unused bits at the end, must be set to 0. Read constructor. @param data byte array containing a DConRef Record, including the header. Read Constructor. @param inStream RecordInputStream containing a DConRefRecord structure. @return The first column of the range. @return The first row of the range. @return The last column of the range. @return The last row of the range. @return raw path byte array. @return the link's path, with the special characters stripped/replaced. May be null. See MS-XLS 2.5.277 (VirtualPath) Checks if the data source in this reference record is external to this sheet or internal. @return true iff this is an external reference. Title: Default Column Width Record Description: Specifies the default width for columns that have no specific width Set. REFERENCE: PG 302 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre The default column width is 8 characters Constructs a DefaultColumnWidth record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the default column width @return defaultwidth for columns Title: Default Row Height Record Description: Row height for rows with Undefined or not explicitly defined heights. REFERENCE: PG 301 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre The default row height for empty rows is 255 twips (255 / 20 == 12.75 points)

Cloning of drawing records must be executed through HSSFPatriarch, because all id's must be changed @return cloned drawing records This Is purely for the biff viewer. During normal operations we don't want to be seeing this.

Description: This record stores data validation Settings and a list of cell ranges which contain these Settings. The data validation Settings of a sheet are stored in a sequential list of DV records. This list Is followed by DVAL record(s) @author Dragos Buleandra (dragos.buleandra@trade2b.ro) @version 2.0-pre Option flags Title of the prompt box Title of the error box Text of the prompt box Text of the error box Not used - Excel seems to always write 0x3FE0 Formula data for first condition (RPN token array without size field) Not used - Excel seems to always write 0x0000 Formula data for second condition (RPN token array without size field) Cell range address list with all affected ranges Option flags field @see org.apache.poi.hssf.util.HSSFDataValidation utility class Constructs a DV record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from When entered via the UI, Excel translates empty string into "\0" While it is possible to encode the title/text as empty string (Excel doesn't exactly crash), the resulting tool-tip text / message box looks wrong. It is best to do the same as the Excel UI and encode 'not present' as "\0". Get the condition data type @return the condition data type @see org.apache.poi.hssf.util.HSSFDataValidation utility class Get the condition error style @return the condition error style @see org.apache.poi.hssf.util.HSSFDataValidation utility class return true if in list validations the string list Is explicitly given in the formula, false otherwise @return true if in list validations the string list Is explicitly given in the formula, false otherwise @see org.apache.poi.hssf.util.HSSFDataValidation utility class return true if empty values are allowed in cells, false otherwise @return if empty values are allowed in cells, false otherwise @see org.apache.poi.hssf.util.HSSFDataValidation utility class @return true if drop down arrow should be suppressed when list validation is used, false otherwise return true if a prompt window should appear when cell Is selected, false otherwise @return if a prompt window should appear when cell Is selected, false otherwise @see org.apache.poi.hssf.util.HSSFDataValidation utility class return true if an error window should appear when an invalid value Is entered in the cell, false otherwise @return if an error window should appear when an invalid value Is entered in the cell, false otherwise @see org.apache.poi.hssf.util.HSSFDataValidation utility class Get the condition operator @return the condition operator @see org.apache.poi.hssf.util.HSSFDataValidation utility class Gets the option flags field. @return options - the option flags field Clones the object. Uses serialisation, as the contents are somewhat complex End Of File record. Description: Marks the end of records belonging to a particular object in the HSSF File REFERENCE: PG 307 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a EOFRecord record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from This class Is used to aggregate the MSODRAWING and OBJ record combinations. This Is necessary due to the bizare way in which these records are Serialized. What happens Is that you Get a combination of MSODRAWING -> OBJ -> MSODRAWING -> OBJ records but the escher records are Serialized _across_ the MSODRAWING records. It Gets even worse when you start looking at TXO records. So what we do with this class Is aggregate lazily. That Is we don't aggregate the MSODRAWING -> OBJ records Unless we need to modify them. At first document contains 4 types of records which belong to drawing layer. There are can be such sequence of record:

DrawingRecord ContinueRecord ... ContinueRecord ObjRecord | TextObjectRecord ..... ContinueRecord ... ContinueRecord ObjRecord | TextObjectRecord NoteRecord ... NoteRecord

To work with shapes we have to read data from Drawing and Continue records into single array of bytes and build escher(office art) records tree from this array. Each shape in drawing layer matches corresponding ObjRecord Each textbox matches corresponding TextObjectRecord

ObjRecord contains information about shape. Thus each ObjRecord corresponds EscherContainerRecord(SPGR)

EscherAggrefate contains also NoteRecords NoteRecords must be serial @author Glen Stampoultzis (glens at apache.org) Maps shape container objects to their OBJ records list of "tail" records that need to be Serialized after all drawing Group records @return Returns the current sid. Calculates the string representation of this record. This Is simply a dump of all the records. Calculates the xml representation of this record. This is simply a dump of all the records. @param tab - string which must be added before each line (used by default '\t') @return xml representation of the all aggregated records @param sid - record sid we want to check if it belongs to drawing layer @return true if record is instance of DrawingRecord or ContinueRecord or ObjRecord or TextObjRecord Collapses the drawing records into an aggregate. read Drawing, Obj, TxtObj, Note and Continue records into single byte array, create Escher tree from byte array, create map <EscherRecord, Record> @param records - list of all records inside sheet @param locFirstDrawingRecord - location of the first DrawingRecord inside sheet @return new EscherAggregate create from all aggregated records which belong to drawing layer Serializes this aggregate to a byte array. Since this Is an aggregate record it will effectively Serialize the aggregated records. @param offset The offset into the start of the array. @param data The byte array to Serialize to. @return The number of bytes Serialized. @param drawingData - escher records saved into single byte array @param writtenEscherBytes - count of bytes already saved into drawing records (we should know it to decide create drawing or continue record) @param pos current position of data array @param data - array of bytes where drawing records must be serialized @param i - number of shape, saved into data array @return offset of data array after serialization How many bytes do the raw escher records contain. @param records List of escher records @return the number of bytes @param records list of records to look into @param loc - location of the record which sid must be returned @return sid of the record with selected location @return record size, including header size of obj, text, note, drawing, continue records create base tree with such structure: EscherDgContainer -EscherSpgrContainer --EscherSpContainer ---EscherSpRecord ---EscherSpgrRecord ---EscherSpRecord -EscherDgRecord id of DgRecord and SpRecord are empty and must be set later by HSSFPatriarch Unused since this Is an aggregate record. Use CreateAggregate(). @see #CreateAggregate Converts the Records into UserModel objects on the bound HSSFPatriarch

@author Josh Micich 'rgoper' / 'Last received results of the DDE link' (seems to be only applicable to DDE links)
Logically this is a 2-D array, which has been flattened into 1-D array here. (logical) number of columns in the {@link #_ddeValues} array (logical) number of rows in the {@link #_ddeValues} array Convenience Function to determine if the name Is a built-in name For OLE and DDE, links can be either 'automatic' or 'manual' only for OLE and DDE DDE links only. If true, this denotes the 'StdDocumentName' @return the standard String representation of this name index to External Book Block (which starts with a EXTERNALBOOK record) a Constructor for making new sub record @param in the RecordInputstream to Read the record from called by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. @param offset to begin writing at @param data byte array containing instance data @return number of bytes written Title: Extern Sheet Description: A List of Inndexes to SupBook REFERENCE: @author Libin Roman (Vista Portal LDT. Developer) @version 1.0-pre Constructs a Extern Sheet record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Add a zero-based reference to a {@link org.apache.poi.hssf.record.SupBookRecord}.

If the type of the SupBook record is same-sheet referencing, Add-In referencing, DDE data source referencing, or OLE data source referencing, then no scope is specified and this value MUST be -2. Otherwise, the scope must be set as follows:

1. -2 Workbook-level reference that applies to the entire workbook.
2. -1 Sheet-level reference.
3. >=0 Sheet-level reference. This specifies the first sheet in the reference.

   If the SupBook type is unused or external workbook referencing, then this value specifies the zero-based index of an external sheet name, see {@link org.apache.poi.hssf.record.SupBookRecord#getSheetNames()}. This referenced string specifies the name of the first sheet within the external workbook that is in scope. This sheet MUST be a worksheet or macro sheet.

   If the supporting link type is self-referencing, then this value specifies the zero-based index of a {@link org.apache.poi.hssf.record.BoundSheetRecord} record in the workbook stream that specifies the first sheet within the scope of this reference. This sheet MUST be a worksheet or a macro sheet.

REFERENCE: PG 314 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

@author Andrew C. Oliver (acoliver at apache dot org) Constructs a FileSharing record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the Readonly @return short representing if this Is Read only (1 = true) @returns password hashed with hashPassword() (very lame) @returns username of the user that Created the file Clone this record. Title: Function Group Count Record Description: Number of built in function Groups in the current version of the SpReadsheet (probably only used on Windoze) REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre suggested default (14 dec) Constructs a FnGroupCount record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the number of built-in functions @return number of built-in functions Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4) Description: An element in the Font Table REFERENCE: PG 315 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a Font record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Clones all the font style information from another FontRecord, onto this one. This will then hold all the same font style options. Set the font to be italics or not @param italics - whether the font Is italics or not @see #SetAttributes(short) Set the font to be stricken out or not @param strike - whether the font Is stricken out or not @see #SetAttributes(short) whether to use the mac outline font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea) @param mac - whether to do that mac font outline thing or not @see #SetAttributes(short) whether to use the mac shado font style thing (mac only) - Some mac person should comment this instead of me doing it (since I have no idea) @param mac - whether to do that mac font shadow thing or not @see #SetAttributes(short) Set the type of Underlining for the font Set the font family (TODO) @param f family Set the Char Set @param charSet - CharSet Set the name of the font @param fn - name of the font (i.e. "Arial") Gets the height of the font in 1/20th point Units @return fontheight (in points/20) Get the font attributes (see individual bit Getters that reference this method) @return attribute - the bitmask Get the font's color palette index @return cpi - font color index Get the bold weight for this font (100-1000dec or 0x64-0x3e8). Default Is 0x190 for normal and 0x2bc for bold @return bw - a number between 100-1000 for the fonts "boldness" Get the type of base or subscript for the font @return base or subscript option Does this FontRecord have all the same font properties as the supplied FontRecord? Note that {@link #equals(Object)} will check for exact objects, while this will check for exact contents, because normally the font record's position makes a big difference too. Only returns two for the same exact object - creating a second FontRecord with the same properties won't be considered equal, as the record's position in the record stream matters. Title: Footer Record Description: Specifies the footer for a sheet REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Shawn Laubach (slaubach at apache dot org) Modified 3/14/02 @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre

0. RK_IEEE_NUMBER
1. RK_IEEE_NUMBER_TIMES_100
2. RK_INTEGER
3. RK_INTEGER_TIMES_100

TableRecord - The record specifies a data table. This record Is preceded by a single Formula record that defines the first cell in the data table, which should only contain a single Ptg, {@link TblPtg}. See p536 of the June 08 binary docs TABLESTYLES (0x088E)
@author Patrick Cheng expect tRef, tRef3D, tArea, tArea3D or tName Not clear if needed . Excel seems to be OK if this byte is not present. Value is often the same as the earlier firstColumn byte. Get the text orientation field for the TextObjectBase record. @return a TextOrientation @return the Horizontal text alignment field value. @return the Vertical text alignment field value. Text has been locked @return the text locked field value. Record for the top margin. NOTE: This source was automatically generated. @author Shawn Laubach (slaubach at apache dot org) Constructs a TopMargin record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the margin field for the TopMargin record. Title: Uncalced Record If this record occurs in the Worksheet Substream, it indicates that the formulas have not been recalculated before the document was saved. @author Olivier Leprince Default constructor Read constructor Title: Unknown Record (for debugging) Description: Unknown record just tells you the sid so you can figure out what records you are missing. Also helps us Read/modify sheets we don't know all the records to. (HSSF leaves these alone!) Company: SuperLink Software, Inc. @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @author Glen Stampoultzis (glens at apache.org) @param id id of the record -not Validated, just stored for serialization @param data the data construct an Unknown record. No fields are interperated and the record will be Serialized in its original form more or less @param in the RecordInputstream to Read the record from spit the record out AS IS. no interpretation or identification print a sort of string representation ([UNKNOWN RECORD] id = x [/UNKNOWN RECORD]) These BIFF record types are known but still uninterpreted by POI @return the documented name of this BIFF record type, null if unknown to POI @return true if the unknown record id has been observed in POI unit tests Unlike the other Record.Clone methods this Is a shallow Clone The UserSViewBegin record specifies Settings for a custom view associated with the sheet. This record also marks the start of custom view records, which save custom view Settings. Records between {@link UserSViewBegin} and {@link UserSViewEnd} contain Settings for the custom view, not Settings for the sheet itself. @author Yegor Kozlov construct an UserSViewBegin record. No fields are interpreted and the record will be Serialized in its original form more or less @param in the RecordInputstream to read the record from spit the record out AS IS. no interpretation or identification @return Globally unique identifier for the custom view The UserSViewEnd record marks the end of the Settings for a custom view associated with the sheet @author Yegor Kozlov construct an UserSViewEnd record. No fields are interpreted and the record will be Serialized in its original form more or less @param in the RecordInputstream to read the record from spit the record out AS IS. no interpretation or identification Title: Use Natural Language Formulas Flag Description: Tells the GUI if this was written by something that can use "natural language" formulas. HSSF can't. REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a UseSelFS record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Title: VCenter record Description: tells whether to center the sheet between vertical margins REFERENCE: PG 420 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a VCENTER record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get whether to center vertically or not @return vcenter or not VerticalPageBreak record that stores page breaks at columns This class Is just used so that SID Compares work properly in the RecordFactory @see PageBreakRecord @author Danny Mui (dmui at apache dot org) @param in the RecordInputstream to Read the record from Title: Window1 Record Description: Stores the attributes of the workbook window. This Is basically so the gui knows how big to make the window holding the spReadsheet document. REFERENCE: PG 421 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a WindowOne record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the horizontal position of the window (in 1/20ths of a point) @return h - horizontal location Get the vertical position of the window (in 1/20ths of a point) @return v - vertical location Get the width of the window @return width Get the height of the window @return height Get the options bitmask (see bit Setters) @return o - the bitmask Get whether the window Is hidden or not @return Ishidden or not Get whether the window has been iconized or not @return iconize or not Get whether to Display the horizontal scrollbar or not @return Display or not Get whether to Display the vertical scrollbar or not @return Display or not Get whether to Display the tabs or not @return Display or not @return the index of the currently Displayed sheet deprecated May 2008 @deprecated - Misleading name - use GetActiveSheetIndex() @return the first visible sheet in the worksheet tab-bar. I.E. the scroll position of the tab-bar. deprecated May 2008 @deprecated - Misleading name - use GetFirstVisibleTab() Get the number of selected tabs @return number of tabs ratio of the width of the tabs to the horizontal scrollbar @return ratio Title: Window Protect Record Description: flags whether workbook windows are protected REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre Constructs a WindowProtect record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Is this window protected or not @return protected or not Title: Window Two Record Description: sheet window Settings REFERENCE: PG 422 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a WindowTwo record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the options bitmask or just use the bit Setters. @return options Get whether the window should Display formulas @return formulas or not Get whether the window should Display gridlines @return gridlines or not Get whether the window should Display row and column headings @return headings or not Get whether the window should freeze panes @return freeze panes or not Get whether the window should Display zero values @return zeros or not Get whether the window should Display a default header @return header or not Is this arabic? @return arabic or not Get whether the outline symbols are displaed @return symbols or not freeze Unsplit panes or not @return freeze or not sheet tab Is selected @return selected or not Is the sheet currently Displayed in the window @return Displayed or not deprecated May 2008 @deprecated use IsActive() was the sheet saved in page break view @return pagebreaksaved or not Get the top row visible in the window @return toprow Get the leftmost column Displayed in the window @return leftmost Get the palette index for the header color @return color zoom magification in page break view @return zoom Get the zoom magnification in normal view @return zoom Get the reserved bits - why would you do this? @return reserved stuff -probably garbage Title: Write Access Record Description: Stores the username of that who owns the spReadsheet generator (on Unix the user's login, on Windoze its the name you typed when you installed the thing) REFERENCE: PG 424 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @version 2.0-pre this record is always padded to a constant length Constructs a WriteAccess record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get the username for the user that Created the report. HSSF uses the logged in user. On natively Created M$ Excel sheet this would be the name you typed in when you installed it in most cases. @return username of the user who Is logged in (probably "tomcat" or "apache") Title: Write Protect Record Description: Indicated that the sheet/workbook Is Write protected. REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @version 3.0-pre Constructs a WriteAccess record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Title: WSBool Record. Description: stores workbook Settings (aka its a big "everything we didn't put somewhere else") REFERENCE: PG 425 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2) @author Andrew C. Oliver (acoliver at apache dot org) @author Glen Stampoultzis (gstamp@iprimus.com.au) @author Jason Height (jheight at chariot dot net dot au) @version 2.0-pre Constructs a WSBool record and Sets its fields appropriately. @param in the RecordInputstream to Read the record from Get first byte (see bit Getters)

One important concept worth considering Is that of font size. One of the difficulties in Converting Graphics calls into escher Drawing calls Is that Excel does not have the concept of absolute pixel positions. It measures it's cell widths in 'Chars' and the cell heights in points. Unfortunately it's not defined exactly what a type of Char it's measuring. Presumably this Is due to the fact that the Excel will be using different fonts on different platforms or even within the same platform. Because of this constraint we've had to calculate the verticalPointsPerPixel. This the amount the font should be scaled by when you Issue commands such as DrawString(). A good way to calculate this Is to use the follow formula:

                  multipler = GroupHeightInPoints / heightOfGroup
             

The height of the Group Is calculated fairly simply by calculating the difference between the y coordinates of the bounding box of the shape. The height of the Group can be calculated by using a convenience called HSSFClientAnchor.GetAnchorHeightInPoints().

Every successful call to startEvaluate must be followed by a call to endEvaluate (recommended in a finally block) to enable proper tracking of which cells are being evaluated at any point in time.

Assuming a well behaved client, parameters to this method would not be required. However, they have been included to assert correct behaviour, and form more meaningful error messages. This class makes an EvaluationCycleDetector instance available to each thRead via a ThReadLocal in order to avoid Adding a parameter to a few protected methods within HSSFFormulaEvaluator. @author Josh Micich @return

0 means Context (Default), 1 means Left To Right, and 2 means Right to Left

            int EvaluatedCellType = evaluator.EvaluateFormulaCell(cell);
            

            int EvaluatedCellType = evaluator.EvaluateInCell(cell).CellType;
            

In some cases exetrnal workbooks referenced by formulas in the main workbook are not avaiable. With this method you can control how POI handles such missing references:

• by default ignoreMissingWorkbooks=false and POI throws {@link org.apache.poi.ss.formula.CollaboratingWorkbooksEnvironment.WorkbookNotFoundException} if an external reference cannot be resolved
• if ignoreMissingWorkbooks=true then POI uses cached formula result that already exists in the main workbook

Please note, that this method works correctly only for workbooks with default font size (Arial 10pt for .xls). If the default font is changed the resized image can be streched vertically or horizontally.

resize(1.0,1.0) keeps the original size,
resize(0.5,0.5) resize to 50% of the original,
resize(2.0,2.0) resizes to 200% of the original.
resize({@link Double#MAX_VALUE},{@link Double#MAX_VALUE}) resizes to the dimension of the embedded image.