BiffRowRecord Struct

Definition

Namespace

Bodu.IO.Biff

Assembly

Bodu.IO.Biff.dll

Package

Bodu.IO.Biff 1.0.0

Source

BiffRowRecord.cs

Represents a decoded ROW record: a row's used column extent, height, option flags, and default format.

public readonly struct BiffRowRecord : IEquatable<BiffRowRecord>

Implements

IEquatable<BiffRowRecord>

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 record identifier is Row. The payload is sixteen bytes in both versions; the two reserved words at offsets 8 through 11 are not interpreted. The derived properties mask the raw fields: Height, HasCustomHeight, IsHidden, OutlineLevel, HasFormat, and XfIndex.

Constructors

BiffRowRecord(int, int, int, ushort, ushort, ushort)

Represents a decoded ROW record: a row's used column extent, height, option flags, and default format.

public BiffRowRecord(int Row, int FirstColumn, int LastColumnExclusive, ushort HeightField, ushort Options, ushort XfField)

Parameters

Row int

The zero-based row index.

FirstColumn int

The zero-based index of the first defined cell in the row.

LastColumnExclusive int

One past the zero-based index of the last defined cell in the row.

HeightField ushort

The raw miyRw field: the height in twips in its low 15 bits.

Options ushort

The raw option flags (grbit).

XfField ushort

The raw format field: the extended-format index in its low 12 bits.

Remarks

The record identifier is Row. The payload is sixteen bytes in both versions; the two reserved words at offsets 8 through 11 are not interpreted. The derived properties mask the raw fields: Height, HasCustomHeight, IsHidden, OutlineLevel, HasFormat, and XfIndex.

See Also

GetRow()

WriteRow(in BiffRowRecord)

Properties

FirstColumn

The zero-based index of the first defined cell in the row.

public int FirstColumn { get; init; }

Property Value

int

HasCustomHeight

Gets a value indicating whether the row height differs from the sheet default.

public bool HasCustomHeight { get; }

Property Value

bool

true when the custom-height option flag (bit 6) is set.

HasFormat

Gets a value indicating whether the row carries an explicit default format.

public bool HasFormat { get; }

Property Value

bool

true when the format option flag (bit 7) is set.

Height

Gets the row height in twips (twentieths of a point).

public int Height { get; }

Property Value

int

The low 15 bits of HeightField.

HeightField

The raw miyRw field: the height in twips in its low 15 bits.

public ushort HeightField { get; init; }

Property Value

ushort

IsHidden

Gets a value indicating whether the row is hidden.

public bool IsHidden { get; }

Property Value

bool

true when the collapsed/hidden option flag (bit 5) is set.

LastColumnExclusive

One past the zero-based index of the last defined cell in the row.

public int LastColumnExclusive { get; init; }

Property Value

int

Options

The raw option flags (grbit).

public ushort Options { get; init; }

Property Value

ushort

OutlineLevel

Gets the outline level of the row.

public int OutlineLevel { get; }

Property Value

int

The low three bits of Options.

Row

The zero-based row index.

public int Row { get; init; }

Property Value

int

XfField

The raw format field: the extended-format index in its low 12 bits.

public ushort XfField { get; init; }

Property Value

ushort

XfIndex

Gets the extended-format index applied to cells the row does not define individually.

public ushort XfIndex { get; }

Property Value

ushort

The low 12 bits of XfField.

Methods

Deconstruct(out int, out int, out int, out ushort, out ushort, out ushort)

public void Deconstruct(out int Row, out int FirstColumn, out int LastColumnExclusive, out ushort HeightField, out ushort Options, out ushort XfField)

Parameters

Row int

FirstColumn int

LastColumnExclusive int

HeightField ushort

Options ushort

XfField ushort

Equals(BiffRowRecord)

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

public bool Equals(BiffRowRecord other)

Parameters

other BiffRowRecord

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 ==(BiffRowRecord, BiffRowRecord)

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

Parameters

left BiffRowRecord

right BiffRowRecord

Returns

bool

operator !=(BiffRowRecord, BiffRowRecord)

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

Parameters

left BiffRowRecord

right BiffRowRecord

Returns

bool

Applies to

Product	Versions
.NET	8, 10

See Also

GetRow()

WriteRow(in BiffRowRecord)