Rename Browser nodes from an Assembly and all Parts

https://beinginventive.typepad.com/being-inventive/2011/05/exporting-all-level-bom-from-inventor.html

Hallo everybody,

last time i found a small iLogic-Code to rename the Display Name of an Inventor-Part

oDoc = ThisApplication.ActiveDocument
oDoc.DisplayName = iProperties.Value("Project", "Part Number") &  " - " & iProperties.Value("Project", "Description")
MessageBox.Show("Displayname = " & oDoc.DisplayName, "iLogic")

now it would be nice to do this from a top of an assembly for all instances of the assembly.

I found same codes for other ilogics, but i'm not a profi about ilogic.

So here is my question. Is it possible to change all display names from components of an assembly and the display name of the assembly.

I know there are other posts in the community, but i didn't find an answer

Jörg

Re: Rename Browser nodes from an Assembly and all Parts

Here's a small VBA macro that should do what you want.

Public Sub ChangeDisplayName()
    Dim asmDoc As AssemblyDocument
    Set asmDoc = ThisApplication.ActiveDocument
    
    ' Change the name for the assembly.
    asmDoc.DisplayName = BuildName(asmDoc)
    
    ' Change the name in every referenced document.
    Dim doc As Document
    For Each doc In asmDoc.AllReferencedDocuments
        doc.DisplayName = BuildName(doc)
    Next
End Sub

Private Function BuildName(doc As Document) As String
    Dim name As String
    Dim designTrackProps As PropertySet
    Set designTrackProps = doc.PropertySets.Item("Design Tracking Properties")
    
    name = designTrackProps.Item("Part Number").Value & " - " & _
           designTrackProps.Item("Description").Value
           
    BuildName = name
End Function

Re: Rename Browser nodes from an Assembly and all Parts

Hi,

Yes this should be possible. I am not finding a complete example that does what you want to do however.

The VBA procedure QueryModelTree() in the help file iterates through the browser model tree of an open part or assembly document, printing the node labels to the VBA debug screen (the "Immediate" window in VBA, if enabled).

Your code would need to do something similar. When it finds a node that you want to rename you would have to get the native object and change the DisplayName or name property for proxies. You can't just change the label.

This is from from the API help:

>> >>

BrowserNodeDefinition Object
Label
Property that gets the label of the BrowserNode. This is the string that is displayed to the user. In the case of BuiltIns, this Label is really a reflection of the corresponding name held by the underlying data - for example, a Sketch or a WorkPlane object. In order to set the Label of a ClientBrowserNodeDefinition, see SetLabel on that object.
<< <<

I tried a quick example. Here is a VBA code snippet. This is just to show what objects in the API you could use to get the native object that needs to change the display. (recurse is part of the QueryModelTree() VBA example in the help) 

Sub recurse(node As BrowserNode)
    If (node.Visible = True) Then
       ' Debug.Print node.BrowserNodeDefinition.Label
       
        Dim oNativeObj As Object
        Set oNativeObj = node.NativeObject
       
        Debug.Print TypeName(oNativeObj)
        Dim oDoc As Document
        Dim oAsmCompDef As AssemblyComponentDefinition
        Dim oCompOcc As ComponentOccurrence
        Dim oCompOccproxy As ComponentOccurrenceProxy
        
        If TypeName(oNativeObj) = "AssemblyComponentDefinition" Then
            Set oAsmCompDef = node.NativeObject
            Set oDoc = oAsmCompDef.Document
            oDoc.DisplayName = "WB"
        End If

       

        If TypeName(oNativeObj) = "ComponentOccurrenceProxy" Then
            Set oCompOccproxy = node.NativeObject
            oCompOccproxy.name = "WB_Test"
        End If

Once you have the VBA code working you can move it to .NET and then to iLogic. This is what I usually do. Prototyping in VBA is a way to quickly get things working. Pasting VBA code to a VB.NET module removes the Set statements and gets you closer to what iLogic will want the code to be. (iLogic rules can run VB.NET code).

Replace the File Reference by Inventor API

Before Inventor 10 (including) the ReferenceFileDescriptor.PutCustomLogicalUsingFull was the method used to replace the file reference and this method was only allowed in Apprentice on non-migrating data sets.

