Interface IPdm
Gives access to the PDM.
Namespace: TopSolid.Pdm.Explorer.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 11, 300, 80)]
public interface IPdmRemarks
This interface is available since v7.10.
Properties
BasicName
Gets the name of PDM (i.e. raw name of PDM connection, not localized).
Declaration
[AvailableSinceVersion(7, 18, 400, 60)]
string BasicName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
This property is available since v7.18 SP7.
IsLocal
Returns true if current PDM is local
Declaration
[AvailableSinceVersion(7, 18, 400, 60)]
bool IsLocal { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
This property is available since v7.18 SP7.
LibraryProjectsRootFolder
Gets the library projects root folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmProjectFolderId LibraryProjectsRootFolder { get; }Property Value
| Type | Description |
|---|---|
| PdmProjectFolderId |
Remarks
This property is available since v7.10.
Name
Gets the name of PDM (i.e. the localized name of PDM connection).
Declaration
[AvailableSinceVersion(7, 18, 400, 60)]
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
This property is available since v7.18 SP7.
Signature
Gets the signature of PDM.
Declaration
[AvailableSinceVersion(7, 18, 400, 60)]
string Signature { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
This property is available since v7.18 SP7.
WorkingProjectsRootFolder
Gets the working projects root folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmProjectFolderId WorkingProjectsRootFolder { get; }Property Value
| Type | Description |
|---|---|
| PdmProjectFolderId |
Remarks
This property is available since v7.10.
Methods
CanPrintDirect(PdmObjectId)
Tells whether a document can be printed directly without user interaction.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
bool CanPrintDirect(PdmObjectId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inDocumentId | Document identifier. |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Remarks
This method is available since v7.10.300.080.
CheckIn(PdmObjectId, Boolean)
Checks-in an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void CheckIn(PdmObjectId inObjectId, bool inRecurses)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier. |
| System.Boolean | inRecurses | Tells if to recurse on objects contained. |
Remarks
This method is available since v7.10.
CheckInSeveral(List<PdmObjectId>, Boolean)
Checks-in several objects.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void CheckInSeveral(List<PdmObjectId> inObjectIds, bool inRecurses)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| System.Boolean | inRecurses | Tells if to recurse on objects contained. |
Remarks
This method is available since v7.10.
CheckOut(PdmObjectId)
Checks-out an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void CheckOut(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier. |
Remarks
This method is available since v7.10.
CopySeveral(List<PdmObjectId>, PdmObjectId)
Copies several objects.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmObjectId> CopySeveral(List<PdmObjectId> inObjectIds, PdmObjectId inContainerId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<PdmObjectId> | inObjectIds | Identifiers of objects to copy. |
| PdmObjectId | inContainerId | Identifier of project or folder container where to copy objects. |
Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<PdmObjectId> | New PDM object identifiers. |
Remarks
This method is available since v7.10.
CreateProjectFolder(PdmProjectFolderId, String)
Creates a project folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmProjectFolderId CreateProjectFolder(PdmProjectFolderId inProjectFolderId, string inFolderName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderId | Identifier of the project folder where the new project folder is to be created. |
| System.String | inFolderName | Name of the new project folder. |
Returns
| Type | Description |
|---|---|
| PdmProjectFolderId | Identifier of the created project folder. |
Remarks
If creation fails, the returned identifier is empty.
This method is available since v7.10.
DeleteProjectFolder(PdmProjectFolderId)
Deletes an empty project folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void DeleteProjectFolder(PdmProjectFolderId inProjectFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderId | Identifier of the project folder to delete. |
Remarks
If the specified project folder was not empty, an exception is thrown.
This method is available since v7.10.
DeleteSeveral(List<PdmObjectId>)
Deletes several objects.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void DeleteSeveral(List<PdmObjectId> inObjectIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<PdmObjectId> | inObjectIds | Identifiers of objects to delete. |
Remarks
This method is available since v7.10.
Exists(PdmObjectId)
Tells whether a PDM object still exists.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
bool Exists(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of the PDM object to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The PDM object still exists. |
Remarks
This method is available since v7.10.
ExportExecutablePackage(List<PdmObjectId>, Boolean, Boolean, Boolean, String)
Exports an executable package.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void ExportExecutablePackage(List<PdmObjectId> inObjectIds, bool inExportsForDelivery, bool inExportsIncrementalPackage, bool inAllowsMeasurement, string inFileFullPath)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| System.Boolean | inExportsForDelivery | Whether exports for delivery. |
| System.Boolean | inExportsIncrementalPackage | Whether exports an incremental package. |
| System.Boolean | inAllowsMeasurement | Whether allows measurement. |
| System.String | inFileFullPath | Full path of the exported package, with ".exe" extension. |
Remarks
This method produces Windows 32-bit executable that allows viewing the specified objects without installing TopSolid'Viewer.
This method is available since v7.10.
ExportMinorRevisionFile(PdmMinorRevisionId, String)
Exports a non TopSolid document minor revision to a file without conversion.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void ExportMinorRevisionFile(PdmMinorRevisionId inMinorRevisionId, string inFullName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of document minor revision to export. |
| System.String | inFullName | Full name of the file to create. |
Remarks
This method is available since v7.10.
ExportPackage(List<PdmObjectId>, Boolean, Boolean, String)
Exports a package.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void ExportPackage(List<PdmObjectId> inObjectIds, bool inExportsForDelivery, bool inExportsIncrementalPackage, string inFileFullPath)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| System.Boolean | inExportsForDelivery | Whether exports for delivery. |
| System.Boolean | inExportsIncrementalPackage | Whether exports an incremental package. |
| System.String | inFileFullPath | Full path of the exported package, with ".TopPkg" extension. |
Remarks
This method is available since v7.10.
ExportToBabylon(PdmObjectId, String, String)
Exports a document to a Babylon file.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void ExportToBabylon(PdmObjectId inDocumentId, string inFolderPath, string inFileName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inDocumentId | Document identifier. |
| System.String | inFolderPath | Path of export folder. |
| System.String | inFileName | File name. |
Remarks
This method is available since v7.10.
ExportToPDF(PdmObjectId, String, String)
Exports a document to a PDF file.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void ExportToPDF(PdmObjectId inDocumentId, string inFolderPath, string inFileName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inDocumentId | Document identifier. |
| System.String | inFolderPath | Path of export folder. |
| System.String | inFileName | File name. |
Remarks
This method is available since v7.10.300.080.
ExportViewerPackage(List<PdmObjectId>, Boolean, Boolean, Boolean, String)
Exports a viewer package.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void ExportViewerPackage(List<PdmObjectId> inObjectIds, bool inExportsForDelivery, bool inExportsIncrementalPackage, bool inAllowsMeasurement, string inFileFullPath)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| System.Boolean | inExportsForDelivery | Whether exports for delivery. |
| System.Boolean | inExportsIncrementalPackage | Whether exports an incremental package. |
| System.Boolean | inAllowsMeasurement | Whether allows measurement. |
| System.String | inFileFullPath | Full path of the exported package, with ".TopPkgViw" extension. |
Remarks
The package produced by this method may be imported in TopSolid'Viewer.
This method is available since v7.10.
GetAuthor(PdmObjectId)
Gets the author of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetAuthor(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object author. |
Remarks
This method is available since v7.10.
GetBOMData(PdmObjectId, out List<String>, out List<Int32>, out List<BomNode>)
Exports a document to a Babylon file.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void GetBOMData(PdmObjectId inDocumentId, out List<string> outBomColumns, out List<int> outBomColumnWidths, out List<BomNode> outBomNodes)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inDocumentId | Document identifier. |
| List<System.String> | outBomColumns | BOM columns. |
| List<System.Int32> | outBomColumnWidths | Widths of BOM columns. |
| List<BomNode> | outBomNodes | BOM nodes. |
Remarks
This method is available since v7.10.300.080.
GetComment(PdmObjectId)
Gets the comment of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetComment(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object comment. |
Remarks
This method is available since v7.10.
GetComplementaryPartNumber(PdmObjectId)
Gets the complementary part number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetComplementaryPartNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object complementary part number. |
Remarks
This method is available since v7.10.
GetConstituents(PdmObjectId, out List<PdmObjectId>, out List<PdmObjectId>)
Gets the constituents of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void GetConstituents(PdmObjectId inObjectId, out List<PdmObjectId> outFolderIds, out List<PdmObjectId> outDocumentObjectIds)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier of a project, a folder or a document. |
| List<PdmObjectId> | outFolderIds | List of folders identifiers. |
| List<PdmObjectId> | outDocumentObjectIds | List of documents identifiers. |
Remarks
This method is available since v7.10.
GetCreationDate(PdmObjectId)
Gets the creation date of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCreationDate(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object creation date. |
Remarks
This method is available since v7.10.300.140.
GetCustomer(PdmObjectId)
Gets the customer of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCustomer(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object customer. |
Remarks
This method is available since v7.10.300.120.
GetCustomerAddress(PdmObjectId)
Gets the customer address of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCustomerAddress(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object customer address. |
Remarks
This method is available since v7.10.300.120.
GetCustomerContact(PdmObjectId)
Gets the customer contact of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCustomerContact(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object customer contact. |
Remarks
This method is available since v7.10.300.120.
GetCustomerEmailAddress(PdmObjectId)
Gets the customer email address of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCustomerEmailAddress(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object customer email address. |
Remarks
This method is available since v7.10.300.120.
GetCustomerIdentificationNumber(PdmObjectId)
Gets the customer identification number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCustomerIdentificationNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object customer identification number. |
Remarks
This method is available since v7.10.300.120.
GetCustomerPhoneNumber(PdmObjectId)
Gets the customer phone number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCustomerPhoneNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object customer phone number. |
Remarks
This method is available since v7.10.300.120.
GetCustomerProjectDescription(PdmObjectId)
Gets the customer project description of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCustomerProjectDescription(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object customer project description. |
Remarks
This method is available since v7.10.300.120.
GetCustomerProjectIdentificationNumber(PdmObjectId)
Gets the project customer identification number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetCustomerProjectIdentificationNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object customer identification number. |
Remarks
This method is available since v7.10.300.120.
GetDeliveryDate(PdmObjectId)
Gets the delivery date of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetDeliveryDate(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object delivery date. |
Remarks
This method is available since v7.10.300.140.
GetDescription(PdmObjectId)
Gets the description of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetDescription(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object description. |
Remarks
This method is available since v7.10.
GetDocumentIcon(String, Size)
Gets the icon of a document.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
Icon GetDocumentIcon(string inFileExtension, Size inDesiredSize)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inFileExtension | File extension. |
| Size | inDesiredSize | Desired size. |
Returns
| Type | Description |
|---|---|
| Icon | The icon corresponding to the file extension. |
Remarks
This method is available since v7.10.300.080.
GetFinalMinorRevision(PdmObjectId)
Gets the last minor revision contained in the last major revision contained in a PDM object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmMinorRevisionId GetFinalMinorRevision(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of the PDM object. |
Returns
| Type | Description |
|---|---|
| PdmMinorRevisionId | Identifier of the last minor revision of the last major revision. |
Remarks
This method is available since v7.10.
GetLastMajorRevision(PdmObjectId)
Gets the last major revision contained in a PDM object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmMajorRevisionId GetLastMajorRevision(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of the PDM object. |
Returns
| Type | Description |
|---|---|
| PdmMajorRevisionId | Identifier of the contained last major revision. |
Remarks
This method is available since v7.10.
GetLastMinorRevision(PdmMajorRevisionId)
Gets the last minor revision contained in a major revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmMinorRevisionId GetLastMinorRevision(PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of the major revision. |
Returns
| Type | Description |
|---|---|
| PdmMinorRevisionId | Identifier of the contained last minor revision. |
Remarks
This method is available since v7.10.
GetLatestRevision(PdmObjectId)
Gets latest revision of specified object and of its children.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void GetLatestRevision(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of object to update. |
Remarks
This method is available since v7.10.
GetLifeCycleMainState(PdmObjectId)
Gets the life cycle main state of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmLifeCycleMainState GetLifeCycleMainState(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of object to get life cycle main state. |
Returns
| Type | Description |
|---|---|
| PdmLifeCycleMainState | Life cycle of the document. |
Remarks
This method is available since v7.10.
GetMajorRevision(PdmMinorRevisionId)
Gets the major revision containing a specified minor revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmMajorRevisionId GetMajorRevision(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the minor revision. |
Returns
| Type | Description |
|---|---|
| PdmMajorRevisionId | Identifier of the containing major revision. |
Remarks
This method is available since v7.10.
GetMajorRevisions(PdmObjectId)
Gets the major revisions contained in a PDM object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmMajorRevisionId> GetMajorRevisions(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of the PDM object. |
Returns
| Type | Description |
|---|---|
| List<PdmMajorRevisionId> | Identifiers of the contained major revisions. |
Remarks
This method is available since v7.10.
GetMajorRevisionText(PdmMajorRevisionId)
Gets the text of a major revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetMajorRevisionText(PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of the major revision. |
Returns
| Type | Description |
|---|---|
| System.String | Text of the major revision. |
Remarks
This method is available since v7.10.
GetManufacturer(PdmObjectId)
Gets the manufacturer of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetManufacturer(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object manufacturer. |
Remarks
This method is available since v7.10.
GetManufacturerPartNumber(PdmObjectId)
Gets the manufacturer part number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetManufacturerPartNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object manufacturer part number. |
Remarks
This method is available since v7.10.
GetMinorRevisionFileSize(PdmMinorRevisionId)
Gets the size of the file of a minor revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
long GetMinorRevisionFileSize(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the minor revision. |
Returns
| Type | Description |
|---|---|
| System.Int64 | Size (in bytes) of the file of the minor revision. |
Remarks
This method is available since v7.10.
GetMinorRevisionFileVersion(PdmMinorRevisionId)
Gets the version of the application used to save the file of a minor revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
int GetMinorRevisionFileVersion(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the minor revision. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Application version used to save the file of the minor revision. |
Remarks
The value returned is defined by: Major * 100000000 + Minor * 1000000 + Build * 1000 + Revision.
For example, v7.5.200.100 is returned as: 705200100.
This method returns 0 if the version of the application is not known.
This method is available since v7.10.
GetMinorRevisionPreviewBitmap(PdmMinorRevisionId)
Gets the preview bitmap of a minor revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
Bitmap GetMinorRevisionPreviewBitmap(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the minor revision. |
Returns
| Type | Description |
|---|---|
| Bitmap | Preview bitmap of the minor revision, or null if none. |
Remarks
This method is available since v7.10.
GetMinorRevisions(PdmMajorRevisionId)
Gets the minor revisions contained in a major revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmMinorRevisionId> GetMinorRevisions(PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of the major revision. |
Returns
| Type | Description |
|---|---|
| List<PdmMinorRevisionId> | Identifiers of the contained minor revisions. |
Remarks
This method is available since v7.10.
GetMinorRevisionText(PdmMinorRevisionId)
Gets the text of a minor revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetMinorRevisionText(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the minor revision. |
Returns
| Type | Description |
|---|---|
| System.String | Text of the minor revision. |
Remarks
This method is available since v7.10.
GetModificationDate(PdmObjectId)
Gets the modification date of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetModificationDate(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object modification date. |
Remarks
This method is available since v7.10.300.140.
GetName(PdmObjectId)
Gets the name of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetName(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object name. |
Remarks
This method is available since v7.10.
GetOwner(PdmObjectId)
Gets the owner of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmObjectId GetOwner(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | PDM object identifier of the owner, or empty if none. |
Remarks
If there is no owner, the returned PDM object identifier is empty.
This method is available since v7.10.
GetPartNumber(PdmObjectId)
Gets the part number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetPartNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object part number. |
Remarks
This method is available since v7.10.
GetPdmObject(PdmMajorRevisionId)
Gets the PDM object containing a specified major revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmObjectId GetPdmObject(PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of the major revision. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Identifier of the containing PDM object. |
Remarks
This method is available since v7.10.
GetProject(PdmObjectId)
Gets the project of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmObjectId GetProject(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | PDM object identifier of the project containing the specified object. |
Remarks
This method is available since v7.10.
GetProjectCategory(PdmObjectId)
Gets the project category of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetProjectCategory(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object category. |
Remarks
This method is available since v7.10.300.140.
GetProjectFolderConstituents(PdmProjectFolderId, out List<PdmProjectFolderId>, out List<PdmObjectId>)
Gets the constituents of a project folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void GetProjectFolderConstituents(PdmProjectFolderId inProjectFolderdId, out List<PdmProjectFolderId> outFolderIds, out List<PdmObjectId> outProjectIds)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderdId | Project folder identifier. |
| List<PdmProjectFolderId> | outFolderIds | List of folders identifiers. |
| List<PdmObjectId> | outProjectIds | List of documents identifiers. |
Remarks
This method is available since v7.10.
GetProjectFolderName(PdmProjectFolderId)
Gets the name of a project folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetProjectFolderName(PdmProjectFolderId inProjectFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderId | Project folder identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Project folder name. |
Remarks
This method is available since v7.10.
GetProjectFolderOwner(PdmProjectFolderId)
Gets the project folder containing a specified project folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmProjectFolderId GetProjectFolderOwner(PdmProjectFolderId inProjectFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderId | Project folder identifier. |
Returns
| Type | Description |
|---|---|
| PdmProjectFolderId | Identifier of the project folder containing the specified project folder, or empty if none. |
Remarks
If there is no owner, i.e. the specified project folder was a root, the returned identifier is empty.
This method is available since v7.10.
GetProjectOwner(PdmObjectId)
Gets the project folder containing a specified project.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmProjectFolderId GetProjectOwner(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project object identifier. |
Returns
| Type | Description |
|---|---|
| PdmProjectFolderId | Identifier of the project folder containing a specified project. |
Remarks
This method is available since v7.10.
GetProjects(Boolean, Boolean)
Gets all the projects.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmObjectId> GetProjects(bool inGetsWorkingProjects, bool inGetsLibraryProjects)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | inGetsWorkingProjects | Gets working projects. |
| System.Boolean | inGetsLibraryProjects | Gets library projects. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | List of projects PDM object identifiers. |
Remarks
This method is available since v7.10.
GetProjectType(PdmObjectId)
Gets the project type of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetProjectType(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object type. |
Remarks
This method is available since v7.10.300.140.
GetReferencedProjects(PdmObjectId)
Gets the referenced projects of a project.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmObjectId> GetReferencedProjects(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | Referenced projects identifiers. |
Remarks
This method is available since v7.10.
GetSavingDate(PdmObjectId)
Gets the saving date of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetSavingDate(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object saving date. |
Remarks
This method is available since v7.10.300.140.
GetState(PdmObjectId)
Gets the state of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmObjectState GetState(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| PdmObjectState | Object state. |
Remarks
This method is available since v7.10.
GetType(PdmObjectId, out String)
Gets the type of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmObjectType GetType(PdmObjectId inObjectId, out string outExtension)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | outExtension | Document file extension, or null if not a document. |
Returns
| Type | Description |
|---|---|
| PdmObjectType | Object type. |
Remarks
This method is available since v7.10.
GetVerifier(PdmObjectId)
Gets the verifier of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
string GetVerifier(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| System.String | Object verifier. |
Remarks
This method is available since v7.10.300.140.
HasConstituents(PdmObjectId)
Tells whether an object has constituents.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
bool HasConstituents(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier of a project, a folder or a document. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The object has constituents, i.e. GetConstituents(PdmObjectId, out List<PdmObjectId>, out List<PdmObjectId>) would not return only empty lists. |
Remarks
This method is available since v7.10.
HasProjectFolderConstituents(PdmProjectFolderId)
Tells whether a project folder has constituents.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
bool HasProjectFolderConstituents(PdmProjectFolderId inProjectFolderdId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderdId | Project folder identifier. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The project folder has constituents, i.e. GetProjectFolderConstituents(PdmProjectFolderId, out List<PdmProjectFolderId>, out List<PdmObjectId>) would not return only empty lists. |
Remarks
This method is available since v7.10.
ImportFile(String, PdmObjectId, String)
Imports a file without conversion.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmObjectId ImportFile(string inFullName, PdmObjectId inContainerId, string inDocumentName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inFullName | Full name of the file to import. |
| PdmObjectId | inContainerId | PDM object identifier of project or folder container where imported file is to be stored. |
| System.String | inDocumentName | Name of the new document. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Identifier of the created document. |
Remarks
This method is available since v7.10.
IsLibraryProject(PdmObjectId)
Tells if a project is a library.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
bool IsLibraryProject(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier. |
Returns
| Type | Description |
|---|---|
| System.Boolean | The project is a library. |
Remarks
This method is available since v7.10.
MoveProject(PdmObjectId, PdmProjectFolderId)
Moves a project into a specified project folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void MoveProject(PdmObjectId inProjectId, PdmProjectFolderId inDestinationFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project object identifier. |
| PdmProjectFolderId | inDestinationFolderId | Identifier of the destination project folder. |
Remarks
This method is available since v7.10.
MoveProjectFolder(PdmProjectFolderId, PdmProjectFolderId)
Moves a project folder into a specified project folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void MoveProjectFolder(PdmProjectFolderId inProjectFolderId, PdmProjectFolderId inDestinationFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderId | Project folder identifier. |
| PdmProjectFolderId | inDestinationFolderId | Identifier of the destination project folder. |
Remarks
This method is available since v7.10.
MoveSeveral(List<PdmObjectId>, PdmObjectId)
Move several objects.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void MoveSeveral(List<PdmObjectId> inObjectIds, PdmObjectId inContainerId)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<PdmObjectId> | inObjectIds | Identifiers of objects to move. |
| PdmObjectId | inContainerId | Identifier of project or folder container where to move objects. |
Remarks
The objects to move must belong to the same project.
The objects must stay in the same project, therefore when specifying a project container it must be that project, and when specifying a folder container it must belong to that project.
This method is available since v7.10.
NeedsGettingLatestRevision(PdmObjectId)
Tells whether specified object or its children need getting latest revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
bool NeedsGettingLatestRevision(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of object to analyze. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Specified object or its children need getting latest revision. |
Remarks
This method is available since v7.10.
OpenMinorRevision(PdmMinorRevisionId, Boolean)
Opens a document.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void OpenMinorRevision(PdmMinorRevisionId inMinorRevisionId, bool inReadOnly)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of document minor revision. |
| System.Boolean | inReadOnly | Open in read-only mode. |
Remarks
This method is available since v7.10.0.0.
OpenProject(PdmObjectId)
Opens a project.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void OpenProject(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier. |
Remarks
This method is available since v7.9.300.100.
PurgeSeveral(List<PdmObjectId>)
Purges several deleted objects.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void PurgeSeveral(List<PdmObjectId> inObjectIds)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.List<PdmObjectId> | inObjectIds | Identifiers of objects to purge. |
Remarks
This method is available since v7.10.
ReimportFile(String, PdmObjectId)
Reimports a file without conversion.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmMinorRevisionId ReimportFile(string inFullName, PdmObjectId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inFullName | Full name of the file to import. |
| PdmObjectId | inDocumentId | PDM object identifier of the document containing previous revisions of the file. |
Returns
| Type | Description |
|---|---|
| PdmMinorRevisionId | Identifier of the created new revision. |
Remarks
This method is available since v7.10.
Restore(PdmObjectId)
Restores a deleted object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void Restore(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.10.
RestoreLastSave(PdmObjectId)
Cancels the modification of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void RestoreLastSave(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Remarks
This method is available since v7.10.
Save(PdmObjectId, Boolean)
Saves an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void Save(PdmObjectId inObjectId, bool inRecurses)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier. |
| System.Boolean | inRecurses | Tells if to recurse on objects contained. |
Remarks
This method is available since v7.10.
SaveSeveral(List<PdmObjectId>, Boolean)
Saves several objects.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SaveSeveral(List<PdmObjectId> inObjectIds, bool inRecurses)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| System.Boolean | inRecurses | Tells if to recurse on objects contained. |
Remarks
This method is available since v7.10.
SearchDocumentByName(PdmObjectId, String)
Searches for a document by its name.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmObjectId> SearchDocumentByName(PdmObjectId inProjectId, string inDocumentName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier, or empty for searching in all projects. |
| System.String | inDocumentName | Document name. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | PDM object identifiers of documents corresponding to the searched name. |
Remarks
This method is available since v7.10.
SearchDocumentByPartNumber(PdmObjectId, String)
Searches for a document by its part number.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmObjectId> SearchDocumentByPartNumber(PdmObjectId inProjectId, string inPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier, or empty for searching in all projects. |
| System.String | inPartNumber | Part number. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | PDM object identifiers of documents corresponding to the searched part number. |
Remarks
This method is available since v7.10.
SearchDocumentByUniversalId(PdmObjectId, String, String)
Searches for a document by its universal identifier.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
PdmObjectId SearchDocumentByUniversalId(PdmObjectId inProjectId, string inDomain, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier, or empty for searching in all projects. |
| System.String | inDomain | Universal domain. |
| System.String | inName | Universal name. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Document PDM object identifier. |
Remarks
This method is available since v7.10.
SearchMajorRevisionBackReferences(PdmObjectId, PdmMajorRevisionId)
Searches all back references of a document major revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmMinorRevisionId> SearchMajorRevisionBackReferences(PdmObjectId inProjectId, PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Identifier of project to search inside, or empty for searching in all projects. |
| PdmMajorRevisionId | inMajorRevisionId | Identifier of the document major revision to analyze. |
Returns
| Type | Description |
|---|---|
| List<PdmMinorRevisionId> | Back referenced minor revisions. |
Remarks
This method is available since v7.10.
SearchMinorRevisionBackReferences(PdmObjectId, PdmMinorRevisionId)
Searches all back references of a document minor revision.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmMinorRevisionId> SearchMinorRevisionBackReferences(PdmObjectId inProjectId, PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Identifier of project to search inside, or empty for searching in all projects. |
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the document minor revision to analyze. |
Returns
| Type | Description |
|---|---|
| List<PdmMinorRevisionId> | Back referenced minor revisions. |
Remarks
This method is available since v7.10.
SearchProjectByName(String)
Searches for a project by its name.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
List<PdmObjectId> SearchProjectByName(string inProjectName)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | inProjectName | Project name. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | PDM object identifiers of projects corresponding to the searched name. |
Remarks
The project name is the localized name in the current culture of TopSolid.
This method is available since v7.10.
SetAuthor(PdmObjectId, String)
Sets the author of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetAuthor(PdmObjectId inObjectId, string inAuthor)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | inAuthor | Author. |
Remarks
This method is available since v7.10.
SetComment(PdmObjectId, String)
Sets the comment of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetComment(PdmObjectId inObjectId, string inComment)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | inComment | Comment. |
Remarks
This method is available since v7.10.
SetComplementaryPartNumber(PdmObjectId, String)
Sets the complementary part number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetComplementaryPartNumber(PdmObjectId inObjectId, string inComplementaryPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | inComplementaryPartNumber | Complementary part number. |
Remarks
This method is available since v7.10.
SetDescription(PdmObjectId, String)
Sets the description of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetDescription(PdmObjectId inObjectId, string inDescription)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | inDescription | Description. |
Remarks
This method is available since v7.10.
SetLifeCycleMainState(PdmObjectId, PdmLifeCycleMainState)
Changes the life cycle main state of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetLifeCycleMainState(PdmObjectId inObjectId, PdmLifeCycleMainState inLifeCycle)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of object to change life cycle main state. |
| PdmLifeCycleMainState | inLifeCycle | Life cycle to apply (None and Design life cycles are not supported). |
Remarks
This method is available since v7.10.
SetManufacturer(PdmObjectId, String)
Sets the manufacturer of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetManufacturer(PdmObjectId inObjectId, string inManufacturer)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | inManufacturer | Manufacturer. |
Remarks
This method is available since v7.10.
SetManufacturerPartNumber(PdmObjectId, String)
Sets the manufacturer part number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetManufacturerPartNumber(PdmObjectId inObjectId, string inManufacturerPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | inManufacturerPartNumber | Manufacturer part number. |
Remarks
This method is available since v7.10.
SetName(PdmObjectId, String)
Sets the name of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetName(PdmObjectId inObjectId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | inName | Name. |
Remarks
This method is available since v7.10.
SetPartNumber(PdmObjectId, String)
Sets the part number of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetPartNumber(PdmObjectId inObjectId, string inPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| System.String | inPartNumber | Part number. |
Remarks
This method is available since v7.10.
SetProjectFolderName(PdmProjectFolderId, String)
Sets the name of a project folder.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void SetProjectFolderName(PdmProjectFolderId inProjectFolderId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderId | Project folder identifier. |
| System.String | inName | Name. |
Remarks
This method is available since v7.10.
UndoCheckOut(PdmObjectId)
Undoes the check-out of an object.
Declaration
[AvailableSinceVersion(7, 11, 300, 80)]
void UndoCheckOut(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Remarks
This method is available since v7.10.