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
Afficher le fichier Open project: 2014-sed-team3/term-project

Protected Properties

Свойство Type Description
m_eMode DialogMode
m_eState DialogState
m_oCreateSubgraphImagesDialogUserSettings CreateSubgraphImagesDialogUserSettings
m_oSelectedVertexNames ICollection
m_oSubgraphImageCreator SubgraphImageCreator
m_oWorkbook Microsoft.Office.Interop.Excel.Workbook

Méthodes publiques

Méthode Description
AssertValid ( ) : void
CreateSubgraphImagesDialog ( DialogMode mode, Microsoft workbook, ICollection selectedVertexNames ) : System

Initializes a new instance of the class.

Méthodes protégées

Méthode 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

Méthode 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 méthode

public AssertValid ( ) : void
Résultat void

CreateSubgraphImagesDialog() public méthode

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. ///
Résultat System

Dispose() protected méthode

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

DoDataExchange() protected méthode

protected DoDataExchange ( System.Boolean bFromControls ) : System.Boolean
bFromControls System.Boolean
Résultat System.Boolean

EnableControls() protected méthode

protected EnableControls ( ) : void
Résultat void

GetSelectedVertices() protected méthode

protected GetSelectedVertices ( IGraph oGraph, ICollection oSelectedVertexNames ) : ICollection
oGraph IGraph
oSelectedVertexNames ICollection
Résultat ICollection

OnClosed() protected méthode

protected OnClosed ( EventArgs e ) : void
e System.EventArgs
Résultat void

OnImageCreationCompleted() protected méthode

protected OnImageCreationCompleted ( RunWorkerCompletedEventArgs e ) : void
e System.ComponentModel.RunWorkerCompletedEventArgs
Résultat void

OnLoad() protected méthode

protected OnLoad ( EventArgs e ) : void
e System.EventArgs
Résultat void

ReadWorkbook() protected méthode

protected ReadWorkbook ( Microsoft oWorkbook ) : IGraph
oWorkbook Microsoft
Résultat IGraph

StartImageCreation() protected méthode

protected StartImageCreation ( ) : void
Résultat void

Property Details

m_eMode protected_oe property

protected DialogMode m_eMode
Résultat DialogMode

m_eState protected_oe property

protected DialogState m_eState
Résultat DialogState

m_oCreateSubgraphImagesDialogUserSettings protected_oe property

protected CreateSubgraphImagesDialogUserSettings,Smrf.NodeXL.ExcelTemplate m_oCreateSubgraphImagesDialogUserSettings
Résultat CreateSubgraphImagesDialogUserSettings

m_oSelectedVertexNames protected_oe property

protected ICollection m_oSelectedVertexNames
Résultat ICollection

m_oSubgraphImageCreator protected_oe property

protected SubgraphImageCreator,Smrf.NodeXL.ExcelTemplate m_oSubgraphImageCreator
Résultat SubgraphImageCreator

m_oWorkbook protected_oe property

protected Microsoft.Office.Interop.Excel.Workbook m_oWorkbook
Résultat Microsoft.Office.Interop.Excel.Workbook