MwPDMApi Namespace > Tree Class > Tree Methods

Traverse a document tree, walking over every instance of the components of an assembly.

Namespace: MwPDMApi
Assembly: MwPDMApi (in MwPDMApi.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Visual Basic
Public Sub WalkTreeAllInstances ( _ docUid As String, _ traverseParent As Boolean, _ Optional clientHook As Object = Nothing, _ Optional queryFilter As String = "" _ )

Visual Basic

Public Sub WalkTreeAllInstances ( _

docUid As String, _
traverseParent As Boolean, _
Optional clientHook As Object = Nothing, _
Optional queryFilter As String = "" _
)

C#
public void WalkTreeAllInstances( string docUid, bool traverseParent, Object clientHook = null, string queryFilter = "" )

public void WalkTreeAllInstances(

string docUid,
bool traverseParent,
Object clientHook = null,
string queryFilter = ""
)

Visual C++
public: void WalkTreeAllInstances( String^ docUid, bool traverseParent, Object^ clientHook = nullptr, String^ queryFilter = L"" )

Visual C++

public:

void WalkTreeAllInstances(
String^ docUid,
bool traverseParent,
Object^ clientHook = nullptr,
String^ queryFilter = L""
)

JavaScript
function walkTreeAllInstances(docUid, traverseParent, clientHook, queryFilter);

Parameters

docUid

Type: System.String
unique id of the root document

traverseParent

Type: System.Boolean
TRUE traverse document parent tree, FALSE traverse document child tree

clientHook (Optional)

Type: System.Object
object providing the UserProcessDocument user-defined method:

Function UserProcessDocument(ByVal appl As Object, ByVal docUid As String, ByVal wtParentUid As String, ByVal wtNesting as Integer) As Boolean

appl: Application object

docUid: unique id of the current tree node

wtParentUid, wtNesting: traversing data (parent unique id and nesting level)

queryFilter (Optional)

Type: System.String
Optional. Further specification for the tree walking (like "AND _condition_")

Remarks

UserProcessDocument is invoked during traverse: return value is used to continue/stop the tree traversing