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

 using System.Drawing;
 using System.Collections;
 using System.ComponentModel;
 using System.Windows.Forms;
 using Word;
+using Microsoft.Office.Core;
 namespace EA_DocGen
+{
       private object endLocation;
       private int[] DocSection = null;
       private int   iDocSection = 0;
+      // Some style names used in EA_DocGen - most are expected to exist in the input template/doc
+      // but the Requirement formatting styles are programmatcally generated if they are found to not
+      // exist. The reason for this is that as of writing this add-in, they do not exist in the ERG
+      // standard template.
+      private const string styleName_ReqAppBody  = "Requirements Approved Body";
+      private const string styleName_ReqAppHdr   = "Requirements Approved Heading";
+      private const string styleName_ReqPropBody = "Requirements Proposed Body";
+      private const string styleName_ReqPropHdr  = "Requirements Proposed Heading";
+      private const string styleName_ReqRejBody  = "Requirements Rejected Body";
+      private const string styleName_ReqRejHdr   = "Requirements Rejected Heading";
+      private const string styleName_ReqName     = "Requirements Name";
+      private const string styleName_Body1       = "Body 1";
+      private const string styleName_Heading1    = "Heading 1";
+      private const string styleName_Heading2    = "Heading 2";
+      private const string styleName_Heading3    = "Heading 3";
+      private const string styleName_Heading4    = "Heading 4";
+      private const string styleName_Heading5    = "Heading 5";
+      private const string styleName_Heading6    = "Heading 6";
+      private const string styleName_Heading7    = "Heading 7";
+      private const string styleName_Heading8    = "Heading 8";
+      private const string styleName_Heading9    = "Heading 9";
+      private const string styleName_NumPara1    = "NumPara 1";
+      private const string styleName_NumPara2    = "NumPara 2";
+      private const string styleName_NumPara3    = "NumPara 3";
+      private const string styleName_NumPara4    = "NumPara 4";
+      private const string styleName_NumPara5    = "NumPara 5";
+      private const string styleName_NumPara6    = "NumPara 6";
+      private const string styleName_NumPara7    = "NumPara 7";
+      private const string styleName_NumPara8    = "NumPara 8";
+      private const string styleName_NumPara9    = "NumPara 9";
+      private const string styleName_TableText   = "Table Text";
+      private const string styleName_RefListNum  = "Reference List Number";
+      private const string styleName_RefListText = "Reference List Text";
+      private const string styleName_Normal      = "Normal";
       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;
             // 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 = "Normal";
+            object l_style = 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
       /// <param name="wordText"></param>
       /// <param name="level"></param>
       private void appendAndSelectHeadingText(string wordText, int level)
+      {
          // Convert level to heading style
-         String styleText;
+         string styleText;
          switch(level)
+         {
-            case 1: styleText = "Heading 1"; break;
+            case 1: styleText = styleName_Heading1; break;
-            case 2: styleText = "Heading 2"; break;
+            case 2: styleText = styleName_Heading2; break;
-            case 3: styleText = "Heading 3"; break;
+            case 3: styleText = styleName_Heading3; break;
-            case 4: styleText = "Heading 4"; break;
+            case 4: styleText = styleName_Heading4; break;
-            case 5: styleText = "Heading 5"; break;
+            case 5: styleText = styleName_Heading5; break;
-            case 6: styleText = "Heading 6"; break;
+            case 6: styleText = styleName_Heading6; break;
-            case 7: styleText = "Heading 7"; break;
+            case 7: styleText = styleName_Heading7; break;
-            case 8: styleText = "Heading 8"; break;
+            case 8: styleText = styleName_Heading8; break;
-            case 9: styleText = "Heading 9"; break;
+            case 9: styleText = styleName_Heading9; break;
-            default: styleText = "Body 1"; break;
+            default: styleText = styleName_Heading9; break;
+         }
          // append the text as a heading
          appendAndSelectText(wordText, styleText);
+      }
       /// <param name="wordText"></param>
       /// <param name="level"></param>
       private void appendAndSelectNumParaText(string wordText, int level)
+      {
          // Convert level to heading style
-         String styleText;
+         string styleText;
          switch(level)
+         {
-            case 1: styleText = "NumPara 1"; break;
+            case 1: styleText = styleName_NumPara1; break;
-            case 2: styleText = "NumPara 2"; break;
+            case 2: styleText = styleName_NumPara2; break;
-            case 3: styleText = "NumPara 3"; break;
+            case 3: styleText = styleName_NumPara3; break;
-            case 4: styleText = "NumPara 4"; break;
+            case 4: styleText = styleName_NumPara4; break;
-            case 5: styleText = "NumPara 5"; break;
+            case 5: styleText = styleName_NumPara5; break;
-            case 6: styleText = "NumPara 6"; break;
+            case 6: styleText = styleName_NumPara6; break;
-            case 7: styleText = "NumPara 7"; break;
+            case 7: styleText = styleName_NumPara7; break;
-            case 8: styleText = "NumPara 8"; break;
+            case 8: styleText = styleName_NumPara8; break;
-            case 9: styleText = "NumPara 9"; break;
+            case 9: styleText = styleName_NumPara9; break;
-            default: styleText = "Body 1"; break;
+            default: styleText = styleName_NumPara9; break;
+         }
          // append the text as a heading
          appendAndSelectText(wordText, styleText);
+      }
          Table.Rows[1].Shading.BackgroundPatternColor = Word.WdColor.wdColorGray10;
          Table.Borders.OutsideLineStyle = Word.WdLineStyle.wdLineStyleSingle;
          Table.Borders.InsideLineStyle = Word.WdLineStyle.wdLineStyleSingle;
          Table.Select();
-         object tableTextStyle = "Table Text";
+         object tableTextStyle = styleName_TableText;
          Table.Range.set_Style( ref tableTextStyle );
          return WordDocument.Tables.Count;
+      }
       /// </summary>
       /// <param name="theElement"></param>
       /// <param name="recurse_level"></param>
       private void processTextElement(EA.Element theElement, int recurse_level )
