Subversion Repositories DevTools

using System;

using System.Drawing;

using System.Collections;

using System.Text;

using System.ComponentModel;

using System.Windows.Forms;

using Word;

using Microsoft.Office.Core;

using System.Threading;

namespace EA_DocGen

{

   /// <summary>

   /// Summary description for createWordDoc.

   /// </summary>

   public class createWordDoc : System.Windows.Forms.Form

   {

      // Enterprise Architect Model related data

      private EA.Package EA_ParentPackage = null;

      private EA.Project EA_Project;

      private Thread creationThread = null;           // Document generation thread

      public static bool abortCreationThread;         // Used to abort the document generation thread

      private bool mustClose = false;                 // Used to signal closure required for doc generation dialog

      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 processedElements = null;

      // This data is designed to support unit test traceability. As such, it is only of real use

      // when making s/w design documents. It allows all non-private classes to be collected into

      // a list in order to generate a design-to-unit-test traceability table.

      private ArrayList classesNeedingUnitTests = null;

      private ArrayList classesWithUnitTests = null;

      private Word.Table utTraceabilityTable = null;

      // MS-Office Word related data

      public static Word.Application WordApp = null;

      public static Word.Document WordDocument = null;

      // Form data

      public System.Windows.Forms.TextBox textBox_template;

      private System.Windows.Forms.Button button_browse_template;

      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.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.Package theParentPackage)

      {

         //

         // Required for Windows Form Designer support

         //

         InitializeComponent();

         EA_ParentPackage = theParentPackage;

         EA_Project       = Main.EA_Repository.GetProjectInterface();

         DocSectionTracking.initialise();

         TabularContent.initialise();

         TextualContent.initialise();

         StyleContent.initialise();

         WordApp = new Word.Application();

      }

      /// <summary>

      /// Clean up any resources being used.

      /// </summary>

      protected override void Dispose( bool disposing )

      {

         if( disposing )

         {

            if(components != null)

            {

               components.Dispose();

            }

         }

         base.Dispose( disposing );

      }

      #region Windows Form Designer generated code

      /// <summary>

      /// Required method for Designer support - do not modify

      /// the contents of this method with the code editor.

      /// </summary>

      private void InitializeComponent()

      {

         this.textBox_template = new System.Windows.Forms.TextBox();

         this.button_browse_template = new System.Windows.Forms.Button();

         this.textBox_output_file = new System.Windows.Forms.TextBox();

         this.button_browse_output_file = new System.Windows.Forms.Button();

         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.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(8, 32);

         this.textBox_template.Name = "textBox_template";

         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(712, 32);

         this.button_browse_template.Name = "button_browse_template";

         this.button_browse_template.Size = new System.Drawing.Size(64, 23);

         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(8, 96);

         this.textBox_output_file.Name = "textBox_output_file";

         this.textBox_output_file.Size = new System.Drawing.Size(696, 22);

         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(712, 96);

         this.button_browse_output_file.Name = "button_browse_output_file";

         this.button_browse_output_file.Size = new System.Drawing.Size(64, 24);

         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(648, 152);

         this.button_cancel.Name = "button_cancel";

         this.button_cancel.Size = new System.Drawing.Size(128, 32);

         this.button_cancel.TabIndex = 3;

         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, 152);

         this.button_generate.Name = "button_generate";

         this.button_generate.Size = new System.Drawing.Size(128, 32);

         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(336, 152);

         this.button_view_output.Name = "button_view_output";

         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(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(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";

         // 

         // checkBox_WordVisibility

         // 

         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 = 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(784, 202);

         this.Controls.Add(this.checkBox_keep_on_top);

         this.Controls.Add(this.checkBox_WordVisibility);

         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.TopMost = true;

         this.Closing += new System.ComponentModel.CancelEventHandler(this.createWordDoc_Closing);

         this.ResumeLayout(false);

      }

      #endregion

      #region Message handlers

      private void button_view_output_Click(object sender, System.EventArgs e)

      {

         if (WordApp != null)

         {

            WordApp.Visible = true;

         }

         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));

               creationThread.ApartmentState = ApartmentState.STA;

               creationThread.Priority = ThreadPriority.Highest;

