Interface IPdm
Gives access to the PDM.
Namespace: TopSolid.Kernel.Automating
Assembly: cs.temp.dll.dll
Syntax
[AvailableSinceVersion(7, 6, 0, 0)]
public interface IPdmRemarks
This interface is available since v7.6.
Properties
LibraryProjectsRootFolder
Gets the library projects root folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
PdmProjectFolderId LibraryProjectsRootFolder { get; }Property Value
| Type | Description |
|---|---|
| PdmProjectFolderId |
Remarks
This property is available since v7.9.
Name
Gets the name of PDM (i.e. the localized name of PDM connection).
Declaration
[AvailableSinceVersion(7, 17, 400, 60)]
string Name { get; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
This property is available since v7.17 SP3.
WorkingProjectsRootFolder
Gets the working projects root folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
PdmProjectFolderId WorkingProjectsRootFolder { get; }Property Value
| Type | Description |
|---|---|
| PdmProjectFolderId |
Remarks
This property is available since v7.9.
Methods
AddReferencedProjects(PdmObjectId, List<PdmObjectId>)
Adds referenced projects to a project.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void AddReferencedProjects(PdmObjectId inProjectId, List<PdmObjectId> inReferencedProjectIds)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier. |
| List<PdmObjectId> | inReferencedProjectIds | Referenced project identifiers to add. |
Remarks
Project is saved automatically after adding a reference.
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
CheckIn(PdmObjectId, Boolean)
Checks-in an object.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void CheckIn(PdmObjectId inObjectId, bool inRecurses)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier. |
| Boolean | inRecurses | Tells if to recurse on objects contained. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
CheckInSeveral(List<PdmObjectId>, Boolean)
Checks-in several objects.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void CheckInSeveral(List<PdmObjectId> inObjectIds, bool inRecurses)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| Boolean | inRecurses | Tells if to recurse on objects contained. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
CheckOut(PdmObjectId)
Checks-out an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void CheckOut(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM 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.8.303.100.
CloseProject(PdmObjectId)
Closes a project.
Declaration
[AvailableSinceVersion(7, 11, 0, 0)]
void CloseProject(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier. |
Remarks
This method is available since v7.11.
CopySeveral(List<PdmObjectId>, PdmObjectId)
Copies several objects.
Declaration
[AvailableSinceVersion(7, 7, 201, 140)]
List<PdmObjectId> CopySeveral(List<PdmObjectId> inObjectIds, PdmObjectId inOwnerId)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | Identifiers of objects to copy. |
| PdmObjectId | inOwnerId | Identifier of project or folder owner where to copy objects. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | New PDM object identifiers. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.201.140.
CopySeveral2(List<PdmObjectId>, PdmObjectId, Boolean)
Copies several objects.
Declaration
[AvailableSinceVersion(7, 15, 400, 240)]
List<PdmObjectId> CopySeveral2(List<PdmObjectId> inObjectIds, PdmObjectId inOwnerId, bool inKeepPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | Identifiers of objects to copy. |
| PdmObjectId | inOwnerId | Identifier of project or folder owner where to copy objects. |
| Boolean | inKeepPartNumber | Whether keeps the same part number |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | New PDM object identifiers. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.201.140.
CreateDocument(PdmObjectId, String, Boolean)
Creates a TopSolid document.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
PdmObjectId CreateDocument(PdmObjectId inOwnerId, string inExtension, bool inUseDefaultTemplate)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inOwnerId | Identifier of owner. |
| String | inExtension | File extension of the document to create, starting with the '.' character. |
| Boolean | inUseDefaultTemplate | Tells whether to use the default template if present. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | PDM object identifier of the created document. |
Remarks
To obtain the extension corresponding to a TopSolid document, one must create such a document in TopSolid, select it in the projet tree and use the "Document Type..." command in the contextual "Tools" menu (TopSolid must be started with the "-a" command line option as this command is only available in the advanced mode).
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
CreateDocumentWithTemplate(PdmObjectId, PdmObjectId)
Creates a TopSolid document with a template.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
PdmObjectId CreateDocumentWithTemplate(PdmObjectId inOwnerId, PdmObjectId inTemplateObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inOwnerId | Identifier of owner. |
| PdmObjectId | inTemplateObjectId | Identifier of the template. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Identifier of the created document. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
CreateFolder(PdmObjectId, String)
Creates a folder.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
PdmObjectId CreateFolder(PdmObjectId inObjectId, string inFolderName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier of a project or a folder where the new folder is to be created. |
| String | inFolderName | Name of the new folder. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Identifier of the created folder. |
Remarks
If creation fails, the returned identifier is empty.
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
CreateLifeCycleSubState(PdmLifeCycleMainState, String)
Creates new life cycle sub state.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
void CreateLifeCycleSubState(PdmLifeCycleMainState inLifeCycleMainState, string inLifeCycleSubStateName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmLifeCycleMainState | inLifeCycleMainState | Associated life cycle main state. |
| String | inLifeCycleSubStateName | Life cycle sub state name. |
CreateProject(String, Boolean)
Creates a project.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
PdmObjectId CreateProject(string inProjectName, bool inIsLibrary)Parameters
| Type | Name | Description |
|---|---|---|
| String | inProjectName | Project name. |
| Boolean | inIsLibrary | Whether it is a library to create or a working project. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | PDM object identifier of the created project. |
Remarks
If creation fails, the returned PDM object identifier is empty.
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
CreateProjectFolder(PdmProjectFolderId, String)
Creates a project folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
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. |
| 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 must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.
CreateProjectWithTemplate(String, PdmObjectId)
Creates a project with a template.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
PdmObjectId CreateProjectWithTemplate(string inProjectName, PdmObjectId inTemplateObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| String | inProjectName | Project name. |
| PdmObjectId | inTemplateObjectId | PDM object identifier of the template. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | PDM object identifier of the created project. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.
DeleteProjectFolder(PdmProjectFolderId)
Deletes an empty project folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
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 must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.
DeleteSeveral(List<PdmObjectId>)
Deletes several objects.
Declaration
[AvailableSinceVersion(7, 7, 201, 140)]
void DeleteSeveral(List<PdmObjectId> inObjectIds)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | Identifiers of objects to delete. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.201.140.
EnsureIsDirty(PdmObjectId)
Ensures that an object is dirty to allow further modifications.
Declaration
[AvailableSinceVersion(7, 9, 300, 80)]
void EnsureIsDirty(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM 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.9.300.80.
Exists(PdmObjectId)
Tells whether a PDM object still exists.
Declaration
[AvailableSinceVersion(7, 6, 301, 120)]
bool Exists(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of the PDM object to analyze. |
Returns
| Type | Description |
|---|---|
| Boolean | The PDM object still exists. |
Remarks
This method is available since v7.6.301.120.
ExportDictionaries(List<PdmObjectId>, CultureInfo[], String[])
Exports dictionaries (.TopDic file).
Declaration
[AvailableSinceVersion(7, 15, 300, 0)]
void ExportDictionaries(List<PdmObjectId> inProjects, CultureInfo[] inCultures, string[] inFileFullNames)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inProjects | Identifiers of projects to export. |
| CultureInfo[] | inCultures | Cultures to export. |
| String[] | inFileFullNames | Dictionnaries files full names. |
Remarks
This method is available since v7.15.300.000.
ExportDictionaryPackage(PdmObjectId, Boolean, CultureInfo, String, String)
Export dictionary package (.TopDicPkg).
Declaration
[AvailableSinceVersion(7, 19, 55, 0)]
void ExportDictionaryPackage(PdmObjectId inProjectId, bool inIsToDeliver, CultureInfo inCulture, string inPackageFileFullName, string inFileFullName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier. |
| Boolean | inIsToDeliver | Whether is to deliver. |
| CultureInfo | inCulture | Culture |
| String | inPackageFileFullName | File full name of the reference package. |
| String | inFileFullName | File full name of the created dictionary package. |
ExportExecutablePackage(List<PdmObjectId>, Boolean, Boolean, Boolean, String)
Exports an executable package.
Declaration
[AvailableSinceVersion(7, 8, 303, 200)]
void ExportExecutablePackage(List<PdmObjectId> inObjectIds, bool inExportsForDelivery, bool inExportsIncrementalPackage, bool inAllowsMeasurement, string inFileFullPath)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| Boolean | inExportsForDelivery | Whether exports for delivery. |
| Boolean | inExportsIncrementalPackage | Whether exports an incremental package. |
| Boolean | inAllowsMeasurement | Whether allows measurement. |
| 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 must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.200.
ExportLocalizations(List<PdmObjectId>, CultureInfo[], String, String, Boolean)
Exports localizations (.TopDic or .xliff file).
Declaration
[AvailableSinceVersion(7, 19, 55, 0)]
void ExportLocalizations(List<PdmObjectId> inProjectIds, CultureInfo[] inCultures, string inDirectoryPath, string inFileExtension, bool inCreateFolderPath)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inProjectIds | Identifiers of projects to export. |
| CultureInfo[] | inCultures | Cultures to export. |
| String | inDirectoryPath | Directory path where translation files are stored. |
| String | inFileExtension | File extension (must be .TopDic or .xliff). |
| Boolean | inCreateFolderPath | Create folders reproducing the full path of the projects. |
ExportMinorRevisionFile(PdmMinorRevisionId, String)
Exports a non TopSolid document minor revision to a file without conversion.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
void ExportMinorRevisionFile(PdmMinorRevisionId inMinorRevisionId, string inFullName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of document minor revision to export. |
| String | inFullName | Full name of the file to create. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.
ExportPackage(List<PdmObjectId>, Boolean, Boolean, String)
Exports a package.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void ExportPackage(List<PdmObjectId> inObjectIds, bool inExportsForDelivery, bool inExportsIncrementalPackage, string inFileFullPath)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| Boolean | inExportsForDelivery | Whether exports for delivery. |
| Boolean | inExportsIncrementalPackage | Whether exports an incremental package. |
| String | inFileFullPath | Full path of the exported package, with ".TopPkg" extension. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
ExportToBabylon(PdmObjectId, String, String)
Export a document to a Babylon file.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
void ExportToBabylon(PdmObjectId inDocumentId, string inFolderPath, string inFileName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inDocumentId | Document identifier. |
| String | inFolderPath | Path of export folder. |
| String | inFileName | File name. |
Remarks
This method is available since v7.10.
ExportViewerPackage(List<PdmObjectId>, Boolean, Boolean, Boolean, String)
Exports a viewer package.
Declaration
[AvailableSinceVersion(7, 8, 303, 200)]
void ExportViewerPackage(List<PdmObjectId> inObjectIds, bool inExportsForDelivery, bool inExportsIncrementalPackage, bool inAllowsMeasurement, string inFileFullPath)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| Boolean | inExportsForDelivery | Whether exports for delivery. |
| Boolean | inExportsIncrementalPackage | Whether exports an incremental package. |
| Boolean | inAllowsMeasurement | Whether allows measurement. |
| 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 must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.200.
GetAuthor(PdmObjectId)
Gets the author of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
string GetAuthor(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object author. |
Remarks
This method is available since v7.8.303.100.
GetComment(PdmObjectId)
Gets the comment of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
string GetComment(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object comment. |
Remarks
This method is available since v7.8.303.100.
GetComplementaryPartNumber(PdmObjectId)
Gets the complementary part number of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
string GetComplementaryPartNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object complementary part number. |
Remarks
This method is available since v7.8.303.100.
GetConstituents(PdmObjectId, out List<PdmObjectId>, out List<PdmObjectId>)
Gets the constituents of an object.
Declaration
[AvailableSinceVersion(7, 6, 301, 120)]
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.6.301.120.
GetCurrentProject()
Gets the current projects.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
PdmObjectId GetCurrentProject()Returns
| Type | Description |
|---|---|
| PdmObjectId | Current project PDM object identifier. |
Remarks
If there is no current project, the returned PDM object identifier is empty.
This method is available since v7.14.
GetDescription(PdmObjectId)
Gets the description of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
string GetDescription(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object description. |
Remarks
This method is available since v7.8.303.100.
GetExportedObjectIds(String)
Get the list of the object identifiers selected during the export of given package file.
Declaration
[AvailableSinceVersion(7, 18, 321, 0)]
List<PdmObjectId> GetExportedObjectIds(string inPackageFileFullPath)Parameters
| Type | Name | Description |
|---|---|---|
| String | inPackageFileFullPath | Full path of the package file, with ".TopPkg" extension. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | 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.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
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.9.
GetLastMajorRevision(PdmObjectId)
Gets the last major revision contained in a PDM object.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
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.7.
GetLastMinorRevision(PdmMajorRevisionId)
Gets the last minor revision contained in a major revision.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
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.7.
GetLatestRevision(PdmObjectId)
Gets latest revision of specified object and of its children.
Declaration
[AvailableSinceVersion(7, 7, 201, 180)]
void GetLatestRevision(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of object to update. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.201.180.
GetLifeCycleMainState(PdmObjectId)
Gets the life cycle main state of an object.
Declaration
[AvailableSinceVersion(7, 9, 302, 160)]
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.9.302.160.
GetLifeCycleSubStates(PdmLifeCycleMainState, out SCG.List<PdmObjectId>, out SCG.List<String>)
Gets sub states of specified main state.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
void GetLifeCycleSubStates(PdmLifeCycleMainState inLifeCycleMainState, out SCG.List<PdmObjectId> outLifeCycleSubStateIds, out SCG.List<string> outLifeCycleSubStateNames)Parameters
| Type | Name | Description |
|---|---|---|
| PdmLifeCycleMainState | inLifeCycleMainState | Life cycle main state. |
| SCG.List<PdmObjectId> | outLifeCycleSubStateIds | Life cycle sub state object identifiers. |
| SCG.List<String> | outLifeCycleSubStateNames | Life cycle sub state names. |
GetMajorRevision(PdmMinorRevisionId)
Gets the major revision containing a specified minor revision.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetMajorRevisionLifeCycleMainState(PdmMajorRevisionId)
Gets the life cycle main state of a major revision.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
PdmLifeCycleMainState GetMajorRevisionLifeCycleMainState(PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of major revision to get life cycle main state. |
Returns
| Type | Description |
|---|---|
| PdmLifeCycleMainState | Life cycle of the document. |
Remarks
This method is available since v7.10.
GetMajorRevisionLifeCycleSubState(PdmMajorRevisionId)
Gets the life cycle sub state of a major revision.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
PdmObjectId GetMajorRevisionLifeCycleSubState(PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of major revision to get life cycle sub state. |
Returns
| Type | Description |
|---|---|
| PdmObjectId |
GetMajorRevisions(PdmObjectId)
Gets the major revisions contained in a PDM object.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetMajorRevisionText(PdmMajorRevisionId)
Gets the text of a major revision.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
string GetMajorRevisionText(PdmMajorRevisionId inMajorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of the major revision. |
Returns
| Type | Description |
|---|---|
| String | Text of the major revision. |
Remarks
This method is available since v7.6.
GetManufacturer(PdmObjectId)
Gets the manufacturer of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
string GetManufacturer(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object manufacturer. |
Remarks
This method is available since v7.8.303.100.
GetManufacturerPartNumber(PdmObjectId)
Gets the manufacturer part number of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
string GetManufacturerPartNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object manufacturer part number. |
Remarks
This method is available since v7.8.303.100.
GetMinorRevisionFileSize(PdmMinorRevisionId)
Gets the size of the file of a minor revision.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
long GetMinorRevisionFileSize(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the minor revision. |
Returns
| Type | Description |
|---|---|
| Int64 | Size (in bytes) of the file of the minor revision. |
Remarks
This method is available since v7.7.
GetMinorRevisionFileVersion(PdmMinorRevisionId)
Gets the version of the application used to save the file of a minor revision.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
int GetMinorRevisionFileVersion(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the minor revision. |
Returns
| Type | Description |
|---|---|
| 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.9.
GetMinorRevisionPreviewBitmap(PdmMinorRevisionId)
Gets the preview bitmap of a minor revision.
Declaration
[AvailableSinceVersion(7, 8, 302, 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.8.302.80.
GetMinorRevisions(PdmMajorRevisionId)
Gets the minor revisions contained in a major revision.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetMinorRevisionText(PdmMinorRevisionId)
Gets the text of a minor revision.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
string GetMinorRevisionText(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the minor revision. |
Returns
| Type | Description |
|---|---|
| String | Text of the minor revision. |
Remarks
This method is available since v7.6.
GetName(PdmObjectId)
Gets the name of an object.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
string GetName(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object name. |
Remarks
This method is available since v7.6.
GetObjectsFromRecycleBin(PdmObjectId)
Gets the objects from the recycle bin.
Declaration
[AvailableSinceVersion(7, 15, 400, 220)]
List<PdmObjectId> GetObjectsFromRecycleBin(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | The objects from the recycle bin. |
Remarks
This method is available since v7.15.400.220.
GetOpenProjects(Boolean, Boolean)
Gets all opened projects.
Declaration
[AvailableSinceVersion(7, 13, 0, 0)]
List<PdmObjectId> GetOpenProjects(bool inGetsWorkingProjects, bool inGetsLibraryProjects)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | inGetsWorkingProjects | Gets working projects. |
| Boolean | inGetsLibraryProjects | Gets library projects. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | List of projects PDM object identifiers. |
Remarks
This method is available since v7.13.
GetOwner(PdmObjectId)
Gets the owner of an object.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetPartNumber(PdmObjectId)
Gets the part number of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
string GetPartNumber(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object part number. |
Remarks
This method is available since v7.8.303.100.
GetPdmObject(PdmMajorRevisionId)
Gets the PDM object containing a specified major revision.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetProject(PdmObjectId)
Gets the project of an object.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetProjectFolderConstituents(PdmProjectFolderId, out List<PdmProjectFolderId>, out List<PdmObjectId>)
Gets the constituents of a project folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
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.9.
GetProjectFolderName(PdmProjectFolderId)
Gets the name of a project folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
string GetProjectFolderName(PdmProjectFolderId inProjectFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderId | Project folder identifier. |
Returns
| Type | Description |
|---|---|
| String | Project folder name. |
Remarks
This method is available since v7.9.
GetProjectFolderOwner(PdmProjectFolderId)
Gets the project folder containing a specified project folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
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.9.
GetProjectMainDocument(PdmObjectId)
Gets the main document of a specified project.
Declaration
[AvailableSinceVersion(7, 11, 0, 0)]
PdmObjectId GetProjectMainDocument(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project object identifier. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Identifier of the main document of the project or Empty if not defined. |
Remarks
This method is available since v7.11.
GetProjectOwner(PdmObjectId)
Gets the project folder containing a specified project.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
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.9.
GetProjects(Boolean, Boolean)
Gets all the projects.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
List<PdmObjectId> GetProjects(bool inGetsWorkingProjects, bool inGetsLibraryProjects)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | inGetsWorkingProjects | Gets working projects. |
| Boolean | inGetsLibraryProjects | Gets library projects. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | List of projects PDM object identifiers. |
Remarks
This method is available since v7.6.
GetProjectTemplates(PdmObjectId, out PdmObjectId, out PdmObjectId)
Gets the "Templates" and "Templates/Defaults" folders of a project.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void GetProjectTemplates(PdmObjectId inProjectId, out PdmObjectId outTemplatesFolderId, out PdmObjectId outDefaultsFolderId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | PDM object identifier of the project. |
| PdmObjectId | outTemplatesFolderId | PDM object identifier of the templates folder. |
| PdmObjectId | outDefaultsFolderId | PDM object identifier of the defaults folder. |
Remarks
This method is available since v7.6.
GetRealUserProperty(PdmObjectId, PdmObjectId)
Gets the value of a specified real user property of an object.
Declaration
[AvailableSinceVersion(7, 9, 300, 40)]
Real? GetRealUserProperty(PdmObjectId inObjectId, PdmObjectId inPropertyObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| PdmObjectId | inPropertyObjectId | Object identifier of property definition document. |
Returns
| Type | Description |
|---|---|
| Nullable<Real> | Property value, or |
Remarks
If the object to analyze does not have a property corresponding to the specified type (i.e. corresponding
to the specified property definition document), this method returns null without throwing any exception.
This method is available since v7.9.300.040.
GetReferencedProjects(PdmObjectId)
Gets the referenced projects of a project.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
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.6.
GetRevisionTexts(PdmObjectId, out String, out String)
Gets the major and minor revision texts of an object.
Declaration
[AvailableSinceVersion(7, 9, 300, 80)]
void GetRevisionTexts(PdmObjectId inObjectId, out string outMajorText, out string outMinorText)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | outMajorText | Major revision text. |
| String | outMinorText | Minor revision text. |
Remarks
This method is available since v7.9.300.80.
GetSavingDate(PdmObjectId)
Gets the modification date of an object.
Declaration
[AvailableSinceVersion(7, 19, 119, 0)]
string GetSavingDate(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
Returns
| Type | Description |
|---|---|
| String | Object modification date. |
Remarks
This method is available since v7.19.119.0.
GetSelectedPdmObjectIds()
Gets selected PDM objects ids of the current project.
Declaration
[AvailableSinceVersion(7, 14, 300, 140)]
SCG.List<PdmObjectId> GetSelectedPdmObjectIds()Returns
| Type | Description |
|---|---|
| SCG.List<PdmObjectId> | PDM object identifiers of selected objects of the PDM tree view. |
Remarks
This method is available since v7.14.300.140.
GetState(PdmObjectId)
Gets the state of an object.
Declaration
[AvailableSinceVersion(7, 6, 301, 120)]
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.6.301.120.
GetTemplates(out PdmObjectId, out PdmObjectId, out PdmObjectId, out PdmObjectId)
Gets all the templates.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void GetTemplates(out PdmObjectId outUserDocumentTemplatesProjectId, out PdmObjectId outCompanyDocumentTemplatesProjectId, out PdmObjectId outUserProjectTemplatesProjectId, out PdmObjectId outCompanyProjectTemplatesProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | outUserDocumentTemplatesProjectId | PDM object identifier of user document templates project. |
| PdmObjectId | outCompanyDocumentTemplatesProjectId | PDM object identifier of company document templates project. |
| PdmObjectId | outUserProjectTemplatesProjectId | PDM object identifier of user project templates project. |
| PdmObjectId | outCompanyProjectTemplatesProjectId | PDM object identifier of company project templates project. |
Remarks
This method is available since v7.6.
GetTextUserProperty(PdmObjectId, PdmObjectId)
Gets the value of a specified text user property of an object.
Declaration
[AvailableSinceVersion(7, 9, 300, 40)]
string GetTextUserProperty(PdmObjectId inObjectId, PdmObjectId inPropertyObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| PdmObjectId | inPropertyObjectId | Object identifier of property definition document. |
Returns
| Type | Description |
|---|---|
| String | Property value, or |
Remarks
If the object to analyze does not have a property corresponding to the specified type (i.e. corresponding
to the specified property definition document), this method returns null without throwing any exception.
This method is available since v7.9.300.040.
GetType(PdmObjectId, out String)
Gets the type of an object.
Declaration
[AvailableSinceVersion(7, 6, 301, 120)]
PdmObjectType GetType(PdmObjectId inObjectId, out string outExtension)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | outExtension | Document file extension, or null if not a document. |
Returns
| Type | Description |
|---|---|
| PdmObjectType | Object type. |
Remarks
This method is available since v7.6.301.120.
HasConstituents(PdmObjectId)
Tells whether an object has constituents.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
bool HasConstituents(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier of a project, a folder or a document. |
Returns
| Type | Description |
|---|---|
| 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.9.
HasProjectFolderConstituents(PdmProjectFolderId)
Tells whether a project folder has constituents.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
bool HasProjectFolderConstituents(PdmProjectFolderId inProjectFolderdId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderdId | Project folder identifier. |
Returns
| Type | Description |
|---|---|
| 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.9.
ImportDictionnaries(List<PdmObjectId>, String[], SCG.Dictionary<String, String>)
Imports dictionnaries documents from specified files if they correspond to specified project identifiers.
Declaration
[AvailableSinceVersion(7, 15, 300, 0)]
void ImportDictionnaries(List<PdmObjectId> inProjects, string[] inFileFullNames, SCG.Dictionary<string, string> ioErrorMessages)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inProjects | Identifiers of projects. |
| String[] | inFileFullNames | Dictionnaries files full names. |
| SCG.Dictionary<String, String> | ioErrorMessages | Error messages. |
Remarks
This method is available since v7.15.300.000.
ImportFile(String, PdmObjectId, String)
Imports a file without conversion.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
PdmObjectId ImportFile(string inFullName, PdmObjectId inOwnerId, string inDocumentName)Parameters
| Type | Name | Description |
|---|---|---|
| String | inFullName | Full name of the file to import. |
| PdmObjectId | inOwnerId | PDM object identifier of project or folder owner where imported file is to be stored. |
| String | inDocumentName | Name of the new document. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Identifier of the created document. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.
ImportLocalizations(String, String, SCG.Dictionary<String, String>)
Imports all localization files (.TopDic or .xliff) contained into given directory.
Declaration
[AvailableSinceVersion(7, 19, 55, 0)]
void ImportLocalizations(string inDirectoryPath, string inFileExtension, SCG.Dictionary<string, string> ioErrorMessages)Parameters
| Type | Name | Description |
|---|---|---|
| String | inDirectoryPath | Directory path. |
| String | inFileExtension | File extension (must be .TopDic or .xliff). |
| SCG.Dictionary<String, String> | ioErrorMessages | Error messages. |
ImportPackageAsDistinctCopy(String, Boolean, Boolean)
Imports a package as disctinct copy.
Declaration
[AvailableSinceVersion(7, 8, 303, 200)]
List<PdmObjectId> ImportPackageAsDistinctCopy(string inFileFullPath, bool inResetsCreationProperties, bool inAllowsPartNumbering)Parameters
| Type | Name | Description |
|---|---|---|
| String | inFileFullPath | Full path of the package file, with ".TopPkg" extension. |
| Boolean | inResetsCreationProperties | Whether to reset creation properties (author, creation date, major/minor revision text). |
| Boolean | inAllowsPartNumbering | Whether to allow automatic part numbering. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | List of imported projects PDM object identifiers. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.200.
ImportPackageAsReplication(String)
Imports a package with replication.
Declaration
[AvailableSinceVersion(7, 8, 303, 200)]
List<PdmObjectId> ImportPackageAsReplication(string inFileFullPath)Parameters
| Type | Name | Description |
|---|---|---|
| String | inFileFullPath | Full path of the package file, with ".TopPkg" extension. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | List of imported projects PDM object identifiers. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.200.
IncludePackageAsDistinctCopy(String, Boolean, Boolean, PdmObjectId)
Imports a package as disctinct copy into an existing project.
Declaration
[AvailableSinceVersion(7, 8, 303, 200)]
void IncludePackageAsDistinctCopy(string inFileFullPath, bool inResetsCreationProperties, bool inAllowsPartNumbering, PdmObjectId inOwnerId)Parameters
| Type | Name | Description |
|---|---|---|
| String | inFileFullPath | Full path of the package file, with ".TopPkg" extension. |
| Boolean | inResetsCreationProperties | Whether to reset creation properties (author, creation date, major/minor revision text). |
| Boolean | inAllowsPartNumbering | Whether to allow automatic part numbering. |
| PdmObjectId | inOwnerId | PDM object identifier of project or folder owner where imported documents are to be stored. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.200.
IncludePackageAsReplication(String, PdmObjectId, Boolean)
Imports a package with replication into an existing folder.
Declaration
[AvailableSinceVersion(7, 19, 39, 0)]
List<PdmObjectId> IncludePackageAsReplication(string inFileFullPath, PdmObjectId inOwnerId, bool inUpdatesEvenIfConflict)Parameters
| Type | Name | Description |
|---|---|---|
| String | inFileFullPath | Full path of the package file, with ".TopPkg" extension. |
| PdmObjectId | inOwnerId | Pdm object id of folder owner where imported file is to be stored or empty to import in root project. |
| Boolean | inUpdatesEvenIfConflict | Whether updates with imported version even if there is a conflict. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | List of imported projects PDM object identifiers. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.19.039.000.
IsDirty(PdmObjectId)
Tells whether an object is dirty.
Declaration
[AvailableSinceVersion(7, 9, 300, 80)]
bool IsDirty(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier. |
Returns
| Type | Description |
|---|---|
| Boolean | The object is dirty. |
Remarks
An object is said dirty when it has been modified since it was last saved.
This method is available since v7.9.300.80.
IsExternal(PdmObjectId)
Tells whether an object is external (i.e. item is a non TopSolid V7 document: .docx, .xlsx, .pdf, .png etc...).
Declaration
[AvailableSinceVersion(7, 16, 324, 0)]
bool IsExternal(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier. |
Returns
| Type | Description |
|---|---|
| Boolean | The object is external. |
IsLibraryProject(PdmObjectId)
Tells if a project is a library.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
bool IsLibraryProject(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier. |
Returns
| Type | Description |
|---|---|
| Boolean | The project is a library. |
Remarks
This method is available since v7.6.
MoveProject(PdmObjectId, PdmProjectFolderId)
Moves a project into a specified project folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
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 must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.
MoveProjectFolder(PdmProjectFolderId, PdmProjectFolderId)
Moves a project folder into a specified project folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
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 must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.
MoveSeveral(List<PdmObjectId>, PdmObjectId)
Moves several objects.
Declaration
[AvailableSinceVersion(7, 8, 303, 140)]
void MoveSeveral(List<PdmObjectId> inObjectIds, PdmObjectId inOwnerId)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | Identifiers of objects to move. |
| PdmObjectId | inOwnerId | Identifier of project or folder owner 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 owner it must be that project, and when specifying a folder owner it must belong to that project.
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.140.
NeedsGettingLatestRevision(PdmObjectId)
Tells whether specified object or its children need getting latest revision.
Declaration
[AvailableSinceVersion(7, 7, 201, 180)]
bool NeedsGettingLatestRevision(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of object to analyze. |
Returns
| Type | Description |
|---|---|
| Boolean | Specified object or its children need getting latest revision. |
Remarks
This method is available since v7.7.201.180.
NeedsUpdating(PdmObjectId)
Tells whether specified object needs updating.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
bool NeedsUpdating(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of document to analyze. |
Returns
| Type | Description |
|---|---|
| Boolean | Specified object needs updating. |
Remarks
This method is available since v7.10.
OpenMinorRevision(PdmMinorRevisionId, Boolean)
Opens a document.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
void OpenMinorRevision(PdmMinorRevisionId inMinorRevisionId, bool inReadOnly)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of document minor revision. |
| Boolean | inReadOnly | Open in read-only mode. |
Remarks
This method is available since v7.10.
OpenMinorRevisionInAnalysisMode(PdmMinorRevisionId)
Opens a document in analysis mode.
Declaration
[AvailableSinceVersion(7, 14, 300, 280)]
void OpenMinorRevisionInAnalysisMode(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of document minor revision. |
Remarks
This method is available since v7.14.300.200.
OpenProject(PdmObjectId)
Opens a project.
Declaration
[AvailableSinceVersion(7, 9, 300, 100)]
void OpenProject(PdmObjectId inProjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project identifier. |
Remarks
This method is available since v7.9.300.100.
PurgeRevisions(SCG.List<PdmObjectId>, Int32, Boolean, Int32, Int32, out Int64, out Int32)
Purges the revisions of PDM objects.
Declaration
[AvailableSinceVersion(7, 19, 400, 140)]
void PurgeRevisions(SCG.List<PdmObjectId> inObjectIds, int inMaximumMajorRevisionCountToKeep, bool inOnlyObsoleteMajorRevisions, int inMaximumMinorRevisionCountToKeep, int inMaximumBackupCountToKeep, out long outFileSize, out int outFileCount)Parameters
| Type | Name | Description |
|---|---|---|
| SCG.List<PdmObjectId> | inObjectIds | PDM objects to purge. |
| Int32 | inMaximumMajorRevisionCountToKeep | Maximum major revisions count to keep, or -1 if major revisions are not purged. |
| Boolean | inOnlyObsoleteMajorRevisions | Purge only the obsolete major revisions. |
| Int32 | inMaximumMinorRevisionCountToKeep | Maximum minor revisions count to keep, or -1 if minor revisions are not purged. |
| Int32 | inMaximumBackupCountToKeep | Maximum backup count to keep, or -1 if backups are not purged. |
| Int64 | outFileSize | Purged files size. |
| Int32 | outFileCount | Purged files count. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.201.140.
PurgeSeveral(List<PdmObjectId>)
Purges several deleted objects.
Declaration
[AvailableSinceVersion(7, 7, 201, 140)]
void PurgeSeveral(List<PdmObjectId> inObjectIds)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | Identifiers of objects to purge. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.201.140.
ReimportFile(String, PdmObjectId)
Reimports a file without conversion.
Declaration
[AvailableSinceVersion(7, 7, 0, 0)]
PdmMinorRevisionId ReimportFile(string inFullName, PdmObjectId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| 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 must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.7.
Restore(PdmObjectId)
Restores a deleted object.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
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, 6, 0, 0)]
void RestoreLastSave(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.6.
RestoreMinorRevision(PdmMinorRevisionId)
Restores a minor revision as the last minor revision.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
void RestoreMinorRevision(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Minor revision identifier. |
Remarks
This method is available since v7.10.
Save(PdmObjectId, Boolean)
Saves an object.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void Save(PdmObjectId inObjectId, bool inRecurses)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | PDM object identifier. |
| Boolean | inRecurses | Tells if to recurse on objects contained. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
SaveAll()
Save all documents.
Declaration
[AvailableSinceVersion(7, 16, 100, 0)]
void SaveAll()SaveSeveral(List<PdmObjectId>, Boolean)
Saves several objects.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void SaveSeveral(List<PdmObjectId> inObjectIds, bool inRecurses)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inObjectIds | PDM object identifiers. |
| Boolean | inRecurses | Tells if to recurse on objects contained. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.6.
SearchDocumentByName(PdmObjectId, String)
Searches for a document by its name.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
List<PdmObjectId> SearchDocumentByName(PdmObjectId inProjectId, string inDocumentName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier, or empty for searching in all projects. |
| 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.6.
SearchDocumentByNameWithWildcards(PdmObjectId, String)
Searches for a document by its name using wildcards.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
List<PdmObjectId> SearchDocumentByNameWithWildcards(PdmObjectId inProjectId, string inDocumentName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier, or empty for searching in all projects. |
| String | inDocumentName | Document name, with SQL wildcards (like "%" being a substitute for zero or more characters). |
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, 7, 0, 0)]
List<PdmObjectId> SearchDocumentByPartNumber(PdmObjectId inProjectId, string inPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier, or empty for searching in all projects. |
| 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.7.
SearchDocumentByPartNumberWithWildcards(PdmObjectId, String)
Searches for a document by its part number using wildcards.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
List<PdmObjectId> SearchDocumentByPartNumberWithWildcards(PdmObjectId inProjectId, string inPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier, or empty for searching in all projects. |
| String | inPartNumber | Part number, with SQL wildcards (like "%" being a substitute for zero or more characters). |
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, 6, 0, 0)]
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. |
| String | inDomain | Universal domain. |
| String | inName | Universal name. |
Returns
| Type | Description |
|---|---|
| PdmObjectId | Document PDM object identifier. |
Remarks
This method is available since v7.6.
SearchDocumentsProvidingFunction(PdmMinorRevisionId, SCG.List<PdmObjectId>, Boolean, SCG.List<String>, Boolean, Int32)
Searches for documents which provide specified function.
Declaration
[AvailableSinceVersion(7, 15, 400, 240)]
SCG.List<PdmObjectId> SearchDocumentsProvidingFunction(PdmMinorRevisionId inFunctionMinorRevisionId, SCG.List<PdmObjectId> inProjects, bool inSearchInReferencedProjects, SCG.List<string> inExtensions, bool inSkipDeletedObjects, int inMaxResultCount)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inFunctionMinorRevisionId | Function minor revision id. |
| SCG.List<PdmObjectId> | inProjects | Projects in which to search or null in order to search in all projects. |
| Boolean | inSearchInReferencedProjects | Search in referenced projects of specified projets. |
| SCG.List<String> | inExtensions | Document types to search for or null for all. |
| Boolean | inSkipDeletedObjects | Skip deleted objects. |
| Int32 | inMaxResultCount | Maximum result count allowed, or -1 if no limit. |
Returns
| Type | Description |
|---|---|
| SCG.List<PdmObjectId> | Founded objects. |
Remarks
This method is available since v7.17.400.000.
SearchExternalObjectsWithProperties(List<PdmObjectId>, Boolean, List<String>, Boolean, Int32)
Searches external PDM objects with several properties.
Declaration
[AvailableSinceVersion(7, 18, 400, 180)]
SCG.List<PdmObjectId> SearchExternalObjectsWithProperties(List<PdmObjectId> inProjects, bool inSearchInReferencedProjects, List<string> inExtensions, bool inSkipDeletedObjects, int inMaxResultCount)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inProjects | Projects in which to search or null in order to search in all projects. |
| Boolean | inSearchInReferencedProjects | Search in referenced projects of specified projets. |
| List<String> | inExtensions | Document types to search for or null for all. |
| Boolean | inSkipDeletedObjects | Skip deleted objects. |
| Int32 | inMaxResultCount | Maximum result count allowed, or -1 if no limit. |
Returns
| Type | Description |
|---|---|
| SCG.List<PdmObjectId> | Founded objects. |
Remarks
This method is available since v7.18.400.220.
SearchFolderByName(PdmObjectId, String)
Searches for a folder by its name.
Declaration
[AvailableSinceVersion(7, 13, 0, 0)]
List<PdmObjectId> SearchFolderByName(PdmObjectId inProjectId, string inFolderName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project PDM object identifier, or empty for searching in all projects. |
| String | inFolderName | Folder name. |
Returns
| Type | Description |
|---|---|
| List<PdmObjectId> | PDM object identifiers of documents corresponding to the searched name. |
Remarks
This method is available since v7.13.
SearchMajorRevisionBackReferences(PdmObjectId, PdmMajorRevisionId)
Searches all back references of a document major revision.
Declaration
[AvailableSinceVersion(7, 7, 201, 140)]
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.7.201.140.
SearchMinorRevisionBackReferences(PdmObjectId, PdmMinorRevisionId)
Searches all back references of a document minor revision.
Declaration
[AvailableSinceVersion(7, 7, 201, 140)]
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.7.201.140.
SearchMinorRevisionReferences(PdmMinorRevisionId)
Searches all references of a document minor revision.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
List<PdmMinorRevisionId> SearchMinorRevisionReferences(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the document minor revision to analyze. |
Returns
| Type | Description |
|---|---|
| List<PdmMinorRevisionId> | Referenced minor revisions. |
Remarks
This method is available since v7.10.
SearchObjectsWithProperties(List<PdmObjectId>, Boolean, List<String>, Boolean, Int32)
Searches PDM objects with several properties.
Declaration
[AvailableSinceVersion(7, 15, 400, 220)]
SCG.List<PdmObjectId> SearchObjectsWithProperties(List<PdmObjectId> inProjects, bool inSearchInReferencedProjects, List<string> inExtensions, bool inSkipDeletedObjects, int inMaxResultCount)Parameters
| Type | Name | Description |
|---|---|---|
| List<PdmObjectId> | inProjects | Projects in which to search or null in order to search in all projects. |
| Boolean | inSearchInReferencedProjects | Search in referenced projects of specified projets. |
| List<String> | inExtensions | Document types to search for or null for all. |
| Boolean | inSkipDeletedObjects | Skip deleted objects. |
| Int32 | inMaxResultCount | Maximum result count allowed, or -1 if no limit. |
Returns
| Type | Description |
|---|---|
| SCG.List<PdmObjectId> | Founded objects. |
Remarks
This method is available since v7.15.400.220.
SearchProjectByName(String)
Searches for a project by its name.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
List<PdmObjectId> SearchProjectByName(string inProjectName)Parameters
| Type | Name | Description |
|---|---|---|
| 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.6.
SearchPropertyDefinitionInfo(PropertyDefinition, out String, out String, out PropertyType)
Searches for a specified property definition information.
Declaration
[AvailableSinceVersion(7, 12, 0, 0)]
bool SearchPropertyDefinitionInfo(PropertyDefinition inPropertyDefinition, out string outLocalizedDomainName, out string outLocalizedName, out PropertyType outType)Parameters
| Type | Name | Description |
|---|---|---|
| PropertyDefinition | inPropertyDefinition | Property definition to search for. |
| String | outLocalizedDomainName | Localized domain name of the property definition found, or |
| String | outLocalizedName | Localized name of the property definition found, or |
| PropertyType | outType | Type of the property, or None if not found. |
Returns
| Type | Description |
|---|---|
| Boolean | Whether the property definition has been found. |
Remarks
This method is available since v7.12.
SearchUserEnumerationLocalizedText(PropertyDefinition, Int32)
Searches for the localized text corresponding to a specified user enumeration property value.
Declaration
[AvailableSinceVersion(7, 12, 0, 0)]
string SearchUserEnumerationLocalizedText(PropertyDefinition inPropertyDefinition, int inValue)Parameters
| Type | Name | Description |
|---|---|---|
| PropertyDefinition | inPropertyDefinition | Property definition of type UserEnumeration. |
| Int32 | inValue | User enumeration value. |
Returns
| Type | Description |
|---|---|
| String | Corresponding localized text, or |
Remarks
This method is available since v7.12.
SetAuthor(PdmObjectId, String)
Sets the author of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void SetAuthor(PdmObjectId inObjectId, string inAuthor)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inAuthor | Author. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.100.
SetComment(PdmObjectId, String)
Sets the comment of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void SetComment(PdmObjectId inObjectId, string inComment)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inComment | Comment. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.100.
SetComplementaryPartNumber(PdmObjectId, String)
Sets the complementary part number of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void SetComplementaryPartNumber(PdmObjectId inObjectId, string inComplementaryPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inComplementaryPartNumber | Complementary part number. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.100.
SetDescription(PdmObjectId, String)
Sets the description of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void SetDescription(PdmObjectId inObjectId, string inDescription)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inDescription | Description. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.100.
SetLifeCycleMainState(PdmObjectId, PdmLifeCycleMainState)
Changes the life cycle main state of an object.
Declaration
[AvailableSinceVersion(7, 9, 302, 160)]
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 must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.302.160.
SetMajorRevisionLifeCycleMainState(PdmMajorRevisionId, PdmLifeCycleMainState)
Changes the life cycle main state of a major revision.
Declaration
[AvailableSinceVersion(7, 10, 0, 0)]
void SetMajorRevisionLifeCycleMainState(PdmMajorRevisionId inMajorRevisionId, PdmLifeCycleMainState inLifeCycle)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of major revision to change life cycle main state. |
| PdmLifeCycleMainState | inLifeCycle | Life cycle to apply (None and Design life cycles are not supported). |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.10.
SetMajorRevisionLifeCycleSubState(PdmMajorRevisionId, PdmObjectId)
Change the life cycle sub state of a major revision.
Declaration
[AvailableSinceVersion(7, 14, 248, 0)]
void SetMajorRevisionLifeCycleSubState(PdmMajorRevisionId inMajorRevisionId, PdmObjectId inNewLifeCycleSubStateId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMajorRevisionId | inMajorRevisionId | Identifier of major revision to change life cycle sub state. |
| PdmObjectId | inNewLifeCycleSubStateId | Life cycle sub state object identifier to apply. |
SetManufacturer(PdmObjectId, String)
Sets the manufacturer of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void SetManufacturer(PdmObjectId inObjectId, string inManufacturer)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inManufacturer | Manufacturer. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.100.
SetManufacturerPartNumber(PdmObjectId, String)
Sets the manufacturer part number of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void SetManufacturerPartNumber(PdmObjectId inObjectId, string inManufacturerPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inManufacturerPartNumber | Manufacturer part number. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.100.
SetName(PdmObjectId, String)
Sets the name of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void SetName(PdmObjectId inObjectId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inName | Name. |
Remarks
This method is available since v7.8.303.100.
SetPartNumber(PdmObjectId, String)
Sets the part number of an object.
Declaration
[AvailableSinceVersion(7, 8, 303, 100)]
void SetPartNumber(PdmObjectId inObjectId, string inPartNumber)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inPartNumber | Part number. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.8.303.100.
SetProjectFolderName(PdmProjectFolderId, String)
Sets the name of a project folder.
Declaration
[AvailableSinceVersion(7, 9, 0, 0)]
void SetProjectFolderName(PdmProjectFolderId inProjectFolderId, string inName)Parameters
| Type | Name | Description |
|---|---|---|
| PdmProjectFolderId | inProjectFolderId | Project folder identifier. |
| String | inName | Name. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.
SetProjectMainDocument(PdmObjectId, PdmObjectId)
Sets the main document of a specified project.
Declaration
[AvailableSinceVersion(7, 11, 0, 0)]
void SetProjectMainDocument(PdmObjectId inProjectId, PdmObjectId inDocumentId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inProjectId | Project object identifier. |
| PdmObjectId | inDocumentId | Main document object identifier or Empty for none. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
EnsureIsDirty(PdmObjectId) must be called on the project before calling this method.
This method is available since v7.11.
SetRealUserProperty(PdmObjectId, PdmObjectId, Real)
Sets the value of a specified real user property of an object.
Declaration
[AvailableSinceVersion(7, 9, 300, 40)]
void SetRealUserProperty(PdmObjectId inObjectId, PdmObjectId inPropertyObjectId, Real inValue)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| PdmObjectId | inPropertyObjectId | Object identifier of property definition document to assign. |
| Real | inValue | Value to assign. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.300.040.
SetRevisionTexts(PdmObjectId, String, String)
Sets the major and minor revision texts of an object.
Declaration
[AvailableSinceVersion(7, 9, 300, 80)]
void SetRevisionTexts(PdmObjectId inObjectId, string inMajorText, string inMinorText)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| String | inMajorText | Major revision text. |
| String | inMinorText | Minor revision text. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.300.80.
SetTextUserProperty(PdmObjectId, PdmObjectId, String)
Sets the value of a specified text user property of an object.
Declaration
[AvailableSinceVersion(7, 9, 300, 40)]
void SetTextUserProperty(PdmObjectId inObjectId, PdmObjectId inPropertyObjectId, string inValue)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Object identifier. |
| PdmObjectId | inPropertyObjectId | Object identifier of property definition document to assign. |
| String | inValue | Value to assign. |
Remarks
This method must not be called between StartModification(String, Boolean) and EndModification(Boolean, Boolean) methods calls.
This method is available since v7.9.300.040.
ShowInProjectTree(PdmObjectId)
Show the object in the project tree.
Declaration
[AvailableSinceVersion(7, 13, 0, 0)]
void ShowInProjectTree(PdmObjectId inObjectId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmObjectId | inObjectId | Identifier of object to show. |
Remarks
This method is available since v7.13.
UndoCheckOut(PdmObjectId)
Undoes the check-out of an object.
Declaration
[AvailableSinceVersion(7, 6, 0, 0)]
void UndoCheckOut(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.6.
UpdateDocumentReferences(PdmMinorRevisionId)
Updates the references of a document minor revision.
Declaration
[AvailableSinceVersion(7, 13, 0, 0)]
void UpdateDocumentReferences(PdmMinorRevisionId inMinorRevisionId)Parameters
| Type | Name | Description |
|---|---|---|
| PdmMinorRevisionId | inMinorRevisionId | Identifier of the document minor revision. |
Remarks
This method is available since v7.13.