C# Class Smrf.NodeXL.ExcelTemplate.GraphMetricsDialog

Edits the user's graph metric settings and optionally calculates the graph metrics.

This dialog lets the user select from a set of graph metrics. It saves the user's selection in a GraphMetricUserSettings object. If the DialogMode argument to the constructor is , it also calculates the selected metrics.

If the user edits and saves graph metrics, Form.ShowDialog() returns DialogResult.OK. Otherwise, it returns DialogResult.Cancel.

Inheritance: ExcelTemplateForm

Datei anzeigen Open project: 2014-sed-team3/term-project

Protected Properties

Property	Type	Description
m_eMode	DialogMode
m_oGraphMetricUserSettings	GraphMetricUserSettings
m_oGraphMetricsDialogUserSettings	GraphMetricsDialogUserSettings
m_oWorkbook	Microsoft.Office.Interop.Excel.Workbook

Public Methods

Method	Description
AssertValid ( ) : void
GraphMetricsDialog ( DialogMode mode, Microsoft workbook ) : System	Initializes a new instance of the GraphMetricsDialog class.

Protected Methods

Method	Description
CalculateTopNByMetrics ( ) : System.Boolean
Dispose ( bool disposing ) : void	Clean up any resources being used.
DoDataExchange ( System.Boolean bFromControls ) : System.Boolean
EditTopNByMetricUserSettings ( ) : void
EditWordMetricUserSettings ( ) : void
ItemToGraphMetricInformation ( Object oCheckedListBoxItem ) : GraphMetricInformation
TryGetSelectedGraphMetricInformation ( GraphMetricInformation &oSelectedGraphMetricInformation ) : System.Boolean

Private Methods

Method	Description
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
OnCheckOrUncheckAll ( object sender, System e ) : void
btnOK_Click ( object sender, System e ) : void
btnOptions_Click ( object sender, EventArgs e ) : void
clbGraphMetrics_SelectedIndexChanged ( object sender, EventArgs e ) : void
wbDescription_Navigating ( object sender, System.Windows.Forms.WebBrowserNavigatingEventArgs e ) : void

Method Details

AssertValid() public method

public AssertValid ( ) : void
return	void

CalculateTopNByMetrics() protected method

protected CalculateTopNByMetrics ( ) : System.Boolean
return	System.Boolean

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 ( System.Boolean bFromControls ) : System.Boolean
bFromControls	System.Boolean
return	System.Boolean

EditTopNByMetricUserSettings() protected method

protected EditTopNByMetricUserSettings ( ) : void
return	void

EditWordMetricUserSettings() protected method

protected EditWordMetricUserSettings ( ) : void
return	void

GraphMetricsDialog() public method

Initializes a new instance of the GraphMetricsDialog class.

public GraphMetricsDialog ( DialogMode mode, Microsoft workbook ) : System
mode	DialogMode	/// Indicates the mode in which the dialog is being used. ///
workbook	Microsoft	/// Workbook containing the graph contents. ///
return	System

ItemToGraphMetricInformation() protected method

protected ItemToGraphMetricInformation ( Object oCheckedListBoxItem ) : GraphMetricInformation
oCheckedListBoxItem	Object
return	GraphMetricInformation

TryGetSelectedGraphMetricInformation() protected method

protected TryGetSelectedGraphMetricInformation ( GraphMetricInformation &oSelectedGraphMetricInformation ) : System.Boolean
oSelectedGraphMetricInformation	GraphMetricInformation
return	System.Boolean

Property Details

m_eMode protected_oe property

protected DialogMode m_eMode
return	DialogMode

m_oGraphMetricUserSettings protected_oe property

protected GraphMetricUserSettings,Smrf.NodeXL.ExcelTemplate m_oGraphMetricUserSettings
return	GraphMetricUserSettings

m_oGraphMetricsDialogUserSettings protected_oe property

protected GraphMetricsDialogUserSettings,Smrf.NodeXL.ExcelTemplate m_oGraphMetricsDialogUserSettings
return	GraphMetricsDialogUserSettings

m_oWorkbook protected_oe property

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