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;

namespace EA_DocGen

{

   /// <summary>

   /// 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 TextualContent TextUtils = null;

      private StyleContent   StyleUtils = null;

      private bool oneShot_skipRootPackage = false;

      private bool oneShot_skipRootElementHeading = false;

      // 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 bool recordingNonPrivateClasses = false;

      private ArrayList nonPrivateClasses = null;

      private ArrayList classesWithUnitTests = null;

      private Word.Table utTraceabilityTable = null;

      // MS-Office Word related data

      private Word.Application WordApp = null;

      private Word.Document WordDocument = null;

      private int[] DocSection = null;

      private int   iDocSection = 0;

      private System.Windows.Forms.TextBox textBox_template;

      private System.Windows.Forms.Button button_browse_template;

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

      /// <summary>

      /// Required designer variable.

      /// </summary>

      private System.ComponentModel.Container components = null;

      public createWordDoc(EA.Repository theRepository, EA.Package theParentPackage, EA_Utilities theEA_Utils)

      {

         //

         // Required for Windows Form Designer support

         //

         InitializeComponent();

         EA_Repository    = theRepository;

         EA_ParentPackage = theParentPackage;

         EA_Project       = EA_Repository.GetProjectInterface();

         EA_Utils         = theEA_Utils;

         TableUtils       = new TabularContent(WordApp, WordDocument);

         TextUtils        = new TextualContent(WordApp, WordDocument);

         StyleUtils       = new StyleContent(WordApp, WordDocument);

         DocSection = new int[12];

         for (int i=0; i<DocSection.Length; i++)

         {

            DocSection[i] = 0;

         }

         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.textBox_progress = new System.Windows.Forms.TextBox();

         this.label3 = new System.Windows.Forms.Label();

         this.checkBox_WordVisibility = new System.Windows.Forms.CheckBox();

         this.SuspendLayout();

         // 

         // textBox_template

         // 

         this.textBox_template.Location = new System.Drawing.Point(16, 40);

         this.textBox_template.Name = "textBox_template";

         this.textBox_template.Size = new System.Drawing.Size(592, 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.Name = "button_browse_template";

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

         this.button_browse_template.TabIndex = 1;

         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.Name = "textBox_output_file";

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

         this.textBox_output_file.TabIndex = 2;

         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.Name = "button_browse_output_file";

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

         this.button_browse_output_file.TabIndex = 3;

         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.Location = new System.Drawing.Point(616, 384);

         this.button_cancel.Name = "button_cancel";

         this.button_cancel.Size = new System.Drawing.Size(80, 23);

         this.button_cancel.TabIndex = 4;

         this.button_cancel.Text = "Close";

         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.Name = "button_generate";

         this.button_generate.Size = new System.Drawing.Size(96, 24);

         this.button_generate.TabIndex = 5;

         this.button_generate.Text = "Generate";

         this.button_generate.Click += new System.EventHandler(this.button_generate_Click);

         // 

         // button_view_output

         // 

         this.button_view_output.Location = new System.Drawing.Point(376, 384);

         this.button_view_output.Name = "button_view_output";

         this.button_view_output.Size = new System.Drawing.Size(96, 23);

         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.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.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.Name = "checkBox_WordVisibility";

         this.checkBox_WordVisibility.Size = new System.Drawing.Size(256, 24);

         this.checkBox_WordVisibility.TabIndex = 17;

         this.checkBox_WordVisibility.Text = "Show MS-WORD During Construction";

         // 

         // createWordDoc

         // 

         this.AutoScaleBaseSize = new System.Drawing.Size(6, 15);

         this.ClientSize = new System.Drawing.Size(712, 432);

         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.Name = "createWordDoc";

         this.Text = "createWordDoc";

         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)

            {

               button_generate.Enabled = false;

               createTheWordDoc();

            }

            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)

      {

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

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

         this.textBox_output_file.Text = dialog.FileName;

      }

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

      {

      }

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

      {

      }

      private void createWordDoc_Closing(object sender, System.ComponentModel.CancelEventArgs e)

