WebSVN – DevTools – Diff – /EA_DocGen/trunk/EA_DocGen/createWordDoc.cs

 using System.Text;
 using System.ComponentModel;
 using System.Windows.Forms;
 using Word;
 using Microsoft.Office.Core;
+using System.Threading;
 namespace EA_DocGen
+{
    /// Summary description for createWordDoc.
    /// </summary>
    public class createWordDoc : System.Windows.Forms.Form
+   {
       // Enterprise Architect Model related data
-      private EA.Repository EA_Repository = null;
       private EA.Package EA_ParentPackage = null;
       private EA.Project EA_Project;
-      private EA_Utilities EA_Utils = null;
-      private TabularContent TableUtils = null;
+      private Thread creationThread = null;           // Document generation thread
-      private TextualContent TextUtils = null;
+      public static bool abortCreationThread;         // Used to abort the document generation thread
-      private StyleContent   StyleUtils = null;
+      private bool mustClose = false;                 // Used to signal closure required for doc generation dialog
-      private DocSectionTracking DocSectionTracker = null;
+      private bool docGenCompletedNormally = false;   // Used to indicate if success message is made just prior to thread exit
       private bool oneShot_skipRootPackage = false;
       private bool oneShot_skipRootElementHeading = false;
       private int processingLink = 0;
       private ArrayList classesNeedingUnitTests = null;
       private ArrayList classesWithUnitTests = null;
       private Word.Table utTraceabilityTable = null;
       // MS-Office Word related data
-      private Word.Application WordApp = null;
+      public static Word.Application WordApp = null;
-      private Word.Document WordDocument = null;
+      public static Word.Document WordDocument = null;
+      // Form data
-      private System.Windows.Forms.TextBox textBox_template;
+      public System.Windows.Forms.TextBox textBox_template;
       private System.Windows.Forms.Button button_browse_template;
-      private System.Windows.Forms.TextBox textBox_output_file;
+      public System.Windows.Forms.TextBox textBox_output_file;
       private System.Windows.Forms.Button button_browse_output_file;
       private System.Windows.Forms.Button button_cancel;
       private System.Windows.Forms.Button button_generate;
       private System.Windows.Forms.Button button_view_output;
       private System.Windows.Forms.Label label1;
       private System.Windows.Forms.Label label2;
-      private System.Windows.Forms.TextBox textBox_progress;
-      private System.Windows.Forms.Label label3;
       private System.Windows.Forms.CheckBox checkBox_WordVisibility;
+      private System.Windows.Forms.CheckBox checkBox_keep_on_top;
       /// <summary>
       /// Required designer variable.
       /// </summary>
       private System.ComponentModel.Container components = null;
-      public createWordDoc(EA.Repository theRepository, EA.Package theParentPackage, EA_Utilities theEA_Utils)
+      public createWordDoc(EA.Package theParentPackage)
+      {
          //
          // Required for Windows Form Designer support
          //
          InitializeComponent();
-         EA_Repository    = theRepository;
          EA_ParentPackage = theParentPackage;
-         EA_Project       = EA_Repository.GetProjectInterface();
+         EA_Project       = Main.EA_Repository.GetProjectInterface();
-         EA_Utils         = theEA_Utils;
-         DocSectionTracker = new DocSectionTracking();
+         DocSectionTracking.initialise();
-         TableUtils        = new TabularContent(WordApp, WordDocument, EA_Utils);
+         TabularContent.initialise();
-         TextUtils         = new TextualContent(WordApp, WordDocument, DocSectionTracker);
+         TextualContent.initialise();
-         StyleUtils        = new StyleContent(WordApp, WordDocument);
+         StyleContent.initialise();
          WordApp = new Word.Application();
+      }
          this.button_cancel = new System.Windows.Forms.Button();
          this.button_generate = new System.Windows.Forms.Button();
          this.button_view_output = new System.Windows.Forms.Button();
          this.label1 = new System.Windows.Forms.Label();
          this.label2 = new System.Windows.Forms.Label();
-         this.textBox_progress = new System.Windows.Forms.TextBox();
-         this.label3 = new System.Windows.Forms.Label();
          this.checkBox_WordVisibility = new System.Windows.Forms.CheckBox();
+         this.checkBox_keep_on_top = new System.Windows.Forms.CheckBox();
          this.SuspendLayout();
          //
          // textBox_template
          //
-         this.textBox_template.Location = new System.Drawing.Point(16, 40);
+         this.textBox_template.Location = new System.Drawing.Point(8, 32);
          this.textBox_template.Name = "textBox_template";
-         this.textBox_template.Size = new System.Drawing.Size(592, 22);
+         this.textBox_template.Size = new System.Drawing.Size(696, 22);
          this.textBox_template.TabIndex = 0;
          this.textBox_template.Text = "";
          this.textBox_template.TextChanged += new System.EventHandler(this.textBox_template_TextChanged);
          //
          // button_browse_template
          //
-         this.button_browse_template.Location = new System.Drawing.Point(616, 40);
+         this.button_browse_template.Location = new System.Drawing.Point(712, 32);
          this.button_browse_template.Name = "button_browse_template";
-         this.button_browse_template.Size = new System.Drawing.Size(80, 23);
+         this.button_browse_template.Size = new System.Drawing.Size(64, 23);
-         this.button_browse_template.TabIndex = 1;
+         this.button_browse_template.TabIndex = 4;
          this.button_browse_template.Text = "Browse";
          this.button_browse_template.Click += new System.EventHandler(this.button_browse_template_Click);
          //
          // textBox_output_file
          //
-         this.textBox_output_file.Location = new System.Drawing.Point(16, 112);
+         this.textBox_output_file.Location = new System.Drawing.Point(8, 96);
          this.textBox_output_file.Name = "textBox_output_file";
-         this.textBox_output_file.Size = new System.Drawing.Size(592, 22);
+         this.textBox_output_file.Size = new System.Drawing.Size(696, 22);
-         this.textBox_output_file.TabIndex = 2;
+         this.textBox_output_file.TabIndex = 1;
          this.textBox_output_file.Text = "";
          this.textBox_output_file.TextChanged += new System.EventHandler(this.textBox_output_file_TextChanged);
          //
          // button_browse_output_file
          //
-         this.button_browse_output_file.Location = new System.Drawing.Point(616, 112);
+         this.button_browse_output_file.Location = new System.Drawing.Point(712, 96);
          this.button_browse_output_file.Name = "button_browse_output_file";
-         this.button_browse_output_file.Size = new System.Drawing.Size(80, 24);
+         this.button_browse_output_file.Size = new System.Drawing.Size(64, 24);
-         this.button_browse_output_file.TabIndex = 3;
+         this.button_browse_output_file.TabIndex = 5;
          this.button_browse_output_file.Text = "Browse";
          this.button_browse_output_file.Click += new System.EventHandler(this.button_browse_output_file_Click);
          //
          // button_cancel
          //
+         this.button_cancel.DialogResult = System.Windows.Forms.DialogResult.Cancel;
-         this.button_cancel.Location = new System.Drawing.Point(616, 384);
+         this.button_cancel.Location = new System.Drawing.Point(648, 152);
          this.button_cancel.Name = "button_cancel";
-         this.button_cancel.Size = new System.Drawing.Size(80, 23);
+         this.button_cancel.Size = new System.Drawing.Size(128, 32);
-         this.button_cancel.TabIndex = 4;
+         this.button_cancel.TabIndex = 3;
-         this.button_cancel.Text = "Close";
+         this.button_cancel.Text = "Close / Abort";
          this.button_cancel.Click += new System.EventHandler(this.button_cancel_Click);
          //
          // button_generate
          //
-         this.button_generate.Location = new System.Drawing.Point(496, 384);
+         this.button_generate.Location = new System.Drawing.Point(496, 152);
          this.button_generate.Name = "button_generate";
-         this.button_generate.Size = new System.Drawing.Size(96, 24);
+         this.button_generate.Size = new System.Drawing.Size(128, 32);
-         this.button_generate.TabIndex = 5;
+         this.button_generate.TabIndex = 2;
          this.button_generate.Text = "Generate";
          this.button_generate.Click += new System.EventHandler(this.button_generate_Click);
          //
          // button_view_output
          //
          this.button_view_output.Enabled = false;
-         this.button_view_output.Location = new System.Drawing.Point(376, 384);
+         this.button_view_output.Location = new System.Drawing.Point(336, 152);
          this.button_view_output.Name = "button_view_output";
-         this.button_view_output.Size = new System.Drawing.Size(96, 23);
+         this.button_view_output.Size = new System.Drawing.Size(128, 32);
          this.button_view_output.TabIndex = 6;
          this.button_view_output.Text = "View Output";
          this.button_view_output.Click += new System.EventHandler(this.button_view_output_Click);
          //
          // label1
          //
-         this.label1.Location = new System.Drawing.Point(16, 16);
+         this.label1.Location = new System.Drawing.Point(8, 8);
          this.label1.Name = "label1";
          this.label1.Size = new System.Drawing.Size(224, 23);
          this.label1.TabIndex = 7;
          this.label1.Text = "Input Template or Document Name";
          //
          // label2
          //
-         this.label2.Location = new System.Drawing.Point(16, 88);
+         this.label2.Location = new System.Drawing.Point(8, 72);
          this.label2.Name = "label2";
          this.label2.Size = new System.Drawing.Size(280, 23);
          this.label2.TabIndex = 8;
          this.label2.Text = "Output Document Name";
          //
-         // textBox_progress
-         //
-         this.textBox_progress.Location = new System.Drawing.Point(16, 184);
-         this.textBox_progress.Multiline = true;
-         this.textBox_progress.Name = "textBox_progress";
-         this.textBox_progress.ReadOnly = true;
-         this.textBox_progress.ScrollBars = System.Windows.Forms.ScrollBars.Vertical;
-         this.textBox_progress.Size = new System.Drawing.Size(680, 168);
-         this.textBox_progress.TabIndex = 9;
-         this.textBox_progress.Text = "";
-         //
-         // label3
-         //
-         this.label3.Location = new System.Drawing.Point(16, 152);
-         this.label3.Name = "label3";
-         this.label3.TabIndex = 10;
-         this.label3.Text = "Progress";
-         //
          // checkBox_WordVisibility
          //
-         this.checkBox_WordVisibility.Location = new System.Drawing.Point(16, 384);
+         this.checkBox_WordVisibility.Location = new System.Drawing.Point(8, 168);
          this.checkBox_WordVisibility.Name = "checkBox_WordVisibility";
          this.checkBox_WordVisibility.Size = new System.Drawing.Size(256, 24);
-         this.checkBox_WordVisibility.TabIndex = 17;
+         this.checkBox_WordVisibility.TabIndex = 7;
          this.checkBox_WordVisibility.Text = "Show MS-WORD During Construction";
          //
+         // checkBox_keep_on_top
+         //
+         this.checkBox_keep_on_top.Checked = true;
+         this.checkBox_keep_on_top.CheckState = System.Windows.Forms.CheckState.Checked;
+         this.checkBox_keep_on_top.Location = new System.Drawing.Point(8, 136);
+         this.checkBox_keep_on_top.Name = "checkBox_keep_on_top";
+         this.checkBox_keep_on_top.Size = new System.Drawing.Size(224, 24);
+         this.checkBox_keep_on_top.TabIndex = 9;
+         this.checkBox_keep_on_top.Text = "Keep dialog on top";
+         this.checkBox_keep_on_top.CheckedChanged += new System.EventHandler(this.checkBox_keep_on_top_CheckedChanged);
+         //
          // createWordDoc
          //
+         this.AcceptButton = this.button_generate;
          this.AutoScaleBaseSize = new System.Drawing.Size(6, 15);
+         this.CancelButton = this.button_cancel;
-         this.ClientSize = new System.Drawing.Size(712, 432);
+         this.ClientSize = new System.Drawing.Size(784, 202);
+         this.Controls.Add(this.checkBox_keep_on_top);
          this.Controls.Add(this.checkBox_WordVisibility);
-         this.Controls.Add(this.label3);
-         this.Controls.Add(this.textBox_progress);
          this.Controls.Add(this.textBox_output_file);
          this.Controls.Add(this.textBox_template);
          this.Controls.Add(this.label2);
          this.Controls.Add(this.label1);
          this.Controls.Add(this.button_view_output);
          this.Controls.Add(this.button_generate);
          this.Controls.Add(this.button_cancel);
          this.Controls.Add(this.button_browse_output_file);
          this.Controls.Add(this.button_browse_template);
+         this.FormBorderStyle = System.Windows.Forms.FormBorderStyle.FixedDialog;
          this.Name = "createWordDoc";
+         this.SizeGripStyle = System.Windows.Forms.SizeGripStyle.Hide;
+         this.Text = "Generate Document From Document Model";
-         this.Text = "createWordDoc";
+         this.TopMost = true;
          this.Closing += new System.ComponentModel.CancelEventHandler(this.createWordDoc_Closing);
          this.ResumeLayout(false);
+      }
       #endregion
+         }
          button_view_output.Enabled = false;