But after Inventor 10, there is a new object called file object is introduced, where each File object will contain one or more documents. Now document is not the same as file anymore where the documents are still represented by the various document objects. So, hereafter instead of using ReferenceFileDescriptor.PutLogicalFilenameUsingFull we need to use FileDescriptor.ReplaceReference.

Significantly, FileDescriptor.ReplaceReference is available inside Inventor as well as in Apprentice.

Following is a part of VBA code which shows how to use the FileDescriptor.ReplaceReference with apprentice API:

Dim oApprentice As ApprenticeServerComponent


Set oApprentice = New ApprenticeServerComponent


Dim oADoc As ApprenticeServerDocument


Set oADoc = oApprentice.Open("C:\Assembly1.iam")


Dim oFD As FileDescriptor


Set oFD = oADoc.File.ReferencedFileDescriptors(1)


Call oFD.ReplaceReference("C:\Part2.ipt")

Call oApprentice.FileSaveAs.AddFileToSave(oADoc, oADoc.FullFileName)


Call oApprentice.FileSaveAs.ExecuteSave

And this is a part of VBA code that does the same with Inventor API:

Dim oDoc As Inventor.DrawingDocument 
Set oDoc = ThisApplication.Documents.Open("C:\Assembly1.iam")

oDoc.File.ReferencedFileDescriptors(1).ReplaceReference("C:\Part2.ipt")

Note: For a file to be valid as a replacement it must have the same heritage as the file being replaced. You cannot replace a file with a brand new file. It has to be copied or modified from the already existing file - they must have shared the same ancestor in their past.

Comments

nina.gogeshvili@business-consulting.de said...

Error: oDoc is not a Drawing.Document. it's a .iam Document. So

Dim oDoc As Inventor.Document is better :D

greetz 
Nina

Reply10/26/2012 at 03:44 AM

Matt said...

It should say Inventor.AssemblyDocument I think

Sub ChangeFileNameReferencedFromAssembly()
  Dim asmDoc As AssemblyDocument
  Set asmDoc = ThisApplication.ActiveDocument
  
  Dim asmCompDef As AssemblyComponentDefinition
  Set asmCompDef = asmDoc.ComponentDefinition
  
  Dim asmOcc As ComponentOccurrence
  Set asmOcc = asmCompDef.Occurrences(1)
  
  Dim partDoc As PartDocument
  Set partDoc = asmOcc.Definition.Document
  
  Dim fileMgr As FileManager
  Set fileMgr = ThisApplication.FileManager
  
  Dim oldFileName As String
  oldFileName = partDoc.FullFileName
  
  ' Create new file with new file name
  Dim newFileName As String
  newFileName = oldFileName + "_new.ipt"
  
  Call fileMgr.CopyFile(oldFileName, newFileName)
  
  ' Change reference
  ' The file you replace the reference to needs
  ' to be the same file or one derived from the
  ' original file
  Call asmOcc.ReferencedDocumentDescriptor. _
    ReferencedFileDescriptor.ReplaceReference(newFileName)
      
  ' Delete the original file (if you want)
  Call fileMgr.DeleteFile(oldFileName)
End Su

change Referance file name VBA

change Referance file name VBA

hi
i want to change name of files referanced iam file
i write code but give me error (Wrong number of arguments or invaild property assignment)
how do you change referance files name
thanks

Private Sub Form_Load()
Dim invApprentice As New ApprenticeServerComponent
Dim odoc As ApprenticeServerDocument
Set odoc = invApprentice.Open("C:\Altar\Assembly1.iam")


Dim oRefDoc As ApprenticeServerDocument
For Each oRefDoc In odoc.AllReferencedDocuments
oRefDoc.FullFileName = InputBox("Change File Name", "Change")

Next
Set odoc = Nothing
DoEvents

End Sub

Report

Re: change Referance file name VBA

Hi -

You can't change file names that way.

It sounds like you should be looking at ApprenticeServer's FileSaveAs object. Check out the API documentation for this.

There's also some information in the Apprentice Server overview section on this.

Cheers,
Jeff

Report

Re: change Referance file name VBA

hi jeff
thank you very much for answer

are there more Tutorials inventor Apprentice

Merry chrismas

Report

*

Re: change Referance file name VBA

