C# Class Smrf.NodeXL.ExcelTemplate.CalculateGraphMetricsDialog

Show file Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Property Type Description
m_bActivateRelevantWorksheetWhenDone Boolean
m_oCalculateGraphMetricsDialogUserSettings CalculateGraphMetricsDialogUserSettings
m_oGraph IGraph
m_oGraphMetricCalculationManager GraphMetricCalculationManager
m_oGraphMetricCalculators IGraphMetricCalculator2[]
m_oWorkbook Microsoft.Office.Interop.Excel.Workbook

Public Methods

Method Description
AssertValid ( ) : void
CalculateGraphMetricsDialog ( IGraph graph, Microsoft workbook ) : System

Initializes a new instance of the class with a default list of graph metric calculators.
CalculateGraphMetricsDialog ( IGraph graph, Microsoft workbook, IGraphMetricCalculator2 graphMetricCalculators, String dialogTitle, Boolean activateRelevantWorksheetWhenDone ) : System

Initializes a new instance of the class with a specified list of graph metric calculators.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.
DoDataExchange ( Boolean bFromControls ) : Boolean
OnClosed ( EventArgs e ) : void
OnLoad ( EventArgs e ) : void
WriteGraphMetricColumnsToWorkbook ( GraphMetricColumn aoGraphMetricColumns ) : void

Private Methods

Method Description
GraphMetricCalculationManager_GraphMetricCalculationCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
GraphMetricCalculationManager_GraphMetricCalculationProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
InitializeComponent ( ) : void

Required method for Designer support - do not modify the contents of this method with the code editor.
btnCancel_Click ( object sender, EventArgs e ) : void

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

CalculateGraphMetricsDialog() public method

Initializes a new instance of the class with a default list of graph metric calculators.
public CalculateGraphMetricsDialog ( IGraph graph, Microsoft workbook ) : System
graph IGraph /// Graph to calculate the graph metrics for, or null. If null, the graph /// is read from . ///
workbook Microsoft /// Workbook where the graph metrics will get written. If is null, the graph is read from this workbook, too. ///
return System

CalculateGraphMetricsDialog() public method

Initializes a new instance of the class with a specified list of graph metric calculators.
public CalculateGraphMetricsDialog ( IGraph graph, Microsoft workbook, IGraphMetricCalculator2 graphMetricCalculators, String dialogTitle, Boolean activateRelevantWorksheetWhenDone ) : System
graph IGraph /// Graph to calculate the graph metrics for, or null. If null, the graph /// is read from . ///
workbook Microsoft /// Workbook where the graph metrics will get written. If is null, the graph is read from this workbook, too. ///
graphMetricCalculators IGraphMetricCalculator2 /// An array of implementations, one /// for each set of graph metrics that should be calculated, or null to use /// a default list of graph metric calculators. ///
dialogTitle String /// Title for the dialog, or null to use a default title. ///
activateRelevantWorksheetWhenDone Boolean /// true to activate one of the worksheets to let the user know that graph /// metrics have been calculated. The worksheet to activate is determined /// by which columns were calculated. ///
return System

Dispose() protected method

Clean up any resources being used.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources should be disposed; otherwise, false.
return void

DoDataExchange() protected method

protected DoDataExchange ( Boolean bFromControls ) : Boolean
bFromControls Boolean
return Boolean

OnClosed() protected method

protected OnClosed ( EventArgs e ) : void
e EventArgs
return void

OnLoad() protected method

protected OnLoad ( EventArgs e ) : void
e EventArgs
return void

WriteGraphMetricColumnsToWorkbook() protected method

protected WriteGraphMetricColumnsToWorkbook ( GraphMetricColumn aoGraphMetricColumns ) : void
aoGraphMetricColumns GraphMetricColumn
return void

Property Details

m_bActivateRelevantWorksheetWhenDone protected property

protected Boolean m_bActivateRelevantWorksheetWhenDone
return Boolean

m_oCalculateGraphMetricsDialogUserSettings protected property

protected CalculateGraphMetricsDialogUserSettings,Smrf.NodeXL.ExcelTemplate m_oCalculateGraphMetricsDialogUserSettings
return CalculateGraphMetricsDialogUserSettings

m_oGraph protected property

protected IGraph m_oGraph
return IGraph

m_oGraphMetricCalculationManager protected property

protected GraphMetricCalculationManager,Smrf.NodeXL.ExcelTemplate m_oGraphMetricCalculationManager
return GraphMetricCalculationManager

m_oGraphMetricCalculators protected property

protected IGraphMetricCalculator2[] m_oGraphMetricCalculators
return IGraphMetricCalculator2[]

m_oWorkbook protected property

protected Microsoft.Office.Interop.Excel.Workbook m_oWorkbook
return Microsoft.Office.Interop.Excel.Workbook