Class ExtendedFormatRecord

One of the most complex records. There are two types: Style and Cell. It should be noted that fields in the extended format record are somewhat arbitrary. Almost all of the fields are bit-level, but we name them as best as possible by functional group. In some places, this is more conducive than others.

Inheritance

System.Object

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw

ExtendedFormatRecord

Implements

System.ICloneable

IBiffStorage

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

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

[Biff(TBIFFRecord.ExtendedFormat)]
[CLSCompliant(false)]
public class ExtendedFormatRecord : BiffRecordRaw, ICloneable, IBiffStorage

Constructors

ExtendedFormatRecord()

Default constructor

Declaration

public ExtendedFormatRecord()

ExtendedFormatRecord(Int32)

Reserved for the record's internal data array.

Declaration

public ExtendedFormatRecord(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.

ExtendedFormatRecord(Stream, out Int32)

Read / initialize constructor.

Declaration

public ExtendedFormatRecord(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_DEFAULT_COLOR_INDEX

Default color index.

Declaration

public const int DEF_DEFAULT_COLOR_INDEX = 65

Field Value

Type
System.Int32

DEF_DEFAULT_PATTERN_COLOR_INDEX

Default pattern color index.

Declaration

public const int DEF_DEFAULT_PATTERN_COLOR_INDEX = 64

Field Value

Type
System.Int32

Properties

_123Prefix

Declaration

public bool _123Prefix { get; set; }

Property Value

Type
System.Boolean

AdtlFillPattern

Fill pattern: This property changes bits of the m_uiAddPaletteOptions class member.

Declaration

public ushort AdtlFillPattern { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x3F.

AlignmentOptions

Alignment options bits in one location. Read-only.

Declaration

public int AlignmentOptions { get; }

Property Value

Type
System.Int32

BorderBottom

Bottom line style: This property changes bits of the m_usBorderOptions class member.

Declaration

public ExcelLineStyle BorderBottom { get; set; }

Property Value

Type
ExcelLineStyle

BorderLeft

Left line style: This property changes bits of the m_usBorderOptions class member.

Declaration

public ExcelLineStyle BorderLeft { get; set; }

Property Value

Type
ExcelLineStyle

BorderOptions

Border options bits in one location. Read-only.

Declaration

public int BorderOptions { get; }

Property Value

Type
System.Int32

BorderRight

Right line style: This property changes bits of the m_usBorderOptions class member.

Declaration

public ExcelLineStyle BorderRight { get; set; }

Property Value

Type
ExcelLineStyle

BorderTop

Top line style: This property changes bits of the m_usBorderOptions class member.

Declaration

public ExcelLineStyle BorderTop { get; set; }

Property Value

Type
ExcelLineStyle

BottomBorderPaletteIndex

Color index for bottom line color. This property changes bits of the m_uiAddPaletteOptions class member.

Declaration

public ushort BottomBorderPaletteIndex { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x7F.

CellOptions

Cell options bits in one location. Read-only.

Declaration

public int CellOptions { get; }

Property Value

Type
System.Int32

DiagonalFromBottomLeft

Diagonal line is drawing from bottom left to top right corner of cell.

Declaration

public bool DiagonalFromBottomLeft { get; set; }

Property Value

Type
System.Boolean

DiagonalFromTopLeft

Diagonal line is drawing from top left to bottom right corner of cell.

Declaration

public bool DiagonalFromTopLeft { get; set; }

Property Value

Type
System.Boolean

DiagonalLineColor

Color index for diagonal line color. This property changes bits of the m_uiAddPaletteOptions class member.

Declaration

public ushort DiagonalLineColor { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x7F.

DiagonalLineStyle

Diagonal line style. This property changes bits of the m_uiAddPaletteOptions class member.

Declaration

public ushort DiagonalLineStyle { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x0F.

FillBackground

Color index for pattern color This property changes bits of m_usFillPaletteOptions.

Declaration

public ushort FillBackground { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x7F.

FillForeground

Color index for pattern background. This property changes bits of m_usFillPaletteOptions.

Declaration

public ushort FillForeground { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x7F.

FontIndex

Index to font record.

Declaration

public ushort FontIndex { get; set; }

Property Value

Type
System.UInt16

FormatIndex

Index to FORMAT record:

Declaration

public ushort FormatIndex { get; set; }

Property Value

Type
System.UInt16

HAlignmentType

Horizontal alignment.

Declaration

public ExcelHAlign HAlignmentType { get; set; }

Property Value

Type
ExcelHAlign

Indent

Gets or sets indent level.

Declaration

public byte Indent { get; set; }

Property Value

Type
System.Byte

IsHidden

True if formula is hidden.

Declaration

public bool IsHidden { get; set; }

Property Value

Type
System.Boolean

IsLocked

True if cell is locked.

Declaration

public bool IsLocked { get; set; }

Property Value

Type
System.Boolean

IsNotParentAlignment

Flag for horizontal and vertical alignment, text wrap, indentation, orientation, rotation, and text direction. If False, then an attribute of the parent style is used.

Declaration

public bool IsNotParentAlignment { get; set; }

Property Value

Type
System.Boolean

IsNotParentBorder

Flag for border lines. If False, then an attribute of the parent style is used.

Declaration

public bool IsNotParentBorder { get; set; }

Property Value

Type
System.Boolean

IsNotParentCellOptions

Flag for cell protection (cell locked and formula hidden). If False, then attributes of the parent style is used.

Declaration

public bool IsNotParentCellOptions { get; set; }

Property Value

Type
System.Boolean

IsNotParentFont

Flag for font, if False, then an attribute of the parent style is used.

Declaration

public bool IsNotParentFont { get; set; }

Property Value

Type
System.Boolean

IsNotParentFormat

Flag for number format, if False, then an attribute of the parent style is used.

Declaration

public bool IsNotParentFormat { get; set; }

Property Value

Type
System.Boolean

IsNotParentPattern

Flag for background area style. If False, then an attribute of the parent style is used.

Declaration

public bool IsNotParentPattern { get; set; }

Property Value

Type
System.Boolean

JustifyLast

For far east languages supported only for format, always use False for US.

Declaration

public bool JustifyLast { get; set; }

Property Value

Type
System.Boolean

LeftBorderPaletteIndex

Color index for left line color This property changes bits of the m_usPaletteOptions class member.

Declaration

public ushort LeftBorderPaletteIndex { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x7F.

MaximumRecordSize

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

Declaration

public override int MaximumRecordSize { get; }

Property Value

Type
System.Int32

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.MaximumRecordSize

MergeCells

True if extended format contains merged cells.

Declaration

public bool MergeCells { get; set; }

Property Value

Type
System.Boolean

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

ParentIndex

Gets /sets index to parent style XF (always FFFH in style XFs in Excel 97).

Declaration

public ushort ParentIndex { get; set; }

Property Value

Type
System.UInt16

ReadingOrder

Text direction, the reading order for far east versions.

Declaration

public ushort ReadingOrder { get; set; }

Property Value

Type
System.UInt16

RightBorderPaletteIndex

Color index for right line color. This property changes bits of the m_usPaletteOptions class member.

Declaration

public ushort RightBorderPaletteIndex { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x7F.

Rotation

Text rotation angle: 0- Not rotated 1-90- 1 to 90 degrees counterclockwise 91-180- 1 to 90 degrees clockwise 255- Letters are stacked top-to-bottom, but not rotated.

Declaration

public ushort Rotation { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0xFF.

ShrinkToFit

True means to shrink content to fit into cell.

Declaration

public bool ShrinkToFit { get; set; }

Property Value

Type
System.Boolean

TopBorderPaletteIndex

Color index for top line color. This property changes bits of the m_uiAddPaletteOptions class member.

Declaration

public ushort TopBorderPaletteIndex { get; set; }

Property Value

Type
System.UInt16

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Thrown when value is more than 0x7F.

VAlignmentType

Vertical alignment.

Declaration

public ExcelVAlign VAlignmentType { get; set; }

Property Value

Type
ExcelVAlign

WrapText

True means that text is wrapped at right border.

Declaration

public bool WrapText { get; set; }

Property Value

Type
System.Boolean

XFType

Type of extended format record.

Declaration

public ExtendedFormatRecord.TXFType XFType { get; set; }

Property Value

Type
ExtendedFormatRecord.TXFType

Methods

CompareTo(ExtendedFormatRecord)

Compares with Extended format record.

Declaration

public int CompareTo(ExtendedFormatRecord twin)

Parameters

Type	Name	Description
ExtendedFormatRecord	twin	Param to compare.

Returns

Type	Description
System.Int32	Returns compare results.

CopyAlignment(ExtendedFormatRecord)

Copies alignment settings from another extended format record.

Declaration

public void CopyAlignment(ExtendedFormatRecord source)

Parameters

Type	Name	Description
ExtendedFormatRecord	source	Source record to copy data from.

CopyBorders(ExtendedFormatRecord)

Copies border settings from another extended format record.

Declaration

public void CopyBorders(ExtendedFormatRecord source)

Parameters

Type	Name	Description
ExtendedFormatRecord	source	Source record to copy data from.

CopyPatterns(ExtendedFormatRecord)

Copies pattern settings from another extended format record.

Declaration

public void CopyPatterns(ExtendedFormatRecord source)

Parameters

Type	Name	Description
ExtendedFormatRecord	source	Source record to copy data from.

CopyProtection(ExtendedFormatRecord)

Copies protection / cells settings from another extended format record.

Declaration

public void CopyProtection(ExtendedFormatRecord source)

Parameters

Type	Name	Description
ExtendedFormatRecord	source	Source record to copy data from.

CopyTo(BiffRecordRaw)

Copies data from the current Biff record to the specified Biff record.

Declaration

public override void CopyTo(BiffRecordRaw raw)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw	raw	Biff record that will receive data from the current record.

Overrides

Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw.CopyTo(Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw)

CopyTo(ExtendedFormatRecord)

Copies data from the current ExtendedFormat record to the specified ExtendedFormat record.

Declaration

public void CopyTo(ExtendedFormatRecord twin)

Parameters

Type	Name	Description
ExtendedFormatRecord	twin	ExtendedFormat record that will receive data from the current record.

GetHashCode()

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current Object.

Overrides

System.Object.GetHashCode()

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)

Exceptions

Type	Condition
WrongBiffRecordDataException	If there is any internal error.

Implements

System.ICloneable

IBiffStorage