IOleComponentUIManager::OnUIEvent Method (UInt32, Guid, Guid, UInt32, UInt32, UInt32, array<RECT>^, Object^)

Visual Studio 2015
 

Informs the SOleComponentUIManager service of a UI event.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

C#
C++
F#
VB
Copy 
void OnUIEvent(
	unsigned int dwCompRole,
	[InAttribute] Guid% rclsidComp,
	[InAttribute] Guid% pguidUIEventGroup,
	unsigned int nUIEventId,
	unsigned int dwUIEventStatus,
	unsigned int dwEventFreq,
	array<RECT>^ prcEventRegion,
	[InAttribute] Object^% pvarEventArg
)

Parameters

dwCompRole
Type: System::UInt32

[in] Role of the affected in-place VSPackage object. For valid dwCompRole values, see OLEROLE.

rclsidComp
Type: System::Guid

[in] Class identifier (CLSID) of the in-place VSPackage object.

pguidUIEventGroup
Type: System::Guid

[in] Uniquely identifies the UI events group of the in-place VSPackage object.

nUIEventId
Type: System::UInt32

[in] Identifies the event using a combination of the events group and event ID.

dwUIEventStatus
Type: System::UInt32

[in] Represents the status of the event. For valid dwUIEventStatus values, see OLEUIEVENTSTATUS.

dwEventFreq
Type: System::UInt32

[in] Indicates how often the event occurs. For valid dwEventFreq values, see OLEUIEVENTFREQ.

prcEventRegion
Type: array<Microsoft.VisualStudio.OLE.Interop::RECT>^

[in] Screen coordinates of the region that might be affected by the event. The environment uses this information to avoid the region.

pvarEventArg
Type: System::Object^

[in] Contains event-specific information if applicable. Typically, pvarEventArg will be null.

From oleipc.idl:

C++
Copy 
void IOleComponentUIManager::OnUIEvent(
   [in] DWORD dwCompRole,
   [in] REFCLSID rclsidComp,
   [in] const GUID *pguidUIEventGroup,
   [in] DWORD nUIEventId,
   [in] DWORD dwUIEventStatus,
   [in] DWORD dwEventFreq,
   [in] RECT *prcEventRegion,
   [in] VARIANT *pvarEventArg
);

The functionality provided by OnUIEvent is also available with the SVsStatusbar service. OnUIEvent can be used to control various fields in the environment's status bar. It is intended to insulate an in-place VSPackage object from interacting directly with any environment-specific UI peculiarities.

A call to OnUIEvent communicates an event's identifier, its status, its frequency, and the region affected. The following events are currently supported by OnUIEvent.

Events

 

uieventidSetTextLinePos

uieventidSetGraphicYPos

uieventidSetTextColPos

uieventidSetGraphicXSize

uieventidSetTextSelMode

uieventidSetGraphicYSize

uieventidSetTextCharPos

uieventidSetGraphicXPos

uieventidSetTextInsMode

uieventidAnimateIcon

Return to top
Show: