.NET Framework Class Library
TraverseProjectsAssemblies.GetDrawings Method

<< Click to Display Table of Contents >>

Navigation:  MwPDMApi Namespace > TraverseProjectsAssemblies Class > TraverseProjectsAssemblies Methods >

.NET Framework Class Library
TraverseProjectsAssemblies.GetDrawings Method

Retrieves all drawings associated with a specified document UID and adds them to the internal collection. The method identifies parent drawings of the document and processes them based on their components. It supports an optional parameter to detect the document in all containing drawings.

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

Syntax

Visual Basic

Public Function GetDrawings ( _

 uid As String, _
 Optional detectModelInDrawingsRegardlessPosition As Boolean = False _
As Integer

C#

public int GetDrawings(

 string uid,
 bool detectModelInDrawingsRegardlessPosition = false
)

Visual C++

public:

int GetDrawings(
 Stringuid,
 bool detectModelInDrawingsRegardlessPosition = false
)

JavaScript

function getDrawings(uiddetectModelInDrawingsRegardlessPosition);

Parameters

uid

Type: System.String
The unique identifier of the document to retrieve drawings for.

detectModelInDrawingsRegardlessPosition (Optional)

Type: System.Boolean
Optional. If set to True, 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 component list (ordered by increasing uid).Default is False.

Return Value

The number of drawings found and added to the internal collection. Returns 0 if no drawings are found or if the UID is invalid.

Remarks

- The method queries the database to find parent drawings of the specified document. - Drawings are added to the collection if they meet the specified criteria: - If a drawing has only one component, it is added. - If the document matches the first component in the drawing (or all components if the optional parameter is True), it is added. - Ensures only relevant drawings are processed and stored.

See Also

TraverseProjectsAssemblies Class

TraverseProjectsAssemblies Members

MwPDMApi Namespace