+      {
-         appendAndSelectText( theElement.Notes.ToString(), "Body 1" );
+         appendAndSelectText( theElement.Notes.ToString(), styleName_Body1 );
+      }
+      {
          foreach(EA.Element theElement in thePackage.Elements)
+         {
             // Here we want to apply the special ERG template styles for each reference
             // item.
-            appendAndSelectText( theElement.Name.ToString(), "Reference List Number" );
+            appendAndSelectText( theElement.Name.ToString(), styleName_RefListNum );
-            appendAndSelectText( theElement.Notes.ToString(), "Reference List Text" );
+            appendAndSelectText( theElement.Notes.ToString(), styleName_RefListText );
+         }
+      }
       private void createTerminologySection(EA.Package thePackage)
          appendAndSelectHeadingText( thePackage.Name.ToString(), recurse_level );
          // Special handling for package called "Terminology"
          if (thePackage.Name == "Terminology")
+         {
-            appendAndSelectText( thePackage.Notes.ToString(), "Body 1" );
+            appendAndSelectText( thePackage.Notes.ToString(), styleName_Body1 );
             createTerminologySection(thePackage);
             return true;
+         }
          if (thePackage.Name == "References")
+         {
-            appendAndSelectText( thePackage.Notes.ToString(), "Body 1" );
+            appendAndSelectText( thePackage.Notes.ToString(), styleName_Body1 );
             createReferencesSection(thePackage);
             return true;
+         }
          // use the package notes as body text and indicate to caller that package elements
          // have not been consumed
-         appendAndSelectText( thePackage.Notes.ToString(), "Body 1" );
+         appendAndSelectText( thePackage.Notes.ToString(), styleName_Body1 );
          return false;
+      }
       private void generatePackageDiagrams( EA.Package thePackage )
                   && EA_Utils.options.opt_DisplayRequirementElementsAsSections == false )
+               {
                   string s;
                   s = EA_Utils.options.opt_RequirementElementDisplayFormat;
                   s = s.Replace(@"%s",@"{0}");
-                  appendAndSelectText( String.Format( s, theElement.Name ), "Body 1");
+                  appendAndSelectText( String.Format( s, theElement.Name ), styleName_Body1);
                   WordRange.Font.Bold = 1;
+               }
                else if ( EA_Utils.options.opt_ElementHeadingTransitionLevel > 0
                   && EA_Utils.options.opt_ElementHeadingTransitionLevel <= recurse_level )
                   appendAndSelectNumParaText( theElement.Name.ToString(), recurse_level );
                else
                   appendAndSelectHeadingText( theElement.Name.ToString(), recurse_level );
-               appendAndSelectText( theElement.Notes.ToString(), "Body 1" );
+               appendAndSelectText( theElement.Notes.ToString(), styleName_Body1 );
+            }
+         }
          else
