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

 using System.Drawing;
 using System.Collections;
 using System.Text;
 using System.ComponentModel;
 using System.Windows.Forms;
-using Word;
+using Microsoft.Office.Interop.Word;
 using Microsoft.Office.Core;
 using System.Threading;
 namespace EA_DocGen
+{
       // 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;
+      private Table utTraceabilityTable = null;
       // MS-Office Word related data
-      public static Word.Application WordApp = null;
+      public static Microsoft.Office.Interop.Word.Application WordApp = null;
-      public static Word.Document WordDocument = null;
+      public static 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;
          TabularContent.initialise();
          TextualContent.initialise();
          StyleContent.initialise();
          TextParser.initialise();
-         WordApp = new Word.Application();
+         WordApp = new Microsoft.Office.Interop.Word.Application();
+      }
       /// <summary>
       /// Clean up any resources being used.
       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)
+             if (this.textBox_output_file.Text.Length > 0)
-            {
+             {
+                 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;
-               creationThread = new Thread(new ThreadStart(createTheWordDoc));
+                 creationThread = new Thread(new ThreadStart(createTheWordDoc));
-               creationThread.ApartmentState = ApartmentState.STA;
+                 creationThread.SetApartmentState(ApartmentState.STA);
-               creationThread.Priority = ThreadPriority.Highest;
+                 creationThread.Priority = ThreadPriority.Highest;
-               creationThread.Start();
+                 creationThread.Start();
-            }
+             }
-            else
+             else
-            {
+             {
-               MessageBox.Show("Error - must specify an output file");
+                 MessageBox.Show("Error - must specify an output file");
-            }
+             }
+         }
          else
+         {
             MessageBox.Show("Error - must specify an input template file");
+         }
             try
+            {
                object nothing = Type.Missing;
                object notTrue = false;
-               WordApp.Application.Quit( ref notTrue, ref nothing, ref nothing);
+               ((Microsoft.Office.Interop.Word._Application)WordApp.Application).Quit(ref notTrue, ref nothing, ref nothing);
+            }
             catch (Exception createWordDoc_Closing_exception)
+            {
                // dummy statement
                String s = createWordDoc_Closing_exception.Message;
             // 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);
+            Range WordRange = WordDocument.Range(ref startLocation, ref endLocation);
-            object direction = Word.WdCollapseDirection.wdCollapseEnd;
+            object direction = 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();
             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 unit = 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;
+            WordApp.Selection.ParagraphFormat.Alignment = 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 Position = WdCaptionPosition.wdCaptionPositionAbove;
             object ExcludeLabel = 0;
             WordApp.Selection.InsertCaption( ref Label, ref Title, ref TitleAutoText, ref Position, ref ExcludeLabel);
             WordApp.Selection.TypeText( ": " + theDiagram.Name);
-            WordApp.Selection.ParagraphFormat.Alignment = Word.WdParagraphAlignment.wdAlignParagraphCenter;
+            WordApp.Selection.ParagraphFormat.Alignment = 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;
                      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;
+                     utTraceabilityTable.Cell(row,2).Range.Font.Color = WdColor.wdColorRed;
+                  }
+               }
                numClassesRemaining--;
                if (numClassesRemaining > 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];
+               Table table = WordDocument.Tables[tableNum];
-               object center = Word.WdParagraphAlignment.wdAlignParagraphCenter;
+               object center = WdParagraphAlignment.wdAlignParagraphCenter;
                TabularContent.Table_SetTableColumnTitle(table, "Term", 1);
                TabularContent.Table_SetTableColumnTitle(table, "Definition", 2);
-               table.Columns[1].SetWidth(100, Word.WdRulerStyle.wdAdjustSameWidth );
+               table.Columns[1].SetWidth(100, WdRulerStyle.wdAdjustSameWidth );
                int row = 2;
                // inject the glossary into the table
                foreach(EA.Term theTerm in glossary)
