C# Class Smrf.NodeXL.ExcelTemplate.TopMetricsReaderBase

Base class for classes that read top metrics from a worksheet in a NodeXL workbook.
Inheritance: Object
Mostrar archivo Open project: 2014-sed-team3/term-project

Protected Properties

Property Type Description
m_sTableNameRoot String
m_sWorksheetName String

Public Methods

Method Description
TopMetricsReaderBase ( String worksheetName, String tableNameRoot ) : System

Initializes a new instance of the TopMetricsReaderBase class.

TryReadMetrics ( Microsoft workbook, String &topMetrics ) : System.Boolean

Protected Methods

Method Description
ReadTopColumn ( ListObject oTopMetricsTable, String sColumnHeader, StringBuilder oTopMetrics ) : void
ReadTopColumns ( ListObject oTopMetricsTable, StringBuilder oTopMetrics ) : void

Private Methods

Method Description
AssertValid ( ) : void

Method Details

ReadTopColumn() protected method

protected ReadTopColumn ( ListObject oTopMetricsTable, String sColumnHeader, StringBuilder oTopMetrics ) : void
oTopMetricsTable ListObject
sColumnHeader String
oTopMetrics StringBuilder
return void

ReadTopColumns() protected method

protected ReadTopColumns ( ListObject oTopMetricsTable, StringBuilder oTopMetrics ) : void
oTopMetricsTable ListObject
oTopMetrics StringBuilder
return void

TopMetricsReaderBase() public method

Initializes a new instance of the TopMetricsReaderBase class.
public TopMetricsReaderBase ( String worksheetName, String tableNameRoot ) : System
worksheetName String /// Name of the worksheet containing the top metrics tables. ///
tableNameRoot String /// Root of the name of each top metric table on the worksheet. ///
return System

TryReadMetrics() public method

public TryReadMetrics ( Microsoft workbook, String &topMetrics ) : System.Boolean
workbook Microsoft
topMetrics String
return System.Boolean

Property Details

m_sTableNameRoot protected_oe property

protected String m_sTableNameRoot
return String

m_sWorksheetName protected_oe property

protected String m_sWorksheetName
return String