Package org.apache.poi.hssf.record

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:

• Apache POI Project

See Also:

org.apache.poi.hssf.eventmodel, RecordFactory

Interface Summary

Interface	Description
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

Class	Description
AbstractEscherHolderRecord	The escher container record is used to hold escher records.
ArrayRecord	ARRAY (0x0221)
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).
CFHeader12Record	Conditional Formatting Header v12 record CFHEADER12 (0x0879), for conditional formattings introduced in Excel 2007 and newer.
CFHeaderBase	Parent of Conditional Formatting Header records, CFHeaderRecord and CFHeader12Record.
CFHeaderRecord	Conditional Formatting Header record CFHEADER (0x01B0).
CFRule12Record	Conditional Formatting v12 Rule Record (0x087A).
CFRuleBase	Conditional Formatting Rules.
CFRuleBase.ComparisonOperator
CFRuleRecord	Conditional Formatting Rule Record (0x01B1).
CodepageRecord	Title: Codepage Record
ColumnInfoRecord	Title: COLINFO Record (0x007D)
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)
DateWindow1904Record	Title: Date Window 1904 Flag record
DBCellRecord	Title: DBCell Record (0x00D7)
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)
DimensionsRecord	Title: Dimensions Record
DrawingGroupRecord
DrawingRecord	DrawingRecord (0x00EC)
DrawingRecordForBiffViewer	This is purely for the biff viewer.
DrawingSelectionRecord	MsoDrawingSelection (0x00ED)
DSFRecord	Title: Double Stream Flag Record (0x0161)
DVALRecord	Title: DATAVALIDATIONS Record (0x01B2)
DVRecord	Title: DATAVALIDATION Record (0x01BE)
EmbeddedObjectRefSubRecord	ftPictFmla (0x0009)
EndSubRecord	ftEnd (0x0000)
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)
ExtSSTRecord	Title: Extended Static String Table (0x00FF)
ExtSSTRecord.InfoSubRecord
FeatHdrRecord	Title: FeatHdr (Feature Header) Record
FeatRecord	Title: Feat (Feature) Record
FilePassRecord	Title: File Pass Record (0x002F)
FileSharingRecord	Title: FILESHARING (0x005B)
FnGroupCountRecord	Title: Function Group Count Record
FontRecord	Title: Font Record (0x0031)
FooterRecord	Title: Footer Record (0x0015)
FormatRecord	Title: Format Record (0x041E)
FormulaRecord	Formula Record (0x0006).
FtCblsSubRecord	This structure appears as part of an Obj record that represents a checkbox or radio button.
FtCfSubRecord	The FtCf structure specifies the clipboard format of the picture-type Obj record containing this FtCf.
FtPioGrbitSubRecord	This structure appears as part of an Obj record that represents image display properties.
GridsetRecord	Title: Gridset Record.
GroupMarkerSubRecord	ftGmo (0x0006)
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)
InterfaceEndRecord	Title: Interface End Record (0x00E2)
InterfaceHdrRecord	Title: Interface Header Record (0x00E1)
IterationRecord	Title: Iteration Record (0x0011)
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)
MMSRecord	Title: MMS Record
MulBlankRecord	Title: Multiple Blank cell record(0x00BE)
MulRKRecord	MULRK (0x00BD)
NameCommentRecord	Title: NAMECMT Record (0x0894)
NameRecord	Title: DEFINEDNAME Record (0x0018)
NoteRecord	NOTE: Comment Associated with a Cell (0x001C)
NoteStructureSubRecord	ftNts (0x000D)
NumberRecord	NUMBER (0x0203) Contains a numeric cell value.
ObjectProtectRecord	Title: Object Protect Record
ObjRecord	OBJRECORD (0x005D)
OldCellRecord	Base class for all old (Biff 2 - Biff 4) cell value records (implementors of CellValueRecordInterface).
OldFormulaRecord	Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in encoded form, along with the value if a number
OldLabelRecord	Biff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for strings stored directly in the cell, from the older file formats that didn't use LabelSSTRecord
OldSheetRecord	Title: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5
OldStringRecord	Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for formula string results.
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 unfrozen panes.
PasswordRecord	Title: Password Record (0x0013)
PasswordRev4Record	Title: Protection Revision 4 password Record (0x01BC)
PrecisionRecord	Title: Precision Record
PrintGridlinesRecord	Title: Print Gridlines Record
PrintHeadersRecord	Title: Print Headers Record
PrintSetupRecord	Title: PAGESETUP (0x00A1)
ProtectionRev4Record	Title: Protection Revision 4 Record (0x01AF)
ProtectRecord	Title: Protect Record (0x0012)
RecalcIdRecord	Title: Recalc Id Record (0x01C1)
Record	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 Description: Wraps a stream and provides helper methods for the construction of records.
RefModeRecord	Title: RefMode Record
RefreshAllRecord	Title: Refresh All Record (0x01B7)
RightMarginRecord	Record for the right margin.
RKRecord	Title: RK Record (0x027E)
RowRecord	Title: Row Record (0x0208)
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)
StandardRecord	Subclasses of this class (the majority of BIFF records) are non-continuable.
StringRecord	STRING (0x0207)
StyleRecord	Title: Style Record (0x0293)
SubRecord	Subrecords are part of the OBJ class.
SupBookRecord	Title: Sup Book - EXTERNALBOOK (0x01AE)
TabIdRecord	Title: Sheet Tab Index Array Record (0x013D)
TableRecord	DATATABLE (0x0236)
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
UnknownRecord	Title: Unknown Record (for debugging)
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
VCenterRecord	Title: VCenter record
VerticalPageBreakRecord	VerticalPageBreak (0x001A) record that stores page breaks at columns
WindowOneRecord	Title: Window1 Record
WindowProtectRecord	Title: Window Protect Record (0x0019)
WindowTwoRecord	Title: Window Two Record
WriteAccessRecord	Title: Write Access Record (0x005C)
WriteProtectRecord	Title: Write Protect Record
WSBoolRecord	Title: WSBOOL (0x0081) (called SHEETPR in OOO doc)

Exception Summary

Exception	Description
RecordInputStream.LeftoverDataException	For use in BiffViewer which may construct Records that don't completely read all available data.