Class RowStorage
Stores single row data and gives functionality to access and modify it.
Inheritance
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
public class RowStorage : Object, IDisposable, IBiffStorage, ICloneable, IOutlineConstructors
RowStorage(Int32, Int32, Int32)
Default constructor.
Declaration
public RowStorage(int iRowNumber, int height, int xfIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iRowNumber | |
| System.Int32 | height | |
| System.Int32 | xfIndex |
Properties
CellPositionSize
Returns size of the cell position block. Read-only.
Declaration
public int CellPositionSize { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
DataSize
Size of allocated data. Read-only.
Declaration
public int DataSize { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
ExtendedFormatIndex
If the row is formatted, then this is the index to the extended format record.
Declaration
public ushort ExtendedFormatIndex { get; set; }Property Value
| Type | Description |
|---|---|
| System.UInt16 |
FirstColumn
Zero-based index of the first column. Read/write.
Declaration
public int FirstColumn { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
HasMultiRkBlank
Gets or sets value indicating whether storage possibly contains MultiRk or MultiBlank records.
Declaration
public bool HasMultiRkBlank { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
HasRkBlank
Gets or sets value indicating whether storage possibly contains Rk or Blank records.
Declaration
public bool HasRkBlank { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Height
Height of the row, in twips = 1/20 of a point.
Declaration
public ushort Height { get; set; }Property Value
| Type | Description |
|---|---|
| System.UInt16 |
IsBadFontHeight
Whether the font and row height are not compatible. True if they aren't compatible.
Declaration
public bool IsBadFontHeight { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsCollapsed
Whether or not to collapse this row.
Declaration
public bool IsCollapsed { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsFormatted
Whether the row has been formatted (even if it has all blank cells).
Declaration
public bool IsFormatted { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsGroupShown
Undocumented bit flag. If it is set to False, then Excel will not show row groups. Default value is True.
Declaration
public bool IsGroupShown { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsHidden
Whether or not to display this row with 0 height.
Declaration
public bool IsHidden { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsSpaceAboveRow
True if there is additional space above the row.
Declaration
public bool IsSpaceAboveRow { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsSpaceBelowRow
True if there is additional space below the row.
Declaration
public bool IsSpaceBelowRow { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IsWrapText
Zero-based index of the first column. Read/write.
Declaration
public bool IsWrapText { get; set; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
LastColumn
Zero-based index of the last column. Read/write.
Declaration
public int LastColumn { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
NeedDataArray
Indicates whether data array is required by this record. Read-only.
Declaration
public bool NeedDataArray { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
OutlineLevel
The outline level of this row. Changes some bits of m_usOptionFlags private member.
Declaration
public ushort OutlineLevel { get; set; }Property Value
| Type | Description |
|---|---|
| System.UInt16 |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentOutOfRangeException | When value is more than 7. |
Provider
Returns internal data provider. Read-only.
Declaration
public DataProvider Provider { get; }Property Value
| Type | Description |
|---|---|
| DataProvider |
RecordCode
Returns code of the biff storage. Read-only.
Declaration
public int RecordCode { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
StreamPos
Indicates record position in stream. This is a utility member of class and is used only in the serialization process. Does not influence the data.
Declaration
public long StreamPos { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int64 |
TypeCode
Returns type code of the biff storage. Read-only.
Declaration
public TBIFFRecord TypeCode { get; }Property Value
| Type | Description |
|---|---|
| TBIFFRecord |
UsedSize
Size of used data. Read-only.
Declaration
public int UsedSize { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
Version
Declaration
public ExcelVersion Version { get; }Property Value
| Type | Description |
|---|---|
| ExcelVersion |
Methods
AppendRecordData(BiffRecordRaw[], Byte[], Boolean, Int32)
Appends storage with record's data.
Declaration
public void AppendRecordData(BiffRecordRaw[] records, byte[] arrBuffer, bool bIgnoreStyles, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw[] | records | Records to append. |
| System.Byte[] | arrBuffer | Temporary buffer for record data. |
| System.Boolean | bIgnoreStyles | Indicates whether we have to ignore styles. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
AppendRecordData(Int16, Int16, BiffRecordRaw, Int32)
Appends storage with record's data.
Declaration
public void AppendRecordData(short type, short length, BiffRecordRaw data, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int16 | type | Record type. |
| System.Int16 | length | Data length. |
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw | data | Array with required data. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
AppendRecordData(Int16, Int16, Byte[], Int32)
Appends storage with record's data.
Declaration
public void AppendRecordData(short type, short length, byte[] data, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int16 | type | Record type. |
| System.Int16 | length | Data length. |
| System.Byte[] | data | Array with required data. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
AppendRecordData(Int32, Byte[], Int32)
Appends storage with record's data.
Declaration
public void AppendRecordData(int length, byte[] data, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | length | Data length. |
| System.Byte[] | data | Array with required data. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
ClearData()
Removes all data saving cells formatting.
Declaration
public void ClearData()Clone()
Creates copy of the storage.
Declaration
public object Clone()Returns
| Type | Description |
|---|---|
| System.Object | RowStorage with copied data. |
Clone(SSTDictionary, SSTDictionary, Dictionary<Int32, Int32>, Dictionary<String, String>, Dictionary<Int32, Int32>, Dictionary<Int32, Int32>, Dictionary<Int32, Int32>)
Creates copy of the storage.
Declaration
public RowStorage Clone(SSTDictionary sourceSST, SSTDictionary destSST, Dictionary<int, int> hashExtFormatIndexes, Dictionary<string, string> hashWorksheetNames, Dictionary<int, int> dicNameIndexes, Dictionary<int, int> dicFontIndexes, Dictionary<int, int> dictExternSheets)Parameters
| Type | Name | Description |
|---|---|---|
| SSTDictionary | sourceSST | Source strings table. |
| SSTDictionary | destSST | Destination strings table |
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | hashExtFormatIndexes | Dictionary with new extended format indexes. |
| System.Collections.Generic.Dictionary<System.String, System.String> | hashWorksheetNames | Dictionary with new worksheet names. |
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicNameIndexes | New name indexes. |
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | Dictionary with new font indexes. |
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dictExternSheets |
Returns
| Type | Description |
|---|---|
| RowStorage | RowStorage with copied data. |
Clone(Int32, Int32, Int32)
Creates copy of the storage.
Declaration
public RowStorage Clone(int iStartColumn, int iEndColumn, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iStartColumn | Zero-based index of the first column to copy. |
| System.Int32 | iEndColumn | Zero-based index of the last column to copy. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
Returns
| Type | Description |
|---|---|
| RowStorage | RowStorage with copied data. |
Clone(IntPtr)
Creates copy of the storage.
Declaration
public object Clone(IntPtr heapHandle)Parameters
| Type | Name | Description |
|---|---|---|
| System.IntPtr | heapHandle |
Returns
| Type | Description |
|---|---|
| System.Object | RowStorage with copied data. |
Compress()
Compresses data storage - combines several rk/blank records into one MulRK/MulBlank records.
Declaration
public void Compress()Contains(Int32)
Indicates whether row contains record with specified index.
Declaration
public bool Contains(int iColumn)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumn | Zero-based column index to find. |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if required record was found. |
CopyRowRecordFrom(RowStorage)
Copies row settings (default style, height and some other settings) from another row storage.
Declaration
public void CopyRowRecordFrom(RowStorage sourceRow)Parameters
| Type | Name | Description |
|---|---|---|
| RowStorage | sourceRow | Storage to copy settings from. |
CreateRowRecord(WorkbookImpl)
Creates RowRecord and copies all required data into it.
Declaration
public RowRecord CreateRowRecord(WorkbookImpl book)Parameters
| Type | Name | Description |
|---|---|---|
| WorkbookImpl | book | Parent workbook. |
Returns
| Type | Description |
|---|---|
| RowRecord | Created record. |
Decompress(Boolean, Int32)
Converts all MultiRK and MultiBlank records into set of RK / Blank records.
Declaration
public void Decompress(bool bIgnoreStyles, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | bIgnoreStyles | Indicates whether styles must be ignored. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
Dispose()
Disposes the object
Declaration
public void Dispose()Dispose(Boolean)
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose(bool disposing)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
FillStream(BinaryWriter, DataProvider, IEncryptor, Int32)
Save record data to stream.
Declaration
public int FillStream(BinaryWriter writer, DataProvider provider, IEncryptor encryptor, int streamPosition)Parameters
| Type | Name | Description |
|---|---|---|
| System.IO.BinaryWriter | writer | Writer that will receive record data. |
| DataProvider | provider | Object that provides access to the data. |
| IEncryptor | encryptor | Object to encrypt data. |
| System.Int32 | streamPosition | Position in the output stream. Used to increase performance. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Size of the record. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | If writer is NULL. |
Finalize()
Disposes this object.
Declaration
protected override void Finalize()Find(Dictionary<Int32, Object>, List<Int64>)
Declaration
public void Find(Dictionary<int, object> dictIndexes, List<long> arrRanges)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.Dictionary<System.Int32, System.Object> | dictIndexes | |
| System.Collections.Generic.List<System.Int64> | arrRanges |
Find(Int32, Int32, Byte, Boolean, Boolean, WorkbookImpl)
Declaration
public List<long> Find(int iFirstColumn, int iLastColumn, byte findValue, bool bError, bool bIsFindFirst, WorkbookImpl book)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iFirstColumn | |
| System.Int32 | iLastColumn | |
| System.Byte | findValue | |
| System.Boolean | bError | |
| System.Boolean | bIsFindFirst | |
| WorkbookImpl | book |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Int64> |
Find(Int32, Int32, Double, ExcelFindType, Boolean, WorkbookImpl)
Declaration
public List<long> Find(int iFirstColumn, int iLastColumn, double findValue, ExcelFindType flags, bool bIsFindFirst, WorkbookImpl book)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iFirstColumn | |
| System.Int32 | iLastColumn | |
| System.Double | findValue | |
| ExcelFindType | flags | |
| System.Boolean | bIsFindFirst | |
| WorkbookImpl | book |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Int64> |
Find(Int32, Int32, String, ExcelFindType, ExcelFindOptions, Int32, Boolean, WorkbookImpl)
Declaration
public List<long> Find(int iFirstColumn, int iLastColumn, string findValue, ExcelFindType flags, ExcelFindOptions findOptions, int iErrorCode, bool bIsFindFirst, WorkbookImpl book)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iFirstColumn | |
| System.Int32 | iLastColumn | |
| System.String | findValue | |
| ExcelFindType | flags | |
| ExcelFindOptions | findOptions | |
| System.Int32 | iErrorCode | |
| System.Boolean | bIsFindFirst | |
| WorkbookImpl | book |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Int64> |
Find(Int32, Int32, String, ExcelFindType, Int32, Boolean, WorkbookImpl)
Declaration
public List<long> Find(int iFirstColumn, int iLastColumn, string findValue, ExcelFindType flags, int iErrorCode, bool bIsFindFirst, WorkbookImpl book)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iFirstColumn | |
| System.Int32 | iLastColumn | |
| System.String | findValue | |
| ExcelFindType | flags | |
| System.Int32 | iErrorCode | |
| System.Boolean | bIsFindFirst | |
| WorkbookImpl | book |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Int64> |
FindFirstCell(Int32, Int32)
Searches for the first cell in the specified range.
Declaration
public int FindFirstCell(int startColumn, int endColumn)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | startColumn | Zero-based column index to start search at. |
| System.Int32 | endColumn | Zero-based column index to end search at. |
Returns
| Type | Description |
|---|---|
| System.Int32 |
FindRecord(TBIFFRecord, Int32, Int32)
Searches for the record of specified type.
Declaration
public int FindRecord(TBIFFRecord recordType, int startColumn, int endColumn)Parameters
| Type | Name | Description |
|---|---|---|
| TBIFFRecord | recordType | Record type to look for. |
| System.Int32 | startColumn | Zero-based index of the column to start looking at. |
| System.Int32 | endColumn | Zero-based index of the column to end looking at. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Column index that contains record of the specified type or value beyond endColumn if not found. |
GetArrayRecord(Int32)
Returns array record.
Declaration
public ArrayRecord GetArrayRecord(int iColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumnIndex | Zero-based column index. |
Returns
| Type | Description |
|---|---|
| ArrayRecord | Corresponding array record. |
GetArrayRecordByOffset(Int32)
Returns array record.
Declaration
public ArrayRecord GetArrayRecordByOffset(int iOffset)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iOffset | Offset to the record. |
Returns
| Type | Description |
|---|---|
| ArrayRecord | Formula array record. |
GetBoolValue(Int32)
Gets bool value by column index. Without check input parameters.
Declaration
public int GetBoolValue(int iCol)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | One based column index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | If found - returns boolean value; otherwise - 0. |
GetCellType(Int32, Boolean)
Gets cell type from current column.
Declaration
public WorksheetImpl.TRangeValueType GetCellType(int iCol, bool bNeedFormulaSubType)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | Indicates column. |
| System.Boolean | bNeedFormulaSubType | Indicates is need to indentify formula sub type. |
Returns
| Type | Description |
|---|---|
| WorksheetImpl.TRangeValueType | Returns cell type. |
GetColumn(Int32)
Gets column from the record.
Declaration
public int GetColumn(int recordStart)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | recordStart | Offset to the record's start. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Zero-based column index. |
GetEnumerator(RecordExtractor)
Returns row storage enumerator.
Declaration
public IEnumerator GetEnumerator(RecordExtractor recordExtractor)Parameters
| Type | Name | Description |
|---|---|---|
| RecordExtractor | recordExtractor | Record extractor to get Biff records from. |
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerator |
GetErrorValue(Int32)
Gets error value by column index. Without check input parameters.
Declaration
public string GetErrorValue(int iCol)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | One based column index. |
Returns
| Type | Description |
|---|---|
| System.String | If found - returns error value; otherwise - null. |
GetFormulaBoolValue(Int32)
Gets formula bool value by column index. Without check input parameters.
Declaration
public int GetFormulaBoolValue(int iCol)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | One based column index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | If found - returns boolean value; otherwise - 0. |
GetFormulaErrorValue(Int32)
Gets formula error value by column index. Without check input parameters.
Declaration
public string GetFormulaErrorValue(int iCol)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | One based column index. |
Returns
| Type | Description |
|---|---|
| System.String | If found - returns error value; otherwise - null. |
GetFormulaNumberValue(Int32)
Gets formula number value.
Declaration
public double GetFormulaNumberValue(int iCol)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | Column index. |
Returns
| Type | Description |
|---|---|
| System.Double | Returns number value or NaN. |
GetFormulaStringValue(Int32)
Returns formula string value.
Declaration
public string GetFormulaStringValue(int iColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumnIndex | Zero-based column index. |
Returns
| Type | Description |
|---|---|
| System.String | String result of the formula. |
GetFormulaStringValueByOffset(Int32)
Returns formula string value.
Declaration
public string GetFormulaStringValueByOffset(int iOffset)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iOffset | Offset to record. |
Returns
| Type | Description |
|---|---|
| System.String | Formula string value. |
GetFormulaValue(Int32)
Gets string value.
Declaration
public Ptg[] GetFormulaValue(int iCol)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | Column index. |
Returns
| Type | Description |
|---|---|
| Ptg[] | Returns ptg array or null. |
GetNumberValue(Int32, Int32)
Gets number value.
Declaration
public double GetNumberValue(int iCol, int sheetIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | Column index. |
| System.Int32 | sheetIndex |
Returns
| Type | Description |
|---|---|
| System.Double | Returns number value or NaN. |
GetRecord(Int32, Int32)
Returns record corresponding to the specified cell.
Declaration
public ICellPositionFormat GetRecord(int iColumnIndex, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumnIndex | Zero-based column index. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
Returns
| Type | Description |
|---|---|
| ICellPositionFormat | Record corresponding to the specified cell. |
GetRecord(Int32, Int32, RecordExtractor)
Returns record corresponding to the specified cell.
Declaration
public ICellPositionFormat GetRecord(int iColumnIndex, int iBlockSize, RecordExtractor recordExtractor)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumnIndex | Zero-based column index. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
| RecordExtractor | recordExtractor | Object used to extract records from internal data array. |
Returns
| Type | Description |
|---|---|
| ICellPositionFormat | Record corresponding to the specified cell. |
GetRecordAtOffset(Int32)
Creates new record based on the data at the specified position.
Declaration
public BiffRecordRaw GetRecordAtOffset(int iOffset)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iOffset | Offset to the record. |
Returns
| Type | Description |
|---|---|
| Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw |
GetRow(Int32)
Gets row from the record.
Declaration
public int GetRow(int recordStart)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | recordStart | Offset to the record's start. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Zero-based row index. |
GetStoreSize(ExcelVersion)
Size of the required storage space. Read-only.
Declaration
public int GetStoreSize(ExcelVersion version)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelVersion | version |
Returns
| Type | Description |
|---|---|
| System.Int32 |
GetStringValue(Int32, SSTDictionary)
Gets string value.
Declaration
public string GetStringValue(int iColumn, SSTDictionary sst)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumn | Column index. |
| SSTDictionary | sst | Represents sst dictionary. |
Returns
| Type | Description |
|---|---|
| System.String | Returns string value or null. |
GetXFIndex(Int32, Boolean)
Gets XF index from the record.
Declaration
public ushort GetXFIndex(int recordStart, bool bMulti)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | recordStart | Offset to the record's start. |
| System.Boolean | bMulti | Indicates whether record is multi record or not. |
Returns
| Type | Description |
|---|---|
| System.UInt16 | Zero-based index to the extended format record with style settings. |
GetXFIndexByColumn(Int32)
Returns extended format index for the specified column or int.MinValue if not found.
Declaration
public int GetXFIndexByColumn(int column)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | column | Zero-based column index. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Extended format index for the specified column or int.MinValue if not found. |
HasFormulaArrayRecord(Int32)
Indicates is contain formula array.
Declaration
public bool HasFormulaArrayRecord(int iCol)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCol | Zero based column index. |
Returns
| Type | Description |
|---|---|
| System.Boolean | If found return true; otherwise - false. |
HasFormulaRecord(Int32)
Indicates if there is formula record.
Declaration
public bool HasFormulaRecord(int iColumn)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumn | Zero based column index. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Indicates whether formula record is contained. |
InsertRecordData(Int32, Int32, Byte[], Int32)
Appends storage with record's data.
Declaration
public void InsertRecordData(int columnIndex, int length, byte[] data, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | columnIndex | Zero-based column index to insert data. |
| System.Int32 | length | Data length. |
| System.Byte[] | data | Array with required data. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
InsertRowData(RowStorage, Int32, IntPtr)
Inserts data from another row object.
Declaration
public void InsertRowData(RowStorage sourceRow, int iBlockSize, IntPtr heapHandle)Parameters
| Type | Name | Description |
|---|---|---|
| RowStorage | sourceRow | Source row data. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
| System.IntPtr | heapHandle | Heap handle that must be used to allocate memory. |
IterateCells(RowStorage.CellMethod, Object)
Iterates through all cells in the row.
Declaration
public void IterateCells(RowStorage.CellMethod method, object data)Parameters
| Type | Name | Description |
|---|---|---|
| RowStorage.CellMethod | method | Method to call for each cell. |
| System.Object | data | Data to pass to the calling method. |
MarkCellUsedReferences(TBIFFRecord, Int32, Object)
Sets items with used reference indexes to true.
Declaration
public void MarkCellUsedReferences(TBIFFRecord recordType, int offset, object data)Parameters
| Type | Name | Description |
|---|---|---|
| TBIFFRecord | recordType | Record type to check. |
| System.Int32 | offset | Offset to the record to check. |
| System.Object | data | Array to mark used references in. |
MarkUsedReferences(Boolean[])
Sets items with used reference indexes to true.
Declaration
public void MarkUsedReferences(bool[] usedItems)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean[] | usedItems | Represents used items. |
MoveNextCell(Int32)
Moves pointer to the next record.
Declaration
public int MoveNextCell(int iOffset)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iOffset | Offset of the current record. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Offset to the next record. |
PrepareRowData(SSTDictionary, ref Dictionary<Int64, SharedFormulaRecord>)
This method prepares row data, it updates indexes inside SSTDictionary, sets flags for RK and MultiRK records.
Declaration
public bool PrepareRowData(SSTDictionary sst, ref Dictionary<long, SharedFormulaRecord> arrShared)Parameters
| Type | Name | Description |
|---|---|---|
| SSTDictionary | sst | SSTDictionary to update. |
| System.Collections.Generic.Dictionary<System.Int64, SharedFormulaRecord> | arrShared | List that will receive all found shared formula records. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
ReAddAllStrings(SSTDictionary)
Looks through all records and calls AddIncrease for each LabelSST record.
Declaration
public void ReAddAllStrings(SSTDictionary sst)Parameters
| Type | Name | Description |
|---|---|---|
| SSTDictionary | sst | Dictionary to update. |
Remove(Int32, Int32, Int32)
Creates copy of the storage.
Declaration
public void Remove(int iStartColumn, int iEndColumn, int blockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iStartColumn | Zero-based index of the first column to copy. |
| System.Int32 | iEndColumn | Zero-based index of the last column to copy. |
| System.Int32 | blockSize | Represents allocation block size. |
ReplaceSharedFormula(WorkbookImpl, Int32, Int32, SharedFormulaRecord)
Replaces all shared formula with ordinary formula.
Declaration
public void ReplaceSharedFormula(WorkbookImpl book, int row, int column, SharedFormulaRecord shared)Parameters
| Type | Name | Description |
|---|---|---|
| WorkbookImpl | book | Parent workbook. |
| System.Int32 | row | |
| System.Int32 | column | |
| SharedFormulaRecord | shared | Shared formula that should be replaced. |
RowColumnOffset(Int32, Int32, Int32)
Adds specified values to row and columns indexes.
Declaration
public void RowColumnOffset(int iDeltaRow, int iDeltaCol, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iDeltaRow | Value to add to row index. |
| System.Int32 | iDeltaCol | Value to add to column index. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
SetArrayFormulaIndex(Int32, Int32, Int32, Int32)
Updates indexes in the array-entered formula.
Declaration
public void SetArrayFormulaIndex(int iColumn, int iArrayRow, int iArrayColumn, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumn | Zero-based column index of the cell with array-entered formula. |
| System.Int32 | iArrayRow | Zero-based row index of the array record. |
| System.Int32 | iArrayColumn | Zero-based column index of the array record. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
SetArrayRecord(Int32, ArrayRecord, Int32)
Sets array record.
Declaration
public void SetArrayRecord(int iColumnIndex, ArrayRecord array, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumnIndex | Zero-based column index. |
| ArrayRecord | array | Record to set. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
SetCellPositionSize(Int32, Int32, ExcelVersion)
Declaration
public void SetCellPositionSize(int newSize, int iBlockSize, ExcelVersion version)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | newSize | |
| System.Int32 | iBlockSize | Memory allocation block size. |
| ExcelVersion | version |
SetCellStyle(Int32, Int32, Int32, Int32)
Sets cell style.
Declaration
public void SetCellStyle(int iRow, int iColumn, int iXFIndex, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iRow | Zero-based row index. |
| System.Int32 | iColumn | Zero-based column index. |
| System.Int32 | iXFIndex | Index of the extended format to set. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
SetDefaultRowOptions()
Sets default row options.
Declaration
public void SetDefaultRowOptions()SetFormulaStringValue(Int32, String, Int32)
Returns formula string value.
Declaration
public void SetFormulaStringValue(int iColumnIndex, string strValue, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumnIndex | Zero-based column index. |
| System.String | strValue | Value to set. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
SetFormulaValue(Int32, Double, StringRecord, Int32)
Sets formula value. Use for setting FormulaError, FormulaBoolean, FormulaNumber, FormulaString values.
Declaration
public void SetFormulaValue(int iColumn, double value, StringRecord strRecord, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumn | Zero based column index. |
| System.Double | value | Represents value for set. |
| StringRecord | strRecord | Represents string record as formula string value. Can be null. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
SetRecord(Int32, ICellPositionFormat, Int32)
Sets cell data.
Declaration
public void SetRecord(int iColumnIndex, ICellPositionFormat cell, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumnIndex | Zero-based column index of the cell. |
| ICellPositionFormat | cell | Cell to set. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
SetVersion(ExcelVersion, Int32)
Declaration
public void SetVersion(ExcelVersion version, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| ExcelVersion | version | |
| System.Int32 | iBlockSize |
UpdateColumnIndexes(Int32, Int32)
Updates column indexes of the specified row.
Declaration
public void UpdateColumnIndexes(int iColumnIndex, int iLastColumnIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iColumnIndex | Column index. |
| System.Int32 | iLastColumnIndex | Last column index. |
UpdateExtendedFormatIndex(Dictionary<Int32, Int32>, Int32)
This method should be called immediately after extended format removal.
Declaration
public void UpdateExtendedFormatIndex(Dictionary<int, int> dictFormats, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dictFormats | Dictionary with updated extended formats. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
UpdateExtendedFormatIndex(Int32, Int32)
This method updates indexes to the extended formats after version change.
Declaration
public void UpdateExtendedFormatIndex(int maxCount, int defaultXF)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | maxCount | New restriction for maximum possible XF index. |
| System.Int32 | defaultXF | Index to the default extended format. |
UpdateExtendedFormatIndex(Int32[], Int32)
This method should be called immediately after extended format removal.
Declaration
public void UpdateExtendedFormatIndex(int[] arrFormats, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | arrFormats | Array with updated extended formats. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
UpdateFormula(Int32, Int32, Rectangle, Int32, Rectangle, Int32, WorkbookImpl)
Updates formulas after copy operation.
Declaration
public void UpdateFormula(int iCurIndex, int iSourceIndex, Rectangle sourceRect, int iDestIndex, Rectangle destRect, int iBlockSize, WorkbookImpl book)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | iCurIndex | Current worksheet index. |
| System.Int32 | iSourceIndex | Source worksheet index. |
| Rectangle | sourceRect | Source rectangle. |
| System.Int32 | iDestIndex | Destination worksheet index. |
| Rectangle | destRect | Destination rectangle. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
| WorkbookImpl | book | Parent workbook. |
UpdateLabelSSTIndexes(Dictionary<Int32, Int32>, IncreaseIndex)
Updates LabelSST indexes after SST record parsing.
Declaration
public void UpdateLabelSSTIndexes(Dictionary<int, int> dictUpdatedIndexes, IncreaseIndex method)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dictUpdatedIndexes | Dictionary with indexes to update, key - old index, value - new index. |
| IncreaseIndex | method |
UpdateNameIndexes(WorkbookImpl, IDictionary<Int32, Int32>, Int32)
Updates indexes to named ranges.
Declaration
public void UpdateNameIndexes(WorkbookImpl book, IDictionary<int, int> dicNewIndex, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| WorkbookImpl | book | Parent workbook. |
| System.Collections.Generic.IDictionary<System.Int32, System.Int32> | dicNewIndex | New indexes. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
UpdateNameIndexes(WorkbookImpl, Int32[], Int32)
Updates indexes to named ranges.
Declaration
public void UpdateNameIndexes(WorkbookImpl book, int[] arrNewIndex, int iBlockSize)Parameters
| Type | Name | Description |
|---|---|---|
| WorkbookImpl | book | Parent workbook. |
| System.Int32[] | arrNewIndex | New indexes. |
| System.Int32 | iBlockSize | Memory allocation elementary block size. |
UpdateReferenceIndexes(TBIFFRecord, Int32, Object)
Updates reference indexes.
Declaration
public void UpdateReferenceIndexes(TBIFFRecord recordType, int offset, object data)Parameters
| Type | Name | Description |
|---|---|---|
| TBIFFRecord | recordType | Represents Biff record type. |
| System.Int32 | offset | Represents offset value. |
| System.Object | data | Data to be updated. |
UpdateReferenceIndexes(Int32[])
Updates reference indexes.
Declaration
public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32[] | arrUpdatedIndexes | Array with updated indexes. |
UpdateRowInfo(RowRecord, Boolean)
Declaration
public void UpdateRowInfo(RowRecord row, bool useFastParsing)Parameters
| Type | Name | Description |
|---|---|---|
| RowRecord | row | |
| System.Boolean | useFastParsing | Indicates whether fast parsing is turned on. If it is not then we don't need to update FirstColumn and LastColumn indexes. |
UpdateStringIndexes(List<Int32>)
Updates string indexes.
Declaration
public void UpdateStringIndexes(List<int> arrNewIndexes)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<System.Int32> | arrNewIndexes | List with new indexes. |
Explicit Interface Implementations
IOutline.Index
Row or column index.
Declaration
ushort IOutline.Index { get; set; }Returns
| Type | Description |
|---|---|
| System.UInt16 |