C# Class Smrf.NodeXL.GraphDataProviders.GraphDataProviderDialogBase

Base class for dialogs that get graph data.
This class and its virtual methods should actually be declared abstract, but the Visual Studio designer doesn't allow dialog classes to have an abstract base class.
Inheritance: Smrf.AppLib.FormPlus
Show file Open project: 2014-sed-team3/term-project Class Usage Examples

Protected Properties

Property Type Description
m_oGraphMLXmlDocument System.Xml.XmlDocument
m_oHttpNetworkAnalyzer HttpNetworkAnalyzerBase

Private Properties

Property Type Description
HttpNetworkAnalyzer_AnalysisCompleted void
HttpNetworkAnalyzer_ProgressChanged void

Public Methods

Method Description
AssertValid ( ) : void
GraphDataProviderDialogBase ( ) : System

Do not use this constructor.

Do not use this constructor. It is for the Visual Studio designer only.

GraphDataProviderDialogBase ( HttpNetworkAnalyzerBase httpNetworkAnalyzer ) : System

Initializes a new instance of the class.

Protected Methods

Method Description
DoDataExchange ( System.Boolean bFromControls ) : System.Boolean
EnableControls ( ) : void
OnAnalysisCompleted ( RunWorkerCompletedEventArgs e ) : void
OnAnalysisException ( Exception oException ) : void
OnAnalysisSuccess ( XmlDocument oGraphMLXmlDocument ) : void
OnClosed ( EventArgs e ) : void
OnEmptyGraph ( ) : void
OnOKClick ( ) : void
OnProgressChanged ( ProgressChangedEventArgs e ) : void
PreviewStartAnalysis ( ) : System.Boolean
StartAnalysis ( ) : void

Private Methods

Method Description
HttpNetworkAnalyzer_AnalysisCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
HttpNetworkAnalyzer_ProgressChanged ( object sender, ProgressChangedEventArgs e ) : void

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

DoDataExchange() protected method

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

EnableControls() protected method

protected EnableControls ( ) : void
return void

GraphDataProviderDialogBase() public method

Do not use this constructor.
Do not use this constructor. It is for the Visual Studio designer only.
public GraphDataProviderDialogBase ( ) : System
return System

GraphDataProviderDialogBase() public method

Initializes a new instance of the class.
public GraphDataProviderDialogBase ( HttpNetworkAnalyzerBase httpNetworkAnalyzer ) : System
httpNetworkAnalyzer HttpNetworkAnalyzerBase /// Object that does most of the work. ///
return System

OnAnalysisCompleted() protected method

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

OnAnalysisException() protected method

protected OnAnalysisException ( Exception oException ) : void
oException System.Exception
return void

OnAnalysisSuccess() protected method

protected OnAnalysisSuccess ( XmlDocument oGraphMLXmlDocument ) : void
oGraphMLXmlDocument System.Xml.XmlDocument
return void

OnClosed() protected method

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

OnEmptyGraph() protected method

protected OnEmptyGraph ( ) : void
return void

OnOKClick() protected method

protected OnOKClick ( ) : void
return void

OnProgressChanged() protected method

protected OnProgressChanged ( ProgressChangedEventArgs e ) : void
e System.ComponentModel.ProgressChangedEventArgs
return void

PreviewStartAnalysis() protected method

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

StartAnalysis() protected method

protected StartAnalysis ( ) : void
return void

Property Details

m_oGraphMLXmlDocument protected property

protected XmlDocument,System.Xml m_oGraphMLXmlDocument
return System.Xml.XmlDocument

m_oHttpNetworkAnalyzer protected property

protected HttpNetworkAnalyzerBase,Smrf.NodeXL.GraphDataProviders m_oHttpNetworkAnalyzer
return HttpNetworkAnalyzerBase