FormClosingEventArgs FormClosingEventArgs FormClosingEventArgs FormClosingEventArgs Class

Definition

Provides data for the FormClosing event.

public ref class FormClosingEventArgs : System::ComponentModel::CancelEventArgs
public class FormClosingEventArgs : System.ComponentModel.CancelEventArgs
type FormClosingEventArgs = class
    inherit CancelEventArgs
Public Class FormClosingEventArgs
Inherits CancelEventArgs
Inheritance
FormClosingEventArgsFormClosingEventArgsFormClosingEventArgsFormClosingEventArgs

Examples

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

private void Form1_FormClosing(Object sender, FormClosingEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "CloseReason", e.CloseReason );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "FormClosing Event" );
}
Private Sub Form1_FormClosing(sender as Object, e as FormClosingEventArgs) _ 
     Handles Form1.FormClosing

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "CloseReason", e.CloseReason)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Cancel", e.Cancel)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"FormClosing Event")

End Sub

Remarks

The FormClosing event occurs just before a form is closed, either by the user, through the user interface (UI), or programmatically, through calls to methods such as Close in the Form class, or Exit in the Application class.

If a form has any child or owned forms, a FormClosing event is also raised for each one. If any one of the forms cancels the event, none of the forms are closed. Therefore the corresponding FormClosed events are not sent to any of the forms.

The FormClosingEventArgs class provides data for this event. Two important members are the Cancel and CloseReason properties. The event can be canceled by setting the Cancel property to true. The CloseReason property provides a reason why the form is being closed.

Constructors

FormClosingEventArgs(CloseReason, Boolean) FormClosingEventArgs(CloseReason, Boolean) FormClosingEventArgs(CloseReason, Boolean) FormClosingEventArgs(CloseReason, Boolean)

Initializes a new instance of the FormClosingEventArgs class.

Properties

Cancel Cancel Cancel Cancel

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

(Inherited from CancelEventArgs)
CloseReason CloseReason CloseReason CloseReason

Gets a value that indicates why the form is being closed.

Methods

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

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

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also