Logo Search packages:      
Sourcecode: ndoc version File versions  Download package

NDoc::Gui::MainForm Class Reference

List of all members.

Detailed Description

The main application form.

The main application form contains a listview that holds assembly and /doc file pairs. You can add, edit, or delete a row in the listview. You can document multiple assemblies at one time.

NDoc provides for dynamic recognition of available documenters. It locates any available assemblies that are capable of creating documentation by searching the directory for any assemblies that contain a class that derives from IDocumenter which is defined in the NDoc.Core namespace.

Currently there are 3 documenters supplied with NDoc:

NDoc allows you to save documentation projects. NDoc project files have the .ndoc extension.

The bottom part of the main application form contains a property grid. You can edit the properties of the selected documenter via this property grid.

Definition at line 71 of file MainForm.cs.

Public Member Functions

 MainForm (string startingProjectFilename)
 Initializes the main application form, locates available documenters, and sets up the menus.

Static Public Member Functions

static void Main (string[] args)
 The main entry point for the application.

Protected Member Functions

void deleteButton_Click (object sender, System.EventArgs e)
 Removes the selected assembly and /doc file pair from the listview.
void menuFileCloseItem_Click (object sender, System.EventArgs e)
 Not implemented yet.
void menuFileNewItem_Click (object sender, System.EventArgs e)
 Resets NDoc to an empty project by calling Clear.
void menuMRUItem_Click (object sender, System.EventArgs e)
 Opens the project file of the selected MRU menu item.
void namespaceSummariesButton_Click (object sender, System.EventArgs e)
 Brings up the form for entering namespace summaries.
override void OnClosing (CancelEventArgs e)
 Prompts the user to save the project if it's dirty.
override void OnDragDrop (DragEventArgs drgevent)
 Handles drag drop and raises the DragDrop event.
override void OnDragEnter (DragEventArgs drgevent)
 Handles drag enter and raises the DragEnter event.


static string HelpFilePath [get]
bool ShowDescriptions [get, set]

Private Member Functions

void addButton_Click (object sender, System.EventArgs e)
void AddRowToListView (AssemblySlashDoc assemblySlashDoc)
void assembliesListView_DoubleClick (object sender, System.EventArgs e)
void assembliesListView_DragDrop (object sender, System.Windows.Forms.DragEventArgs e)
void assembliesListView_DragEnter (object sender, System.Windows.Forms.DragEventArgs e)
void assembliesListView_SelectedIndexChanged (object sender, System.EventArgs e)
void BuildTraceError (Exception ex)
void Clear ()
void comboBoxDocumenters_SelectedIndexChanged (object sender, System.EventArgs e)
void ConfigureUIForBuild (bool starting)
void editButton_Click (object sender, System.EventArgs e)
void EnableAssemblyItems ()
 Enable/disable the buttons in the GUI based on whether there any assemblies to document.
void EnableMenuItems (bool bEnable)
 Enables/disables the Save and SaveAs menu items.
void FileOpen (string fileName)
void FileSave (string fileName)
void FileSaveAs ()
Point GetOnScreenLocation (Point pt)
void InitializeComponent ()
 Required method for Designer support - do not modify the contents of this method with the code editor.
void MainForm_Load (object sender, System.EventArgs e)
void MakeMRUMenu ()
 Clears and recreates the most recently used files (MRU) menu.
void menuAboutItem_Click (object sender, System.EventArgs e)
void menuCancelBuildItem_Click (object sender, System.EventArgs e)
void menuDocBuildItem_Click (object sender, System.EventArgs e)
void menuDocViewItem_Click (object sender, System.EventArgs e)
void menuFileExitItem_Click (object sender, System.EventArgs e)
void menuFileExportNamespaces_Click (object sender, System.EventArgs e)
void menuFileImportNamespaces_Click (object sender, System.EventArgs e)
void menuFileOpenItem_Click (object sender, System.EventArgs e)
void menuFileOpenSolution_Click (object sender, System.EventArgs e)
void menuFileSaveAsItem_Click (object sender, System.EventArgs e)
void menuFileSaveItem_Click (object sender, System.EventArgs e)
void menuHelpContents_Click (object sender, System.EventArgs e)
void menuHelpIndex_Click (object sender, System.EventArgs e)
void menuNDocOnline_Click (object sender, System.EventArgs e)
void menuViewBuildProgress_Click (object sender, System.EventArgs e)
void menuViewDescriptions_Click (object sender, System.EventArgs e)
void menuViewLicense_Click (object sender, System.EventArgs e)
 Opens the license file in its associates application.
void menuViewOptions_Click (object sender, System.EventArgs e)
void menuViewStatusBar_Click (object sender, System.EventArgs e)
void OnProjectModified (object sender, EventArgs e)
void OnStepUpdate (object sender, ProgressArgs e)
DialogResult PromptToSave ()
void propertyGrid_PropertyValueChanged (object s, System.Windows.Forms.PropertyValueChangedEventArgs e)
bool QueryContinueOpen ()
void ReadConfig ()
 Reads in the NDoc configuration file from the application directory.
