C# Class Smrf.NodeXL.ExcelTemplate.CreateSubgraphImagesDialog

Dialog that creates a subgraph image for each of a graph's vertices.

Call Form.ShowDialog() to run the dialog. All image creation is performed within the dialog.

A SubgraphImageCreator object does most of the work. The image creation is done asynchronously, so it doesn't hang the UI and can be cancelled by the user. However, the optional insertion of thumbnail images into the vertex worksheet is done synchronously, because you can't update the UI in Windows from a background thread. During thumbnail insertion, all dialog controls are disabled and the UI doesn't respond to user input.

Inheritance: ExcelTemplateForm

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

Protected Properties

Property	Type	Description
m_eMode	DialogMode
m_eState	DialogState
m_oCreateSubgraphImagesDialogUserSettings	CreateSubgraphImagesDialogUserSettings
m_oSelectedVertexNames	ICollection
m_oSubgraphImageCreator	SubgraphImageCreator
m_oWorkbook	Microsoft.Office.Interop.Excel.Workbook

Public Methods

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

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.
DoDataExchange ( System.Boolean bFromControls ) : System.Boolean
EnableControls ( ) : void
GetSelectedVertices ( IGraph oGraph, ICollection oSelectedVertexNames ) : ICollection
OnClosed ( EventArgs e ) : void
OnImageCreationCompleted ( RunWorkerCompletedEventArgs e ) : void
OnLoad ( EventArgs e ) : void
ReadWorkbook ( Microsoft oWorkbook ) : IGraph
StartImageCreation ( ) : void

Private Methods

Method	Description
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
SubgraphImageCreator_ImageCreationCompleted ( object sender, RunWorkerCompletedEventArgs e ) : void
SubgraphImageCreator_ImageCreationProgressChanged ( object sender, ProgressChangedEventArgs e ) : void
btnCreate_Click ( object sender, EventArgs e ) : void

Method Details

AssertValid() public method

public AssertValid ( ) : void
return	void

CreateSubgraphImagesDialog() public method

Initializes a new instance of the class.

public CreateSubgraphImagesDialog ( DialogMode mode, Microsoft workbook, ICollection selectedVertexNames ) : System
mode	DialogMode	/// Indicates the mode in which the dialog is being used. ///
workbook	Microsoft	/// Workbook containing the graph data. If is /// , the workbook isn't used and this /// parameter must be null. ///
selectedVertexNames	ICollection	/// Collection of zero or more vertex names corresponding to the selected /// rows in the vertex worksheet. If is , the collection isn't used and this /// parameter must be null. ///
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 ( System.Boolean bFromControls ) : System.Boolean
bFromControls	System.Boolean
return	System.Boolean

EnableControls() protected method

protected EnableControls ( ) : void
return	void

GetSelectedVertices() protected method

protected GetSelectedVertices ( IGraph oGraph, ICollection oSelectedVertexNames ) : ICollection
oGraph	IGraph
oSelectedVertexNames	ICollection
return	ICollection

OnClosed() protected method

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

OnImageCreationCompleted() protected method

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

OnLoad() protected method

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

ReadWorkbook() protected method

protected ReadWorkbook ( Microsoft oWorkbook ) : IGraph
oWorkbook	Microsoft
return	IGraph

StartImageCreation() protected method

protected StartImageCreation ( ) : void
return	void

Property Details

m_eMode protected property

protected DialogMode m_eMode
return	DialogMode

m_eState protected property

protected DialogState m_eState
return	DialogState

m_oCreateSubgraphImagesDialogUserSettings protected property

protected CreateSubgraphImagesDialogUserSettings,Smrf.NodeXL.ExcelTemplate m_oCreateSubgraphImagesDialogUserSettings
return	CreateSubgraphImagesDialogUserSettings

m_oSelectedVertexNames protected property

protected ICollection m_oSelectedVertexNames
return	ICollection

m_oSubgraphImageCreator protected property

protected SubgraphImageCreator,Smrf.NodeXL.ExcelTemplate m_oSubgraphImageCreator
return	SubgraphImageCreator

m_oWorkbook protected property

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