Click or drag to resize

CPROJ Methods

The CPROJ type exposes the following members.

Methods
  NameDescription
Public methodStatic memberDropMapClipData
Drop Map clipboard data in the current project (workspace background)
Public methodStatic memberGetCentralProjectInformation(String, String, String, String, String, String, String, String, String, String, String)
Get Central project information.
Public methodStatic memberGetCentralProjectInformation(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.
Public methodStatic memberGetRegisteredBackgroundScript(Int32, String, String, String, String, String, CVV, String)
Retrieve info on a registered OMS script launched from the project
Public methodStatic memberGetRegisteredBackgroundScript(Int32, String, Int32, String, String, Int32, String, String, Int32, CVV, String, Int32)
Retrieve info on a registered OMS script launched from the project
Public methodStatic memberGetRegisteredBackgroundScriptEx(Int32, String, String, String, String, String, String, String, CLST, CLST, String)
Retrieve info on a registered OMS script launched from the project
Public methodStatic memberGetRegisteredBackgroundScriptEx(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
Public methodStatic memberGetServerAndProjectGUID(String, String)
Return the unique identifier of the project and server.
Public methodStatic memberGetServerAndProjectGUID(String, Int32, String, Int32)
Return the unique identifier of the project and server.
Public methodStatic memberHasPendingCentralPublishEvent
Checks if there is a pending publish event.
Public methodStatic memberiAddDocument
Adds (and opens) a document file in the current project.
Public methodStatic memberiAddDocumentIncludeMeta
Adds (and opens) a document file in the current project.
Public methodStatic memberiAddDocumentWithoutOpening
Adds (and opens) a document file in the current project.
Public methodStatic memberiAddGridDocument
Adds (and opens) a grid document file in the current project with a particular colour distribution and colour file.
Public methodStatic memberiAddGridDocuments
Adds (and opens) multiple grid document files of the same type in the current project with a shared (same) colour distribution and colour file.
Public methodStatic memberICurrentDocument(String, String)
Get the name and type of the loaded document with focus.
Public methodStatic memberICurrentDocument(String, Int32, String, Int32)
Get the name and type of the loaded document with focus.
Public methodStatic memberICurrentDocumentOfType(String, String)
Get the name of a loaded document of a specific type.
Public methodStatic memberICurrentDocumentOfType(String, Int32, String)
Get the name of a loaded document of a specific type.
Public methodStatic memberiGetCommandEnvironment
The current command environment
Public methodStatic memberIGetDefaultProjectPath(String)
Get default project folder.
Public methodStatic memberIGetDefaultProjectPath(String, Int32)
Get default project folder.
Public methodStatic memberIGetName(String)
Return the name of the project file.
Public methodStatic memberIGetName(String, Int32)
Return the name of the project file.
Public methodStatic memberiGetNumRegisteredBackgroundScripts
Register a OMS script launched from the project
Public methodStatic memberiListDocuments
Fills a VV with documents of a certain type.
Public methodStatic memberiListLoadedDocuments
Fills a VV with loaded documents of a certain type.
Public methodStatic memberiListTools
Fills an LST object with tools of a certain type and notes the current visibility setting.
Public methodStatic memberiRemoveDocument
Removes (and closes if visible) a document from the current project.
Public methodStatic memberiRemoveTool
Removes (and closes if visible) a auxiliary tool from the current project.
Public methodStatic memberiSaveCloseDocuments
Saves and closes (if visible) documents contained in the current project.
Public methodStatic memberRegisterBackgroundScript
Register an OMS script launched from the project
Public methodStatic memberRegisterBackgroundScriptEx
Register an OMS script launched from the project
Public methodStatic memberSaveDocumentView
Save document view to a file.
Public methodStatic memberSetCentralProjectInformation
Set Central project information.
Public methodStatic memberSetDefaultProjectPath
Set default project folder.
Top
See Also