Show / Hide Table of Contents

Class ApplicationHelper

Helper methods for ICamApiApplication

Inheritance

object

ApplicationHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class ApplicationHelper

Methods

AttributesManager(ComWrapper<ICamApiApplication>)

Object to manage custom user defined attributes and their libraries

Declaration

public static ComWrapper<ICamApiCustomAttributesManager> AttributesManager(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiCustomAttributesManager>

CreateNewProject(ComWrapper<ICamApiApplication>)

Close the current project without saving and create a new empty project

Declaration

public static void CreateNewProject(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

ExecutablePath(ComWrapper<ICamApiApplication>)

Path to executable file

Declaration

public static string ExecutablePath(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
string

ExportCurrentProject(ComWrapper<ICamApiApplication>, string, bool)

Export current active project with all snapshots to target file

Declaration

public static void ExportCurrentProject(this ComWrapper<ICamApiApplication> appCom, string targetFileName, bool overwrite)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom
string	targetFileName
bool	overwrite

GetActiveProject(ComWrapper<ICamApiApplication>)

Active project of instance (can be null if no active project)

Declaration

public static ComWrapper<ICamApiProject> GetActiveProject(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiProject>

GetExtensionManager(ComWrapper<ICamApiApplication>)

Instance of extension manager

Declaration

public static ComWrapper<IExtensionManager> GetExtensionManager(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<IExtensionManager>

HotkeyManager(ComWrapper<ICamApiApplication>)

Manager for plugin-registered global keyboard shortcuts. Reachable during startup (before the main form exists). Returns null in headless / kernel-only builds where no GUI hotkey registry was created.

Declaration

public static ComWrapper<ICamApiHotkeyManager>? HotkeyManager(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiHotkeyManager>

ImportToolsFromFile(ComWrapper<ICamApiApplication>, IEnumerable<string>, string)

Import machining tools from local tool exchange files (.sc12tool) into the active project. A tool whose origin is already in the project replaces that tool.

Declaration

public static IReadOnlyList<string> ImportToolsFromFile(this ComWrapper<ICamApiApplication> appCom, IEnumerable<string> fileNames, string operationID = "")

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom
IEnumerable<string>	fileNames	Paths to the tool exchange files.
string	operationID	Optional. Operation to set the imported tool as the tool of; a single file only.

Returns

Type	Description
IReadOnlyList<string>	Identifiers of the imported tools; pass one to ShowToolWindow to show it.

ImportToolsFromPLM(ComWrapper<ICamApiApplication>, string, IEnumerable<string>, string, string)

Import machining tools from a PLM system into the active project. The batch is downloaded in one session; a tool whose origin is already in the project replaces that tool.

Declaration

public static IReadOnlyList<string> ImportToolsFromPLM(this ComWrapper<ICamApiApplication> appCom, string extensionTypeId, IEnumerable<string> itemIds, string connectionId = "", string operationID = "")

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom
string	extensionTypeId	Identifier of the PLM extension to use. Required.
IEnumerable<string>	itemIds	Identifiers of the tool assembly items in the PLM system.
string	connectionId	Optional. A specific PLM connection; empty means the only connection of that extension type.
string	operationID	Optional. Operation to set the imported tool as the tool of; a single item only.

Returns

Type	Description
IReadOnlyList<string>	Identifiers of the imported tools; pass one to ShowToolWindow to show it.

LanguageCode(ComWrapper<ICamApiApplication>)

Windows Language Code Identifier (LCID) selected for the application

Declaration

public static int LanguageCode(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
int

LanguageName(ComWrapper<ICamApiApplication>)

Name of the language selected for the application

Declaration

public static string LanguageName(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
string

LogFilePath(ComWrapper<ICamApiApplication>)

Path to the log file of CAM

Declaration

public static string LogFilePath(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
string

MachinesLibrary(ComWrapper<ICamApiApplication>)

Manager over a library of machines of CAM system

Declaration

public static ComWrapper<ICamApiMachinesLibrary> MachinesLibrary(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiMachinesLibrary>

MachiningToolsManager(ComWrapper<ICamApiApplication>)

Manager over list of machining tools of CAM system

Declaration

public static ComWrapper<ICamApiMachiningToolsManager> MachiningToolsManager(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiMachiningToolsManager>

MacroManager(ComWrapper<ICamApiApplication>)

Object to manage all macros inside a CAM application

Declaration

public static ComWrapper<ICamApiMacroManager> MacroManager(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiMacroManager>

MainForm(ComWrapper<ICamApiApplication>)

Main window handle

Declaration

public static ComWrapper<ICamApiApplicationMainForm> MainForm(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiApplicationMainForm>

MainWorkMode(ComWrapper<ICamApiApplication>)

Work mode of application

Declaration

public static TMainWorkMode MainWorkMode(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
TMainWorkMode

OpenProject(ComWrapper<ICamApiApplication>, string, bool)

Close current project without saving and open new one in instance of active project

Declaration

public static void OpenProject(this ComWrapper<ICamApiApplication> appCom, string fileName, bool addToReOpen)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom
string	fileName
bool	addToReOpen

OpenProjectFromPLM(ComWrapper<ICamApiApplication>, string, string)

Close the current project without saving and open one from a PLM system in instance of the active project

Declaration

public static void OpenProjectFromPLM(this ComWrapper<ICamApiApplication> appCom, string plmItemId, string connectionId)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom
string	plmItemId
string	connectionId

PLMManager(ComWrapper<ICamApiApplication>)

Object which works with PLM extensions

Declaration

public static ComWrapper<IPLMManager> PLMManager(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<IPLMManager>

SaveCurrentProject(ComWrapper<ICamApiApplication>, string)

Save current active project (empty FileName rewrites current file)

Declaration

public static void SaveCurrentProject(this ComWrapper<ICamApiApplication> appCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom
string	fileName

SetActiveProjectMachine(ComWrapper<ICamApiApplication>, ComWrapper<ICamApiMachineInfo>)

Set machine of the current active project

Declaration

public static void SetActiveProjectMachine(this ComWrapper<ICamApiApplication> appCom, ComWrapper<ICamApiMachineInfo> machineInfo)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom
ComWrapper<ICamApiMachineInfo>	machineInfo

SetMainWorkMode(ComWrapper<ICamApiApplication>, TMainWorkMode)

Set work mode of application

Declaration

public static void SetMainWorkMode(this ComWrapper<ICamApiApplication> appCom, TMainWorkMode value)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom
TMainWorkMode	value

Theme(ComWrapper<ICamApiApplication>)

Snapshot of currently active UI theme palette. Returns null in headless / kernel-only builds where the theme factory was not registered.

Declaration

public static ComWrapper<ICamApiTheme>? Theme(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiTheme>

UserTechOperationList(ComWrapper<ICamApiApplication>)

List of user operations available to be created in the current technologist

Declaration

public static ComWrapper<ICamApiUserTechOperationList> UserTechOperationList(this ComWrapper<ICamApiApplication> appCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplication>	appCom

Returns

Type	Description
ComWrapper<ICamApiUserTechOperationList>