Interface ICamApiApplication
Instance of CAM application
Assembly: CAMAPI.Application.dll
Syntax
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("79A78312-DA90-46E8-8418-C4E71BBD1627")]
public interface ICamApiApplication
Properties
AttributesManager
Object to manage custom user defined attributes and their libraries.
Declaration
ICamApiCustomAttributesManager AttributesManager { get; }
Property Value
Constants
Constants of main application
Declaration
ICamApiConstants Constants { get; }
Property Value
ExecutablePath
Declaration
string ExecutablePath { get; }
Property Value
HotkeyManager
Manager for plugin-registered global keyboard shortcuts. Lives at the
application level so a global extension can register hotkeys during
startup, before the main form exists.
Declaration
ICamApiHotkeyManager HotkeyManager { get; }
Property Value
LanguageCode
Returns Windows Language Code Identifier (LCID) selected for the application
Declaration
int LanguageCode { get; }
Property Value
LanguageName
Returns the name of the language selected for the application
Declaration
string LanguageName { get; }
Property Value
LastActionIdleSeconds
Seconds elapsed since the last raw user input (mouse click / key / wheel)
in windows. Returns 0 if there was no input yet (e.g. headless run).
Native modal dialogs (message boxes, file pickers) are not tracked.
Declaration
double LastActionIdleSeconds { get; }
Property Value
LogFilePath
Returns path to the log file name of CAM
Declaration
string LogFilePath { get; }
Property Value
MachinesLibrary
Manager over library of machines of CAM system
Declaration
ICamApiMachinesLibrary MachinesLibrary { get; }
Property Value
Manager over list of machining tools of CAM system
Declaration
ICamApiMachiningToolsManager MachiningToolsManager { get; }
Property Value
MacroManager
Object to manage all macros inside CAM application
Declaration
ICamApiMacroManager MacroManager { get; }
Property Value
MainForm
Declaration
ICamApiApplicationMainForm MainForm { get; }
Property Value
MainWorkMode
Declaration
TMainWorkMode MainWorkMode { get; set; }
Property Value
PLMManager
Object which works with PLM extensions
Declaration
IPLMManager PLMManager { get; }
Property Value
Paths
Paths, used in CAM application
Declaration
ICamApiPaths Paths { get; }
Property Value
SmartHintManager
Manager of smart hints: lets an extension supply the context help for the parameters
of its own operations. Available before the main window of CAM application is created,
so the hints can be loaded while the extension is starting up.
Declaration
ICamApiSmartHintManager SmartHintManager { get; }
Property Value
Started
Current instance is ready to work. It may be not ready if in closing
mode or in open process
Declaration
Property Value
Theme
Snapshot of currently active UI theme (palette, fonts, metrics).
Read-only - plugins observe the theme, they do not switch it.
Declaration
ICamApiTheme Theme { get; }
Property Value
UserTechOperationList
List of user operations available to be created in the current technologist
Declaration
ICamApiUserTechOperationList UserTechOperationList { get; }
Property Value
UtilityManager
Utility manager to run some utilities inside CAM application
Declaration
ICamApiUtilityManager UtilityManager { get; }
Property Value
Methods
AskCamAgent(string, bool, int, out TResultStatus)
Declaration
string AskCamAgent(string message, bool interruptOnError, int timeoutMs, out TResultStatus ret)
Parameters
Returns
CreateNewProject(out TResultStatus)
Declaration
void CreateNewProject(out TResultStatus ResultStatus)
Parameters
ExportCurrentProject(string, bool, out TResultStatus)
Declaration
void ExportCurrentProject(string TargetFileName, bool Overwrite, out TResultStatus ResultStatus)
Parameters
GetActiveProject(out TResultStatus)
Declaration
ICamApiProject GetActiveProject(out TResultStatus ResultStatus)
Parameters
Returns
GetExtensionManager(out TResultStatus)
Declaration
IExtensionManager GetExtensionManager(out TResultStatus ResultStatus)
Parameters
Returns
Declaration
IListString ImportToolsFromFile(IListString FileNames, string OperationID, out TResultStatus ResultStatus)
Parameters
Returns
Declaration
IListString ImportToolsFromPLM(string ExtensionTypeId, IListString ItemIds, string ConnectionId, string OperationID, out TResultStatus ResultStatus)
Parameters
Returns
OpenProject(string, bool, out TResultStatus)
Declaration
void OpenProject(string FileName, bool AddToReOpen, out TResultStatus ResultStatus)
Parameters
OpenProjectFromPLM(string, string, out TResultStatus)
Declaration
void OpenProjectFromPLM(string PLMItemId, string ConnectionId, out TResultStatus ResultStatus)
Parameters
RegisterHandler(string, ICamApiEventHandler, IListString, out TResultStatus)
Declaration
void RegisterHandler(string HandlerIdent, ICamApiEventHandler Handler, IListString Events, out TResultStatus ResultStatus)
Parameters
SaveCurrentProject(string, out TResultStatus)
Declaration
void SaveCurrentProject(string FileName, out TResultStatus ResultStatus)
Parameters
SetActiveProjectMachine(ICamApiMachineInfo, out TResultStatus)
Declaration
void SetActiveProjectMachine(ICamApiMachineInfo MachineInfo, out TResultStatus ResultStatus)
Parameters
UnregisterHandler(string, out TResultStatus)
Declaration
void UnregisterHandler(string HandlerIdent, out TResultStatus ResultStatus)
Parameters