+      }
       private void button_generate_Click(object sender, System.EventArgs e)
+      {
          if (this.textBox_template.Text.Length > 0)
+         {
             if (this.textBox_output_file.Text.Length > 0)
+            {
+               creationThread = new Thread(new ThreadStart(createTheWordDoc));
-               button_generate.Enabled = false;
+               creationThread.ApartmentState = ApartmentState.STA;
+               creationThread.Priority = ThreadPriority.Highest;
-               createTheWordDoc();
+               creationThread.Start();
+            }
             else
+            {
                MessageBox.Show("Error - must specify an output file");
+            }
+         {
             MessageBox.Show("Error - must specify an input template file");
+         }
+      }
       private void button_cancel_Click(object sender, System.EventArgs e)
+      {
-         this.Close();
+      }
       private void button_browse_template_Click(object sender, System.EventArgs e)
+      {
          OpenFileDialog dialog = new OpenFileDialog();
          dialog.Filter = "Word Files (*.doc;*.dot)|*.doc;*.dot|All files(*.*)|*.*";
          dialog.FilterIndex = 1;
-         dialog.ShowDialog();
+         if (DialogResult.OK == dialog.ShowDialog())
+         {
-         this.textBox_template.Text = dialog.FileName;
+            this.textBox_template.Text = dialog.FileName;
+         }
+      }
       private void button_browse_output_file_Click(object sender, System.EventArgs e)
+      {
          OpenFileDialog dialog = new OpenFileDialog();
          dialog.Filter = "Word Files (*.doc;*.dot)|*.doc;*.dot|All files(*.*)|*.*";
          dialog.FilterIndex = 1;
          dialog.CheckFileExists = false;
-         dialog.ShowDialog();
+         if (DialogResult.OK == dialog.ShowDialog())
+         {
-         this.textBox_output_file.Text = dialog.FileName;
+            this.textBox_output_file.Text = dialog.FileName;
+         }
+      }
       private void textBox_template_TextChanged(object sender, System.EventArgs e)
+      {
+      }
+      private void checkBox_keep_on_top_CheckedChanged(object sender, System.EventArgs e)
+      {
+         this.TopMost = this.checkBox_keep_on_top.Checked;
+      }
       private void textBox_output_file_TextChanged(object sender, System.EventArgs e)
+      {
+      }
       private void createWordDoc_Closing(object sender, System.ComponentModel.CancelEventArgs e)
+      {
+         if (creationThread != null && creationThread.IsAlive && !mustClose && Main.threadCreateDocProcessRunning)
+         {
+            e.Cancel = true;
+            DialogResult dlgRes = MessageBox.Show("Cancel Document Generation?", "Cancel", MessageBoxButtons.YesNo);
+            if (dlgRes == DialogResult.Yes)
+            {
+               abortCreationThread = true;
+               mustClose = true;
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Document Generation Aborting...Please Wait", -1);
+            }
+         }
-         if (WordApp != null)
+         else if (WordApp != null)
+         {
             // try-catch just in case user closed the application themselves whilst viewing the
             // generated output document
             try
+            {
                String s = createWordDoc_Closing_exception.Message;
+            }
+         }
+      }
       #endregion
       #region word document generation code
       /// </summary>
       /// <param name="prefix"></param>
       /// <param name="EA_string"></param>
       private void displayProgress(string prefix, string EA_string)
+      {
-         textBox_progress.AppendText( prefix + EA_string + "\r\n" );
+         //textBox_progress.AppendText( prefix + EA_string + "\r\n" );
          // Display to the output tab as well - as a longer term record of what happened
          StringBuilder sb = new StringBuilder("");
-         DocSectionTracker.appendHeadingNumber(ref sb);
+         DocSectionTracking.appendHeadingNumber(ref sb);
          while (sb.Length < 30)
             sb.Append(" ");
          sb.Append(prefix);
          sb.Append(EA_string);
-         EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, sb.ToString(), 0);
+         Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, sb.ToString(), 0);
+      }
       /// <summary>
       /// This method takes the specified EA diagram element and puts the diagram image
       /// </summary>
       /// <param name="theDiagram"></param>
       private void appendAndSelectDiagramViaClipboard(EA.Diagram theDiagram)
