Export (0) Print
Expand All

PopupEventArgs Class

Provides data for the ToolTip.Popup event.

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

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

public class PopupEventArgs : CancelEventArgs

The PopupEventArgs type exposes the following members.

  NameDescription
Public methodPopupEventArgsInitializes an instance of the PopupEventArgs class.
Top

  NameDescription
Public propertyAssociatedControlGets the control for which the ToolTip is being drawn.
Public propertyAssociatedWindowGets the window to which this ToolTip is bound.
Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyIsBalloonGets a value indicating whether the ToolTip is displayed as a standard rectangular or a balloon window.
Public propertyToolTipSizeGets or sets the size of the ToolTip.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

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.

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" );
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft