 | CPROJ Class |
Project functions
Inheritance HierarchyNamespace: Geosoft.Desktop.GXNet
Assembly: geosoft.desktop.gxnet (in geosoft.desktop.gxnet.dll) Version: 2025.1.0.25
SyntaxThe CPROJ type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | DropMapClipData | Drop Map clipboard data in the current project (workspace background) |
| GetCentralProjectInformation(String, String, String, String, String, String, String, String, String, String, String) | Get Central project information. |
| GetCentralProjectInformation(String, Int32, String, Int32, String, Int32, String, Int32, String, Int32, String, Int32, String, Int32, String, Int32, String, Int32, String, Int32, String, Int32) | Get Central project information. |
| GetRegisteredBackgroundScript(Int32, String, String, String, String, String, CVV, String) | Retrieve info on a registered OMS script launched from the project |
| GetRegisteredBackgroundScript(Int32, String, Int32, String, String, Int32, String, String, Int32, CVV, String, Int32) | Retrieve info on a registered OMS script launched from the project |
| GetRegisteredBackgroundScriptEx(Int32, String, String, String, String, String, String, String, CLST, CLST, String) | Retrieve info on a registered OMS script launched from the project |
| GetRegisteredBackgroundScriptEx(Int32, String, Int32, String, String, Int32, String, String, String, String, Int32, CLST, CLST, String, Int32) | Retrieve info on a registered OMS script launched from the project |
| GetServerAndProjectGUID(String, String) | Return the unique identifier of the project and server. |
| GetServerAndProjectGUID(String, Int32, String, Int32) | Return the unique identifier of the project and server. |
| HasPendingCentralPublishEvent | Checks if there is a pending publish event. |
| iAddDocument | Adds (and opens) a document file in the current project. |
| iAddDocumentIncludeMeta | Adds (and opens) a document file in the current project. |
| iAddDocumentWithoutOpening | Adds (and opens) a document file in the current project. |
| iAddGridDocument | Adds (and opens) a grid document file in the current project with a particular colour distribution and colour file. |
| iAddGridDocuments | Adds (and opens) multiple grid document files of the same type in the current project with a shared (same) colour distribution and colour file. |
| ICurrentDocument(String, String) | Get the name and type of the loaded document with focus. |
| ICurrentDocument(String, Int32, String, Int32) | Get the name and type of the loaded document with focus. |
| ICurrentDocumentOfType(String, String) | Get the name of a loaded document of a specific type. |
| ICurrentDocumentOfType(String, Int32, String) | Get the name of a loaded document of a specific type. |
| iGetCommandEnvironment | The current command environment |
| IGetDefaultProjectPath(String) | Get default project folder. |
| IGetDefaultProjectPath(String, Int32) | Get default project folder. |
| iGetDocumentEvoObjectMetadata | Get Evo object metadata associated with the document from project metadata |
| IGetName(String) | Return the name of the project file. |
| IGetName(String, Int32) | Return the name of the project file. |
| iGetNumericVoxelITR | Get a numeric voxel document's ITR from project metadata |
| iGetNumRegisteredBackgroundScripts | Register a OMS script launched from the project |
| iListDocuments | Fills a VV with documents of a certain type. |
| iListLoadedDocuments | Fills a VV with loaded documents of a certain type. |
| iListTools |
Fills an LST object with tools of a certain type and
notes the current visibility setting.
|
| iRemoveDocument | Removes (and closes if visible) a document from the current project. |
| iRemoveTool | Removes (and closes if visible) a auxiliary tool from the current project. |
| iSaveCloseDocuments | Saves and closes (if visible) documents contained in the current project. |
| iSetDocumentEvoObjectMetadata | Set evo object metadata associated with the document into project metadata |
| iSetNumericVoxelITR | Set a numeric voxel document's ITR into project metadata |
| RegisterBackgroundScript | Register an OMS script launched from the project |
| RegisterBackgroundScriptEx | Register an OMS script launched from the project |
| SaveDocumentView | Save document view to a file. |
| SetCentralProjectInformation | Set Central project information. |
| SetDefaultProjectPath | Set default project folder. |
See Also