+      {
          // NOTE: diagrams only use one stereotype, not a list of them, so dont use StereotypeEx field
-         if (  EA_Utils.options.opt_ConsiderAPIDiagramsOnly
+         if (  EA_DocGenOptions.opt_ConsiderAPIDiagramsOnly
             && !theDiagram.Stereotype.Equals("API") )
+         {
             displayProgress( "SKIPPED DIAGRAM: ", theDiagram.Name.ToString() );
+         }
          // open the diagram in EA and copy it's image to the clipboard
          else if (EA_Project.PutDiagramImageOnClipboard(theDiagram.DiagramGUID,0))
+         {
             object startLocation;
             object endLocation;
-            TextUtils.appendDescription( theDiagram.Notes, EA_Utils );
+            TextualContent.appendDescription( TextualContent.trimTrailingReturns(theDiagram.Notes) );
             // create a range at the end of the document
             startLocation = WordDocument.Content.End;
             WordDocument.Content.InsertParagraphAfter();
             endLocation = WordDocument.Content.End;
             object direction = Word.WdCollapseDirection.wdCollapseEnd;
             WordRange.Collapse(ref direction);  // collapse prevents existing content being replaced
             // Get ready for the diagram paste and the formatting we want to do on it with the
             // selection object.
-            TextUtils.SelectInsertionPointAtEndOfDocument();
+            TextualContent.SelectInsertionPointAtEndOfDocument();
             // Paste the diagram into the document
             WordRange.Paste();
             // Set style of the diagram to "Normal" so that it can occupy space all the way to the left margin
             WordApp.Selection.MoveDown( ref unit, ref count, ref missing);
             WordApp.Selection.ParagraphFormat.Alignment = Word.WdParagraphAlignment.wdAlignParagraphCenter;
             // Add a caption
             WordDocument.Content.InsertParagraphAfter();
-            TextUtils.SelectInsertionPointAtEndOfDocument();
+            TextualContent.SelectInsertionPointAtEndOfDocument();
             object Label = "Figure";
             object Title = Type.Missing;
             object TitleAutoText = Type.Missing;
             object Position = Word.WdCaptionPosition.wdCaptionPositionAbove;
             object ExcludeLabel = 0;
             //string bookmarkName = theDiagram.Name;
             //bookmarkName = bookmarkName.Replace(' ', '_');
             //WordDocument.Bookmarks.Add( bookmarkName, ref lastParaRange );
             // Close the diagram in EA
-            EA_Repository.CloseDiagram(theDiagram.DiagramID);
+            Main.EA_Repository.CloseDiagram(theDiagram.DiagramID);
             displayProgress( "DIAGRAM: ", theDiagram.Name.ToString() );
+         }
+      }
+               {
                   oneShot_skipRootPackage = true;
+               }
                else if (s[0] == '{')
+               {
-                  EA.Package theFoundPackage = EA_Utils.EA_Finder.findPackageInRepositoryByGUID(s);
+                  EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);
                   if (theFoundPackage != null)
+                  {
                      parse_package(theFoundPackage, recurse_level);
+                  }
                   else
+         {
             if (s.Length > 0 && s != "\n" && s != "\r" )
+            {
                if (s[0] == '{')
+               {
-                  EA.Diagram theFoundDiagram = EA_Utils.EA_Finder.findDiagramInRepositoryByGUID(s);
+                  EA.Diagram theFoundDiagram = (EA.Diagram)Main.EA_Repository.GetDiagramByGuid(s);
                   if (theFoundDiagram != null)
+                  {
                      appendAndSelectDiagramViaClipboard( theFoundDiagram );
+                  }
                   else
+               {
                   oneShot_skipRootElementHeading = true;
+               }
                else if ( s[0] == '{')
+               {
-                  EA.Element theFoundElement = EA_Utils.EA_Finder.findElementInRepositoryByGUID(s);
+                  EA.Element theFoundElement = Main.EA_Repository.GetElementByGuid(s);
                   if (theFoundElement != null)
+                  {
                      parse_element( theFoundElement, recurse_level );
+                  }
                   else
                   skipRoots = true;
+               }
                else if (s[0] == '{')  // is it a GUID?
+               {
                   // find the package by its GUID
-                  theFoundPackage = EA_Utils.EA_Finder.findPackageInRepositoryByGUID(s);
+                  theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);
+               }
                else if (s.StartsWith("package="))
+               {
                   // add the users named package to our list of names
                   names.Add( s.Substring(8, s.Length - 8) );
                if ( s[0] == '{')
+               {
                   try
+                  {
                      // try to find the GUID as a package
-                     EA.Package theFoundPackage = EA_Utils.EA_Finder.findPackageInRepositoryByGUID(s);
+                     EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);
                      if (theFoundPackage != null)
-                        TextUtils.appendUnitTestSuite(theFoundPackage, recurse_level, ref classesWithUnitTests, ref EA_Utils);
+                        TextualContent.appendUnitTestSuite(theFoundPackage, recurse_level, ref classesWithUnitTests);
                      else
+                     {
                         // try to find the GUID as an element
-                        EA.Element theFoundElement = EA_Utils.EA_Finder.findElementInRepositoryByGUID(s);
+                        EA.Element theFoundElement = Main.EA_Repository.GetElementByGuid(s);
                         if (theFoundElement != null)
-                           TextUtils.appendUnitTestSuite(theFoundElement, recurse_level, ref classesWithUnitTests, ref EA_Utils);
+                           TextualContent.appendUnitTestSuite(theFoundElement, recurse_level, ref classesWithUnitTests);
                         else
                            MessageBox.Show("WARNING - Could not find linked element : " + linkedName );
+                     }
+                  }
                   catch
+                  {
                      // try to find the GUID as an element
-                     EA.Element theFoundElement = EA_Utils.EA_Finder.findElementInRepositoryByGUID(s);
+                     EA.Element theFoundElement = Main.EA_Repository.GetElementByGuid(s);
                      if (theFoundElement != null)
-                        TextUtils.appendUnitTestSuite(theFoundElement, recurse_level, ref classesWithUnitTests, ref EA_Utils);
+                        TextualContent.appendUnitTestSuite(theFoundElement, recurse_level, ref classesWithUnitTests);
                      else
                         MessageBox.Show("WARNING - Could not find linked element : " + linkedName );
+                  }
+               }
                else
+      {
          if (classesNeedingUnitTests.Count > 0)
+         {
             if (theElement.Notes.Length > 0)
+            {
-               TextUtils.appendAndSelectText( theElement.Notes, EA_Constants.styleName_Body1);
+               TextualContent.appendAndSelectText( theElement.Notes, EA_Constants.styleName_Body1);
+            }
-            int tableNum = TableUtils.Table_Create("Design Element to Unit Test Suite Traceability", 2, 2);
+            int tableNum = TabularContent.Table_Create("Design Element to Unit Test Suite Traceability", true, 2, 2);
             utTraceabilityTable = WordDocument.Tables[tableNum];
-            TableUtils.Table_SetTableColumnTitle(utTraceabilityTable, "Design Element (class)", 1);
+            TabularContent.Table_SetTableColumnTitle(utTraceabilityTable, "Design Element (class)", 1);
-            TableUtils.Table_SetTableColumnTitle(utTraceabilityTable, "Test Suite", 2);
+            TabularContent.Table_SetTableColumnTitle(utTraceabilityTable, "Test Suite", 2);
+         }
+      }
       private void completeTestTraceability()
+         {
             int numClassesRemaining = classesNeedingUnitTests.Count;
             int row = 2;
             foreach(int elementId in classesNeedingUnitTests)
+            {
-               EA.Element theElement = EA_Repository.GetElementByID( elementId );
+               EA.Element theElement = Main.EA_Repository.GetElementByID( elementId );
                if (theElement != null)
+               {
                   utTraceabilityTable.Cell(row,1).Range.Text = theElement.Name;
                   if (classesWithUnitTests.Contains( elementId ))
+                  {
-                     utTraceabilityTable.Cell(row,2).Range.Text = TextUtils.testSuiteName(theElement);
+                     utTraceabilityTable.Cell(row,2).Range.Text = TextualContent.testSuiteName(theElement);
+                  }
                   else
+                  {
                      utTraceabilityTable.Cell(row,2).Range.Text = "Missing tests!";
                      utTraceabilityTable.Cell(row,2).Range.Font.Color = Word.WdColor.wdColorRed;
+               }
                numClassesRemaining--;
                if (numClassesRemaining > 0)
+               {
-                  TableUtils.Table_InsertNewRowAfterThisRow(utTraceabilityTable, row);
+                  TabularContent.Table_InsertNewRowAfterThisRow(utTraceabilityTable, row);
                   row++;
+               }
+               if (abortCreationThread)
+                  break;
+            }
+         }
+      }
       #endregion
       /// <param name="thePackage"></param>
       private void createReferencesSection(EA.Package thePackage)
+      {
          foreach(EA.Element theElement in thePackage.Elements)
+         {
+            if (abortCreationThread)
+               return;
             // Here we want to apply the special ERG template styles for each reference
             // item.
-            TextUtils.appendAndSelectText( theElement.Name.ToString(), EA_Constants.styleName_RefListNum );
+            TextualContent.appendAndSelectText( theElement.Name.ToString(), EA_Constants.styleName_RefListNum );
-            TextUtils.appendAndSelectText( theElement.Notes.ToString(), EA_Constants.styleName_RefListText );
+            TextualContent.appendAndSelectText( theElement.Notes.ToString(), EA_Constants.styleName_RefListText );
+         }
+      }
       private void createTerminologySection(EA.Package thePackage, int recurse_level)
          // Use local package elements as source of glossary, but if none are present, resort to using
          // the project glossary in the repository
          int numItems = thePackage.Elements.Count;
          if (numItems == 0)
+         {
-            numItems = EA_Repository.Terms.Count;
+            numItems = Main.EA_Repository.Terms.Count;
+            // For some wierd reason, I have seen exceptions occur here when trying to get a sorted list of glossary
+            // items, so I put a trap and retry loop in until such time as the exact cause can be determined.
+            ArrayList glossary = null;
-            // Create a table
+            bool done = false;
-            int tableNum = TableUtils.Table_Create("Terminology", numItems+1, 2);
+            int retries = 3;
+            do
+            {
-            Word.Table table = WordDocument.Tables[tableNum];
+               if (abortCreationThread)
-            object center = Word.WdParagraphAlignment.wdAlignParagraphCenter;
+                  return;
+               try
+               {
-            TableUtils.Table_SetTableColumnTitle(table, "Term", 1);
+                  glossary = new ArrayList();
-            TableUtils.Table_SetTableColumnTitle(table, "Definition", 2);
+                  foreach(EA.Term theTerm in Main.EA_Repository.Terms)
+                     glossary.Add(theTerm);
-            table.Columns[1].SetWidth(100, Word.WdRulerStyle.wdAdjustSameWidth );
+                  glossarySort sorter = new glossarySort();
+                  glossary.Sort( sorter );
+                  done = true;
+               }
+               catch (Exception e)
+               {
+                  Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Sorting Glossary, Exception" + e.Message, -1);
+                  retries--;
-            int row = 2;
+               }
-            // inject the glossary into the table
+            } while (!done && retries > 0);
-            foreach(EA.Term theTerm in EA_Repository.Terms)
+            if (done && glossary.Count > 0)
+            {
+               // Create a table
+               int tableNum = TabularContent.Table_Create("Terminology", true, numItems+1, 2);
+               Word.Table table = WordDocument.Tables[tableNum];
+               object center = Word.WdParagraphAlignment.wdAlignParagraphCenter;
+               TabularContent.Table_SetTableColumnTitle(table, "Term", 1);
+               TabularContent.Table_SetTableColumnTitle(table, "Definition", 2);
+               table.Columns[1].SetWidth(100, Word.WdRulerStyle.wdAdjustSameWidth );
+               int row = 2;
+               // inject the glossary into the table
+               foreach(EA.Term theTerm in glossary)
+               {
+                  if (abortCreationThread)
+                     return;
-               table.Cell(row,1).Range.Text = theTerm.Term;
+                  table.Cell(row,1).Range.Text = theTerm.Term;
-               table.Cell(row,2).Range.Text = theTerm.Meaning;
+                  table.Cell(row,2).Range.Text = theTerm.Meaning;
-               row++;
+                  row++;
+               }
+            }
+         }
          else
+         {
             // scan content of terminology package - allow user to specify tables, text, package links,
             // and diagram links.
             ArrayList infoItems = new ArrayList();
             foreach(EA.Element theElement in thePackage.Elements)
+            {
+               if (abortCreationThread)
+                  return;
                if (theElement.Name.StartsWith(EA_Constants.EA_DocGenTable))
+               {
-                  TableUtils.processTableElement( theElement, recurse_level);
+                  TabularContent.processTableElement( theElement, recurse_level);
+               }
                else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenPackageLink))
+               {
                   processingLink++;
                   processPackageLink( theElement, recurse_level );
                   processingLink--;
+               }
                else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenText))
+               {
-                  TextUtils.appendAndSelectText( theElement.Notes.ToString(), EA_Constants.styleName_Body1 );
+                  TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(theElement.Notes), EA_Constants.styleName_Body1 );
+               }
                else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenDiagramLink))
