Class MergeCellsRecord

Contains all merged cell ranges of the current sheet. Optional record defining a square area of cells to "merge" into one cell.

Inheritance
System.Object
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw
MergeCellsRecord
Implements
System.ICloneable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Syncfusion.XlsIO.Parser.Biff_Records
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
[CLSCompliant(false)]
[Biff(TBIFFRecord.MergeCells)]
public class MergeCellsRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

MergeCellsRecord()

Default constructor

Declaration
public MergeCellsRecord()

MergeCellsRecord(Int32)

Reserved for record's internal data array.

Declaration
public MergeCellsRecord(int iReserve)
Parameters
Type Name Description
System.Int32 iReserve

Amount of bytes for data array.
Exceptions
Type Condition
System.ArgumentOutOfRangeException

If amount of bytes requested is less than zero.

MergeCellsRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public MergeCellsRecord(Stream stream, out int itemSize)
Parameters
Type Name Description
System.IO.Stream stream

Stream from which record data should be read.
System.Int32 itemSize

size of read item.
Exceptions
Type Condition
System.ArgumentNullException

If stream is not specified.
System.ApplicationException

If stream does not support read or seek operations.

Fields

DEF_MAXIMUM_REGIONS

Maximum possible number of regions in the single MergeCells record.

Declaration
public const int DEF_MAXIMUM_REGIONS = 1027
Field Value
Type
System.Int32

Properties

MinimumRecordSize

Read-only. Returns minimum possible size of record's internal data array.

Declaration
public override int MinimumRecordSize { get; }
Property Value
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MinimumRecordSize

RangesNumber

Returns number of ranges.

Declaration
public ushort RangesNumber { get; }
Property Value
Type
System.UInt16

Regions

All merged cell ranges of the current sheet.

Declaration
public MergeCellsRecord.MergedRegion[] Regions { get; set; }
Property Value
Type
MergeCellsRecord.MergedRegion[]

Methods

GetStoreSize(ExcelVersion)

Size of the required storage space. Read-only.

Declaration
public override int GetStoreSize(ExcelVersion version)
Parameters
Type Name Description
ExcelVersion version
Returns
Type
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Convert Data buffer to special values according to record specification.

Declaration
public override void ParseStructure(DataProvider provider, int iOffset, int iLength, ExcelVersion version)
Parameters
Type Name Description
DataProvider provider

Object that provides access to the data.
System.Int32 iOffset

Offset to the record's data.
System.Int32 iLength

Length of the record's data.
ExcelVersion version

Excel version used for infill.
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.ParseStructure(Syncfusion.XlsIO.Parser.Biff_Records.DataProvider, System.Int32, System.Int32, Syncfusion.XlsIO.ExcelVersion)

SetRegions(Int32, Int32, MergeCellsRecord.MergedRegion[])

Copies regions to the internal array.

Declaration
public void SetRegions(int iStartIndex, int iCount, MergeCellsRecord.MergedRegion[] arrRegions)
Parameters
Type Name Description
System.Int32 iStartIndex

First region to copy.
System.Int32 iCount

Regions count.
MergeCellsRecord.MergedRegion[] arrRegions

Array with regions to copy.

Implements

System.ICloneable