ToolTip.Active Property (System.Windows.Forms)

Active Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

ToolTip..::.Active Property

Gets or sets a value indicating whether the ToolTip is currently active.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

Visual Basic (Declaration)

Public Property Active As Boolean

Visual Basic (Usage)

Dim instance As ToolTip
Dim value As Boolean

value = instance.Active

instance.Active = value

public bool Active { get; set; }

Visual C++

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

JScript

public function get Active () : boolean
public function set Active (value : boolean)

Property Value

Type: System..::.Boolean
true if the ToolTip is currently active; otherwise, false. The default is true.

Remarks

With the Active property, you can enable or disable the display of ToolTip text for all controls that have text specified by this particular ToolTip component. Although more than one ToolTip component can be created and assigned to a form, setting the Active property to false only affects the current ToolTip. You can enable users to set the value of this property in a form that provides application options. These options, in turn, provide the user with the ability to enable or disable the display of ToolTips in your application.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0

Reference

ToolTip Class

ToolTip Members

System.Windows.Forms Namespace