Package org.apache.poi.hssf.record

Record package contains class representations for XLS binary strutures.

See:
          Description

Interface Summary
BiffHeaderInput  
CellValueRecordInterface The cell value record interface is implemented by all classes of type Record that contain cell values.
Margin The margin interface is a parent used to define left, right, top and bottom margins.
 

Class Summary
AbstractEscherHolderRecord The escher container record is used to hold escher records.
ArrayRecord ARRAY (0x0221)

Treated in a similar way to SharedFormulaRecord

AutoFilterInfoRecord The AutoFilterInfo record specifies the number of columns that have AutoFilter enabled and indicates the beginning of the collection of AutoFilter records.
BackupRecord Title: Backup Record
BlankRecord Title: Blank cell record (0x0201)
BOFRecord Title: Beginning Of File (0x0809)
BookBoolRecord Title: Save External Links record (BookBool)
BoolErrRecord Creates new BoolErrRecord.
BottomMarginRecord Record for the bottom margin.

BoundSheetRecord Title: Bound Sheet Record (aka BundleSheet) (0x0085)
CalcCountRecord Title: Calc Count Record Description: Specifies the maximum times the gui should perform a formula recalculation.
CalcModeRecord Title: Calc Mode Record
CellRecord Base class for all cell value records (implementors of CellValueRecordInterface).
CFHeaderRecord Conditional Formatting Header record CFHEADER (0x01B0)
CFRuleRecord Conditional Formatting Rule Record (0x01B1).
CFRuleRecord.ComparisonOperator  
CodepageRecord Title: Codepage Record
ColumnInfoRecord Title: COLINFO Record (0x007D)

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)

CommonObjectDataSubRecord The common object data record is used to store all common preferences for an excel object.

ContinueRecord Title: Continue Record(0x003C) - Helper class used primarily for SST Records
CountryRecord Title: Country Record (aka WIN.INI country)
CRNCountRecord XCT - CRN Count
CRNRecord Title: CRN(0x005A)

Description: This record stores the contents of an external cell or cell range

REFERENCE: OOO 5.23

DateWindow1904Record Title: Date Window 1904 Flag record
DBCellRecord Title: DBCell Record (0x00D7)

Description: Used by Excel and other MS apps to quickly find rows in the sheets.

DBCellRecord.Builder  
DConRefRecord DConRef records specify a range in a workbook (internal or external) that serves as a data source for pivot tables or data consolidation.
DefaultColWidthRecord Title: Default Column Width Record (0x0055)
DefaultRowHeightRecord Title: Default Row Height Record Description: Row height for rows with undefined or not explicitly defined heights.
DeltaRecord Title: Delta Record (0x0010)

Description: controls the accuracy of the calculations

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

DimensionsRecord Title: Dimensions Record
DrawingGroupRecord  
DrawingRecord DrawingRecord (0x00EC)

DrawingRecordForBiffViewer This is purely for the biff viewer.
DrawingSelectionRecord MsoDrawingSelection (0x00ED)

Reference: [MS-OGRAPH].pdf sec 2.4.69

DSFRecord Title: Double Stream Flag Record (0x0161)

Description: tells if this is a double stream file.

DVALRecord Title: DATAVALIDATIONS Record (0x01B2)

Description: used in data validation ; This record is the list header of all data validation records (0x01BE) in the current sheet.

DVRecord Title: DATAVALIDATION Record (0x01BE)

Description: This record stores data validation settings and a list of cell ranges which contain these settings.

EmbeddedObjectRefSubRecord ftPictFmla (0x0009)
A sub-record within the OBJ record which stores a reference to an object stored in a separate entry within the OLE2 compound file.
EndSubRecord ftEnd (0x0000)

The end data record is used to denote the end of the subrecords.

EOFRecord End Of File record.
EscherAggregate This class is used to aggregate the MSODRAWING and OBJ record combinations.
ExtendedFormatRecord Title: Extended Format Record Description: Probably one of the more complex records.
ExternalNameRecord EXTERNALNAME (0x0023)

ExternSheetRecord EXTERNSHEET (0x0017)
A List of Indexes to EXTERNALBOOK (supplemental book) Records

ExtSSTRecord Title: Extended Static String Table (0x00FF)

Description: This record is used for a quick lookup into the SST record.

