Skip to content

Port WinForms docs for 9.0 #10247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Sep 21, 2024
Merged

Port WinForms docs for 9.0 #10247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
17fda2c
Port WinForms API Docs for 9.0
lonitra Aug 13, 2024
7dc3398
Apply suggestions from code review
lonitra Aug 19, 2024
751cfe7
add docs for rc1 experimental apis
lonitra Sep 19, 2024
2640776
fix toolstrip docs
lonitra Sep 19, 2024
efccf59
Apply suggestions from code review
lonitra Sep 19, 2024
d63d343
PR feedback
lonitra Sep 19, 2024
639c2e7
Merge branch 'winformsdoc' of https://github.com/lonitra/dotnet-api-d…
lonitra Sep 19, 2024
baeea0d
Apply suggestions from code review
lonitra Sep 20, 2024
2e67e63
Apply suggestions from code review
lonitra Sep 21, 2024
6d32f04
Apply suggestions from code review
lonitra Sep 21, 2024
6ba3897
Apply suggestions from code review
lonitra Sep 21, 2024
927aeb8
PR feedback
lonitra Sep 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions xml/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollection.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
<Docs>
<summary>Stores <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> objects in a strongly typed collection.</summary>
<remarks>To be added.</remarks>
<seealso cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
Expand Down Expand Up @@ -193,6 +194,7 @@
<returns>The index at which the new element was inserted.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.AddRange(System.Windows.Forms.Design.Behavior.Adorner[])" />
<seealso cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.AddRange(System.Windows.Forms.Design.Behavior.Adorner[])" />
</Docs>
</Member>
<MemberGroup MemberName="AddRange">
Expand Down Expand Up @@ -247,6 +249,7 @@
<summary>Copies the elements of an array to the end of the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />.</summary>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.Add(System.Windows.Forms.Design.Behavior.Adorner)" />
<seealso cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.Add(System.Windows.Forms.Design.Behavior.Adorner)" />
</Docs>
</Member>
<Member MemberName="AddRange">
Expand Down Expand Up @@ -282,6 +285,7 @@
<summary>Adds the contents of another <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> to the end of the collection.</summary>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.Add(System.Windows.Forms.Design.Behavior.Adorner)" />
<seealso cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.Add(System.Windows.Forms.Design.Behavior.Adorner)" />
</Docs>
</Member>
<Member MemberName="Contains">
Expand Down Expand Up @@ -319,6 +323,7 @@
<see langword="true" /> if the <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> is contained in the collection; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.IndexOf(System.Windows.Forms.Design.Behavior.Adorner)" />
<seealso cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.IndexOf(System.Windows.Forms.Design.Behavior.Adorner)" />
</Docs>
</Member>
<Member MemberName="CopyTo">
Expand Down Expand Up @@ -366,6 +371,7 @@ The number of elements in the <see cref="T:System.Windows.Forms.Design.Behavior.
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="arrayIndex" /> is less than the lower bound of <paramref name="array" />.</exception>
<altmember cref="T:System.Array" />
<seealso cref="T:System.Array" />
</Docs>
</Member>
<Member MemberName="GetEnumerator">
Expand Down Expand Up @@ -399,6 +405,7 @@ The number of elements in the <see cref="T:System.Windows.Forms.Design.Behavior.
<returns>An <see cref="T:System.Collections.IEnumerator" /> for the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> instance.</returns>
<remarks>To be added.</remarks>
<altmember cref="T:System.Collections.IEnumerator" />
<seealso cref="T:System.Collections.IEnumerator" />
</Docs>
</Member>
<Member MemberName="IndexOf">
Expand Down Expand Up @@ -435,6 +442,7 @@ The number of elements in the <see cref="T:System.Windows.Forms.Design.Behavior.
<returns>The index of the <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> of <paramref name="value" /> in the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" />, if found; otherwise, -1.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.Contains(System.Windows.Forms.Design.Behavior.Adorner)" />
<seealso cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.Contains(System.Windows.Forms.Design.Behavior.Adorner)" />
</Docs>
</Member>
<Member MemberName="Insert">
Expand Down Expand Up @@ -472,6 +480,7 @@ The number of elements in the <see cref="T:System.Windows.Forms.Design.Behavior.
<summary>Inserts an <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> into the <see cref="T:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection" /> at the specified index.</summary>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.Add(System.Windows.Forms.Design.Behavior.Adorner)" />
<seealso cref="M:System.Windows.Forms.Design.Behavior.BehaviorServiceAdornerCollection.Add(System.Windows.Forms.Design.Behavior.Adorner)" />
</Docs>
</Member>
<Member MemberName="Item">
Expand Down
20 changes: 20 additions & 0 deletions xml/System.Windows.Forms/AccessibleEvents.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -587,6 +587,7 @@
<MemberValue>9</MemberValue>
<Docs>
<summary>A window has lost mouse capture. The system sends the event; servers never send this event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemCaptureStart" />
</Docs>
</Member>
<Member MemberName="SystemCaptureStart">
Expand Down Expand Up @@ -614,6 +615,7 @@
<MemberValue>8</MemberValue>
<Docs>
<summary>A window is being moved or resized. The system sends the event; servers never send this event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemCaptureEnd" />
</Docs>
</Member>
<Member MemberName="SystemContextHelpEnd">
Expand Down Expand Up @@ -641,6 +643,7 @@
<MemberValue>13</MemberValue>
<Docs>
<summary>A window exited context-sensitive Help mode. The system does not send the event consistently.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemContextHelpStart" />
</Docs>
</Member>
<Member MemberName="SystemContextHelpStart">
Expand Down Expand Up @@ -668,6 +671,7 @@
<MemberValue>12</MemberValue>
<Docs>
<summary>A window entered context-sensitive Help mode. The system does not send the event consistently.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemContextHelpEnd" />
</Docs>
</Member>
<Member MemberName="SystemDialogEnd">
Expand Down Expand Up @@ -695,6 +699,7 @@
<MemberValue>17</MemberValue>
<Docs>
<summary>A dialog box was closed. The system does not send the event for standard dialog boxes. Servers send this event for custom dialog boxes. The system does not send the event consistently.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemDialogStart" />
</Docs>
</Member>
<Member MemberName="SystemDialogStart">
Expand Down Expand Up @@ -722,6 +727,7 @@
<MemberValue>16</MemberValue>
<Docs>
<summary>A dialog box was displayed. The system sends the event for standard dialog boxes. Servers send this event for custom dialog boxes. The system does not send the event consistently.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemDialogEnd" />
</Docs>
</Member>
<Member MemberName="SystemDragDropEnd">
Expand Down Expand Up @@ -749,6 +755,7 @@
<MemberValue>15</MemberValue>
<Docs>
<summary>An application is about to exit drag-and-drop mode. Applications that support drag-and-drop operations must send this event; the system does not.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemDragDropStart" />
</Docs>
</Member>
<Member MemberName="SystemDragDropStart">
Expand Down Expand Up @@ -776,6 +783,7 @@
<MemberValue>14</MemberValue>
<Docs>
<summary>An application is about to enter drag-and-drop mode. Applications that support drag-and-drop operations must send this event; the system does not.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemDragDropEnd" />
</Docs>
</Member>
<Member MemberName="SystemForeground">
Expand Down Expand Up @@ -830,6 +838,7 @@
<MemberValue>5</MemberValue>
<Docs>
<summary>A menu from the menu bar was closed. The system sends this event for standard menus. Servers send this event for custom menus.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemMenuStart" />
</Docs>
</Member>
<Member MemberName="SystemMenuPopupEnd">
Expand Down Expand Up @@ -860,6 +869,7 @@
<para>A shortcut menu was closed. The system sends this event for standard menus. Servers send this event for custom menus. When a shortcut menu is closed, the client receives this message followed almost immediately by the <see langword="SystemMenuEnd" /> event. The system does not send the event consistently.</para>
<para>For a call to <c>TrackPopupMenu()</c>, a client will see <see langword="EVENT_SYSTEM_MENUSTART" /> followed almost immediately by <see langword="EVENT_SYSTEM_MENUPOPUPSTART" /> for the popup being shown.</para>
</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemMenuPopupStart" />
</Docs>
</Member>
<Member MemberName="SystemMenuPopupStart">
Expand Down Expand Up @@ -890,6 +900,7 @@
<para>A shortcut menu was displayed. The system sends this event for standard menus. Servers send this event for custom menus. The system does not send the event consistently.</para>
<para>For a call to <c>TrackPopupMenu()</c>, a client will see <see langword="EVENT_SYSTEM_MENUSTART" /> followed almost immediately by <see langword="EVENT_SYSTEM_MENUPOPUPSTART" /> for the popup being shown.</para>
</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemMenuPopupEnd" />
</Docs>
</Member>
<Member MemberName="SystemMenuStart">
Expand Down Expand Up @@ -917,6 +928,7 @@
<MemberValue>4</MemberValue>
<Docs>
<summary>A menu item on the menu bar was selected. The system sends this event for standard menus. Servers send this event for custom menus. The system might raise more than one <see langword="MenuStart" /> event that might or might not have a corresponding <see langword="MenuEnd" /> event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemMenuEnd" />
</Docs>
</Member>
<Member MemberName="SystemMinimizeEnd">
Expand Down Expand Up @@ -944,6 +956,7 @@
<MemberValue>23</MemberValue>
<Docs>
<summary>A window object was minimized or maximized. The system sends the event; servers never send this event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemMinimizeStart" />
</Docs>
</Member>
<Member MemberName="SystemMinimizeStart">
Expand Down Expand Up @@ -971,6 +984,7 @@
<MemberValue>22</MemberValue>
<Docs>
<summary>A window object is about to be minimized or maximized. The system sends the event; servers never send this event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemMinimizeEnd" />
</Docs>
</Member>
<Member MemberName="SystemMoveSizeEnd">
Expand Down Expand Up @@ -998,6 +1012,7 @@
<MemberValue>11</MemberValue>
<Docs>
<summary>The movement or resizing of a window is finished. The system sends the event; servers never send this event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemMoveSizeStart" />
</Docs>
</Member>
<Member MemberName="SystemMoveSizeStart">
Expand Down Expand Up @@ -1025,6 +1040,7 @@
<MemberValue>10</MemberValue>
<Docs>
<summary>A window is being moved or resized. The system sends the event; servers never send this event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemMoveSizeEnd" />
</Docs>
</Member>
<Member MemberName="SystemScrollingEnd">
Expand Down Expand Up @@ -1052,6 +1068,7 @@
<MemberValue>19</MemberValue>
<Docs>
<summary>Scrolling has ended on a scroll bar. The system sends this event for scroll bars attached to a window and for standard scroll bar controls. Servers send this event for custom scroll bars.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemScrollingStart" />
</Docs>
</Member>
<Member MemberName="SystemScrollingStart">
Expand Down Expand Up @@ -1079,6 +1096,7 @@
<MemberValue>18</MemberValue>
<Docs>
<summary>Scrolling has started on a scroll bar. The system sends the event for scroll bars attached to a window and for standard scroll bar controls. Servers send this event for custom scroll bars.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemScrollingEnd" />
</Docs>
</Member>
<Member MemberName="SystemSound">
Expand Down Expand Up @@ -1133,6 +1151,7 @@
<MemberValue>21</MemberValue>
<Docs>
<summary>The user released ALT+TAB. The system sends the <see langword="SwitchEnd" /> event; servers never send this event. If only one application is running when the user presses ALT+TAB, the system sends the <see langword="SwitchEnd" /> event without a corresponding <see langword="SwitchStart" /> event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemSwitchStart" />
</Docs>
</Member>
<Member MemberName="SystemSwitchStart">
Expand Down Expand Up @@ -1160,6 +1179,7 @@
<MemberValue>20</MemberValue>
<Docs>
<summary>The user pressed ALT+TAB, which activates the switch window. If only one application is running when the user presses ALT+TAB, the system raises the <see langword="SwitchEnd" /> event without a corresponding <see langword="SwitchStart" /> event.</summary>
<seealso cref="F:System.Windows.Forms.AccessibleEvents.SystemSwitchEnd" />
</Docs>
</Member>
<Member MemberName="ValueChange">
Expand Down
42 changes: 33 additions & 9 deletions xml/System.Windows.Forms/Application.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,10 @@
<ReturnType>System.Windows.Forms.SystemColorMode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the default color mode (dark mode) for the application.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>This is the <see cref="P:System.Windows.Forms.Application.SystemColorMode" />; which either has been set by <see cref="M:System.Windows.Forms.Application.SetColorMode(System.Windows.Forms.SystemColorMode)" /> or its default value <see cref="F:System.Windows.Forms.SystemColorMode.Classic" />.
If it has been set to <see cref="F:System.Windows.Forms.SystemColorMode.System" />, then the actual color mode is determined by the system settings (which can be retrieved by the static (shared in VB) <see cref="P:System.Windows.Forms.Application.SystemColorMode" /> property.</remarks>
</Docs>
</Member>
<Member MemberName="CommonAppDataPath">
Expand Down Expand Up @@ -982,9 +983,9 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets a value indicating whether the application is running in a dark system color context.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>In a high contrast mode, this will always return <see langword="false" />.</remarks>
</Docs>
</Member>
<Member MemberName="LeaveThreadModal">
Expand Down Expand Up @@ -1811,9 +1812,25 @@
<Parameter Name="systemColorMode" Type="System.Windows.Forms.SystemColorMode" Index="0" FrameworkAlternate="windowsdesktop-9.0" />
</Parameters>
<Docs>
<param name="systemColorMode">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="systemColorMode">The application's default color mode (dark mode) to set.</param>
<summary>Sets the default color mode (dark mode) for the application.</summary>
<remarks>
<para>
You should use this method to set the default color mode (dark mode) for the application. Set it before creating any UI elements to ensure that the correct color mode
is used. You can set it to dark mode (<see cref="F:System.Windows.Forms.SystemColorMode.Dark" />), light mode (<see cref="F:System.Windows.Forms.SystemColorMode.Classic" />)
or to the system setting (<see cref="F:System.Windows.Forms.SystemColorMode.System" />).
</para>
<para>
If you set it to <see cref="F:System.Windows.Forms.SystemColorMode.System" />, the actual color mode is determined by the Windows system settings. If the system setting is changed,
the application will not automatically adapt to the new setting.
</para>
<para>
Note that the dark color mode is only available from Windows 11 on or later versions. If the system is set to a high contrast mode, the dark mode is not available.
</para>
<para>
<b>Note for Visual Basic:</b> If you are using the Visual Basic Application Framework, you should set the color mode by handling the Application Events (see <see cref="E:Microsoft.VisualBasic.ApplicationServices.WindowsFormsApplicationBase.ApplyApplicationDefaults" />).
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="SetCompatibleTextRenderingDefault">
Expand Down Expand Up @@ -1930,6 +1947,7 @@ You can adjust text scale with the **Make text bigger** slider on the **Settings
<exception cref="T:System.ArgumentNullException">
<paramref name="font" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">You can only call this method before the first window is created by your Windows Forms application.</exception>
<seealso href="https://docs.microsoft.com/windows/uwp/design/input/text-scaling" />
</Docs>
</Member>
<Member MemberName="SetHighDpiMode">
Expand Down Expand Up @@ -2225,9 +2243,15 @@ The high DPI mode is set once per process. For more information about setting th
<ReturnType>System.Windows.Forms.SystemColorMode</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the system color mode setting of the OS system environment.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<remarks>
<para>
The color setting is determined based on the operating system version and its system settings. It returns <see cref="F:System.Windows.Forms.SystemColorMode.Dark" /> if the dark mode is enabled in the system settings, <see cref="F:System.Windows.Forms.SystemColorMode.Classic" /> if the color mode equals the light, standard color setting.
</para>
<para><c>SystemColorMode</c> is supported on Windows 11 or later versions.</para>
<para><c>SystemColorModes</c> is not supported if the Windows OS <c>High Contrast Mode</c> has been enabled in the system settings.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ThreadException">
Expand Down
1 change: 1 addition & 0 deletions xml/System.Windows.Forms/ButtonBase.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1040,6 +1040,7 @@ For example, consider a button control whose <xref:System.Windows.Forms.ImageLis
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="value" /> is less than -1.</exception>
<altmember cref="T:System.Windows.Forms.ImageList" />
<inheritdoc cref="P:System.Windows.Forms.ButtonBase.ImageKey" />
</Docs>
</Member>
<Member MemberName="ImageKey">
Expand Down
Loading