.NET Framework Class Library
Revision Members

<< Click to Display Table of Contents >>

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

.NET Framework Class Library
Revision Members

The Revision type exposes the following members.

Methods

 

Name

Description

Public method

ActivateRevision

Activates an older revision as current revision.

Public method

Approve

The command displays the default single document approval dialog, with the two choices for approving to the next revision or back to the previous revision.

Public method

CheckIn

Checks in the current open document and closes it

Public method

CheckinFromCheckout

Returns the way the current document has been checkedin.

Public method

CheckOut

Checks out the current selected document and opens it.

Public method

CheckOutAsDifferentUser

Checks-out a document whose unique is id equal to docUid, impersonating the user with name equal to user.

Public method

CheckSavedConfiguration

Queries the MW datasource for the existance of a specific file in configuration.

Public method

Equals

(Inherited from Object.)

Protected method

Finalize

(Inherited from Object.)

Public method

GetGlobaleError

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the current error state related to reading the revision parameters file. A value of 0 indicates success; 1 indicates an error occurred while reading or creating the configuration file.

Public method

GetGlobaleRevPhaseA

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the current enabled/disabled state of revision phase A.

Public method

GetGlobaleRevPhaseAarray

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the phase A revision array as a List(Of String). This list contains all possible revision labels for phase A (typically "Prerelease"), loaded from the configuration file and used to validate and manage prerelease states.

Public method

GetGlobaleRevPhaseAarray_AsObject

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the phase A revision array as an Object. This array contains all possible revision labels for phase A (typically "Prerelease"), loaded from the configuration file and used to validate and manage prerelease states. This method is provided for compatibility with legacy code that expects an Object return type.

Public method

GetGlobaleRevPhaseACap

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the caption/label for revision phase A (typically "Prerelease"). This caption is a human-readable description of phase A, used in user interfaces, reports, or logs to clearly indicate the meaning of the revision phase instead of using only codes or numbers.

Public method

GetGlobaleRevPhaseB

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the current enabled/disabled state of revision phase B.

Public method

GetGlobaleRevPhaseBarray

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the phase B revision array as a List(Of String). This list contains all possible revision labels for phase B (typically "Major"), loaded from the configuration file and used to validate and manage major release states.

Public method

GetGlobaleRevPhaseBarray_AsObject

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the phase B revision array as an Object. This array contains all possible revision labels for phase B (typically "Major"), loaded from the configuration file and used to validate and manage major release states. This method is provided for compatibility with legacy code that expects an Object return type.

Public method

GetGlobaleRevPhaseBCap

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the caption/label for revision phase B (typically "Major"). This caption is a human-readable description of phase B, used in user interfaces, reports, or logs to clearly indicate the meaning of the revision phase instead of using only codes or numbers.

Public method

GetGlobaleRevPhaseC

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the current enabled/disabled state of revision phase C.

Public method

GetGlobaleRevPhaseCarray

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the phase C revision array as a List(Of String). This list contains all possible revision labels for phase C (typically minor revisions), loaded from the configuration file and used to validate and manage minor release states.

Public method

GetGlobaleRevPhaseCarray_AsObject

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the phase C revision array as an Object. This array contains all possible revision labels for phase C (typically "Minor"), loaded from the configuration file and used to validate and manage minor release states. This method is provided for compatibility with legacy code that expects an Object return type.

Public method

GetGlobaleRevPhaseCCap

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the caption/label for revision phase C (typically "Minor"). This caption is a human-readable description of phase C, used in user interfaces, reports, or logs to clearly indicate the meaning of the revision phase instead of using only codes or numbers.

Public method

GetGlobaleRevSeparator

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Returns the current revision separator string used to distinguish between major and minor revision parts. The separator is loaded from the configuration file and is typically a character such as "." or "-".

Public method

GetHashCode

(Inherited from Object.)

Public method

GetNextRevisionLabel

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Retrieves the next revision label based on the provided name and revision array.

Public method

GetNumberOfRevisions

Retrieves the number of revision for a document.

Public method

GetType

(Inherited from Object.)

Public method

IncrementRevisionState

Increments the actual state of the last selected document or overwrites the current revision.

Protected method

MemberwiseClone

(Inherited from Object.)

Public method

NewRevision

Similar to the IncrementRevisionState; the only difference is that the revision is not automatically incremented to a computer calculated value but, instead, is assigned as argument.

Public method

ReleaseIsMajor

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Determines whether the given revision is a major release based on the global revision phase settings and the provided revision string.

Public method

ReleaseIsMinor

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Determines whether the given revision is a minor release based on the global revision phase settings and the provided revision string.

Public method

ReleaseIsPreRelease

This method is the result of porting the legacy OnNewRev.lib library from VBScript to .NET. Determines whether the given revision is a pre-release based on the global revision phase settings and the provided revision string.

Public method

RenameCurrentRevision

Renames the revision of the currently selected document with the assigned new name. If docUid is passed as optional argument, it works on the document with that unique id. If ecoID is passed as optional argument, the ECO_ID field of the REVISIONS table record is filled with the value passed to the function (used if docUid is specified).

Public method

ToString

(Inherited from Object.)

Public method

VisualizeRevision

Opens a previous revision in the CAD desktop

See Also

Revision Class

MwPDMApi Namespace