Edit

Share via

PopupEventArgs Class

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

Provides data for the Popup event.

public ref class PopupEventArgs : System::ComponentModel::CancelEventArgs
public class PopupEventArgs : System.ComponentModel.CancelEventArgs
type PopupEventArgs = class
    inherit CancelEventArgs
Public Class PopupEventArgs
Inherits CancelEventArgs
Inheritance
Object
EventArgs
CancelEventArgs
PopupEventArgs

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.

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

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

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.

Constructors

PopupEventArgs(IWin32Window, Control, Boolean, Size)

Initializes an instance of the PopupEventArgs class.

Properties

AssociatedControl

Gets the control for which the ToolTip is being drawn.
AssociatedWindow

Gets the window to which this ToolTip is bound.
Cancel

Gets or sets a value indicating whether the event should be canceled.

(Inherited from CancelEventArgs)
IsBalloon

Gets a value indicating whether the ToolTip is displayed as a standard rectangular or a balloon window.
ToolTipSize

Gets or sets the size of the ToolTip.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also