Skip to content

Commit 460526e

Browse files
JuditRosecarlossanlopmerriemcgawThraka
authored
Update missing Winforms documentation (#3959)
* Update missing Winforms documentation * Update xml/System.Windows.Forms/ToolStripControlHost+ToolStripHostedControlAccessibleObject.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Windows.Forms/ComboBox.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Windows.Forms/ComboBox.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Windows.Forms/Form.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Windows.Forms/ListBox.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Windows.Forms/MonthCalendar.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Windows.Forms/ToolStripControlHost+ToolStripHostedControlAccessibleObject.xml Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Update xml/System.ComponentModel.Design/DesignerActionService.xml * Apply suggestions from code review Co-Authored-By: Merrie McGaw <[email protected]> Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Apply suggestions from code review Co-Authored-By: Merrie McGaw <[email protected]> Co-Authored-By: Carlos Sanchez Lopez <[email protected]> * Apply suggestions from code review * Update xml/System.ComponentModel.Design/ObjectSelectorEditor.xml * added article to describe new Explorer style theme * add exception documentation * Update xml/System.ComponentModel.Design/DesignerActionService.xml Co-Authored-By: Andy De George <[email protected]> * Change TreeView to cref link Co-authored-by: Carlos Sanchez Lopez <[email protected]> Co-authored-by: Merrie McGaw <[email protected]> Co-authored-by: Andy De George <[email protected]>
1 parent defcafd commit 460526e

File tree

9 files changed

+56
-35
lines changed

9 files changed

+56
-35
lines changed

‎xml/System.ComponentModel.Design/DesignerActionService.xml

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -619,11 +619,27 @@
619619
<Parameter Name="type" Type="System.Windows.Forms.Design.ComponentActionsType" Index="1" FrameworkAlternate="net-5.0;netcore-3.0;netcore-3.1" />
620620
</Parameters>
621621
<Docs>
622-
<param name="component">To be added.</param>
623-
<param name="type">To be added.</param>
624-
<summary>To be added.</summary>
625-
<returns>To be added.</returns>
626-
<remarks>To be added.</remarks>
622+
<param name="component">The component that the DesignerActions are associated with.</param>
623+
<param name="type">The <see cref="T:System.ComponentModel.Design.ComponentActionsType" /> to filter the associated designer actions with.</param>
624+
<summary>Returns the collection of designer action item lists of the specified type associated with a component.</summary>
625+
<returns>The collection of designer actions of the specified type for the specified component.</returns>
626+
<exception cref="T:System.ArgumentNullException"><paramref name="component" /> is <see langword="null" />.</exception>
627+
<remarks>
628+
<format type="text/markdown"><![CDATA[
629+
630+
## Remarks
631+
This version of the overloaded <xref:System.ComponentModel.Design.DesignerActionService.GetComponentActions%2A> method filters on the `type` parameter, which can have one of the following values.
632+
633+
|Value|Description|
634+
|-----------|-----------------|
635+
|<xref:System.ComponentModel.Design.ComponentActionsType.All>|All associated designer actions.|
636+
|<xref:System.ComponentModel.Design.ComponentActionsType.Component>|Pull-model designer actions only.|
637+
|<xref:System.ComponentModel.Design.ComponentActionsType.Service>|Push-model designer actions only.|
638+
639+
If the associated designer for a component does not supply a pull-model designer action list, then the <xref:System.ComponentModel.Design.DesignerActionService.GetComponentActions%2A> method will instead use the designer's design-time shortcut menu items from the <xref:System.ComponentModel.Design.ComponentDesigner.Verbs%2A> property.
640+
641+
]]></format>
642+
</remarks>
627643
</Docs>
628644
</Member>
629645
<Member MemberName="GetComponentDesignerActions">

‎xml/System.ComponentModel.Design/ObjectSelectorEditor.xml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -135,9 +135,8 @@
135135
<Parameter Name="treeView" Type="System.Windows.Forms.TreeView" Index="0" FrameworkAlternate="net-5.0;netcore-3.0;netcore-3.1" />
136136
</Parameters>
137137
<Docs>
138-
<param name="treeView">To be added.</param>
139-
<summary>To be added.</summary>
140-
<remarks>To be added.</remarks>
138+
<param name="treeView">The tree view control to modify.</param>
139+
<summary>Modify a Windows Forms <see cref="T:System.Windows.Forms.TreeView" /> control to use the <related type="Article" href="https://docs.microsoft.com/en-us/dotnet/framework/winforms/controls/creating-an-explorer-style-interface-with-the-listview-and-treeview"> new Explorer style theme</related>.</summary>
141140
</Docs>
142141
</Member>
143142
<Member MemberName="currValue">

‎xml/System.Windows.Forms.Design/ComponentActionsType.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<BaseTypeName>System.Enum</BaseTypeName>
1515
</Base>
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>Designer action items that can be associated with a component.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -36,7 +36,7 @@
3636
</ReturnValue>
3737
<MemberValue>0</MemberValue>
3838
<Docs>
39-
<summary>To be added.</summary>
39+
<summary>Represents component and service type designer actions.</summary>
4040
</Docs>
4141
</Member>
4242
<Member MemberName="Component">
@@ -57,7 +57,7 @@
5757
</ReturnValue>
5858
<MemberValue>1</MemberValue>
5959
<Docs>
60-
<summary>To be added.</summary>
60+
<summary>Represents pull-model designer actions.</summary>
6161
</Docs>
6262
</Member>
6363
<Member MemberName="Service">
@@ -78,7 +78,7 @@
7878
</ReturnValue>
7979
<MemberValue>2</MemberValue>
8080
<Docs>
81-
<summary>To be added.</summary>
81+
<summary>Represents push-model designer actions.</summary>
8282
</Docs>
8383
</Member>
8484
</Members>

‎xml/System.Windows.Forms/ComboBox.xml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3106,11 +3106,21 @@
31063106
<Parameter Name="keyData" Type="System.Windows.Forms.Keys" Index="1" FrameworkAlternate="net-5.0;netcore-3.0;netcore-3.1" />
31073107
</Parameters>
31083108
<Docs>
3109-
<param name="msg">To be added.</param>
3110-
<param name="keyData">To be added.</param>
3111-
<summary>To be added.</summary>
3112-
<returns>To be added.</returns>
3113-
<remarks>To be added.</remarks>
3109+
<param name="msg">The window message to process, passed by reference.</param>
3110+
<param name="keyData">One of the enumeration values that represent the key to process.</param>
3111+
<summary>Processes a command key.</summary>
3112+
<returns>
3113+
<see langword="true" /> if the character was processed by the control; otherwise, <see langword="false" />.</returns>
3114+
<remarks>
3115+
<format type="text/markdown"><![CDATA[
3116+
3117+
## Remarks
3118+
This method is called during message preprocessing to handle command keys. Command keys are keys that always take precedence over regular input keys. Examples of command keys include accelerators and menu shortcuts. The method must return `true` to indicate that it has processed the command key, or `false` to indicate that the key is not a command key. This method is only called when the control is hosted in a Windows Forms application or as an ActiveX control.
3119+
3120+
The <xref:System.Windows.Forms.Control.ProcessCmdKey%2A> method first determines whether the control has a <xref:System.Windows.Forms.ContextMenu>, and if so, enables the <xref:System.Windows.Forms.ContextMenu> to process the command key. If the command key is not a menu shortcut and the control has a parent, the key is passed to the parent's <xref:System.Windows.Forms.Control.ProcessCmdKey%2A> method. The net effect is that command keys are "bubbled" up the control hierarchy. In addition to the key the user pressed, the key data also indicates which, if any, modifier keys were pressed at the same time as the key. Modifier keys include the SHIFT, CTRL, and ALT keys.
3121+
3122+
]]></format>
3123+
</remarks>
31143124
</Docs>
31153125
</Member>
31163126
<Member MemberName="ProcessKeyEventArgs">

‎xml/System.Windows.Forms/DataGridView.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15233,10 +15233,10 @@
1523315233
<Parameter Name="keyData" Type="System.Windows.Forms.Keys" Index="0" FrameworkAlternate="net-5.0;netcore-3.1" />
1523415234
</Parameters>
1523515235
<Docs>
15236-
<param name="keyData">To be added.</param>
15237-
<summary>To be added.</summary>
15238-
<returns>To be added.</returns>
15239-
<remarks>To be added.</remarks>
15236+
<param name="keyData">A bitwise combination of the enumeration values that represent the key or keys to process.</param>
15237+
<summary>Activates the keyboard tooltip.</summary>
15238+
<returns>
15239+
<see langword="true" /> if the key was processed; otherwise, <see langword="false" />.</returns>
1524015240
</Docs>
1524115241
</Member>
1524215242
<Member MemberName="ProcessDataGridViewKey">

‎xml/System.Windows.Forms/Form.xml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1377,9 +1377,8 @@
13771377
</ReturnValue>
13781378
<Parameters />
13791379
<Docs>
1380-
<summary>To be added.</summary>
1381-
<returns>To be added.</returns>
1382-
<remarks>To be added.</remarks>
1380+
<summary>Creates a new accessibility object for the <see cref="T:System.Windows.Forms.Form" /> control.</summary>
1381+
<returns>A new accessible object for the control.</returns>
13831382
</Docs>
13841383
</Member>
13851384
<Member MemberName="CreateControlsInstance">

‎xml/System.Windows.Forms/ListBox.xml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2020,9 +2020,8 @@
20202020
<Parameter Name="e" Type="System.EventArgs" Index="0" FrameworkAlternate="net-5.0;netcore-3.0;netcore-3.1" />
20212021
</Parameters>
20222022
<Docs>
2023-
<param name="e">To be added.</param>
2024-
<summary>To be added.</summary>
2025-
<remarks>To be added.</remarks>
2023+
<param name="e">An event data instance.</param>
2024+
<summary>Raises the <see cref="E:System.Windows.Forms.Control.GotFocus" /> event.</summary>
20262025
</Docs>
20272026
</Member>
20282027
<Member MemberName="OnHandleCreated">

‎xml/System.Windows.Forms/MonthCalendar.xml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1757,9 +1757,8 @@ The <xref:System.Windows.Forms.AccessibleObject> is only available in applicatio
17571757
<Parameter Name="e" Type="System.EventArgs" Index="0" FrameworkAlternate="net-5.0;netcore-3.1" />
17581758
</Parameters>
17591759
<Docs>
1760-
<param name="e">To be added.</param>
1761-
<summary>To be added.</summary>
1762-
<remarks>To be added.</remarks>
1760+
<param name="e">An event data instance.</param>
1761+
<summary>Raises the <see cref="E:System.Windows.Forms.Control.GotFocus" /> event.</summary>
17631762
</Docs>
17641763
</Member>
17651764
<Member MemberName="OnHandleCreated">

‎xml/System.Windows.Forms/ToolStripControlHost+ToolStripHostedControlAccessibleObject.xml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
</Base>
1616
<Interfaces />
1717
<Docs>
18-
<summary>To be added.</summary>
18+
<summary>Represents the accessible object control host responsible for accessible navigation within the <see cref="T:System.Windows.Forms.ToolStrip" /> standard items and hosted controls like TextBox, ComboBox, ProgressBar, etc.</summary>
1919
<remarks>To be added.</remarks>
2020
</Docs>
2121
<Members>
@@ -37,10 +37,9 @@
3737
<Parameter Name="toolStripControlHost" Type="System.Windows.Forms.ToolStripControlHost" />
3838
</Parameters>
3939
<Docs>
40-
<param name="toolStripHostedControl">To be added.</param>
41-
<param name="toolStripControlHost">To be added.</param>
42-
<summary>To be added.</summary>
43-
<remarks>To be added.</remarks>
40+
<param name="toolStripHostedControl">The control hosted in the <see cref="T:System.Windows.Forms.ToolStripControlHost" /> container.</param>
41+
<param name="toolStripControlHost">The container which hosts a control on the <see cref="T:System.Windows.Forms.ToolStrip" />.</param>
42+
<summary> Initializes a new <see cref="T:System.Windows.Forms.ToolStripControlHost.ToolStripHostedControlAccessibleObject" /> instance with the specified tool strip hosted control and tool strip control host. </summary>
4443
</Docs>
4544
</Member>
4645
</Members>

0 commit comments

Comments
 (0)