Jeff, the example code from Autodesk does not work. Even the example from
ADN website does not work.

Joe ...


wrote in message 
news:6310790@discussion.autodesk.com...
Hi -

You can't change file names that way.

It sounds like you should be looking at ApprenticeServer's FileSaveAs 
object. Check out the API documentation for this.

There's also some information in the Apprentice Server overview section on 
this.

Cheers,
Jeff

Report

Re: change Referance file name VBA

hi joe
this code is apprentice code, also Apprentice cannot be used within
Inventor’s VBA, so this sample must be run from either Visual Basic or VBA within another product, i.e.

Dim oApprentice As New ApprenticeServerComponent
' Open a document.
Dim oDoc As ApprenticeServerDocument
Set oDoc = oApprentice.Open("C:\Temp\Assembly1.iam")
' Iterate through the references looking for a
' reference to a specific file.
Dim oRefFileDesc As ReferencedFileDescriptor
For Each oRefFileDesc In oDoc.ReferencedFileDescriptors
If oRefFileDesc.FullFileName = "C:\Temp\OldPart.ipt" Then
' Replace the reference.
Call oRefFileDesc.PutLogicalFileNameUsingFull( _ "C:\Temp\NewPart.ipt")
Exit For
End If Next
' Set a reference to the FileSaveAs object.
Dim oFileSaveAs As FileSaveAs
Set oFileSaveAs = oApprentice.FileSaveAs
' Save the assembly.
Call oFileSaveAs.AddFileToSave(oDoc, oDoc.FullFileName)
Call oFileSaveAs.ExecuteSave

Report

in reply to: Kgokhankaya

‎01-07-2010 11:56 PM

Re: change Referance file name VBA

hi joe
this code is apprentice code, also Apprentice cannot be used within
Inventor’s VBA, so this sample must be run from either Visual Basic or VBA within another product, i.e.

Dim oApprentice As New ApprenticeServerComponent
' Open a document.
Dim oDoc As ApprenticeServerDocument
Set oDoc = oApprentice.Open("C:\Temp\Assembly1.iam")
' Iterate through the references looking for a
' reference to a specific file.
Dim oRefFileDesc As ReferencedFileDescriptor
For Each oRefFileDesc In oDoc.ReferencedFileDescriptors
If oRefFileDesc.FullFileName = "C:\Temp\OldPart.ipt" Then
' Replace the reference.
Call oRefFileDesc.PutLogicalFileNameUsingFull( _ "C:\Temp\NewPart.ipt")
Exit For
End If Next
' Set a reference to the FileSaveAs object.
Dim oFileSaveAs As FileSaveAs
Set oFileSaveAs = oApprentice.FileSaveAs
' Save the assembly.
Call oFileSaveAs.AddFileToSave(oDoc, oDoc.FullFileName)
Call oFileSaveAs.ExecuteSave

Re: change Referance file name VBA

Sorry - this code does not work. It fails on the
"PutLogicalFilenameUsingFull" method.

I am running it in VB6SP6 with IV2010 loaded.

Joe ...


wrote in message news:6314748@discussion.autodesk.com...
hi joe
this code is apprentice code, also Apprentice cannot be used within
Inventor's VBA, so this sample must be run from either Visual Basic or VBA 
within another product, i.e.

Dim oApprentice As New ApprenticeServerComponent
' Open a document.
Dim oDoc As ApprenticeServerDocument
Set oDoc = oApprentice.Open("C:\Temp\Assembly1.iam")
' Iterate through the references looking for a
' reference to a specific file.
Dim oRefFileDesc As ReferencedFileDescriptor
For Each oRefFileDesc In oDoc.ReferencedFileDescriptors
If oRefFileDesc.FullFileName = "C:\Temp\OldPart.ipt" Then
' Replace the reference.
Call oRefFileDesc.PutLogicalFileNameUsingFull( _ 
"C:\Temp\NewPart.ipt")
Exit For
End If Next
' Set a reference to the FileSaveAs object.
Dim oFileSaveAs As FileSaveAs
Set oFileSaveAs = oApprentice.FileSaveAs
' Save the assembly.
Call oFileSaveAs.AddFileToSave(oDoc, oDoc.FullFileName)
Call oFileSaveAs.ExecuteSave

Report