               creationThread.Start();

            }

            else

            {

               MessageBox.Show("Error - must specify an output file");

            }

         }

         else

         {

            MessageBox.Show("Error - must specify an input template file");

         }

      }

      private void button_cancel_Click(object sender, System.EventArgs e)

      {

      }

      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;

         if (DialogResult.OK == dialog.ShowDialog())

         {

            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;

         if (DialogResult.OK == dialog.ShowDialog())

         {

            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);

            }

         }

         else if (WordApp != null)

         {

            // try-catch just in case user closed the application themselves whilst viewing the

            // generated output document

            try 

            {

               object nothing = Type.Missing;

               object notTrue = false;

               WordApp.Application.Quit( ref notTrue, ref nothing, ref nothing);

            }

            catch (Exception createWordDoc_Closing_exception)

            {

               // dummy statement

               String s = createWordDoc_Closing_exception.Message;

            }

         }

      }

      #endregion

      #region word document generation code

      /// <summary>

      /// Displays progress of the document generation in the createWordDocument dialog

      /// </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" );

         // Display to the output tab as well - as a longer term record of what happened

         StringBuilder sb = new StringBuilder("");

         DocSectionTracking.appendHeadingNumber(ref sb);

         while (sb.Length < 30)

            sb.Append(" ");

         sb.Append(prefix);

         sb.Append(EA_string);

         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

      /// into the clipboard from where it can be pasted into the word document. After

      /// pasting it into the document, it sets the style and other aspects of the 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_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;

            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;

            Word.Range WordRange = WordDocument.Range(ref startLocation, ref endLocation);

            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.

            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

            object l_style = EA_Constants.styleName_Normal;

            endLocation = WordDocument.Content.End;

            WordRange = WordDocument.Range(ref startLocation, ref endLocation);

            WordRange.set_Style(ref l_style);

            // Center the diagram on the page

            object unit = Word.WdUnits.wdLine;

            object missing = Type.Missing;

            object count = 1;

            WordApp.Selection.MoveDown( ref unit, ref count, ref missing);

            WordApp.Selection.ParagraphFormat.Alignment = Word.WdParagraphAlignment.wdAlignParagraphCenter;

            // Add a caption

            WordDocument.Content.InsertParagraphAfter();

            TextualContent.SelectInsertionPointAtEndOfDocument();         

            object Label = "Figure";

            object Title = Type.Missing;

            object TitleAutoText = Type.Missing;

            object Position = Word.WdCaptionPosition.wdCaptionPositionAbove;

            object ExcludeLabel = 0;

            WordApp.Selection.InsertCaption( ref Label, ref Title, ref TitleAutoText, ref Position, ref ExcludeLabel);

            WordApp.Selection.TypeText( ": " + theDiagram.Name.ToString());

            WordApp.Selection.ParagraphFormat.Alignment = Word.WdParagraphAlignment.wdAlignParagraphCenter;

            // experimental code to create a bookmark for the figure caption

            //WordDocument.Paragraphs[ WordDocument.Paragraphs.Count ].Range.Select();

            //object lastParaRange = WordDocument.Paragraphs[ WordDocument.Paragraphs.Count ].Range;

            //string bookmarkName = theDiagram.Name;

            //bookmarkName = bookmarkName.Replace(' ', '_');

            //WordDocument.Bookmarks.Add( bookmarkName, ref lastParaRange );

            // Close the diagram in EA

            Main.EA_Repository.CloseDiagram(theDiagram.DiagramID);

            displayProgress( "DIAGRAM: ", theDiagram.Name.ToString() );

         }

      }

      #region special element processing functions (link elements, table and text elements, etc)

      /// <summary>

      /// This is an attempt to create a table similar in style to those made by the ERG doc template macros.

      /// It is not exaclty that same though, and further work could be done to align it more precisely.

      /// </summary>

      /// <param name="tableTitle"></param>

      /// <param name="numRows"></param>

      /// <param name="numCols"></param>

      /// <returns></returns>

      /// <summary>

      /// This function process a package link element, parsing each linked package by the

      /// parse_package() recursive function.

      /// </summary>

      /// <param name="theElement"></param>

      /// <param name="recurse_level"></param>

      private void processPackageLink(EA.Element theElement, int recurse_level)

      {

         string [] EA_DocGenPkgLnk = null;

         string delimStr = "\r\n";

         char [] delim = delimStr.ToCharArray();

         EA_DocGenPkgLnk = theElement.Notes.ToString().Split(delim,100);

         string linkedName = "";

         foreach(string s in EA_DocGenPkgLnk)

         {

            if (s.Length > 0 && s != "\n" && s != "\r")

            {

               if (s == "skiproot")

               {

                  oneShot_skipRootPackage = true;

               }

               else if (s[0] == '{')

               {

                  EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);

                  if (theFoundPackage != null)

                  {

                     parse_package(theFoundPackage, recurse_level);

                  }

                  else

                  {

                     MessageBox.Show("WARNING - Could not find linked package : " + linkedName );

                  }

               }

               else

               {

                  linkedName = s;

               }            

            }

         }

      }

      /// <summary>

      /// This function process a diagram link element, using the appendAndSelectDiagramViaClipboard()

      /// for each linked diagram.

      /// </summary>

      /// <param name="theElement"></param>

      private void processDiagramLink(EA.Element theElement)

      {

         string [] EA_DocGenDiagLnk = null;

         string delimStr = "\r\n";

         char [] delim = delimStr.ToCharArray();

         EA_DocGenDiagLnk = theElement.Notes.ToString().Split(delim,100);

         string linkedName = "";

         foreach(string s in EA_DocGenDiagLnk)

         {

            if (s.Length > 0 && s != "\n" && s != "\r" )

            {

               if (s[0] == '{')

               {

                  EA.Diagram theFoundDiagram = (EA.Diagram)Main.EA_Repository.GetDiagramByGuid(s);

                  if (theFoundDiagram != null)

                  {

                     appendAndSelectDiagramViaClipboard( theFoundDiagram );

                  }

                  else 

                  {

                     MessageBox.Show("WARNING - Could not find linked diagram : " + linkedName );

                  }

               }

               else

               {

                  linkedName = s;

               }            

            }

         }         

      }

      /// <summary>

      /// This function process an element link element, parsing each linked element by the

      /// parse_element() recursive function.

      /// </summary>

      /// <param name="theElement"></param>

      /// <param name="recurse_level"></param>

      private void processElementLink(EA.Element theElement, int recurse_level )

      {

         string [] EA_DocGenEleLnk = null;

         string delimStr = "\r\n";

         char [] delim = delimStr.ToCharArray();

         EA_DocGenEleLnk = theElement.Notes.ToString().Split(delim,100);

         string linkedName = "";

         foreach(string s in EA_DocGenEleLnk)

         {

            if (s.Length > 0 && s != "\n" && s != "\r")

            {

               if (s == "skiproot")

               {

                  oneShot_skipRootElementHeading = true;

               }

               else if ( s[0] == '{')

               {

                  EA.Element theFoundElement = Main.EA_Repository.GetElementByGuid(s);

                  if (theFoundElement != null)

                  {

                     parse_element( theFoundElement, recurse_level );

                  }

                  else 

                  {

                     MessageBox.Show("WARNING - Could not find linked element : " + linkedName );

                  }

               }

               else

               {

                  linkedName = s;

               }            

            }

         }         

      }

      /// <summary>

      /// This method is recursive and searches a model structure to find a match to any 

      /// of the names given in a list. Matched package structure is then parsed for

      /// document content generation.

      /// </summary>

      /// <param name="parentPackage"></param>

      /// <param name="thePackage"></param>

      /// <param name="recurse_level"></param>

      /// <param name="skipRoots"></param>

      /// <param name="names"></param>

      private void processNameLinkPackage(EA.Package parentPackage, EA.Package thePackage, int recurse_level, bool skipRoots, ref ArrayList names)

      {

         // search for the package name in the names[] list

         int i = 0;

         bool found = false;

         foreach (string name in names)

         {

            // users can specify parent\child in a name to help narrow down exactly what package they 

            // are looking for so deal with that, but the parent\ part is optional.

            int splitpos = name.IndexOf('\\',0);

            if (splitpos >= 0)

            {

               if (parentPackage != null)

               {

                  if (name.Substring(0,splitpos).Equals(parentPackage.Name))

                  {

                     if (name.Substring(splitpos+1).Equals(thePackage.Name))

                     {

                        found = true;

                        break;

                     }

                  }

               }

               else

               {

                  if (name.Substring(splitpos+1).Equals(thePackage.Name))

                  {

                     found = true;

                     break;

                  }

               }

            }

            else

            {

               if (name.Equals(thePackage.Name))

               {

                  found = true;

                  break;

               }

            }

            i++;

         }

         if (found)

         {

            // remove the found name, arm the skiproot mechanism if needed, and parse the package

            names.RemoveAt(i);

            if (skipRoots == true)

               oneShot_skipRootPackage = true;

            parse_package(thePackage, recurse_level);

         }

         else if (names.Count > 0)  // any names left to process?

         {

            // recurse for each of this packages sub-packages

            foreach(EA.Package subPackage in thePackage.Packages)

            {

               processNameLinkPackage(thePackage, subPackage, recurse_level, skipRoots, ref names);                        

            }         

         }

      }

      private void processNameLink(EA.Element theElement, int recurse_level )

      {

         string delimStr = "\r\n";

         char [] delim = delimStr.ToCharArray();

         string [] EA_DocGenNameLnk = theElement.Notes.ToString().Split(delim,100);

         string linkedName = "";

         bool gotLinkedName = false;

         ArrayList names = new ArrayList();

         EA.Package theFoundPackage = null;

         bool skipRoots = false;

         // search through the option strings

         foreach(string s in EA_DocGenNameLnk)

         {

            if (s.Length > 0 && s != "\n" && s != "\r")

            {

               if (s == "skiproot")

               {

                  skipRoots = true;

               }

               else if (s[0] == '{')  // is it a GUID?

               {

                  // find the package by its GUID

                  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) );

               }

               else if (gotLinkedName == false)

               {

                  // capture name of package refered to by the GUID - this is only for diagnostic purposes

                  gotLinkedName = true;

                  linkedName = s;

               }            

            }

         }  

         // If the GUID was resolved...

         if (theFoundPackage != null)

         {

            processNameLinkPackage(null, theFoundPackage, recurse_level, skipRoots, ref names);

            if (names.Count > 0)

            {

               StringBuilder sb = new StringBuilder();

               sb.Append("WARNING - Could not find named package(s)\n");

               sb.Append("within name link: ");

               sb.Append(linkedName);

               sb.Append("\n\nProblem package= directives are:\n");

               foreach(String s in names)

               {

                  sb.Append("\n");

                  sb.Append(s);

               }

               MessageBox.Show(sb.ToString());

            }

         }

         else

         {

            MessageBox.Show("WARNING - Could not find linked package : " + linkedName );

         }

      }

      /// <summary>

      /// This function processes a name link element. These are elements that point

      /// (using a GUID) to a package, and the user has specified text names of sub-packages

      /// within the package that they wish to have processed for document generation.

      /// This is a useful way of getting content when you cannot be sure that the GUIDs

      /// of the packages you want will remain constant (eg. when re-using content from

      /// a reqpro import (for doc gen purposes)).

      /// </summary>

      /// <param name="theElement"></param>

      /// <param name="recurse_level"></param>

      private void processTestLink(EA.Element theElement, int recurse_level )

      {

         string [] EA_DocGenEleLnk = null;

         string delimStr = "\r\n";

         char [] delim = delimStr.ToCharArray();

         EA_DocGenEleLnk = theElement.Notes.ToString().Split(delim,100);

         string linkedName = "";

         foreach(string s in EA_DocGenEleLnk)

         {

            if (s.Length > 0 && s != "\n" && s != "\r")

            {

               if ( s[0] == '{')

               {

                  try

                  {

                     // try to find the GUID as a package

                     EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);

                     if (theFoundPackage != null)

                        TextualContent.appendUnitTestSuite(theFoundPackage, recurse_level, ref classesWithUnitTests);

                     else 

                     {

                        // try to find the GUID as an element

                        EA.Element theFoundElement = Main.EA_Repository.GetElementByGuid(s);

                        if (theFoundElement != null)

                           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 = Main.EA_Repository.GetElementByGuid(s);

                     if (theFoundElement != null)

                        TextualContent.appendUnitTestSuite(theFoundElement, recurse_level, ref classesWithUnitTests);

                     else 

                        MessageBox.Show("WARNING - Could not find linked element : " + linkedName );

                  }

               }

               else

               {

                  linkedName = s;

               }            

            }

         }         

      }

      private void processTestTraceability( EA.Element theElement, int recurse_level )

      {

         if (classesNeedingUnitTests.Count > 0)

         {

            if (theElement.Notes.Length > 0)

            {

               TextualContent.appendAndSelectText( theElement.Notes, EA_Constants.styleName_Body1);

            }

            int tableNum = TabularContent.Table_Create("Design Element to Unit Test Suite Traceability", true, 2, 2);

            utTraceabilityTable = WordDocument.Tables[tableNum];

            TabularContent.Table_SetTableColumnTitle(utTraceabilityTable, "Design Element (class)", 1);

            TabularContent.Table_SetTableColumnTitle(utTraceabilityTable, "Test Suite", 2);

         }

      }

      private void completeTestTraceability()

      {

         if (utTraceabilityTable != null)

         {

            int numClassesRemaining = classesNeedingUnitTests.Count;

            int row = 2;

            foreach(int elementId in classesNeedingUnitTests)

            {

               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 = 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)

               {

                  TabularContent.Table_InsertNewRowAfterThisRow(utTraceabilityTable, row);

                  row++;

               }

               if (abortCreationThread)

                  break;

            }

         }

      }

      #endregion

      #region special section processing functions (references, terminology, etc)

      /// <summary>

      /// This function processes elements as if they represented document references for

      /// the References section of a document.

      /// </summary>

      /// <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.

            TextualContent.appendAndSelectText( theElement.Name.ToString(), EA_Constants.styleName_RefListNum );

            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 = 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;

            bool done = false;

            int retries = 3;

            do

            {

               if (abortCreationThread)

                  return;

               try

               {

                  glossary = new ArrayList();

                  foreach(EA.Term theTerm in Main.EA_Repository.Terms)

                     glossary.Add(theTerm);

                  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--;

               }

            } while (!done && retries > 0);

            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,2).Range.Text = theTerm.Meaning;

                  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))

               {

                  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))

               {

                  TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(theElement.Notes), EA_Constants.styleName_Body1 );

               }