Package org.apache.poi.hssf.record
package org.apache.poi.hssf.record
Record package contains class representations for XLS binary strutures. Its very low level.
- See Also:
-
ClassDescriptionThe escher container record is used to hold escher records.ARRAY (0x0221)The AutoFilterInfo record specifies the number of columns that have AutoFilter enabled and indicates the beginning of the collection of AutoFilter records.Boolean specifying whether the GUI should store a backup of the file.Represents a column in a row with no value but with styling.Somewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject.Contains a flag specifying whether the Gui should save externally linked values from other workbooks.Creates new BoolErrRecord.Record for the bottom margin.Defines a sheet within a workbook.Specifies the maximum times the gui should perform a formula recalculation.Tells the gui whether to calculate formulas automatically, manually or automatically except for tables.Base class for all cell value records (implementors of
CellValueRecordInterface).The cell value record interface is implemented by all classes of type Record that contain cell values.Conditional Formatting Header v12 record CFHEADER12 (0x0879), for conditional formattings introduced in Excel 2007 and newer.Parent of Conditional Formatting Header records,CFHeaderRecordandCFHeader12Record.Conditional Formatting Header record CFHEADER (0x01B0).Conditional Formatting v12 Rule Record (0x087A).Conditional Formatting Rules.Conditional Formatting Rule Record (0x01B1).The default characterset.Defines with width and formatting for a range of columnsThe common object data record is used to store all common preferences for an excel object.Helper class used primarily for SST RecordsCountry Record (aka WIN.INI country) - used for localizationXCT - CRN CountThis record stores the contents of an external cell or cell rangeFlag specifying whether 1904 date windowing is used.Used by Excel and other MS apps to quickly find rows in the sheets.DConRef records specify a range in a workbook (internal or external) that serves as a data source for pivot tables or data consolidation.Specifies the default width for columns that have no specific width set.Row height for rows with undefined or not explicitly defined heights.Controls the accuracy of the calculationsProvides the minumum and maximum bounds of a sheet.Specifies a group of drawing objects.This is purely for the biff viewer.MsoDrawingSelection (0x00ED)Tells if this is a double stream file.This record is the list header of all data validation records (0x01BE) in the current sheet.This record stores data validation settings and a list of cell ranges which contain these settings.ftPictFmla (0x0009)ftEnd (0x0000)Marks the end of records belonging to a particular object in the HSSF FileThis class is used to aggregate the MSODRAWING and OBJ record combinations.Probably one of the more complex records.EXTERNALNAME (0x0023)EXTERNSHEET (0x0017)Extended Static String Table (0x00FF)Title: FeatHdr (Feature Header) RecordTitle: Feat (Feature) RecordFile Pass Record (0x002F)Stores the encrypted readonly for a workbook (write protect).umber of built in function groups in the current version of the Spreadsheet (probably only used on Windows)Describes a font in the workbookSpecifies the footer for a sheetDescribes a number format -- those goofy strings like $(#,###)Formula Record (0x0006).Manages the cached formula result values of other types besides numeric.This structure appears as part of an Obj record that represents a checkbox or radio button.The FtCf structure specifies the clipboard format of the picture-type Obj record containing this FtCf.This structure appears as part of an Obj record that represents image display properties.Flag denoting whether the user specified that gridlines are used when printing.ftGmo (0x0006)Row/column gutter sizesWhether to center between horizontal marginsCommon header/footer base classThe HEADERFOOTER record stores information added in Office Excel 2007 for headers/footers.Specifies a header for a sheetFlag defines whether to hide placeholders and objectHorizontalPageBreak (0x001B) record that stores page breaks at rowsHSSFRecordTypes.RecordConstructor<T extends Record>TheHyperlinkRecord(0x01B8) wraps an HLINK-record from the Excel-97 format.Occurs right after BOF, tells you where the DBCELL records are for a sheet Important for locating cellsShows where the Interface Records ends (MMS)Defines the beginning of Interface records (MMS)Tells whether to iterate over formula calculations or not.Label Record (0x0204) - read only support for strings stored directly in the cell...Refers to a string in the shared string table and is a column value.This structure specifies the properties of a list or drop-down list embedded object in a sheet.This structure specifies properties of the dropdown list controlRecord for the left margin.The margin interface is a parent used to define left, right, top and bottom margins.Optional record defining a square area of cells to "merged" into one cell.defines how many add menu and del menu options are stored in the file.Represents a set of columns in a row with no value but with styling.Used to store multiple RK numbers on a row.Defines a comment associated with a specified name.Defines a named range within a workbook.NOTE: Comment Associated with a Cell (0x001C)ftNts (0x000D)NUMBER (0x0203) Contains a numeric cell value.Protect embedded object with the lamest "security" ever invented.OBJRECORD (0x005D)Base class for all old (Biff 2 - Biff 4) cell value records (implementors ofCellValueRecordInterface).Formula Record (0x0006 / 0x0206 / 0x0406) - holds a formula in encoded form, along with the value if a numberBiff2 - Biff 4 Label Record (0x0004 / 0x0204) - read only support for strings stored directly in the cell, from the older file formats that didn't useLabelSSTRecordTitle: Bound Sheet Record (aka BundleSheet) (0x0085) for BIFF 5Biff2 - Biff 4 Label Record (0x0007 / 0x0207) - read only support for formula string results.Record that contains the functionality page breaks (horizontal and vertical)Since both records store 2byte integers (short), no point in differentiating it in the records.Supports custom palettes.Describes the frozen and unfrozen panes.Stores the encrypted password for a sheet or workbook (HSSF doesn't support encryption)Protection Revision 4 password Record (0x01BC)Defines whether to store with full precision or what's displayed by the gui (meaning have really screwed up and skewed figures or only think you do!)Whether to print the gridlines when you enjoy the spreadsheet on paper.Whether or not to print the row/column headers when you enjoy your spreadsheet in the physical form.Stores print setup options -- bogus for HSSF (and marked as such)Describes whether this is a protected shared/tracked workbookDefines whether a sheet or workbook is protected (HSSF DOES NOT SUPPORT ENCRYPTION)This record contains an ID that marks when a worksheet was last recalculated.All HSSF Records inherit from this class.Common base class ofRecordandRecordAggregateTitle: Record FactoryA stream based way to get at complete records, with as low a memory footprint as possible.Title: Record Input Stream Description: Wraps a stream and provides helper methods for the construction of records.For use in BiffViewer which may constructRecords that don't completely read all available data.Describes which reference mode to useFlag whether to refresh all external data when loading a sheet.Record for the right margin.An internal 32 bit number with the two most significant bits storing the type.Stores the row information for the sheet.Defines whether to recalculate before saving (set to true)I have no idea what a Scenario is or why on would want to protect it with the lamest "security" ever invented.Specifies the window's zoom magnification.Shows the user's selection on the sheet for write set num refs to 0Primarily used as an excel optimization so that multiple similar formulas are not written out too many times.Static String Table Record (0x00FC)Subclasses of this class (the majority of BIFF records) are non-continuable.STRING (0x0207)Describes a builtin to the gui or user defined styleSubrecords are part of the OBJ class.A External Workbook Description (Supplemental Book).Contains an array of sheet id's.The record specifies a data table.TABLESTYLES (0x088E)The TXO record (0x01B6) is used to define the properties of a text box.Record for the top margin.If this record occurs in the Worksheet Substream, it indicates that the formulas have not been recalculated before the document was saved.Unknown record just tells you the sid so you can figure out what records you are missing.The UserSViewBegin record specifies settings for a custom view associated with the sheet.The UserSViewEnd record marks the end of the settings for a custom view associated with the sheetTells the GUI if this was written by something that can use "natural language" formulas.Tells whether to center the sheet between vertical marginsVerticalPageBreak (0x001A) record that stores page breaks at columnsStores the attributes of the workbook window.Flags whether workbook windows are protectedSheet window settingsTitle: Write Access Record (0x005C)Indicated that the sheet/workbook is write protected.Stores workbook settings (aka its a big "everything we didn't put somewhere else")