Interface IPdm
Gives access to the PDM.
Namespace: TopSolid.Pdm.Explorer.Automating
Assembly: TopSolid.Pdm.Explorer.Automating.dll
Syntax
[ServiceContract]
[AvailableSinceVersion(7, 11, 300, 80)]
public interface IPdmRemarks
This interface is available since v7.10.
Properties
| Name | Description |
|---|---|
| BasicName | Gets the name of PDM (i.e. raw name of PDM connection, not localized). |
| IsLocal | Returns true if current PDM is local |
| LibraryProjectsRootFolder | Gets the library projects root folder. |
| Name | Gets the name of PDM (i.e. the localized name of PDM connection). |
| Signature | Gets the signature of PDM. |
| WorkingProjectsRootFolder | Gets the working projects root folder. |
Methods
| Name | Description |
|---|---|
| CanPrintDirect(PdmObjectId) | Tells whether a document can be printed directly without user interaction. |
| CheckIn(PdmObjectId, bool) | Checks-in an object. |
| CheckInSeveral(List<PdmObjectId>, bool) | Checks-in several objects. |
| CheckOut(PdmObjectId) | Checks-out an object. |
| CloseMinorRevision(PdmMinorRevisionId) | Closes a minor revision |
| CopySeveral(List<PdmObjectId>, PdmObjectId) | Copies several objects. |
| CreateProjectFolder(PdmProjectFolderId, string) | Creates a project folder. |
| DeleteProjectFolder(PdmProjectFolderId) | Deletes an empty project folder. |
| DeleteSeveral(List<PdmObjectId>) | Deletes several objects. |
| Exists(PdmObjectId) | Tells whether a PDM object still exists. |
| ExportExecutablePackage(List<PdmObjectId>, bool, bool, bool, string) | Exports an executable package. |
| ExportMinorRevisionFile(PdmMinorRevisionId, string) | Exports a non TopSolid document minor revision to a file without conversion. |
| ExportPackage(List<PdmObjectId>, bool, bool, string) | Exports a package. |
| ExportToBabylon(PdmObjectId, string, string) | Exports a document to a Babylon file. |
| ExportToPDF(PdmObjectId, string, string) | Exports a document to a PDF file. |
| ExportViewerPackage(List<PdmObjectId>, bool, bool, bool, string) | Exports a viewer package. |
| GetAuthor(PdmObjectId) | Gets the author of an object. |
| GetBOMData(PdmObjectId, out List<string>, out List<int>, out List<BomNode>) | Exports a document to a Babylon file. |
| GetComment(PdmObjectId) | Gets the comment of an object. |
| GetComplementaryPartNumber(PdmObjectId) | Gets the complementary part number of an object. |
| GetConstituents(PdmObjectId, out List<PdmObjectId>, out List<PdmObjectId>) | Gets the constituents of an object. |
| GetCreationDate(PdmObjectId) | Gets the creation date of an object. |
| GetCustomer(PdmObjectId) | Gets the customer of an object. |
| GetCustomerAddress(PdmObjectId) | Gets the customer address of an object. |
| GetCustomerContact(PdmObjectId) | Gets the customer contact of an object. |
| GetCustomerEmailAddress(PdmObjectId) | Gets the customer email address of an object. |
| GetCustomerIdentificationNumber(PdmObjectId) | Gets the customer identification number of an object. |
| GetCustomerPhoneNumber(PdmObjectId) | Gets the customer phone number of an object. |
| GetCustomerProjectDescription(PdmObjectId) | Gets the customer project description of an object. |
| GetCustomerProjectIdentificationNumber(PdmObjectId) | Gets the project customer identification number of an object. |
| GetDeliveryDate(PdmObjectId) | Gets the delivery date of an object. |
| GetDescription(PdmObjectId) | Gets the description of an object. |
| GetDocumentIcon(string, Size) | Gets the icon of a document. |
| GetFinalMinorRevision(PdmObjectId) | Gets the last minor revision contained in the last major revision contained in a PDM object. |
| GetLastMajorRevision(PdmObjectId) | Gets the last major revision contained in a PDM object. |
| GetLastMinorRevision(PdmMajorRevisionId) | Gets the last minor revision contained in a major revision. |
| GetLatestRevision(PdmObjectId) | Gets latest revision of specified object and of its children. |
| GetLifeCycleMainState(PdmObjectId) | Gets the life cycle main state of an object. |
| GetMajorRevision(PdmMinorRevisionId) | Gets the major revision containing a specified minor revision. |
| GetMajorRevisionText(PdmMajorRevisionId) | Gets the text of a major revision. |
| GetMajorRevisions(PdmObjectId) | Gets the major revisions contained in a PDM object. |
| GetManufacturer(PdmObjectId) | Gets the manufacturer of an object. |
| GetManufacturerPartNumber(PdmObjectId) | Gets the manufacturer part number of an object. |
| GetMinorRevisionFileSize(PdmMinorRevisionId) | Gets the size of the file of a minor revision. |
| GetMinorRevisionFileVersion(PdmMinorRevisionId) | Gets the version of the application used to save the file of a minor revision. |
| GetMinorRevisionPreviewBitmap(PdmMinorRevisionId) | Gets the preview bitmap of a minor revision. |
| GetMinorRevisionText(PdmMinorRevisionId) | Gets the text of a minor revision. |
| GetMinorRevisions(PdmMajorRevisionId) | Gets the minor revisions contained in a major revision. |
| GetModificationDate(PdmObjectId) | Gets the modification date of an object. |
| GetName(PdmObjectId) | Gets the name of an object. |
| GetOwner(PdmObjectId) | Gets the owner of an object. |
| GetPartNumber(PdmObjectId) | Gets the part number of an object. |
| GetPdmObject(PdmMajorRevisionId) | Gets the PDM object containing a specified major revision. |
| GetProject(PdmObjectId) | Gets the project of an object. |
| GetProjectCategory(PdmObjectId) | Gets the project category of an object. |
| GetProjectFolderConstituents(PdmProjectFolderId, out List<PdmProjectFolderId>, out List<PdmObjectId>) | Gets the constituents of a project folder. |
| GetProjectFolderName(PdmProjectFolderId) | Gets the name of a project folder. |
| GetProjectFolderOwner(PdmProjectFolderId) | Gets the project folder containing a specified project folder. |
| GetProjectOwner(PdmObjectId) | Gets the project folder containing a specified project. |
| GetProjectType(PdmObjectId) | Gets the project type of an object. |
| GetProjects(bool, bool) | Gets all the projects. |
| GetReferencedProjects(PdmObjectId) | Gets the referenced projects of a project. |
| GetSavingDate(PdmObjectId) | Gets the saving date of an object. |
| GetState(PdmObjectId) | Gets the state of an object. |
| GetType(PdmObjectId, out string) | Gets the type of an object. |
| GetVerifier(PdmObjectId) | Gets the verifier of an object. |
| HasConstituents(PdmObjectId) | Tells whether an object has constituents. |
| HasProjectFolderConstituents(PdmProjectFolderId) | Tells whether a project folder has constituents. |
| ImportFile(string, PdmObjectId, string) | Imports a file without conversion. |
| IsLibraryProject(PdmObjectId) | Tells if a project is a library. |
| MoveProject(PdmObjectId, PdmProjectFolderId) | Moves a project into a specified project folder. |
| MoveProjectFolder(PdmProjectFolderId, PdmProjectFolderId) | Moves a project folder into a specified project folder. |
| MoveSeveral(List<PdmObjectId>, PdmObjectId) | Move several objects. |
| NeedsGettingLatestRevision(PdmObjectId) | Tells whether specified object or its children need getting latest revision. |
| OpenMinorRevision(PdmMinorRevisionId, bool) | Opens a document. |
| OpenProject(PdmObjectId) | Opens a project. |
| PurgeSeveral(List<PdmObjectId>) | Purges several deleted objects. |
| ReimportFile(string, PdmObjectId) | Reimports a file without conversion. |
| Restore(PdmObjectId) | Restores a deleted object. |
| RestoreLastSave(PdmObjectId) | Cancels the modification of an object. |
| Save(PdmObjectId, bool) | Saves an object. |
| SaveSeveral(List<PdmObjectId>, bool) | Saves several objects. |
| SearchDocumentByName(PdmObjectId, string) | Searches for a document by its name. |
| SearchDocumentByPartNumber(PdmObjectId, string) | Searches for a document by its part number. |
| SearchDocumentByUniversalId(PdmObjectId, string, string) | Searches for a document by its universal identifier. |
| SearchMajorRevisionBackReferences(PdmObjectId, PdmMajorRevisionId) | Searches all back references of a document major revision. |
| SearchMinorRevisionBackReferences(PdmObjectId, PdmMinorRevisionId) | Searches all back references of a document minor revision. |
| SearchProjectByName(string) | Searches for a project by its name. |
| SetAuthor(PdmObjectId, string) | Sets the author of an object. |
| SetComment(PdmObjectId, string) | Sets the comment of an object. |
| SetComplementaryPartNumber(PdmObjectId, string) | Sets the complementary part number of an object. |
| SetDescription(PdmObjectId, string) | Sets the description of an object. |
| SetLifeCycleMainState(PdmObjectId, PdmLifeCycleMainState) | Changes the life cycle main state of an object. |
| SetManufacturer(PdmObjectId, string) | Sets the manufacturer of an object. |
| SetManufacturerPartNumber(PdmObjectId, string) | Sets the manufacturer part number of an object. |
| SetName(PdmObjectId, string) | Sets the name of an object. |
| SetPartNumber(PdmObjectId, string) | Sets the part number of an object. |
| SetProjectFolderName(PdmProjectFolderId, string) | Sets the name of a project folder. |
| UndoCheckOut(PdmObjectId) | Undoes the check-out of an object. |