C# Класс Smrf.NodeXL.ExcelTemplate.WorksheetReaderBase

Base class for classes that know how to read an Excel worksheet containing graph data.
There is one derived class for each worksheet in a NodeXL workbook that contains graph data. There are additional derived classes for reading tables contained in the hidden Miscellaneous worksheet.
Наследование: Smrf.NodeXL.Core.NodeXLBase
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
EmptyIDArray System.Int32[]

Защищенные свойства (Protected)

Свойство Тип Описание
m_oAlphaConverter AlphaConverter

Открытые методы

Метод Описание
AssertValid ( ) : void
VertexNameToVertex ( String vertexName, IVertexCollection vertices, IVertex>.Dictionary vertexNameDictionary ) : IVertex
WorksheetReaderBase ( ) : System

Initializes a new instance of the WorksheetReaderBase class.

Защищенные методы

Метод Описание
CreateVertex ( String sVertexName, IVertexCollection oVertices, IVertex>.Dictionary oVertexNameDictionary ) : IVertex
FillIDColumn ( ListObject oTable ) : void
FilterColumnNames ( ExcelTableReader oExcelTableReader, HashSet oColumnNamesToExclude ) : String[]
GetTableColumnIndex ( ListObject oTable, String sColumnName, System.Boolean bColumnIsRequired ) : Int32
HideVertex ( IVertex oVertex ) : void
OnInvalidVisibility ( ExcelTableReader oRow ) : void
OnWorkbookFormatError ( String sMessage ) : void
OnWorkbookFormatError ( String sMessage, Range oRangeToSelect ) : void
OnWorkbookFormatErrorWithDropDown ( ExcelTableReader oRow, String sColumnName, String sInvalidCellDescription ) : void
ReadAllColumns ( ExcelTableReader oExcelTableReader, ExcelTableReader oRow, IMetadataProvider oEdgeOrVertex, HashSet oColumnNamesToExclude ) : void
ReadAlpha ( ExcelTableReader oRow, IMetadataProvider oEdgeOrVertex ) : System.Boolean
ReadCellAndSetMetadata ( ExcelTableReader oRow, String sColumnName, IMetadataProvider oEdgeOrVertex, String sKeyName ) : System.Boolean
ReadColor ( ExcelTableReader oRow, String sColumnName, IMetadataProvider oEdgeOrVertex, String sColorKey, ColorConverter2 oColorConverter2 ) : void
RemoveVertex ( IVertex oVertex, ReadWorkbookContext oReadWorkbookContext, IGraph oGraph ) : void
TryGetBoolean ( ExcelTableReader oRow, String sColumnName, BooleanConverter oBooleanConverter, System.Boolean &bBoolean ) : System.Boolean
TryGetColor ( ExcelTableReader oRow, String sColumnName, ColorConverter2 oColorConverter2, Color &oColor ) : System.Boolean
TryGetLocation ( ExcelTableReader oRow, String sXColumnName, String sYColumnName, VertexLocationConverter oVertexLocationConverter, PointF &oLocation ) : System.Boolean
TryGetVertexShape ( ExcelTableReader oRow, String sColumnName, VertexShape &eShape ) : System.Boolean

Описание методов

AssertValid() публичный Метод

public AssertValid ( ) : void
Результат void

CreateVertex() защищенный статический Метод

protected static CreateVertex ( String sVertexName, IVertexCollection oVertices, IVertex>.Dictionary oVertexNameDictionary ) : IVertex
sVertexName String
oVertices IVertexCollection
oVertexNameDictionary IVertex>.Dictionary
Результат IVertex

FillIDColumn() защищенный Метод

protected FillIDColumn ( ListObject oTable ) : void
oTable ListObject
Результат void

FilterColumnNames() защищенный Метод

protected FilterColumnNames ( ExcelTableReader oExcelTableReader, HashSet oColumnNamesToExclude ) : String[]
oExcelTableReader Smrf.AppLib.ExcelTableReader
oColumnNamesToExclude HashSet
Результат String[]

GetTableColumnIndex() защищенный Метод

protected GetTableColumnIndex ( ListObject oTable, String sColumnName, System.Boolean bColumnIsRequired ) : Int32
oTable ListObject
sColumnName String
bColumnIsRequired System.Boolean
Результат System.Int32

HideVertex() защищенный Метод

protected HideVertex ( IVertex oVertex ) : void
oVertex IVertex
Результат void

OnInvalidVisibility() защищенный Метод

protected OnInvalidVisibility ( ExcelTableReader oRow ) : void
oRow Smrf.AppLib.ExcelTableReader
Результат void

OnWorkbookFormatError() защищенный Метод

protected OnWorkbookFormatError ( String sMessage ) : void
sMessage String
Результат void

OnWorkbookFormatError() защищенный Метод

protected OnWorkbookFormatError ( String sMessage, Range oRangeToSelect ) : void
sMessage String
oRangeToSelect Range
Результат void

OnWorkbookFormatErrorWithDropDown() защищенный Метод

protected OnWorkbookFormatErrorWithDropDown ( ExcelTableReader oRow, String sColumnName, String sInvalidCellDescription ) : void
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
sInvalidCellDescription String
Результат void

ReadAllColumns() защищенный Метод

protected ReadAllColumns ( ExcelTableReader oExcelTableReader, ExcelTableReader oRow, IMetadataProvider oEdgeOrVertex, HashSet oColumnNamesToExclude ) : void
oExcelTableReader Smrf.AppLib.ExcelTableReader
oRow Smrf.AppLib.ExcelTableReader
oEdgeOrVertex IMetadataProvider
oColumnNamesToExclude HashSet
Результат void

ReadAlpha() защищенный Метод

protected ReadAlpha ( ExcelTableReader oRow, IMetadataProvider oEdgeOrVertex ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
oEdgeOrVertex IMetadataProvider
Результат System.Boolean

ReadCellAndSetMetadata() защищенный Метод

protected ReadCellAndSetMetadata ( ExcelTableReader oRow, String sColumnName, IMetadataProvider oEdgeOrVertex, String sKeyName ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
oEdgeOrVertex IMetadataProvider
sKeyName String
Результат System.Boolean

ReadColor() защищенный Метод

protected ReadColor ( ExcelTableReader oRow, String sColumnName, IMetadataProvider oEdgeOrVertex, String sColorKey, ColorConverter2 oColorConverter2 ) : void
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
oEdgeOrVertex IMetadataProvider
sColorKey String
oColorConverter2 ColorConverter2
Результат void

RemoveVertex() защищенный Метод

protected RemoveVertex ( IVertex oVertex, ReadWorkbookContext oReadWorkbookContext, IGraph oGraph ) : void
oVertex IVertex
oReadWorkbookContext ReadWorkbookContext
oGraph IGraph
Результат void

TryGetBoolean() защищенный Метод

protected TryGetBoolean ( ExcelTableReader oRow, String sColumnName, BooleanConverter oBooleanConverter, System.Boolean &bBoolean ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
oBooleanConverter BooleanConverter
bBoolean System.Boolean
Результат System.Boolean

TryGetColor() защищенный Метод

protected TryGetColor ( ExcelTableReader oRow, String sColumnName, ColorConverter2 oColorConverter2, Color &oColor ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
oColorConverter2 ColorConverter2
oColor Color
Результат System.Boolean

TryGetLocation() защищенный Метод

protected TryGetLocation ( ExcelTableReader oRow, String sXColumnName, String sYColumnName, VertexLocationConverter oVertexLocationConverter, PointF &oLocation ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sXColumnName String
sYColumnName String
oVertexLocationConverter VertexLocationConverter
oLocation System.Drawing.PointF
Результат System.Boolean

TryGetVertexShape() защищенный Метод

protected TryGetVertexShape ( ExcelTableReader oRow, String sColumnName, VertexShape &eShape ) : System.Boolean
oRow Smrf.AppLib.ExcelTableReader
sColumnName String
eShape VertexShape
Результат System.Boolean

VertexNameToVertex() публичный статический Метод

public static VertexNameToVertex ( String vertexName, IVertexCollection vertices, IVertex>.Dictionary vertexNameDictionary ) : IVertex
vertexName String
vertices IVertexCollection
vertexNameDictionary IVertex>.Dictionary
Результат IVertex

WorksheetReaderBase() публичный Метод

Initializes a new instance of the WorksheetReaderBase class.
public WorksheetReaderBase ( ) : System
Результат System

Описание свойств

EmptyIDArray публичное статическое свойство

public static Int32[],System EmptyIDArray
Результат System.Int32[]

m_oAlphaConverter защищенное свойство

protected AlphaConverter,Smrf.NodeXL.ExcelTemplate m_oAlphaConverter
Результат AlphaConverter