Table of Contents

BiffRkRecord Struct

Definition

Namespace
Bodu.IO.Biff
Assembly
Bodu.IO.Biff.dll
Package
Bodu.IO.Biff 1.0.0
Source
BiffRkRecord.cs

Represents a decoded RK record: a cell holding a number in the compact RK encoding.

public readonly struct BiffRkRecord : IEquatable<BiffRkRecord>
Implements
Inherited Members
Extension Methods

Remarks

The record identifier is Rk. The payload is ten bytes in both versions: the cell prefix, then the 32-bit RK value that Decode(uint) interprets.

Constructors

BiffRkRecord(int, int, ushort, uint)

Represents a decoded RK record: a cell holding a number in the compact RK encoding.

public BiffRkRecord(int Row, int Column, ushort XfIndex, uint RawValue)

Parameters

Row int

The zero-based row index.

Column int

The zero-based column index.

XfIndex ushort

The extended-format index of the cell.

RawValue uint

The 32-bit RK value as stored.

Remarks

The record identifier is Rk. The payload is ten bytes in both versions: the cell prefix, then the 32-bit RK value that Decode(uint) interprets.

See Also

Properties

Column

The zero-based column index.

public int Column { get; init; }

Property Value

int

RawValue

The 32-bit RK value as stored.

public uint RawValue { get; init; }

Property Value

uint

Row

The zero-based row index.

public int Row { get; init; }

Property Value

int

Value

Gets the decoded cell value.

public double Value { get; }

Property Value

double

The number RawValue represents.

XfIndex

The extended-format index of the cell.

public ushort XfIndex { get; init; }

Property Value

ushort

Methods

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

public void Deconstruct(out int Row, out int Column, out ushort XfIndex, out uint RawValue)

Parameters

Row int
Column int
XfIndex ushort
RawValue uint

Equals(BiffRkRecord)

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

public bool Equals(BiffRkRecord other)

Parameters

other BiffRkRecord

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

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

Parameters

left BiffRkRecord
right BiffRkRecord

Returns

bool

operator !=(BiffRkRecord, BiffRkRecord) 

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

Parameters

left BiffRkRecord
right BiffRkRecord

Returns

bool

Applies to

ProductVersions
.NET8, 10

See Also

GetRk()
WriteRk(int, int, ushort, uint)
BiffRk