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

+      {
          // NOTE: diagrams only use one stereotype, not a list of them, so dont use StereotypeEx field
          if (  EA_DocGenOptions.optionValue(EA_DocGenOptions.boolean_options_e.CONSIDER_API_DIAGRAMS_ONLY)
             && !theDiagram.Stereotype.Equals("API") )
+         {
-            displayProgress( "SKIPPED DIAGRAM: ", theDiagram.Name.ToString() );
+            displayProgress( "SKIPPED DIAGRAM: ", theDiagram.Name );
+         }
          else if (theDiagram.StyleEx != null && theDiagram.StyleEx.IndexOf("ExcludeRTF=1") >= 0)
+         {
-            displayProgress( "EXCLUDED DIAGRAM: ", theDiagram.Name.ToString() );
+            displayProgress( "EXCLUDED DIAGRAM: ", theDiagram.Name );
+         }
             // 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;
+            if (theDiagram.Notes != null && theDiagram.Notes.Length > 0)
+            {
-            //@@@@
+               //@@@@
-            //TextualContent.appendDescription( TextualContent.trimTrailingReturns(theDiagram.Notes) );
+               //TextualContent.appendDescription( TextualContent.trimTrailingReturns(theDiagram.Notes) );
-            TextParser.parse( TextualContent.trimTrailingReturns(theDiagram.Notes), theDiagram.DiagramID, EA_Constants.styleName_Body1, 0, false);
+               TextParser.parse( TextualContent.trimTrailingReturns(theDiagram.Notes), theDiagram.DiagramID, EA_Constants.styleName_Body1, 0, false);
+            }
             // create a range at the end of the document
             startLocation = WordDocument.Content.End;
             WordDocument.Content.InsertParagraphAfter();
             endLocation = WordDocument.Content.End;
             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.TypeText( ": " + theDiagram.Name);
             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;
             //WordDocument.Bookmarks.Add( bookmarkName, ref lastParaRange );
             // Close the diagram in EA
             Main.EA_Repository.CloseDiagram(theDiagram.DiagramID);
-            displayProgress( "DIAGRAM: ", theDiagram.Name.ToString() );
+            displayProgress( "DIAGRAM: ", theDiagram.Name );
+         }
+      }
       #region special element processing functions (link elements, table and text elements, etc)
       /// </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);
+         if (theElement.Notes != null && theElement.Notes.Length > 0)
-         string linkedName = "";
-         foreach(string s in EA_DocGenPkgLnk)
+         {
-            if (s.Length > 0 && s != "\n" && s != "\r")
+            string [] EA_DocGenPkgLnk = null;
+            string delimStr = "\r\n";
+            char [] delim = delimStr.ToCharArray();
+            EA_DocGenPkgLnk = theElement.Notes.Split(delim,100);
+            string linkedName = "";
+            foreach(string s in EA_DocGenPkgLnk)
+            {
-               if (s == "skiproot")
+               if (s.Length > 0 && s != "\n" && s != "\r")
+               {
-                  oneShot_skipRootPackage = true;
-               }
-               else if (s[0] == '{')
+                  if (s == "skiproot")
-               {
-                  EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);
-                  if (theFoundPackage != null)
+                  {
-                     parse_package(theFoundPackage, recurse_level);
+                     oneShot_skipRootPackage = true;
+                  }
-                  else
+                  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 );
+                        MessageBox.Show("WARNING - Could not find linked package : " + linkedName );
+                     }
+                  }
+                  else
+                  {
+                     linkedName = s;
+                  }
+               }
-               else
-               {
-                  linkedName = s;
-               }
+            }
+         }
+      }
       /// 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);
+         if (theElement.Notes != null && theElement.Notes.Length > 0)
-         string linkedName = "";
-         foreach(string s in EA_DocGenDiagLnk)
+         {
+            string [] EA_DocGenDiagLnk = null;
+            string delimStr = "\r\n";
+            char [] delim = delimStr.ToCharArray();
+            EA_DocGenDiagLnk = theElement.Notes.Split(delim,100);
+            string linkedName = "";
-            if (s.Length > 0 && s != "\n" && s != "\r" )
+            foreach(string s in EA_DocGenDiagLnk)
+            {
-               if (s[0] == '{')
+               if (s.Length > 0 && s != "\n" && s != "\r" )
+               {
-                  EA.Diagram theFoundDiagram = (EA.Diagram)Main.EA_Repository.GetDiagramByGuid(s);
-                  if (theFoundDiagram != null)
+                  if (s[0] == '{')
+                  {
+                     EA.Diagram theFoundDiagram = (EA.Diagram)Main.EA_Repository.GetDiagramByGuid(s);
+                     if (theFoundDiagram != null)
+                     {
-                     appendAndSelectDiagramViaClipboard( theFoundDiagram );
+                        appendAndSelectDiagramViaClipboard( theFoundDiagram );
+                     }
+                     else
+                     {
+                        MessageBox.Show("WARNING - Could not find linked diagram : " + linkedName );
+                     }
+                  }
                   else
+                  {
-                     MessageBox.Show("WARNING - Could not find linked diagram : " + linkedName );
+                     linkedName = s;
                   }
+               }
-               else
-               {
+            }
-                  linkedName = s;
-               }
-            }
+         }
-         }
+      }
       /// <summary>
       /// This function process an element link element, parsing each linked element by the
       /// </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);
