{"id":3305,"date":"2018-12-03T06:26:50","date_gmt":"2018-12-03T14:26:50","guid":{"rendered":"https:\/\/blogs.plm.automation.siemens.com\/t5\/Solid-Edge-Blog\/Adding-Metadata-to-Solid-Edge-Objects-Using-the-API\/ba-p\/547369"},"modified":"2020-05-07T14:22:22","modified_gmt":"2020-05-07T18:22:22","slug":"adding-metadata-to-solid-edge-objects-using-the-api","status":"publish","type":"post","link":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/adding-metadata-to-solid-edge-objects-using-the-api\/","title":{"rendered":"Adding Metadata to Solid Edge Objects Using the API"},"content":{"rendered":"

Textual information in the form of metadata can be added in Solid Edge in various ways:<\/P><\/p>\n


    \n
  1. File Properties<\/A> – can be added and accessed both manually and programmatically.<\/LI>
    \n
  2. Block Labels – Limited to the Draft environment and can be hidden if required.<\/LI>
    \n
  3. Property Tables – These are found on the Tools tab of the ribbon, Properties group, in the Part and Sheetmetal environments. Custom properties can be defined in a tabular format which can then be attached to geometrical objects like edges or faces. This information can also be queried, both interactively and using the API.<\/LI>
    \n<\/OL><\/p>\n

    All of the above information is accessible to the end user by one means or the other though.<\/P><\/p>\n

    There are often scenarios in programming where information needs to be attached to geometrical entities in Solid Edge and retrieved without being exposed to the user. Attribute sets can be used for this as described in this article.<\/P>
    \n

    \"MetaData3.png\"<\/span><\/P><\/p>\n

    To attach an attribute set called “RouteDataSet” to an object, say a Line2d:<\/P><\/p>\n

    Dim seAttrSet As Object = Nothing<\/p>\n
    seAttrSet = seLine2d.AttributeSets.Add(“RouteDataSet”)<\/PRE><\/p>\n
    \"TipIcon.png\"<\/span>Note<\/STRONG>: Besides this, AttributeSets has the usual Remove and Item methods and the Count property.<\/P><\/p>\n
    Declare datasets and assign values to add to the attribute set:<\/P><\/p>\n
    Dim sData As String = String.Empty
    \nDim bData As Boolean = False
    \nDim iData As Integer = 0<\/p>\n
    sData = “GTR001N4”
    \nbData = True
    \niData = 155<\/PRE><\/p>\n
    Add each type of data to the set using the appropriate attribute type constant:<\/P><\/p>\n
    seAttrSet.Add(“RouteName<\/STRONG>“, SolidEdgeConstants.AttributeTypeConstants.seStringANSI)
    \nseAttrSet.RouteName<\/STRONG> = sData<\/p>\n
    seAttrSet.Add(“IncludedInPaintCalculations<\/STRONG>“,SolidEdgeConstants.AttributeTypeConstants.seBoolean)
    \nseAttrSet.IncludedInPaintCalculations<\/STRONG> = bData
    \n 
    \nseAttrSet.Add(“EstimatedLength<\/STRONG>“, SolidEdgeConstants.AttributeTypeConstants.seInteger)
    \nseAttrSet.EstimatedLength<\/STRONG> = iData<\/PRE><\/p>\n
    Note how the first String argument which is the name of the attribute set automatically becomes a property on the next line when assigning it a value. This facilitates adding any number of named attributes to a set.<\/P><\/p>\n
    The other data types are:<\/P><\/p>\n
    \"AA02.png\"<\/span><\/P><\/p>\n
    \"TipIcon.png\"<\/span>Note<\/STRONG>: Besides this, the AttributeSet has the usual Remove and Item methods and the Count and SetName properties where the later returns the name of an attribute set.<\/P><\/p>\n
    To check the existence of an attribute set on an object, an additional method called IsAttributeSetPresent can be used:<\/P><\/p>\n
    If seLine2d.IsAttributeSetPresent(“RouteDataSet”) Then
    \n  seAttrSet = seLine2d.AttributeSets(“RouteDataSet”)<\/p>\n
      seAttribute = seAttrSet(“RouteName”)
    \n  sData = seAttribute.Value()
    \n 
    \n  seAttribute = seAttrSet(“IncludedInPaintCalculations”)
    \n  bData = seAttribute.Value()
    \n 
    \n  seAttribute = seAttrSet(“EstimatedLength”)
    \n  iData = seAttribute.Value()
    \nEnd If<\/PRE><\/p>\n
    Here’s a simple application to illustrate attribute sets:<\/P><\/p>\n
    \"AA05.png\"<\/span><\/P><\/p>\n
    And the source code is as below. Try this with a line selected on a drawing sheet:<\/P><\/p>\n
    Imports SolidEdgeFramework
    \nImports SolidEdgeFrameworkSupport
    \n 
    \nPublic Class Form1
    \n 
    \n       Dim seApp As SolidEdgeFramework.Application = Nothing
    \n       Dim seDoc As SolidEdgeDocument = Nothing
    \n 
    \n       Dim seSel As SelectSet = Nothing
    \n       Dim seLine2d As Line2d = Nothing
    \n 
    \n       Dim seAttrSet As Object = Nothing
    \n       Dim seAttribute As Object = Nothing
    \n 
    \n       Dim sData As String = String.Empty
    \n       Dim bData As Boolean = False
    \n       Dim iData As Integer = 0
    \n 
    \n       Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
    \n              seApp = Runtime.InteropServices.Marshal.GetActiveObject(“SolidEdge.Application”)
    \n              seDoc = seApp.ActiveDocument
    \n       End Sub
    \n 
    \n       Private Sub Button1_Click(sender As Object, e As EventArgs) Handles Button1.Click
    \n              seSel = seDoc.SelectSet
    \n              seLine2d = seSel.Item(1)
    \n 
    \n              seAttrSet = seLine2d.AttributeSets.Add(“RouteDataSet”)
    \n 
    \n              sData = “GTR001N4”
    \n              bData = True
    \n              iData = 155
    \n 
    \n              seAttrSet.Add(“RouteName”, SolidEdgeConstants.AttributeTypeConstants.seStringANSI)
    \n              seAttrSet.RouteName = sData
    \n 
    \n              seAttrSet.Add(“IncludedInPaintCalculations”, SolidEdgeConstants.AttributeTypeConstants.seBoolean)
    \n              seAttrSet.IncludedInPaintCalculations = bData
    \n 
    \n              seAttrSet.Add(“EstimatedLength”, SolidEdgeConstants.AttributeTypeConstants.seInteger)
    \n              seAttrSet.EstimatedLength = iData
    \n       End Sub
    \n 
    \n       Private Sub Button2_Click(sender As Object, e As EventArgs) Handles Button2.Click
    \n              seSel = seDoc.SelectSet
    \n              seLine2d = seSel.Item(1)
    \n 
    \n              If seLine2d.IsAttributeSetPresent(“RouteDataSet”) Then
    \n                     seAttrSet = seLine2d.AttributeSets(“RouteDataSet”)
    \n 
    \n                     seAttribute = seAttrSet(“RouteName”)
    \n                     sData = seAttribute.Value()
    \n 
    \n                     seAttribute = seAttrSet(“IncludedInPaintCalculations”)
    \n                     bData = seAttribute.Value()
    \n 
    \n                     seAttribute = seAttrSet(“EstimatedLength”)
    \n                     iData = seAttribute.Value()
    \n 
    \n                     MessageBox.Show(“String Data = ” & sData & vbCrLf &
    \n                                     “Boolean Data = ” & bData & vbCrLf &
    \n                                     “Numerical Data = ” & iData & vbCrLf
    \n                                    )
    \n              End If
    \n       End Sub
    \nEnd Class<\/PRE><\/p>\n
    Most graphics objects support AttributeSets in the Part, Sheetmetal, Draft and Assembly environments. Some common examples are:<\/P><\/p>\n

      \n
    1. Part<\/STRONG>: Sketch, Line2d, Circle2d, Arc2d, Profile, CoordinateSystem, RefPlane, etc.<\/LI>
      \n
    2. Assembly<\/STRONG>: All those from Part and additionally GroundRelation, Occurrence, Tube, Wire, AsmRefPlane, etc.<\/LI>
      \n
    3. Draft<\/STRONG>: DrawingView, Layer, Group, Sheet, etc.<\/LI>
      \n<\/OL><\/p>\n
      \"TipIcon.png\"<\/span>Tip<\/STRONG>: Solid Edge Document objects themselves do not directly support attribute sets but there is an easy way to store attributes at the document level. Here are some suggestions. Use the 2D Model Sheet in Draft and the base coordinate systems in the 3D environments since these objects are guaranteed in the respective file types. Read an article on how to access the 2D Model Sheet using the API here<\/A>.<\/P><\/p>\n
      Another important feature of the attributes scheme is querying which can be done at the document level. To assess how many objects have the “RouteDataSet” attribute set in a document:<\/P><\/p>\n
      Dim seRouteObjects As SolidEdgeFramework.QueryObjects = 
      seDocument.AttributeQuery.AttributeQuery.QueryByName(“RouteDataSet”, “RouteName”)
      \n<\/PRE><\/p>\n
      Then you can count the number of objects and access an item:<\/P>
      \n
        <\/P>
      \n
      seRouteObjects.Count
      \nseRouteObjects.Item<\/PRE><\/p>\n
      The Revision Notes app<\/A> also uses attribute sets extensively, for example, to differentiate a revision note group from other groups.<\/P>
      \n
       \"03.png\"<\/span><\/P><\/p>\n
      Hope you find many uses for this hidden gem of the Solid Edge API in your apps as well.<\/P><\/p>\n
      ~Tushar Suradkar<\/P>
      \n
      www.SurfAndCode.IN<\/A><\/P>
      \n
      www.CADVertex.com<\/A><\/P><\/p>\n","protected":false},"excerpt":{"rendered":"
       
      \n Textual information in the form of metadata can be added in Solid Edge in various ways: <\/p>\n
       File Properties – can be added and accessed both manually and programmatically.
      \n Bl…<\/p>\n","protected":false},"author":42979,"featured_media":3323,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"spanish_translation":"","french_translation":"","german_translation":"","italian_translation":"","polish_translation":"","japanese_translation":"","chinese_translation":"","footnotes":""},"categories":[1,183,96],"tags":[33],"industry":[],"product":[],"coauthors":[],"class_list":["post-3305","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-news","category-product-updates","category-tips-tricks","tag-developer"],"featured_image_url":"https:\/\/blogs.stage.sw.siemens.com\/wp-content\/uploads\/sites\/8\/2019\/09\/03-1.png","_links":{"self":[{"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/posts\/3305","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/users\/42979"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/comments?post=3305"}],"version-history":[{"count":6,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/posts\/3305\/revisions"}],"predecessor-version":[{"id":3324,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/posts\/3305\/revisions\/3324"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/media\/3323"}],"wp:attachment":[{"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/media?parent=3305"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/categories?post=3305"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/tags?post=3305"},{"taxonomy":"industry","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/industry?post=3305"},{"taxonomy":"product","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/product?post=3305"},{"taxonomy":"author","embeddable":true,"href":"https:\/\/blogs.stage.sw.siemens.com\/solidedge\/wp-json\/wp\/v2\/coauthors?post=3305"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}