DTE2.UserControl Property

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

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

Namespace:  EnvDTE80
Assembly:  EnvDTE80 (in EnvDTE80.dll)

bool UserControl { get; set; }

Property Value

Type: System.Boolean
true if the environment is running under user control; otherwise, false.

UserControl can be set to true, indicating that a human is interacting with the environment. Once this is done, an Add-in or macro 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.

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft