IGUIManager interface

The IGUIManager interface represents the Graphical User interface portions of the Altium Designer application such as resizing panels, checking for certain hot key maps and status bars.

public interface IGUIManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
PanelDockedHeight	int	get; set
PanelDockedWidth	int	get; set

PanelDockedHeight

No description yet.

int GetPanelDockedHeight(string argViewName);
void SetPanelDockedHeight(string argViewName, int argHeight);

Type: int · Access: read/write · Index: argViewName (string)

PanelDockedWidth

No description yet.

int GetPanelDockedWidth(string argViewName);
void SetPanelDockedWidth(string argViewName, int argWidth);

Type: int · Access: read/write · Index: argViewName (string)

Methods

Method	Returns	Description
AddKeyStrokeAndLaunch	bool
AddKeyToBuffer	bool
BeginDragDrop	void
CanMovePanel	bool
CanResizePanel	bool	This method determines whether the panel can be resized or not.
CurrentProcessLauncherAvailable	bool	This method determines whether the current process launcher is available or not to use.
DesignspaceUISupports	bool
DesignspaceValue	string
DoneTransparentToolbars	void
Dragging	bool
DXPShortcutToDelphiShortcut	string
GetActionListFromTree	IExternalActionItemList
GetActivePLByCommand	IProcessLauncherInfo
GetAllAvailableHotkeys	void
GetCurrentFormHandle	uint
GetFocusedPanelName	string
GetPanelIsOpen	bool
GetPanelIsOpenInAnyForm	bool
GetPanelIsVisibleInAnyForm	bool
GetProcessLauncherInfoByID	IProcessLauncherInfo
GetShortcutTextForPLID	string
HasTreeShownAsPopup	bool
HideDragImage	void
InitTransparentToolbars	void
IsPanelPinned	bool
IsPanelValidInCurrentForm	bool
IsPanelVisibleInCurrentForm	bool
IsSysLevelHotKey	bool
LaunchCurrentHotkey	void
MovePanelTo	void
ProcessMessage	bool
RegisterFloatingWindow	void
RegisterUserProcessLauncher	IProcessLauncherInfo
ResizePanel	void
SetFocusLock	void
SetPanelActiveInCurrentForm	void
SetPanelPinned	void
SetPanelVisibleInCurrentForm	void
SetTitleBarErrorMessage	void
ShowCurrentProcessLauncherHelp	bool
ShowDragImage	void
ShowStandardMenuAsPopup	void
ShowTreeAsPopup	void
ShowTreeAsPopupAt	void
StatusBar_GetState	string
StatusBar_SetState	void
StatusBarManager	IStatusBarManager
UnregisterFloatingWindow	void
UnregisterUserProcessLauncher	void
UpdateInterfaceState	void
UpdateTransparentToolbars	void

AddKeyStrokeAndLaunch

No description yet.

bool AddKeyStrokeAndLaunch(ushort argKey);

Parameter	Type	Passing
argKey	ushort	value

Returns: bool

AddKeyToBuffer

No description yet.

bool AddKeyToBuffer(int argKeyId, bool arglt, bool argShift, bool argCtrl);

Parameter	Type	Passing
argKeyId	int	value
arglt	bool	value
argShift	bool	value
argCtrl	bool	value

Returns: bool

BeginDragDrop

No description yet.

void BeginDragDrop(IDragDropObject argDragDropInfo);
void BeginDragDrop(object argDragDropInfo);

Parameter	Type	Passing
argDragDropInfo	IDragDropObject	value

Returns: nothing (void)

The first overload is an extension method of IGUIManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

CanMovePanel

No description yet.