      {

         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>

      /// This class is one derived from the EA_UtilitiesRecursionWorker base class so that

      /// an instance of it can be used as a parameter in the EA_Utilities.findAndProcessPackageElements

      /// method which recursively parses a given package. Thus, clients can parse EA model structure but

      /// specify their own functionality to be carried out on packages and elements found in the 

      /// parsing.

      /// This particular derived class is designed to collect a list of element names from the

      /// package, from elements that have a type that is acceptable.

      /// </summary>

      public class ElementAccumulator : EA_UtilitiesRecursionWorker

      {

         public ArrayList Elements = null;

         private ArrayList validElementTypes = null;

         private EA_Utilities EA_Utils = null;

         public ElementAccumulator(ArrayList elementTypeList, EA_Utilities theEA_Utils): base()

         {

            validElementTypes = elementTypeList;

            EA_Utils = theEA_Utils;

            Elements = new ArrayList();

         }

         public override void processElement( EA.Element theElement )

         {

            if (validElementTypes.Contains( theElement.Type ))

            {

               //if ( (theElement.Type == "Requirement") && (theElement.Status == "Rejected") )

               //   return;

               if (   0 == theElement.Type.CompareTo("Class")

                  && true == EA_Utils.options.opt_SuppressPrivateClasses

                  && true == theElement.Visibility.StartsWith("Private") )

               {

                  // do nothing

               }

               else

                  Elements.Add( theElement );

            }

         }

      }

      private void trackDocSection(int recurse_level)

      {

         iDocSection = recurse_level;

         DocSection[iDocSection]++;     

         for (int i=iDocSection+1; i<DocSection.Length; i++)

            DocSection[i] = 0;

      }

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

         for (int i = 1; i<=iDocSection; i++)

         {

            if (i!=1)

               sb.Append(".");

            sb.Append(DocSection[i].ToString());

         }

         while (sb.Length < 30)

            sb.Append(" ");

         sb.Append(prefix);

         sb.Append(EA_string);

         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)

      {

         // open the diagram in EA and copy it's image to the clipboard

         if (EA_Project.PutDiagramImageOnClipboard(theDiagram.DiagramGUID,0))

         {

            object startLocation;

            object endLocation;

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

            TextUtils.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();

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

            EA_Repository.CloseDiagram(theDiagram.DiagramID);

         }

      }

      #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 = EA_Utils.EA_Finder.findPackageInRepositoryByGUID(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_Utils.EA_Finder.findDiagramInRepositoryByGUID(s);

                  if (theFoundDiagram != null)

