Skip to content

Commit 1e01c0a

Browse files
AdamYoblickAdamYoblick
authored
Merge pull request #5078 from AdamYoblick/master
Regenerated intellisense xml from winforms triple slash comments
2 parents f3d08e7 + 36b9b58 commit 1e01c0a

38 files changed

+899
-220
lines changed

‎xml/System.Windows.Forms.Design.Behavior/BehaviorServiceAdornerCollection.xml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -426,6 +426,8 @@ The number of elements in the <see cref="T:System.Windows.Forms.Design.Behavior.
426426
<summary>Gets or sets the element at the specified index.</summary>
427427
<value>The <see cref="T:System.Windows.Forms.Design.Behavior.Adorner" /> element specified by <paramref name="index" />.</value>
428428
<remarks>To be added.</remarks>
429+
<exception cref="T:System.ArgumentOutOfRangeException">
430+
<paramref name="index" /> is outside the valid range of indexes for the collection.</exception>
429431
</Docs>
430432
</Member>
431433
<Member MemberName="Remove">

‎xml/System.Windows.Forms.VisualStyles/FontProperty.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
</ReturnValue>
6666
<MemberValue>210</MemberValue>
6767
<Docs>
68-
<summary>To be added.</summary>
68+
<summary>The font that will be used to draw text within the context of this part.</summary>
6969
</Docs>
7070
</Member>
7171
</Members>

‎xml/System.Windows.Forms/AccessibleEvents.xml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -735,6 +735,15 @@
735735
<MemberValue>7</MemberValue>
736736
<Docs>
737737
<summary>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.</summary>
738+
<remarks>
739+
<format type="text/markdown"><![CDATA[
740+
741+
## Remarks
742+
743+
Note that for a call to TrackPopupMenu(), a client will see `EVENT_SYSTEM_MENUSTART` followed almost immediately by `EVENT_SYSTEM_MENUPOPUPSTART` for the popup being shown.
744+
745+
]]></format>
746+
</remarks>
738747
</Docs>
739748
</Member>
740749
<Member MemberName="SystemMenuPopupStart">
@@ -758,6 +767,15 @@
758767
<MemberValue>6</MemberValue>
759768
<Docs>
760769
<summary>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.</summary>
770+
<remarks>
771+
<format type="text/markdown"><![CDATA[
772+
773+
## Remarks
774+
775+
Note that for a call to TrackPopupMenu(), a client will see `EVENT_SYSTEM_MENUSTART` followed almost immediately by `EVENT_SYSTEM_MENUPOPUPSTART` for the popup being shown.
776+
777+
]]></format>
778+
</remarks>
761779
</Docs>
762780
</Member>
763781
<Member MemberName="SystemMenuStart">

‎xml/System.Windows.Forms/AxHost.xml‎

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4271,7 +4271,15 @@
42714271
<Docs>
42724272
<summary>Returns a collection of type <see cref="T:System.Attribute" /> for the current object.</summary>
42734273
<returns>An <see cref="T:System.ComponentModel.AttributeCollection" /> with the attributes for the current object.</returns>
4274-
<remarks>To be added.</remarks>
4274+
<remarks>
4275+
<format type="text/markdown"><![CDATA[
4276+
4277+
## Remarks
4278+
4279+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.AxHost> instance is cast to an <xref:System.ComponentModel.ICustomTypeDescriptor> interface.
4280+
4281+
]]></format>
4282+
</remarks>
42754283
</Docs>
42764284
</Member>
42774285
<Member MemberName="System.ComponentModel.ICustomTypeDescriptor.GetClassName">
@@ -4542,7 +4550,15 @@
45424550
<Docs>
45434551
<summary>Returns the events for the current object.</summary>
45444552
<returns>An <see cref="T:System.ComponentModel.EventDescriptorCollection" /> that represents the events for the current object.</returns>
4545-
<remarks>To be added.</remarks>
4553+
<remarks>
4554+
<format type="text/markdown"><![CDATA[
4555+
4556+
## Remarks
4557+
4558+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.AxHost> instance is cast to an <xref:System.ComponentModel.ICustomTypeDescriptor> interface.
4559+
4560+
]]></format>
4561+
</remarks>
45464562
</Docs>
45474563
</Member>
45484564
<Member MemberName="System.ComponentModel.ICustomTypeDescriptor.GetEvents">
@@ -4626,7 +4642,15 @@
46264642
<Docs>
46274643
<summary>Returns the properties for the current object.</summary>
46284644
<returns>A <see cref="T:System.ComponentModel.PropertyDescriptorCollection" /> that represents the events for the current object.</returns>
4629-
<remarks>To be added.</remarks>
4645+
<remarks>
4646+
<format type="text/markdown"><![CDATA[
4647+
4648+
## Remarks
4649+
4650+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.AxHost> instance is cast to an <xref:System.ComponentModel.ICustomTypeDescriptor> interface.
4651+
4652+
]]></format>
4653+
</remarks>
46304654
</Docs>
46314655
</Member>
46324656
<Member MemberName="System.ComponentModel.ICustomTypeDescriptor.GetProperties">