+         if (theElement.Notes != null && theElement.Notes.Length > 0)
-         string linkedName = "";
-         foreach(string s in EA_DocGenEleLnk)
+         {
-            if (s.Length > 0 && s != "\n" && s != "\r")
+            string [] EA_DocGenEleLnk = null;
+            string delimStr = "\r\n";
+            char [] delim = delimStr.ToCharArray();
+            EA_DocGenEleLnk = theElement.Notes.Split(delim,100);
+            string linkedName = "";
+            foreach(string s in EA_DocGenEleLnk)
+            {
-               if (s == "skiproot")
+               if (s.Length > 0 && s != "\n" && s != "\r")
-               {
-                  oneShot_skipRootElementHeading = true;
-               }
-               else if ( s[0] == '{')
+               {
-                  EA.Element theFoundElement = Main.EA_Repository.GetElementByGuid(s);
-                  if (theFoundElement != null)
+                  if (s == "skiproot")
+                  {
-                     parse_element( theFoundElement, recurse_level );
+                     oneShot_skipRootElementHeading = true;
+                  }
-                  else
+                  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 );
+                        MessageBox.Show("WARNING - Could not find linked element : " + linkedName );
+                     }
+                  }
+                  else
+                  {
+                     linkedName = s;
+                  }
+               }
-               else
-               {
-                  linkedName = s;
-               }
+            }
          }
+      }
       /// <summary>
       /// This method is recursive and searches a model structure to find a match to any
+         }
+      }
       private void processNameLink(EA.Element theElement, int recurse_level )
+      {
+         if (theElement.Notes != null && theElement.Notes.Length > 0)
+         {
-         string delimStr = "\r\n";
+            string delimStr = "\r\n";
-         char [] delim = delimStr.ToCharArray();
+            char [] delim = delimStr.ToCharArray();
-         string [] EA_DocGenNameLnk = theElement.Notes.ToString().Split(delim,100);
+            string [] EA_DocGenNameLnk = theElement.Notes.Split(delim,100);
-         string linkedName = "";
+            string linkedName = "";
-         bool gotLinkedName = false;
+            bool gotLinkedName = false;
-         ArrayList names = new ArrayList();
+            ArrayList names = new ArrayList();
-         EA.Package theFoundPackage = null;
+            EA.Package theFoundPackage = null;
-         bool skipRoots = false;
+            bool skipRoots = false;
-         // search through the option strings
+            // search through the option strings
-         foreach(string s in EA_DocGenNameLnk)
+            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?
+               if (s.Length > 0 && s != "\n" && s != "\r")
-               {
-                  // find the package by its GUID
-                  theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);
-               }
-               else if (s.StartsWith("package="))
+               {
+                  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
+                     // add the users named package to our list of names
-                  names.Add( s.Substring(8, s.Length - 8) );
+                     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;
+                  }
+               }
-               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 the GUID was resolved...
-         if (theFoundPackage != null)
+            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");
+               processNameLinkPackage(null, theFoundPackage, recurse_level, skipRoots, ref names);
-               foreach(String s in 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("\n");
-                  sb.Append(s);
+                     sb.Append(s);
+                  }
+                  MessageBox.Show(sb.ToString());
+               }
-               MessageBox.Show(sb.ToString());
+            }
-         }
-         else
+            else
-         {
+            {
-            MessageBox.Show("WARNING - Could not find linked package : " + linkedName );
+               MessageBox.Show("WARNING - Could not find linked package : " + linkedName );
+            }
+         }
+      }
       /// <summary>
       /// </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);
