C# Class Smrf.NodeXL.ExcelTemplate.GraphMetricsAggregator

Aggregates the overall metrics from a folder full of NodeXL workbooks into a new Excel workbook.
Call AggregateGraphMetricsAsync to aggregate the overall metrics. Call CancelAsync to stop the aggregation. Handle the AggregationProgressChanged and events to monitor the progress and completion of the aggregation.
Inheritance: Object
Afficher le fichier Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Свойство Type Description
m_oBackgroundWorker System.ComponentModel.BackgroundWorker

Méthodes publiques

Méthode Description
AggregateGraphMetricsAsync ( String sourceFolderPath, Microsoft workbook ) : void
CancelAsync ( ) : void
GraphMetricsAggregator ( ) : System

Initializes a new instance of the GraphMetricsAggregator class.

Méthodes protégées

Méthode Description
AggregateGraphMetricsInternal ( AggregateGraphMetricsAsyncArgs oAggregateGraphMetricsAsyncArgs, BackgroundWorker oBackgroundWorker, DoWorkEventArgs oDoWorkEventArgs ) : void
BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
GetWorkbookSettings ( Microsoft oWorkbook ) : String
TryGetGraphMetricsForOneNodeXLWorkbook ( String sNodeXLWorkbookFilePath, OverallMetricsInfo &oOverallMetricsInfo ) : System.Boolean
WriteOverallMetricsToNewWorkbook ( Microsoft oApplicationForNewWorkbook, IList oOverallMetricsInfos ) : void

Private Methods

Méthode Description
AssertValid ( ) : void

Method Details

AggregateGraphMetricsAsync() public méthode

public AggregateGraphMetricsAsync ( String sourceFolderPath, Microsoft workbook ) : void
sourceFolderPath String
workbook Microsoft
Résultat void

AggregateGraphMetricsInternal() protected méthode

protected AggregateGraphMetricsInternal ( AggregateGraphMetricsAsyncArgs oAggregateGraphMetricsAsyncArgs, BackgroundWorker oBackgroundWorker, DoWorkEventArgs oDoWorkEventArgs ) : void
oAggregateGraphMetricsAsyncArgs AggregateGraphMetricsAsyncArgs
oBackgroundWorker System.ComponentModel.BackgroundWorker
oDoWorkEventArgs System.ComponentModel.DoWorkEventArgs
Résultat void

BackgroundWorker_DoWork() protected méthode

protected BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
sender object
e System.ComponentModel.DoWorkEventArgs
Résultat void

BackgroundWorker_ProgressChanged() protected méthode

protected BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
sender object
e System.ComponentModel.ProgressChangedEventArgs
Résultat void

BackgroundWorker_RunWorkerCompleted() protected méthode

protected BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
sender object
e System.ComponentModel.RunWorkerCompletedEventArgs
Résultat void

CancelAsync() public méthode

public CancelAsync ( ) : void
Résultat void

GetWorkbookSettings() protected méthode

protected GetWorkbookSettings ( Microsoft oWorkbook ) : String
oWorkbook Microsoft
Résultat String

GraphMetricsAggregator() public méthode

Initializes a new instance of the GraphMetricsAggregator class.
public GraphMetricsAggregator ( ) : System
Résultat System

TryGetGraphMetricsForOneNodeXLWorkbook() protected méthode

protected TryGetGraphMetricsForOneNodeXLWorkbook ( String sNodeXLWorkbookFilePath, OverallMetricsInfo &oOverallMetricsInfo ) : System.Boolean
sNodeXLWorkbookFilePath String
oOverallMetricsInfo OverallMetricsInfo
Résultat System.Boolean

WriteOverallMetricsToNewWorkbook() protected méthode

protected WriteOverallMetricsToNewWorkbook ( Microsoft oApplicationForNewWorkbook, IList oOverallMetricsInfos ) : void
oApplicationForNewWorkbook Microsoft
oOverallMetricsInfos IList
Résultat void

Property Details

m_oBackgroundWorker protected_oe property

protected BackgroundWorker,System.ComponentModel m_oBackgroundWorker
Résultat System.ComponentModel.BackgroundWorker