SplitterCancelEventArgs Class

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

SplitterCancelEventArgs.cs

Provides data for splitter events.

public ref class SplitterCancelEventArgs : System::ComponentModel::CancelEventArgs

public class SplitterCancelEventArgs : System.ComponentModel.CancelEventArgs

type SplitterCancelEventArgs = class
    inherit CancelEventArgs

Public Class SplitterCancelEventArgs
Inherits CancelEventArgs

Inheritance

Object

EventArgs

CancelEventArgs

SplitterCancelEventArgs

Examples

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the SplitterMoving 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 SplitContainer named SplitContainer1. Then ensure that the event handler is associated with the SplitterMoving event.

private void SplitContainer1_SplitterMoving(Object sender, SplitterCancelEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "MouseCursorX", e.MouseCursorX );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "MouseCursorY", e.MouseCursorY );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "SplitX", e.SplitX );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "SplitY", e.SplitY );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "SplitterMoving Event" );
}

Private Sub SplitContainer1_SplitterMoving(sender as Object, e as SplitterCancelEventArgs) _ 
     Handles SplitContainer1.SplitterMoving

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "MouseCursorX", e.MouseCursorX)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "MouseCursorY", e.MouseCursorY)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "SplitX", e.SplitX)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "SplitY", e.SplitY)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Cancel", e.Cancel)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"SplitterMoving Event")

End Sub

Constructors

SplitterCancelEventArgs(Int32, Int32, Int32, Int32)

Initializes a new instance of the SplitterCancelEventArgs class with the specified coordinates of the mouse pointer and the upper left corner of the SplitContainer.

Properties

Cancel	Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs)
MouseCursorX	Gets the X coordinate of the mouse pointer in client coordinates.
MouseCursorY	Gets the Y coordinate of the mouse pointer in client coordinates.
SplitX	Gets or sets the X coordinate of the upper left corner of the SplitContainer in client coordinates.
SplitY	Gets or sets the Y coordinate of the upper left corner of the SplitContainer in client coordinates.

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)