Class ApplicationMainFormHelper

Helper methods for ICamApiApplicationMainForm

Inheritance

object

ApplicationMainFormHelper

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 ApplicationMainFormHelper

Methods

ActiveClientRect(ComWrapper<ICamApiApplicationMainForm>)

Active client rectangle of the main application window - the area occupied by the 3D graphic view. Returned in client pixels of the main application window; use ClientToScreen(ComWrapper<ICamApiApplicationMainForm>, TCamApiRect) to translate into screen coordinates.

Declaration

public static TCamApiRect ActiveClientRect(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
TCamApiRect

BeginFreeze(ComWrapper<ICamApiApplicationMainForm>, TFreezeInterfaceType)

Freeze main form (user interaction disabled)

Declaration

public static void BeginFreeze(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, TFreezeInterfaceType freezeType)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
TFreezeInterfaceType	freezeType

ClientToScreen(ComWrapper<ICamApiApplicationMainForm>, TCamApiRect)

Translate a rectangle from main application window client coordinates to screen (desktop) coordinates.

Declaration

public static TCamApiRect ClientToScreen(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, TCamApiRect r)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
TCamApiRect	r

Returns

Type	Description
TCamApiRect

CloudsCollabDownload(ComWrapper<ICamApiApplicationMainForm>)

Download project from cloud collaboration

Declaration

public static void CloudsCollabDownload(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

CloudsCollabOpenChat(ComWrapper<ICamApiApplicationMainForm>)

Open cloud collaboration chat

Declaration

public static void CloudsCollabOpenChat(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

CloudsCollabShare(ComWrapper<ICamApiApplicationMainForm>)

Share in cloud collaboration

Declaration

public static void CloudsCollabShare(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

ConnectPLMConnection(ComWrapper<ICamApiApplicationMainForm>, long)

Connect to PLM

Declaration

public static void ConnectPLMConnection(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, long connectionId)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
long	connectionId

CrashReport(ComWrapper<ICamApiApplicationMainForm>)

Start a crash report request

Declaration

public static void CrashReport(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

CreateNewProject(ComWrapper<ICamApiApplicationMainForm>)

Replace current active project with a new one

Declaration

public static void CreateNewProject(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

DisconnectPLMConnection(ComWrapper<ICamApiApplicationMainForm>, long)

Disconnect from PLM

Declaration

public static void DisconnectPLMConnection(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, long connectionId)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
long	connectionId

EndFreeze(ComWrapper<ICamApiApplicationMainForm>)

Unfreeze main form

Declaration

public static void EndFreeze(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

ExportCurrentProject(ComWrapper<ICamApiApplicationMainForm>)

Export current active project with all snapshots

Declaration

public static void ExportCurrentProject(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

ExportDrillPoints(ComWrapper<ICamApiApplicationMainForm>, string)

Saves selected drill operation points

Declaration

public static void ExportDrillPoints(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName

ExportProjectToPLM(ComWrapper<ICamApiApplicationMainForm>, long)

Export project to PLM

Declaration

public static void ExportProjectToPLM(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, long connectionId)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
long	connectionId

ExportProjectWithHistory(ComWrapper<ICamApiApplicationMainForm>, string)

Saves current project with full snapshot history

Declaration

public static void ExportProjectWithHistory(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName

ExportSimulationResults(ComWrapper<ICamApiApplicationMainForm>, string)

Export simulation results

Declaration

public static void ExportSimulationResults(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName

GetFiltersManager(ComWrapper<ICamApiApplicationMainForm>)

Manager for geometry selection filters

Declaration

public static ComWrapper<ICamApiFiltersManager> GetFiltersManager(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
ComWrapper<ICamApiFiltersManager>

GetHotkeyManager(ComWrapper<ICamApiApplicationMainForm>)

Manager for plugin-registered global keyboard shortcuts

Declaration

public static ComWrapper<ICamApiHotkeyManager> GetHotkeyManager(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
ComWrapper<ICamApiHotkeyManager>

GetTechnologyForm(ComWrapper<ICamApiApplicationMainForm>)

Get UI for technology

Declaration

public static ComWrapper<ICamApiTechnologyForm> GetTechnologyForm(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
ComWrapper<ICamApiTechnologyForm>

GetUiInfo(ComWrapper<ICamApiApplicationMainForm>)

Get main UI state info

Declaration

public static ComWrapper<ICamApiMainFormUiInfo> GetUiInfo(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
ComWrapper<ICamApiMainFormUiInfo>

GetVerifyCompareManager(ComWrapper<ICamApiApplicationMainForm>)

Manager for the "Verify compare" mode (machining result vs part)

Declaration

public static ComWrapper<ICamApiVerifyCompareManager> GetVerifyCompareManager(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
ComWrapper<ICamApiVerifyCompareManager>

GetVisibilityManager(ComWrapper<ICamApiApplicationMainForm>)

Manager for visibility of 3D scene objects per work mode

Declaration

public static ComWrapper<ICamApiVisibilityManager> GetVisibilityManager(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
ComWrapper<ICamApiVisibilityManager>

GetVisible(ComWrapper<ICamApiApplicationMainForm>)

Get visibility of main form - may change when main window opens/closes

Declaration

public static bool GetVisible(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
bool

ImportMachineSetup(ComWrapper<ICamApiApplicationMainForm>, string)

Import machine setup

Declaration

public static void ImportMachineSetup(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName

LoadProjectFromPLM(ComWrapper<ICamApiApplicationMainForm>, long)

Import project from PLM

Declaration

public static void LoadProjectFromPLM(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, long connectionId)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
long	connectionId

MainViewPort(ComWrapper<ICamApiApplicationMainForm>)

View port

Declaration

public static ComWrapper<ICamApiViewPort> MainViewPort(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
ComWrapper<ICamApiViewPort>

MainWindowHandle(ComWrapper<ICamApiApplicationMainForm>)

Handle of the main application window can be used to set this window as a parent for any child window

Declaration

public static long MainWindowHandle(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
long

OpenAiAssistant(ComWrapper<ICamApiApplicationMainForm>)

Open AI assistant

Declaration

public static void OpenAiAssistant(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

OpenDotnetInterpreterInVSCode(ComWrapper<ICamApiApplicationMainForm>, string)

Open dotnet interpreter in VS Code

Declaration

public static void OpenDotnetInterpreterInVSCode(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName

OpenProject(ComWrapper<ICamApiApplicationMainForm>, string)

Close current project without saving and open new one

Declaration

public static void OpenProject(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName

OpenProjectSnap(ComWrapper<ICamApiApplicationMainForm>, string, string)

Close current project without saving and open snapshot

Declaration

public static void OpenProjectSnap(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName, string snapName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName
string	snapName

ProcessMessages(ComWrapper<ICamApiApplicationMainForm>)

Process pending UI messages of the main application thread (equivalent to Application.ProcessMessages on the Pascal side).

Declaration

public static void ProcessMessages(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

RunAppSetup(ComWrapper<ICamApiApplicationMainForm>)

Run app setup dialog

Declaration

public static bool RunAppSetup(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

Returns

Type	Description
bool

RunUtilitiesSetup(ComWrapper<ICamApiApplicationMainForm>, TCamApiRect)

Run utilities setup dialog

Declaration

public static void RunUtilitiesSetup(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, TCamApiRect anchorRect = default)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
TCamApiRect	anchorRect

SaveAsMachineSetup(ComWrapper<ICamApiApplicationMainForm>, string)

Saves current project as a machine setup

Declaration

public static void SaveAsMachineSetup(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName

SaveCurrentProject(ComWrapper<ICamApiApplicationMainForm>)

Save current active project

Declaration

public static void SaveCurrentProject(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

SaveCurrentProjectAs(ComWrapper<ICamApiApplicationMainForm>)

Save current active project as a copy (empty path rewrites current file)

Declaration

public static void SaveCurrentProjectAs(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

SaveProject(ComWrapper<ICamApiApplicationMainForm>)

Save current project

Declaration

public static void SaveProject(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

SaveProjectAs(ComWrapper<ICamApiApplicationMainForm>, string)

Save current project to file

Declaration

public static void SaveProjectAs(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	fileName

ScreenToClient(ComWrapper<ICamApiApplicationMainForm>, TCamApiRect)

Translate a rectangle from screen (desktop) coordinates into main application window client coordinates.

Declaration

public static TCamApiRect ScreenToClient(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, TCamApiRect r)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
TCamApiRect	r

Returns

Type	Description
TCamApiRect

SetCurrentInPrime(ComWrapper<ICamApiApplicationMainForm>, bool)

Notify app form that it is current in prime

Declaration

public static void SetCurrentInPrime(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
bool	value

ShowHelpContents(ComWrapper<ICamApiApplicationMainForm>)

Show help contents

Declaration

public static void ShowHelpContents(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

ShowSnapshotManager(ComWrapper<ICamApiApplicationMainForm>, string)

Show snapshot manager for specified project

Declaration

public static void ShowSnapshotManager(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string projectPath)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom
string	projectPath

ShowToolWindow(ComWrapper<ICamApiApplicationMainForm>, string)

Show the window with the machining tools of the project and select a tool in it. Use it after importing a tool: without the window the user has no visual sign that the tool has actually appeared in the project. The main application window is brought to the front.

Declaration

public static void ShowToolWindow(this ComWrapper<ICamApiApplicationMainForm> mainFormCom, string toolID = "")

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom	Main form
string	toolID	Identifier of the tool to select, as returned by the tool import methods. Empty just opens the window.

ShowTutorialWnd(ComWrapper<ICamApiApplicationMainForm>)

Show tutorial window

Declaration

public static void ShowTutorialWnd(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom

SupportRequest(ComWrapper<ICamApiApplicationMainForm>)

Start support request

Declaration

public static void SupportRequest(this ComWrapper<ICamApiApplicationMainForm> mainFormCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiApplicationMainForm>	mainFormCom