Windows apps
Collapse the table of content
Expand the table of content
Information
Switch
Switch
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

FormClosingEventArgs::CloseReason Property

.NET Framework (current version)
 

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

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

C#
C++
F#
VB
Copy 
public:
property CloseReason CloseReason {
	CloseReason get();
}

Property Value

Type: System.Windows.Forms::CloseReason

One of the System.Windows.Forms::CloseReason enumerated values.

A Form can be closed because of a variety of reasons, both user-initiated and programmatic. The CloseReason property indicates a reason for the closure.

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the Form::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 MessageBox::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 Form::FormClosing event.

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show:
© 2017 Microsoft