+               {
                   processingLink++;
                   processDiagramLink( theElement );
+            }
             if (infoItems.Count > 0)
+            {
                // Create a table
-               int tableNum = TableUtils.Table_Create("Terminology", infoItems.Count+1, 2);
+               int tableNum = TabularContent.Table_Create("Terminology", true, infoItems.Count+1, 2);
                Word.Table table = WordDocument.Tables[tableNum];
                object center = Word.WdParagraphAlignment.wdAlignParagraphCenter;
-               TableUtils.Table_SetTableColumnTitle(table, "Term", 1);
+               TabularContent.Table_SetTableColumnTitle(table, "Term", 1);
-               TableUtils.Table_SetTableColumnTitle(table, "Definition", 2);
+               TabularContent.Table_SetTableColumnTitle(table, "Definition", 2);
                table.Columns[1].SetWidth(100, Word.WdRulerStyle.wdAdjustSameWidth );
                int row = 2;
+               elementSortByName sorter = new elementSortByName();
+               infoItems.Sort(sorter);
                foreach(EA.Element theElement in infoItems)
+               {
+                  if (abortCreationThread)
+                     return;
                   table.Cell(row,1).Range.Text = theElement.Name.ToString();
                   table.Cell(row,2).Range.Text = theElement.Notes.ToString();
                   row++;
+               }
+            }
          bool processLowerLevelContent = true;  // return value for this function
          // The package name is a heading, and the package notes are paragraphs
          // directly under that heading
