Class ExcelSheetImpl

Inheritance

System.Object

ExcelSheetImpl

ExcelSheet<T>

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 ExcelSheetImpl

Fields

| Improve this Doc View Source

DataPages

The parsed data pages

Declaration

public readonly List<ExcelPage> DataPages

Field Value

Type	Description
System.Collections.Generic.List<ExcelPage>

Properties

| Improve this Doc View Source

ColumnCount

The total number of columns

Declaration

public uint ColumnCount { get; }

Property Value

Type	Description
System.UInt32

| Improve this Doc View Source

Columns

Declaration

public ExcelColumnDefinition[] Columns { get; }

Property Value

Type	Description
ExcelColumnDefinition[]

| Improve this Doc View Source

ColumnsByOffset

Declaration

public Dictionary<ushort, ExcelColumnDefinition> ColumnsByOffset { get; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.UInt16, ExcelColumnDefinition>

| Improve this Doc View Source

DataPagination

Returns the data pages contained in the Excel header

Declaration

public ExcelDataPagination[] DataPagination { get; }

Property Value

Type	Description
ExcelDataPagination[]

| Improve this Doc View Source

Header

A quick accessor to the data available in the sheet header

Declaration

public ExcelHeaderHeader Header { get; }

Property Value

Type	Description
ExcelHeaderHeader

| Improve this Doc View Source

HeaderFile

The header of the sheet which defines its properties such as total row count, pages and languages

Declaration

public ExcelHeaderFile HeaderFile { get; }

Property Value

Type	Description
ExcelHeaderFile

| Improve this Doc View Source

Languages

The available languages for this sheet.

Declaration

public Language[] Languages { get; }

Property Value

Type	Description
Language[]

Remarks

You will need to reload this sheet with a different language if you want to access a single sheet in more than 1 language at a time.

| Improve this Doc View Source

Name

The name of the sheet

Declaration

public string Name { get; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

RequestedLanguage

The language that was requested for this sheet when it was loaded

Declaration

public Language RequestedLanguage { get; protected set; }

Property Value

Type	Description
Language

| Improve this Doc View Source

RowCount

The total count of rows irrespective of paging

Declaration

public uint RowCount { get; }

Property Value

Type	Description
System.UInt32

| Improve this Doc View Source

Variant

The kind of sheet

Declaration

public ExcelVariant Variant { get; }

Property Value

Type	Description
ExcelVariant

Methods

| Improve this Doc View Source

GenerateFilePath(String, UInt32, Language)

Generates an absolute path to a data file for a sheet

Declaration

protected string GenerateFilePath(string name, uint startId, Language language)

Parameters

Type	Name	Description
System.String	name	The sheet name
System.UInt32	startId	The page row start index
Language	language	The requested language

Returns

Type	Description
System.String	An absolute path to the file

| Improve this Doc View Source

GetPageForRow(UInt32)

Gets the corresponding data page for a given row

Declaration

public ExcelPage GetPageForRow(uint row)

Parameters

Type	Name	Description
System.UInt32	row	The row id to fetch the parent page for

Returns

Type	Description
ExcelPage	The ExcelPage if found, null otherwise

| Improve this Doc View Source

ProcessDataEndianness(ExcelDataFile)

Reverses the endianness of a data file on LE machines so the underlying stream can be copied from as is

Declaration

protected void ProcessDataEndianness(ExcelDataFile file)

Parameters

Type	Name	Description
ExcelDataFile	file	The file to swap endianness for

| Improve this Doc View Source

ProcessDataRow(Int64, MemoryStream, BinaryWriter, BinaryReader)

Reverses an inner segment of data based on the column size

Declaration

protected void ProcessDataRow(long offset, MemoryStream ms, BinaryWriter bw, BinaryReader br)

Parameters

Type	Name	Description
System.Int64	offset	The row offset to start from
System.IO.MemoryStream	ms	The underlying System.IO.MemoryStream that contains the file data
System.IO.BinaryWriter	bw	Used to write the correct data back into the System.IO.MemoryStream
System.IO.BinaryReader	br	Used to read the correctly sized data from the underlying System.IO.MemoryStream