Inheritance diagram for EVPDDLib::IUI:

Public Member Functions
HRESULT	ShowMessageBox ([in]BSTR msg, [in]BSTR title, [in]LONG boxType, [out, retval] LONG *result)

HRESULT	ShowMessageBox2 ([in]BSTR msg, [in]MessageBoxCaption title, [in]LONG boxType, [out, retval] LONG *result)

HRESULT	DoIdleAction ()
	Enforces idle-action sequence, which leads to enablers of buttons to be triggered.

HRESULT	CreateInputDialog ([out, retval] IMultiInputDialog **ppDlg)
	Creates a multi-input dialog. The caller must populate the set of imput parameters and show it.

Properties
OLE_HANDLE	MainWindow `[get]`
	HWND of the main window. You can use it to manipulate the position and visibility of the main window.

IGadget	GadgetById ([in] LONG Id) `[get]`
	Returns the IGadget representing a certain command Id. Used internally by the test automation.

IGadget	GadgetByPos ([in] ScreenCoordsType coordType,[in] ScreenPoint pos) `[get]`
	Returns the gadget from a certain screen position. Used internally by the test automation.

IListView	LVById ([in] LONG nLVID) `[get]`
	Returns the grid object with a certain Id. Used internally by the test automation.

IListView	LVByHwnd ([in] OLE_HANDLE hWnd) `[get]`
	Returns the grid object with a handle. Used internally by the test automation.

IListView	LVByPos ([in] ScreenCoordsType coordType,[in] ScreenPoint pos) `[get]`
	Returns the grid object from certain screen coordinates. Used internally by the test automation.

INoteTab	NoteTab ([in] TabSpecification tabSpec) `[get]`
	Returns the tab control with a certain functional type. Used internally by the test automation.

LONG	ModeCursor `[get]`
	Returns a default cursor Id of the active mode. Used internally by the test automation.

IAutoCanvas	ActiveCanvas `[get]`
	Returns the canvas activated in the UI. To be called only if the UI is visible and there's an opened project.

BOOL	Visible `[get, set]`

IMenuItemPath	MenuItem ([in] INT itemId) `[get]`
	Returns information of a menu item with a certain Id. Used internally by the test automation system.

CheckBtnInfo	CheckBtnInfoById ([in] OLE_HANDLE hwnd,[in] INT checkButtonId) `[get]`

LONG	BackColor `[get]`
	Returns the canvas's default background control.

IGadget	GadgetByIdEx ([in] LONG Id,[in] BOOL bSearchHidden,[in] OLE_HANDLE hRootWnd) `[get]`

IGadgetGroup	GadgetGroup ([in] BSTR name) `[get]`

IAutoTabControlBar	TabControlBar `[get]`

IGadget	GadgetByPosObj ([in] ScreenCoordsType coordType,[in] LONG x,[in] LONG y) `[get]`

IListView	LVByPosObj ([in] ScreenCoordsType coordType,[in] LONG x,[in] LONG y) `[get]`

BSTR	LanguageAbbrev `[get]`
	Returns a string containing the curent selected language abreviation: EN, BG etc.

BSTR	UIThemeId `[get]`
	Returns a string of the selected icon theme file like SmallTheme.dll.

BSTR	ColorSetId `[get]`
	Returns a string of the selected color theme file like Dark_Flat_DefUIColors_ui.

BOOL	HasInteractiveIser `[get]`
	Returns true if there's interactive user (as opposed to running as a service)

VARIANT_BOOL	ExpectsIdleAction `[get]`
	returns 'true' if there are pending messages to process or an idle-action is pending (e.g. some of the buttons are yet to be enabled after the latest changes)

VARIANT_BOOL	HasGadgetById ([in] LONG Id) `[get]`

Detailed Description

IUI interface gives access to the UI of the application. You can get access to this object by using the IAutoApp::UI property.

Member Function Documentation

◆ ShowMessageBox()

HRESULT EVPDDLib::IUI::ShowMessageBox	(	[in] BSTR	msg,
		[in] BSTR	title,
		[in] LONG	boxType,
		[out, retval] LONG *	result
	)

Displays a message-box on top of the active window.

Parameters