-         TextUtils.appendAndSelectHeadingText( thePackage.Name.ToString(), recurse_level );
+         TextualContent.appendAndSelectHeadingText( thePackage.Name.ToString(), recurse_level );
          displayProgress( "PACKAGE: ", thePackage.Name.ToString() );
          // Special handling for package called "Terminology"
          if (thePackage.Name == "Terminology")
+         {
-            TextUtils.appendAndSelectText( thePackage.Notes.ToString(), EA_Constants.styleName_Body1 );
+            TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(thePackage.Notes), EA_Constants.styleName_Body1 );
             createTerminologySection(thePackage, recurse_level);
             processLowerLevelContent = false;
+         }
          else if (thePackage.Name == "References")
+         {
-            TextUtils.appendAndSelectText( thePackage.Notes.ToString(), EA_Constants.styleName_Body1 );
+            TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(thePackage.Notes), EA_Constants.styleName_Body1 );
             createReferencesSection(thePackage);
             processLowerLevelContent = false;
+         }
          else
+         {
             // use the package notes as body text and indicate to caller that package elements
             // have not been consumed
-            TextUtils.appendAndSelectText( thePackage.Notes.ToString(), EA_Constants.styleName_Body1 );
+            TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(thePackage.Notes), EA_Constants.styleName_Body1 );
+         }
          return processLowerLevelContent;
+      }
       private void generatePackageDiagrams( EA.Package thePackage )