                  {

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

                     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 = EA_Utils.EA_Finder.findElementInRepositoryByGUID(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 creates a table from the content of an EA_DocGenTable element in the model.

      /// The elements notes section contains the table parameters and cell content.

      /// See the EA_Utilities::AddTableElement() method for the layout of this content.

      /// </summary>

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

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

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

      {

         string [] EA_DocGenTable = null;

         string [] cells = null;

         string delimStr = "\r\n";

         char [] delim = delimStr.ToCharArray();

         string trimStr = " ";

         char [] trimChars = trimStr.ToCharArray();

         EA_DocGenTable = theElement.Notes.ToString().Split(delim,200);

         int columnCount = 0;

         int rowCount = 0;

         char seperator = ',';

         string tableTitle = "";

         bool gotSeperator = false;

         bool gotTitle = false;

         // Scan the notes content line by line looking for table parameters and counting

         // the number of table rows (which is not specified as an explicit table parameter).

         int s_ElementsConsumedByTableParams = 0;

         foreach(string s in EA_DocGenTable)

         {

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

            {

               if (gotTitle == false && s.StartsWith("title"))

               {

                  s_ElementsConsumedByTableParams++;

                  tableTitle = EA_Utils.options.getOptionValue(s, tableTitle);

                  gotTitle = true;

                  if (tableTitle == "")

                  {

                     MessageBox.Show( "Table Element Serialisation Failed - Bad Title" );

                     break;

                  }

               }

               else if (columnCount == 0 && s.StartsWith("columns"))

               {

                  s_ElementsConsumedByTableParams++;

                  columnCount = EA_Utils.options.getOptionValue(s, columnCount);

                  if (columnCount == 0)

                  {

                     MessageBox.Show( "Table Element Serialisation Failed - bad column count" );

                     break;

                  }

               }

               else if (gotSeperator == false && s.StartsWith("seperator"))

               {

                  s_ElementsConsumedByTableParams++;

                  seperator = EA_Utils.options.getOptionValue(s, seperator);

                  gotSeperator = true;

               }

               else

               {

                  rowCount++;

               }

            }

         }

         if (gotTitle == true && gotSeperator == true && columnCount != 0)

         {

            if (rowCount < 2)

            {

               MessageBox.Show( "Table Element Serialisation Failed - Insufficient Rows" );

            }

            else

            {

               // create the table in the word doc

               int tableNum = TableUtils.Table_Create( tableTitle, rowCount, columnCount );

               Word.Table table = WordDocument.Tables[tableNum];

               object center = Word.WdParagraphAlignment.wdAlignParagraphCenter;

               // scan the element notes again to extract the cell content and add it to the

               // table we just created.

               int row = 1;

               int col = 1;

               foreach(string s in EA_DocGenTable)

               {

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

                  {

                     if (s_ElementsConsumedByTableParams > 0)

                     {

                        s_ElementsConsumedByTableParams--;

                     }

                     else

                     {

                        delimStr = seperator.ToString();

                        delim = delimStr.ToCharArray();

                        cells = s.Split(delim,columnCount);

                        if (cells.Length != columnCount)

                        {

                           MessageBox.Show( "Table Element Serialisation Failed - Bad Row" );

                           break;

                        }

                        else

                        {

                           // serialise table row

                           for(col=1; col<=columnCount; col++)

                           {

                              cells[col-1].TrimStart( trimChars );

                              cells[col-1].TrimEnd( trimChars );

                              table.Cell(row,col).Range.Text = cells[col-1];

                              // special handling for heading row

                              if (row == 1)

                              {

                                 table.Cell(row,col).Range.ParagraphFormat.Alignment = Word.WdParagraphAlignment.wdAlignParagraphCenter;

                                 table.Cell(row,col).Range.Font.Bold = 1;

                              }

                           }

                           row++;

                        }                     

                     }

                  }

               }

            }

         }

         else

         {

            MessageBox.Show( "Table Element Serialisation Failed - Table Parameters Incomplete" );

         }

      }

      /// <summary>

      /// This function processes a test link element

      /// </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 = EA_Utils.EA_Finder.findPackageInRepositoryByGUID(s);

                     if (theFoundPackage != null)

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

                     else 

                     {

                        // try to find the GUID as an element

                        EA.Element theFoundElement = EA_Utils.EA_Finder.findElementInRepositoryByGUID(s);

                        if (theFoundElement != null)

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

                     if (theFoundElement != null)

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

                     else 

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

                  }

               }

               else

               {

                  linkedName = s;

               }            

            }

         }         

      }

      /// <summary>

      /// This function process a text element. It is a simple wrapper for the 

      /// appendAndSelectText()function.

      /// </summary>

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

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

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

      {

         TextUtils.appendAndSelectText( theElement.Notes.ToString(), EA_Constants.styleName_Body1 );

      }

      /// <summary>

      /// This function will insert a relationship matrix table into the document, built from content

      /// specified in options that are provided in the notes section of the special element that

      /// has led to this function being called.

      /// </summary>

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

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

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

      {

         int tableNum = 0;

         Word.Table table = null;

         // process the options for the relationship matrix

         EA_RelationshipMatrix EA_RelMatrix = new EA_RelationshipMatrix(EA_Utils);

         if (!EA_RelMatrix.processRelationshipMatrixOptions( theElement ))

         {

            return;  // must have been an error

         }

         // Scan the fromPackage to find all the "from elements".

         ElementAccumulator fromLister = new ElementAccumulator(EA_RelMatrix.fromElementTypes, EA_Utils);

         EA_Utils.findAndProcessPackageElements( EA_RelMatrix.fromPackage, fromLister, EA_RelMatrix.fromPackageRecursion );

         // Sort the "from elements"

         elementSortByName sorter = new elementSortByName();

         fromLister.Elements.Sort( sorter );

         // dictionary to support from-to table construction.

         ArrayList fromToDictionary = new ArrayList();

         // dictionary to support to-from table construction.

         ArrayList toFromDictionary = new ArrayList();

         bool needFromToTable = false;

         if (EA_RelMatrix.fromToTableTitle != null && EA_RelMatrix.fromToTableTitle.Length > 0)

            needFromToTable = true;

         bool needToFromTable = false;

         if (EA_RelMatrix.toFromTableTitle != null && EA_RelMatrix.toFromTableTitle.Length > 0)

            needToFromTable = true;

         // NOTE: this code has to execute even if no from-to table is needed, in order to support the

         // generation of a to-from table, assuming the user has requested one.

         int numberOfFromToRows = 0;

         foreach(EA.Element fromElement in fromLister.Elements)

         {

            // look at the elements connection collection to find references to the

            // destination elements

            bool foundToElement = false;

            EA.Collection conCollection = fromElement.Connectors;

            foreach (EA.Connector thisCon in conCollection)

            {

               EA.Element destE = EA_Repository.GetElementByID( thisCon.SupplierID );

               if (destE == null)

                  continue;

               // ignore self-referential connections

               if (fromElement.ElementID == thisCon.SupplierID)

                  continue;

               // if the destination element is of a type that the user has requested to include...

               if (!EA_RelMatrix.toElementTypes.Contains( destE.Type ))

                  continue;

               // Capture the from-to relationship in a dictionary where the key is the

               // "from element", and the value is the "to element".

               DictionaryEntry newFromToEntry = new DictionaryEntry(fromElement, destE);

               fromToDictionary.Add( newFromToEntry );

               foundToElement = true;

               // Capture the from-to relationship in a dictionary where the key is the

               // ID of the destination element, and the value is the from element name.

               // This dictionary will enable rapid construction of the to-from table if

               // the user has requested it, from the exact same relationship info used

               // to construct the from-to table.

               if (needToFromTable)

               {

                  DictionaryEntry newToFromEntry = new DictionaryEntry(destE.ElementID, fromElement.Name);

                  toFromDictionary.Add( newToFromEntry );

               }

            }

            // If we found a from-to relationship that table needs a new row.

            if (foundToElement)

            {

               numberOfFromToRows++;

            }

               // If we did not find a from-to relationship that table still needs a new row 

               // if the user wants all "from elements", even if some have no "to elements".

            else if (EA_RelMatrix.fromPackageTrimming == false)

            {

               DictionaryEntry newFromToEntry = new DictionaryEntry(fromElement, null);

               fromToDictionary.Add( newFromToEntry );

               numberOfFromToRows++;

            }

         }

         if (needFromToTable)

         {

            // Now we can actually serialise the table

            if (EA_RelMatrix.fromIntroText != null && EA_RelMatrix.fromIntroText.Length > 0)

            {

               TextUtils.appendAndSelectText( EA_RelMatrix.fromIntroText, EA_Constants.styleName_Body1 );

            }

            // create the from-to table in the word doc

            tableNum = TableUtils.Table_Create( EA_RelMatrix.fromToTableTitle, numberOfFromToRows + 1, 2 );

            table = WordDocument.Tables[tableNum];

            TableUtils.Table_SetTableColumnTitle(table, EA_RelMatrix.fromColumnTitle, 1);

            TableUtils.Table_SetTableColumnTitle(table, EA_RelMatrix.toColumnTitle, 2);

            int row = 1;

            int lastFromElementId = -1;

            bool firstFromToCon = true;

            foreach (DictionaryEntry de in fromToDictionary)

            {

               if ( ((EA.Element)de.Key).ElementID != lastFromElementId )

               {

                  lastFromElementId = ((EA.Element)de.Key).ElementID;

                  row++;

                  table.Cell(row,1).Range.Text = ((EA.Element)de.Key).Name;

                  firstFromToCon = true;

               }

               if (((EA.Element)de.Value) != null)

               {

                  if (firstFromToCon)

                  {

                     firstFromToCon = false;

                     table.Cell(row,2).Range.Text = ((EA.Element)de.Value).Name;

                  }

                  else

                  {

                     table.Cell(row,2).Range.Text += ((EA.Element)de.Value).Name;

                  }

               }

               else

               {

                  table.Cell(row,2).Range.Text = "Un-allocated relationship!";

                  table.Cell(row,2).Range.Font.Color = Word.WdColor.wdColorRed;

               }

            }

         }

         // Does user want a to-from table ?

         if (needToFromTable)