+         {
             displayProgress( "FILTERED: ", theElement.Type );
       /// </summary>
       private void removeExistingDocumentContent()
+      {
          //WordApp.Visible = true;  // enable this when debugging this horrible function
          Word.Selection aSelection;
-         object findStyle = getStyle("Heading 1");
+         object findStyle = getStyle( styleName_Heading1 );
          WordApp.Selection.WholeStory();
          aSelection = WordApp.Selection;
          aSelection.Find.ClearFormatting();
             // generated content. Extend the range to the end of the document and cut out the
             // old content.
             Word.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 = styleName_Body1;
+            range.set_Style(ref style);
+         }
+      }
       /// <summary>
       /// an input template, sets various characteristics of the document, schedules the
       /// EA parsing function, before finally saving the document to the output file name.
       /// </summary>
       private void createTheWordDoc()
+      {
+         // caputre initial security settings
+         MsoAutomationSecurity  securityBefore = WordApp.AutomationSecurity;
          try
+         {
             object template       = this.textBox_template.Text;
             object newTemplate    = Type.Missing;
             object outputFilename = this.textBox_output_file.Text;
             EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "", 0);
             EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME,
                                        String.Format( "Generating Document {0}", this.textBox_output_file.Text), 0 );
-            // tell word not to show itself
+            // tell word not to show itself unless user has checked the option to say otherwise
             WordApp.Visible = this.checkBox_WordVisibility.Checked;
+            // disable VB macros from running in the document
+            WordApp.AutomationSecurity = MsoAutomationSecurity.msoAutomationSecurityForceDisable;
+            WordApp.DisplayAlerts = Word.WdAlertLevel.wdAlertsNone;
             // Create a document from the input template
             WordDocument = WordApp.Documents.Add(ref template, ref newTemplate, ref docType, ref visible);
             // Remove all old content from the input document/template. Note that this assumes
             // that content will begin at section 1 with the title "Introduction" and it will have
             // turn off grammar and spell checking
             WordDocument.GrammarChecked = false;
             WordDocument.SpellingChecked = false;
+            // If the input template does not contain the styles needed for requirement documents,
+            // programmatically create them just in case.
+            createRequirementStylesIfNecessary();
             // Parse EA_DocGen Document Model. The parent package is the document model itself
             // and the packages within it are the top level packages only.
             // Question: do we have to parse diagrams and elements at this top level? So far,
             // this has been found to be unecessary, but you never know. For now, dont do it.
             foreach(EA.Package thePackage in EA_ParentPackage.Packages)
+            {
                parse_package(thePackage, 0);
+            }
-            // TODO
-            // Can we run a word macro from this addin? If so, we should open the doc properties
-            // dialog to let user enter/update the properties.
-            // We could emulate the UpdateAllDocumentFields subroutine written in VB within the
-            // ERG standard template. For now though, do some basic stuff only.
             // Select the entire document, and Update all fields, including Table of Contents
             // and then collapse the selection in case user wants to view the document, because
             // they wont want to see the inverse video of the selection.
             WordApp.Selection.WholeStory();
+         }
          catch (Exception createTheWordDoc_exception)
