Programming Mechworks PDM > .NET API > MwPDMApi Namespace > Tree Class > Tree Methods

Retrieves all documents within the tree structure of a specified main document, including assemblies, parts, drawings, and generic documents. This method performs a traversal of the tree Structure, using optimized mechanisms to improve execution speed. It may not traverse all document instances when multiple occurrences exist. Optional traversal of sub-projects and inclusion of drawings are controlled by the specified parameters. This method is recommended when performance is preferred over full instance-level accuracy.

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

Syntax

Visual Basic
Public Function GetAllDocumentsInStructure ( _ MainDocUid As String, _ AddDrawings As Integer, _ TraverseProjects As Boolean, _ Optional detectModelInDrawingsRegardlessPosition As Boolean = False _ ) As TraverseProjectsAssemblies

Visual Basic

Public Function GetAllDocumentsInStructure ( _

MainDocUid As String, _
AddDrawings As Integer, _
TraverseProjects As Boolean, _
Optional detectModelInDrawingsRegardlessPosition As Boolean = False _
) As TraverseProjectsAssemblies

C#
public TraverseProjectsAssemblies GetAllDocumentsInStructure( string MainDocUid, int AddDrawings, bool TraverseProjects, bool detectModelInDrawingsRegardlessPosition = false )

public TraverseProjectsAssemblies GetAllDocumentsInStructure(

string MainDocUid,
int AddDrawings,
bool TraverseProjects,
bool detectModelInDrawingsRegardlessPosition = false
)

Visual C++
public: TraverseProjectsAssemblies^ GetAllDocumentsInStructure( String^ MainDocUid, int AddDrawings, bool TraverseProjects, bool detectModelInDrawingsRegardlessPosition = false )

Visual C++

public:

TraverseProjectsAssemblies^ GetAllDocumentsInStructure(
String^ MainDocUid,
int AddDrawings,
bool TraverseProjects,
bool detectModelInDrawingsRegardlessPosition = false
)

JavaScript
function getAllDocumentsInStructure(MainDocUid, AddDrawings, TraverseProjects, detectModelInDrawingsRegardlessPosition);

Parameters

MainDocUid

Type: System.String
The unique identifier of the main document to process.

AddDrawings

Type: System.Int32
Determines whether to include drawings in the result: 0 = Do not include drawings, 1 = Include only linked drawings, 2 = Include all drawings.

TraverseProjects

Type: System.Boolean
Specifies whether to traverse sub-projects: True = Traverse sub-projects, False = Do not traverse sub-projects.

detectModelInDrawingsRegardlessPosition (Optional)

Type: System.Boolean
Optional. Consider the case where a drawing is related to multiple models. If this parameter is set to True, when processing a document, the method adds the drawing to the drawing's output data collection, regardless wether the document's position is the first one in the drawing's related document list (ordered by increasing uid). Default is False, the drawing is added only if the document's position is the first one in the drawing's related document list.

Return Value

A TraverseProjectsAssemblies object containing the documents data obtaioned by traversing the tree structure.

Remarks

This method initializes a new instance of the TraverseProjectsAssemblies class to perform the traversal.