From 957eb3188197cc47cc2f1a4cca8a6c1aa1b90422 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 25 Jul 2025 11:38:14 -0700 Subject: [PATCH 1/4] CI Update - clean up invalid XML doc files (#11607) --- .../FromKeyedServicesAttribute.xml | 2 +- .../VectorStore.xml | 2 +- xml/System.Formats.Asn1/AsnDecoder.xml | 28 +- xml/System.Formats.Asn1/AsnReader.xml | 36 +- xml/System.Formats.Asn1/AsnWriter.xml | 12 +- xml/System.Numerics/Vector2.xml | 2 +- xml/System.Reflection/TypeExtensions.xml | 526 +++++++++++------- 7 files changed, 376 insertions(+), 232 deletions(-) diff --git a/xml/Microsoft.Extensions.DependencyInjection/FromKeyedServicesAttribute.xml b/xml/Microsoft.Extensions.DependencyInjection/FromKeyedServicesAttribute.xml index 0b028e53cc8..c54621fd02e 100644 --- a/xml/Microsoft.Extensions.DependencyInjection/FromKeyedServicesAttribute.xml +++ b/xml/Microsoft.Extensions.DependencyInjection/FromKeyedServicesAttribute.xml @@ -30,8 +30,8 @@ Indicates that the parameter should be bound using the keyed service registered with the specified key. To be added. - + diff --git a/xml/Microsoft.Extensions.VectorData/VectorStore.xml b/xml/Microsoft.Extensions.VectorData/VectorStore.xml index 9b8f144dd5c..44555f500a2 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStore.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStore.xml @@ -215,9 +215,9 @@ To successfully request a collection, either must be annotated with attributes that define the schema of the record type, or must be provided. - + diff --git a/xml/System.Formats.Asn1/AsnDecoder.xml b/xml/System.Formats.Asn1/AsnDecoder.xml index c7b5c7a8121..cd8fbcb6619 100644 --- a/xml/System.Formats.Asn1/AsnDecoder.xml +++ b/xml/System.Formats.Asn1/AsnDecoder.xml @@ -133,7 +133,7 @@ value will be copied into the return value as unset bits, irrespective of their value in the encoded representation. - + is not defined. @@ -154,7 +154,7 @@ . is not correct for the method. - + @@ -276,8 +276,8 @@ The decoded value. To be added. + - is not defined. @@ -306,7 +306,7 @@ . is not the same as . - + @@ -1308,7 +1308,7 @@ An array containing the contents of the Octet String value. To be added. - + is not defined. @@ -1329,7 +1329,7 @@ . is not correct for the method. - + @@ -1681,7 +1681,7 @@ value will be copied into as unset bits, irrespective of their value in the encoded representation. - + is not defined. @@ -1706,7 +1706,7 @@ overlaps . - + @@ -1766,7 +1766,7 @@ and the reader does not advance. To be added. - + is not defined. @@ -1795,7 +1795,7 @@ . is not the same as . - + @@ -1851,8 +1851,8 @@ This method does not determine if the string used only characters defined by the encoding. + - is not defined. @@ -1877,7 +1877,7 @@ overlaps . - + @@ -2150,7 +2150,7 @@ otherwise, . To be added. - + is not defined. @@ -2175,7 +2175,7 @@ overlaps . - + diff --git a/xml/System.Formats.Asn1/AsnReader.xml b/xml/System.Formats.Asn1/AsnReader.xml index d3d4573991a..2a2c58792e1 100644 --- a/xml/System.Formats.Asn1/AsnReader.xml +++ b/xml/System.Formats.Asn1/AsnReader.xml @@ -192,12 +192,12 @@ The bytes of the next encoded value. To be added. - + The reader is positioned at a point where the tag or length is invalid under the current encoding rules. - + @@ -273,7 +273,7 @@ A copy of the value in a newly allocated, precisely sized, array. To be added. - + The next value does not have the correct tag. @@ -291,7 +291,7 @@ . is not correct for the method. - + @@ -385,8 +385,8 @@ The decoded value. To be added. + - is not a known character string type. @@ -411,7 +411,7 @@ . is not the same as . - + @@ -1183,7 +1183,7 @@ A copy of the value in a newly allocated, precisely sized, array. To be added. - + The next value does not have the correct tag. @@ -1201,7 +1201,7 @@ . is not correct for the method. - + @@ -1478,7 +1478,7 @@ The decoded value. To be added. - + The next value does not have the correct tag. @@ -1496,7 +1496,7 @@ . is not correct for the method. - + @@ -1608,7 +1608,7 @@ and the reader does not advance. To be added. - + The next value does not have the correct tag. @@ -1626,7 +1626,7 @@ . is not correct for the method. - + @@ -1676,8 +1676,8 @@ and the reader does not advance. To be added. + - is not a known character string type. @@ -1702,7 +1702,7 @@ . is not the same as . - + @@ -1748,8 +1748,8 @@ This method does not determine if the string used only characters defined by the encoding. + - The next value does not have the correct tag. @@ -1767,7 +1767,7 @@ . is not a character string tag type. - + @@ -1930,7 +1930,7 @@ and the reader does not advance. To be added. - + The next value does not have the correct tag. @@ -1948,7 +1948,7 @@ . is not correct for the method. - + diff --git a/xml/System.Formats.Asn1/AsnWriter.xml b/xml/System.Formats.Asn1/AsnWriter.xml index 0b27546539e..a14aa74875d 100644 --- a/xml/System.Formats.Asn1/AsnWriter.xml +++ b/xml/System.Formats.Asn1/AsnWriter.xml @@ -1170,7 +1170,7 @@ tag UNIVERSAL 10. To be added. - + is . @@ -1188,7 +1188,7 @@ the unboxed type of is declared []. - + @@ -1847,14 +1847,14 @@ accepting the two-digit year as valid in context. To be added. - + . is , but . is not correct for the method. - + @@ -1893,7 +1893,7 @@ provided the year is in the allowed range. To be added. - + . is , but @@ -1905,7 +1905,7 @@ is not in the range ( - 100, ]. - + diff --git a/xml/System.Numerics/Vector2.xml b/xml/System.Numerics/Vector2.xml index 98b68d8fce4..f0d0f6a771d 100644 --- a/xml/System.Numerics/Vector2.xml +++ b/xml/System.Numerics/Vector2.xml @@ -5710,7 +5710,7 @@ The behavior of this method changed in .NET 5. For more information, see [Behavi - + diff --git a/xml/System.Reflection/TypeExtensions.xml b/xml/System.Reflection/TypeExtensions.xml index 2abfb772fcd..3892ba9527c 100644 --- a/xml/System.Reflection/TypeExtensions.xml +++ b/xml/System.Reflection/TypeExtensions.xml @@ -186,23 +186,45 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + 10.0.0.0 + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + - System.Reflection.EventInfo + System.Reflection.EventInfo - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents)>] + + + + To be added. @@ -505,58 +527,64 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.0.0.0 - 4.1.0.0 - 4.1.2.0 - 5.0.0.0 - 6.0.0.0 - 7.0.0.0 - 8.0.0.0 - 9.0.0.0 - 10.0.0.0 + 4.1.5.0 - - - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] - [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] - - - System.Type[] + System.Type[] - - - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces)>] - - - + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Reflection.TypeExtensions + 4.1.5.0 + + + System.Reflection.MemberInfo[] + + + + To be added. + To be added. To be added. To be added. To be added. - - - - - - + + + + + + Method System.Reflection.TypeExtensions @@ -582,41 +610,18 @@ - - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)>] - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Reflection.TypeExtensions - 4.1.5.0 - - - System.Reflection.MemberInfo[] - - - - - + To be added. @@ -674,23 +679,48 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + 10.0.0.0 + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + - System.Reflection.MemberInfo[] + System.Reflection.MemberInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All)>] + + + + To be added. @@ -830,22 +860,43 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + 10.0.0.0 + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + - System.Reflection.MethodInfo[] + System.Reflection.MethodInfo[] - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] + + + To be added. @@ -855,23 +906,44 @@ - - - - - - + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + 10.0.0.0 + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + - System.Reflection.MethodInfo[] + System.Reflection.MethodInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] + + + + To be added. @@ -882,24 +954,46 @@ - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + 10.0.0.0 + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + - System.Type + System.Type - - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)>] + + + + + To be added. @@ -911,39 +1005,12 @@ - - - - - - - Method - - System.Reflection.TypeExtensions - 4.1.5.0 - - - System.Type[] - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - + + + + + + Method System.Reflection.TypeExtensions @@ -964,32 +1031,34 @@ - System.Reflection.PropertyInfo[] + System.Type[] - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes)>] + To be added. + To be added. To be added. To be added. To be added. - - - - - - + + + + + + Method System.Reflection.TypeExtensions @@ -1000,51 +1069,70 @@ - To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Reflection.TypeExtensions - 4.1.5.0 + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + 10.0.0.0 + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + - System.Reflection.PropertyInfo + System.Reflection.PropertyInfo[] - - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + + To be added. - To be added. + To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Reflection.TypeExtensions @@ -1071,30 +1159,28 @@ - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties | System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] - To be added. To be added. - To be added. To be added. To be added. To be added. - - - - - - + + + + + + Method System.Reflection.TypeExtensions @@ -1106,7 +1192,65 @@ - + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + + Method + + System.Reflection.TypeExtensions + 4.0.0.0 + 4.1.0.0 + 4.1.2.0 + 5.0.0.0 + 6.0.0.0 + 7.0.0.0 + 8.0.0.0 + 9.0.0.0 + 10.0.0.0 + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + + System.Reflection.PropertyInfo + + + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties)>] + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + To be added. From 097a5676d40ec9225d0e9cad972c6684beb52d36 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 25 Jul 2025 11:38:51 -0700 Subject: [PATCH 2/4] remove invalid authors (#11591) --- docfx.json | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/docfx.json b/docfx.json index 269725313ef..b96fdedd3c7 100644 --- a/docfx.json +++ b/docfx.json @@ -44,7 +44,7 @@ "recommendations": true, "author": "dotnet-bot", "ms.author": "dotnetcontent", - "ms.date": "05/16/2023", + "ms.date": "07/01/2025", "searchScope": [".NET"], "show_latex": true, "uhfHeaderId": "MSDocsHeader-DotNet", @@ -73,15 +73,11 @@ "fileMetadata": { "author": { "api/System.Net**.yml": "karelz", - "api/System.Web**.yml": "Rick-Anderson", - "api/Microsoft.VisualBasic**.yml": "KathleenDollard" + "api/Microsoft.VisualBasic**.yml": "BillWagner" }, "ms.author": { "api/System.Net**.yml": "ncldev", - "api/Microsoft.VisualBasic**.yml": "kdollard" - }, - "ms.custom": { - "api/System.String.Split.yml": "contperf-fy21q2" + "api/Microsoft.VisualBasic**.yml": "wiwagn" }, "ms.subservice": { "api/Accessibility**.yml": "accessibility", From 6144224d1cb3e6e7febf3948170d0f35146c0f45 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 25 Jul 2025 11:39:18 -0700 Subject: [PATCH 3/4] remove broken links (#11593) --- .../TaskCompletionSource`1.xml | 6 +- xml/System.Web.DynamicData/DynamicFilter.xml | 64 +++---- .../DynamicHyperLink.xml | 24 +-- .../DynamicRouteExpression.xml | 12 +- .../QueryableFilterRepeater.xml | 57 +++--- .../QueryableFilterUserControl.xml | 167 +++++++++--------- xml/System.Web.UI.WebControls/Button.xml | 3 - .../CheckBoxList.xml | 19 +- .../DropDownList.xml | 13 +- xml/System.Web.UI.WebControls/FileUpload.xml | 25 +-- xml/System.Web.UI.WebControls/ImageButton.xml | 3 - xml/System.Web.UI.WebControls/LinkButton.xml | 13 +- xml/System.Web.UI.WebControls/ListView.xml | 37 ++-- xml/System.Web.UI.WebControls/Menu.xml | 3 - xml/System.Web.UI.WebControls/Repeater.xml | 3 - .../RouteParameter.xml | 40 +---- xml/System.Web.UI.WebControls/TextBox.xml | 63 +++---- xml/System.Web.UI/Page.xml | 3 - xml/System.Web/HttpRequest.xml | 18 +- xml/System.Web/HttpServerUtility.xml | 3 - .../AdornedElementPlaceholder.xml | 72 ++++---- .../ExceptionValidationRule.xml | 42 +++-- xml/System.Windows.Controls/GroupStyle.xml | 2 - xml/System.Windows.Controls/WebBrowser.xml | 1 - xml/System.Windows.Data/Binding.xml | 2 - .../BindingListCollectionView.xml | 4 - .../CollectionViewSource.xml | 4 - xml/System.Windows.Data/FilterEventArgs.xml | 72 ++++---- .../FilterEventHandler.xml | 24 ++- .../ListCollectionView.xml | 4 - .../PropertyGroupDescription.xml | 88 +++++---- xml/System.Windows/DataTemplate.xml | 8 +- xml/System.Windows/DataTrigger.xml | 17 +- 33 files changed, 365 insertions(+), 551 deletions(-) diff --git a/xml/System.Threading.Tasks/TaskCompletionSource`1.xml b/xml/System.Threading.Tasks/TaskCompletionSource`1.xml index 1ff755c964c..a90b0a080b7 100644 --- a/xml/System.Threading.Tasks/TaskCompletionSource`1.xml +++ b/xml/System.Threading.Tasks/TaskCompletionSource`1.xml @@ -74,13 +74,11 @@ to represent an external asynchronous operation. is provided for this purpose. It enables the creation of a task that can be handed out to consumers. The consumers can use the members of the task the same way as they would in any other scenario handling task member variables. However, unlike most tasks, the state of a task created by a TaskCompletionSource is controlled explicitly by the methods on TaskCompletionSource. This enables the completion of the external asynchronous operation to be propagated to the underlying Task. The separation also ensures that consumers are not able to transition the state without access to the corresponding TaskCompletionSource. For more information, see the entry [The Nature of TaskCompletionSource\](https://devblogs.microsoft.com/pfxteam/the-nature-of-taskcompletionsourcetresult/) in the Parallel Programming with .NET blog. - - The [Parallel Extensions samples](https://go.microsoft.com/fwlink/?LinkID=165717) also contain examples of how to use . - + In many scenarios, it's useful to enable a to represent an external asynchronous operation. is provided for this purpose. It enables the creation of a task that can be handed out to consumers. The consumers can use the members of the task the same way as they would in any other scenario handling task member variables. However, unlike most tasks, the state of a task created by a TaskCompletionSource is controlled explicitly by the methods on TaskCompletionSource. This enables the completion of the external asynchronous operation to be propagated to the underlying Task. The separation also ensures that consumers are not able to transition the state without access to the corresponding TaskCompletionSource. For more information, see the entry [The Nature of TaskCompletionSource\](https://devblogs.microsoft.com/pfxteam/the-nature-of-taskcompletionsourcetresult/) in the Parallel Programming with .NET blog. ## Examples + The following example shows how to use a : :::code language="csharp" source="~/snippets/csharp/System.Threading.Tasks/TaskCompletionSourceTResult/Overview/taskcompletionsource.cs" id="Snippet01"::: diff --git a/xml/System.Web.DynamicData/DynamicFilter.xml b/xml/System.Web.DynamicData/DynamicFilter.xml index eac77d7442f..88641a11ae7 100644 --- a/xml/System.Web.DynamicData/DynamicFilter.xml +++ b/xml/System.Web.DynamicData/DynamicFilter.xml @@ -28,13 +28,11 @@ ## Introduction @@ -51,7 +49,6 @@ You can specify the filter template to use in the following ways: - By using the property in page markup. This approach is a presentation-layer customization, which is independent of the schema (database), and which applies to a single page. - - By using the attribute in the model. This approach is a data-layer customization, which depends on the specific schema (database), and which applies to the entire application. If you use both approaches, the filter template that is specified in the markup takes precedence over the template that is specified in the data model. @@ -62,46 +59,37 @@ The following figure shows the steps that Dynamic Data follows in order to implement table row filtering by a foreign-key column. - ![Dynamic Data Query Elements](~/add/media/dynamic-dataquery.png "Dynamic Data Query Elements") - -1. The control passes the selected value to the control. - -2. The control uses the value to create the query filtering information. It then passes this information to the data source control. - -3. The data source control passes the filtering query information to the data source provider. + ![Dynamic Data Query Elements](~/add/media/dynamic-dataquery.png) -4. The data source provider passes the query to the database. - -5. The database returns the filtered table rows. - -6. The data source provider sends this data back to the data source control. - -7. The data source control passes the filtered table rows to the data-bound control for display. +1. The control passes the selected value to the control. +2. The control uses the value to create the query filtering information. It then passes this information to the data source control. +3. The data source control passes the filtering query information to the data source provider. +4. The data source provider passes the query to the database. +5. The database returns the filtered table rows. +6. The data source provider sends this data back to the data source control. +7. The data source control passes the filtered table rows to the data-bound control for display. ## Declarative Syntax -``` +```xml + ID="Control ID" + DataField="Name of the data field to use for filtering" + EnableViewState="True|False" + FilterUIHint="Name of the filter template to generate the UI" + OnFilterChanged="Filter changed event handler" + OnDataBinding="DataBinding event handler" + OnDisposed="Disposed event handler" + OnInit="Init event handler" + OnLoad="Load event handler" + OnPreRender="PreRender event handler" + OnUnload="Unload event handler" + Visible="True|False" + runat="server"/> ``` - - ## Examples - A Visual Studio project with source code is available at this location: [Download](https://go.microsoft.com/fwlink/?LinkId=168914). The following examples use the default ForeignKey.ascx filter template to create the UI for filtering the Products table rows by the ProductCategory foreign-key column. When the user selects a ProductCategory value, only the rows that contain that value are displayed. diff --git a/xml/System.Web.DynamicData/DynamicHyperLink.xml b/xml/System.Web.DynamicData/DynamicHyperLink.xml index 25ea9f41b35..1fd8844aa3c 100644 --- a/xml/System.Web.DynamicData/DynamicHyperLink.xml +++ b/xml/System.Web.DynamicData/DynamicHyperLink.xml @@ -33,10 +33,9 @@ @@ -46,9 +45,7 @@ The control enables you to create the following links: - Table row data-bound links, which are for data-item specific action links such as "Edit" and "Details". Dynamic Data infers the table and the primary key from the current row. An example of these links is in the Edit.aspx page of a Dynamic Data Web site. - - Links to objects, which are specific action links such as "List" and "Insert" that in turn point to objects such as tables. An example of these links is in the Default.aspx page of a Dynamic Data Web site. - - Unbound links, which create table action links outside a data-bound control. An example of these links is in the Insert link in the List.aspx page template of a Dynamic Data Web site. Because these links are not part of a data-bound control that has a defined data context, you must specify the table to access and the action to perform. If you specify "Edit" or "Details" as the action, you must also provide the primary key. The control supports additional markup attributes then can be forwarded to the routing engine when the link is activated. This can be useful when you want to have an item-specific link from a non-data-bound context. @@ -56,21 +53,18 @@ ## Declarative Syntax -``` +```xml + ID="string" + Action="Details|Edit|Insert|List" + ContextTypeName="string" + DataField="string" + TableName="string" + OnDataBinding="DataBinding event handler" + OnPreRender="PreRender event handler"/> ``` - - ## Examples - A Visual Studio project with source code is available to accompany this topic: [Scaffolding Dynamic Data](https://go.microsoft.com/fwlink/?LinkId=168914). The following examples show how to create controls for data rows, for a collection, and to perform the specified action. diff --git a/xml/System.Web.DynamicData/DynamicRouteExpression.xml b/xml/System.Web.DynamicData/DynamicRouteExpression.xml index b16cf4c8ab8..6d72042de8b 100644 --- a/xml/System.Web.DynamicData/DynamicRouteExpression.xml +++ b/xml/System.Web.DynamicData/DynamicRouteExpression.xml @@ -26,15 +26,12 @@ ## Declarative Syntax -``` +```xml + ColumnName="Name of the foreign key column"/> ``` - - ## Examples - A Visual Studio project with source code is available to accompany this topic: [Scaffolding Dynamic Data](https://go.microsoft.com/fwlink/?LinkId=168914). The following example shows a custom List.aspx page template for the Products table. It uses the property to specify the ProductCategory foreign key for filtering the Products rows. @@ -42,9 +39,8 @@ The example requires the following: -- A Dynamic Data Web site. For more information, see [Walkthrough: Creating a New Dynamic Data Web Site Using Scaffolding](https://msdn.microsoft.com/library/1564aef2-9103-436a-9806-c8ad7abd616a). - -- The AdventureWorksLT sample database. For more information, see [How to: Connect to the AdventureWorksLT Database using an .MDF File](https://msdn.microsoft.com/library/d34ffbac-607d-40f1-b088-0a3304ea032b). +- A Dynamic Data Web site. For more information, see [Walkthrough: Creating a New Dynamic Data Web Site Using Scaffolding](https://learn.microsoft.com/previous-versions/cc488469(v=vs.140)). +- The AdventureWorksLT sample database. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/system.web.dynamicdata.dynamicrouteexpression/cs/list.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/system.web.dynamicdata.dynamicrouteexpression/vb/list.aspx" id="Snippet1"::: diff --git a/xml/System.Web.DynamicData/QueryableFilterRepeater.xml b/xml/System.Web.DynamicData/QueryableFilterRepeater.xml index cf304bab44d..35e62fdb130 100644 --- a/xml/System.Web.DynamicData/QueryableFilterRepeater.xml +++ b/xml/System.Web.DynamicData/QueryableFilterRepeater.xml @@ -38,12 +38,10 @@ @@ -65,50 +63,39 @@ The following figure shows the steps that Dynamic Data follows in order to implement automatic table row filtering. - ![Dynamic Data Table Row Filtering Elements](~/add/media/dynamic-autofilter.png "Dynamic Data Table Row Filtering Elements") - -1. The controls (which are contained in the control), pass a column value to the control. - -2. The control uses this value to create the query filtering information, which it then passes to the data source control. - -3. The data source control passes the query filtering information to the data source provider. - -4. The data source provider passes the query to the database. + ![Dynamic Data Table Row Filtering Elements](~/add/media/dynamic-autofilter.png) -5. The database returns the filtered table rows. - -6. The data source provider sends this data back to the data source control. - -7. This control passes the filtered table rows to the data-bound control for display. +1. The controls (which are contained in the control), pass a column value to the control. +2. The control uses this value to create the query filtering information, which it then passes to the data source control. +3. The data source control passes the query filtering information to the data source provider. +4. The data source provider passes the query to the database. +5. The database returns the filtered table rows. +6. The data source provider sends this data back to the data source control. +7. This control passes the filtered table rows to the data-bound control for display. ## Declarative Syntax -``` +```xml + ID="string" + DynamicFilterContainerId="string" + EnableViewState="True|False" + OnDataBinding="DataBinding event handler" + OnDisposed="Disposed event handler" + OnInit="Init event handler" + OnLoad="Load event handler" + OnPreRender="PreRender event handler" + OnUnload="Unload event handler" + Visible="true" + runat="server" /> ``` - - ## Examples - A Visual Studio project with source code is available at this location: [Scaffolding Dynamic Data](https://go.microsoft.com/fwlink/?LinkId=168914). The following example shows how to use the control to generate the UI for table row filtering. The repeater's item template contains a control that creates the UI for each supported column type. - The example requires the following: - -- A Dynamic Data Web site or a Dynamic Data Web application. For more information, see `Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding`. + The example requires a Dynamic Data Web site or a Dynamic Data Web application. For more information, see `Walkthrough: Creating a New Dynamic Data Web Site using Scaffolding`. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/system.web.dynamicdata.queryablefilterrepeater/cs/queryablefilterrepeater.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/system.web.dynamicdata.queryablefilterrepeater/vb/queryablefilterrepeater.aspx" id="Snippet1"::: diff --git a/xml/System.Web.DynamicData/QueryableFilterUserControl.xml b/xml/System.Web.DynamicData/QueryableFilterUserControl.xml index 041f3de6648..0518b06ba38 100644 --- a/xml/System.Web.DynamicData/QueryableFilterUserControl.xml +++ b/xml/System.Web.DynamicData/QueryableFilterUserControl.xml @@ -16,18 +16,13 @@ Provides a base class for filter controls. - class is the base class for user controls that render filters that can be plugged into the Dynamic Data filtering framework that is based on the class. - - Implementers must override the control, which can return a modified object that reflects the filter's state. The base class contains helper methods for building LINQ expression trees. - - - -## Examples - A Visual Studio project with source code is available to accompany this topic: [Scaffolding Dynamic Data](https://go.microsoft.com/fwlink/?LinkId=168914). - + class is the base class for user controls that render filters that can be plugged into the Dynamic Data filtering framework that is based on the class. + + Implementers must override the control, which can return a modified object that reflects the filter's state. The base class contains helper methods for building LINQ expression trees. + ]]> @@ -131,11 +126,11 @@ Gets the default values that are mapped for the table. The default values that are mapped for the table. - @@ -201,11 +196,11 @@ Gets the data control that handles the filter inside the filter template. The data control that handles the filter. - @@ -233,60 +228,60 @@ Gets the transformed object from the source object. The transformed object from the source object. - . - - - -## Examples - This method is implemented to transform the source object into the target object. Examples of expressions that you might want to implement include order by, range, or search. - - The following example shows how to implement the method for a Boolean filter that is derived from . - -```csharp -public override IQueryable GetQueryable(IQueryable source) { - if (String.IsNullOrEmpty(DropDownList1.SelectedValue)) { - return source; - } - - bool value = Convert.ToBoolean(DropDownList1.SelectedValue); - - ParameterExpression parameterExpression = - Expression.Parameter(source.ElementType, "item"); - Expression body = BuildQueryBody( - parameterExpression, value); - - LambdaExpression lambda = Expression.Lambda(body, - parameterExpression); - MethodCallExpression whereCall = Expression.Call( - typeof(Queryable), - "Where", - new Type[] { source.ElementType }, - source.Expression, Expression.Quote(lambda)); - return source.Provider.CreateQuery(whereCall); -} -``` - -```vb -Public Overloads Overrides Function GetQueryable(ByVal source As IQueryable) As IQueryable - If [String].IsNullOrEmpty(DropDownList1.SelectedValue) Then - Return source - End If - - Dim value As Boolean = Convert.ToBoolean(DropDownList1.SelectedValue) - - Dim parameterExpression As ParameterExpression = Expression.Parameter(source.ElementType, "item") - Dim body As Expression = BuildQueryBody(parameterExpression, value) - - Dim lambda As LambdaExpression = Expression.Lambda(body, parameterExpression) - Dim whereCall As MethodCallExpression = Expression.[Call](GetType(Queryable), "Where", _ - New Type() {source.ElementType}, source.Expression, Expression.Quote(lambda)) - Return source.Provider.CreateQuery(whereCall) -End Function -``` - + . + + + +## Examples + This method is implemented to transform the source object into the target object. Examples of expressions that you might want to implement include order by, range, or search. + + The following example shows how to implement the method for a Boolean filter that is derived from . + +```csharp +public override IQueryable GetQueryable(IQueryable source) { + if (String.IsNullOrEmpty(DropDownList1.SelectedValue)) { + return source; + } + + bool value = Convert.ToBoolean(DropDownList1.SelectedValue); + + ParameterExpression parameterExpression = + Expression.Parameter(source.ElementType, "item"); + Expression body = BuildQueryBody( + parameterExpression, value); + + LambdaExpression lambda = Expression.Lambda(body, + parameterExpression); + MethodCallExpression whereCall = Expression.Call( + typeof(Queryable), + "Where", + new Type[] { source.ElementType }, + source.Expression, Expression.Quote(lambda)); + return source.Provider.CreateQuery(whereCall); +} +``` + +```vb +Public Overloads Overrides Function GetQueryable(ByVal source As IQueryable) As IQueryable + If [String].IsNullOrEmpty(DropDownList1.SelectedValue) Then + Return source + End If + + Dim value As Boolean = Convert.ToBoolean(DropDownList1.SelectedValue) + + Dim parameterExpression As ParameterExpression = Expression.Parameter(source.ElementType, "item") + Dim body As Expression = BuildQueryBody(parameterExpression, value) + + Dim lambda As LambdaExpression = Expression.Lambda(body, parameterExpression) + Dim whereCall As MethodCallExpression = Expression.[Call](GetType(Queryable), "Where", _ + New Type() {source.ElementType}, source.Expression, Expression.Quote(lambda)) + Return source.Provider.CreateQuery(whereCall) +End Function +``` + ]]> @@ -310,11 +305,11 @@ End Function Raises the event. - @@ -341,11 +336,11 @@ End Function A list control. Populates a list control with all the foreign-key elements or Boolean elements in the table. - diff --git a/xml/System.Web.UI.WebControls/Button.xml b/xml/System.Web.UI.WebControls/Button.xml index 5e29aae6848..a56ec568413 100644 --- a/xml/System.Web.UI.WebControls/Button.xml +++ b/xml/System.Web.UI.WebControls/Button.xml @@ -734,10 +734,7 @@ This property cannot be set by themes or style sheet themes. For more information, see and [ASP.NET Themes and Skins](https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)). - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192871). The following code example demonstrates how to use the property to specify additional client-side script that executes when a control is clicked. diff --git a/xml/System.Web.UI.WebControls/CheckBoxList.xml b/xml/System.Web.UI.WebControls/CheckBoxList.xml index cc3c32d3b7d..e53a8b004c9 100644 --- a/xml/System.Web.UI.WebControls/CheckBoxList.xml +++ b/xml/System.Web.UI.WebControls/CheckBoxList.xml @@ -31,17 +31,13 @@ ## Introduction @@ -141,10 +137,7 @@ ``` - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=191890). The following code example demonstrates how to create a control on a Web page. diff --git a/xml/System.Web.UI.WebControls/DropDownList.xml b/xml/System.Web.UI.WebControls/DropDownList.xml index 8e160ebc531..e77bead6405 100644 --- a/xml/System.Web.UI.WebControls/DropDownList.xml +++ b/xml/System.Web.UI.WebControls/DropDownList.xml @@ -35,13 +35,11 @@ ## Introduction @@ -121,10 +119,7 @@ ``` - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=191893). The following code example demonstrates how to create a control that contains four items. diff --git a/xml/System.Web.UI.WebControls/FileUpload.xml b/xml/System.Web.UI.WebControls/FileUpload.xml index 63878908af7..aac9f74cc7f 100644 --- a/xml/System.Web.UI.WebControls/FileUpload.xml +++ b/xml/System.Web.UI.WebControls/FileUpload.xml @@ -38,19 +38,14 @@ ## Introduction @@ -132,19 +127,13 @@ /> ``` - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=191897). This section contains the following four examples: - The first example demonstrates how to create a control that saves files to a path that is specified in code. - - The second example demonstrates how to create a control that saves files to a specified directory in the file system for the application. - - The third example demonstrates how to create a control that saves files to a specified path and limits the size of the file that can be uploaded. - - The fourth example demonstrates how to create a control that saves files to a specified path and allows only files that have the .doc or .xls file name extensions to be uploaded. > [!CAUTION] diff --git a/xml/System.Web.UI.WebControls/ImageButton.xml b/xml/System.Web.UI.WebControls/ImageButton.xml index 73870b47c80..eb25aa4fc05 100644 --- a/xml/System.Web.UI.WebControls/ImageButton.xml +++ b/xml/System.Web.UI.WebControls/ImageButton.xml @@ -135,10 +135,7 @@ /> ``` - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192874). The following code example demonstrates how to create an control that displays the coordinates at which an image is clicked. diff --git a/xml/System.Web.UI.WebControls/LinkButton.xml b/xml/System.Web.UI.WebControls/LinkButton.xml index 514de2ddec2..e2943c4edf9 100644 --- a/xml/System.Web.UI.WebControls/LinkButton.xml +++ b/xml/System.Web.UI.WebControls/LinkButton.xml @@ -87,13 +87,11 @@ ## Introduction @@ -162,10 +160,7 @@ /> ``` - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192872). The following example demonstrates how to create a control that displays text in a control when the link is clicked. diff --git a/xml/System.Web.UI.WebControls/ListView.xml b/xml/System.Web.UI.WebControls/ListView.xml index ebd2e563496..f41743425d5 100644 --- a/xml/System.Web.UI.WebControls/ListView.xml +++ b/xml/System.Web.UI.WebControls/ListView.xml @@ -86,44 +86,29 @@ ## Introduction The control is used to display the values from a data source. It resembles the control, except that it displays data by using user-defined templates instead of row fields. Creating your own templates gives you more flexibility in controlling how the data is displayed. - A Visual Studio project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=199759). - The control supports the following features: - Support for binding to data source controls such as , , and . - - Customizable appearance through user-defined templates and styles. - - Built-in sorting capabilities. - - Built-in update and delete capabilities. - - Built-in insert capabilities. - - Support for paging capabilities by using a control. - - Built-in item selection capabilities. - - Programmatic access to the object model to dynamically set properties, handle events, and so on. - - Multiple key fields. To learn about other data-bound controls that are available in ASP.NET, see [Data-Bound Web Server Controls](https://learn.microsoft.com/previous-versions/aspnet/ms228214(v=vs.100)). @@ -3133,13 +3118,13 @@ ## Remarks This method uses a different template depending on the mode of the item being instantiated and the settings of the control. The method uses one of the following templates to populate the container: -- +- -- +- -- +- -- +- > [!NOTE] > This method is primarily used by control developers to extend the control. diff --git a/xml/System.Web.UI.WebControls/Menu.xml b/xml/System.Web.UI.WebControls/Menu.xml index 5ca6fa6a7a0..5c5b1870db9 100644 --- a/xml/System.Web.UI.WebControls/Menu.xml +++ b/xml/System.Web.UI.WebControls/Menu.xml @@ -507,10 +507,7 @@ ``` - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192868). The following code example demonstrates how to create a control with static menu items using declarative syntax. diff --git a/xml/System.Web.UI.WebControls/Repeater.xml b/xml/System.Web.UI.WebControls/Repeater.xml index c1180669865..8760e307323 100644 --- a/xml/System.Web.UI.WebControls/Repeater.xml +++ b/xml/System.Web.UI.WebControls/Repeater.xml @@ -137,10 +137,7 @@ ``` - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192873). The following code example demonstrates how to use two simple controls on a page. The property is used to specify the data source for the control. The first displays its items in a table; the second displays its items in a comma-separated list. diff --git a/xml/System.Web.UI.WebControls/RouteParameter.xml b/xml/System.Web.UI.WebControls/RouteParameter.xml index 3522f6216fe..8f352c8416f 100644 --- a/xml/System.Web.UI.WebControls/RouteParameter.xml +++ b/xml/System.Web.UI.WebControls/RouteParameter.xml @@ -25,49 +25,13 @@ object to bind the value of a segment of the requested URL to a database query or command. You can declare objects in markup for data source controls or the control. - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=168640). - - - -## Examples - The examples in this section show how to use objects in markup to pass URL parameter values to a query that is specified for a data source control. - - The following example shows code in the Global.asax page that defines a route that is named `ProductRoute`. The route defines a URL parameter that is named `productname`. The route also defines an optional catchall parameter that is named `culture`, which can be used to specify the language in which the product description is displayed. The Product.aspx page handles requests for this route. - - - - - - The following example shows the Product.aspx page. The page contains a control that has a query that requires two parameters, one for the name of the product and one for the language of the product description. objects are used to supply the values for the query parameters. The value of the route URL parameter `productname` is passed to the query parameter `@productname`. The value of the route URL parameter `culture` is passed to the query parameter `@culture`. If a route URL does not include the URL parameter `culture`, a default value of "en" is used. - - - - The following example shows a page that is named ProductLinks.aspx, which contains hyperlinks that link to the Product.aspx page by using route URLs. These hyperlinks use `RouteUrl` expressions to create route URLs. The first link does not include a `culture` route parameter. Therefore, the default value of "en" that is defined in the object for `@culture` query parameter will be used in the query. The second link provides a `culture` value of "fr", which causes the description to be displayed in French. For more information about how to use `RouteUrl` expressions, see [How to: Construct URLs from Routes](https://learn.microsoft.com/previous-versions/aspnet/cc668176(v=vs.100)). - - - - When you click the first hyperlink, you see the Product.aspx page with the following values in the control: - -|ProductID|Name|Description| -|---------------|----------|-----------------| -|`994`|`LL Bottom Bracket`|`Chromoly steel.`| - - When you click the second hyperlink, you see the following values in the control: - -|ProductID|Name|Description| -|---------------|----------|-----------------| -|`994`|`LL Bottom Bracket`|`Acier chromé.`| - - To run this example, add the two .aspx pages and the code in the Global.asax file to an ASP.NET Web site or Web application that defines a connection string named `AdventureWorksLTConnectionString` for the AdventureWorksLT database. For information about how to set up a connection to the AdventureWorksLT database, see [How to: Set Up an AdventureWorksLT Sample Database for ASP.NET Development](https://msdn.microsoft.com/library/2baad633-9d63-49cc-a6b2-917cafd35356). - - For more information about ASP.NET routing, see [ASP.NET Routing](https://learn.microsoft.com/previous-versions/aspnet/cc668201(v=vs.100)). +If you implement ASP.NET routing in a Web site, you can use the object to bind the value of a segment of the requested URL to a database query or command. You can declare objects in markup for data source controls or the control. ]]> - QueryExtender Web Server Control Overview + QueryExtender Web Server Control Overview diff --git a/xml/System.Web.UI.WebControls/TextBox.xml b/xml/System.Web.UI.WebControls/TextBox.xml index b85e2e7bd36..b67b5349644 100644 --- a/xml/System.Web.UI.WebControls/TextBox.xml +++ b/xml/System.Web.UI.WebControls/TextBox.xml @@ -92,9 +92,8 @@ ## Remarks In this topic: -- [Introduction](#introduction) - -- [Declarative Syntax](#declarative_syntax) +- [Introduction](#introduction) +- [Declarative Syntax](#declarative_syntax) ## Introduction @@ -107,7 +106,7 @@ For a list of initial property values for an instance of , see the constructor. > [!CAUTION] -> This control can be used to accept user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. You can use validation controls to verify user input before displaying the input text in a control. ASP.NET provides an input request validation feature to block script and HTML in user input. For more information, see [Securing Standard Controls](https://learn.microsoft.com/previous-versions/aspnet/ms178270(v=vs.100)), [How to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings](https://learn.microsoft.com/previous-versions/aspnet/a2a4yykt(v=vs.100)), and [Validating User Input in ASP.NET Web Pages](https://learn.microsoft.com/previous-versions/aspnet/7kh55542(v=vs.100)). +> This control can be used to accept user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. You can use validation controls to verify user input before displaying the input text in a control. ASP.NET provides an input request validation feature to block script and HTML in user input. For more information, see [Securing Standard Controls](https://learn.microsoft.com/previous-versions/aspnet/ms178270(v=vs.100)), [How to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings](https://learn.microsoft.com/previous-versions/aspnet/a2a4yykt(v=vs.100)), and [Validating User Input in ASP.NET Web Pages](https://learn.microsoft.com/previous-versions/aspnet/7kh55542(v=vs.100)). ## Declarative Syntax @@ -169,15 +168,12 @@ /> ``` - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192423). The following code example demonstrates how to use the control to get user input. When the user clicks the **Add** button, the sum of the values entered in the text boxes is displayed. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). ```csharp <%@ Page Language="C#" AutoEventWireup="True" %> @@ -327,7 +323,7 @@ The following code example demonstrates how to use the constructor to dynamically add a control to the page. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/TextBox Constructor/CS/textboxctorcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/TextBox Constructor/VB/textboxctorvb.aspx" id="Snippet1"::: @@ -372,7 +368,7 @@ The following code example demonstrates how to override the method in a custom server control, so that the control text always appears bold. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomTextBoxAddAttributesToRender/CS/custom_textbox_addattributestorendercs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomTextBoxAddAttributesToRender/VB/custom_textbox_addattributestorendervb.aspx" id="Snippet1"::: @@ -414,7 +410,7 @@ The following code example demonstrates how to override the method in a custom server control so that it always sets the property to the parsed object's `Text` property if the parsed object is a control, and throws an exception otherwise. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomTextBoxAddParsedSubObject/CS/custom_textbox_addparsedsubobjectcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomTextBoxAddParsedSubObject/VB/custom_textbox_addparsedsubobjectvb.aspx" id="Snippet1"::: @@ -465,7 +461,7 @@ To assist with data entry, Microsoft Internet Explorer 5 and later and some other browsers support a feature referred to as AutoComplete. AutoComplete monitors a text box and creates a list of values entered by the user. When the user returns to the text box at a later time, the list is displayed. Instead of retyping a previously entered value, the user can simply select the value from this list. Use the property to control the behavior of the AutoComplete feature for a control. The enumeration is used to represent the values that you can apply to the property. > [!NOTE] -> Not all browsers support the AutoComplete feature. Check with your browser to determine compatibility. +> Not all browsers support the AutoComplete feature. Check with your browser to determine compatibility. By default, the property for a control is set to `AutoCompleteType.None`. With this setting, the control shares the list with other controls with the same property across different pages. You can also share a list between controls based on a category, instead of an property. When you set the property to one of the category values (such as `AutoCompleteType.FirstName`, `AutoCompleteType.LastName`, and so on), all controls with the same category share the same list. You can disable the AutoComplete feature for a control by setting the property to `AutoCompleteType.Disabled`. @@ -479,7 +475,7 @@ The following code example demonstrates how to use the enumeration to specify the AutoComplete category for a control. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/AutoCompleteType/CS/AutoCompleteTypecs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/AutoCompleteType/VB/AutoCompleteTypevb.aspx" id="Snippet1"::: @@ -528,7 +524,7 @@ Use the property to specify whether an automatic postback to the server will occur when the control loses focus. Pressing the ENTER or the TAB key while in the control is the most common way to change focus. > [!NOTE] -> If the control's parent container contains a button marked as the default button (for example, if the container's or property is set), the default button's `Click` event is not raised in response to the automatic postback. +> If the control's parent container contains a button marked as the default button (for example, if the container's or property is set), the default button's `Click` event is not raised in response to the automatic postback. This property cannot be set by themes or style sheet themes. For more information, see and [ASP.NET Themes and Skins](https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)). @@ -538,7 +534,7 @@ The following example shows how to use the property to automatically display the sum of the values entered in the text boxes when the control loses focus. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/TextBoxAutoPostBack/CS/textboxautopostbackcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/TextBoxAutoPostBack/VB/textboxautopostbackvb.aspx" id="Snippet1"::: @@ -634,7 +630,7 @@ The following code example demonstrates how to use the property to specify a width of 2 characters for the control. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/TextBox/CS/textboxcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/TextBox/VB/textboxvb.aspx" id="Snippet1"::: @@ -725,19 +721,16 @@ Use the property to limit the number of characters that can be entered in the control. > [!NOTE] -> This property is applicable only when the property is set to `TextBoxMode.SingleLine` or `TextBoxMode.Password`. +> This property is applicable only when the property is set to `TextBoxMode.SingleLine` or `TextBoxMode.Password`. This property cannot be set by themes or style sheet themes. For more information, see and [ASP.NET Themes and Skins](https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)). - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192423). The following code example demonstrates how to use the control to get user input. When the user clicks the **Add** button, the sum of the values entered in the text boxes is displayed. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). ```csharp <%@ Page Language="C#" AutoEventWireup="True" %> @@ -880,7 +873,7 @@ The following code example demonstrates how to override the method so that it always displays a one-point border in a custom server control. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomTextBoxOnPreRender/CS/custom_textbox_onprerendercs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomTextBoxOnPreRender/VB/custom_textbox_onprerendervb.aspx" id="Snippet1"::: @@ -922,7 +915,7 @@ The event is raised when the content of the text box changes between posts to the server. > [!NOTE] -> A control must persist some values between posts to the server for this event to work correctly. Be sure that view state is enabled for this control. +> A control must persist some values between posts to the server for this event to work correctly. Be sure that view state is enabled for this control. Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). @@ -934,7 +927,7 @@ The following code example demonstrates how to override the method so that it always marks a custom server control as having been modified. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomTextBoxOnTextChanged/CS/custom_textbox_ontextchangedcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomTextBoxOnTextChanged/VB/custom_textbox_ontextchangedvb.aspx" id="Snippet1"::: @@ -1027,7 +1020,7 @@ Use the property to specify whether the contents of the control can be changed. Setting this property to `true` will prevent users from entering a value or changing the existing value. Note that the user of the control cannot change this property; only the developer can. > [!IMPORTANT] -> The value of a control with the property set to `true` is sent to the server when a postback occurs, but the server does no processing for a read-only text box. This prevents a malicious user from changing a value that is read-only. The value of the property is preserved in the view state between postbacks unless modified by server-side code. +> The value of a control with the property set to `true` is sent to the server when a postback occurs, but the server does no processing for a read-only text box. This prevents a malicious user from changing a value that is read-only. The value of the property is preserved in the view state between postbacks unless modified by server-side code. This property cannot be set by themes or style sheet themes. For more information, see and [ASP.NET Themes and Skins](https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)). @@ -1037,7 +1030,7 @@ The following code example demonstrates how to use the property to prevent any changes to the text displayed in the control. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/TextBoxMultiLine/CS/multilinetextboxcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/TextBoxMultiLine/VB/multilinetextboxvb.aspx" id="Snippet1"::: @@ -1088,7 +1081,7 @@ The following code example demonstrates how to override the method in a custom server control so that the control is always displayed with an image. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomTextBoxRender/CS/custom_textbox_rendercs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomTextBoxRender/VB/custom_textbox_rendervb.aspx" id="Snippet1"::: @@ -1144,7 +1137,7 @@ Use the property to specify the number of rows displayed in a multiline text box. > [!NOTE] -> This property is applicable only when the property is set to `TextBoxMode.MultiLine`. +> This property is applicable only when the property is set to `TextBoxMode.MultiLine`. This property cannot be set by themes or style sheet themes. For more information, see and [ASP.NET Themes and Skins](https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)). @@ -1154,7 +1147,7 @@ The following code example demonstrates how to use the property to specify a height of 5 rows for a multiline control. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/TextBoxMultiLine/CS/multilinetextboxcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/TextBoxMultiLine/VB/multilinetextboxvb.aspx" id="Snippet1"::: @@ -1318,7 +1311,7 @@ The following code example demonstrates how to use the property to create a custom text box. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomTextBoxTagKey/CS/custom_textbox_tagkeycs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomTextBoxTagKey/VB/custom_textbox_tagkeyvb.aspx" id="Snippet1"::: @@ -1399,7 +1392,7 @@ The following code example demonstrates how to use the control to get user input. When the user clicks the **Add** button, the sum of the values entered in the text boxes is displayed. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). ```csharp <%@ Page Language="C#" AutoEventWireup="True" %> @@ -1538,7 +1531,7 @@ The event is raised when the content of the text box changes between posts to the server. The event is only raised if the text is changed by the user; the event is not raised if the text is changed programmatically. > [!NOTE] -> A control must persist some values between posts to the server for this event to work correctly. Be sure that view state is enabled for this control. +> A control must persist some values between posts to the server for this event to work correctly. Be sure that view state is enabled for this control. For more information about how to handle events, see [Handling and Raising Events](/dotnet/standard/events/). @@ -1614,7 +1607,7 @@ protected void TextBox1_TextChanged(object sender, EventArgs e) The following code example demonstrates how to use the property to specify a multiline text box. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/TextBoxMultiLine/CS/multilinetextboxcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/TextBoxMultiLine/VB/multilinetextboxvb.aspx" id="Snippet1"::: @@ -1707,7 +1700,7 @@ protected void TextBox1_TextChanged(object sender, EventArgs e) Use the property to specify whether the text displayed in a multiline control automatically continues on the next line when the text reaches the end of the control. > [!NOTE] -> This property is applicable only when the property is set to `TextBoxMode.MultiLine`. +> This property is applicable only when the property is set to `TextBoxMode.MultiLine`. @@ -1715,7 +1708,7 @@ protected void TextBox1_TextChanged(object sender, EventArgs e) The following code example demonstrates how to use the property to wrap text entered in the control. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/TextBoxMultiLine/CS/multilinetextboxcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/TextBoxMultiLine/VB/multilinetextboxvb.aspx" id="Snippet1"::: diff --git a/xml/System.Web.UI/Page.xml b/xml/System.Web.UI/Page.xml index f24eddd0ba3..8f13ef9f585 100644 --- a/xml/System.Web.UI/Page.xml +++ b/xml/System.Web.UI/Page.xml @@ -71,10 +71,7 @@ The class is a control that acts as the user interface for your Web application, and as such should be scrutinized to make sure best practices for writing secure code and securing applications are followed. For general information on these topics, see [Overview of Web Application Security Threats](https://learn.microsoft.com/previous-versions/f13d73y6(v=vs.140)), [Security Policy Best Practices](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/sa4se9bc(v=vs.100)), and [Key Security Concepts](/dotnet/standard/security/key-security-concepts). For more specific information, see [Securing Standard Controls](https://learn.microsoft.com/previous-versions/aspnet/ms178270(v=vs.100)), [How to: Display Safe Error Messages](https://learn.microsoft.com/previous-versions/aspnet/994a1482(v=vs.100)), [How to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings](https://learn.microsoft.com/previous-versions/aspnet/a2a4yykt(v=vs.100)), and [Introduction to the Validation Controls](https://learn.microsoft.com/previous-versions/dotnet/netframework-3.0/2e4hd649(v=vs.85)). - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192425). The following code example demonstrates how the class is used in the code-behind page model. Note that the code-behind source file declares a partial class that inherits from a base page class. The base page class can be , or it can be another class that derives from . Furthermore, note that the partial class allows the code-behind file to use controls defined on the page without the need to define them as field members. diff --git a/xml/System.Web/HttpRequest.xml b/xml/System.Web/HttpRequest.xml index 768c1a7b286..7bb71c03d3e 100644 --- a/xml/System.Web/HttpRequest.xml +++ b/xml/System.Web/HttpRequest.xml @@ -26,9 +26,7 @@ To access data from the , , , or collections, you can write `Request["key"]`, as shown in the example for the property. > [!NOTE] -> Unicode support for class members requires IIS version 6.0 or later. - - +> Unicode support for class members requires IIS version 6.0 or later. ## Examples The following examples access the instance for the current request by using the property of the class. @@ -109,12 +107,10 @@ Public Class RestrictedPage End Class ``` - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkID=191455). - This example uses the class to write the values of several class properties to a file. For properties that are of type string, the values are HTML encoded as they are written to the file. Properties that represent a collection are looped through, and each key/value pair that they contain is written to the file. > [!IMPORTANT] -> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). +> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). [!code-aspx-csharp[System.Web.HttpRequest_Sample1#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.HttpRequest_Sample1/CS/requestdetailscs.aspx#1)] [!code-aspx-vb[System.Web.HttpRequest_Sample1#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.HttpRequest_Sample1/VB/requestdetailsvb.aspx#1)] @@ -629,7 +625,7 @@ End Class ASP.NET includes two intrinsic cookie collections. The collection accessed through the collection of contains cookies transmitted by the client to the server in the `Cookie` header. The collection accessed through the collection of contains new cookies created on the server and transmitted to the client in the `Set-Cookie` header. > [!NOTE] -> After you add a cookie by using the collection, the cookie is immediately available in the collection, even if the response has not been sent to the client. +> After you add a cookie by using the collection, the cookie is immediately available in the collection, even if the response has not been sent to the client. @@ -1155,7 +1151,7 @@ End Class The method overloads provide managed access to the IIS 7 `IHttpRequest::InsertEntityBody` method. The IIS method inserts an HTTP request entity body (the data that is posted by a client) into memory. This is useful because IIS does not maintain a copy of the request entity after it has been read. The methods create a copy of the HTTP request entity data and make it available to IIS for additional custom handling. > [!NOTE] -> The method overloads work only on IIS 7.0 or later, because the `IHttpRequest::InsertEntityBody` method was added in IIS 7.0. +> The method overloads work only on IIS 7.0 or later, because the `IHttpRequest::InsertEntityBody` method was added in IIS 7.0. ]]> @@ -1464,7 +1460,7 @@ End Class ## Remarks > [!CAUTION] -> The property potentially contains sensitive information about the hosting environment. The return value should not be displayed to users. +> The property potentially contains sensitive information about the hosting environment. The return value should not be displayed to users. @@ -1525,7 +1521,7 @@ End Class ## Remarks > [!CAUTION] -> The property potentially contains sensitive information about the hosting environment. The return value should not be displayed to users. +> The property potentially contains sensitive information about the hosting environment. The return value should not be displayed to users. ]]> @@ -2169,7 +2165,7 @@ Dim fullname2 As String = Request("fullname") Request validation checks for HTML markup and script that might indicate a potential cross-site scripting attack. By default, all values are checked using request validation and if any values contain markup or script, ASP.NET throws an exception. Use this method if you anticipate that the request will contain markup (for example, you are allowing users to post content that contains markup) and you want to get the raw value of a request. > [!IMPORTANT] -> If you use this property, you must manually check the data for potential cross-site scripting attacks. +> If you use this property, you must manually check the data for potential cross-site scripting attacks. ]]> diff --git a/xml/System.Web/HttpServerUtility.xml b/xml/System.Web/HttpServerUtility.xml index 0b1026cd545..095fa712252 100644 --- a/xml/System.Web/HttpServerUtility.xml +++ b/xml/System.Web/HttpServerUtility.xml @@ -23,10 +23,7 @@ ## Remarks The methods and properties of the class are exposed through the intrinsic object provided by ASP.NET. - - ## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=192870). The following example demonstrates how to use the method and the method of the class. The method helps ensure that any user-supplied string input will be rendered as static text in browsers instead of executable script or HTML elements. The method encodes URLs so that they are correctly transmitted in the HTTP stream. diff --git a/xml/System.Windows.Controls/AdornedElementPlaceholder.xml b/xml/System.Windows.Controls/AdornedElementPlaceholder.xml index 372d4306249..42a0a6ebebf 100644 --- a/xml/System.Windows.Controls/AdornedElementPlaceholder.xml +++ b/xml/System.Windows.Controls/AdornedElementPlaceholder.xml @@ -33,37 +33,37 @@ Represents the element used in a to specify where a decorated control is placed relative to other elements in the . - that serves as a custom validation to provide visual feedback when the user input is not valid. - - For example, you might want a red exclamation point to appear next to a text box when the input is not valid, as in the following illustration. - - ![Data binding validation error](~/add/media/databindingdemo-validation.PNG "Data binding validation error") - - -## XAML Object Element Usage - -``` - -``` - - - -## Examples - The following example shows how to use a with to create the adorned in the preceding illustration. - - :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippet1"::: - - The element specifies where the control being adorned (the in this case) should be placed. - - You can then specify your template as the for your , as in the following example. - - :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippetcustomvalidation"::: - - For the complete sample, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703) or the Data Validation section in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - + that serves as a custom validation to provide visual feedback when the user input is not valid. + + For example, you might want a red exclamation point to appear next to a text box when the input is not valid, as in the following illustration. + + ![Data binding validation error](~/add/media/databindingdemo-validation.PNG "Data binding validation error") + + +## XAML Object Element Usage + +``` + +``` + + + +## Examples + The following example shows how to use a with to create the adorned in the preceding illustration. + + :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippet1"::: + + The element specifies where the control being adorned (the in this case) should be placed. + + You can then specify your template as the for your , as in the following example. + + :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippetcustomvalidation"::: + + For the complete sample, see the Data Validation section in [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). + ]]> @@ -287,11 +287,11 @@ Determines the size of the object. The desired size of this object. - is a placeholder for. - + is a placeholder for. + ]]> The object is not part of a template. diff --git a/xml/System.Windows.Controls/ExceptionValidationRule.xml b/xml/System.Windows.Controls/ExceptionValidationRule.xml index e53d7b1e148..2931b4c20b1 100644 --- a/xml/System.Windows.Controls/ExceptionValidationRule.xml +++ b/xml/System.Windows.Controls/ExceptionValidationRule.xml @@ -23,28 +23,26 @@ Represents a rule that checks for exceptions that are thrown during the update of the binding source property. - with a object. The class is a built-in rule that checks for exceptions that are thrown during the updates of the binding source property. You can provide custom logic to specify how the binding engine handles these exceptions by using a . For more information, see . - - An alternative syntax to setting the explicitly is to set the property to `true` on your or object. - - You can create a custom rule by creating a class that derives from . For more information and a detailed discussion of data validation, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - - - -## Examples - The property takes a collection of objects. The following example uses as the binding target property and `StartPrice` (an integer) as the binding source property. When the user enters a value that cannot be converted to an integer, an exception is thrown, which causes the to invalidate the target value. - - :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippetdefaultvalidation"::: - - By default, when there is a validation error, the appears with a red border. Optionally, you can write a custom to specify how you want to notify the user when there is a validation error. - - For more information about data validation, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). - - For the complete sample, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - + with a object. The class is a built-in rule that checks for exceptions that are thrown during the updates of the binding source property. You can provide custom logic to specify how the binding engine handles these exceptions by using a . For more information, see . + + An alternative syntax to setting the explicitly is to set the property to `true` on your or object. + + You can create a custom rule by creating a class that derives from . For more information and a detailed discussion of data validation, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). + + + +## Examples + The property takes a collection of objects. The following example uses as the binding target property and `StartPrice` (an integer) as the binding source property. When the user enters a value that cannot be converted to an integer, an exception is thrown, which causes the to invalidate the target value. + + :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippetdefaultvalidation"::: + + By default, when there is a validation error, the appears with a red border. Optionally, you can write a custom to specify how you want to notify the user when there is a validation error. + + For more information about data validation, see [Data Binding Overview](/dotnet/framework/wpf/data/data-binding-overview). + ]]> diff --git a/xml/System.Windows.Controls/GroupStyle.xml b/xml/System.Windows.Controls/GroupStyle.xml index 40e2795c9a6..461100a73b2 100644 --- a/xml/System.Windows.Controls/GroupStyle.xml +++ b/xml/System.Windows.Controls/GroupStyle.xml @@ -448,8 +448,6 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml" id="Snippetheadertemplate"::: - For the complete sample, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - ]]> diff --git a/xml/System.Windows.Controls/WebBrowser.xml b/xml/System.Windows.Controls/WebBrowser.xml index 859fcff23cd..0ce9e7649f9 100644 --- a/xml/System.Windows.Controls/WebBrowser.xml +++ b/xml/System.Windows.Controls/WebBrowser.xml @@ -133,7 +133,6 @@ internal interface IServiceProvider ]]> - XBAP Hosting Silverlight Sample diff --git a/xml/System.Windows.Data/Binding.xml b/xml/System.Windows.Data/Binding.xml index 848969f3877..2c294f5bb2d 100644 --- a/xml/System.Windows.Data/Binding.xml +++ b/xml/System.Windows.Data/Binding.xml @@ -1265,8 +1265,6 @@ :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/AddProductWindow.xaml" id="Snippetcomboboxmultibinding"::: - For the full example, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - ]]> diff --git a/xml/System.Windows.Data/BindingListCollectionView.xml b/xml/System.Windows.Data/BindingListCollectionView.xml index 7344015603d..225022b5db6 100644 --- a/xml/System.Windows.Data/BindingListCollectionView.xml +++ b/xml/System.Windows.Data/BindingListCollectionView.xml @@ -1009,16 +1009,12 @@ > [!NOTE] > This property can only be set by accessing the collection object and using its various methods such as Add. The property to access the collection object itself is read-only; the collection itself is read/write. - - ## Examples The following example shows how to use this property: :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet6"::: - For the complete example, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - ]]> diff --git a/xml/System.Windows.Data/CollectionViewSource.xml b/xml/System.Windows.Data/CollectionViewSource.xml index dacc8b1c8cd..b3824a25512 100644 --- a/xml/System.Windows.Data/CollectionViewSource.xml +++ b/xml/System.Windows.Data/CollectionViewSource.xml @@ -500,8 +500,6 @@ You can use this event to set an event handler to provide filtering logic. - - ## Examples The following example shows how to set an event handler for the event. In this example, `listingDataView` is an instance of . @@ -513,8 +511,6 @@ :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: - For the complete example, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - ]]> diff --git a/xml/System.Windows.Data/FilterEventArgs.xml b/xml/System.Windows.Data/FilterEventArgs.xml index 1f75458e81c..993093996ec 100644 --- a/xml/System.Windows.Data/FilterEventArgs.xml +++ b/xml/System.Windows.Data/FilterEventArgs.xml @@ -23,21 +23,19 @@ Provides information and event data that is associated with the event. - event. In this example, `listingDataView` is an instance of . - + event. In this example, `listingDataView` is an instance of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet10"::: - - The following example shows the implementation of the example `ShowOnlyBargainsFilter` filter event handler. This event handler uses the property to filter out `AuctionItem` objects that have a `CurrentPrice` of $25.00 or greater. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet10"::: + + The following example shows the implementation of the example `ShowOnlyBargainsFilter` filter event handler. This event handler uses the property to filter out `AuctionItem` objects that have a `CurrentPrice` of $25.00 or greater. + :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: - - For the complete example, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: + ]]> @@ -80,21 +78,19 @@ if the item passes the filter; otherwise, . The default is . - event. In this example, `listingDataView` is an instance of . - + event. In this example, `listingDataView` is an instance of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet10"::: - - The following example shows the implementation of the example `ShowOnlyBargainsFilter` filter event handler. This event handler uses the property to filter out `AuctionItem` objects that have a `CurrentPrice` of $25.00 or greater. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet10"::: + + The following example shows the implementation of the example `ShowOnlyBargainsFilter` filter event handler. This event handler uses the property to filter out `AuctionItem` objects that have a `CurrentPrice` of $25.00 or greater. + :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: - - For the complete example, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: + ]]> @@ -132,21 +128,19 @@ Gets the object that the filter should test. The object that the filter should test. The default is . - event. In this example, `listingDataView` is an instance of . - + event. In this example, `listingDataView` is an instance of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet10"::: - - The following example shows the implementation of the example `ShowOnlyBargainsFilter` filter event handler. This event handler uses the property to filter out `AuctionItem` objects that have a `CurrentPrice` of $25.00 or greater. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet10"::: + + The following example shows the implementation of the example `ShowOnlyBargainsFilter` filter event handler. This event handler uses the property to filter out `AuctionItem` objects that have a `CurrentPrice` of $25.00 or greater. + :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: - - For the complete example, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: + ]]> diff --git a/xml/System.Windows.Data/FilterEventHandler.xml b/xml/System.Windows.Data/FilterEventHandler.xml index adf4ee60f15..9d161f6fba9 100644 --- a/xml/System.Windows.Data/FilterEventHandler.xml +++ b/xml/System.Windows.Data/FilterEventHandler.xml @@ -31,21 +31,19 @@ The event data. Represents the method that will handle the event. - event. In this example, `listingDataView` is an instance of . - + event. In this example, `listingDataView` is an instance of . + :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet10"::: - - The following example shows the implementation of the example `ShowOnlyBargainsFilter` filter event handler. This event handler uses the property to filter out `AuctionItem` objects that have a `CurrentPrice` of $25.00 or greater. - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet10"::: + + The following example shows the implementation of the example `ShowOnlyBargainsFilter` filter event handler. This event handler uses the property to filter out `AuctionItem` objects that have a `CurrentPrice` of $25.00 or greater. + :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: - - For the complete example, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - + :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet5"::: + ]]> diff --git a/xml/System.Windows.Data/ListCollectionView.xml b/xml/System.Windows.Data/ListCollectionView.xml index 5a2fb3e5bdf..6001416651e 100644 --- a/xml/System.Windows.Data/ListCollectionView.xml +++ b/xml/System.Windows.Data/ListCollectionView.xml @@ -1180,16 +1180,12 @@ > [!NOTE] > This property can only be set by accessing the collection object and using its various methods such as `Add`. The property to access the collection object itself is read-only; the collection itself is read/write. - - ## Examples The following example shows how to use this property: :::code language="csharp" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/MainWindow.xaml.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/System.Windows.Data/BindingListCollectionView/GroupDescriptions/MainWindow.xaml.vb" id="Snippet6"::: - For the complete example, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - ]]> diff --git a/xml/System.Windows.Data/PropertyGroupDescription.xml b/xml/System.Windows.Data/PropertyGroupDescription.xml index b22c216e8d2..fdbf6db4940 100644 --- a/xml/System.Windows.Data/PropertyGroupDescription.xml +++ b/xml/System.Windows.Data/PropertyGroupDescription.xml @@ -23,15 +23,15 @@ Describes the grouping of items using a property name as the criteria. - allows you to create implicit groups based on a . If you simply want to group by a property you can set the property. If you want to change the value that is eventually used for group you can use the property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. - - You can also define how string comparison should take place using the property. - + allows you to create implicit groups based on a . If you simply want to group by a property you can set the property. If you want to change the value that is eventually used for group you can use the property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. + + You can also define how string comparison should take place using the property. + ]]> @@ -67,16 +67,14 @@ Initializes a new instance of the class. - @@ -196,11 +194,11 @@ Gets an value that orders groups in ascending order of name. An value that orders groups in ascending order of name. - can be used as a value for . - + can be used as a value for . + ]]> @@ -230,11 +228,11 @@ Gets an value that orders groups in descending order of name. An value that orders groups in descending order of name. - can be used as a value for . - + can be used as a value for . + ]]> @@ -275,11 +273,11 @@ Gets or sets a converter to apply to the property value or the item to produce the final value that is used to determine which group(s) an item belongs to. The default value is . - property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. - + property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. + ]]> @@ -391,13 +389,13 @@ Gets or sets the name of the property that is used to determine which group(s) an item belongs to. The default value is . - allows you to create implicit groups based on a . If you simply want to group by a property you can set the property. If you want to change the value that is eventually used for group you can use the property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. - - You can also define how string comparison should take place using the property. - + allows you to create implicit groups based on a . If you simply want to group by a property you can set the property. If you want to change the value that is eventually used for group you can use the property to supply a value converter. For example, you may want to group items based on the first letter of a name. If the property is not set, the item itself is passed to the value converter. The converter may return a collection, which indicates the items can appear in more than one group. + + You can also define how string comparison should take place using the property. + ]]> @@ -438,11 +436,11 @@ Gets or sets a value that specifies the comparison between the value of an item (as determined by and ) and the name of a group. The default value is .. - diff --git a/xml/System.Windows/DataTemplate.xml b/xml/System.Windows/DataTemplate.xml index 81ab6ac1409..28bb8d2ac98 100644 --- a/xml/System.Windows/DataTemplate.xml +++ b/xml/System.Windows/DataTemplate.xml @@ -60,7 +60,6 @@ - Data Binding Demo @@ -311,18 +310,15 @@ ## XAML Values - *OneOrMoreTriggers* - Zero or more objects. - + *OneOrMoreTriggers*\ + Zero or more objects. ## Examples The following demonstrates the use of the property. :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/DataBindingLabApp.xaml" id="Snippetauctionitemdatatemplate"::: - For the complete sample, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - ]]> diff --git a/xml/System.Windows/DataTrigger.xml b/xml/System.Windows/DataTrigger.xml index 0c79687bcfd..358bfd545dc 100644 --- a/xml/System.Windows/DataTrigger.xml +++ b/xml/System.Windows/DataTrigger.xml @@ -279,8 +279,6 @@ The first is specified such that if the data object has a *SpecialFeatures* value of *Color*, then the item is displayed with a `DodgerBlue` background with Navy titles. If the data object has a *SpecialFeatures* value of *Highlight*, then the second will be active, causing the item to be displayed with an Orange border with a star. - For the complete sample, see [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703). - :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/DataBindingLabApp.xaml" id="Snippetauctionitemsdatatriggers"::: ]]> @@ -423,22 +421,21 @@ This value is compared with the property value produced by the property of the . The comparison is a reference equality check. If the two values are equal, then the associated actions or setters are applied. - Note that you must specify both the and properties on a for the data trigger to be meaningful. If one or both properties are not set, an exception will be thrown. - - +> [!NOTE] +> You must specify both the and properties on a for the data trigger to be meaningful. If one or both properties aren't set, an exception is thrown. ## Examples - In the following example, the of the is bound to *Places*, an of *Place* objects. *Place* objects have properties *Name* and *State*. + In the following example, the of the is bound to `Places`, an of `Place` objects. `Place` objects have properties `Name` and `State`. - Each of the displays a *Place* object. The in the example is applied to each . + Each of the displays a `Place` object. The in the example is applied to each . - The is specified such that if the *State* of the *Place* data item is "WA" then the foreground of the corresponding is set to Red. + The is specified such that if the `State` of the `Place` data item is "WA", then the foreground of the corresponding is set to Red. :::code language="xaml" source="~/snippets/csharp/System.Windows/Condition/Binding/Window1.xaml" id="Snippet1"::: - The following example shows two s that are defined in a . The is applied to *AuctionItem* data objects (not shown in this example), which have the property *SpecialFeatures*. See [Data Binding Demo](https://go.microsoft.com/fwlink/?LinkID=163703) for the complete example. + The following example shows two s that are defined in a . The is applied to `AuctionItem` data objects (not shown in this example), which have the property `SpecialFeatures`. - The first is specified such that if the data object has a *SpecialFeatures* value of *Color*, then the item is displayed with a DodgerBlue background with Navy titles. If the data object has a *SpecialFeatures* value of *Highlight*, then the second will be active, causing the item to be displayed with an Orange border with a star. + The first is specified such that if the data object has a `SpecialFeatures` value of `Color`, then the item is displayed with a DodgerBlue background with Navy titles. If the data object has a `SpecialFeatures` value of `Highlight`, then the second will be active, causing the item to be displayed with an Orange border with a star. :::code language="xaml" source="~/snippets/csharp/System.Windows/DataTemplate/Triggers/DataBindingLabApp.xaml" id="Snippetauctionitemsdatatriggers"::: From 9cc9a5b2d48bade5afd075a7c2546b826f9a1a0f Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 25 Jul 2025 16:41:58 -0700 Subject: [PATCH 4/4] Clarify that sequence is sorted in example (#11426) --- xml/System.Linq/Enumerable.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Linq/Enumerable.xml b/xml/System.Linq/Enumerable.xml index 6759c12deab..9a51a8b0437 100644 --- a/xml/System.Linq/Enumerable.xml +++ b/xml/System.Linq/Enumerable.xml @@ -15298,7 +15298,7 @@ In Visual Basic query expression syntax, an `Aggregate Into Sum()` clause transl In Visual Basic query expression syntax, a `Take` clause translates to an invocation of . ## Examples - The following code example demonstrates how to use to return elements from the start of a sequence. + The following code example demonstrates how to use to return elements from the start of a sequence (after it's sorted). :::code language="csharp" source="~/snippets/csharp/System.Linq/Enumerable/AggregateTSource/enumerable.cs" interactive="try-dotnet-method" id="Snippet99"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Linq.Enumerable/VB/Enumerable.vb" id="Snippet99":::