C# Класс 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.
Наследование: Object
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
m_oBackgroundWorker System.ComponentModel.BackgroundWorker

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

Метод Описание
AggregateGraphMetricsAsync ( String sourceFolderPath, Microsoft workbook ) : void
CancelAsync ( ) : void
GraphMetricsAggregator ( ) : System

Initializes a new instance of the GraphMetricsAggregator class.

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

Метод Описание
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

Приватные методы

Метод Описание
AssertValid ( ) : void

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

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

public AggregateGraphMetricsAsync ( String sourceFolderPath, Microsoft workbook ) : void
sourceFolderPath String
workbook Microsoft
Результат void

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

protected AggregateGraphMetricsInternal ( AggregateGraphMetricsAsyncArgs oAggregateGraphMetricsAsyncArgs, BackgroundWorker oBackgroundWorker, DoWorkEventArgs oDoWorkEventArgs ) : void
oAggregateGraphMetricsAsyncArgs AggregateGraphMetricsAsyncArgs
oBackgroundWorker System.ComponentModel.BackgroundWorker
oDoWorkEventArgs System.ComponentModel.DoWorkEventArgs
Результат void

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

protected BackgroundWorker_DoWork ( object sender, DoWorkEventArgs e ) : void
sender object
e System.ComponentModel.DoWorkEventArgs
Результат void

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

protected BackgroundWorker_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
sender object
e System.ComponentModel.ProgressChangedEventArgs
Результат void

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

protected BackgroundWorker_RunWorkerCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
sender object
e System.ComponentModel.RunWorkerCompletedEventArgs
Результат void

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

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

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

protected GetWorkbookSettings ( Microsoft oWorkbook ) : String
oWorkbook Microsoft
Результат String

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

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

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

protected TryGetGraphMetricsForOneNodeXLWorkbook ( String sNodeXLWorkbookFilePath, OverallMetricsInfo &oOverallMetricsInfo ) : System.Boolean
sNodeXLWorkbookFilePath String
oOverallMetricsInfo OverallMetricsInfo
Результат System.Boolean

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

protected WriteOverallMetricsToNewWorkbook ( Microsoft oApplicationForNewWorkbook, IList oOverallMetricsInfos ) : void
oApplicationForNewWorkbook Microsoft
oOverallMetricsInfos IList
Результат void

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

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

protected BackgroundWorker,System.ComponentModel m_oBackgroundWorker
Результат System.ComponentModel.BackgroundWorker