bool CanMovePanel(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: bool

CanResizePanel

This method determines whether the panel can be resized or not. The name of the panel need to be supplied.

bool CanResizePanel(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: bool

CurrentProcessLauncherAvailable

This method determines whether the current process launcher is available or not to use.

bool CurrentProcessLauncherAvailable();

Returns: bool

DesignspaceUISupports

No description yet.

bool DesignspaceUISupports(string argUIFeature);

Parameter	Type	Passing
argUIFeature	string	value

Returns: bool

DesignspaceValue

No description yet.

string DesignspaceValue(string argSectionName, string argValueName);

Parameter	Type	Passing
argSectionName	string	value
argValueName	string	value

Returns: string

DoneTransparentToolbars

No description yet.

void DoneTransparentToolbars();

Returns: nothing (void)

Dragging

No description yet.

bool Dragging();

Returns: bool

DXPShortcutToDelphiShortcut

No description yet.

string DXPShortcutToDelphiShortcut(string argShortcutText);

Parameter	Type	Passing
argShortcutText	string	value

Returns: string

GetActionListFromTree

No description yet.

IExternalActionItemList GetActionListFromTree(string argTreeID);

Parameter	Type	Passing
argTreeID	string	value

Returns: IExternalActionItemList

Extension method of IGUIManagerHelper (using DXP;).

GetActivePLByCommand

No description yet.

IProcessLauncherInfo GetActivePLByCommand(string argDocumentKind, string argCommand, string argParams);

Parameter	Type	Passing
argDocumentKind	string	value
argCommand	string	value
argParams	string	value

Returns: IProcessLauncherInfo

Extension method of IGUIManagerHelper (using DXP;).

GetAllAvailableHotkeys

No description yet.

void GetAllAvailableHotkeys(out string argHotkeys, out string argDescriptions);

Parameter	Type	Passing
argHotkeys	string	out
argDescriptions	string	out

Returns: nothing (void)

GetCurrentFormHandle

No description yet.

uint GetCurrentFormHandle();

Returns: uint

GetFocusedPanelName

No description yet.

string GetFocusedPanelName();

Returns: string

GetPanelIsOpen

No description yet.

bool GetPanelIsOpen(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: bool

GetPanelIsOpenInAnyForm

No description yet.

bool GetPanelIsOpenInAnyForm(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: bool

GetPanelIsVisibleInAnyForm

No description yet.

bool GetPanelIsVisibleInAnyForm(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: bool

GetProcessLauncherInfoByID

No description yet.

IProcessLauncherInfo GetProcessLauncherInfoByID(string argPLID);

Parameter	Type	Passing
argPLID	string	value

Returns: IProcessLauncherInfo

Extension method of IGUIManagerHelper (using DXP;).

GetShortcutTextForPLID

No description yet.

string GetShortcutTextForPLID(string argPLID);

Parameter	Type	Passing
argPLID	string	value

Returns: string

HasTreeShownAsPopup

No description yet.

bool HasTreeShownAsPopup();

Returns: bool

HideDragImage

No description yet.

void HideDragImage();

Returns: nothing (void)

InitTransparentToolbars

No description yet.

void InitTransparentToolbars(Rect argViewRect);
void InitTransparentToolbars(IRect argViewRect);

Parameter	Type	Passing
argViewRect	Rect	value

Returns: nothing (void)

The first overload is an extension method of IGUIManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

IsPanelPinned

No description yet.

bool IsPanelPinned(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: bool

IsPanelValidInCurrentForm

No description yet.

bool IsPanelValidInCurrentForm(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: bool

IsPanelVisibleInCurrentForm

No description yet.

bool IsPanelVisibleInCurrentForm(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: bool

IsSysLevelHotKey

No description yet.

bool IsSysLevelHotKey(int argKeyId, bool arglt, bool argShift, bool argCtrl);

Parameter	Type	Passing
argKeyId	int	value
arglt	bool	value
argShift	bool	value
argCtrl	bool	value

Returns: bool

LaunchCurrentHotkey

No description yet.

void LaunchCurrentHotkey();

Returns: nothing (void)

MovePanelTo

No description yet.

void MovePanelTo(string argViewName, int argLeft, int argTop);

Parameter	Type	Passing
argViewName	string	value
argLeft	int	value
argTop	int	value

Returns: nothing (void)

ProcessMessage

No description yet.

bool ProcessMessage(ref Message argMsg);
bool ProcessMessage(ref IMessage argMsg);

Parameter	Type	Passing
argMsg	Message	ref

Returns: bool

The first overload is an extension method of IGUIManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

RegisterFloatingWindow

No description yet.

void RegisterFloatingWindow(IFloatingWindow argFloatingWindow);
void RegisterFloatingWindow(object argFloatingWindow);

Parameter	Type	Passing
argFloatingWindow	IFloatingWindow	value

Returns: nothing (void)

The first overload is an extension method of IGUIManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

RegisterUserProcessLauncher

No description yet.

IProcessLauncherInfo RegisterUserProcessLauncher(string argPreferredID, string argServerCommand, string argParameters, string argCaption, string argDescription, string argImageFile, string argShortcutText, string argShortcut2Text);

Parameter	Type	Passing
argPreferredID	string	value
argServerCommand	string	value
argParameters	string	value
argCaption	string	value
argDescription	string	value
argImageFile	string	value
argShortcutText	string	value
argShortcut2Text	string	value

Returns: IProcessLauncherInfo

Extension method of IGUIManagerHelper (using DXP;).

ResizePanel

No description yet.

void ResizePanel(string argViewName, int argWidth, int argHeight);

Parameter	Type	Passing
argViewName	string	value
argWidth	int	value
argHeight	int	value

Returns: nothing (void)

SetFocusLock

No description yet.

void SetFocusLock(bool argLocked);

Parameter	Type	Passing
argLocked	bool	value

Returns: nothing (void)

SetPanelActiveInCurrentForm

No description yet.

void SetPanelActiveInCurrentForm(string argViewName);

Parameter	Type	Passing
argViewName	string	value

Returns: nothing (void)

SetPanelPinned

No description yet.

void SetPanelPinned(string argViewName, bool argIsPinned);

Parameter	Type	Passing
argViewName	string	value
argIsPinned	bool	value

Returns: nothing (void)

SetPanelVisibleInCurrentForm

No description yet.

void SetPanelVisibleInCurrentForm(string argViewName, bool argIsVisible);

Parameter	Type	Passing
argViewName	string	value
argIsVisible	bool	value

Returns: nothing (void)

SetTitleBarErrorMessage

No description yet.

void SetTitleBarErrorMessage(string argErrorMessage);

Parameter	Type	Passing
argErrorMessage	string	value

Returns: nothing (void)

ShowCurrentProcessLauncherHelp

No description yet.

bool ShowCurrentProcessLauncherHelp();

Returns: bool

ShowDragImage

No description yet.

void ShowDragImage();

Returns: nothing (void)

ShowStandardMenuAsPopup

No description yet.

void ShowStandardMenuAsPopup(IMenuWrapper argMenuWrapper, Point argPosition);
void ShowStandardMenuAsPopup(object argMenuWrapper, IPoint argPosition);

Parameter	Type	Passing
argMenuWrapper	IMenuWrapper	value
argPosition	Point	value

Returns: nothing (void)

The first overload is an extension method of IGUIManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

ShowTreeAsPopup

No description yet.

void ShowTreeAsPopup(string argTreeID);

Parameter	Type	Passing
argTreeID	string	value

Returns: nothing (void)

ShowTreeAsPopupAt

No description yet.

void ShowTreeAsPopupAt(string argTreeID, Point argPosition);
void ShowTreeAsPopupAt(string argTreeID, IPoint argPosition);

Parameter	Type	Passing
argTreeID	string	value
argPosition	Point	value

Returns: nothing (void)

The first overload is an extension method of IGUIManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

StatusBar_GetState

No description yet.

string StatusBar_GetState(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

StatusBar_SetState

No description yet.

void StatusBar_SetState(int argIndex, string argS);

Parameter	Type	Passing
argIndex	int	value
argS	string	value

Returns: nothing (void)

StatusBarManager

No description yet.

IStatusBarManager StatusBarManager();

Returns: IStatusBarManager

Extension method of IGUIManagerHelper (using DXP;).

UnregisterFloatingWindow

No description yet.

void UnregisterFloatingWindow(IFloatingWindow argFloatingWindow);
void UnregisterFloatingWindow(object argFloatingWindow);

Parameter	Type	Passing
argFloatingWindow	IFloatingWindow	value

Returns: nothing (void)

The first overload is an extension method of IGUIManagerHelper (using DXP;) with typed parameters; the second is declared by the interface.

UnregisterUserProcessLauncher

No description yet.

void UnregisterUserProcessLauncher(string argPLID);

Parameter	Type	Passing
argPLID	string	value

Returns: nothing (void)

UpdateInterfaceState

No description yet.

void UpdateInterfaceState();

Returns: nothing (void)

UpdateTransparentToolbars

No description yet.

void UpdateTransparentToolbars();

Returns: nothing (void)

Returned by

IClient.GetGUIManager, GlobalVars.GUIManager