+         {
             MessageBox.Show("Document Generation Failed\n\n" + createTheWordDoc_exception.Message);
+         }
+         // restore security settings
+         WordApp.AutomationSecurity = securityBefore;
+      }
+      /// <summary>
+      /// Creates a wdStyleTypeParagraph based style
+      /// </summary>
+      /// <param name="newStyleName"></param>
+      /// <param name="followingStyleName"></param>
+      /// <param name="baseStyle"></param>
+      /// <returns></returns>
+      private Word.Style createParagrapghStyle(string newStyleName,
+                                               string followingStyleName,
+                                               Word.Style baseStyle)
+      {
+         Word.Style s = getStyle(newStyleName);
+         if (s == null)
+         {
+            object o_styleType = Word.WdStyleType.wdStyleTypeParagraph;
+            s = WordDocument.Styles.Add(newStyleName, ref o_styleType);
+            object o_baseStyle = baseStyle.NameLocal;
+            object o_followingStyle = followingStyleName;
+            s.set_BaseStyle(ref o_baseStyle);
+            s.set_NextParagraphStyle(ref o_followingStyle);
+            s.Font = baseStyle.Font;
+            s.ParagraphFormat = baseStyle.ParagraphFormat;
+            s.LanguageID = Word.WdLanguageID.wdEnglishAUS;
+            s.NoProofing = 0;
+            s.Frame.Delete();
+            s.NoSpaceBetweenParagraphsOfSameStyle = false;
+         }
+         return s;
+      }
+      /// <summary>
+      /// Creates a wdStyleTypeCharacter based style
+      /// </summary>
+      /// <param name="newStyleName"></param>
+      /// <param name="baseStyle"></param>
+      /// <returns></returns>
+      private Word.Style createCharacterStyle(string newStyleName, Word.Style baseStyle)
+      {
+         Word.Style s = getStyle(newStyleName);
+         if (s == null)
+         {
+            object o_styleType = Word.WdStyleType.wdStyleTypeCharacter;
+            s = WordDocument.Styles.Add(newStyleName, ref o_styleType);
+            object o_baseStyle = baseStyle.NameLocal;
+            s.set_BaseStyle(ref o_baseStyle);
+            s.Font = baseStyle.Font;
+            s.LanguageID = Word.WdLanguageID.wdEnglishAUS;
+            s.NoProofing = 0;
+         }
+         return s;
+      }
+      /// <summary>
+      /// Creates the styles needed for generating requirement documentation, if they do not
+      /// already exist.
+      /// </summary>
+      private void createRequirementStylesIfNecessary()
+      {
+         Word.Style s_Body1 = getStyle(styleName_Body1);
+         if (s_Body1 != null)
+         {
+            // APPROVED ///////////////////////////////////////////////////////////////////////////////////////////////
+            Word.Style s_ReqAppBody = createParagrapghStyle(styleName_ReqAppBody, styleName_ReqAppBody, s_Body1);
+            if (s_ReqAppBody != null)
+            {
+               // No changes needed - this is just a copy of Body 1
+            }
+            Word.Style s_ReqAppHdr = null;
+            if (s_ReqAppBody != null)
+            {
+               s_ReqAppHdr = createParagrapghStyle(styleName_ReqAppHdr, styleName_ReqAppBody, s_Body1);
+               if (s_ReqAppHdr != null)
+               {
+                  // Indent:Hanging: 2.5cm, Space After: 3pt, Keep with next, Tabs: 16.5cm, Right
+                  s_ReqAppHdr.ParagraphFormat.FirstLineIndent = WordApp.CentimetersToPoints((float)-2.5);
+                  s_ReqAppHdr.ParagraphFormat.SpaceAfter = 3;
+                  s_ReqAppHdr.ParagraphFormat.KeepWithNext = (int)MsoTriState.msoTrue;
+                  s_ReqAppHdr.ParagraphFormat.TabStops.ClearAll();
+                  object alignment = Word.WdTabAlignment.wdAlignTabRight;
+                  object leader = Word.WdTabLeader.wdTabLeaderSpaces;
+                  s_ReqAppHdr.ParagraphFormat.TabStops.Add( WordApp.CentimetersToPoints((float)16.5), ref alignment, ref leader );
+               }
+            }
+            // PROPOSED ///////////////////////////////////////////////////////////////////////////////////////////////
+            Word.Style s_ReqPropBody = null;
+            if (s_ReqAppBody != null)
+            {
+               s_ReqPropBody = createParagrapghStyle(styleName_ReqPropBody, styleName_ReqPropBody, s_ReqAppBody );
+               if (s_ReqPropBody != null)
+               {
+                  // Font: Italic
+                  s_ReqPropBody.Font.Italic = (int)MsoTriState.msoTrue;
+               }
+            }
+            if (s_ReqAppHdr != null && s_ReqPropBody != null)
+            {
+               Word.Style s_ReqPropHdr = createParagrapghStyle(styleName_ReqPropHdr, styleName_ReqPropBody, s_ReqAppHdr );
+               if (s_ReqPropHdr != null)
+               {
+                  // Font: Italic
+                  s_ReqPropHdr.Font.Italic = (int)MsoTriState.msoTrue;
+               }
+            }
+            // REJECTED ///////////////////////////////////////////////////////////////////////////////////////////////
+            Word.Style s_ReqRejBody = null;
+            if (s_ReqAppBody != null)
+            {
+               s_ReqRejBody = createParagrapghStyle(styleName_ReqRejBody, styleName_ReqRejBody, s_ReqAppBody );
+               if (s_ReqRejBody != null)
+               {
+                  // Font: Italic
+                  s_ReqRejBody.Font.StrikeThrough = (int)MsoTriState.msoTrue;
+               }
+            }
+            if (s_ReqAppHdr != null && s_ReqRejBody != null)
+            {
+               Word.Style s_ReqRejHdr = createParagrapghStyle(styleName_ReqRejHdr, styleName_ReqRejBody, s_ReqAppHdr );
+               if (s_ReqRejHdr != null)
+               {
+                  // Font: Italic
+                  s_ReqRejHdr.Font.StrikeThrough = (int)MsoTriState.msoTrue;
+               }
+            }
+            // REQUIREMENT NAME ///////////////////////////////////////////////////////////////////////////////////////////////
+            Word.Style s_DefParaFont = getStyle("Default Paragraph Font");
+            if (s_DefParaFont != null)
+            {
+               Word.Style s_ReqName = createCharacterStyle(styleName_ReqName, s_DefParaFont );
+               if (s_ReqName != null)
+               {
+                  s_ReqName.Font.Bold = (int)MsoTriState.msoTrue;
+               }
+            }
+         }
+      }
       /// <summary>
       /// Generates the text for requirements.  This uses custom styles to format the text
       /// rather than formatting it in code.
          string reqShortDesc = "";
          string reqNotes = "";
          string reqStatusText = "";
          string reqHeadingStyle ="";
          string reqParaStyle = "";