‎xml/System.Windows.Forms/BindingContext.xml‎

Lines changed: 63 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,15 @@ this->BindingContext->get_Item(dataSet1->Customers)->Position = 1;
204204
<param name="dataSource">The <see cref="T:System.Object" /> associated with the <see cref="T:System.Windows.Forms.BindingManagerBase" />.</param>
205205
<param name="listManager">The <see cref="T:System.Windows.Forms.BindingManagerBase" /> to add.</param>
206206
<summary>Adds the <see cref="T:System.Windows.Forms.BindingManagerBase" /> associated with a specific data source to the collection.</summary>
207-
<remarks>To be added.</remarks>
207+
<remarks>
208+
<format type="text/markdown"><![CDATA[
209+
210+
## Remarks
211+
212+
This method is obsolete and unused.
213+
214+
]]></format>
215+
</remarks>
208216
</Docs>
209217
</Member>
210218
<Member MemberName="AddCore">
@@ -233,7 +241,15 @@ this->BindingContext->get_Item(dataSet1->Customers)->Position = 1;
233241
<param name="dataSource">The object associated with the <see cref="T:System.Windows.Forms.BindingManagerBase" />.</param>
234242
<param name="listManager">The <see cref="T:System.Windows.Forms.BindingManagerBase" /> to add.</param>
235243
<summary>Adds the <see cref="T:System.Windows.Forms.BindingManagerBase" /> associated with a specific data source to the collection.</summary>
236-
<remarks>To be added.</remarks>
244+
<remarks>
245+
<format type="text/markdown"><![CDATA[
246+
247+
## Remarks
248+
249+
This method is obsolete and unused.
250+
251+
]]></format>
252+
</remarks>
237253
<exception cref="T:System.ArgumentNullException">
238254
<paramref name="dataSource" /> is <see langword="null" />.
239255

