OLEIPCSTATE Enum

  • Reference

Definition

Namespace:
Microsoft.VisualStudio.Shell.Interop
Assembly:
Microsoft.VisualStudio.Shell.Interop.dll
Assembly:
Microsoft.VisualStudio.Interop.dll
Package:
Microsoft.VisualStudio.Interop v17.9.37000

Specifies state IDs passed to IOleInPlaceComponent::OnEnterState(UInt32, Int32), OnUIComponentEnterState(UInt32, UInt32, UInt32), FOnUIComponentExitState(UInt32, UInt32, UInt32), and FUIComponentInState(UInt32).

public enum class OLEIPCSTATE
public enum class OLEIPCSTATE
enum OLEIPCSTATE
public enum OLEIPCSTATE
type OLEIPCSTATE = 
Public Enum OLEIPCSTATE
Inheritance
Enum
OLEIPCSTATE

Fields

OLEIPCSTATE_MODAL 1

Modal state; disables top-level windows.
OLEIPCSTATE_RECORDING 4

Recording state.
OLEIPCSTATE_REDRAWOFF 2

redrawOff state; disables window repainting.
OLEIPCSTATE_WARNINGSOFF 3

warningsOff state; disables user warnings.

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:

Applies to