Class RowParser

Inheritance

System.Object

RowParser

Inherited Members

System.Object.Equals(System.Object)

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Lumina.Excel

Assembly: Lumina.dll

Syntax

public class RowParser

Constructors

| Improve this Doc View Source

RowParser(ExcelSheetImpl, ExcelDataFile)

Declaration

public RowParser(ExcelSheetImpl sheet, ExcelDataFile dataFile)

Parameters

Type	Name	Description
ExcelSheetImpl	sheet
ExcelDataFile	dataFile

| Improve this Doc View Source

RowParser(ExcelSheetImpl, ExcelDataFile, UInt32)

Declaration

public RowParser(ExcelSheetImpl sheet, ExcelDataFile dataFile, uint row)

Parameters

Type	Name	Description
ExcelSheetImpl	sheet
ExcelDataFile	dataFile
System.UInt32	row

| Improve this Doc View Source

RowParser(ExcelSheetImpl, ExcelDataFile, UInt32, UInt32)

Declaration

public RowParser(ExcelSheetImpl sheet, ExcelDataFile dataFile, uint row, uint subRow)

Parameters

Type	Name	Description
ExcelSheetImpl	sheet
ExcelDataFile	dataFile
System.UInt32	row
System.UInt32	subRow

Fields

| Improve this Doc View Source

Row

Declaration

public uint Row

Field Value

Type	Description
System.UInt32

| Improve this Doc View Source

SubRow

Declaration

public uint SubRow

Field Value

Type	Description
System.UInt32

Properties

| Improve this Doc View Source

RowCount

Declaration

public uint RowCount { get; }

Property Value

Type	Description
System.UInt32

Methods

| Improve this Doc View Source

CalculateSubRowOffset(UInt32)

Declaration

public long CalculateSubRowOffset(uint subRow)

Parameters

Type	Name	Description
System.UInt32	subRow

Returns

Type	Description
System.Int64

| Improve this Doc View Source

ReadBytes(Int32, Int32)

Read n bytes starting from the row offset + offset

Declaration

public byte[] ReadBytes(int offset, int count)

Parameters

Type	Name	Description
System.Int32	offset	The offset inside the row
System.Int32	count	The number of bytes to read

Returns

Type	Description
System.Byte[]	A copy of the read bytes

| Improve this Doc View Source

ReadColumn<T>(Int32)

Read a type from a column index in the row

Declaration

public T ReadColumn<T>(int column)

Parameters

Type	Name	Description
System.Int32	column	The column index to lookup

Returns

Type	Description
T	The read data contained in the provided type

Type Parameters

Name	Description
T	The type to store the read data in

| Improve this Doc View Source

ReadColumnRaw(Int32)

Declaration

public object ReadColumnRaw(int column)

Parameters

Type	Name	Description
System.Int32	column

Returns

Type	Description
System.Object

| Improve this Doc View Source

ReadOffset<T>(Int32, ExcelColumnDataType)

Read a type from an offset in the row

Declaration

public T ReadOffset<T>(int offset, ExcelColumnDataType type)

Parameters

Type	Name	Description
System.Int32	offset	The offset to read from
ExcelColumnDataType	type	The excel column type to read

Returns

Type	Description
T	The read data contained in the provided type

Type Parameters

Name	Description
T

| Improve this Doc View Source

ReadOffset<T>(UInt16, Byte)

Read a type from an offset in the row

Declaration

public T ReadOffset<T>(ushort offset, byte bit = 0)

Parameters

Type	Name	Description
System.UInt16	offset	The offset to read from
System.Byte	bit	Read a specific bit from the underlying position - useful for bools

Returns

Type	Description
T	The read data contained in the provided type

Type Parameters

Name	Description
T	The type to store the data in

| Improve this Doc View Source

ReadStructure<T>(Int32)

Reads a structure from an offset inside the current row

Declaration

public T ReadStructure<T>(int offset)
    where T : struct

Parameters

Type	Name	Description
System.Int32	offset	The offset to start reading from

Returns

Type	Description
T	The read structure filled from the row data

Type Parameters

Name	Description
T	The type of struct to read out from the row

| Improve this Doc View Source

ReadStructures<T>(Int32, Int32)

Reads structures from an offset inside the current row

Declaration

public List<T> ReadStructures<T>(int offset, int count)
    where T : struct

Parameters

Type	Name	Description
System.Int32	offset	The offset to start reading from
System.Int32	count	The number of structures to read sequentially

Returns

Type	Description
System.Collections.Generic.List<T>	The read structures filled from the row data

Type Parameters

Name	Description
T	The type of struct to read out from the row

| Improve this Doc View Source

ReadStructuresAsArray<T>(Int32, Int32)

Reads structures from an offset inside the current row

Declaration

public T[] ReadStructuresAsArray<T>(int offset, int count)
    where T : struct

Parameters

Type	Name	Description
System.Int32	offset	The offset to start reading from
System.Int32	count	The number of structures to read sequentially

Returns

Type	Description
T[]	The read structures filled from the row data

Type Parameters

Name	Description
T	The type of struct to read out from the row

| Improve this Doc View Source

SeekToRow(UInt32)

Moves the parser to a row in the current page given its index

Declaration

public void SeekToRow(uint row)

Parameters

Type	Name	Description
System.UInt32	row	The row index to seek to

| Improve this Doc View Source

SeekToRow(UInt32, UInt32)

Moves the parser to a row + subrow in the current page given their indexes

Declaration

public void SeekToRow(uint row, uint subRow)

Parameters

Type	Name	Description
System.UInt32	row	The row index to seek to
System.UInt32	subRow	The subrow index to seek to

Exceptions

Type	Condition
System.IndexOutOfRangeException	Given subrow index was out of bounds