msg	: The message text
title	: The message box title
boxType	: The message-box type, as defined by WinUser.h (MB_OK=0, MB_OKCANCEL=1, MB_ABORTRETRYIGNORE=2, MB_YESNOCANCEL=3, MB_YESNO=4, MB_RETRYCANCEL=5, MB_CANCELTRYCONTINUE=6. can be combined (bitwise) with icon-modifier:MB_ICONHAND=0x10, MB_ICONQUESTION=0x20, MB_ICONEXCLAMATION=0x30, MB_ICONASTERISK=0x40, can be combined (bitwise) with default-button:MB_DEFBUTTON1=0, MB_DEFBUTTON2=0x100, MB_DEFBUTTON3 = 0x200, MB_DEFBUTTON4=0x300 can be combined (bitwise) with message-scope: MB_APPLMODAL=0, MB_SYSTEMMODAL=0x1000, MB_TASKMODAL=0x2000, MB_HELP=0x4000
result	: returns the message-box return code: IDOK=1, IDCANCEL=2, IDABORT=3, IDRETRY=4, IDIGNORE=5, IDYES=6, IDNO=7, IDCLOSE=8, IDHELP=9, IDTRYAGAIN=10, IDCONTINUE=11

◆ ShowMessageBox2()

HRESULT EVPDDLib::IUI::ShowMessageBox2	(	[in] BSTR	msg,
		[in] MessageBoxCaption	title,
		[in] LONG	boxType,
		[out, retval] LONG *	result
	)

Displays a message-box on top of the active window. Like MessageBox, but the title is defined by the NLS of the application

Parameters

msg	: The message text
title	: one of the enumeration values defined by the MessageBoxTitle enum: MBT_Capt_Error = 0, MBT_Capt_Warning = 1, MBT_Capt_Exception = 2, MBT_Capt_Information = 3, MBT_Capt_Fatal = 4, MBT_Capt_Question = 5
boxType	: The same as with IUI::ShowMessageBox
result	: returns the message-box return code: Same as IUI::ShowMessageBox

◆ DoIdleAction()

HRESULT EVPDDLib::IUI::DoIdleAction ( )

Enforces idle-action sequence, which leads to enablers of buttons to be triggered.

◆ CreateInputDialog()

HRESULT EVPDDLib::IUI::CreateInputDialog ( [out, retval] IMultiInputDialog ** ppDlg )

Creates a multi-input dialog. The caller must populate the set of imput parameters and show it.

Property Documentation

◆ MainWindow

OLE_HANDLE EVPDDLib::IUI::MainWindow

get

HWND of the main window. You can use it to manipulate the position and visibility of the main window.

◆ GadgetById

IGadget EVPDDLib::IUI::GadgetById([in] LONG Id)

get

Returns the IGadget representing a certain command Id. Used internally by the test automation.

◆ GadgetByPos

IGadget EVPDDLib::IUI::GadgetByPos([in] ScreenCoordsType coordType, [in] ScreenPoint pos)

get

Returns the gadget from a certain screen position. Used internally by the test automation.

◆ LVById

IListView EVPDDLib::IUI::LVById([in] LONG nLVID)

get

Returns the grid object with a certain Id. Used internally by the test automation.

◆ LVByHwnd

IListView EVPDDLib::IUI::LVByHwnd([in] OLE_HANDLE hWnd)

get

Returns the grid object with a handle. Used internally by the test automation.

◆ LVByPos

IListView EVPDDLib::IUI::LVByPos([in] ScreenCoordsType coordType, [in] ScreenPoint pos)

get

Returns the grid object from certain screen coordinates. Used internally by the test automation.

◆ NoteTab

INoteTab EVPDDLib::IUI::NoteTab([in] TabSpecification tabSpec)

get

Returns the tab control with a certain functional type. Used internally by the test automation.

◆ ModeCursor

LONG EVPDDLib::IUI::ModeCursor

get

Returns a default cursor Id of the active mode. Used internally by the test automation.

◆ ActiveCanvas

IAutoCanvas EVPDDLib::IUI::ActiveCanvas

get

Returns the canvas activated in the UI. To be called only if the UI is visible and there's an opened project.

◆ Visible

BOOL EVPDDLib::IUI::Visible

getset

Manipulates the UI's state of visibility. Setting Visible=false destroys the entire UI. A tray icon is created.

◆ MenuItem

IMenuItemPath EVPDDLib::IUI::MenuItem([in] INT itemId)

get

Returns information of a menu item with a certain Id. Used internally by the test automation system.

◆ CheckBtnInfoById

CheckBtnInfo EVPDDLib::IUI::CheckBtnInfoById([in] OLE_HANDLE hwnd, [in] INT checkButtonId)

get

Forces the check state of a button with Id 'checkButtonId', part of a dialog with handle 'hwnd'. Used by the test automation system.

◆ BackColor

LONG EVPDDLib::IUI::BackColor

get

Returns the canvas's default background control.

◆ GadgetByIdEx

IGadget EVPDDLib::IUI::GadgetByIdEx([in] LONG Id, [in] BOOL bSearchHidden, [in] OLE_HANDLE hRootWnd)

get

Searches for a gadget that's part of a certain UI element (normally a dialog, for example, the Properties dialog). Used by the AI plugin or, internally, by the test automation system.

Parameters

Id	The Id of the gadget.
bSearchHidden	Search through the visible or all the gadgets.
hRootWnd	The handle of the root window. If null is passed, search for a gadget through the entire application. Returns a gadget, matching the criteria, or null.

◆ GadgetGroup

IGadgetGroup EVPDDLib::IUI::GadgetGroup([in] BSTR name)

get

◆ TabControlBar

IAutoTabControlBar EVPDDLib::IUI::TabControlBar

get

◆ GadgetByPosObj

IGadget EVPDDLib::IUI::GadgetByPosObj([in] ScreenCoordsType coordType, [in] LONG x, [in] LONG y)

get

Returns the gadget from a certain screen position. Used internally by the test automation. copy of GadgetByPos not using struct

◆ LVByPosObj

IListView EVPDDLib::IUI::LVByPosObj([in] ScreenCoordsType coordType, [in] LONG x, [in] LONG y)

get

Returns the grid object from certain screen coordinates. Used internally by the test automation. copy of LVByPos not using struct

◆ LanguageAbbrev

BSTR EVPDDLib::IUI::LanguageAbbrev

get

Returns a string containing the curent selected language abreviation: EN, BG etc.

◆ UIThemeId

BSTR EVPDDLib::IUI::UIThemeId

get

Returns a string of the selected icon theme file like SmallTheme.dll.

◆ ColorSetId

BSTR EVPDDLib::IUI::ColorSetId

get

Returns a string of the selected color theme file like Dark_Flat_DefUIColors_ui.

◆ HasInteractiveIser

BOOL EVPDDLib::IUI::HasInteractiveIser

get

Returns true if there's interactive user (as opposed to running as a service)

◆ ExpectsIdleAction

VARIANT_BOOL EVPDDLib::IUI::ExpectsIdleAction

get

returns 'true' if there are pending messages to process or an idle-action is pending (e.g. some of the buttons are yet to be enabled after the latest changes)

◆ HasGadgetById

VARIANT_BOOL EVPDDLib::IUI::HasGadgetById([in] LONG Id)

get

Evaluates if gadget with the specified Id exists (does not say if it is visible or not) Can be used before calling GadgetById, when you expect the gadget is missing, to avoid the exception being thrown.

The documentation for this interface was generated from the following file:

E:/EngView100/libs/CadAutomation/EVPDD.idl

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ ShowMessageBox()

◆ ShowMessageBox2()

◆ DoIdleAction()

◆ CreateInputDialog()

Property Documentation

◆ MainWindow

◆ GadgetById

◆ GadgetByPos

◆ LVById

◆ LVByHwnd

◆ LVByPos

◆ NoteTab

◆ ModeCursor

◆ ActiveCanvas

◆ Visible

◆ MenuItem

◆ CheckBtnInfoById

◆ BackColor

◆ GadgetByIdEx

◆ GadgetGroup

◆ TabControlBar

◆ GadgetByPosObj

◆ LVByPosObj

◆ LanguageAbbrev

◆ UIThemeId

◆ ColorSetId

◆ HasInteractiveIser

◆ ExpectsIdleAction

◆ HasGadgetById