+      {
          // default handling of diagrams
          foreach(EA.Diagram theDiagram in thePackage.Diagrams)
+         {
+            if (abortCreationThread)
+               return;
             if (theDiagram.ParentID == 0 || thePackage.PackageID == theDiagram.ParentID)
+            {
                appendAndSelectDiagramViaClipboard( theDiagram );
+            }
+         }
       private void generateElementDiagrams( EA.Element theElement )
+      {
          // default handling of diagrams
          foreach(EA.Diagram theDiagram in theElement.Diagrams)
+         {
+            if (abortCreationThread)
+               return;
             if (theDiagram.ParentID == 0 || theElement.ElementID == theDiagram.ParentID)
+            {
                appendAndSelectDiagramViaClipboard( theDiagram );
+            }
+         }
          // filter out methods with certain characteristics?
          // eg. Users may only want to document public and protected methods.
          int numMethodsRemaining = 0;
          foreach(EA.Method theMethod in theMethods)
+         {
+            if (abortCreationThread)
+               return;
-            if (EA_Utils.options.opt_SuppressPrivateMethods == false
+            if (EA_DocGenOptions.opt_SuppressPrivateMethods == false
                || !theMethod.Visibility.StartsWith("Private"))
                numMethodsRemaining++;
+         }
          Word.Range wr;
+         {
             // Print the "<Class Name> Operations" headings
             sb = new StringBuilder();
             sb.Append( theElement.Name );
             sb.Append( " Operations" );
-            TextUtils.appendAndSelectHeadingText(sb.ToString(), recurse_level);
+            TextualContent.appendAndSelectHeadingText(sb.ToString(), recurse_level);
             // Iterate through the class's methods
             foreach(EA.Method theMethod in theMethods)
+            {
+               if (abortCreationThread)
+                  return;
                sb = new StringBuilder();
-               if (EA_Utils.options.opt_SuppressPrivateMethods == false
+               if (EA_DocGenOptions.opt_SuppressPrivateMethods == false
                   || !theMethod.Visibility.StartsWith("Private"))
+               {
                   // Print the Method name as a sub heading, and its description
-                  TextUtils.appendAndSelectHeadingText(theMethod.Name , recurse_level + 1);
+                  TextualContent.appendAndSelectHeadingText(theMethod.Name , recurse_level + 1);
-                  TextUtils.appendDescription(theMethod.Notes, EA_Utils);
+                  TextualContent.appendDescription(TextualContent.trimTrailingReturns(theMethod.Notes));
                   // Get a list of the method's parameters and sort them by the position field setup
                   // in EA by the designer
                   ArrayList theParams = new ArrayList();
                   foreach(EA.Parameter theParam in theMethod.Parameters)
                      theParams.Add( theParam );
                   parameterSortByPos paramSorter = new parameterSortByPos();
                   theParams.Sort( paramSorter );
                   // Print the prototype heading
-                  wr = TextUtils.appendAndSelectText("\nPrototype:", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+                  wr = TextualContent.appendAndSelectText("\nPrototype:", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
                   // begin to build the prototype string
                   sb = new StringBuilder();
                   sb.Append( theMethod.ReturnType );
                   sb.Append( " " );
                   if (theParams.Count > 0)
+                  {
                      int numParamsRemaining = theParams.Count;
                      // print what we have so far constructed for the prototype
-                     wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+                     wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
                      // Now form a new string for the params
                      sb = new StringBuilder();
                      foreach(EA.Parameter theParam in theParams)
+                     {
+                        if (abortCreationThread)
+                           return;
                         // each parameter is   "[in|out|inout] type name [= default-value]"
                         // where the default value is optional
                         sb.Append( "[" );
                         sb.Append( theParam.Kind );
                         sb.Append( "] " );
                         numParamsRemaining--;
+                     }
                      // complete the prototype and print it.
                      sb.Append( ")" );
-                     wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_4_5cm);
+                     wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_4_5cm);
+                  }
                   else
+                  {
                      // complete the prototype and print it.
                      sb.Append( ")" );
-                     wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+                     wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+                  }
                   // Prototype Attributes/Characteristics
                   sb = new StringBuilder();
                      sb.Append( theMethod.Throws );
+                  }
                   if (sb.Length > 0)
+                  {
-                     wr = TextUtils.appendAndSelectText("Characteristics:", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+                     wr = TextualContent.appendAndSelectText("Characteristics:", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
-                     wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+                     wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+                  }
                   // Parameter Descriptions
                   if (theParams.Count > 0)
+                  {
-                     wr = TextUtils.appendAndSelectText("Parameters:", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+                     wr = TextualContent.appendAndSelectText("Parameters:", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
                      foreach(EA.Parameter theParam in theParams)
+                     {
-                        wr = TextUtils.appendAndSelectText( theParam.Name + "\t", EA_Constants.stylename_Parameter_Description);
+                        wr = TextualContent.appendAndSelectText( theParam.Name + "\t", EA_Constants.stylename_Parameter_Description);
                         // do notes in seperate step since we want to call the appendDescription() method which
                         // automatically alerts us to missing descriptions in the generated document.
-                        wr = TextUtils.appendDescription( theParam.Notes, EA_Constants.stylename_Parameter_Description, EA_Utils, true);
+                        wr = TextualContent.appendDescription( TextualContent.trimTrailingReturns(theParam.Notes), EA_Constants.stylename_Parameter_Description, true);
+                        if (abortCreationThread)
+                           return;
+                     }
+                  }
+               }
+            }
+         }
          // eg. Users may only want to document public and protected attributes.
          int numAttrsRemaining = 0;
          foreach(EA.Attribute theAttr in theAttrs)
+         {
+            if (abortCreationThread)
+               return;
-            if (EA_Utils.options.opt_SuppressPrivateAttributes == false
+            if (EA_DocGenOptions.opt_SuppressPrivateAttributes == false
                || !theAttr.Visibility.StartsWith("Private"))
                numAttrsRemaining++;
+         }
          if (numAttrsRemaining > 0)
+         {
             StringBuilder sb = new StringBuilder();
             sb.Append( theElement.Name );
             sb.Append( " Attributes" );
-            TextUtils.appendAndSelectHeadingText(sb.ToString(), recurse_level);
+            TextualContent.appendAndSelectHeadingText(sb.ToString(), recurse_level);
             // serialise the attributes to the document.
             foreach(EA.Attribute theAttr in theAttrs)
+            {
+               if (abortCreationThread)
+                  return;
-               if (EA_Utils.options.opt_SuppressPrivateAttributes == false
+               if (EA_DocGenOptions.opt_SuppressPrivateAttributes == false
                   || !theAttr.Visibility.StartsWith("Private"))
+               {
                   // Begin to build content string for the "Attribute" table column
                   sb = new StringBuilder();
                   // <type> <name>
                   sb.Append("\n");
                   sb.Append(theAttr.Type);
                   sb.Append(" ");
                   sb.Append(theAttr.Name);
-                  Word.Range wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1);
+                  Word.Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1);
                   wr.Font.Bold = 1;
-                  wr = TextUtils.appendDescription(theAttr.Notes, EA_Utils);
+                  wr = TextualContent.appendDescription(TextualContent.trimTrailingReturns(theAttr.Notes));
                   wr.ParagraphFormat.LeftIndent = WordApp.CentimetersToPoints((float)3.5);
                   // The approach here is to display as much of the attribute as we can but try to keep the output
                   // uncluttered by omitting items the user has not set via the EA GUI.
                   // Now look at the constraint and tagged value collections and add any found info to the
                   // right hand column
                   short i;
                   for(i=0; i<theAttr.Constraints.Count; i++)
+                  {
+                     if (abortCreationThread)
+                        return;
                      EA.AttributeConstraint theCons = (EA.AttributeConstraint)theAttr.Constraints.GetAt(i);
                      sb.Append( theCons.Type );
                      sb.Append( ": {" );
                      sb.Append( theCons.Name );
                      sb.Append( "}\n" );
                      //sb.Append( "\n" );
+                  }
                   for(i=0; i<theAttr.TaggedValues.Count; i++)
+                  {
+                     if (abortCreationThread)
+                        return;
                      EA.AttributeTag theTag = (EA.AttributeTag)theAttr.TaggedValues.GetAt(i);
                      sb.Append( "[" );
                      sb.Append( theTag.Name );
                      sb.Append( "="  );
                      sb.Append( theTag.Value );
                   if (sb.Length > 0)
+                  {
                      // remove the trailing "\n"
                      sb.Remove( sb.ToString().Length - 1, 1);
-                     wr = TextUtils.appendAndSelectText("Characteristics:", EA_Constants.styleName_Body1_Left_3_5cm_Italic);
+                     wr = TextualContent.appendAndSelectText("Characteristics:", EA_Constants.styleName_Body1_Left_3_5cm_Italic);
-                     wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_4_5cm);
+                     wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_4_5cm);
+                  }
                   numAttrsRemaining--;
+               }
+            }
+      {
          StringBuilder sb = new StringBuilder();
          ////////////////////////////////////////////////////////////////////////////////////////////////
          sb.Append( "Characteristics:" );
-         Word.Range wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+         Word.Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
          sb = new StringBuilder();
          // VISIBILITY
          sb.Append( theElement.Visibility );
          // ABSTRACT
             sb.Append("\nClass is active (has its own thread of control)\n");
          // IS SPEC
          if (theElement.IsSpec)
             sb.Append("\nClass is a specification\n");
-         wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+         wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
          ////////////////////////////////////////////////////////////////////////////////////////////////
          sb = new StringBuilder();
          foreach(EA.Element baseClass in theElement.BaseClasses)
+         {
             sb.Append( baseClass.Name);
+         }
          if (sb.Length > 0)
+         {
-            wr = TextUtils.appendAndSelectText("Base Class(es):", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+            wr = TextualContent.appendAndSelectText("Base Class(es):", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
-            wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+            wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+         }
          ////////////////////////////////////////////////////////////////////////////////////////////////
          sb = new StringBuilder();
          foreach(EA.Element intf in theElement.Realizes)
+         {
             sb.Append( intf.Name);
+         }
          if (sb.Length > 0)
+         {
-            wr = TextUtils.appendAndSelectText("Realises:", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+            wr = TextualContent.appendAndSelectText("Realises:", EA_Constants.styleName_Body1_Left_2_5cm_Italic);
-            wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+            wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+         }
+      }
       private void generateClassRequirements( EA.Element theElement, int recurse_level )
+      {
          StringBuilder sb = new StringBuilder();
          sb.Append( "Requirements:" );
-         Word.Range wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+         Word.Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
          foreach(EA.Requirement theReq in theElement.Requirements)
+         {
+            if (abortCreationThread)
+               return;
             sb = new StringBuilder();
             sb.Append( theReq.Name );
-            wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+            wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
             sb = new StringBuilder();
             sb.Append( theReq.Notes );
             if (sb.Length > 0)
+            {
-               wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_4_5cm);
+               wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_4_5cm);
+            }
+         }
+      }
       private void generateClassConstraints( EA.Element theElement, int recurse_level )
+      {
          StringBuilder sb = new StringBuilder();
          sb.Append( "Constraints:" );
-         Word.Range wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+         Word.Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
          foreach(EA.Constraint theCons in theElement.Constraints)
+         {
+            if (abortCreationThread)
+               return;
             sb = new StringBuilder();
             sb.Append( theCons.Type );
             sb.Append( ": {" );
             sb.Append( theCons.Name );
             sb.Append( "}" );
-            wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
+            wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_3_5cm);
             if (theCons.Notes.Length > 0)
+            {
                sb = new StringBuilder();
                sb.Append( theCons.Notes );
-               wr = TextUtils.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_4_5cm);
+               wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_4_5cm);
+            }
+         }
+      }
          // track recursion level to control heading style formatting requirements
          if (oneShot_skipRootElementHeading == false)
             recurse_level++;
-         if (EA_Utils.options.elementTypeFoundInEA_DocGen( theElement.Type ))
+         if (EA_DocGenOptions.elementTypeFoundInEA_DocGen( theElement.Type ))
+         {
             // pass the element to the requirement element serialisation function. It
             // will tell us if it did anything with it. If not, then carry out the default
             // element serialisation.
-            if (false == TextUtils.generateRequirementText(theElement, EA_Utils))
+            if (false == TextualContent.generateRequirementText(theElement))
+            {
                bool isClass = theElement.Type.StartsWith("Class");
                if (   (   true == isClass
-                       && true == EA_Utils.options.opt_SuppressPrivateClasses
+                       && true == EA_DocGenOptions.opt_SuppressPrivateClasses
                        && true == theElement.Visibility.StartsWith("Private"))
-                   || (   true == EA_Utils.options.opt_ConsiderAPIElementsOnly
+                   || (   true == EA_DocGenOptions.opt_ConsiderAPIElementsOnly
                        && 0 > theElement.StereotypeEx.IndexOf("API"))
+                  )
+               {
                   // do nothing
-                  DocSectionTracker.trackDocSection(recurse_level);
+                  DocSectionTracking.trackDocSection(recurse_level);
                   displayProgress( "SKIPPED: ", theElement.Name );
                   allowSubElementParsing = false;
+               }
                else
+               {
                   // disarm the one-shot element (heading) skipping feature if it was armed, and
                   // by-pass the code to generate a new heading level for the element
                   if (oneShot_skipRootElementHeading == false)
+                  {
                      // Default element serialisation
-                     TextUtils.appendAndSelectHeadingText( theElement.Name, recurse_level );
+                     TextualContent.appendAndSelectHeadingText( theElement.Name, recurse_level );
+                  }
                   else
+                  {
                      oneShot_skipRootElementHeading = false;
+                  }
                   processedElements.Add(theElement.ElementID);
                   displayProgress( "ELEMENT: ", theElement.Name );
-                  TextUtils.appendDescription( theElement.Notes, EA_Utils );
+                  TextualContent.appendDescription( TextualContent.trimTrailingReturns(theElement.Notes) );
                   generateElementDiagrams(theElement);
                   if (true == isClass)
+                  {
                          && !theElement.Visibility.StartsWith("Private"))
+                     {
                         classesNeedingUnitTests.Add( theElement.ElementID );
+                     }
+                     if (!abortCreationThread)
-                     generateClassCharacteristics(theElement, recurse_level);
+                        generateClassCharacteristics(theElement, recurse_level);
+                  }
                   // Requirement collection
-                  if (theElement.Requirements.Count > 0)
+                  if (!abortCreationThread && theElement.Requirements.Count > 0)
+                  {
                      generateClassRequirements(theElement, recurse_level);
+                  }
                   // Constraint collection
-                  if (theElement.Constraints.Count > 0)
+                  if (!abortCreationThread && theElement.Constraints.Count > 0)
+                  {
                      generateClassConstraints(theElement, recurse_level);
+                  }
-                  if (theElement.Issues.Count > 0)
+                  if (!abortCreationThread && theElement.Issues.Count > 0)
+                  {
+                  }
                   // Attribute collection
-                  if (theElement.Attributes.Count > 0)
+                  if (!abortCreationThread && theElement.Attributes.Count > 0)
+                  {
                      generateAttributeContent(theElement, recurse_level);
+                  }
                   // Method collection
-                  if (theElement.Methods.Count > 0)
+                  if (!abortCreationThread && theElement.Methods.Count > 0)
+                  {
                      generateMethodContent(theElement, recurse_level);
+                  }
+               }
+            }
             else
+            {
                processedElements.Add(theElement.ElementID);
-               DocSectionTracker.trackDocSection(recurse_level);
+               DocSectionTracking.trackDocSection(recurse_level);
                displayProgress( "ELEMENT: ", theElement.Name );
+            }
+         }
          else
+         {
-            DocSectionTracker.trackDocSection(recurse_level);
+            DocSectionTracking.trackDocSection(recurse_level);
             displayProgress( "FILTERED: ", theElement.Type );
+         }
          // TODO
          // We will probably have to put special code in here at some point for attributes
          // of, and collections of things within elements. This will become apparent once
       /// </summary>
       private void removeExistingDocumentContent()
+      {
          //WordApp.Visible = true;  // enable this when debugging this horrible function
          Word.Selection aSelection;
-         object findStyle = StyleUtils.getStyle( EA_Constants.styleName_Heading1 );
+         object findStyle = StyleContent.getStyle( EA_Constants.styleName_Heading1 );
          WordApp.Selection.WholeStory();
          aSelection = WordApp.Selection;
          aSelection.Find.ClearFormatting();
       /// </summary>
       /// <param name="theElement"></param>
       /// <param name="recurse_level"></param>
       private void parse_element(EA.Element theElement, int recurse_level)
+      {
+         if (abortCreationThread)
+            return;
          // First look for and handle special elements that control the doc-gen process
          // The EA_DocGenPackageLink can contain a list of GUIDs in its notes section
          // that point to model structure outside of the localised structure forming the
          // document. This enables a document to grab content from other external models
             // The EA_DocGenTable element can contain table content in its notes section
             // and must be dealt with in a special way.
          else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenTable))
+         {
-            TableUtils.processTableElement(theElement, recurse_level);
+            TabularContent.processTableElement(theElement, recurse_level);
+         }
             // The EA_DocGenText element can contain text content in its notes section
             // that must be appended to the doc in Body 1 style within the current
             // section.
          else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenText))
+         {
-            TextUtils.appendAndSelectText( theElement.Notes.ToString(), EA_Constants.styleName_Body1 );
+            TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(theElement.Notes), EA_Constants.styleName_Body1 );
+         }
          else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenRelationshipMatrix))
