UpdatePathfinder Method

Description

This method provides automation functionality to update the assembly pathfinder by either refreshing the icons for each existing entry or by completely rebuilding the pathfinder.

Syntax

Visual Basic
Public Sub UpdatePathfinder( _ ByVal UpdateType As AssemblyPathfinderUpdateConstants _ )

Parameters

UpdateType

Value	Description
seRebuild	Locks and clears Pathfinder, but actually rebuilds Pathfinder during next idle cycle. It is possible that an automation could do something to affect the “shape” of the assembly. An interactive example of this is deleting a subassembly. Since such edits can be difficult to reflect in the pathfinder, it is sometimes preferable to simply rebuild the entire pathfinder. This will ensure that the rebuild pathfinder will match the previous state as closely as possible with respect to scroll position and expand/collapse settings. Please note that the request to rebuild is lazy. In that the pathfinder will be rebuilt at a safe time after the API request, typically when the application is at idle.
seResume	seSuspend/seResume pair should be used to bracket long sequences of actions in which performance trumps accuracy.
seSuspend	The seSuspend call will clear the pathfinder (as happens with seRebuild) and remain so until this suspension is lifted via seResume.
seUpdate	Refreshes the Pathfinder immediately. Refreshing the icons can be necessary if something happens, for example, to change the visibility (show/hide) or load state (active/inactive) of a reference. It is possible that some automation could affect the assembly in a manner such that the normal icon update logic is skipped. This is appropriate for refreshing the icons in such cases. Calling UpdatePathfinder with seUpdate is very quick and its results are applied to the pathfinder before the call returns.

Member of AssemblyPathfinderUpdateConstants. Specifies the type of update to Assembly Pathfinder.

Example

Example (VB.NET)

Public Class UpdatePathFinder

    Private Sub UpdatePathFinder_Load(sender As System.Object, e As System.EventArgs) Handles MyBase.Load
        Dim oApp As SolidEdgeFramework.Application = Nothing
        Dim oView As SolidEdgeFramework.View = Nothing
        Dim oDoc As SolidEdgeAssembly.AssemblyDocument = Nothing

        Try
            oApp = GetObject(, "SolidEdge.Application")
            oDoc = oApp.ActiveDocument
            oDoc.UpdatePathfinder(SolidEdgeAssembly.AssemblyPathfinderUpdateConstants.seUpdate)
        Catch ex As Exception
            MsgBox(ex.ToString)
        End Try
    End Sub
End Class