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



	/// <summary>
	/// Class containing functions that implement the EA_DocGen menu items.
	/// </summary>
	public class EA_Utilities
	{
      // data used by followLink() to roll around multiple GUIDs contained in the link
      static int lastLinkID = -1;
      static int nextGuidIndex = 0;
 
 
 
 
 
 
 
      // Operations
 
      public static void identifyClipboardItem()
      {
         object o = null;
 
         Main.EA_Repository.EnsureOutputVisible(Main.GUI_OUTPUT_TAB_NAME);
         Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "", -1);
         Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Name : " + GUID_Clipboard.name, -1);
         Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "GUID : " + GUID_Clipboard.guid, -1);
         if (GUID_Clipboard.objType == EA.ObjectType.otPackage)
         {
            Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Type : Package", -1);
            o = Main.EA_Repository.GetPackageByGuid(GUID_Clipboard.guid);
         }
         else if (GUID_Clipboard.objType == EA.ObjectType.otElement)
         {
            Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Type : Element", -1);
            o = Main.EA_Repository.GetElementByGuid(GUID_Clipboard.guid);
         }
         else if (GUID_Clipboard.objType == EA.ObjectType.otDiagram)
         {
            Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Type : Diagram", -1);
            o = Main.EA_Repository.GetDiagramByGuid(GUID_Clipboard.guid);
         }
         if (o != null)
         {
            Main.EA_Repository.ShowInProjectView(o);
         }
      }
 
      public static void updateLink()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otElement)
         {
            EA.Element ele = (EA.Element)obj;
 
            if (ele.Name.StartsWith(EA_Constants.EA_DocGenBaseName)
               && ele.Name.IndexOf("Link") > 0)
            {
               char[] sep = new char[] {'\r', '\n'};
               string[] strings = ele.Notes.Split(sep, 50);
               foreach(string s in strings)
               {
                  if (s.Length > 0 && s[0] == '{')
                  {
                     if (ele.Name.StartsWith(EA_Constants.EA_DocGenDiagramLink))
                     {
                        EA.Diagram diag = (EA.Diagram)Main.EA_Repository.GetDiagramByGuid(s);
                        if (diag != null)
                        {
                           ele.Name = EA_Constants.EA_DocGenDiagramLink + " - " + GetPackagePath(diag.PackageID, diag.Name);
                           ele.Update();
                           Main.EA_Repository.RefreshModelView(ele.PackageID);
                           Main.EA_Repository.ShowInProjectView(ele);
                           return;
                        }
                     }
                     else if (ele.Name.StartsWith(EA_Constants.EA_DocGenElementLink))
                     {
                        EA.Element e = (EA.Element)Main.EA_Repository.GetElementByGuid(s);
                        if (e != null)
                        {
                           ele.Name = EA_Constants.EA_DocGenElementLink + " - " + GetPackagePath(e.PackageID, e.Name);
                           ele.Update();
                           Main.EA_Repository.RefreshModelView(ele.PackageID);
                           Main.EA_Repository.ShowInProjectView(ele);
                           return;
                        }
                     }
                     else if (ele.Name.StartsWith(EA_Constants.EA_DocGenPackageLink))
                     {
                        EA.Package p = (EA.Package)Main.EA_Repository.GetPackageByGuid(s);
                        if (p != null)
                        {
                           ele.Name = EA_Constants.EA_DocGenPackageLink + " - " + GetPackagePath(p.PackageID, p.Name);
                           ele.Update();
                           Main.EA_Repository.RefreshModelView(ele.PackageID);
                           Main.EA_Repository.ShowInProjectView(ele);
                           return;
                        }
                     }
                     else if (ele.Name.StartsWith(EA_Constants.EA_DocGenNameLink))
                     {
                        EA.Package p = (EA.Package)Main.EA_Repository.GetPackageByGuid(s);
                        if (p != null)
                        {
                           ele.Name = EA_Constants.EA_DocGenNameLink + " - " + GetPackagePath(p.PackageID, p.Name);
                           ele.Update();
                           Main.EA_Repository.RefreshModelView(ele.PackageID);
                           Main.EA_Repository.ShowInProjectView(ele);
                           return;
                        }
                     }
                     return;
                  }
               }
               MessageBox.Show("Unable to find link GUID");
               return;
            }
         }
         MessageBox.Show("You must select an EA_DocGen link element");
      }
 
      public static void followLink()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otElement)
         {
            EA.Element ele = (EA.Element)obj;
 
            if (ele.Name.StartsWith(EA_Constants.EA_DocGenBaseName)
               && ele.Name.IndexOf("Link") > 0)
            {
 
               if (ele.ElementID != lastLinkID)
               {
                  nextGuidIndex = 0;
               }
 
               char[] sep = new char[] {'\r', '\n'};
               string[] strings = ele.Notes.Split(sep, 50);
               int thisGUIDIndex = 0;
               for(int i=0; i < 2; i++)
               {
                  foreach(string s in strings)
                  {
                     if (s.Length > 0 && s[0] == '{')
                     {
                        if (thisGUIDIndex < nextGuidIndex)
                        {
                           thisGUIDIndex++;
                           continue;
                        }
 
                        object o = null;
                        if (ele.Name.StartsWith(EA_Constants.EA_DocGenDiagramLink))
                        {
                           o = Main.EA_Repository.GetDiagramByGuid(s);
                        }
                        else if (ele.Name.StartsWith(EA_Constants.EA_DocGenElementLink))
                        {
                           o = Main.EA_Repository.GetElementByGuid(s);
                        }
                        else if (ele.Name.StartsWith(EA_Constants.EA_DocGenPackageLink))
                        {
                           o = Main.EA_Repository.GetPackageByGuid(s);
                        }
                        else if (ele.Name.StartsWith(EA_Constants.EA_DocGenNameLink))
                        {
                           o = Main.EA_Repository.GetPackageByGuid(s);
                        }
                        if (o != null)
                        {
                           Main.EA_Repository.ShowInProjectView(o);
                           lastLinkID = ele.ElementID;
                           nextGuidIndex++;
                        }
                        else
                        {
                           MessageBox.Show("Unable to resolve link\r\n" + s);
                        }
                        return;
                     }
                  }
                  if (nextGuidIndex > 0)
                  {
                     nextGuidIndex = 0;
                  }
                  else
                  {
                     break;
                  }
               }
               MessageBox.Show("Unable to find link GUID");
               return;
            }
         }
         MessageBox.Show("You must select an EA_DocGen link element");
      }
 
 
      public static void modifyOptions()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otElement)
         {
            EA.Element ele = (EA.Element)obj;
 
            if (0 == ele.Name.CompareTo(EA_Constants.EA_DocGenBaseName))
            {
               if (true == EA_DocGenOptions.lookForAndProcess_EA_DocGen_Element( ele ))
               {
                  EA_DocGenOptionsForm dlg = new EA_DocGenOptionsForm();
                  dlg.populate();
                  DialogResult dlgRes = dlg.ShowDialog();
                  if (dlgRes == DialogResult.OK)
                  {
                     dlg.read();
 
                     EA_DocGenOptions.updateEA_DocGen(ele);
                  }
               }
            }
         }
      }

 
      /// <summary>
      /// Begins the document generation process, opening the dialog to capture input/output
      /// files. the createWordDoc dialog class does most of the work ofcoarse.
      /// </summary>
      public static void createWordDoc()
      {
         Main.threadCreateDocDialogRunning = true;
 
 
 
         try
         {
            EA.ObjectType objType;
            object obj;
 
            objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
            if (objType == EA.ObjectType.otPackage)
            {
               EA_DocGenOptions.initialise();
 
               // Make sure this package has an EA_DocGen element
               if (true == EA_DocGenOptions.lookForAndProcess_EA_DocGen_Element( ((EA.Package)obj) ))
               {
                  // bring up the dialog for doc generation
                  createWordDoc dialog = new createWordDoc(((EA.Package)obj));
                  dialog.Text = "Generate Document From Model Layout";
                  dialog.textBox_template.Text    = ReadTag((EA.Package)obj, "TEMPLATE");
                  dialog.textBox_output_file.Text = ReadTag((EA.Package)obj, "DOCFILE");
                  dialog.ShowDialog();
                  WriteTag((EA.Package)obj, "TEMPLATE", dialog.textBox_template.Text); 
                  WriteTag((EA.Package)obj, "DOCFILE",  dialog.textBox_output_file.Text);
               }
               else
               {
                  MessageBox.Show("EA_DocGen document model packages must contain an EA_DocGen element");
               }
            }
            else
            {
               MessageBox.Show("You must select a package whose content is to be formed into a document");
            }
         }
         catch(Exception e)
         {
            MessageBox.Show(e.Message);
         }
         Main.threadCreateDocDialogRunning = false;
      }
 
 
      /// <summary>
      /// Creates a package under the specified parent package. the package is given a tree position

      /// </summary>
      /// <param name="parentPackage"></param>
      /// <param name="name"></param>
      /// <param name="treePos"></param>
      /// <returns></returns>
      public static EA.Package createPackage(EA.Package parentPackage, string name, int treePos)
      {
         EA.Package newobj = (EA.Package)parentPackage.Packages.AddNew(name, "Package");
         newobj.TreePos = treePos;
         newobj.Update();
         return newobj;

 
      /// <summary>
      /// Generate a package hierarchy that reflects the document layout of BMS-00289, the
      /// ERG Product Software Design Document.
      /// </summary>
      public static void create_BMS00289_Layout()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            if (  ((EA.Package)obj).Packages.Count == 0
               && ((EA.Package)obj).Elements.Count == 0
               && ((EA.Package)obj).Diagrams.Count == 0 )

               newElement.Update();
 
               parentPackage.Packages.Refresh();
 
               // refresh project browser view
               Main.EA_Repository.RefreshModelView(parentPackage.PackageID);
            }
            else
            {
               MessageBox.Show("Can only insert layout into an empty package");
            }

 
 
      /// <summary>
      /// Generate a package hierarchy that reflects a basic document layout.
      /// </summary>
      public static void create_basic_Layout()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            if (  ((EA.Package)obj).Packages.Count == 0
               && ((EA.Package)obj).Elements.Count == 0
               && ((EA.Package)obj).Diagrams.Count == 0 )

               newElement.Update();
 
               parentPackage.Packages.Refresh();
 
               // refresh project browser view
               Main.EA_Repository.RefreshModelView(parentPackage.PackageID);
            }
            else
            {
               MessageBox.Show("Can only insert layout into an empty package");
            }

      /// obtaing the full path of an element,diagram, or package.
      /// </summary>
      /// <param name="parentId"></param>
      /// <param name="instr"></param>
      /// <returns></returns>
      public static string GetPackagePath( int parentId, string instr )
      {
         if (parentId != 0)
         {
            EA.Package pkg;
            pkg = Main.EA_Repository.GetPackageByID( parentId );
            if (pkg != null)
            {
               instr = pkg.Name + "/" + instr;
               instr = GetPackagePath(pkg.ParentID, instr);
            }
         }
         return instr;
      }
 
 
      private static void copy_GUID_to_clipboard(object obj, EA.ObjectType objType, bool confirm)
      {
         GUID_Clipboard.copy(obj, objType, confirm);
      }
 
 
      /// <summary>
      /// For the selected item, copy its GUID to the internal add-in GUID clipboard and the
      /// global external clipboard. Also copy to the internal add-in GUID clipboard, the name of
      /// the element and its type. This will support the AddLinkElement() method.
      /// </summary>
      public static void copy_GUID_to_clipboard()
      {
         EA.ObjectType objType;
         object obj;
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         GUID_Clipboard.copy(obj, objType, true);
      }
 
 
      public static void AddTestTraceabilityElement()
      {
         EA.ObjectType objType;
         object obj;
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         AddTestTraceabilityElement(obj, objType);
      }
      public static void AddTestTraceabilityElement(object obj, EA.ObjectType objType)
      {
         if (objType == EA.ObjectType.otPackage)
         {
            object newobj = null;
 

 
      /// <summary>
      /// Using the internal add-in GUID clipboard, paste a test link element into the selected
      /// package.
      /// </summary>
      public static void AddTestLinkElement()
      {
         EA.ObjectType objType;
         object obj;
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         AddTestLinkElement(obj, objType);
      }
 
      private static void AddTestLinkElement(object obj, EA.ObjectType objType)
      {
         if (objType == EA.ObjectType.otPackage)
         {
            object newobj = null;
 
            if (   GUID_Clipboard.objType == EA.ObjectType.otElement
                || GUID_Clipboard.objType == EA.ObjectType.otPackage)
            {
               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenTestLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);
 
               if (newobj != null)
               {
                  ((EA.Element)newobj).Notes = GUID_Clipboard.name + "\r\n" + GUID_Clipboard.guid;
                  ((EA.Element)newobj).Update();
               }
            }
            else
            {

 
      /// <summary>
      /// Using the internal add-in GUID clipboard, paste a link element into the selected
      /// package.
      /// </summary>
      public static void AddLinkElement()
      {
         EA.ObjectType objType;
         object obj;
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         AddLinkElement(obj, objType);
      }
 
      private static void AddLinkElement(object obj, EA.ObjectType objType)
      {
         if (objType == EA.ObjectType.otPackage)
         {
            object newobj = null;
 
            if (GUID_Clipboard.objType == EA.ObjectType.otPackage)
            {
               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenPackageLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);
            }
            else if (GUID_Clipboard.objType == EA.ObjectType.otDiagram)
            {
               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenDiagramLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);
            }
            else if (GUID_Clipboard.objType == EA.ObjectType.otElement)
            {
               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenElementLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);
            }
            else if (GUID_Clipboard.objType == EA.ObjectType.otAttribute)
            {
               MessageBox.Show("Attribute links are not currently supported");
            }
            else if (GUID_Clipboard.objType == EA.ObjectType.otMethod)
            {
               MessageBox.Show("Method links are not currently supported");
            }
 
            if (newobj != null)
            {
               ((EA.Element)newobj).Notes = GUID_Clipboard.name + "\r\n" + GUID_Clipboard.guid;
               ((EA.Element)newobj).Update();
            }
         }
         else
         {
            MessageBox.Show("You must select a package into which the link will be inserted");
         }
      }
 
 
      public static void AddNameLinkElement()
      {
         EA.ObjectType objType;
         object obj;
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         AddNameLinkElement(obj, objType);
      }
 
      private static void AddNameLinkElement(object obj, EA.ObjectType objType)
      {
         if (objType == EA.ObjectType.otPackage)
         {
            object newobj = null;
 
            if (GUID_Clipboard.objType == EA.ObjectType.otPackage)
            {
               newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenNameLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);
               if (newobj != null)
               {
                  StringBuilder sb = new StringBuilder();
                  sb.Append(GUID_Clipboard.name);
                  sb.Append("\r\n");
                  sb.Append(GUID_Clipboard.guid);
                  sb.Append("\r\n");
                  sb.Append("### Add as many package names as you like below here.\r\n");
                  sb.Append("### Each should be of the form: package=name\r\n");
                  sb.Append("### Delete any unused package= lines from these notes.\r\n");
                  sb.Append("### The names are case sensitive and must match exactly\r\n");

            MessageBox.Show("You must select a package into which the name link will be inserted");
         }
      }
 
 
      public static void AddTableElement()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            object newobj = null;
 
            newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenTable, EA_Constants.EA_DocGenElementType);

            MessageBox.Show("You must select a package into which the Table Element will be inserted");
         }
      }
 
 
      public static void AddTextElement()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            object newobj = null;
 
            newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenText, EA_Constants.EA_DocGenElementType);

            MessageBox.Show("You must select a package into which the Text Element will be inserted");
         }
      }
 
 
      public static void AddRelationshipMatrixElement()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            RelationshipMatrixType dlg = new RelationshipMatrixType();
            DialogResult dlgRes = dlg.ShowDialog();
            if (dlgRes == DialogResult.OK)

            MessageBox.Show("You must select a package into which the RelationshipMatrix Element will be inserted");
         }
      }
 
 
      public static void GeneratePackagesFromElementList()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            if (GUID_Clipboard.objType == EA.ObjectType.otPackage)
            {
               EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(GUID_Clipboard.guid);
               if (theFoundPackage != null)
               {
                  EA.Package srcPackage = theFoundPackage;
                  EA.Package destPackage = ((EA.Package)obj);
 
                  foreach( EA.Element srcElement in srcPackage.Elements)
                  {
                     if (false == EA_Finders.elementNameExistsInPackage(destPackage, srcElement.Name.ToString()))
                     {
                        createPackage(destPackage, srcElement.Name.ToString(), 1);
                     }
                  }
               }

            MessageBox.Show("You must select a Destination Package into which the Generated Packages will be inserted");
         }
      }
 
 
      public static void GenerateSubPackageLinks()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            if (GUID_Clipboard.objType == EA.ObjectType.otPackage)
            {
               EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(GUID_Clipboard.guid);
               if (theFoundPackage != null)
               {
                  EA.Package srcPackage = theFoundPackage;
                  EA.Package destPackage = ((EA.Package)obj);
 
                  GUID_Clipboard.push();
 
                  foreach( EA.Package subPackage in srcPackage.Packages)
                  {
                     copy_GUID_to_clipboard( (object)subPackage, EA.ObjectType.otPackage, false);
                     AddLinkElement( (object)destPackage, EA.ObjectType.otPackage);
                  }
 
                  GUID_Clipboard.pop();
               }
            }
            else
            {
               MessageBox.Show("You must first copy a Source Package GUID to the clipboard");

            MessageBox.Show("You must select a Destination Package into which the Sub-Package Links will be inserted");
         }
      }
 
 
      public static void GenerateElementLinks()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            if (GUID_Clipboard.objType == EA.ObjectType.otPackage)
            {
               EA.Package theFoundPackage = Main.EA_Repository.GetPackageByGuid(GUID_Clipboard.guid);
               if (theFoundPackage != null)
               {
                  EA.Package srcPackage = theFoundPackage;
                  EA.Package destPackage = ((EA.Package)obj);
 
                  GUID_Clipboard.push();
 
                  foreach( EA.Element subElement in srcPackage.Elements)
                  {
                     copy_GUID_to_clipboard( (object)subElement, EA.ObjectType.otElement, false);
                     AddLinkElement( (object)destPackage, EA.ObjectType.otPackage);
                  }
 
                  GUID_Clipboard.pop();
               }
            }
            else
            {
               MessageBox.Show("You must first copy a Source Package GUID to the clipboard");

      /// a user to specify what processing is to be done upon or with each element found.
      /// </summary>
      /// <param name="thePackage"></param>
      /// <param name="worker"></param>
      /// <param name="recurse"></param>
      public static void findAndProcessPackageElements( EA.Package thePackage, EA_UtilitiesRecursionWorker worker, bool recurse)
      {
         worker.processPackage( thePackage );
 
         foreach (EA.Element theElement in thePackage.Elements)
         {

         }
 
      }
 
 
      public static void addDocumentReference()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            DocReferenceForm dlg = new DocReferenceForm();
            DialogResult dlgRes = dlg.ShowDialog();
            if (dlgRes == DialogResult.OK)

            }
         }
      }
 
 
      public static void addTerminology()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            TerminologyForm dlg = new TerminologyForm();
            DialogResult dlgRes = dlg.ShowDialog();
            if (dlgRes == DialogResult.OK)

            }
         }
      }
 
 
      public static string ReadTag(EA.Package thePackage, string tagName)
      {
         EA.Element theElement = Main.EA_Repository.GetElementByGuid(thePackage.PackageGUID);
         if (theElement != null)
         {
            return ReadTag(theElement, tagName);
         }
         return "";
      }
 
      public static string ReadTag(EA.Element theElement, string tagName)
      {
         string result;
 
         EA.TaggedValue tag = (EA.TaggedValue)theElement.TaggedValues.GetByName(tagName);
         if (null != tag)

            result = "";
         }
         return result;
      }
 
      public static bool WriteTag(EA.Package thePackage, string tagName, string value)
      {
         EA.Element theElement = Main.EA_Repository.GetElementByGuid(thePackage.PackageGUID);
         if (theElement != null)
         {
            return WriteTag(theElement, tagName, value);
         }
         return false;
      }
 
      public static bool WriteTag(EA.Element theElement, string tagName, string value)
      {
         bool result;
         EA.TaggedValue tag;
            
         tag = (EA.TaggedValue)theElement.TaggedValues.GetByName(tagName);

         }
         return result;
      }
 
 
      public static void RemoveAPIStereotypeFromContent()
      {
         EA.ObjectType objType;
         object obj;
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            RemoveAPIStereotypeFromContent((EA.Package)obj);
            Main.EA_Repository.RefreshModelView(((EA.Package)obj).PackageID);
         }
         else if (objType == EA.ObjectType.otDiagram)
         {
            RemoveAPIStereotypeFromDiagram((EA.Diagram)obj);
            Main.EA_Repository.RefreshModelView(((EA.Diagram)obj).PackageID);
         }
         else if (objType == EA.ObjectType.otElement)
         {
            RemoveAPIStereotypeFromContent((EA.Element)obj);
            Main.EA_Repository.RefreshModelView(((EA.Element)obj).PackageID);
         }
      }
 
      private static void RemoveAPIStereotypeFromPackage(EA.Package thePackage)
      {
         thePackage.StereotypeEx = thePackage.StereotypeEx.Replace(",API","");
         thePackage.StereotypeEx = thePackage.StereotypeEx.Replace("API,","");
         thePackage.StereotypeEx = thePackage.StereotypeEx.Replace("API","");
         thePackage.Update();
      }
 
      private static void RemoveAPIStereotypeFromDiagram(EA.Diagram theDiagram)
      {
         // diagrams only use one stereotype, not a list of them
         if (theDiagram.Stereotype.Equals("API"))
         {
            theDiagram.Stereotype = "";
            theDiagram.Update();
         }
      }
 
      private static void RemoveAPIStereotypeFromElement(EA.Element theElement)
      {
         theElement.StereotypeEx = theElement.StereotypeEx.Replace(",API","");
         theElement.StereotypeEx = theElement.StereotypeEx.Replace("API,","");
         theElement.StereotypeEx = theElement.StereotypeEx.Replace("API","");
         theElement.Update();
      }
 
      private static void RemoveAPIStereotypeFromContent(EA.Package thePackage)
      {
         RemoveAPIStereotypeFromPackage(thePackage);
 
         foreach(EA.Diagram diagram in thePackage.Diagrams)
         {

         {
            RemoveAPIStereotypeFromContent(package); // recursion
         }
      }
 
      private static void RemoveAPIStereotypeFromContent(EA.Element theElement)
      {
         RemoveAPIStereotypeFromElement(theElement);
 
         foreach(EA.Diagram diagram in theElement.Diagrams)
         {

            RemoveAPIStereotypeFromContent(element); // recursion
         }
      }
 
 
      public static void MarkContentWithAPIStereotype()
      {
         EA.ObjectType objType;
         object obj;
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            MarkContentWithAPIStereotype((EA.Package)obj);
            Main.EA_Repository.RefreshModelView(((EA.Package)obj).PackageID);
         }
         else if (objType == EA.ObjectType.otDiagram)
         {
            MarkDiagramWithAPIStereotype((EA.Diagram)obj);
            Main.EA_Repository.RefreshModelView(((EA.Diagram)obj).PackageID);
         }
         else if (objType == EA.ObjectType.otElement)
         {
            MarkContentWithAPIStereotype((EA.Element)obj);
            Main.EA_Repository.RefreshModelView(((EA.Element)obj).PackageID);
         }
      }
 
      private static void MarkPackageWithAPIStereotype(EA.Package thePackage)
      {
         if (thePackage.StereotypeEx.IndexOf("API") < 0)
         {
            if (thePackage.StereotypeEx.Length > 0)
               thePackage.StereotypeEx += ",API";

               thePackage.StereotypeEx = "API";
            thePackage.Update();
         }
      }
 
      private static void MarkDiagramWithAPIStereotype(EA.Diagram theDiagram)
      {
         // diagrams only use one stereotype, not a list of them
         theDiagram.Stereotype = "API";
         theDiagram.Update();
      }
 
      private static void MarkElementWithAPIStereotype(EA.Element theElement)
      {
         if (theElement.StereotypeEx.IndexOf("API") < 0)
         {
            if (theElement.StereotypeEx.Length > 0)
               theElement.StereotypeEx += ",API";

               theElement.Stereotype = "API";
            theElement.Update();
         }
      }
 
      private static void MarkContentWithAPIStereotype(EA.Package thePackage)
      {
         MarkPackageWithAPIStereotype(thePackage);
 
         foreach(EA.Diagram diagram in thePackage.Diagrams)
         {

         {
            MarkContentWithAPIStereotype(package); // recursion
         }
      }
 
      private static void MarkContentWithAPIStereotype(EA.Element theElement)
      {
         MarkElementWithAPIStereotype(theElement);
 
         foreach(EA.Diagram diagram in theElement.Diagrams)
         {

 
 
      #region Temporary or experimental code
 
 
      private static void parse_element(int parentId, EA.Element theElement, int recurse_level)
      {
 
 
         Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, 
            "ParentId:"
            + parentId.ToString()
            + ", Level:"
            + recurse_level.ToString()
            + ", TreePos:"
            + theElement.TreePos.ToString() 
            + ", ELE-ParentID:"
            + theElement.ParentID.ToString()
            + ", ELE-PackageID:"
            + theElement.PackageID.ToString()
            + ", ELE-ElementID:"
            + theElement.ElementID.ToString()
            + ",  ELE-Name: " 
            + theElement.Name, -1);
         
         foreach(EA.Diagram theDiagram in theElement.Diagrams)
         {
            Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, 
               "Level:"
               + recurse_level.ToString() 
               + ", ParentID:"
               + theDiagram.ParentID.ToString()
               + ", PackageID:"
               + theDiagram.PackageID.ToString()
               + ", DiagramID:"
               + theDiagram.DiagramID.ToString()
               + "  DIAGRAM: " 
               + theDiagram.Name, -1);
         }
 
         foreach(EA.Element subElement in theElement.Elements)
         {
            parse_element(theElement.ElementID, subElement, recurse_level+1);
 
         }
      }
 
 
      /// <summary>
      /// Parse a package structure in a similar way to that taken when users are generating a word
      /// document, only here we simply write diagnostic text to the output tab.
      /// </summary>
      /// <param name="thePackage"></param>
      /// <param name="recurse_level"></param>
      private static void parse_package(EA.Package thePackage, int recurse_level)
      {
         Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, 
                                      "Level:"
                                    + recurse_level.ToString() 
                                    + ", ParentID:"
                                    + thePackage.ParentID.ToString()
                                    + ", PackageID:"

         // default handling of diagrams
         foreach(EA.Diagram theDiagram in thePackage.Diagrams)
         {
            if (theDiagram.ParentID == 0)
            {
               Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, 
                  "Level:"
                  + recurse_level.ToString() 
                  + ", ParentID:"
                  + theDiagram.ParentID.ToString()
                  + ", PackageID:"

         {
            if (subElement.ParentID == 0 || thePackage.PackageID == subElement.ParentID)
               parse_element(thePackage.PackageID, subElement, recurse_level+1);
         }
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
         foreach(EA.Package lowerLevelPackage in thePackage.Packages)
         {
            parse_package(lowerLevelPackage, recurse_level+1);
         }
      }

 
      /// <summary>
      /// Parses a specified package in a similar way to what would be done if a user were generating
      /// a word document, but here do nothing except write diagnostic text to the output tab.
      /// </summary>
      public static void showDiscoveryOrder()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            EA.Package EA_ParentPackage = ((EA.Package)obj);
 
            Main.EA_Repository.EnsureOutputVisible(Main.GUI_OUTPUT_TAB_NAME);
            Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "", -1);
            Main.EA_Repository.WriteOutput( Main.GUI_OUTPUT_TAB_NAME, "Showing Object Discovery order for " + EA_ParentPackage.Name, -1);
 
 
 
            parse_package(EA_ParentPackage, 1);
 
         }
         else
         {
            MessageBox.Show("You must select a package to parse");
         }
      }
 
 
      public static void SaveVersionControlledPackage()
      {
         EA.ObjectType objType;
         object obj;
 
         objType = Main.EA_Repository.GetTreeSelectedItem( out obj );
         if (objType == EA.ObjectType.otPackage)
         {
            EA.Package EA_Package = ((EA.Package)obj);
 
            if (EA_Package.IsControlled == true)
            {
               EA.Project EA_Project = Main.EA_Repository.GetProjectInterface();
 
               EA_Project.SaveControlledPackage( EA_Package.PackageGUID );
 
               //EA_Project.SaveControlledPackage( EA_Project.GUIDtoXML( EA_Package.PackageGUID ) );
            }

Rev 2104	Rev 2106
Line 31...	Line 31...
31	`/// <summary>`	31	`/// <summary>`
32	`/// Class containing functions that implement the EA_DocGen menu items.`	32	`/// Class containing functions that implement the EA_DocGen menu items.`
33	`/// </summary>`	33	`/// </summary>`
34	`public class EA_Utilities`	34	`public class EA_Utilities`
35	`{`	35	`{`
-		36	`// data used by followLink() to roll around multiple GUIDs contained in the link`
36	`// Data`	37	`static int lastLinkID = -1;`
37	`public EA_DocGenOptions options = null;`	38	`static int nextGuidIndex = 0;`
38		39
39	`public GUID_Clipboard guid_clipboard = null;`	-
40		40
41	`private EA.Repository EA_Repository = null;`	-
42		-
43	`public EA_Finders EA_Finder = null;`	-
44		41
45	`// Operations`	42	`// Operations`
46		43
47	`public EA_Utilities()`	44	`public static void identifyClipboardItem()`
48	`{`	45	`{`
49	`guid_clipboard = new GUID_Clipboard(this);`	46	`object o = null;`
50		47
-		48	`Main.EA_Repository.EnsureOutputVisible(Main.GUI_OUTPUT_TAB_NAME);`
-		49	`Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "", -1);`
-		50	`Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Name : " + GUID_Clipboard.name, -1);`
-		51	`Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "GUID : " + GUID_Clipboard.guid, -1);`
-		52	`if (GUID_Clipboard.objType == EA.ObjectType.otPackage)`
-		53	`{`
-		54	`Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Type : Package", -1);`
-		55	`o = Main.EA_Repository.GetPackageByGuid(GUID_Clipboard.guid);`
-		56	`}`
-		57	`else if (GUID_Clipboard.objType == EA.ObjectType.otElement)`
-		58	`{`
-		59	`Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Type : Element", -1);`
-		60	`o = Main.EA_Repository.GetElementByGuid(GUID_Clipboard.guid);`
-		61	`}`
-		62	`else if (GUID_Clipboard.objType == EA.ObjectType.otDiagram)`
-		63	`{`
-		64	`Main.EA_Repository.WriteOutput(Main.GUI_OUTPUT_TAB_NAME, "Type : Diagram", -1);`
-		65	`o = Main.EA_Repository.GetDiagramByGuid(GUID_Clipboard.guid);`
-		66	`}`
-		67	`if (o != null)`
-		68	`{`
51	`options = new EA_DocGenOptions(this);`	69	`Main.EA_Repository.ShowInProjectView(o);`
-		70	`}`
-		71	`}`
52		72
53	`EA_Finder = new EA_Finders();`	73	`public static void updateLink()`
54	`}`	74	`{`
-		75	`EA.ObjectType objType;`
-		76	`object obj;`
55		77
-		78	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
-		79	`if (objType == EA.ObjectType.otElement)`
-		80	`{`
-		81	`EA.Element ele = (EA.Element)obj;`
56		82
-		83	`if (ele.Name.StartsWith(EA_Constants.EA_DocGenBaseName)`
-		84	`&& ele.Name.IndexOf("Link") > 0)`
-		85	`{`
-		86	`char[] sep = new char[] {'\r', '\n'};`
-		87	`string[] strings = ele.Notes.Split(sep, 50);`
-		88	`foreach(string s in strings)`
-		89	`{`
-		90	`if (s.Length > 0 && s[0] == '{')`
-		91	`{`
-		92	`if (ele.Name.StartsWith(EA_Constants.EA_DocGenDiagramLink))`
-		93	`{`
-		94	`EA.Diagram diag = (EA.Diagram)Main.EA_Repository.GetDiagramByGuid(s);`
-		95	`if (diag != null)`
-		96	`{`
-		97	`ele.Name = EA_Constants.EA_DocGenDiagramLink + " - " + GetPackagePath(diag.PackageID, diag.Name);`
-		98	`ele.Update();`
-		99	`Main.EA_Repository.RefreshModelView(ele.PackageID);`
-		100	`Main.EA_Repository.ShowInProjectView(ele);`
-		101	`return;`
-		102	`}`
-		103	`}`
-		104	`else if (ele.Name.StartsWith(EA_Constants.EA_DocGenElementLink))`
-		105	`{`
-		106	`EA.Element e = (EA.Element)Main.EA_Repository.GetElementByGuid(s);`
-		107	`if (e != null)`
-		108	`{`
-		109	`ele.Name = EA_Constants.EA_DocGenElementLink + " - " + GetPackagePath(e.PackageID, e.Name);`
-		110	`ele.Update();`
-		111	`Main.EA_Repository.RefreshModelView(ele.PackageID);`
-		112	`Main.EA_Repository.ShowInProjectView(ele);`
-		113	`return;`
-		114	`}`
-		115	`}`
-		116	`else if (ele.Name.StartsWith(EA_Constants.EA_DocGenPackageLink))`
-		117	`{`
-		118	`EA.Package p = (EA.Package)Main.EA_Repository.GetPackageByGuid(s);`
-		119	`if (p != null)`
-		120	`{`
-		121	`ele.Name = EA_Constants.EA_DocGenPackageLink + " - " + GetPackagePath(p.PackageID, p.Name);`
-		122	`ele.Update();`
-		123	`Main.EA_Repository.RefreshModelView(ele.PackageID);`
-		124	`Main.EA_Repository.ShowInProjectView(ele);`
-		125	`return;`
-		126	`}`
-		127	`}`
-		128	`else if (ele.Name.StartsWith(EA_Constants.EA_DocGenNameLink))`
-		129	`{`
-		130	`EA.Package p = (EA.Package)Main.EA_Repository.GetPackageByGuid(s);`
-		131	`if (p != null)`
-		132	`{`
-		133	`ele.Name = EA_Constants.EA_DocGenNameLink + " - " + GetPackagePath(p.PackageID, p.Name);`
-		134	`ele.Update();`
57	`public void accept_EA_RepositoryRef(EA.Repository EA_RepositoryRef)`	135	`Main.EA_Repository.RefreshModelView(ele.PackageID);`
-		136	`Main.EA_Repository.ShowInProjectView(ele);`
-		137	`return;`
-		138	`}`
-		139	`}`
-		140	`return;`
-		141	`}`
-		142	`}`
-		143	`MessageBox.Show("Unable to find link GUID");`
-		144	`return;`
-		145	`}`
-		146	`}`
-		147	`MessageBox.Show("You must select an EA_DocGen link element");`
-		148	`}`
-		149
-		150	`public static void followLink()`
58	`{`	151	`{`
59	`EA_Repository = EA_RepositoryRef;`	152	`EA.ObjectType objType;`
-		153	`object obj;`
-		154
60	`EA_Finder.accept_EA_RepositoryRef(EA_RepositoryRef);`	155	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
-		156	`if (objType == EA.ObjectType.otElement)`
-		157	`{`
-		158	`EA.Element ele = (EA.Element)obj;`
-		159
-		160	`if (ele.Name.StartsWith(EA_Constants.EA_DocGenBaseName)`
-		161	`&& ele.Name.IndexOf("Link") > 0)`
-		162	`{`
-		163
-		164	`if (ele.ElementID != lastLinkID)`
-		165	`{`
-		166	`nextGuidIndex = 0;`
-		167	`}`
-		168
-		169	`char[] sep = new char[] {'\r', '\n'};`
-		170	`string[] strings = ele.Notes.Split(sep, 50);`
-		171	`int thisGUIDIndex = 0;`
-		172	`for(int i=0; i < 2; i++)`
-		173	`{`
-		174	`foreach(string s in strings)`
-		175	`{`
-		176	`if (s.Length > 0 && s[0] == '{')`
-		177	`{`
-		178	`if (thisGUIDIndex < nextGuidIndex)`
-		179	`{`
-		180	`thisGUIDIndex++;`
-		181	`continue;`
-		182	`}`
-		183
-		184	`object o = null;`
-		185	`if (ele.Name.StartsWith(EA_Constants.EA_DocGenDiagramLink))`
-		186	`{`
-		187	`o = Main.EA_Repository.GetDiagramByGuid(s);`
-		188	`}`
-		189	`else if (ele.Name.StartsWith(EA_Constants.EA_DocGenElementLink))`
-		190	`{`
-		191	`o = Main.EA_Repository.GetElementByGuid(s);`
-		192	`}`
-		193	`else if (ele.Name.StartsWith(EA_Constants.EA_DocGenPackageLink))`
-		194	`{`
-		195	`o = Main.EA_Repository.GetPackageByGuid(s);`
-		196	`}`
-		197	`else if (ele.Name.StartsWith(EA_Constants.EA_DocGenNameLink))`
-		198	`{`
-		199	`o = Main.EA_Repository.GetPackageByGuid(s);`
-		200	`}`
-		201	`if (o != null)`
-		202	`{`
-		203	`Main.EA_Repository.ShowInProjectView(o);`
-		204	`lastLinkID = ele.ElementID;`
-		205	`nextGuidIndex++;`
-		206	`}`
-		207	`else`
-		208	`{`
-		209	`MessageBox.Show("Unable to resolve link\r\n" + s);`
-		210	`}`
-		211	`return;`
-		212	`}`
-		213	`}`
-		214	`if (nextGuidIndex > 0)`
-		215	`{`
-		216	`nextGuidIndex = 0;`
-		217	`}`
-		218	`else`
-		219	`{`
-		220	`break;`
-		221	`}`
-		222	`}`
-		223	`MessageBox.Show("Unable to find link GUID");`
-		224	`return;`
-		225	`}`
-		226	`}`
-		227	`MessageBox.Show("You must select an EA_DocGen link element");`
61	`}`	228	`}`
62		229
63		230
64	`public void modifyOptions()`	231	`public static void modifyOptions()`
65	`{`	232	`{`
66	`EA.ObjectType objType;`	233	`EA.ObjectType objType;`
67	`object obj;`	234	`object obj;`
68		235
69	`objType = EA_Repository.GetTreeSelectedItem( out obj );`	236	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
70	`if (objType == EA.ObjectType.otElement)`	237	`if (objType == EA.ObjectType.otElement)`
71	`{`	238	`{`
72	`EA.Element ele = (EA.Element)obj;`	239	`EA.Element ele = (EA.Element)obj;`
73		240
74	`if (0 == ele.Name.CompareTo(EA_Constants.EA_DocGenBaseName))`	241	`if (0 == ele.Name.CompareTo(EA_Constants.EA_DocGenBaseName))`
75	`{`	242	`{`
76	`if (true == options.lookForAndProcess_EA_DocGen_Element( ele ))`	243	`if (true == EA_DocGenOptions.lookForAndProcess_EA_DocGen_Element( ele ))`
77	`{`	244	`{`
78	`EA_DocGenOptionsForm dlg = new EA_DocGenOptionsForm();`	245	`EA_DocGenOptionsForm dlg = new EA_DocGenOptionsForm();`
79	`dlg.populate(EA_Repository, options);`	246	`dlg.populate();`
80	`DialogResult dlgRes = dlg.ShowDialog();`	247	`DialogResult dlgRes = dlg.ShowDialog();`
81	`if (dlgRes == DialogResult.OK)`	248	`if (dlgRes == DialogResult.OK)`
82	`{`	249	`{`
83	`dlg.read(EA_Repository, options);`	250	`dlg.read();`
84		251
85	`options.updateEA_DocGen(ele);`	252	`EA_DocGenOptions.updateEA_DocGen(ele);`
86	`}`	253	`}`
87	`}`	254	`}`
88	`}`	255	`}`
89	`}`	256	`}`
90	`}`	257	`}`
Line 92...	Line 259...
92		259
93	`/// <summary>`	260	`/// <summary>`
94	`/// Begins the document generation process, opening the dialog to capture input/output`	261	`/// Begins the document generation process, opening the dialog to capture input/output`
95	`/// files. the createWordDoc dialog class does most of the work ofcoarse.`	262	`/// files. the createWordDoc dialog class does most of the work ofcoarse.`
96	`/// </summary>`	263	`/// </summary>`
97	`public void createWordDoc()`	264	`public static void createWordDoc()`
98	`{`	265	`{`
99	`EA.ObjectType objType;`	266	`Main.threadCreateDocDialogRunning = true;`
100	`object obj;`	-
101		267
102	`objType = EA_Repository.GetTreeSelectedItem( out obj );`	-
103	`if (objType == EA.ObjectType.otPackage)`	268	`try`
104	`{`	269	`{`
105	`// Make sure this package has an EA_DocGen element`	270	`EA.ObjectType objType;`
-		271	`object obj;`
-		272
106	`if (true == options.lookForAndProcess_EA_DocGen_Element( ((EA.Package)obj) ))`	273	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
-		274	`if (objType == EA.ObjectType.otPackage)`
107	`{`	275	`{`
-		276	`EA_DocGenOptions.initialise();`
-		277
-		278	`// Make sure this package has an EA_DocGen element`
-		279	`if (true == EA_DocGenOptions.lookForAndProcess_EA_DocGen_Element( ((EA.Package)obj) ))`
-		280	`{`
108	`// bring up the dialog for doc generation`	281	`// bring up the dialog for doc generation`
109	`createWordDoc dialog = new createWordDoc(EA_Repository, ((EA.Package)obj), this);`	282	`createWordDoc dialog = new createWordDoc(((EA.Package)obj));`
110	`dialog.Text = "Generate Document From Model Layout";`	283	`dialog.Text = "Generate Document From Model Layout";`
-		284	`dialog.textBox_template.Text = ReadTag((EA.Package)obj, "TEMPLATE");`
-		285	`dialog.textBox_output_file.Text = ReadTag((EA.Package)obj, "DOCFILE");`
111	`dialog.ShowDialog();`	286	`dialog.ShowDialog();`
-		287	`WriteTag((EA.Package)obj, "TEMPLATE", dialog.textBox_template.Text);`
-		288	`WriteTag((EA.Package)obj, "DOCFILE", dialog.textBox_output_file.Text);`
-		289	`}`
-		290	`else`
-		291	`{`
-		292	`MessageBox.Show("EA_DocGen document model packages must contain an EA_DocGen element");`
-		293	`}`
112	`}`	294	`}`
113	`else`	295	`else`
114	`{`	296	`{`
115	`MessageBox.Show("EA_DocGen document model packages must contain an EA_DocGen element");`	297	`MessageBox.Show("You must select a package whose content is to be formed into a document");`
116	`}`	298	`}`
117	`}`	299	`}`
118	`else`	300	`catch(Exception e)`
119	`{`	301	`{`
120	`MessageBox.Show("You must select a package whose content is to be formed into a document");`	302	`MessageBox.Show(e.Message);`
121	`}`	303	`}`
-		304	`Main.threadCreateDocDialogRunning = false;`
122	`}`	305	`}`
123		306
124		307
125	`/// <summary>`	308	`/// <summary>`
126	`/// Creates a package under the specified parent package. the package is given a tree position`	309	`/// Creates a package under the specified parent package. the package is given a tree position`
Line 128...	Line 311...
128	`/// </summary>`	311	`/// </summary>`
129	`/// <param name="parentPackage"></param>`	312	`/// <param name="parentPackage"></param>`
130	`/// <param name="name"></param>`	313	`/// <param name="name"></param>`
131	`/// <param name="treePos"></param>`	314	`/// <param name="treePos"></param>`
132	`/// <returns></returns>`	315	`/// <returns></returns>`
133	`public EA.Package createPackage(EA.Package parentPackage, string name, int treePos)`	316	`public static EA.Package createPackage(EA.Package parentPackage, string name, int treePos)`
134	`{`	317	`{`
135	`EA.Package newobj = (EA.Package)parentPackage.Packages.AddNew(name, "Package");`	318	`EA.Package newobj = (EA.Package)parentPackage.Packages.AddNew(name, "Package");`
136	`newobj.TreePos = treePos;`	319	`newobj.TreePos = treePos;`
137	`newobj.Update();`	320	`newobj.Update();`
138	`return newobj;`	321	`return newobj;`
Line 141...	Line 324...
141		324
142	`/// <summary>`	325	`/// <summary>`
143	`/// Generate a package hierarchy that reflects the document layout of BMS-00289, the`	326	`/// Generate a package hierarchy that reflects the document layout of BMS-00289, the`
144	`/// ERG Product Software Design Document.`	327	`/// ERG Product Software Design Document.`
145	`/// </summary>`	328	`/// </summary>`
146	`public void create_BMS00289_Layout()`	329	`public static void create_BMS00289_Layout()`
147	`{`	330	`{`
148	`EA.ObjectType objType;`	331	`EA.ObjectType objType;`
149	`object obj;`	332	`object obj;`
150		333
151	`objType = EA_Repository.GetTreeSelectedItem( out obj );`	334	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
152	`if (objType == EA.ObjectType.otPackage)`	335	`if (objType == EA.ObjectType.otPackage)`
153	`{`	336	`{`
154	`if ( ((EA.Package)obj).Packages.Count == 0`	337	`if ( ((EA.Package)obj).Packages.Count == 0`
155	`&& ((EA.Package)obj).Elements.Count == 0`	338	`&& ((EA.Package)obj).Elements.Count == 0`
156	`&& ((EA.Package)obj).Diagrams.Count == 0 )`	339	`&& ((EA.Package)obj).Diagrams.Count == 0 )`
Line 204...	Line 387...
204	`newElement.Update();`	387	`newElement.Update();`
205		388
206	`parentPackage.Packages.Refresh();`	389	`parentPackage.Packages.Refresh();`
207		390
208	`// refresh project browser view`	391	`// refresh project browser view`
209	`EA_Repository.RefreshModelView(parentPackage.PackageID);`	392	`Main.EA_Repository.RefreshModelView(parentPackage.PackageID);`
210	`}`	393	`}`
211	`else`	394	`else`
212	`{`	395	`{`
213	`MessageBox.Show("Can only insert layout into an empty package");`	396	`MessageBox.Show("Can only insert layout into an empty package");`
214	`}`	397	`}`
Line 221...	Line 404...
221		404
222		405
223	`/// <summary>`	406	`/// <summary>`
224	`/// Generate a package hierarchy that reflects a basic document layout.`	407	`/// Generate a package hierarchy that reflects a basic document layout.`
225	`/// </summary>`	408	`/// </summary>`
226	`public void create_basic_Layout()`	409	`public static void create_basic_Layout()`
227	`{`	410	`{`
228	`EA.ObjectType objType;`	411	`EA.ObjectType objType;`
229	`object obj;`	412	`object obj;`
230		413
231	`objType = EA_Repository.GetTreeSelectedItem( out obj );`	414	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
232	`if (objType == EA.ObjectType.otPackage)`	415	`if (objType == EA.ObjectType.otPackage)`
233	`{`	416	`{`
234	`if ( ((EA.Package)obj).Packages.Count == 0`	417	`if ( ((EA.Package)obj).Packages.Count == 0`
235	`&& ((EA.Package)obj).Elements.Count == 0`	418	`&& ((EA.Package)obj).Elements.Count == 0`
236	`&& ((EA.Package)obj).Diagrams.Count == 0 )`	419	`&& ((EA.Package)obj).Diagrams.Count == 0 )`
Line 260...	Line 443...
260	`newElement.Update();`	443	`newElement.Update();`
261		444
262	`parentPackage.Packages.Refresh();`	445	`parentPackage.Packages.Refresh();`
263		446
264	`// refresh project browser view`	447	`// refresh project browser view`
265	`EA_Repository.RefreshModelView(parentPackage.PackageID);`	448	`Main.EA_Repository.RefreshModelView(parentPackage.PackageID);`
266	`}`	449	`}`
267	`else`	450	`else`
268	`{`	451	`{`
269	`MessageBox.Show("Can only insert layout into an empty package");`	452	`MessageBox.Show("Can only insert layout into an empty package");`
270	`}`	453	`}`
Line 282...	Line 465...
282	`/// obtaing the full path of an element,diagram, or package.`	465	`/// obtaing the full path of an element,diagram, or package.`
283	`/// </summary>`	466	`/// </summary>`
284	`/// <param name="parentId"></param>`	467	`/// <param name="parentId"></param>`
285	`/// <param name="instr"></param>`	468	`/// <param name="instr"></param>`
286	`/// <returns></returns>`	469	`/// <returns></returns>`
287	`public string GetPackagePath( int parentId, string instr )`	470	`public static string GetPackagePath( int parentId, string instr )`
288	`{`	471	`{`
289	`if (parentId != 0)`	472	`if (parentId != 0)`
290	`{`	473	`{`
291	`EA.Package pkg;`	474	`EA.Package pkg;`
292	`pkg = EA_Repository.GetPackageByID( parentId );`	475	`pkg = Main.EA_Repository.GetPackageByID( parentId );`
293	`if (pkg != null)`	476	`if (pkg != null)`
294	`{`	477	`{`
295	`instr = pkg.Name + "/" + instr;`	478	`instr = pkg.Name + "/" + instr;`
296	`instr = GetPackagePath(pkg.ParentID, instr);`	479	`instr = GetPackagePath(pkg.ParentID, instr);`
297	`}`	480	`}`
298	`}`	481	`}`
299	`return instr;`	482	`return instr;`
300	`}`	483	`}`
301		484
302		485
303	`private void copy_GUID_to_clipboard(object obj, EA.ObjectType objType, bool confirm)`	486	`private static void copy_GUID_to_clipboard(object obj, EA.ObjectType objType, bool confirm)`
304	`{`	487	`{`
305	`guid_clipboard.copy(obj, objType, confirm);`	488	`GUID_Clipboard.copy(obj, objType, confirm);`
306	`}`	489	`}`
307		490
308		491
309	`/// <summary>`	492	`/// <summary>`
310	`/// For the selected item, copy its GUID to the internal add-in GUID clipboard and the`	493	`/// For the selected item, copy its GUID to the internal add-in GUID clipboard and the`
311	`/// global external clipboard. Also copy to the internal add-in GUID clipboard, the name of`	494	`/// global external clipboard. Also copy to the internal add-in GUID clipboard, the name of`
312	`/// the element and its type. This will support the AddLinkElement() method.`	495	`/// the element and its type. This will support the AddLinkElement() method.`
313	`/// </summary>`	496	`/// </summary>`
314	`public void copy_GUID_to_clipboard()`	497	`public static void copy_GUID_to_clipboard()`
315	`{`	498	`{`
316	`EA.ObjectType objType;`	499	`EA.ObjectType objType;`
317	`object obj;`	500	`object obj;`
318	`objType = EA_Repository.GetTreeSelectedItem( out obj );`	501	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
319	`guid_clipboard.copy(obj, objType, true);`	502	`GUID_Clipboard.copy(obj, objType, true);`
320	`}`	503	`}`
321		504
322		505
323	`public void AddTestTraceabilityElement()`	506	`public static void AddTestTraceabilityElement()`
324	`{`	507	`{`
325	`EA.ObjectType objType;`	508	`EA.ObjectType objType;`
326	`object obj;`	509	`object obj;`
327	`objType = EA_Repository.GetTreeSelectedItem( out obj );`	510	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
328	`AddTestTraceabilityElement(obj, objType);`	511	`AddTestTraceabilityElement(obj, objType);`
329	`}`	512	`}`
330	`public void AddTestTraceabilityElement(object obj, EA.ObjectType objType)`	513	`public static void AddTestTraceabilityElement(object obj, EA.ObjectType objType)`
331	`{`	514	`{`
332	`if (objType == EA.ObjectType.otPackage)`	515	`if (objType == EA.ObjectType.otPackage)`
333	`{`	516	`{`
334	`object newobj = null;`	517	`object newobj = null;`
335		518
Line 348...	Line 531...
348		531
349	`/// <summary>`	532	`/// <summary>`
350	`/// Using the internal add-in GUID clipboard, paste a test link element into the selected`	533	`/// Using the internal add-in GUID clipboard, paste a test link element into the selected`
351	`/// package.`	534	`/// package.`
352	`/// </summary>`	535	`/// </summary>`
353	`public void AddTestLinkElement()`	536	`public static void AddTestLinkElement()`
354	`{`	537	`{`
355	`EA.ObjectType objType;`	538	`EA.ObjectType objType;`
356	`object obj;`	539	`object obj;`
357	`objType = EA_Repository.GetTreeSelectedItem( out obj );`	540	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
358	`AddTestLinkElement(obj, objType);`	541	`AddTestLinkElement(obj, objType);`
359	`}`	542	`}`
360		543
361	`private void AddTestLinkElement(object obj, EA.ObjectType objType)`	544	`private static void AddTestLinkElement(object obj, EA.ObjectType objType)`
362	`{`	545	`{`
363	`if (objType == EA.ObjectType.otPackage)`	546	`if (objType == EA.ObjectType.otPackage)`
364	`{`	547	`{`
365	`object newobj = null;`	548	`object newobj = null;`
366		549
367	`if ( guid_clipboard.objType == EA.ObjectType.otElement`	550	`if ( GUID_Clipboard.objType == EA.ObjectType.otElement`
368	`\|\| guid_clipboard.objType == EA.ObjectType.otPackage)`	551	`\|\| GUID_Clipboard.objType == EA.ObjectType.otPackage)`
369	`{`	552	`{`
370	`newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenTestLink + " - " + guid_clipboard.name, EA_Constants.EA_DocGenElementType);`	553	`newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenTestLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);`
371		554
372	`if (newobj != null)`	555	`if (newobj != null)`
373	`{`	556	`{`
374	`((EA.Element)newobj).Notes = guid_clipboard.name + "\r\n" + guid_clipboard.guid;`	557	`((EA.Element)newobj).Notes = GUID_Clipboard.name + "\r\n" + GUID_Clipboard.guid;`
375	`((EA.Element)newobj).Update();`	558	`((EA.Element)newobj).Update();`
376	`}`	559	`}`
377	`}`	560	`}`
378	`else`	561	`else`
379	`{`	562	`{`
Line 389...	Line 572...
389		572
390	`/// <summary>`	573	`/// <summary>`
391	`/// Using the internal add-in GUID clipboard, paste a link element into the selected`	574	`/// Using the internal add-in GUID clipboard, paste a link element into the selected`
392	`/// package.`	575	`/// package.`
393	`/// </summary>`	576	`/// </summary>`
394	`public void AddLinkElement()`	577	`public static void AddLinkElement()`
395	`{`	578	`{`
396	`EA.ObjectType objType;`	579	`EA.ObjectType objType;`
397	`object obj;`	580	`object obj;`
398	`objType = EA_Repository.GetTreeSelectedItem( out obj );`	581	`objType = Main.EA_Repository.GetTreeSelectedItem( out obj );`
399	`AddLinkElement(obj, objType);`	582	`AddLinkElement(obj, objType);`
400	`}`	583	`}`
401		584
402	`private void AddLinkElement(object obj, EA.ObjectType objType)`	585	`private static void AddLinkElement(object obj, EA.ObjectType objType)`
403	`{`	586	`{`
404	`if (objType == EA.ObjectType.otPackage)`	587	`if (objType == EA.ObjectType.otPackage)`
405	`{`	588	`{`
406	`object newobj = null;`	589	`object newobj = null;`
407		590
408	`if (guid_clipboard.objType == EA.ObjectType.otPackage)`	591	`if (GUID_Clipboard.objType == EA.ObjectType.otPackage)`
409	`{`	592	`{`
410	`newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenPackageLink + " - " + guid_clipboard.name, EA_Constants.EA_DocGenElementType);`	593	`newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenPackageLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);`
411	`}`	594	`}`
412	`else if (guid_clipboard.objType == EA.ObjectType.otDiagram)`	595	`else if (GUID_Clipboard.objType == EA.ObjectType.otDiagram)`
413	`{`	596	`{`
414	`newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenDiagramLink + " - " + guid_clipboard.name, EA_Constants.EA_DocGenElementType);`	597	`newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenDiagramLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);`
415	`}`	598	`}`
416	`else if (guid_clipboard.objType == EA.ObjectType.otElement)`	599	`else if (GUID_Clipboard.objType == EA.ObjectType.otElement)`
417	`{`	600	`{`
418	`newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenElementLink + " - " + guid_clipboard.name, EA_Constants.EA_DocGenElementType);`	601	`newobj = ((EA.Package)obj).Elements.AddNew(EA_Constants.EA_DocGenElementLink + " - " + GUID_Clipboard.name, EA_Constants.EA_DocGenElementType);`
419	`}`	602	`}`
420	`else if (guid_clipboard.objType == EA.ObjectType.otAttribute)`	603	`else if (GUID_Clipboard.objType == EA.ObjectType.otAttribute)`
421	`{`	604	`{`
422	`MessageBox.Show("Attribute links are not currently supported");`	605	`MessageBox.Show("Attribute links are not currently supported");`
423	`}`	606	`}`
424	`else if (guid_clipboard.objType == EA.ObjectType.otMethod)`	607	`else if (GUID_Clipboard.objType == EA.ObjectType.otMethod)`
425	`{`	608	`{`
426	`MessageBox.Show("Method links are not currently supported");`	609	`MessageBox.Show("Method links are not currently supported");`
427	`}`	610	`}`
428		611
429	`if (newobj != null)`	612	`if (newobj != null)`
430	`{`	613	`{`
431	`((EA.Element)newobj).Notes = guid_clipboard.name + "\r\n" + guid_clipboard.guid;`	614	`((EA.Element)newobj).Notes = GUID_Clipboard.name + "\r\n" + GUID_Clipboard.guid;`
432	`((EA.Element)newobj).Update();`	615	`((EA.Element)newobj).Update();`
433	`}`	616	`}`
434	`}`	617	`}`
435	`else`	618	`else`
436	`{`	619	`{`
437	`MessageBox.Show("You must select a package into which the link will be inserted");`	620	`MessageBox.Show("You must select a package into which the link will be inserted");`
438	`}`	621	`}`
439	`}`	622	`}`
440		623
441		624
442	`public void AddNameLinkElement()`	625	`public static void AddNameLinkElement()`
443	`{`	626	`{`

Subversion Repositories DevTools

(root)/EA_DocGen/trunk/EA_DocGen/EA_Utilities.cs – Rev 2104 → 2106