OLEIPCSTATE Enumeration

Specifies state IDs passed to IOleInPlaceComponent::OnEnterState, OnUIComponentEnterState, FOnUIComponentExitState, and FUIComponentInState.

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

Syntax

'Declaration
Public Enumeration OLEIPCSTATE
public enum OLEIPCSTATE
public enum class OLEIPCSTATE
type OLEIPCSTATE
public enum OLEIPCSTATE

Members

Member name Description
OLEIPCSTATE_MODAL Modal state; disables top-level windows.
OLEIPCSTATE_REDRAWOFF redrawOff state; disables window repainting.
OLEIPCSTATE_WARNINGSOFF warningsOff state; disables user warnings.
OLEIPCSTATE_RECORDING Recording state.

Remarks

When the host or a component is notified through one of these methods that another entity (component or host) is entering or exiting a state identified by one of these state IDs, the host/component should take appropriate action:

OLEIPCSTATE_MODAL (modal state):

If the application is entering a modal state, the host/component should disable its top-level windows, and reenable them when the application exits this state. Also, when this state is entered or exited, host/component should notify approprate inplace objects via EnableModeless.

OLEIPCSTATE_REDRAWOFF (redrawOff state):

If the application is entering a redrawOff state, the host/component should disable repainting of its windows, and reenable repainting when the application exits this state.

OLEIPCSTATE_WARNINGSOFF (warningsOff state):

If the application is entering a warningsOff state, the host/component should disable the presentation of any user warnings, and reenable this when the application exits this state.

OLEIPCSTATE_RECORDING (Recording state):

Used to notify the host/component when Recording is turned on or off.

COM Signature

From oleipc.idl:

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace