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

The command shows the Document Selector Dialog used for multiple checkout/checkin/approve, for briefcase import/export, etc.

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

Syntax

Visual Basic
Public Function ShowDocumentSelectorDialog ( _ title As String, _ message As String, _ info As String, _ includeLinkedDrawings As Boolean, _ checkForeignDocuments As Boolean, _ uidList As List(Of Integer), _ Optional noTraverseChildren As Boolean = False, _ Optional neverReturnLinkedDocuments As Boolean = False, _ Optional uidsToBePreSelected As List(Of Integer) = Nothing, _ Optional uidsToBePreDisabled As List(Of Integer) = Nothing, _ Optional showParentTree As Boolean = False, _ Optional typeList As List(Of String) = Nothing, _ Optional extraColumnsToShow As List(Of String) = Nothing _ ) As List(Of Integer)

Visual Basic

Public Function ShowDocumentSelectorDialog ( _

title As String, _
message As String, _
info As String, _
includeLinkedDrawings As Boolean, _
checkForeignDocuments As Boolean, _
uidList As List(Of Integer), _
Optional noTraverseChildren As Boolean = False, _
Optional neverReturnLinkedDocuments As Boolean = False, _
Optional uidsToBePreSelected As List(Of Integer) = Nothing, _
Optional uidsToBePreDisabled As List(Of Integer) = Nothing, _
Optional showParentTree As Boolean = False, _
Optional typeList As List(Of String) = Nothing, _
Optional extraColumnsToShow As List(Of String) = Nothing _
) As List(Of Integer)

C#
public List<int> ShowDocumentSelectorDialog( string title, string message, string info, bool includeLinkedDrawings, bool checkForeignDocuments, List<int> uidList, bool noTraverseChildren = false, bool neverReturnLinkedDocuments = false, List<int> uidsToBePreSelected = null, List<int> uidsToBePreDisabled = null, bool showParentTree = false, List<string> typeList = null, List<string> extraColumnsToShow = null )

public List<int> ShowDocumentSelectorDialog(

string title,
string message,
string info,
bool includeLinkedDrawings,
bool checkForeignDocuments,
List<int> uidList,
bool noTraverseChildren = false,
bool neverReturnLinkedDocuments = false,
List<int> uidsToBePreSelected = null,
List<int> uidsToBePreDisabled = null,
bool showParentTree = false,
List<string> typeList = null,
List<string> extraColumnsToShow = null
)

Visual C++
public: List<int>^ ShowDocumentSelectorDialog( String^ title, String^ message, String^ info, bool includeLinkedDrawings, bool checkForeignDocuments, List<int>^ uidList, bool noTraverseChildren = false, bool neverReturnLinkedDocuments = false, List<int>^ uidsToBePreSelected = nullptr, List<int>^ uidsToBePreDisabled = nullptr, bool showParentTree = false, List<String^>^ typeList = nullptr, List<String^>^ extraColumnsToShow = nullptr )

Visual C++

public:

List<int>^ ShowDocumentSelectorDialog(
String^ title,
String^ message,
String^ info,
bool includeLinkedDrawings,
bool checkForeignDocuments,
List<int>^ uidList,
bool noTraverseChildren = false,
bool neverReturnLinkedDocuments = false,
List<int>^ uidsToBePreSelected = nullptr,
List<int>^ uidsToBePreDisabled = nullptr,
bool showParentTree = false,
List<String^>^ typeList = nullptr,
List<String^>^ extraColumnsToShow = nullptr
)

JavaScript
function showDocumentSelectorDialog(title, message, info, includeLinkedDrawings, checkForeignDocuments, uidList, noTraverseChildren, neverReturnLinkedDocuments, uidsToBePreSelected, uidsToBePreDisabled, showParentTree, typeList, extraColumnsToShow);

Parameters

title

Type: System.String
title of the dialog

message

Type: System.String
explaining message

info

Type: System.String
additional info

includeLinkedDrawings

Type: System.Boolean
false: exclude any linked drawing
true:include any linked drawing

checkForeignDocuments

Type: System.Boolean
false: enable the row if the document is foreign
true: disable the row if the document is foreign

uidList

Type: System.Collections.Generic.List(Int32)
A list of the document unique ids to be listed in the Selector dialog

noTraverseChildren (Optional)

Type: System.Boolean
false: traverses children tree
true: avoids the recursion through all the document's children - useful for "drawings only" lists

neverReturnLinkedDocuments (Optional)

Type: System.Boolean
false: returns also document linked to selected ones (e.g. configs)
true: doesn't return linked documents

uidsToBePreSelected (Optional)

Type: System.Collections.Generic.List(Int32)
A list of values to be shown as already selected in the displayed dialog.

uidsToBePreDisabled (Optional)

Type: System.Collections.Generic.List(Int32)
A list of values to be shown as already disabled in the displayed dialog.

showParentTree (Optional)

Type: System.Boolean
false: do not show the parent tree of the current passed uid(s)
true: show the parent tree of the current passed uid(s)

typeList (Optional)

Type: System.Collections.Generic.List(String)
A lists of the types T of the Documents that must be displayed, with a format like: 'A','P','D','G','0' and any combination of the above.

extraColumnsToShow (Optional)

Type: System.Collections.Generic.List(String)
A list of database fields

Return Value

A list of selected or linked uids