Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
UserControl Property

_DTE.UserControl Property

Sets or gets a value indicating whether the environment was launched by a user or by automation.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.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, but 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. Once 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?: " & DTE.UserControl)
End Sub

Community Additions

ADD
Show:
© 2015 Microsoft