+         if (theElement.Notes != null && theElement.Notes.Length > 0)
-         string linkedName = "";
-         foreach(string s in EA_DocGenEleLnk)
+         {
-            if (s.Length > 0 && s != "\n" && s != "\r")
+            string [] EA_DocGenEleLnk = null;
+            string delimStr = "\r\n";
+            char [] delim = delimStr.ToCharArray();
+            EA_DocGenEleLnk = theElement.Notes.Split(delim,100);
+            string linkedName = "";
+            foreach(string s in EA_DocGenEleLnk)
+            {
-               if ( s[0] == '{')
+               if (s.Length > 0 && s != "\n" && s != "\r")
+               {
-                  try
+                  if ( s[0] == '{')
+                  {
+                     try
+                     {
-                     // try to find the GUID as a package
+                        // try to find the GUID as a package
-                     EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);
+                        EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(s);
-                     if (theFoundPackage != null)
+                        if (theFoundPackage != null)
-                        TextualContent.appendUnitTestSuite(theFoundPackage, recurse_level, ref classesWithUnitTests);
+                           TextualContent.appendUnitTestSuite(theFoundPackage, recurse_level, ref classesWithUnitTests);
-                     else
+                        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 );
+                     }
+                  }
-                  catch
+                  else
+                  {
-                     // try to find the GUID as an element
-                     EA.Element theFoundElement = Main.EA_Repository.GetElementByGuid(s);
-                     if (theFoundElement != null)
+                     linkedName = s;
-                        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 )
+      {
          bool processLowerLevelContent = true;  // return value for this function
          // The package name is a heading, and the package notes are paragraphs
          // directly under that heading
-         TextualContent.appendAndSelectHeadingText( thePackage.Name.ToString(), recurse_level );
+         TextualContent.appendAndSelectHeadingText( thePackage.Name, recurse_level );
-         displayProgress( "PACKAGE: ", thePackage.Name.ToString() );
+         displayProgress( "PACKAGE: ", thePackage.Name );
          // Special handling for package called "Terminology"
          if (thePackage.Name == "Terminology")
+         {
             TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(thePackage.Notes), EA_Constants.styleName_Body1 );
             createReferencesSection(thePackage);
             processLowerLevelContent = false;
+         }
          else
+         {
+            if (thePackage.Notes != null && thePackage.Notes.Length > 0)
+            {
-            // use the package notes as body text and indicate to caller that package elements
+               // use the package notes as body text and indicate to caller that package elements
-            // have not been consumed
+               // have not been consumed
-            // @@@@
+               // @@@@
-            //TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(thePackage.Notes), EA_Constants.styleName_Body1 );
+               //TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(thePackage.Notes), EA_Constants.styleName_Body1 );
-            TextParser.parse( TextualContent.trimTrailingReturns(thePackage.Notes), thePackage.PackageID, EA_Constants.styleName_Body1, 0, false);
+               TextParser.parse( TextualContent.trimTrailingReturns(thePackage.Notes), thePackage.PackageID, EA_Constants.styleName_Body1, 0, false);
+            }
+         }
          return processLowerLevelContent;
+      }
+                  }
                   processedElements.Add(theElement.ElementID);
                   displayProgress( "ELEMENT: ", theElement.Name );
+                  if (theElement.Notes != null && theElement.Notes.Length > 0)
+                  {
-                  // @@@@
+                     // @@@@
-                  //TextualContent.appendDescription( TextualContent.trimTrailingReturns(theElement.Notes) );
+                     //TextualContent.appendDescription( TextualContent.trimTrailingReturns(theElement.Notes) );
-                  TextParser.parse( TextualContent.trimTrailingReturns(theElement.Notes), theElement.ElementID, EA_Constants.styleName_Body1, 0, false);
+                     TextParser.parse( TextualContent.trimTrailingReturns(theElement.Notes), theElement.ElementID, EA_Constants.styleName_Body1, 0, false);
+                  }
                   generateElementDiagrams(theElement);
                   if (true == isClass)
+                  {
             // The EA_DocGenText element can contain text content in its notes section
             // that must be appended to the doc in Body 1 style within the current
             // section.
          else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenText))
+         {
+            if (theElement.Notes != null && theElement.Notes.Length > 0)
+            {
-            //@@@@
+               //@@@@
-            //TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(theElement.Notes), EA_Constants.styleName_Body1 );
+               //TextualContent.appendAndSelectText( TextualContent.trimTrailingReturns(theElement.Notes), EA_Constants.styleName_Body1 );
-            TextParser.parse( TextualContent.trimTrailingReturns(theElement.Notes), theElement.ElementID, EA_Constants.styleName_Body1, 0, false);
+               TextParser.parse( TextualContent.trimTrailingReturns(theElement.Notes), theElement.ElementID, EA_Constants.styleName_Body1, 0, false);
+            }
+         }
          else if (theElement.Name.StartsWith(EA_Constants.EA_DocGenRelationshipMatrix))
+         {
             EA_RelationshipMatrix.initialise(processedElements);
             if (!abortCreationThread)
+            {
                Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Correcting known problems in ERG template styles", -1);
                StyleContent.correctErrorsInTemplateStyles();
+            }
+            if (EA_DocGenOptions.optionValue(EA_DocGenOptions.boolean_options_e.FORCE_HEADING_TABS_TO_2_5_CM))
+            {
+               Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Forcing Heading styles to use tab stop at 2.5cm only", -1);
+               StyleContent.forceHeadingsToUse2_5cmTabStops();
+            }
             // 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.

Subversion Repositories DevTools

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