C# Class Smrf.NodeXL.ExcelTemplate.AnalyzeEmailNetworkDialog

Dialog that analyzes a user's email network and writes the results to the edge worksheet.

Call Form.ShowDialog() to show the dialog. When the user clicks the OK button, the workbook is automatically updated and DialogResult.OK is returned. Otherwise, DialogResult.Cancel is returned.

An EmailNetworkAnalyzer object does most of the work. The analysis is done asynchronously, so it doesn't hang the UI and can be cancelled by the user.

Inheritance: ExcelTemplateForm

Mostra file Open project: 2014-sed-team3/term-project

Protected Properties

Property	Type	Description
m_bClearTablesFirst	System.Boolean
m_oAnalyzeEmailNetworkDialogUserSettings	AnalyzeEmailNetworkDialogUserSettings
m_oEdgeTable	ListObject
m_oEmailNetworkAnalyzer	Smrf.SocialNetworkLib.EmailNetworkAnalyzer
m_oWorkbook	Microsoft.Office.Interop.Excel.Workbook

Public Methods

Method	Description
AnalyzeEmailNetworkDialog ( Microsoft workbook, System.Boolean clearTablesFirst ) : System	Initializes a new instance of the class.
AssertValid ( ) : void

Protected Methods

Method	Description
AnalyzerToParticipant ( String sParticipantFromAnalyzer ) : String
DataGridViewCheckBoxCellIsChecked ( System.Windows.Forms.DataGridViewRow oRow, String sColumnName ) : System.Boolean
DataGridViewRowToEmailParticipantCriteria ( System.Windows.Forms.DataGridViewRow oRow ) : EmailParticipantCriteria
Dispose ( bool disposing ) : void	Clean up any resources being used.
DoDataExchange ( System.Boolean bFromControls ) : System.Boolean
DoDataExchangeFromControls ( ) : System.Boolean
DoDataExchangeFromParticipants ( ) : void
DoDataExchangeToControls ( ) : void
DoDataExchangeToParticipants ( ) : void
EnableControls ( ) : void
FirstParticipantSpecified ( ) : System.Boolean
OnAnalysisCompleted ( RunWorkerCompletedEventArgs e ) : void
OnClosed ( EventArgs e ) : void
OnLoad ( EventArgs e ) : void
ParticipantToAnalyzer ( String sParticipantEnteredByUser ) : String
PopulateEdgesTable ( EmailParticipantPair aoEmailParticipantPairs ) : void
SetEdgeWeightValues ( Object aoEdgeWeights, Int32 iRowOffsetToWriteTo ) : void
ShowParticipantsEnabledState ( ) : void
StartAnalysis ( ) : void
ValidateFilter ( String sString ) : System.Boolean
ValidateFilterTextBox ( System.Boolean bCheckBoxIsChecked, System oTextBox, String sFilterDescription, String &sTrimmedText ) : System.Boolean
ValidateParticipants ( ) : System.Boolean

Private Methods

Method	Description
EmailNetworkAnalyzer_AnalysisCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
OnEventThatRequiresControlEnabling ( object sender, EventArgs e ) : void
btnOK_Click ( object sender, EventArgs e ) : void

Method Details

AnalyzeEmailNetworkDialog() public method

Initializes a new instance of the class.

public AnalyzeEmailNetworkDialog ( Microsoft workbook, System.Boolean clearTablesFirst ) : System
workbook	Microsoft	/// Workbook containing the graph data. ///
clearTablesFirst	System.Boolean	/// true if the NodeXL tables in should be /// cleared first. ///
return	System

AnalyzerToParticipant() protected method

protected AnalyzerToParticipant ( String sParticipantFromAnalyzer ) : String
sParticipantFromAnalyzer	String
return	String

AssertValid() public method

public AssertValid ( ) : void
return	void

DataGridViewCheckBoxCellIsChecked() protected method

protected DataGridViewCheckBoxCellIsChecked ( System.Windows.Forms.DataGridViewRow oRow, String sColumnName ) : System.Boolean
oRow	System.Windows.Forms.DataGridViewRow
sColumnName	String
return	System.Boolean

DataGridViewRowToEmailParticipantCriteria() protected method

protected DataGridViewRowToEmailParticipantCriteria ( System.Windows.Forms.DataGridViewRow oRow ) : EmailParticipantCriteria
oRow	System.Windows.Forms.DataGridViewRow
return	Smrf.SocialNetworkLib.EmailParticipantCriteria

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

DoDataExchangeFromControls() protected method

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

DoDataExchangeFromParticipants() protected method

protected DoDataExchangeFromParticipants ( ) : void
return	void

DoDataExchangeToControls() protected method

protected DoDataExchangeToControls ( ) : void
return	void

DoDataExchangeToParticipants() protected method

protected DoDataExchangeToParticipants ( ) : void
return	void

EnableControls() protected method

protected EnableControls ( ) : void
return	void

FirstParticipantSpecified() protected method

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

OnAnalysisCompleted() protected method

protected OnAnalysisCompleted ( RunWorkerCompletedEventArgs e ) : void
e	System.ComponentModel.RunWorkerCompletedEventArgs
return	void

OnClosed() protected method

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

OnLoad() protected method

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

ParticipantToAnalyzer() protected method

protected ParticipantToAnalyzer ( String sParticipantEnteredByUser ) : String
sParticipantEnteredByUser	String
return	String

PopulateEdgesTable() protected method

protected PopulateEdgesTable ( EmailParticipantPair aoEmailParticipantPairs ) : void
aoEmailParticipantPairs	Smrf.SocialNetworkLib.EmailParticipantPair
return	void

SetEdgeWeightValues() protected method

protected SetEdgeWeightValues ( Object aoEdgeWeights, Int32 iRowOffsetToWriteTo ) : void
aoEdgeWeights	Object
iRowOffsetToWriteTo	System.Int32
return	void

ShowParticipantsEnabledState() protected method

protected ShowParticipantsEnabledState ( ) : void
return	void

StartAnalysis() protected method

protected StartAnalysis ( ) : void
return	void

ValidateFilter() protected method

protected ValidateFilter ( String sString ) : System.Boolean
sString	String
return	System.Boolean

ValidateFilterTextBox() protected method

protected ValidateFilterTextBox ( System.Boolean bCheckBoxIsChecked, System oTextBox, String sFilterDescription, String &sTrimmedText ) : System.Boolean
bCheckBoxIsChecked	System.Boolean
oTextBox	System
sFilterDescription	String
sTrimmedText	String
return	System.Boolean

ValidateParticipants() protected method

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

Property Details

m_bClearTablesFirst protected_oe property

protected Boolean,System m_bClearTablesFirst
return	System.Boolean

m_oAnalyzeEmailNetworkDialogUserSettings protected_oe property

protected AnalyzeEmailNetworkDialogUserSettings,Smrf.NodeXL.ExcelTemplate m_oAnalyzeEmailNetworkDialogUserSettings
return	AnalyzeEmailNetworkDialogUserSettings

m_oEdgeTable protected_oe property

protected ListObject m_oEdgeTable
return	ListObject

m_oEmailNetworkAnalyzer protected_oe property

protected EmailNetworkAnalyzer,Smrf.SocialNetworkLib m_oEmailNetworkAnalyzer
return	Smrf.SocialNetworkLib.EmailNetworkAnalyzer

m_oWorkbook protected_oe property

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