@@ -263,7 +279,15 @@ this->BindingContext->get_Item(dataSet1->Customers)->Position = 1;
263279
<Parameters />
264280
<Docs>
265281
<summary>Clears the collection of any <see cref="T:System.Windows.Forms.BindingManagerBase" /> objects.</summary>
266-
<remarks>To be added.</remarks>
282+
<remarks>
283+
<format type="text/markdown"><![CDATA[
284+
285+
## Remarks
286+
287+
This method is obsolete and unused.
288+
289+
]]></format>
290+
</remarks>
267291
</Docs>
268292
</Member>
269293
<Member MemberName="ClearCore">
@@ -287,7 +311,15 @@ this->BindingContext->get_Item(dataSet1->Customers)->Position = 1;
287311
<Parameters />
288312
<Docs>
289313
<summary>Clears the collection.</summary>
290-
<remarks>To be added.</remarks>
314+
<remarks>
315+
<format type="text/markdown"><![CDATA[
316+
317+
## Remarks
318+
319+
This method is obsolete and unused.
320+
321+
]]></format>
322+
</remarks>
291323
</Docs>
292324
</Member>
293325
<Member MemberName="CollectionChanged">
@@ -679,7 +711,15 @@ BindingManagerBase bmOrders = this.BindingContext
679711
<Docs>
680712
<param name="dataSource">The data source associated with the <see cref="T:System.Windows.Forms.BindingManagerBase" /> to remove.</param>
681713
<summary>Deletes the <see cref="T:System.Windows.Forms.BindingManagerBase" /> associated with the specified data source.</summary>
682-
<remarks>To be added.</remarks>
714+
<remarks>
715+
<format type="text/markdown"><![CDATA[
716+
717+
## Remarks
718+
719+
This method is obsolete and unused.
720+
721+
]]></format>
722+
</remarks>
683723
</Docs>
684724
</Member>
685725
<Member MemberName="RemoveCore">
@@ -706,7 +746,15 @@ BindingManagerBase bmOrders = this.BindingContext
706746
<Docs>
707747
<param name="dataSource">The data source associated with the <see cref="T:System.Windows.Forms.BindingManagerBase" /> to remove.</param>
708748
<summary>Removes the <see cref="T:System.Windows.Forms.BindingManagerBase" /> associated with the specified data source.</summary>
709-
<remarks>To be added.</remarks>
749+
<remarks>
750+
<format type="text/markdown"><![CDATA[
751+
752+
## Remarks
753+
754+
This method is obsolete and unused.
755+
756+
]]></format>
757+
</remarks>
710758
</Docs>
711759
</Member>
712760
<Member MemberName="System.Collections.ICollection.CopyTo">
@@ -844,7 +892,15 @@ BindingManagerBase bmOrders = this.BindingContext
844892
<Docs>
845893
<summary>Gets an object to use for synchronization (thread safety).</summary>
846894
<value>This property is derived from <see cref="T:System.Collections.ICollection" />, and is overridden to always return <see langword="null" />.</value>
847-
<remarks>To be added.</remarks>
895+
<remarks>
896+
<format type="text/markdown"><![CDATA[
897+
898+
## Remarks
899+
900+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.BindingContext> instance is cast to an <xref:System.Collections.ICollection> interface.
901+
902+
]]></format>
903+
</remarks>
848904
</Docs>
849905
</Member>
850906
<Member MemberName="System.Collections.IEnumerable.GetEnumerator">

‎xml/System.Windows.Forms/BindingSource.xml‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3853,7 +3853,15 @@
38533853
<Parameters />
38543854
<Docs>
38553855
<summary>Signals the <see cref="T:System.Windows.Forms.BindingSource" /> that initialization is starting.</summary>
3856-
<remarks>To be added.</remarks>
3856+
<remarks>
3857+
<format type="text/markdown"><![CDATA[
3858+
3859+
## Remarks
3860+
3861+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.BindingSource> instance is cast to an <xref:System.ComponentModel.ISupportInitialize> interface.
3862+
3863+
]]></format>
3864+
</remarks>
38573865
</Docs>
38583866
</Member>
38593867
<Member MemberName="System.ComponentModel.ISupportInitialize.EndInit">
@@ -3879,7 +3887,15 @@
38793887
<Parameters />
38803888
<Docs>
38813889
<summary>Signals the <see cref="T:System.Windows.Forms.BindingSource" /> that initialization is complete.</summary>
3882-
<remarks>To be added.</remarks>
3890+
<remarks>
3891+
<format type="text/markdown"><![CDATA[
3892+
3893+
## Remarks
3894+
3895+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.BindingSource> instance is cast to an <xref:System.ComponentModel.ISupportInitialize> interface.
3896+
3897+
]]></format>
3898+
</remarks>
38833899
</Docs>
38843900
</Member>
38853901
<Member MemberName="System.ComponentModel.ISupportInitializeNotification.Initialized">

