how to run Search Command through API

[liminma8458]

Hi, all,

There is a Search function in Inventor browser:

At the same time, Inventor provides a API command "AppBrowserSearchCmd" for that. But how to use this API command?  I try to use following, but it doesn't work out.

Public Sub Run_Search_Command()
' Get the CommandManager object.
Dim oCommandMgr As CommandManager
Set oCommandMgr = ThisApplication.CommandManager

'Call oCommandMgr.PostPrivateEvent(kNameEvent, "VALPRD09")
'Call oCommandMgr.PostPrivateEvent(kFileNameEvent, "VALPRD09")

Call oCommandMgr.PostPrivateEvent(kStringEvent, "VALPRD09")

' Get control definition for the line command.
Dim oControlDef As ControlDefinition
Set oControlDef = oCommandMgr.ControlDefinitions.Item("AppBrowserSearchCmd")
' Execute the command.
Call oControlDef.Execute
End Sub

So, How to provide input to the API command? And where to get the search result?

[chandra.shekar.g · Accepted solution]

@liminma8458,

Nice question,

In Inventor 2020 API, a new object called "SearchBox" is exposed in BrowserPane. To do your task, try below VBA code to search in box

Sub SearchBoxSample()
    Dim oDoc As Document
    Set oDoc = ThisApplication.ActiveDocument
     
    Dim oPane As BrowserPane
    ' Get the BrowserPane that support the search box.
    If oDoc.DocumentType = kPartDocumentObject Then
        Set oPane = oDoc.BrowserPanes("PmDefault")
    ElseIf oDoc.DocumentType = kAssemblyDocumentObject Then
        Set oPane = oDoc.BrowserPanes("AmBrowserArrangement")
    ElseIf oDoc.DocumentType = kDrawingDocumentObject Then
        Set oPane = oDoc.BrowserPanes("DlHierarchy")
    ElseIf oDoc.DocumentType = kPresentationDocumentObject Then
        Set oPane = oDoc.BrowserPanes("DxHierarchy")
    End If
    
    Dim oSearchBox As SearchBox
    Set oSearchBox = oPane.SearchBox
    
    ' Enable the search box and display it in the broser pane for search text.
    oSearchBox.Enabled = True
    oSearchBox.Visible = True
    Call oSearchBox.Search("VALPRD09")
End Sub

Thanks and regards,

[liminma8458]

Chandra,

Yes, the code works, even in Inventor 2019. I got the search result shown in the browser pane. But how can I get the resulted occurrence information through the API so I can deal with them with program? Looks like Object oSearchBox does not provide such information. Is it?

[chandra.shekar.g · Accepted solution]

@liminma8458,

Try below VBA code to search occurrence in an assembly by mentioning name.

Sub SerachOccurrence()
    Dim oDoc As AssemblyDocument
    Set oDoc = ThisApplication.ActiveDocument
    
    Dim oDef As AssemblyComponentDefinition
    Set oDef = oDoc.ComponentDefinition
    
    Dim occ As ComponentOccurrence
    
    Dim coll As ObjectCollection
    Set coll = ThisApplication.TransientObjects.CreateObjectCollection
    
    For Each occ In oDef.Occurrences
        If InStr(UCase(occ.Name), UCase("VALPRD09")) = 1 Then
            Call coll.Add(occ)
        End If
    Next
    
End Sub

Note: It is tested for one level and can be extended further to get sub occurrences as well.

Thanks and regards