C# Class Smrf.NodeXL.ExcelTemplate.AutomateTasksDialog

Edits a AutomateTasksUserSettings object and optionally runs the tasks specified in the object.
Unlike other dialogs in this application, you do not pass a user settings object to the constructor. That's because when automating a folder, this class must update the user settings before opening other workbooks, so those other workbooks will have access to the updated settings.

The Form.ShowDialog() return value does indicate whether the settings were updated: it returns DialogResult.OK if they were edited, or DialogResult.Cancel if they were not.

Inheritance: ExcelTemplateForm
ファイルを表示 Open project: 2014-sed-team3/term-project

Protected Properties

Property Type Description
m_bIgnoreItemCheckEvents System.Boolean
m_eMode DialogMode
m_oAutomateTasksDialogUserSettings AutomateTasksDialogUserSettings
m_oAutomateTasksUserSettings AutomateTasksUserSettings
m_oNodeXLControl Smrf.NodeXL.Visualization.Wpf.NodeXLControl
m_oThisWorkbook ThisWorkbook

Public Methods

Method Description
AssertValid ( ) : void
AutomateTasksDialog ( DialogMode mode, ThisWorkbook thisWorkbook, NodeXLControl nodeXLControl ) : System

Initializes a new instance of the AutomateTasksDialog class.

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Clean up any resources being used.
DoDataExchange ( System.Boolean bFromControls ) : System.Boolean
EditFolderToSaveWorkbookTo ( ) : void
EnableControls ( ) : void
GetTasksToRun ( ) : AutomationTasks
ItemToAutomationTask ( Object oCheckedListBoxItem ) : AutomationTasks
PopulateTasksToRun ( ) : void
SetTasksToRun ( AutomationTasks eTasksToRun ) : void

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
OnEventThatRequiresControlEnabling ( object sender, EventArgs e ) : void
btnOK_Click ( object sender, System e ) : void
btnOptions_Click ( object sender, EventArgs e ) : void
clbTasksToRun_ItemCheck ( object sender, System.Windows.Forms.ItemCheckEventArgs e ) : void

Method Details

AssertValid() public method

public AssertValid ( ) : void
return void

AutomateTasksDialog() public method

Initializes a new instance of the AutomateTasksDialog class.
public AutomateTasksDialog ( DialogMode mode, ThisWorkbook thisWorkbook, NodeXLControl nodeXLControl ) : System
mode DialogMode /// Indicates the mode in which the dialog is being used. ///
thisWorkbook ThisWorkbook /// Workbook containing the graph contents. ///
nodeXLControl Smrf.NodeXL.Visualization.Wpf.NodeXLControl /// The NodeXLControl object. This can be null if /// is . ///
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

EditFolderToSaveWorkbookTo() protected method

protected EditFolderToSaveWorkbookTo ( ) : void
return void

EnableControls() protected method

protected EnableControls ( ) : void
return void

GetTasksToRun() protected method

protected GetTasksToRun ( ) : AutomationTasks
return AutomationTasks

ItemToAutomationTask() protected method

protected ItemToAutomationTask ( Object oCheckedListBoxItem ) : AutomationTasks
oCheckedListBoxItem Object
return AutomationTasks

PopulateTasksToRun() protected method

protected PopulateTasksToRun ( ) : void
return void

SetTasksToRun() protected method

protected SetTasksToRun ( AutomationTasks eTasksToRun ) : void
eTasksToRun AutomationTasks
return void

Property Details

m_bIgnoreItemCheckEvents protected_oe property

protected Boolean,System m_bIgnoreItemCheckEvents
return System.Boolean

m_eMode protected_oe property

protected DialogMode m_eMode
return DialogMode

m_oAutomateTasksDialogUserSettings protected_oe property

protected AutomateTasksDialogUserSettings,Smrf.NodeXL.ExcelTemplate m_oAutomateTasksDialogUserSettings
return AutomateTasksDialogUserSettings

m_oAutomateTasksUserSettings protected_oe property

protected AutomateTasksUserSettings,Smrf.NodeXL.ExcelTemplate m_oAutomateTasksUserSettings
return AutomateTasksUserSettings

m_oNodeXLControl protected_oe property

protected NodeXLControl,Smrf.NodeXL.Visualization.Wpf m_oNodeXLControl
return Smrf.NodeXL.Visualization.Wpf.NodeXLControl

m_oThisWorkbook protected_oe property

protected ThisWorkbook,Smrf.NodeXL.ExcelTemplate m_oThisWorkbook
return ThisWorkbook