DTE2.UserControl Property

Reference

Definition

Namespace:: EnvDTE80

Assembly:: EnvDTE80.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a value indicating whether the environment was started by a user or by automation.

public:
 property bool UserControl { bool get(); void set(bool value); };

public:
 property bool UserControl { bool get(); void set(bool value); };

[System.Runtime.InteropServices.DispId(227)]
public bool UserControl { [System.Runtime.InteropServices.DispId(227)] get; [System.Runtime.InteropServices.DispId(227)] set; }

[<System.Runtime.InteropServices.DispId(227)>]
[<get: System.Runtime.InteropServices.DispId(227)>]
[<set: System.Runtime.InteropServices.DispId(227)>]
member this.UserControl : bool with get, set

Public Property UserControl As Boolean

Property Value

Boolean

true if the environment is running under user control; otherwise, false.

Implements

UserControl

Attributes: DispIdAttribute

Examples

Sub UserControlExample()  
   MsgBox("Environment is running under user control?: " & DTE2.UserControl)  
End Sub

Remarks

UserControl can be set to true, indicating that a human is interacting with the environment. Once this is done, you cannot change it back to false.

If the environment is not under user control, and the last external automation client disconnects, then the environment shuts down.

If you start the environment through the Start menu, it is user-created and UserControl is set to true. If the environment is started by CoCreate, however, it is automation-created and UserControl is set to false.

You can control the visibility of the main window through automation only when UserControl is set to false. After it is irreversibly set to true, the main window cannot be hidden.

Manually attempting to open a new solution or document causes UserControl to be set to true. Automatically attempting to do the same does not affect the value.

Applies to