Re: change Referance file name VBA

hi
you must generate C:\Temp\Assembly1.iam (include oldpart.ipt) then you must generate newpart.ipt on C:\Temp\
if you do thıs it is run
maybe you have add referance to vba6 "autodesk inventor's appreance object library"

iProperty Object Model Inventor

Accessing iProperties

Probably the most used area of Inventor’s API is iProperties and because of that it generates more questions than any other single area.  I wanted to try and eliminate some of those questions by giving a brief overview of how to access iProperties that I hope will answer most questions.  Because iProperties is relatively simple it’s also a very good introduction to Inventor’s API.  In the example below we’ll look at what it takes to edit the value of the Part Number property.

iProperty Object Model When working with Inventor’s API you need to be aware of the Object Model.  The object model describes the relationship between the various API objects and is used to understand how to gain access to a particular object.  Inventor’s entire object model is quite large and can be a bit overwhelming, which can be seen below.  (Click the picture to access the pdf file of the entire chart.)

However, when programming with Inventor you don’t need to understand the entire object model, but just the portion of the model that you’re currently using.  When working with iProperties you’ll be using a maximum of only six different objects.  A simplified version of the object model for these six objects is shown below.

The Application object is the top-level object and represents Inventor.  From it you can get the Documents object which provides the ability to access any open documents and also to open documents and create new documents.  The Document object represents any of the various Inventor documents, i.e. part, assembly, drawing, etc.  From the object model chart we learn that the PropertySets object is accessed from a document.  This implies that properties are owned by a document and each document has its own unique set.

Accessing a Document There are several ways to access a specific document but for this example I’ll keep it simple by accessing the document that’s currently open for edit.  This is also the most common way of accessing a document.  You do this by using the ActiveDocument property of the Application object.  Looking at the object model chart above, using this property takes you from the Application object and jumps directly to the Document object, bypassing the Documents object.  The code for this is shown below.

Public Sub ReadiProperty() 
    ' Get the active document. 
    Dim oDoc As Document 
    Set oDoc = ThisApplication.ActiveDocument 
End Sub

Accessing iProperties 
From each document you can access its associated iProperties.  iProperties are organized in groups and the API provides access to these groups.  The first iProperty related object is the PropertySets object.  You can think of the PropertySets object as the equivalent to the iProperties dialog.  It’s the top level that provides access to all iProperty information.

The code below shows how to get the PropertySets object.

Public Sub ReadiProperty() 
    ' Get the active document.     Dim oDoc As Document 
    Set oDoc = ThisApplication.ActiveDocument 

    ' Get the PropertySets object.     Dim oPropSets As PropertySets 
    Set oPropSets = oDoc.PropertySets 
End Sub

The next object in the object model is the PropertySet object.  You can think of this object as being equivalent to a tab in the iProperties dialog. 

There’s a little more to worry about when accessing the PropertySet object because you have to specify which of the existing PropertySet objects you want.  There are a few different ways to do this but I would recommend using the name of the PropertySet.  This makes your code easier to read later.  The names of the standard property sets are:

Inventor Document Summary Information 
Inventor Summary Information 
Design Tracking Properties 
Inventor User Defined Properties

For this sample I want to get the value of the Part Number property.  This is in the “Design Tracking Properties” property set (as determined by looking at the chart at the end of this post).  The code below illustrates getting this property set by name.

Public Sub ReadiProperty() 
    ' Get the active document.     Dim oDoc As Document 
    Set oDoc = ThisApplication.ActiveDocument 

    ' Get the PropertySets object.     Dim oPropSets As PropertySets 
    Set oPropSets = oDoc.PropertySets 

    ' Get the design tracking property set.     Dim oPropSet As PropertySet 
    Set oPropSet = oPropSets.Item("Design Tracking Properties") 
End Sub

The next object is the Property object.  This represents a specific property, as illustrated below.

Properties are also identified by name.  The code below demonstrates accessing the part number property.

Public Sub ReadiProperty() 
    ' Get the active document.     Dim oDoc As Document 
    Set oDoc = ThisApplication.ActiveDocument 

    ' Get the PropertySets object.     Dim oPropSets As PropertySets 
    Set oPropSets = oDoc.PropertySets 

    ' Get the design tracking property set.     Dim oPropSet As PropertySet 
    Set oPropSet = oPropSets.Item("Design Tracking Properties") 

    ' Get the part number iProperty.     Dim oPartNumiProp As Property 
    Set oPartNumiProp = oPropSet.Item("Part Number") 