+         {
-            EA_RelationshipMatrix EA_RelMatrix = new EA_RelationshipMatrix(EA_Repository, TableUtils, TextUtils, EA_Utils, WordDocument, processedElements);
+            EA_RelationshipMatrix.initialise(processedElements);
-            if (EA_RelMatrix.processRelationshipMatrixOptions( theElement ))
+            if (EA_RelationshipMatrix.processRelationshipMatrixOptions( theElement ))
+            {
-               EA_RelMatrix.processRelationshipMatrixElement( theElement, recurse_level );
+               EA_RelationshipMatrix.processRelationshipMatrixElement( theElement, recurse_level );
+            }
+         }
          else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenTestLink))
+         {
             if (allowSubElementParsing)
+            {
                // Look at this elements sub-elements
                foreach(EA.Element subElement in theElement.Elements)
+               {
+                  if (abortCreationThread)
+                     return;
                   parse_element(subElement, recurse_level+1);
+               }
+            }
+         }
+      }
       /// </summary>
       /// <param name="parentPackage"></param>
       /// <param name="recurse_level"></param>
       private void parse_package(EA.Package thePackage, int recurse_level)
+      {
+         if (abortCreationThread)
+            return;
          // track recursion level to control heading style formatting requirements
          // The one-shot skiproot feature of the EA_DocGenPackageLink element handling has an effect
          // here, as you can see.
          bool rootPackageWasSkipped = !oneShot_skipRootPackage;
          if (oneShot_skipRootPackage == false)
          bool packageHasAPIStereotype = false;
          if (0 <= thePackage.StereotypeEx.IndexOf("API") )
             packageHasAPIStereotype = true;
          // only process the package if it the stereotype allows, or sensitivity to the stereotype is disabled
-         if (  !EA_Utils.options.opt_ConsiderAPIPackagesOnly
+         if (  !EA_DocGenOptions.opt_ConsiderAPIPackagesOnly
-            || (EA_Utils.options.opt_ConsiderAPIPackagesOnly && EA_Utils.options.opt_RestrictForLinkedPackagesOnly && processingLink == 0)
+            || (EA_DocGenOptions.opt_ConsiderAPIPackagesOnly && EA_DocGenOptions.opt_RestrictForLinkedPackagesOnly && processingLink == 0)
-            || (EA_Utils.options.opt_ConsiderAPIPackagesOnly && packageHasAPIStereotype)
+            || (EA_DocGenOptions.opt_ConsiderAPIPackagesOnly && packageHasAPIStereotype)
+            )
+         {
             bool processLowerLevelContent = true;
                // consume diagrams
                generatePackageDiagrams( thePackage );
                foreach(EA.Element subElement in thePackage.Elements)
+               {
+                  if (abortCreationThread)
+                     return;
                   if (subElement.ParentID == 0 || thePackage.PackageID == subElement.ParentID)
                      parse_element(subElement, recurse_level);
+               }
                // Scan through the sub-packages within this package.
                foreach(EA.Package subPackage in thePackage.Packages)
+               {
+                  if (abortCreationThread)
+                     return;
                   // recurse
                   parse_package(subPackage, recurse_level);
+               }
+            }
+         }
       /// an input template, sets various characteristics of the document, schedules the
       /// EA parsing function, before finally saving the document to the output file name.
       /// </summary>
       private void createTheWordDoc()
+      {
+         docGenCompletedNormally = false;
+         abortCreationThread = false;
+         Main.threadCreateDocProcessRunning = true;
-         // caputre initial security settings
+         // capture initial security settings
          MsoAutomationSecurity  securityBefore = WordApp.AutomationSecurity;
+         button_generate.Enabled = false;
+         button_browse_output_file.Enabled = false;
+         button_browse_template.Enabled = false;
+         textBox_output_file.Enabled = false;
+         textBox_template.Enabled = false;
+         checkBox_WordVisibility.Enabled = false;
          try
+         {
             object template       = this.textBox_template.Text;
             object newTemplate    = Type.Missing;
             object outputFilename = this.textBox_output_file.Text;
             object docType = Type.Missing;
             object visible = Type.Missing;
             object nothing = Type.Missing;
             object notTrue = false;
-            EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "", 0);
+            Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "", 0);
-            EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME,
+            Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME,
                                        String.Format( "Generating Document {0}", this.textBox_output_file.Text), 0 );
             // tell word not to show itself unless user has checked the option to say otherwise
             WordApp.Visible = this.checkBox_WordVisibility.Checked;
             // disable VB macros from running in the document
             WordApp.AutomationSecurity = MsoAutomationSecurity.msoAutomationSecurityForceDisable;
             WordApp.DisplayAlerts = Word.WdAlertLevel.wdAlertsNone;
             // Create a document from the input template
