Class ColumnInfoRecord

Defines the formatting information for a range of columns including width, outline, and collapsed options.

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

Constructors

ColumnInfoRecord()

Default Constructor

Declaration
public ColumnInfoRecord()

ColumnInfoRecord(Int32)

Reserves for record's internal data array iReserve bytes.

Declaration
public ColumnInfoRecord(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.

ColumnInfoRecord(Stream, out Int32)

Read / initialize constructor.

Declaration
public ColumnInfoRecord(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.

Properties

ColumnWidth

Width of the columns in 1/256 of the width of the zero character, using default font (first font record in the file).

Declaration
public ushort ColumnWidth { get; set; }
Property Value
Type Description
System.UInt16

ExtendedFormatIndex

Index of extended format record for default column formatting.

Declaration
public ushort ExtendedFormatIndex { get; set; }
Property Value
Type Description
System.UInt16

FirstColumn

Index of first column in the range.

Declaration
public ushort FirstColumn { get; set; }
Property Value
Type Description
System.UInt16

IsCollapsed

If 1, then columns are collapsed.

Declaration
public bool IsCollapsed { get; set; }
Property Value
Type Description
System.Boolean

IsHidden

Columns are hidden.

Declaration
public bool IsHidden { get; set; }
Property Value
Type Description
System.Boolean

LastColumn

Index of the last column in the range.

Declaration
public ushort LastColumn { get; set; }
Property Value
Type Description
System.UInt16

MaximumRecordSize

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

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

MinimumRecordSize

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

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

OutlineLevel

Outline level of the columns (0 = no outline). This property changes bits of private m_usOptions field. Set method would raise ArgumentOutOfRange exception if value is more than 7.

Declaration
public ushort OutlineLevel { get; set; }
Property Value
Type Description
System.UInt16

Reserved

Read-only. Reserved value.

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

Methods

CompareTo(Object)

Compares this record with another ColumnInfoRecord.

Declaration
public int CompareTo(object obj)
Parameters
Type Name Description
System.Object obj

Object to compare with.
Returns
Type Description
System.Int32

0 if specified record is equal to the current record; otherwise -1.

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 Description
System.Int32
Overrides
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.GetStoreSize(Syncfusion.XlsIO.ExcelVersion)

ParseStructure(DataProvider, Int32, Int32, ExcelVersion)

Parse structure of record. Converts 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)

SetDefaultOptions()

Sets options into default state without setting extended format index.

Declaration
public void SetDefaultOptions()

Explicit Interface Implementations

IOutline.Index

Row or column index.

Declaration
ushort IOutline.Index { get; set; }
Returns
Type Description
System.UInt16

Implements

System.ICloneable
System.IComparable