+               {
                   if (abortCreationThread)
             if (infoItems.Count > 0)
+            {
                // Create a table
                int tableNum = TabularContent.Table_Create("Terminology", true, infoItems.Count+1, 2);
-               Word.Table table = WordDocument.Tables[tableNum];
+               Table table = WordDocument.Tables[tableNum];
-               object center = Word.WdParagraphAlignment.wdAlignParagraphCenter;
+               object center = WdParagraphAlignment.wdAlignParagraphCenter;
                TabularContent.Table_SetTableColumnTitle(table, "Term", 1);
                TabularContent.Table_SetTableColumnTitle(table, "Definition", 2);
-               table.Columns[1].SetWidth(100, Word.WdRulerStyle.wdAdjustSameWidth );
+               table.Columns[1].SetWidth(100, WdRulerStyle.wdAdjustSameWidth );
                int row = 2;
                elementSortByName sorter = new elementSortByName();
                infoItems.Sort(sorter);
             if (EA_DocGenOptions.optionValue(EA_DocGenOptions.boolean_options_e.SUPPRESS_PRIVATE_METHODS) == false
                || !theMethod.Visibility.StartsWith("Private"))
                numMethodsRemaining++;
+         }
-         Word.Range wr;
+         Range wr;
          StringBuilder sb;
          if (numMethodsRemaining > 0)
+         {
             // Print the "<Class Name> Operations" headings
                if (EA_DocGenOptions.optionValue(EA_DocGenOptions.boolean_options_e.SUPPRESS_PRIVATE_METHODS) == false
                   || !theMethod.Visibility.StartsWith("Private"))
+               {
                   // Print the Method name as a sub heading, and its description
                   TextualContent.appendAndSelectHeadingText(theMethod.Name , recurse_level + 1);
+                  if (theMethod.Notes != null && theMethod.Notes.Length > 0)
+                  {
-                  TextualContent.appendDescription(TextualContent.trimTrailingReturns(theMethod.Notes));
+                     TextParser.parse( TextualContent.trimTrailingReturns(theMethod.Notes), theMethod.MethodID, EA_Constants.styleName_Body1, 0, false);
+                  }
                   // 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)
                         if (abortCreationThread)
                            return;
                         // each parameter is   "[in|out|inout] type name [= default-value]"
                         // where the default value is optional
+                        if (!(EA_DocGenOptions.optionValue(EA_DocGenOptions.boolean_options_e.SUPPRESS_PARAMETER_KIND)))
+                        {
-                        sb.Append( "[" );
+                            sb.Append("[");
-                        sb.Append( theParam.Kind );
+                            sb.Append(theParam.Kind);
-                        sb.Append( "] " );
+                            sb.Append("] ");
+                        }
                         sb.Append( theParam.Type );
                         sb.Append( " " );
                         sb.Append( theParam.Name );
                         if (theParam.Default.Length > 0)
+                        {
                   // <type> <name>
                   sb.Append("\n");
                   sb.Append(theAttr.Type);
                   sb.Append(" ");
                   sb.Append(theAttr.Name);
-                  Word.Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1);
+                  Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1);
                   if (wr.Characters.Last.Text.Equals("\r"))
                      wr.End = wr.End - 1;   // Dont boldise the \r paragraph marker
                   wr.Font.Bold = 1;
                   wr = TextualContent.appendDescription(TextualContent.trimTrailingReturns(theAttr.Notes));
       private void generateClassCharacteristics( EA.Element theElement, int recurse_level )
+      {
          StringBuilder sb = null;
-         Word.Range wr = null;
+         Range wr = null;
          // CHARACTERISTICS
          if (EA_DocGenOptions.optionValue(EA_DocGenOptions.boolean_options_e.SUPPRESS_CLASS_CHARACTERISTICS) == false)
+         {
             sb = new StringBuilder();
          if (EA_DocGenOptions.optionValue(EA_DocGenOptions.boolean_options_e.SUPPRESS_CLASS_REQUIREMENTS) == false)
+         {
             StringBuilder sb = new StringBuilder();
             sb.Append( "Requirements:" );
-            Word.Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+            Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
             foreach(EA.Requirement theReq in theElement.Requirements)
+            {
                if (abortCreationThread)
                   return;
          if (EA_DocGenOptions.optionValue(EA_DocGenOptions.boolean_options_e.SUPPRESS_CLASS_CONSTRAINTS) == false)
+         {
             StringBuilder sb = new StringBuilder();
             sb.Append( "Constraints:" );
-            Word.Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
+            Range wr = TextualContent.appendAndSelectText(sb.ToString(), EA_Constants.styleName_Body1_Left_2_5cm_Italic);
             foreach(EA.Constraint theCons in theElement.Constraints)
+            {
                if (abortCreationThread)
                   return;
       /// prior to adding in the new content from the latest EA model data.
       /// </summary>
       private void removeExistingDocumentContent()
+      {
          //WordApp.Visible = true;  // enable this when debugging this horrible function
-         Word.Selection aSelection;
+         Selection aSelection;
          object findStyle = StyleContent.getStyle( EA_Constants.styleName_Heading1 );
          WordApp.Selection.WholeStory();
          aSelection = WordApp.Selection;
+         {
             // found Introduction with Heading 1 style so we are now at the point in the
             // document where everything here on must be deleted in readiness for the newly
             // generated content. Extend the range to the end of the document and cut out the
             // old content.
-            Word.Range range = aSelection.Range;
+            Range range = aSelection.Range;
             range.End = WordDocument.Content.End;
             range.Cut();
             // try and ensure that no heading style is left in place following the removal
             object style = EA_Constants.styleName_Body1;
             range.set_Style(ref style);
          Main.threadCreateDocProcessRunning = true;
          // 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;
             // control word visibility based on checkbox user can modify
             WordApp.Visible = this.checkBox_WordVisibility.Checked;
             // disable VB macros from running in the document
             WordApp.AutomationSecurity = MsoAutomationSecurity.msoAutomationSecurityForceDisable;
-            WordApp.DisplayAlerts = Word.WdAlertLevel.wdAlertsNone;
+            WordApp.DisplayAlerts = 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);
                   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 noSave = WdSaveOptions.wdDoNotSaveChanges;
-               object format = Word.WdOriginalFormat.wdWordDocument;
+               object format = WdOriginalFormat.wdWordDocument;
-               WordDocument.Close(ref noSave, ref format, ref nothing);
+               ((_Document)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
                      ref nothing, ref nothing, ref nothing);
                   // Tell user the process completed ok
                   Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Document Generation Complete", -1);
                   docGenCompletedNormally = true;
-                  button_view_output.Enabled = true;
+                  ThreadComplete(EThreadCompleteStatus.tcsComplete);
+               }
+            }
             else
+            {
                Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Document Generation Aborted", -1);
          // 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)
+           ThreadComplete(EThreadCompleteStatus.tcsClose);
+      }
+      public enum EThreadCompleteStatus
+      {
+          tcsComplete,
-            this.Close();
+          tcsClose
+      }
+      public delegate void ThreadCompleteDelegate(EThreadCompleteStatus Status);
+      private void ThreadComplete(EThreadCompleteStatus Status)
+      {
+          // Ensure form access is thread safe
+          if (this.InvokeRequired)
+          {
+              this.Invoke(new ThreadCompleteDelegate(ThreadComplete), new object[] { Status });
+          }
+          else
+          {
+              if (Status == EThreadCompleteStatus.tcsComplete)
+              {
+                  button_view_output.Enabled = true;
+              }
+              else if (Status == EThreadCompleteStatus.tcsClose)
+              {
+                  this.Close();
+              }
+          }
+      }
       #endregion

Subversion Repositories DevTools

(root)/EA_DocGen/trunk/EA_DocGen/createWordDoc.cs – Rev 2132 → 2136