End Sub

Once you have a Property object you can use its Value property to get its current value and to also set the value is you want to change the iProperty.  The code below displays the part number of the active document in a message box.

Public Sub ReadiProperty() 
    ' Get the active document.     Dim oDoc As Document 
    Set oDoc = ThisApplication.ActiveDocument 

    ' Get the PropertySets object.     Dim oPropSets As PropertySets 
    Set oPropSets = oDoc.PropertySets 

    ' Get the design tracking property set.     Dim oPropSet As PropertySet 
    Set oPropSet = oPropSets.Item("Design Tracking Properties") 

    ' Get the part number iProperty.     Dim oPartNumiProp As Property 
    Set oPartNumiProp = oPropSet.Item("Part Number") 

    ' Display the value.     MsgBox "The part number is: " & oPartNumiProp.Value 
End Sub

This code changes the value of the part number property.

Public Sub SetiProperty() 
    ' Get the active document.     Dim oDoc As Document 
    Set oDoc = ThisApplication.ActiveDocument 

    ' Get the PropertySets object.     Dim oPropSets As PropertySets 
    Set oPropSets = oDoc.PropertySets 

    ' Get the design tracking property set.     Dim oPropSet As PropertySet 
    Set oPropSet = oPropSets.Item("Design Tracking Properties") 

    ' Get the part number iProperty.     Dim oPartNumiProp As Property 
    Set oPartNumiProp = oPropSet.Item("Part Number") 

    ' Set the part number.     oPartNumiProp.Value = "SamplePart001" 
End Sub

Accessing an iProperty is simply of a matter of navigating down the object model to get to a specific Property object.  The tricky parts is knowing which property set the property you want is located in, and knowing the name of that property set and the name of the property.  The table below lists all of the standard property sets and the names of the properties they contain.  This should provide all you need to access existing properties.  In addition to the names, the chart also lists the type of each property.  This is important when setting the value of a property so you know what type is expected.

Inventor Summary Information
Property Name	Type
Author	String
Comments	String
Keywords	String
Last Saved By	String
Thumbnail	IPictureDisp
Revision Number	String
Subject	String
Title	String
Inventor Document Summary Information
Property Name	Type
Category	String
Company	String
Manager	String
Design Tracking Properties
Property Name	Type
Authority	String
Catalog Web Link	String
Categories	String
Checked By	String
Cost	Currency
Cost Center	String
Creation Time	Date
Date Checked	Date
Defer Updates	Boolean
Description	String
Design Status	Long
Designer	String
Document SubType	String
Document SubType Name	String
Engineer	String
Engr Approved By	String
Engr Date Approved	Date
External Property Revision Id	String
Language	String
Manufacturer	String
Material	String
Mfg Approved By	String
Mfg Date Approved	Date
Parameterized Template	Boolean
Part Icon	IPictureDisp
Part Number	String
Part Property Revision Id	String
Project	String
Proxy Refresh Date	Date
Size Designation	String
Standard	String
Standard Revision	String
Standards Organization	String
Stock Number	String
Template Row	String
User Status	String
Vendor	String
Weld Material	String
Inventor User Defined Properties

Posted at 06:14 PM in Brian, iProperties | Permalink

  

Comments

Brad Johnson said...

When I run the following code in VB6 
Private Sub Form_Load()
Call GetActiveDocument
End Sub
Public Sub GetActiveDocument()
' Get the active document.
Dim oDoc As Document
Set oDoc = ThisApplication.ActiveDocument
MsgBox "Got " & oDoc.FullFileName
End Sub
'
I get the following error
Run-time error '429':
ActiveX component can't create object
Can you tell me why?

ReplyOctober 06, 2010 at 02:30 PM

Tommy Rosberg said...

A quick question:
I can see in the table that some iProperty categories have the word 'Inventor' added to their name. The category earlier called 'Summary Information' is now called 'Inventor Summary Information'. Have I understood this correct?

Best regards,
Tommy Rosberg
Avalon PLM AB