ExtSSTRecord.InfoSubRecord  
FeatHdrRecord Title: FeatHdr (Feature Header) Record
FeatRecord Title: Feat (Feature) Record
FilePassRecord Title: File Pass Record (0x002F)

Description: Indicates that the record after this record are encrypted.

FileSharingRecord Title: FILESHARING (0x005B)

Description: stores the encrypted readonly for a workbook (write protect) This functionality is accessed from the options dialog box available when performing 'Save As'.

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

FnGroupCountRecord Title: Function Group Count Record
FontRecord Title: Font Record (0x0031)

- describes a font in the workbook (index = 0-3,5-infinity - skip 4)

FooterRecord Title: Footer Record (0x0015)

Description: Specifies the footer for a sheet

FormatRecord Title: Format Record (0x041E)

Description: describes a number format -- those goofy strings like $(#,###)

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

FormulaRecord Formula Record (0x0006).
FtCblsSubRecord This structure appears as part of an Obj record that represents a checkbox or radio button.
GridsetRecord Title: Gridset Record.
GroupMarkerSubRecord ftGmo (0x0006)

The group marker record is used as a position holder for groups.

GutsRecord Title: Guts Record
HCenterRecord Title: HCenter record (0x0083)
HeaderFooterBase Common header/footer base class
HeaderFooterRecord The HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.
HeaderRecord Title: Header Record
HideObjRecord Title: Hide Object Record
HorizontalPageBreakRecord HorizontalPageBreak (0x001B) record that stores page breaks at rows

HyperlinkRecord The HyperlinkRecord (0x01B8) wraps an HLINK-record from the Excel-97 format.
IndexRecord Title: Index Record (0x020B)

Description: Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cells

NOT USED IN THIS RELEASE REFERENCE: PG 323 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

InterfaceEndRecord Title: Interface End Record (0x00E2)
InterfaceHdrRecord Title: Interface Header Record (0x00E1)
IterationRecord Title: Iteration Record (0x0011)

Description: Tells whether to iterate over forumla calculations or not (if a formula is dependant upon another formula's result) (odd feature for something that can only have 32 elements in a formula!)

LabelRecord Label Record (0x0204) - read only support for strings stored directly in the cell..
LabelSSTRecord Title: Label SST Record
LbsDataSubRecord This structure specifies the properties of a list or drop-down list embedded object in a sheet.
LbsDataSubRecord.LbsDropData This structure specifies properties of the dropdown list control
LeftMarginRecord Record for the left margin.

MergeCellsRecord Title: Merged Cells Record (0x00E5)
Description: Optional record defining a square area of cells to "merged" into one cell.
MMSRecord Title: MMS Record
MulBlankRecord Title: Multiple Blank cell record(0x00BE)

Description: Represents a set of columns in a row with no value but with styling.

MulRKRecord MULRK (0x00BD)

Used to store multiple RK numbers on a row.

NameCommentRecord Title: NAMECMT Record (0x0894)

Description: Defines a comment associated with a specified name.

NameRecord Title: DEFINEDNAME Record (0x0018)

Description: Defines a named range within a workbook.

NoteRecord NOTE: Comment Associated with a Cell (0x001C)

NoteStructureSubRecord ftNts (0x000D)

Represents a NoteStructure sub record.

NumberRecord NUMBER (0x0203) Contains a numeric cell value.
ObjectProtectRecord Title: Object Protect Record
ObjRecord OBJRECORD (0x005D)

The obj record is used to hold various graphic objects and controls.

PageBreakRecord Record that contains the functionality page breaks (horizontal and vertical)
PageBreakRecord.Break Since both records store 2byte integers (short), no point in differentiating it in the records.
PaletteRecord PaletteRecord (0x0092) - Supports custom palettes.
PaneRecord Describes the frozen and unfozen panes.

PasswordRecord Title: Password Record (0x0013)

Description: stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption) REFERENCE: PG 371 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)

PasswordRev4Record Title: Protection Revision 4 password Record (0x01BC)

Description: Stores the (2 byte??!!) encrypted password for a shared workbook

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

PrecisionRecord Title: Precision Record
PrintGridlinesRecord Title: Print Gridlines Record
PrintHeadersRecord Title: Print Headers Record
PrintSetupRecord Title: PAGESETUP (0x00A1)

Description: Stores print setup options -- bogus for HSSF (and marked as such)

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

REFERENCE: PG 412 Microsoft Excel Binary File Format Structure v20091214

ProtectionRev4Record Title: Protection Revision 4 Record (0x01AF)

