.NET Framework Class Library
Document Members

<< Click to Display Table of Contents >>

Navigation:  Programming Mechworks PDM > .NET API > MwPDMApi Namespace > Document Class >

.NET Framework Class Library
Document Members

The Document type exposes the following members.

Methods

 

Name

Description

Public method

AddDocument

Links as a child a document file to the current selected document (that can be a project or any other object selectable through the SelectById).

Public method

CheckIfDrawingExists

Check if a drawing related to the specify part/assembly exists

Public method

CreatePreviewFile

Creates a preview file for the specified document

Public method

CreatePreviewFileFromFullPath

Creates a preview file given the full path of a CAD file.

Public method

DataEntrHelper

Returns the helper object associated with the specified document helper associated to dataentr context. Initializes and returns a new instance of the appropriate DataEntr helper class.

Public method

DocumentFileType

Detects if the document is of the type specified.

Public method

DocumentType

Get MW type of specified document, according to its file extension.

Public method

Equals

(Inherited from Object.)

Protected method

Finalize

(Inherited from Object.)

Public method

GetAssemblyList

Returns a list of assemblies in which the specified document is used.

Public method

GetDocIdFromDrawing

Returns all the document ids contained into a drawing

Public method

GetDocProject

Returns all the projects that a document belongs to.

Public method

GetDocProjectsList

Returns an array of projects that a document belongs to.

Public method

GetDocState

Retrieve the current document state and its revision.

Public method

GetHashCode

(Inherited from Object.)

Public method

GetHiddenFilesList

Retrieves the list of hidden files (revision files, master drawing files, etc. ) that may exist for a particular document.

Public method

GetIdFromFullFileName

Retrieves DocID and DocUid from full file name and a configuration (if specified).

Public method

GetRevisionOutputFiles

Retrieves the list of output files generated for a document for the last revision cycle

Public method

GetRevisionOutputFiles2

Retrieves the list of output files with complete path (or not) generated for a document for the last revision cycle

Public method

GetType

(Inherited from Object.)

Public method

GetUniqueIdListFromFileName

Retrieves the list of configured documents.

Protected method

MemberwiseClone

(Inherited from Object.)

Public method

Open

Opens the currently selected document

Public method

OpenDocument

Opens the currently selected document

Public method

Rename

Renames a file as specified, if no parameter is passed it renames the currently selected document.

Public method

ToString

(Inherited from Object.)

See Also

Document Class

MwPDMApi Namespace