-         object reqNameStyle = "Requirements Name";
+         object reqNameStyle = styleName_ReqName;
          Word.Range shortDescRange;
          // Set the style depending on the status
          switch ( theElement.Status )
+         {
             case "Proposed":
                reqStatusText = "(Proposed)";
-               reqHeadingStyle = "Requirements Proposed Heading";
+               reqHeadingStyle = styleName_ReqPropHdr;
-               reqParaStyle = "Requirements Proposed Body";
+               reqParaStyle    = styleName_ReqPropBody;
                break;
             case "Rejected":
-               reqHeadingStyle = "Requirements Rejected Heading";
+               reqHeadingStyle = styleName_ReqRejHdr;
-               reqParaStyle = "Requirements Rejected Body";
+               reqParaStyle    = styleName_ReqRejBody;
                break;
             case "Approved":
                reqStatusText = "(Phase " + theElement.Phase + ")";
-               reqHeadingStyle = "Requirements Approved Heading";
+               reqHeadingStyle = styleName_ReqAppHdr;
-               reqParaStyle = "Requirements Approved Body";
+               reqParaStyle    = styleName_ReqAppBody;
                break;
             default:
                reqStatusText = "(" + theElement.Status + ")(Phase " + theElement.Phase + ")";
-               reqHeadingStyle = "Requirements Approved Heading";
+               reqHeadingStyle = styleName_ReqAppHdr;
-               reqParaStyle = "Requirements Approved Body";
+               reqParaStyle    = styleName_ReqAppBody;
                break;
+         }
          // Pull out the ID from the name
          int pos = theElement.Name.IndexOf( " ", 0, theElement.Name.Length );
          appendAndSelectText( reqNotes, reqParaStyle );
+      }
+      /// <summary>
+      /// Class to sort EA elements alphabetically, in a case insensitive way.
+      /// This is used by the processRelationshipMatrixElement method.
+      /// </summary>
       public class elementSortByName : IComparer
+      {
          int IComparer.Compare( object x, object y)
+         {
             if (x!=null & y!= null)
          if (needFromToTable)
+         {
             if (EA_RelMatrix.fromIntroText != null && EA_RelMatrix.fromIntroText.Length > 0)
+            {
-               appendAndSelectText( EA_RelMatrix.fromIntroText, "Body 1" );
+               appendAndSelectText( EA_RelMatrix.fromIntroText, styleName_Body1 );
+            }
             // create the from-to table in the word doc
             tableNum = createTable( EA_RelMatrix.fromToTableTitle, fromLister.Elements.Count + 1, 2 );
             table = WordDocument.Tables[tableNum];
             // Sort the "to" elements
             toLister.Elements.Sort( sorter );
             if (EA_RelMatrix.toIntroText != null && EA_RelMatrix.toIntroText.Length > 0)
+            {
-               appendAndSelectText( EA_RelMatrix.toIntroText, "Body 1" );
+               appendAndSelectText( EA_RelMatrix.toIntroText, styleName_Body1 );
+            }
             // create the table in the word doc
             tableNum = createTable( EA_RelMatrix.toFromTableTitle, toLister.Elements.Count + 1, 2 );
             table = WordDocument.Tables[tableNum];

Subversion Repositories DevTools

(root)/EA_DocGen/trunk/EA_DocGen/createWordDoc.cs – Rev 2090 → 2092