Skip to content

Commit 9ed6ee3

Browse files
carlossanlopcarlossanlop
authored
System.ComponentModel (#10214)
1 parent ccf3f88 commit 9ed6ee3

File tree

6 files changed

+77
-32
lines changed

6 files changed

+77
-32
lines changed

‎xml/System.ComponentModel/ComponentResourceManager.xml

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,13 @@
352352
<param name="value">To be added.</param>
353353
<param name="objectName">To be added.</param>
354354
<param name="culture">To be added.</param>
355-
<summary>To be added.</summary>
355+
<summary>
356+
<para>Examines all the resources for the provided culture.</para>
357+
<para>When it finds a resource with a key in the format of</para>
358+
<para>"[objectName].[property name]" or "[objectName]-[property name]" it will apply that resource's value</para>
359+
<para>to the corresponding property on the object. If there is no matching</para>
360+
<para>property the resource will be ignored.</para>
361+
</summary>
356362
<remarks>To be added.</remarks>
357363
</Docs>
358364
</Member>

‎xml/System.ComponentModel/CustomTypeDescriptor.xml

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,10 @@
486486
</ReturnValue>
487487
<Parameters />
488488
<Docs>
489-
<summary>To be added.</summary>
489+
<summary>
490+
<para>Returns a type converter for the type this type</para>
491+
<para>descriptor is representing.</para>
492+
</summary>
490493
<returns>To be added.</returns>
491494
<remarks>To be added.</remarks>
492495
</Docs>
@@ -874,7 +877,10 @@
874877
</ReturnValue>
875878
<Parameters />
876879
<Docs>
877-
<summary>To be added.</summary>
880+
<summary>
881+
<para>Returns a collection of event descriptors</para>
882+
<para>for the object this type descriptor is representing.</para>
883+
</summary>
878884
<returns>To be added.</returns>
879885
<remarks>To be added.</remarks>
880886
</Docs>
@@ -1068,7 +1074,10 @@
10681074
</ReturnValue>
10691075
<Parameters />
10701076
<Docs>
1071-
<summary>To be added.</summary>
1077+
<summary>
1078+
<para>Returns a collection of property descriptors</para>
1079+
<para>for the object this type descriptor is representing.</para>
1080+
</summary>
10721081
<returns>To be added.</returns>
10731082
<remarks>To be added.</remarks>
10741083
</Docs>
@@ -1161,9 +1170,20 @@
11611170
<ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
11621171
</ReturnValue>
11631172
<Docs>
1164-
<summary>To be added.</summary>
1173+
<summary>Gets a value that indicates whether types are required to be registered through <see cref="M:System.ComponentModel.TypeDescriptionProvider.RegisterType``1" />.</summary>
11651174
<value>To be added.</value>
1166-
<remarks>To be added.</remarks>
1175+
<remarks>
1176+
<para>The default value is <see langword="null" /> which means that the type descriptor has not declared whether or not it is compatible registered types.</para>
1177+
<para>A type descriptor needs to implement this to return <see langword="true" /> or <see langword="false" /> if the feature switch</para>
1178+
<para>'System.ComponentModel.TypeDescriptor.RequireRegisteredTypes' is enabled.</para>
1179+
<para>If <see langword="true" /> is returned, then the type descriptor must also implement</para>
1180+
<para>
1181+
<see cref="M:System.ComponentModel.ICustomTypeDescriptor.GetConverterFromRegisteredType" />,</para>
1182+
<para>
1183+
<see cref="M:System.ComponentModel.ICustomTypeDescriptor.GetEventsFromRegisteredType" />, and</para>
1184+
<para>
1185+
<see cref="M:System.ComponentModel.ICustomTypeDescriptor.GetPropertiesFromRegisteredType" />.</para>
1186+
</remarks>
11671187
</Docs>
11681188
</Member>
11691189
</Members>

‎xml/System.ComponentModel/ICustomTypeDescriptor.xml

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,7 @@
332332
</ReturnValue>
333333
<Parameters />
334334
<Docs>
335-
<summary>To be added.</summary>
335+
<summary>Gets a type converter for this object that may be registered.</summary>
336336
<returns>To be added.</returns>
337337
<remarks>To be added.</remarks>
338338
</Docs>
@@ -678,7 +678,7 @@
678678
</ReturnValue>
679679
<Parameters />
680680
<Docs>
681-
<summary>To be added.</summary>
681+
<summary>Gets the events for this instance of a component that may be registered.</summary>
682682
<returns>To be added.</returns>
683683
<remarks>To be added.</remarks>
684684
</Docs>
@@ -856,7 +856,7 @@
856856
</ReturnValue>
857857
<Parameters />
858858
<Docs>
859-
<summary>To be added.</summary>
859+
<summary>Gets the properties for this instance of a component that may be registered.</summary>
860860
<returns>To be added.</returns>
861861
<remarks>To be added.</remarks>
862862
</Docs>
@@ -952,9 +952,23 @@ pd.GetValue(GetPropertyOwner(myPd));
952952
<ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
953953
</ReturnValue>
954954
<Docs>
955-
<summary>To be added.</summary>
955+
<summary>Gets a value that indicates whether types are required to be registered through <see cref="M:System.ComponentModel.TypeDescriptionProvider.RegisterType``1" />.</summary>
956956
<value>To be added.</value>
957-
<remarks>To be added.</remarks>
957+
<remarks>
958+
<para>The default value is <see langword="null" /> which means that the type descriptor has not declared whether or not it is compatible registered types.</para>
959+
<para>A type descriptor needs to implement this to return either <see langword="true" /> or <see langword="false" /> if the feature switch</para>
960+
<para>'System.ComponentModel.TypeDescriptor.RequireRegisteredTypes' is enabled.</para>
961+
<para>If <see langword="true" /> is returned, then the type descriptor must also implement</para>
962+
<para>
963+
<see cref="M:System.ComponentModel.ICustomTypeDescriptor.GetConverterFromRegisteredType" />,</para>
964+
<para>
965+
<see cref="M:System.ComponentModel.ICustomTypeDescriptor.GetEventsFromRegisteredType" />, and</para>
966+
<para>
967+
<see cref="M:System.ComponentModel.ICustomTypeDescriptor.GetPropertiesFromRegisteredType" />.</para>
968+
<para>
969+
<br />
970+
</para>
971+
</remarks>
958972
</Docs>
959973
</Member>
960974
</Members>

‎xml/System.ComponentModel/PropertyDescriptor.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@
524524
<ReturnType>System.ComponentModel.TypeConverter</ReturnType>
525525
</ReturnValue>
526526
<Docs>
527-
<summary>To be added.</summary>
527+
<summary>Gets the type converter for this property.</summary>
528528
<value>To be added.</value>
529529
<remarks>To be added.</remarks>
530530
</Docs>

‎xml/System.ComponentModel/TypeDescriptionProvider.xml

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -438,9 +438,9 @@
438438
</Parameters>
439439
<Docs>
440440
<param name="instance">To be added.</param>
441-
<summary>To be added.</summary>
441+
<summary>Returns an extended custom type descriptor for the given object.</summary>
442442
<returns>To be added.</returns>
443-
<remarks>To be added.</remarks>
443+
<remarks>An extended type descriptor is a custom type descriptor that offers properties that other objects have added to this object, but are not actually defined on the object. For example, in the .NET Framework Component Model, objects that implement the interface IExtenderProvider can "attach" properties to other objects that reside in the same logical container. The GetTypeDescriptor method does not return a type descriptor that provides these extra extended properties. GetExtendedTypeDescriptor returns the set of these extended properties. TypeDescriptor will automatically merge the results of these two property collections. Note that while the .NET Framework component model only supports extended properties this API can be used for extended attributes and events as well, if the type description provider supports it.</remarks>
444444
</Docs>
445445
</Member>
446446
<Member MemberName="GetExtenderProviders">
@@ -1036,9 +1036,9 @@
10361036
</Parameters>
10371037
<Docs>
10381038
<param name="instance">To be added.</param>
1039-
<summary>To be added.</summary>
1039+
<summary>Returns a custom type descriptor for the given type or object.</summary>
10401040
<returns>To be added.</returns>
1041-
<remarks>To be added.</remarks>
1041+
<remarks>The objectType parameter is always valid, but the instance parameter may be <see langword="null" /> if no instance was passed to TypeDescriptor. The method should return a custom type descriptor for the object. If the method is not interested in providing type information for the object it should return base.</remarks>
10421042
</Docs>
10431043
</Member>
10441044
<Member MemberName="GetTypeDescriptorFromRegisteredType">
@@ -1073,9 +1073,9 @@
10731073
</Parameters>
10741074
<Docs>
10751075
<param name="objectType">To be added.</param>
1076-
<summary>To be added.</summary>
1076+
<summary>Returns a custom type descriptor for the given type or object.</summary>
10771077
<returns>To be added.</returns>
1078-
<remarks>To be added.</remarks>
1078+
<remarks>The objectType parameter is always valid, but the instance parameter may be <see langword="null" /> if no instance was passed to TypeDescriptor. The method should return a custom type descriptor for the object. If the method is not interested in providing type information for the object it should return base.</remarks>
10791079
</Docs>
10801080
</Member>
10811081
<Member MemberName="GetTypeDescriptorFromRegisteredType">
@@ -1119,9 +1119,12 @@
11191119
<Docs>
11201120
<param name="objectType">To be added.</param>
11211121
<param name="instance">To be added.</param>
1122-
<summary>To be added.</summary>
1122+
<summary>Returns a custom type descriptor for the given type or object.</summary>
11231123
<returns>To be added.</returns>
1124-
<remarks>To be added.</remarks>
1124+
<remarks>
1125+
<para>The objectType parameter is always valid, but the instance parameter may be <see langword="null" /> if no instance was passed to TypeDescriptor. The method should return a custom type descriptor for the object. If the method is not interested in providing type information for the object it should return base.</para>
1126+
<para>This method is prototyped as virtual, and by default returns a custom type descriptor that returns empty collections for all values if no parent provider was passed. If a parent provider was passed, this method will invoke the parent provider's GetTypeDescriptorFromRegisteredType method.</para>
1127+
</remarks>
11251128
</Docs>
11261129
</Member>
11271130
<Member MemberName="IsRegisteredType">
@@ -1150,9 +1153,11 @@
11501153
</Parameters>
11511154
<Docs>
11521155
<param name="type">To be added.</param>
1153-
<summary>To be added.</summary>
1156+
<summary>Determines whether the type was registered with its provider through <see cref="M:System.ComponentModel.TypeDescriptor.RegisterType``1" />.</summary>
11541157
<returns>To be added.</returns>
11551158
<remarks>To be added.</remarks>
1159+
<exception cref="T:System.ArgumentNullException">
1160+
<paramref name="type" /> is <see langword="null" />.</exception>
11561161
</Docs>
11571162
</Member>
11581163
<Member MemberName="IsSupportedType">
@@ -1240,8 +1245,8 @@
12401245
</TypeParameters>
12411246
<Parameters />
12421247
<Docs>
1243-
<typeparam name="T">To be added.</typeparam>
1244-
<summary>To be added.</summary>
1248+
<typeparam name="T">The type to register.</typeparam>
1249+
<summary>Registers the type so it can be used by reflection-based providers in trimmed applications.</summary>
12451250
<remarks>To be added.</remarks>
12461251
</Docs>
12471252
</Member>
@@ -1267,9 +1272,9 @@
12671272
<ReturnType>System.Nullable&lt;System.Boolean&gt;</ReturnType>
12681273
</ReturnValue>
12691274
<Docs>
1270-
<summary>To be added.</summary>
1275+
<summary>Gets a value that indicates whether the provider uses reflection and requires types to be registered through <see cref="M:System.ComponentModel.TypeDescriptor.RegisterType``1" /> to support trimmed applications.</summary>
12711276
<value>To be added.</value>
1272-
<remarks>To be added.</remarks>
1277+
<remarks>For backwards compatibility, this is typically only enforced when calling members that have "FromRegisteredType" suffix.</remarks>
12731278
</Docs>
12741279
</Member>
12751280
</Members>

‎xml/System.ComponentModel/TypeDescriptor.xml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2222,7 +2222,7 @@
22222222
</Parameters>
22232223
<Docs>
22242224
<param name="component">To be added.</param>
2225-
<summary>To be added.</summary>
2225+
<summary>Gets a type converter for the type of the specified component.</summary>
22262226
<returns>To be added.</returns>
22272227
<remarks>To be added.</remarks>
22282228
</Docs>
@@ -2253,7 +2253,7 @@
22532253
</Parameters>
22542254
<Docs>
22552255
<param name="type">To be added.</param>
2256-
<summary>To be added.</summary>
2256+
<summary>Gets a type converter for the specified registered type.</summary>
22572257
<returns>To be added.</returns>
22582258
<remarks>To be added.</remarks>
22592259
</Docs>
@@ -3511,7 +3511,7 @@
35113511
</Parameters>
35123512
<Docs>
35133513
<param name="componentType">To be added.</param>
3514-
<summary>To be added.</summary>
3514+
<summary>Gets a collection of events for a specified type of component.</summary>
35153515
<returns>To be added.</returns>
35163516
<remarks>To be added.</remarks>
35173517
</Docs>
@@ -4164,7 +4164,7 @@
41644164
</Parameters>
41654165
<Docs>
41664166
<param name="component">To be added.</param>
4167-
<summary>To be added.</summary>
4167+
<summary>Gets a collection of properties for a specified component.</summary>
41684168
<returns>To be added.</returns>
41694169
<remarks>To be added.</remarks>
41704170
</Docs>
@@ -4195,7 +4195,7 @@
41954195
</Parameters>
41964196
<Docs>
41974197
<param name="componentType">To be added.</param>
4198-
<summary>To be added.</summary>
4198+
<summary>Gets a collection of properties for a specified type.</summary>
41994199
<returns>To be added.</returns>
42004200
<remarks>To be added.</remarks>
42014201
</Docs>
@@ -4906,8 +4906,8 @@
49064906
</TypeParameters>
49074907
<Parameters />
49084908
<Docs>
4909-
<typeparam name="T">To be added.</typeparam>
4910-
<summary>To be added.</summary>
4909+
<typeparam name="T">The type to register.</typeparam>
4910+
<summary>Registers the type so it can be used by reflection-based providers in trimmed applications.</summary>
49114911
<remarks>To be added.</remarks>
49124912
</Docs>
49134913
</Member>

0 commit comments

Comments
 (0)