PopupEventArgs Class (System.Windows.Forms)

Switch View :
Classic
Lightweight
ScriptFree
.NET Framework Class Library
PopupEventArgs Class

Provides data for the ToolTip.Popup event.

Inheritance Hierarchy
System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      System.Windows.Forms.PopupEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)
Syntax
Visual Basic
Public Class PopupEventArgs _
	Inherits CancelEventArgs
C#
public class PopupEventArgs : CancelEventArgs
Visual C++
public ref class PopupEventArgs : public CancelEventArgs
F#
type PopupEventArgs =  
    class
        inherit CancelEventArgs
    end

The PopupEventArgs type exposes the following members.

Constructors
  Name Description
Public method PopupEventArgs Initializes an instance of the PopupEventArgs class.
Top
Properties
  Name Description
Public property AssociatedControl Gets the control for which the ToolTip is being drawn.
Public property AssociatedWindow Gets the window to which this ToolTip is bound.
Public property Cancel Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public property IsBalloon Gets a value indicating whether the ToolTip is displayed as a standard rectangular or a balloon window.
Public property ToolTipSize Gets or sets the size of the ToolTip.
Top
Methods
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top
Remarks

The Popup event of the ToolTip class is raised before a ToolTip is displayed. The handler for this event receives a parameter of type PopupEventArgs. This parameter provides information about the ToolTip and enables you to modify the size of the ToolTip through the ToolTipSize property. Because Popup derives from CancelEventArgs, the handler can also stop the ToolTip from being displayed.

Examples

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the Popup event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type ToolTip named ToolTip1. Then ensure that the event handler is associated with the Popup event.

Visual Basic

Private Sub ToolTip1_Popup(sender as Object, e as PopupEventArgs) _ 
     Handles ToolTip1.Popup

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "AssociatedWindow", e.AssociatedWindow)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "AssociatedControl", e.AssociatedControl)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "IsBalloon", e.IsBalloon)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "ToolTipSize", e.ToolTipSize)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Cancel", e.Cancel)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"Popup Event")

End Sub
C#

private void ToolTip1_Popup(Object sender, PopupEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "AssociatedWindow", e.AssociatedWindow );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "AssociatedControl", e.AssociatedControl );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "IsBalloon", e.IsBalloon );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "ToolTipSize", e.ToolTipSize );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "Popup Event" );
}
Version Information

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Platforms

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also

Reference

System.Windows.Forms Namespace
ToolTip
Popup
DrawToolTipEventArgs
ToolTipSize