+            Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Creating new document based on template", -1);
             WordDocument = WordApp.Documents.Add(ref template, ref newTemplate, ref docType, ref visible);
-            TableUtils.AcceptWordAppAndDoc(WordApp, WordDocument);
-            TextUtils.AcceptWordAppAndDoc(WordApp, WordDocument);
-            StyleUtils.AcceptWordAppAndDoc(WordApp, WordDocument);
             // Remove all old content from the input document/template. Note that this assumes
             // that content will begin at section 1 with the title "Introduction" and it will have
             // "Heading 1" style.
+            if (!abortCreationThread)
+            {
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Removing existing content (if any)", -1);
-            removeExistingDocumentContent();
+               removeExistingDocumentContent();
+            }
             // turn off grammar and spell checking
             WordDocument.GrammarChecked = false;
             WordDocument.SpellingChecked = false;
             processedElements = new ArrayList();
             // If the input template does not contain the styles needed for requirement documents,
             // programmatically create them just in case.
+            if (!abortCreationThread)
+            {
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Creating Requirement Styles", -1);
-            StyleUtils.createRequirementStyles();
+               StyleContent.createRequirementStyles();
+            }
+            if (!abortCreationThread)
+            {
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Creating Additional Heading Styles", -1);
-            StyleUtils.createAdditionalHeadingLevelStyles();
+               StyleContent.createAdditionalHeadingLevelStyles();
+            }
+            if (!abortCreationThread)
+            {
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Creating Element Detail Styles", -1);
-            StyleUtils.createElementDetailsStyles();
+               StyleContent.createElementDetailsStyles();
+            }
+            if (!abortCreationThread)
+            {
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Correcting known problems in ERG template styles", -1);
-            StyleUtils.correctErrorsInTemplateStyles();
+               StyleContent.correctErrorsInTemplateStyles();
+            }
             // Parse EA_DocGen Document Model. The parent package is the document model itself
             // and the packages within it are the top level packages only.
             // Question: do we have to parse diagrams and elements at this top level? So far,
             // this has been found to be unecessary, but you never know. For now, dont do it.
-            foreach(EA.Package thePackage in EA_ParentPackage.Packages)
+            if (!abortCreationThread)
+            {
-               parse_package(thePackage, 0);
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Generating new content", -1);
-            }
+               foreach(EA.Package thePackage in EA_ParentPackage.Packages)
+               {
+                  parse_package(thePackage, 0);
+                  if (abortCreationThread)
+                     break;
+               }
+            }
             // for design docs, a user may have used the test traceability element in their document model,
             // which means that now we are finished with parse 1 of the document, we can complete the traceability
             // table (if any) that was begun when that special element was first encountered.
-            completeTestTraceability();
+            if (!abortCreationThread)
-            // Save the document to the output file before we try and update the fields. This is because
-            // I have seen Fields.Update() fail on a few occasions and it is very annoying
-            // to lose what has thus far been generated.
-            WordDocument.SaveAs( ref outputFilename,
-               ref nothing, ref nothing, ref nothing, ref nothing,
-               ref nothing, ref nothing, ref nothing, ref nothing,
-               ref nothing, ref nothing, ref nothing, ref nothing,
-               ref nothing, ref nothing, ref nothing);
-            object noSave = Word.WdSaveOptions.wdDoNotSaveChanges;
-            object format = Word.WdOriginalFormat.wdWordDocument;
-            WordDocument.Close(ref noSave, ref format, ref nothing);
-            // Re-load the document to update the fields. For some as yet unknown reason, doing this
-            // sometimes fails, but by doing it in a re-loaded instance of the word document
-            // the failures seem to be reduced.
+            {
-            WordDocument = WordApp.Documents.Add(ref outputFilename, ref newTemplate, ref docType, ref visible);
-            WordDocument.Fields.Update();
+               completeTestTraceability();
-            WordDocument.SaveAs( ref outputFilename,
-               ref nothing, ref nothing, ref nothing, ref nothing,
-               ref nothing, ref nothing, ref nothing, ref nothing,
-               ref nothing, ref nothing, ref nothing, ref nothing,
-               ref nothing, ref nothing, ref nothing);
+               // Save the document to the output file before we try and update the fields. This is because
+               // I have seen Fields.Update() fail on a few occasions and it is very annoying
+               // to lose what has thus far been generated.
+               WordDocument.SaveAs( ref outputFilename,
+                  ref nothing, ref nothing, ref nothing, ref nothing,
+                  ref nothing, ref nothing, ref nothing, ref nothing,
+                  ref nothing, ref nothing, ref nothing, ref nothing,
+                  ref nothing, ref nothing, ref nothing);
+               object noSave = Word.WdSaveOptions.wdDoNotSaveChanges;
+               object format = Word.WdOriginalFormat.wdWordDocument;
+               WordDocument.Close(ref noSave, ref format, ref nothing);
+               if (!abortCreationThread)
+               {
+                  Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Updating Fields and Saving Document", -1);
+                  // Re-load the document to update the fields. For some as yet unknown reason, doing this
+                  // sometimes fails, but by doing it in a re-loaded instance of the word document
+                  // the failures seem to be reduced.
+                  WordDocument = WordApp.Documents.Add(ref outputFilename, ref newTemplate, ref docType, ref visible);
+                  WordDocument.Fields.Update();
+                  WordDocument.SaveAs( ref outputFilename,
+                     ref nothing, ref nothing, ref nothing, ref nothing,
+                     ref nothing, ref nothing, ref nothing, ref nothing,
+                     ref nothing, ref nothing, ref nothing, ref nothing,
+                     ref nothing, ref nothing, ref nothing);
-            // Tell user the process completed ok
+                  // Tell user the process completed ok
+                  Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Document Generation Complete", -1);
-            textBox_progress.AppendText( "---Completed---" );
+                  docGenCompletedNormally = true;
+                  button_view_output.Enabled = true;
+               }
+            }
+            else
+            {
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Document Generation Aborted", -1);
-            MessageBox.Show("Document Generation Complete");
+               MessageBox.Show("Document Generation Aborted");
+            }
-            button_view_output.Enabled = true;
+         }
          catch (Exception createTheWordDoc_exception)
+         {
+            Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Document Generation Failed : " + createTheWordDoc_exception.Message, -1);
             MessageBox.Show("Document Generation Failed\n\n" + createTheWordDoc_exception.Message);
+         }
          // restore security settings
          WordApp.AutomationSecurity = securityBefore;
+         // issue the generation complete message box as close to the end of the thread as possible so that
+         // there is less of a chance that a user pressing the close button will see a "cancel generation"
+         // warning box.
+         if (docGenCompletedNormally)
+            MessageBox.Show("Document Generation Complete");
+         // we can mark the thread as not running since from now on we do not want to do anything with the
+         // WordApp or WordDocument objects and their destruction wont cause any ill effects.
+         Main.threadCreateDocProcessRunning = false;
+         if (mustClose)
+            this.Close();
+      }
       #endregion
+   }
+}

Subversion Repositories DevTools

(root)/EA_DocGen/trunk/EA_DocGen/createWordDoc.cs – Rev 2104 → 2106