BiffXfRecord Struct

Definition

Namespace

Bodu.IO.Biff

Assembly

Bodu.IO.Biff.dll

Package

Bodu.IO.Biff 1.0.0

Source

BiffXfRecord.cs

Represents the leading fields of a decoded XF (extended format) record: the font and number-format indices and the protection and style flags. Alignment, border, and fill fields that follow are not interpreted.

public readonly struct BiffXfRecord : IEquatable<BiffXfRecord>

Implements

IEquatable<BiffXfRecord>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

BufferConverter.CopyTo<T>(T, byte[], int)

ComparableExtensions.AtLeast<T>(T, T, IComparer<T>)

ComparableExtensions.AtMost<T>(T, T, IComparer<T>)

ComparableExtensions.Clamp<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsBetween<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.IsEqualTo<T>(T, T, IComparer<T>)

ComparableExtensions.IsGreaterThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsGreaterThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThanOrEqual<T>(T, T?, IComparer<T>)

ComparableExtensions.IsLessThan<T>(T, T?, IComparer<T>)

ComparableExtensions.IsOutside<T>(T, T?, T?, IComparer<T>)

ComparableExtensions.Max<T>(T, T, IComparer<T>)

ComparableExtensions.Min<T>(T, T, IComparer<T>)

Remarks

The first six bytes are laid out identically in BIFF5 (16-byte record) and BIFF8 (20-byte record).

Constructors

BiffXfRecord(ushort, ushort, ushort)

Represents the leading fields of a decoded XF (extended format) record: the font and number-format indices and the protection and style flags. Alignment, border, and fill fields that follow are not interpreted.

public BiffXfRecord(ushort FontIndex, ushort FormatIndex, ushort TypeField)

Parameters

FontIndex ushort

The index of the cell's font in the FONT record sequence.

FormatIndex ushort

The index of the cell's number format.

TypeField ushort

The raw type-and-protection word: locked (bit 0), hidden (bit 1), style (bit 2), parent style index (bits 4-15).

Remarks

The first six bytes are laid out identically in BIFF5 (16-byte record) and BIFF8 (20-byte record).

See Also

GetXf()

WriteXf(in BiffXfRecord)

BiffFormatRecord

BiffFontRecord

Properties

FontIndex

The index of the cell's font in the FONT record sequence.

public ushort FontIndex { get; init; }

Property Value

ushort

FormatIndex

The index of the cell's number format.

public ushort FormatIndex { get; init; }

Property Value

ushort

IsHidden

Gets a value indicating whether the cell's formula is hidden.

public bool IsHidden { get; }

Property Value

bool

true when bit 1 of TypeField is set.

IsLocked

Gets a value indicating whether the cell is locked.

public bool IsLocked { get; }

Property Value

bool

true when bit 0 of TypeField is set.

IsStyle

Gets a value indicating whether the record describes a style rather than a cell format.

public bool IsStyle { get; }

Property Value

bool

true when bit 2 of TypeField is set.

ParentStyleIndex

Gets the index of the parent style format.

public int ParentStyleIndex { get; }

Property Value

int

Bits 4-15 of TypeField; 0xFFF for a style record with no parent.

TypeField

The raw type-and-protection word: locked (bit 0), hidden (bit 1), style (bit 2), parent style index (bits 4-15).

public ushort TypeField { get; init; }

Property Value

ushort

Methods

Deconstruct(out ushort, out ushort, out ushort)

public void Deconstruct(out ushort FontIndex, out ushort FormatIndex, out ushort TypeField)

Parameters

FontIndex ushort

FormatIndex ushort

TypeField ushort

Equals(BiffXfRecord)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(BiffXfRecord other)

Parameters

other BiffXfRecord

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator ==(BiffXfRecord, BiffXfRecord)

public static bool operator ==(BiffXfRecord left, BiffXfRecord right)

Parameters

left BiffXfRecord

right BiffXfRecord

Returns

bool

operator !=(BiffXfRecord, BiffXfRecord)

public static bool operator !=(BiffXfRecord left, BiffXfRecord right)

Parameters

left BiffXfRecord

right BiffXfRecord

Returns

bool

Applies to

Product	Versions
.NET	8, 10

See Also

GetXf()

WriteXf(in BiffXfRecord)

BiffFormatRecord

BiffFontRecord