‎xml/System.Windows.Forms/CheckedListBox+CheckedIndexCollection.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -421,7 +421,7 @@
421421
<Docs>
422422
<param name="value">The object to be added to the <see cref="T:System.Windows.Forms.CheckedListBox.CheckedIndexCollection" />.</param>
423423
<summary>Adds an item to the <see cref="T:System.Windows.Forms.CheckedListBox.CheckedIndexCollection" />. For a description of this member, see <see cref="M:System.Collections.IList.Add(System.Object)" />.</summary>
424-
<returns>To be added.</returns>
424+
<returns>The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection.</returns>
425425
<remarks>
426426
<format type="text/markdown"><![CDATA[
427427

‎xml/System.Windows.Forms/DrawItemEventArgs.xml‎

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@
239239
</ReturnValue>
240240
<Parameters />
241241
<Docs>
242-
<summary>To be added.</summary>
242+
<summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
243243
<remarks>To be added.</remarks>
244244
</Docs>
245245
</Member>
@@ -597,9 +597,17 @@
597597
</ReturnValue>
598598
<Parameters />
599599
<Docs>
600-
<summary>To be added.</summary>
601-
<returns>To be added.</returns>
602-
<remarks>To be added.</remarks>
600+
<summary>Returns the handle to a Windows device context.</summary>
601+
<returns>An <see cref="T:System.IntPtr" /> representing the handle of a device context.</returns>
602+
<remarks>
603+
<format type="text/markdown"><![CDATA[
604+
605+
## Remarks
606+
607+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.DrawItemEventArgs> instance is cast to an <xref:System.Drawing.IDeviceContext> interface.
608+
609+
]]></format>
610+
</remarks>
603611
</Docs>
604612
</Member>
605613
<Member MemberName="System.Drawing.IDeviceContext.ReleaseHdc">
@@ -622,8 +630,16 @@
622630
</ReturnValue>
623631
<Parameters />
624632
<Docs>
625-
<summary>To be added.</summary>
626-
<remarks>To be added.</remarks>
633+
<summary>Releases the handle of a Windows device context.</summary>
634+
<remarks>
635+
<format type="text/markdown"><![CDATA[
636+
637+
## Remarks
638+
639+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.DrawItemEventArgs> instance is cast to an <xref:System.Drawing.IDeviceContext> interface.
640+
641+
]]></format>
642+
</remarks>
627643
</Docs>
628644
</Member>
629645
</Members>

‎xml/System.Windows.Forms/ErrorProvider.xml‎

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1106,7 +1106,15 @@
11061106
<Parameters />
11071107
<Docs>
11081108
<summary>Signals the object that initialization is starting.</summary>
1109-
<remarks>To be added.</remarks>
1109+
<remarks>
1110+
<format type="text/markdown"><![CDATA[
1111+
1112+
## Remarks
1113+
1114+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.ErrorProvider> instance is cast to an <xref:System.ComponentModel.ISupportInitialize> interface.
1115+
1116+
]]></format>
1117+
</remarks>
11101118
</Docs>
11111119
</Member>
11121120
<Member MemberName="System.ComponentModel.ISupportInitialize.EndInit">
@@ -1132,7 +1140,15 @@
11321140
<Parameters />
11331141
<Docs>
11341142
<summary>Signals the object that initialization is complete.</summary>
1135-
<remarks>To be added.</remarks>
1143+
<remarks>
1144+
<format type="text/markdown"><![CDATA[
1145+
1146+
## Remarks
1147+
1148+
This member is an explicit interface member implementation. It can be used only when the <xref:System.Windows.Forms.ErrorProvider> instance is cast to an <xref:System.ComponentModel.ISupportInitialize> interface.
1149+
1150+
]]></format>
1151+
</remarks>
11361152
</Docs>
11371153
</Member>
11381154
<Member MemberName="Tag">

0 commit comments

Comments
 (0)