Interface IPdm
Gives access to the PDM.
Namespace: TopSolid.Kernel.Automating
Assembly: TopSolid.Kernel.Automating.dll
Syntax
[ServiceContract]
[AvailableSinceVersion(7, 6, 0, 0)]
public interface IPdmRemarks
This interface is available since v7.6.
Properties
| Name | Description |
|---|---|
| LibraryProjectsRootFolder | Gets the library projects root folder. |
| Name | Gets the name of PDM (i.e. the localized name of PDM connection). |
| WorkingProjectsRootFolder | Gets the working projects root folder. |
Methods
| Name | Description |
|---|---|
| AddReferencedProjects(PdmObjectId, List<PdmObjectId>) | Adds referenced projects to a project. |
| CheckIn(PdmObjectId, bool) | Checks-in an object. |
| CheckInSeveral(List<PdmObjectId>, bool) | Checks-in several objects. |
| CheckOut(PdmObjectId) | Checks-out an object. |
| CloseProject(PdmObjectId) | Closes a project. |
| CopySeveral(List<PdmObjectId>, PdmObjectId) | Copies several objects. |
| CopySeveral2(List<PdmObjectId>, PdmObjectId, bool) | Copies several objects. |
| CopySeveralWithOptions(List<PdmObjectId>, PdmObjectId, bool, bool) | Copies several objects. |
| CreateDocument(PdmObjectId, string, bool) | Creates a TopSolid document. |
| CreateDocumentWithTemplate(PdmObjectId, PdmObjectId) | Creates a TopSolid document with a template. |
| CreateFolder(PdmObjectId, string) | Creates a folder. |
| CreateLifeCycleSubState(PdmLifeCycleMainState, string) | Creates new life cycle sub state. |
| CreateProject(string, bool) | Creates a project. |
| CreateProjectFolder(PdmProjectFolderId, string) | Creates a project folder. |
| CreateProjectWithTemplate(string, PdmObjectId) | Creates a project with a template. |
| DeleteProjectFolder(PdmProjectFolderId) | Deletes an empty project folder. |
| DeleteSeveral(List<PdmObjectId>) | Deletes several objects. |
| EnsureIsDirty(PdmObjectId) | Ensures that an object is dirty to allow further modifications. |
| Exists(PdmObjectId) | Tells whether a PDM object still exists. |
| ExportDictionaries(List<PdmObjectId>, CultureInfo[], string[]) | Exports dictionaries (.TopDic file). |
| ExportDictionaryPackage(PdmObjectId, bool, CultureInfo, string, string) | Export dictionary package (.TopDicPkg). |
| ExportExecutablePackage(List<PdmObjectId>, bool, bool, bool, string) | Exports an executable package. |
| ExportLocalizations(List<PdmObjectId>, CultureInfo[], string, string, bool) | Exports localizations (.TopDic or .xliff file). |
| 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) | Export a document to a Babylon file. |
| ExportViewerPackage(List<PdmObjectId>, bool, bool, bool, string) | Exports a viewer package. |
| GetAuthor(PdmObjectId) | Gets the author of an object. |
| GetAvailablePdmConnections() | Gets all available Pdms connections. |
| 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. |
| GetCurrentProject() | Gets the current projects. |
| GetDescription(PdmObjectId) | Gets the description of an object. |
| GetExportedObjectIds(string) | Get the list of the object identifiers selected during the export of given package file. |
| 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. |
| GetLifeCycleSubStates(PdmLifeCycleMainState, out List<PdmObjectId>, out List<string>) | Gets sub states of specified main state. |
| GetMajorRevision(PdmMinorRevisionId) | Gets the major revision containing a specified minor revision. |
| GetMajorRevisionLifeCycleMainState(PdmMajorRevisionId) | Gets the life cycle main state of a major revision. |
| GetMajorRevisionLifeCycleSubState(PdmMajorRevisionId) | Gets the life cycle sub state of a major 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. |
| GetName(PdmObjectId) | Gets the name of an object. |
| GetObjectsFromRecycleBin(PdmObjectId) | Gets the objects from the recycle bin. |
| GetOpenProjects(bool, bool) | Gets all opened projects. |
| 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. |
| 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. |
| GetProjectMainDocument(PdmObjectId) | Gets the main document of a specified project. |
| GetProjectOwner(PdmObjectId) | Gets the project folder containing a specified project. |
| GetProjectTemplates(PdmObjectId, out PdmObjectId, out PdmObjectId) | Gets the "Templates" and "Templates/Defaults" folders of a project. |
| GetProjects(bool, bool) | Gets all the projects. |
| GetRealUserProperty(PdmObjectId, PdmObjectId) | Gets the value of a specified real user property of an object. |
| GetReferencedProjects(PdmObjectId) | Gets the referenced projects of a project. |
| GetRevisionTexts(PdmObjectId, out string, out string) | Gets the major and minor revision texts of an object. |
| GetSavingDate(PdmObjectId) | Gets the modification date of an object. |
| GetSelectedPdmObjectIds() | Gets selected PDM objects ids of the current project. |
| GetState(PdmObjectId) | Gets the state of an object. |
| GetTemplates(out PdmObjectId, out PdmObjectId, out PdmObjectId, out PdmObjectId) | Gets all the templates. |
| GetTextUserProperty(PdmObjectId, PdmObjectId) | Gets the value of a specified text user property of an object. |
| GetType(PdmObjectId, out string) | Gets the type of an object. |
| HasConstituents(PdmObjectId) | Tells whether an object has constituents. |
| HasProjectFolderConstituents(PdmProjectFolderId) | Tells whether a project folder has constituents. |
| ImportDictionnaries(List<PdmObjectId>, string[], Dictionary<string, string>) | Imports dictionnaries documents from specified files if they correspond to specified project identifiers. |
| ImportFile(string, PdmObjectId, string) | Imports a file without conversion. |
| ImportLocalizations(string, string, Dictionary<string, string>) | Imports all localization files (.TopDic or .xliff) contained into given directory. |
| ImportPackageAsDistinctCopy(string, bool, bool) | Imports a package as disctinct copy. |
| ImportPackageAsReplication(string) | Imports a package with replication. |
| IncludePackageAsDistinctCopy(string, bool, bool, PdmObjectId) | Imports a package as disctinct copy into an existing project. |
| IncludePackageAsReplication(string, PdmObjectId, bool) | Imports a package with replication into an existing folder. |
| IsDirty(PdmObjectId) | Tells whether an object is dirty. |
| IsExternal(PdmObjectId) | Tells whether an object is external (i.e. item is a non TopSolid V7 document: .docx, .xlsx, .pdf, .png etc...). |
| 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) | Moves several objects. |
| NeedsGettingLatestRevision(PdmObjectId) | Tells whether specified object or its children need getting latest revision. |
| NeedsUpdating(PdmObjectId) | Tells whether specified object needs updating. |
| OpenMinorRevision(PdmMinorRevisionId, bool) | Opens a document. |
| OpenMinorRevisionInAnalysisMode(PdmMinorRevisionId) | Opens a document in analysis mode. |
| OpenProject(PdmObjectId) | Opens a project. |
| PurgeRevisions(List<PdmObjectId>, int, bool, int, int, out long, out int) | Purges the revisions of PDM objects. |
| 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. |
| RestoreMinorRevision(PdmMinorRevisionId) | Restores a minor revision as the last minor revision. |
| Save(PdmObjectId, bool) | Saves an object. |
| SaveAll() | Save all documents. |
| SaveSeveral(List<PdmObjectId>, bool) | Saves several objects. |
| SearchDocumentByName(PdmObjectId, string) | Searches for a document by its name. |
| SearchDocumentByNameWithWildcards(PdmObjectId, string) | Searches for a document by its name using wildcards. |
| SearchDocumentByPartNumber(PdmObjectId, string) | Searches for a document by its part number. |
| SearchDocumentByPartNumberWithWildcards(PdmObjectId, string) | Searches for a document by its part number using wildcards. |
| SearchDocumentByUniversalId(PdmObjectId, string, string) | Searches for a document by its universal identifier. |
| SearchDocumentsProvidingFunction(PdmMinorRevisionId, List<PdmObjectId>, bool, List<string>, bool, int) | Searches for documents which provide specified function. |
| SearchExternalObjectsWithProperties(List<PdmObjectId>, bool, List<string>, bool, int) | Searches external PDM objects with several properties. |
| SearchFolderByName(PdmObjectId, string) | Searches for a folder by its name. |
| SearchMajorRevisionBackReferences(PdmObjectId, PdmMajorRevisionId) | Searches all back references of a document major revision. |
| SearchMinorRevisionBackReferences(PdmObjectId, PdmMinorRevisionId) | Searches all back references of a document minor revision. |
| SearchMinorRevisionReferences(PdmMinorRevisionId) | Searches all references of a document minor revision. |
| SearchObjectsWithProperties(List<PdmObjectId>, bool, List<string>, bool, int) | Searches PDM objects with several properties. |
| SearchProjectByName(string) | Searches for a project by its name. |
| SearchPropertyDefinitionInfo(PropertyDefinition, out string, out string, out PropertyType) | Searches for a specified property definition information. |
| SearchUserEnumerationLocalizedText(PropertyDefinition, int) | Searches for the localized text corresponding to a specified user enumeration property value. |
| 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. |
| SetMajorRevisionLifeCycleMainState(PdmMajorRevisionId, PdmLifeCycleMainState) | Changes the life cycle main state of a major revision. |
| SetMajorRevisionLifeCycleSubState(PdmMajorRevisionId, PdmObjectId) | Change the life cycle sub state of a major revision. |
| 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. |
| SetProjectMainDocument(PdmObjectId, PdmObjectId) | Sets the main document of a specified project. |
| SetRealUserProperty(PdmObjectId, PdmObjectId, Real) | Sets the value of a specified real user property of an object. |
| SetRevisionTexts(PdmObjectId, string, string) | Sets the major and minor revision texts of an object. |
| SetTextUserProperty(PdmObjectId, PdmObjectId, string) | Sets the value of a specified text user property of an object. |
| ShowInProjectTree(PdmObjectId) | Show the object in the project tree. |
| UndoCheckOut(PdmObjectId) | Undoes the check-out of an object. |
| UpdateDocumentReferences(PdmMinorRevisionId) | Updates the references of a document minor revision. |