dotnet-api-docs/xml/System.Windows.Forms/CloseReason.xml at main · dotnet/dotnet-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<Type Name="CloseReason" FullName="System.Windows.Forms.CloseReason">
  <TypeSignature Language="C#" Value="public enum CloseReason" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed CloseReason extends System.Enum" />
  <TypeSignature Language="DocId" Value="T:System.Windows.Forms.CloseReason" />
  <TypeSignature Language="VB.NET" Value="Public Enum CloseReason" />
  <TypeSignature Language="F#" Value="type CloseReason = " />
  <TypeSignature Language="C++ CLI" Value="public enum class CloseReason" />
  <AssemblyInfo>
    <AssemblyName>System.Windows.Forms</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
    <AssemblyVersion>10.0.0.0</AssemblyVersion>
    <AssemblyVersion>11.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>Specifies the reason that a form was closed.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[

## Remarks
 The <xref:System.Windows.Forms.Form.FormClosing> and <xref:System.Windows.Forms.Form.FormClosed> events are raised when a <xref:System.Windows.Forms.Form> is closed, either through user action or programmatically. Handlers for these events receive parameters of type <xref:System.Windows.Forms.FormClosingEventArgs> and <xref:System.Windows.Forms.FormClosedEventArgs>, respectively. Both of these event argument classes use the <xref:System.Windows.Forms.CloseReason> enumeration.

 ]]></format>
    </remarks>
    <altmember cref="E:System.Windows.Forms.Form.FormClosing" />
    <altmember cref="E:System.Windows.Forms.Form.FormClosed" />
    <altmember cref="P:System.Windows.Forms.FormClosingEventArgs.CloseReason" />
    <altmember cref="P:System.Windows.Forms.FormClosedEventArgs.CloseReason" />
  </Docs>
  <Members>
    <Member MemberName="ApplicationExitCall">
      <MemberSignature Language="C#" Value="ApplicationExitCall" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.CloseReason ApplicationExitCall = int32(6)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Forms.CloseReason.ApplicationExitCall" />
      <MemberSignature Language="VB.NET" Value="ApplicationExitCall" />
      <MemberSignature Language="F#" Value="ApplicationExitCall = 6" Usage="System.Windows.Forms.CloseReason.ApplicationExitCall" />
      <MemberSignature Language="C++ CLI" Value="ApplicationExitCall" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.CloseReason</ReturnType>
      </ReturnValue>
      <MemberValue>6</MemberValue>
      <Docs>
        <summary>The <see cref="M:System.Windows.Forms.Application.Exit" /> method of the <see cref="T:System.Windows.Forms.Application" /> class was invoked.</summary>
      </Docs>
    </Member>
    <Member MemberName="FormOwnerClosing">
      <MemberSignature Language="C#" Value="FormOwnerClosing" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.CloseReason FormOwnerClosing = int32(5)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Forms.CloseReason.FormOwnerClosing" />
      <MemberSignature Language="VB.NET" Value="FormOwnerClosing" />
      <MemberSignature Language="F#" Value="FormOwnerClosing = 5" Usage="System.Windows.Forms.CloseReason.FormOwnerClosing" />
      <MemberSignature Language="C++ CLI" Value="FormOwnerClosing" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.CloseReason</ReturnType>
      </ReturnValue>
      <MemberValue>5</MemberValue>
      <Docs>
        <summary>The owner form is closing.</summary>
      </Docs>
    </Member>
    <Member MemberName="MdiFormClosing">
      <MemberSignature Language="C#" Value="MdiFormClosing" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.CloseReason MdiFormClosing = int32(2)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Forms.CloseReason.MdiFormClosing" />
      <MemberSignature Language="VB.NET" Value="MdiFormClosing" />
      <MemberSignature Language="F#" Value="MdiFormClosing = 2" Usage="System.Windows.Forms.CloseReason.MdiFormClosing" />
      <MemberSignature Language="C++ CLI" Value="MdiFormClosing" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.CloseReason</ReturnType>
      </ReturnValue>
      <MemberValue>2</MemberValue>
      <Docs>
        <summary>The parent form of this multiple document interface (MDI) form is closing.</summary>
      </Docs>
    </Member>
    <Member MemberName="None">
      <MemberSignature Language="C#" Value="None" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.CloseReason None = int32(0)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Forms.CloseReason.None" />
      <MemberSignature Language="VB.NET" Value="None" />
      <MemberSignature Language="F#" Value="None = 0" Usage="System.Windows.Forms.CloseReason.None" />
      <MemberSignature Language="C++ CLI" Value="None" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.CloseReason</ReturnType>
      </ReturnValue>
      <MemberValue>0</MemberValue>
      <Docs>
        <summary>The cause of the closure was not defined or could not be determined.</summary>
      </Docs>
    </Member>
    <Member MemberName="TaskManagerClosing">
      <MemberSignature Language="C#" Value="TaskManagerClosing" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.CloseReason TaskManagerClosing = int32(4)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Forms.CloseReason.TaskManagerClosing" />
      <MemberSignature Language="VB.NET" Value="TaskManagerClosing" />
      <MemberSignature Language="F#" Value="TaskManagerClosing = 4" Usage="System.Windows.Forms.CloseReason.TaskManagerClosing" />
      <MemberSignature Language="C++ CLI" Value="TaskManagerClosing" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.CloseReason</ReturnType>
      </ReturnValue>
      <MemberValue>4</MemberValue>
      <Docs>
        <summary>
          <para>The Microsoft Windows Task Manager is closing the application.</para>
          <para>In Windows 8.1 and later versions, this member is not used, because Task Manager issues the <c>WM_SYSCOMMAND</c> message with <c>SC_CLOSE</c>. In Windows 7 and earlier versions, the <c>WM_CLOSE</c> message was issued. This action is now indistinguishable from and misclassified as  <c>CloseReason.UserClosing</c>.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="UserClosing">
      <MemberSignature Language="C#" Value="UserClosing" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.CloseReason UserClosing = int32(3)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Forms.CloseReason.UserClosing" />
      <MemberSignature Language="VB.NET" Value="UserClosing" />
      <MemberSignature Language="F#" Value="UserClosing = 3" Usage="System.Windows.Forms.CloseReason.UserClosing" />
      <MemberSignature Language="C++ CLI" Value="UserClosing" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.CloseReason</ReturnType>
      </ReturnValue>
      <MemberValue>3</MemberValue>
      <Docs>
        <summary>The form is closing either programmatically or through a user action in the user interface (for example, by clicking the **Close** button on the form window, selecting **Close** from the window's control menu, or pressing ALT+F4).</summary>
      </Docs>
    </Member>
    <Member MemberName="WindowsShutDown">
      <MemberSignature Language="C#" Value="WindowsShutDown" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.CloseReason WindowsShutDown = int32(1)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Forms.CloseReason.WindowsShutDown" />
      <MemberSignature Language="VB.NET" Value="WindowsShutDown" />
      <MemberSignature Language="F#" Value="WindowsShutDown = 1" Usage="System.Windows.Forms.CloseReason.WindowsShutDown" />
      <MemberSignature Language="C++ CLI" Value="WindowsShutDown" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
        <AssemblyVersion>10.0.0.0</AssemblyVersion>
        <AssemblyVersion>11.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.CloseReason</ReturnType>
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
        <summary>The operating system is closing all applications before shutting down.</summary>
      </Docs>
    </Member>
  </Members>
</Type>