Description: describes whether this is a protected shared/tracked workbook

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

ProtectRecord Title: Protect Record (0x0012)

Description: defines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)

HSSF now supports the simple "protected" sheets (where they are not encrypted and open office et al ignore the password record entirely).

RecalcIdRecord Title: Recalc Id Record (0x01C1)

Description: This record contains an ID that marks when a worksheet was last recalculated.

Record Title: Record Description: All HSSF Records inherit from this class.
RecordBase Common base class of Record and RecordAggregate
RecordFactory Title: Record Factory
RecordFactoryInputStream A stream based way to get at complete records, with as low a memory footprint as possible.
RecordInputStream Title: Record Input Stream
RefModeRecord Title: RefMode Record
RefreshAllRecord Title: Refresh All Record (0x01B7)

Description: Flag whether to refresh all external data when loading a sheet.

RightMarginRecord Record for the right margin.

RKRecord Title: RK Record (0x027E)

Description: An internal 32 bit number with the two most significant bits storing the type.

RowRecord Title: Row Record (0x0208)

Description: stores the row information for the sheet.

SaveRecalcRecord Title: Save Recalc Record
ScenarioProtectRecord Title: Scenario Protect Record
SCLRecord Specifies the window's zoom magnification.
SelectionRecord Title: Selection Record (0x001D)
SharedFormulaRecord Title: SHAREDFMLA (0x04BC) SharedFormulaRecord Description: Primarily used as an excel optimization so that multiple similar formulas are not written out too many times.
SharedValueRecordBase Common base class for SharedFormulaRecord, ArrayRecord and TableRecord which are have similarities.
SSTRecord Title: Static String Table Record (0x00FC)

Description: This holds all the strings for LabelSSTRecords.

StandardRecord Subclasses of this class (the majority of BIFF records) are non-continuable.
StringRecord STRING (0x0207)

Stores the cached result of a text formula

StyleRecord Title: Style Record (0x0293)

Description: Describes a builtin to the gui or user defined style

SubRecord Subrecords are part of the OBJ class.
SupBookRecord Title: Sup Book - EXTERNALBOOK (0x01AE)

Description: A External Workbook Description (Supplemental Book) Its only a dummy record for making new ExternSheet Record

TabIdRecord Title: Sheet Tab Index Array Record (0x013D)

Description: Contains an array of sheet id's.

TableRecord DATATABLE (0x0236)

TableRecord - The record specifies a data table.

TableStylesRecord TABLESTYLES (0x088E)
TextObjectRecord The TXO record (0x01B6) is used to define the properties of a text box.
TopMarginRecord Record for the top margin.

UncalcedRecord Title: Uncalced Record
UnicodeString Deprecated. Use UnicodeString instead
UnknownRecord Title: Unknown Record (for debugging)

Description: Unknown record just tells you the sid so you can figure out what records you are missing.

UserSViewBegin The UserSViewBegin record specifies settings for a custom view associated with the sheet.
UserSViewEnd The UserSViewEnd record marks the end of the settings for a custom view associated with the sheet
UseSelFSRecord Title: USESELFS (0x0160) - Use Natural Language Formulas Flag

Description: Tells the GUI if this was written by something that can use "natural language" formulas.

VCenterRecord Title: VCenter record
VerticalPageBreakRecord VerticalPageBreak (0x001A) record that stores page breaks at columns

WindowOneRecord Title: Window1 Record
WindowProtectRecord Title: Window Protect Record (0x0019)

Description: flags whether workbook windows are protected

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

WindowTwoRecord Title: Window Two Record
WriteAccessRecord Title: Write Access Record (0x005C)

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)

WriteProtectRecord Title: Write Protect Record
WSBoolRecord Title: WSBOOL (0x0081) (called SHEETPR in OOO doc)

Description: stores workbook settings (aka its a big "everything we didn't put somewhere else")

 

Exception Summary
RecordFormatException Title: Record Format Exception Description: Used by records to indicate invalid format/data.
RecordInputStream.LeftoverDataException For use in BiffViewer which may construct Records that don't completely read all available data.
 

Package org.apache.poi.hssf.record Description

Record package contains class representations for XLS binary strutures. Its very low level.

Related Documentation

For overviews, tutorials, examples, guides, and tool documentation, please see:

See Also:
org.apache.poi.hssf.eventmodel, RecordFactory


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