void RefreshPropertyGrid ()
void SaveOrSaveAs ()
void SelectedDocumenterChanged ()
void SetWindowTitle ()
void statusBar_VisibleChanged (object sender, System.EventArgs e)
void toolBarButton_Click (object sender, System.Windows.Forms.ToolBarButtonClickEventArgs e)
void traceWindow1_VisibleChanged (object sender, System.EventArgs e)
void UpdateMRUList ()
 Updates the MRU menu to reflect the project that was just opened.
void UpdateProgress (string text, int percent)
delegate void UpdateProgressDelegate (string text, int percent)
void WriteConfig ()
 Writes out the NDoc configuration file to the application directory.

Private Attributes

System.Windows.Forms.Button addButton
NDoc.Gui.HeaderGroupBox assembliesHeaderGroupBox
System.Windows.Forms.ListView assembliesListView
System.Windows.Forms.ColumnHeader assemblyHeader
Thread buildThread
System.Windows.Forms.ToolBarButton buildToolBarButton
System.Windows.Forms.ToolBarButton cancelToolBarButton
System.Windows.Forms.ComboBox comboBoxDocumenters
System.ComponentModel.IContainer components
System.Windows.Forms.Button deleteButton
NDoc.Gui.HeaderGroupBox documenterHeaderGroupBox
System.Windows.Forms.Button editButton
System.Windows.Forms.Label labelDocumenters
System.Windows.Forms.MainMenu mainMenu1
System.Windows.Forms.MenuItem menuAboutItem
System.Windows.Forms.MenuItem menuCancelBuildItem
System.Windows.Forms.MenuItem menuDocBuildItem
System.Windows.Forms.MenuItem menuDocItem
System.Windows.Forms.MenuItem menuDocViewItem
System.Windows.Forms.MenuItem menuFileCloseItem
System.Windows.Forms.MenuItem menuFileExitItem
System.Windows.Forms.MenuItem menuFileExportNamespaces
System.Windows.Forms.MenuItem menuFileImportNamespaces
System.Windows.Forms.MenuItem menuFileItem
System.Windows.Forms.MenuItem menuFileNewItem
System.Windows.Forms.MenuItem menuFileOpenItem
System.Windows.Forms.MenuItem menuFileOpenSolution
System.Windows.Forms.MenuItem menuFileRecentProjectsItem
System.Windows.Forms.MenuItem menuFileSaveAsItem
System.Windows.Forms.MenuItem menuFileSaveItem
System.Windows.Forms.MenuItem menuHelpContents
System.Windows.Forms.MenuItem menuHelpIndex
System.Windows.Forms.MenuItem menuHelpItem
System.Windows.Forms.MenuItem menuItem1
System.Windows.Forms.MenuItem menuItem2
System.Windows.Forms.MenuItem menuItem3
System.Windows.Forms.MenuItem menuItem4
System.Windows.Forms.MenuItem menuItem6
System.Windows.Forms.MenuItem menuNDocOnline
System.Windows.Forms.MenuItem menuSpacerItem1
System.Windows.Forms.MenuItem menuSpacerItem2
System.Windows.Forms.MenuItem menuSpacerItem3
System.Windows.Forms.MenuItem menuSpacerItem4
System.Windows.Forms.MenuItem menuSpacerItem6
System.Windows.Forms.MenuItem menuView
System.Windows.Forms.MenuItem menuViewBuildProgress
System.Windows.Forms.MenuItem menuViewDescriptions
System.Windows.Forms.MenuItem menuViewLicense
System.Windows.Forms.MenuItem menuViewOptions
System.Windows.Forms.MenuItem menuViewStatusBar
System.Windows.Forms.Button namespaceSummariesButton
System.Windows.Forms.ToolBarButton newToolBarButton
System.Windows.Forms.ToolBarButton openToolBarButton
NDocOptions options
string processDirectory
System.Windows.Forms.ProgressBar progressBar
Project project
string projectFilename
RuntimePropertyGrid propertyGrid
StringCollection recentProjectFilenames = new StringCollection()
System.Windows.Forms.ToolBarButton saveToolBarButton
System.Windows.Forms.ToolBarButton separatorToolBarButton
System.Windows.Forms.ColumnHeader slashDocHeader
System.Windows.Forms.ToolBarButton solutionToolBarButton
System.Windows.Forms.Splitter splitter1
string startingProjectFilename
System.Windows.Forms.StatusBar statusBar
System.Windows.Forms.StatusBarPanel statusBarTextPanel
System.Windows.Forms.ToolBar toolBar
System.Windows.Forms.ImageList toolBarImageList
NDoc.Gui.TraceWindowControl traceWindow1
string untitledProjectName = "(Untitled)"
System.Windows.Forms.ToolBarButton viewToolBarButton

The documentation for this class was generated from the following file:

Generated by  Doxygen 1.6.0   Back to index