C# Class Smrf.NodeXL.ExcelTemplate.GraphMetricWriter

Writes GraphMetricColumn objects to the workbook.
Call WriteGraphMetricColumnsToWorkbook to write one or more GraphMetricColumn objects to a workbook, then call to let the user know that graph metrics have been calculated.
Inheritance: Object
Datei anzeigen Open project: 2014-sed-team3/term-project Class Usage Examples

Public Methods

Method Description
ActivateRelevantWorksheet ( IEnumerable graphMetricColumns, Microsoft workbook ) : void
GraphMetricWriter ( ) : System

Initializes a new instance of the GraphMetricWriter class.
WriteGraphMetricColumnsToWorkbook ( GraphMetricColumn graphMetricColumns, Microsoft workbook ) : void

Protected Methods

Method Description
ClearWorksheets ( GraphMetricColumn aoGraphMetricColumns, Microsoft oWorkbook ) : void
GetColumn1HeaderCellForStackedTable ( Microsoft oWorksheet, Range oColumnARange ) : Range
GraphMetricColumnsIncludeWorksheet ( IEnumerable oGraphMetricColumns, String sWorksheetName ) : System.Boolean
ResizeTable ( ListObject oTable, Int32 iMinimumRows ) : void
TryCreateGroupEdgeTable ( Microsoft oWorkbook, ListObject &oGroupEdgeTable ) : System.Boolean
TryCreateStackedTable ( Microsoft oWorkbook, String sWorksheetName, GraphMetricColumn oGraphMetricColumn, ListObject &oStackedTable ) : System.Boolean
TryGetRequiredColumnInformation ( GraphMetricColumn oGraphMetricColumn, ListObject oTable, Range &oVisibleColumnData ) : System.Boolean
TryGetRequiredColumnWithIDInformation ( GraphMetricColumnWithID oGraphMetricColumnWithID, ListObject oTable, Range &oVisibleColumnData, Range &oIDColumnData ) : System.Boolean
TryGetTable ( Microsoft oWorkbook, GraphMetricColumn oGraphMetricColumn, ListObject &oTable ) : System.Boolean
WriteGraphMetricColumnOrderedToWorkbook ( GraphMetricColumnOrdered oGraphMetricColumnOrdered, ListObject oTable ) : void
WriteGraphMetricColumnWithIDToWorkbook ( GraphMetricColumnWithID oGraphMetricColumnWithID, ListObject oTable ) : void

Private Methods

Method Description
AssertValid ( ) : void

Method Details

ActivateRelevantWorksheet() public method

public ActivateRelevantWorksheet ( IEnumerable graphMetricColumns, Microsoft workbook ) : void
graphMetricColumns IEnumerable
workbook Microsoft
return void

ClearWorksheets() protected method

protected ClearWorksheets ( GraphMetricColumn aoGraphMetricColumns, Microsoft oWorkbook ) : void
aoGraphMetricColumns GraphMetricColumn
oWorkbook Microsoft
return void

GetColumn1HeaderCellForStackedTable() protected method

protected GetColumn1HeaderCellForStackedTable ( Microsoft oWorksheet, Range oColumnARange ) : Range
oWorksheet Microsoft
oColumnARange Range
return Range

GraphMetricColumnsIncludeWorksheet() protected method

protected GraphMetricColumnsIncludeWorksheet ( IEnumerable oGraphMetricColumns, String sWorksheetName ) : System.Boolean
oGraphMetricColumns IEnumerable
sWorksheetName String
return System.Boolean

GraphMetricWriter() public method

Initializes a new instance of the GraphMetricWriter class.
public GraphMetricWriter ( ) : System
return System

ResizeTable() protected method

protected ResizeTable ( ListObject oTable, Int32 iMinimumRows ) : void
oTable ListObject
iMinimumRows System.Int32
return void

TryCreateGroupEdgeTable() protected method

protected TryCreateGroupEdgeTable ( Microsoft oWorkbook, ListObject &oGroupEdgeTable ) : System.Boolean
oWorkbook Microsoft
oGroupEdgeTable ListObject
return System.Boolean

TryCreateStackedTable() protected method

protected TryCreateStackedTable ( Microsoft oWorkbook, String sWorksheetName, GraphMetricColumn oGraphMetricColumn, ListObject &oStackedTable ) : System.Boolean
oWorkbook Microsoft
sWorksheetName String
oGraphMetricColumn GraphMetricColumn
oStackedTable ListObject
return System.Boolean

TryGetRequiredColumnInformation() protected method

protected TryGetRequiredColumnInformation ( GraphMetricColumn oGraphMetricColumn, ListObject oTable, Range &oVisibleColumnData ) : System.Boolean
oGraphMetricColumn GraphMetricColumn
oTable ListObject
oVisibleColumnData Range
return System.Boolean

TryGetRequiredColumnWithIDInformation() protected method

protected TryGetRequiredColumnWithIDInformation ( GraphMetricColumnWithID oGraphMetricColumnWithID, ListObject oTable, Range &oVisibleColumnData, Range &oIDColumnData ) : System.Boolean
oGraphMetricColumnWithID GraphMetricColumnWithID
oTable ListObject
oVisibleColumnData Range
oIDColumnData Range
return System.Boolean

TryGetTable() protected method

protected TryGetTable ( Microsoft oWorkbook, GraphMetricColumn oGraphMetricColumn, ListObject &oTable ) : System.Boolean
oWorkbook Microsoft
oGraphMetricColumn GraphMetricColumn
oTable ListObject
return System.Boolean

WriteGraphMetricColumnOrderedToWorkbook() protected method

protected WriteGraphMetricColumnOrderedToWorkbook ( GraphMetricColumnOrdered oGraphMetricColumnOrdered, ListObject oTable ) : void
oGraphMetricColumnOrdered GraphMetricColumnOrdered
oTable ListObject
return void

WriteGraphMetricColumnWithIDToWorkbook() protected method

protected WriteGraphMetricColumnWithIDToWorkbook ( GraphMetricColumnWithID oGraphMetricColumnWithID, ListObject oTable ) : void
oGraphMetricColumnWithID GraphMetricColumnWithID
oTable ListObject
return void

WriteGraphMetricColumnsToWorkbook() public method

public WriteGraphMetricColumnsToWorkbook ( GraphMetricColumn graphMetricColumns, Microsoft workbook ) : void
graphMetricColumns GraphMetricColumn
workbook Microsoft
return void