Package org.apache.poi.hssf.record

Record package contains class representations for XLS binary strutures.

See:
          Description

Interface Summary
CellValueRecordInterface The cell value record interface is implemented by all classes of type Record that contain cell values.
CustomField  
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.
AreaFormatRecord The area format record is used to define the colours and patterns for an area.
AreaRecord The area record is used to define a area chart.
AxisLineFormatRecord The axis line format record defines the axis type details.
AxisOptionsRecord The axis options record provides unit information and other various tidbits about the axis.
AxisParentRecord The axis size and location NOTE: This source is automatically generated please do not modify this file.
AxisRecord The axis record defines the type of an axis.
AxisUsedRecord The number of axes used on a chart.
BackupRecord Title: Backup Record
BarRecord The bar record is used to define a bar chart.
BeginRecord The begin record defines the start of a block of records for a (grpahing data object.
BlankRecord Title: Blank cell record
BOFRecord Title: Beginning Of File
BookBoolRecord Title: Save External Links record (BookBool)
BoolErrRecord Creates new BoolErrRecord.
BottomMarginRecord Record for the bottom margin.
BoundSheetRecord Title: Bound Sheet Record (aka BundleSheet)
CalcCountRecord Title: Calc Count Record Description: Specifies the maximum times the gui should perform a formula recalculation.
CalcModeRecord Title: Calc Mode Record
CategorySeriesAxisRecord This record refers to a category or series axis and is used to specify label/tickmark frequency.
CFHeaderRecord Conditional Formatting Header record (CFHEADER)
CFRuleRecord Conditional Formatting Rule Record.
CFRuleRecord.ComparisonOperator  
ChartFormatRecord Class ChartFormatRecord
ChartRecord The chart record is used to define the location and size of a chart.
ChartTitleFormatRecord Describes the formatting runs associated with a chart title.
CodepageRecord Title: Codepage Record
ColumnInfoRecord Title: COLINFO Record

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 - Helper class used primarily for SST Records
CountryRecord Title: Country Record (aka WIN.INI country)
CRNCountRecord XCT – CRN Count
CRNRecord Title: CRN
DataFormatRecord The data format record is used to index into a series.
DateWindow1904Record Title: Date Window 1904 Flag record
DatRecord The dat record is used to store options for the chart.
DBCellRecord Title: DBCell Record Description: Used by Excel and other MS apps to quickly find rows in the sheets.
DefaultColWidthRecord Title: Default Column Width Record
DefaultDataLabelTextPropertiesRecord The default data label text properties record identifies the text characteristics of the preceeding text record.
DefaultRowHeightRecord Title: Default Row Height Record Description: Row height for rows with undefined or not explicitly defined heights.
DeltaRecord Title: Delta Record
DimensionsRecord Title: Dimensions Record
DrawingGroupRecord  
DrawingRecord  
DrawingRecordForBiffViewer This is purely for the biff viewer.
DrawingSelectionRecord  
DSFRecord Title: Double Stream Flag Record
DVALRecord Title: DATAVALIDATIONS Record
DVRecord Title: DATAVALIDATION Record (0x01BE)

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

EmbeddedObjectRefSubRecord A sub-record within the OBJ record which stores a reference to an object stored in a separate entry within the OLE2 compound file.
EndRecord The end record defines the end of a block of records for a (Graphing) data object.
EndSubRecord 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

ExternSheetRecord Title: Extern Sheet
ExternSheetSubRecord Title: A sub Record for Extern Sheet
ExtSSTInfoSubRecord Extended SST table info subrecord
ExtSSTRecord Title: Extended Static String Table
FilePassRecord Title: File Pass Record
FileSharingRecord Title: FILESHARING
FnGroupCountRecord Title: Function Group Count Record
FontBasisRecord The font basis record stores various font metrics.
FontIndexRecord The font index record indexes into the font table for the text record.
FontRecord Title: Font Record - descrbes a font in the workbook (index = 0-3,5-infinity - skip 4)
FooterRecord Title: Footer Record
FormatRecord Title: Format Record
FormulaRecord Formula Record.
FrameRecord The frame record indicates whether there is a border around the displayed text of a chart.
GridsetRecord Title: Gridset Record.
GroupMarkerSubRecord The group marker record is used as a position holder for groups.
GutsRecord Title: Guts Record
HCenterRecord Title: HCenter record
HeaderRecord Title: Header Record
HideObjRecord Title: Hide Object Record
HorizontalPageBreakRecord HorizontalPageBreak record that stores page breaks at rows
HyperlinkRecord The HyperlinkRecord wraps an HLINK-record from the Excel-97 format.
IndexRecord Title: Index Record
InterfaceEndRecord Title: Interface End Record
InterfaceHdrRecord Title: Interface Header Record
IterationRecord Title: Iteration Record
LabelRecord Label Record - read only support for strings stored directly in the cell..
LabelSSTRecord Title: Label SST Record
LeftMarginRecord Record for the left margin.
LegendRecord Defines a legend for a chart.
LineFormatRecord Describes a line format record.
LinkedDataFormulaField Not implemented yet.
LinkedDataRecord Describes a linked data record.
MergeCellsRecord Title: Merged Cells Record
Description: Optional record defining a square area of cells to "merged" into one cell.
MMSRecord Title: MMS Record
MulBlankRecord Title: Mulitple Blank cell record
MulRKRecord Used to store multiple RK numbers on a row.
NameRecord Title: Name Record (aka Named Range)
NoteRecord NOTE: Comment Associated with a Cell (1Ch)
NoteStructureSubRecord Represents a NoteStructure (0xD) sub record.
NumberFormatIndexRecord The number format index record indexes format table.
NumberRecord Contains a numeric cell value.
ObjectLinkRecord Links text to an object on the chart or identifies it as the title.
ObjectProtectRecord Title: Object Protect Record
ObjRecord The obj record is used to hold various graphic objects and controls.
PageBreakRecord Record that contains the functionality page breaks (horizontal and vertical)
PaletteRecord PaletteRecord - Supports custom palettes.
PaneRecord Describes the frozen and unfozen panes.
PasswordRecord Title: Password Record
PasswordRev4Record Title: Protection Revision 4 password Record
PlotAreaRecord preceeds and identifies a frame as belonging to the plot area.
PlotGrowthRecord The plot growth record specifies the scaling factors used when a font is scaled.
PrecisionRecord Title: Precision Record
PrintGridlinesRecord Title: Print Gridlines Record
PrintHeadersRecord Title: Print Headers Record
PrintSetupRecord Title: Print Setup Record
ProtectionRev4Record Title: Protection Revision 4 Record
ProtectRecord Title: Protect Record
RecalcIdRecord Title: Recalc Id Record
Record Title: Record Description: All HSSF Records inherit from this class.
RecordFactory Deprecated. use EventRecordFactory instead
RecordInputStream Title: Record Input Stream
RefModeRecord Title: RefMode Record
RefreshAllRecord Title: Refresh All Record
RightMarginRecord Record for the right margin.
RKRecord Title: RK Record Description: An internal 32 bit number with the two most significant bits storing the type.
RowRecord Title: Row Record
SaveRecalcRecord Title: Save Recalc Record
ScenarioProtectRecord Title: Scenario Protect Record
SCLRecord Specifies the window's zoom magnification.
SelectionRecord Title: Selection Record
SeriesChartGroupIndexRecord The series chart group index record stores the index to the CHARTFORMAT record (0 based).
SeriesIndexRecord links a series to its position in the series list.
SeriesLabelsRecord The series label record defines the type of label associated with the data format record.
SeriesListRecord The series list record defines the series displayed as an overlay to the main chart record.
SeriesRecord The series record describes the overall data for a series.
SeriesTextRecord Defines a series name NOTE: This source is automatically generated please do not modify this file.
SeriesToChartGroupRecord Indicates the chart-group index for a series.
SharedFormulaRecord Title: SharedFormulaRecord Description: Primarily used as an excel optimization so that multiple similar formulas are not written out too many times.
SheetPropertiesRecord Describes a chart sheet properties record.
SSTRecord Title: Static String Table Record
StringRecord Supports the STRING record structure.
StyleRecord Title: Style Record
SubRecord Subrecords are part of the OBJ class.
SupBookRecord Title: Sup Book (EXTERNALBOOK)
TabIdRecord Title: Sheet Tab Index Array Record
TextObjectBaseRecord The TXO record is used to define the properties of a text box.
TextObjectRecord  
TextRecord The text record is used to define text stored on a chart.
TickRecord The Tick record defines how tick marks and label positioning/formatting NOTE: This source is automatically generated please do not modify this file.
TopMarginRecord Record for the top margin.
UncalcedRecord Title: Uncalced Record
UnicodeString Title: Unicode String
UnicodeString.FormatRun  
UnicodeString.UnicodeRecordStats Returns the size of this record, given the ammount of record space remaining, it will also include the size of writing a continue record.
UnitsRecord The units record describes units.
UnknownRecord Title: Unknown Record (for debugging)
UseSelFSRecord Title: Use Natural Language Formulas Flag
ValueRangeRecord The value range record defines the range of the value axis.
VCenterRecord Title: VCenter record
VerticalPageBreakRecord VerticalPageBreak record that stores page breaks at columns
WindowOneRecord Title: Window1 Record
WindowProtectRecord Title: Window Protect Record
WindowTwoRecord Title: Window Two Record
WriteAccessRecord Title: Write Access Record
WriteProtectRecord Title: Write Protect Record
WSBoolRecord Title: WSBool Record.
 

Exception Summary
RecordFormatException Title: Record Format Exception Description: Used by records to indicate invalid format/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 2008 The Apache Software Foundation or its licensors, as applicable.