diff --git a/xml/FrameworksIndex/net-10.0.xml b/xml/FrameworksIndex/net-10.0.xml index 4ff8a44f0bb..71b1268c315 100644 --- a/xml/FrameworksIndex/net-10.0.xml +++ b/xml/FrameworksIndex/net-10.0.xml @@ -3933,6 +3933,7 @@ + @@ -11068,6 +11069,8 @@ + + @@ -16157,6 +16160,7 @@ + @@ -31045,6 +31049,10 @@ + + + + @@ -31060,7 +31068,9 @@ + + @@ -31075,10 +31085,16 @@ + + + + + + @@ -31100,6 +31116,11 @@ + + + + + @@ -31144,7 +31165,9 @@ + + @@ -31161,10 +31184,17 @@ + + + + + + + @@ -31172,6 +31202,9 @@ + + + @@ -31196,6 +31229,8 @@ + + @@ -31239,6 +31274,7 @@ + @@ -31247,8 +31283,11 @@ + + + @@ -31295,6 +31334,8 @@ + + @@ -31401,6 +31442,13 @@ + + + + + + + @@ -31462,6 +31510,7 @@ + @@ -31582,6 +31631,8 @@ + + @@ -31742,6 +31793,8 @@ + + @@ -31904,6 +31957,8 @@ + + @@ -32734,6 +32789,7 @@ + @@ -37440,6 +37496,18 @@ + + + + + + + + + + + + @@ -37857,6 +37925,7 @@ + @@ -38137,6 +38206,10 @@ + + + + @@ -38382,9 +38455,11 @@ + + @@ -38406,6 +38481,11 @@ + + + + + @@ -40325,6 +40405,7 @@ + @@ -40486,6 +40567,7 @@ + @@ -44802,6 +44884,20 @@ + + + + + + + + + + + + + + @@ -44840,6 +44936,7 @@ + @@ -44853,12 +44950,16 @@ + + + + @@ -45044,6 +45145,13 @@ + + + + + + + @@ -45110,6 +45218,7 @@ + @@ -45178,6 +45287,7 @@ + @@ -45375,6 +45485,13 @@ + + + + + + + @@ -45441,6 +45558,7 @@ + @@ -45509,6 +45627,7 @@ + @@ -45707,6 +45826,13 @@ + + + + + + + @@ -45773,6 +45899,7 @@ + @@ -45839,6 +45966,7 @@ + @@ -46014,6 +46142,13 @@ + + + + + + + @@ -46074,6 +46209,7 @@ + @@ -47405,51 +47541,26 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + @@ -53037,8 +53148,10 @@ + + @@ -53052,20 +53165,27 @@ + + + + + + - + + @@ -53090,6 +53210,7 @@ + @@ -53128,7 +53249,7 @@ - + @@ -53856,12 +53977,16 @@ + + + + @@ -53869,20 +53994,31 @@ + + + + + + + + + - + + + @@ -54066,11 +54202,13 @@ + + @@ -54156,8 +54294,10 @@ + + @@ -54166,6 +54306,7 @@ + @@ -54368,6 +54509,7 @@ + @@ -54384,6 +54526,8 @@ + + @@ -54727,6 +54871,7 @@ + diff --git a/xml/FrameworksIndex/windowsdesktop-10.0.xml b/xml/FrameworksIndex/windowsdesktop-10.0.xml index 8aaf4856f81..5d8cb83ea47 100644 --- a/xml/FrameworksIndex/windowsdesktop-10.0.xml +++ b/xml/FrameworksIndex/windowsdesktop-10.0.xml @@ -12350,10 +12350,12 @@ + + @@ -35817,6 +35819,9 @@ + + + diff --git a/xml/Microsoft.Extensions.VectorData/VectorStore.xml b/xml/Microsoft.Extensions.VectorData/VectorStore.xml index d81200ff1b1..abfca1c1ab3 100644 --- a/xml/Microsoft.Extensions.VectorData/VectorStore.xml +++ b/xml/Microsoft.Extensions.VectorData/VectorStore.xml @@ -214,9 +214,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.CodeDom.Compiler/CodeDomProvider.xml b/xml/System.CodeDom.Compiler/CodeDomProvider.xml index 51531b65953..d7a63227804 100644 --- a/xml/System.CodeDom.Compiler/CodeDomProvider.xml +++ b/xml/System.CodeDom.Compiler/CodeDomProvider.xml @@ -49,9 +49,6 @@ ## Remarks A can be used to create and retrieve instances of code generators and code compilers. Code generators can be used to generate code in a particular language, and code compilers can be used to compile code into assemblies. -> [!NOTE] -> In the .NET Framework 2.0, the methods made available in the code generator and code compiler are available directly from the code provider. You do not need to call or to access the methods, and those methods are marked as obsolete. This applies to preexisting as well as new code provider implementations. - A implementation typically provides code generation and/or code compilation interfaces for generating code and managing compilation for a single programming language. Several languages are supported by implementations that ship with the Windows SDK. These languages include C#, Visual Basic, C++, and JScript. Developers or compiler vendors can implement the and interfaces and provide a that extends CodeDOM support to other programming languages. The [<system.codedom> Element](/dotnet/framework/configure-apps/file-schema/compiler/system-codedom-element) in the machine configuration file (Machine.config) provides a mechanism for developers and compiler vendors to add configuration settings for additional implementations. @@ -74,7 +71,7 @@ ]]> - In the .NET Framework versions 1.0 and 1.1, code providers consist of implementations of , , , and . In the .NET Framework 2.0, the , , and methods are obsolete, and the methods of and are directly available in the class. You should override those methods in your code provider implementation and not call the base methods. + In .NET Framework 1.0 and 1.1, code providers consist of implementations of , , , and . Starting in .NET Framework 2.0, the , , and methods are obsolete, and the methods of and are directly available in the class. You should override those methods in your code provider implementation and not call the base methods. @@ -171,7 +168,7 @@ > On .NET Core and .NET 5+, calls to the `CodeDomProvider.CompileAssemblyFromDom` method throw a . Compile code is not supported. > [!NOTE] -> In .NET Framework 2.0 and later versions, this method can be called directly on the code provider even if it's not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. +> In .NET Framework 2.0 and later versions, this method can be called directly on the code provider even if it's not overridden by the code provider. If the code provider does not override this method, the implementation is called by the base class. ]]> @@ -361,12 +358,12 @@ methods that are directly available in the code provider. + This method is obsolete. The recommended alternative is to call the methods that are directly available in the code provider. ]]> - In the .NET Framework 2.0, you should implement the members in the class and throw a when this method is called. + You should implement the members in the class and throw a when this method is called. @@ -476,12 +473,12 @@ methods that are directly available in the class. + This method is obsolete. The recommended alternative is to call the methods that are directly available in the class. ]]> - In the .NET Framework 2.0, you should implement the members in the class and throw a when this method is called. + You should implement the members in the class and throw a when this method is called. @@ -533,7 +530,7 @@ This method uses the specified for output. This method supports more optimized code generation that incrementally updates the source code. > [!NOTE] -> The base class implementation calls the method, which is obsolete in the .NET Framework 2.0 and results in a if an object is not returned. +> The base class implementation calls the method, which is obsolete and results in a if an object is not returned. ]]> @@ -588,7 +585,7 @@ This method uses the specified file name for output. > [!NOTE] -> The base class implementation calls the method, which is obsolete in the .NET Framework 2.0 and results in a if an object is not returned. +> The base class implementation calls the method, which is obsolete and results in a if an object is not returned. ]]> @@ -1287,11 +1284,6 @@ ## Remarks Use the method to enumerate the language provider settings on a computer. -> [!NOTE] -> In the .NET Framework 2.0, the default language providers supplied by the .NET Framework are not specified in the [<system.codedom> Element](/dotnet/framework/configure-apps/file-schema/compiler/system-codedom-element) compiler configuration section and cannot be removed, so this method returns information about the default providers and any specified in the configuration file. - - - ## Examples The following code example enumerates the language providers on the computer and displays the configuration and compiler settings for each language provider. This code example is part of a larger example provided for the class. diff --git a/xml/System.CodeDom.Compiler/ICodeCompiler.xml b/xml/System.CodeDom.Compiler/ICodeCompiler.xml index 003e8bd3c00..29c597bc4cf 100644 --- a/xml/System.CodeDom.Compiler/ICodeCompiler.xml +++ b/xml/System.CodeDom.Compiler/ICodeCompiler.xml @@ -31,19 +31,19 @@ Defines an interface for invoking compilation of source code or a CodeDOM tree using a specific compiler. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, code providers consist of implementations of , , , and . In the .NET Framework 2.0, the , , and methods are obsolete, and the methods of and are directly available in the class. You should override those methods in your code provider implementation and not call the base methods. - - The interface can be implemented for a specific compiler to enable developers to programmatically compile assemblies from Code Document Object Model (CodeDOM) compile units, strings containing source code, or source code files. - - The interface provides the capability to invoke compilation with specified parameters at runtime and access information related to compilation after compilation occurs, including the result code, and any errors or warnings the compiler returns. Each compile method accepts a object that indicates settings for the compiler, and returns a object that indicates the results of the compilation. - - Compiler developers should provide an implementation of this interface to support dynamic compilation. implementers should also consider implementing this interface to provide programmatic compilation capability for the language that they are providing CodeDom support for. - +> Starting in .NET Framework 2.0, the , , and methods are obsolete, and the methods of and are directly available in the class. You should override those methods in your code provider implementation and not call the base methods. + + The interface can be implemented for a specific compiler to enable developers to programmatically compile assemblies from Code Document Object Model (CodeDOM) compile units, strings containing source code, or source code files. + + The interface provides the capability to invoke compilation with specified parameters at runtime and access information related to compilation after compilation occurs, including the result code, and any errors or warnings the compiler returns. Each compile method accepts a object that indicates settings for the compiler, and returns a object that indicates the results of the compilation. + + Compiler developers should provide an implementation of this interface to support dynamic compilation. implementers should also consider implementing this interface to provide programmatic compilation capability for the language that they are providing CodeDom support for. + ]]> diff --git a/xml/System.CodeDom.Compiler/ICodeGenerator.xml b/xml/System.CodeDom.Compiler/ICodeGenerator.xml index 0d6afde2fb7..cfec5737fbf 100644 --- a/xml/System.CodeDom.Compiler/ICodeGenerator.xml +++ b/xml/System.CodeDom.Compiler/ICodeGenerator.xml @@ -31,17 +31,17 @@ Defines an interface for generating code. - [!NOTE] -> In the .NET Framework versions 1.0 and 1.1, code providers consist of implementations of , , , and . In the .NET Framework 2.0, the , , and methods are obsolete, and the methods of and are directly available in the class. You should override those methods in your code provider implementation and not call the base methods. - - Developers of compilers can implement this interface to allow people to dynamically generate code in a particular language. This can be used for a variety of purposes, such as creating code-generating wizards, creating dynamic assemblies with content that can be debugged, and for templated documents with embedded code, such as ASP.NET. - - An implementation is typically obtained through a call to the method of . - +> Starting in .NET Framework 2.0, the , , and methods are obsolete, and the methods of and are directly available in the class. You should override those methods in your code provider implementation and not call the base methods. + + Developers of compilers can implement this interface to allow people to dynamically generate code in a particular language. This can be used for a variety of purposes, such as creating code-generating wizards, creating dynamic assemblies with content that can be debugged, and for templated documents with embedded code, such as ASP.NET. + + An implementation is typically obtained through a call to the method of . + ]]> @@ -82,11 +82,11 @@ Creates an escaped identifier for the specified value. The escaped identifier for the value. - tests whether the identifier conflicts with reserved or language keywords, and if so, returns an equivalent name with language-specific escape code formatting. This is referred to an escaped identifier. The escaped identifier will contain the same `value` but will have escape code formatting added to differentiate the identifier from the keyword. Two implementation examples are preceding the `value` with "@" or bracketing the `value` with "[" and "]". - + tests whether the identifier conflicts with reserved or language keywords, and if so, returns an equivalent name with language-specific escape code formatting. This is referred to an escaped identifier. The escaped identifier will contain the same `value` but will have escape code formatting added to differentiate the identifier from the keyword. Two implementation examples are preceding the `value` with "@" or bracketing the `value` with "[" and "]". + ]]> @@ -128,11 +128,11 @@ Creates a valid identifier for the specified value. A valid identifier for the specified value. - tests whether the identifier conflicts with reserved or language keywords, and returns a valid identifier name that does not conflict. The returned identifier will contain the same `value` but, if it conflicts with reserved or language keywords, will have escape code formatting added to differentiate the identifier from the keyword. Typically, if the value needs modification, value is returned preceded by an underscore "_". - + tests whether the identifier conflicts with reserved or language keywords, and returns a valid identifier name that does not conflict. The returned identifier will contain the same `value` but, if it conflicts with reserved or language keywords, will have escape code formatting added to differentiate the identifier from the keyword. Typically, if the value needs modification, value is returned preceded by an underscore "_". + ]]> @@ -433,11 +433,11 @@ if the parameter is a valid identifier; otherwise, . - in a derived class, design the method to test the value passed to it, and return `true` only if the value fits the rules of the language and does not conflict with a keyword. - + in a derived class, design the method to test the value passed to it, and return `true` only if the value fits the rules of the language and does not conflict with a keyword. + ]]> @@ -479,11 +479,11 @@ if the specified capabilities are supported; otherwise, . - flags at once to test for a set of capabilities by joining a set of appropriate capability flags together with a binary "Or" operator (|). - + flags at once to test for a set of capabilities by joining a set of appropriate capability flags together with a binary "Or" operator (|). + ]]> @@ -523,11 +523,11 @@ The identifier to validate. Throws an exception if the specified value is not a valid identifier. - . This method enables a code generator that implements this method to produce an informative error message based upon the value of an invalid identifier. - + . This method enables a code generator that implements this method to produce an informative error message based upon the value of an invalid identifier. + ]]> The identifier is not valid. diff --git a/xml/System.Collections.Immutable/ImmutableDictionary.xml b/xml/System.Collections.Immutable/ImmutableDictionary.xml index 9f6e757dcd0..ff4e6f68135 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary.xml @@ -657,7 +657,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] [<System.Runtime.CompilerServices.Nullable(2)>] @@ -665,17 +665,17 @@ - + - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 0, 1, 1 })] [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 0, 1, 1 })>] - + [System.Runtime.CompilerServices.ParamCollection] [<System.Runtime.CompilerServices.ParamCollection>] - + [System.Runtime.CompilerServices.ScopedRef] [<System.Runtime.CompilerServices.ScopedRef>] @@ -710,7 +710,7 @@ - + [System.Runtime.CompilerServices.Nullable(2)] [<System.Runtime.CompilerServices.Nullable(2)>] @@ -718,25 +718,25 @@ - + - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })] [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 2, 1 })>] - + - + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 0, 1, 1 })] [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 0, 1, 1 })>] - + [System.Runtime.CompilerServices.ParamCollection] [<System.Runtime.CompilerServices.ParamCollection>] - + [System.Runtime.CompilerServices.ScopedRef] [<System.Runtime.CompilerServices.ScopedRef>] diff --git a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml index ec8af71a64e..c59e21fc5ea 100644 --- a/xml/System.Collections.Immutable/ImmutableDictionary`2.xml +++ b/xml/System.Collections.Immutable/ImmutableDictionary`2.xml @@ -78,14 +78,14 @@ [System.Diagnostics.DebuggerTypeProxy(typeof(System.Collections.Immutable.ImmutableDictionaryDebuggerProxy<,>))] [<System.Diagnostics.DebuggerTypeProxy(typeof(System.Collections.Immutable.ImmutableDictionaryDebuggerProxy<,>))>] + + [System.Runtime.CompilerServices.CollectionBuilder(typeof(System.Collections.Immutable.ImmutableDictionary), "CreateRangeWithOverwrite")] + [<System.Runtime.CompilerServices.CollectionBuilder(typeof(System.Collections.Immutable.ImmutableDictionary), "CreateRangeWithOverwrite")>] + [System.Runtime.CompilerServices.Nullable(0)] [<System.Runtime.CompilerServices.Nullable(0)>] - - [System.Runtime.CompilerServices.CollectionBuilder(typeof(System.Collections.Immutable.ImmutableDictionary), "CreateRangeWithOverwrite")] - [<System.Runtime.CompilerServices.CollectionBuilder(typeof(System.Collections.Immutable.ImmutableDictionary), "CreateRangeWithOverwrite")>] - The type of the keys in the dictionary. diff --git a/xml/System.Collections.Specialized/HybridDictionary.xml b/xml/System.Collections.Specialized/HybridDictionary.xml index 49b3bdc2613..846224337e1 100644 --- a/xml/System.Collections.Specialized/HybridDictionary.xml +++ b/xml/System.Collections.Specialized/HybridDictionary.xml @@ -574,9 +574,7 @@ ## Remarks This method is an O(1) operation. - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `key` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `key` to determine whether `item` exists. ## Examples The following code example searches for an element in a . diff --git a/xml/System.Collections.Specialized/ListDictionary.xml b/xml/System.Collections.Specialized/ListDictionary.xml index 637784c6f3f..7032a34b838 100644 --- a/xml/System.Collections.Specialized/ListDictionary.xml +++ b/xml/System.Collections.Specialized/ListDictionary.xml @@ -80,7 +80,7 @@ A key cannot be `null`, but a value can. The `foreach` statement of the C# language (`for each` in Visual Basic) returns an object of the type of the elements in the collection. Since each element of the is a key/value pair, the element type is not the type of the key or the type of the value. Instead, the element type is . For example: - + :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/ListDictionary/Overview/source2.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.ListDictionary2/VB/source2.vb" id="Snippet3"::: @@ -449,9 +449,7 @@ ## Remarks This method is an O(`n`) operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `key` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `key` to determine whether `item` exists. ## Examples The following code example searches for an element in a . diff --git a/xml/System.Collections.Specialized/OrderedDictionary.xml b/xml/System.Collections.Specialized/OrderedDictionary.xml index 0ef25e2e521..443255e8922 100644 --- a/xml/System.Collections.Specialized/OrderedDictionary.xml +++ b/xml/System.Collections.Specialized/OrderedDictionary.xml @@ -665,9 +665,7 @@ ## Remarks Using the property can return a null value if the key does not exist or if the key is `null`. Use the method to determine if a specific key exists in the collection. - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example demonstrates the modification of an collection. In this example, the method is used to determine if an entry exists before attempting to remove it. This code is part of a larger code example that can be viewed at . diff --git a/xml/System.Collections.Specialized/StringCollection.xml b/xml/System.Collections.Specialized/StringCollection.xml index 5eedbc11f3b..c40249d100a 100644 --- a/xml/System.Collections.Specialized/StringCollection.xml +++ b/xml/System.Collections.Specialized/StringCollection.xml @@ -81,7 +81,7 @@ ## Examples The following code example demonstrates several of the properties and methods of . - + :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/StringCollection/Overview/stringcollection.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.Specialized.StringCollection2/VB/stringcollection.vb" id="Snippet1"::: @@ -403,9 +403,7 @@ This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example searches the for an element. @@ -689,9 +687,7 @@ This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example searches the for an element. @@ -1460,7 +1456,7 @@ This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ]]> @@ -1526,7 +1522,7 @@ This method performs a linear search; therefore, this method is an O(`n`) operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ]]> diff --git a/xml/System.Collections.Specialized/StringDictionary.xml b/xml/System.Collections.Specialized/StringDictionary.xml index 566e8ca0531..9fd711f0277 100644 --- a/xml/System.Collections.Specialized/StringDictionary.xml +++ b/xml/System.Collections.Specialized/StringDictionary.xml @@ -86,7 +86,7 @@ ## Examples The following code example demonstrates several of the properties and methods of . - + :::code language="csharp" source="~/snippets/csharp/System.Collections.Specialized/StringDictionary/Overview/stringdictionary.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collection.Specialized.StringDictionary/VB/stringdictionary.vb" id="Snippet1"::: @@ -345,9 +345,7 @@ This method is an O(1) operation. - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example searches for an element in a . @@ -415,9 +413,7 @@ This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an O(`n`) operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example searches for an element in a . diff --git a/xml/System.Collections/ArrayList.xml b/xml/System.Collections/ArrayList.xml index 7700a460ee7..7ec51290172 100644 --- a/xml/System.Collections/ArrayList.xml +++ b/xml/System.Collections/ArrayList.xml @@ -1150,7 +1150,7 @@ This method is an `O(1)` operation. This method determines equality by calling . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. +This method uses the collection's objects' and methods on `item` to determine whether item exists. ]]> @@ -2012,9 +2012,7 @@ This method is an `O(1)` operation. This method determines equality by calling . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example shows how to determine the index of the first occurrence of a specified element. @@ -2092,9 +2090,7 @@ This method is an `O(1)` operation. This method determines equality by calling . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example shows how to determine the index of the first occurrence of a specified element. @@ -2176,9 +2172,7 @@ This method is an `O(1)` operation. This method determines equality by calling . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example shows how to determine the index of the first occurrence of a specified element. @@ -2785,9 +2779,7 @@ This method is an `O(1)` operation. This method performs a linear search; therefore, this method is an `O(n)` operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example shows how to determine the index of the last occurrence of a specified element. @@ -2865,9 +2857,7 @@ This method is an `O(1)` operation. This method determines equality by calling . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example shows how to determine the index of the last occurrence of a specified element. @@ -2949,9 +2939,7 @@ This method is an `O(1)` operation. This method determines equality by calling . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example shows how to determine the index of the last occurrence of a specified element. Note that `LastIndexOf` is a backward search; therefore, `count` must be less than or equal to `startIndex` + 1. diff --git a/xml/System.Collections/CollectionBase.xml b/xml/System.Collections/CollectionBase.xml index d13b6fd7f62..3d3a347664b 100644 --- a/xml/System.Collections/CollectionBase.xml +++ b/xml/System.Collections/CollectionBase.xml @@ -1662,9 +1662,7 @@ A instance is always modifiable. See . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example implements the class and uses that implementation to create a collection of objects. @@ -1733,9 +1731,7 @@ A instance is always modifiable. See . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example implements the class and uses that implementation to create a collection of objects. diff --git a/xml/System.Collections/DictionaryBase.xml b/xml/System.Collections/DictionaryBase.xml index 83828ed337f..4d84b5f2204 100644 --- a/xml/System.Collections/DictionaryBase.xml +++ b/xml/System.Collections/DictionaryBase.xml @@ -90,7 +90,7 @@ The C# [foreach](/dotnet/csharp/language-reference/keywords/foreach-in) statemen ## Examples The following code example implements the class and uses that implementation to create a dictionary of keys and values that have a of 5 characters or less. - + :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryBase/Overview/dictionarybase.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.DictionaryBase/VB/dictionarybase.vb" id="Snippet1"::: @@ -1559,9 +1559,7 @@ The C# [foreach](/dotnet/csharp/language-reference/keywords/foreach-in) statemen ## Remarks This method is an `O(1)` operation. - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `key` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `key` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `key` to determine whether `item` exists. ## Examples The following code example implements the class and uses that implementation to create a dictionary of keys and values that have a of 5 characters or less. diff --git a/xml/System.Collections/DictionaryEntry.xml b/xml/System.Collections/DictionaryEntry.xml index fc1cd812584..e9c5040d126 100644 --- a/xml/System.Collections/DictionaryEntry.xml +++ b/xml/System.Collections/DictionaryEntry.xml @@ -74,7 +74,7 @@ The We don't recommend that you use the `DictionaryEntry` structure for new development. Instead, we recommend that you use a generic structure along with the class. For more information, see [Non-generic collections shouldn't be used](https://github.com/dotnet/platform-compat/blob/master/docs/DE0006.md) on GitHub. The C# [foreach](/dotnet/csharp/language-reference/keywords/foreach-in) statement and the Visual Basic [For Each](/dotnet/visual-basic/language-reference/statements/for-each-next-statement) statement require the type of each element in the collection. Since each element of the is a key/value pair, the element type is not the type of the key or the type of the value. Instead, the element type is . For example: - + :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Overview/DictionaryEntrySample.cs" id="Snippet01"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.DictionaryEntry/vb/DictionaryEntrySample.vb" id="Snippet01"::: @@ -147,14 +147,7 @@ The The object defined in each key/value pair. The definition associated with . Initializes an instance of the type with the specified key and value. - - - + To be added. is and the .NET Framework version is 1.0 or 1.1. diff --git a/xml/System.Collections/Hashtable.xml b/xml/System.Collections/Hashtable.xml index b418bb4bb36..5cbacd7c9ee 100644 --- a/xml/System.Collections/Hashtable.xml +++ b/xml/System.Collections/Hashtable.xml @@ -2086,10 +2086,7 @@ Each element is a key/value pair stored in a and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following example shows how to determine whether the contains a specific element. @@ -2163,9 +2160,7 @@ Each element is a key/value pair stored in a and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following example shows how to determine whether the contains a specific element. @@ -2241,9 +2236,7 @@ Each element is a key/value pair stored in a . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following example shows how to determine whether the contains a specific element. diff --git a/xml/System.Collections/IDictionary.xml b/xml/System.Collections/IDictionary.xml index 53a43d820f6..cf45df9be17 100644 --- a/xml/System.Collections/IDictionary.xml +++ b/xml/System.Collections/IDictionary.xml @@ -73,7 +73,7 @@ implementations fall into three categories: read-only, fixed-size, variable-size. A read-only object cannot be modified. A fixed-size object does not allow the addition or removal of elements, but does allow the modification of existing elements. A variable-size object allows the addition, removal, and modification of elements. The `foreach` statement of the C# language (`For Each` in Visual Basic) returns an object of the type of the elements in the collection. Since each element of the object is a key/value pair, the element type is not the type of the key or the type of the value. Instead, the element type is . For example: - + :::code language="csharp" source="~/snippets/csharp/System.Collections/DictionaryEntry/Key/remarks.cs" id="Snippet14"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Dictionary/VB/remarks.vb" id="Snippet14"::: @@ -289,9 +289,7 @@ ## Remarks Implementations can vary in whether they allow the key to be `null`. - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether item exists. ## Examples The following code example demonstrates how to implement the method. This code example is part of a larger example provided for the class. diff --git a/xml/System.Collections/IList.xml b/xml/System.Collections/IList.xml index c87970d31bd..aa26790de39 100644 --- a/xml/System.Collections/IList.xml +++ b/xml/System.Collections/IList.xml @@ -61,21 +61,21 @@ Represents a non-generic collection of objects that can be individually accessed by index. - is a descendant of the interface and is the base interface of all non-generic lists. implementations fall into three categories: read-only, fixed-size, and variable-size. A read-only cannot be modified. A fixed-size does not allow the addition or removal of elements, but it allows the modification of existing elements. A variable-size allows the addition, removal, and modification of elements. - - For the generic version of this interface, see . - - - -## Examples - The following example demonstrates the implementation of the interface to create a simple, fixed-size list. - + is a descendant of the interface and is the base interface of all non-generic lists. implementations fall into three categories: read-only, fixed-size, and variable-size. A read-only cannot be modified. A fixed-size does not allow the addition or removal of elements, but it allows the modification of existing elements. A variable-size allows the addition, removal, and modification of elements. + + For the generic version of this interface, see . + + + +## Examples + The following example demonstrates the implementation of the interface to create a simple, fixed-size list. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet01"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet01"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet01"::: + ]]> @@ -131,20 +131,20 @@ Adds an item to the . The position into which the new element was inserted, or -1 to indicate that the item was not inserted into the collection. - interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. @@ -191,19 +191,19 @@ Removes all items from the . - and the capacity of a collection. Typically, the count is set to zero, and references to other objects from elements of the collection are also released. The capacity can be set to zero or a default value, or it can remain unchanged. - - - -## Examples - The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + and the capacity of a collection. Typically, the count is set to zero, and references to other objects from elements of the collection are also released. The capacity can be set to zero or a default value, or it can remain unchanged. + + + +## Examples + The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> The is read-only. @@ -258,19 +258,18 @@ if the is found in the ; otherwise, . - and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - - -## Examples - The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + and methods on `item` to determine whether item exists. + +## Examples + The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> @@ -323,19 +322,18 @@ Determines the index of a specific item in the . The index of if found in the list; otherwise, -1. - and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - - -## Examples - The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + and methods on `item` to determine whether item exists. + +## Examples + The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> @@ -389,29 +387,29 @@ The object to insert into the . Inserts an item to the at the specified index. - , then `value` is appended to the end. - - In collections of contiguous elements, such as lists, the elements that follow the insertion point move down to accommodate the new element. If the collection is indexed, the indexes of the elements that are moved are also updated. This behavior does not apply to collections where elements are conceptually grouped into buckets, such as a hash table. - - - -## Examples - The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + , then `value` is appended to the end. + + In collections of contiguous elements, such as lists, the elements that follow the insertion point move down to accommodate the new element. If the collection is indexed, the indexes of the elements that are moved are also updated. This behavior does not apply to collections where elements are conceptually grouped into buckets, such as a hash table. + + + +## Examples + The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> is not a valid index in the . - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. is null reference in the . @@ -461,19 +459,19 @@ if the has a fixed size; otherwise, . - interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> @@ -522,19 +520,19 @@ if the is read-only; otherwise, . - interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> @@ -587,21 +585,21 @@ Gets or sets the element at the specified index. The element at the specified index. - property. Visual Basic implements as a default property, which provides the same indexing functionality. - - - -## Examples - The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + property. Visual Basic implements as a default property, which provides the same indexing functionality. + + + +## Examples + The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> @@ -656,25 +654,25 @@ The object to remove from the . Removes the first occurrence of a specific object from the . - , the remains unchanged and no exception is thrown. - - - -## Examples - The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + , the remains unchanged and no exception is thrown. + + + +## Examples + The following example demonstrates the implementation of the interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. If is not in the list, the method should do nothing. In particular, it should not throw an exception. @@ -727,27 +725,27 @@ The zero-based index of the item to remove. Removes the item at the specified index. - interface to create a simple, fixed-size list. This code is part of a larger example for the interface. - + interface to create a simple, fixed-size list. This code is part of a larger example for the interface. + :::code language="csharp" source="~/snippets/csharp/System.Collections/IList/Overview/Program.cs" id="Snippet02"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Collections.IList_Implementation/vb/Program.vb" id="Snippet02"::: + ]]> is not a valid index in the . - The is read-only. - - -or- - + The is read-only. + + -or- + The has a fixed size. diff --git a/xml/System.Collections/Queue.xml b/xml/System.Collections/Queue.xml index 0aaa43694a5..0d210bf6695 100644 --- a/xml/System.Collections/Queue.xml +++ b/xml/System.Collections/Queue.xml @@ -115,7 +115,7 @@ This class implements a queue as a circular array. Objects stored in a and how to print out its values. - + :::code language="csharp" source="~/snippets/csharp/System.Collections/Queue/Overview/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Queue Example/VB/source.vb" id="Snippet1"::: @@ -545,7 +545,7 @@ This class implements a queue as a circular array. Objects stored in a . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `obj` to determine whether `item` exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `obj` parameter on the objects in the collection. +This method uses the collection's objects' and methods on `obj` to determine whether `item` exists. ]]> diff --git a/xml/System.Collections/SortedList.xml b/xml/System.Collections/SortedList.xml index c37013f9805..ea1b15f5809 100644 --- a/xml/System.Collections/SortedList.xml +++ b/xml/System.Collections/SortedList.xml @@ -112,7 +112,7 @@ A element can be accessed by its key, like Elements in this collection can be accessed using an integer index. Indexes in this collection are zero-based. The `foreach` statement of the C# language (`for each` in Visual Basic) returns an object of the type of the elements in the collection. Since each element of the object is a key/value pair, the element type is not the type of the key or the type of the value. Rather, the element type is . For example: - + :::code language="csharp" source="~/snippets/csharp/System.Collections/SortedList/Overview/remarks.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic SortedList Example/VB/remarks.vb" id="Snippet2"::: @@ -950,9 +950,7 @@ A element can be accessed by its key, like This method uses a binary search algorithm; therefore, this method is an `O(log n)` operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example shows how to determine whether a object contains a specific element. @@ -1025,9 +1023,7 @@ A element can be accessed by its key, like This method uses a binary search algorithm; therefore, this method is an `O(log n)` operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example shows how to determine whether a object contains a specific element. @@ -1100,9 +1096,7 @@ A element can be accessed by its key, like This method performs a linear search; therefore, the average execution time is proportional to . That is, this method is an `O(n)` operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example shows how to determine whether a object contains a specific element. @@ -1658,9 +1652,7 @@ A element can be accessed by its key, like This method uses a binary search algorithm; therefore, this method is an `O(log n)` operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example shows how to determine the index of a key or a value in a object. @@ -1733,9 +1725,7 @@ A element can be accessed by its key, like This method uses a linear search; therefore, this method is an `O(n)` operation, where `n` is . - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples The following code example shows how to determine the index of a key or a value in a object. diff --git a/xml/System.Collections/Stack.xml b/xml/System.Collections/Stack.xml index 7cb407c243d..e6e4664d771 100644 --- a/xml/System.Collections/Stack.xml +++ b/xml/System.Collections/Stack.xml @@ -101,7 +101,7 @@ If is less than the capacity of the sta ## Examples The following example shows how to create and add values to a Stack and how to display its values. - + :::code language="csharp" source="~/snippets/csharp/System.Collections/Stack/Overview/source.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_Classic/classic Stack Example/VB/source.vb" id="Snippet1"::: @@ -463,7 +463,7 @@ If is less than the capacity of the sta This method performs a linear search; therefore, this method is an `O(n)` operation, where `n` is . - Starting with the .NET Framework 2.0, this method tests for equality by passing the `obj` argument to the method of individual objects in the collection. In the earlier versions of the .NET Framework, this determination was made by using passing the individual items in the collection to the method of the `obj` argument. +This method tests for equality by passing the `obj` argument to the method of individual objects in the collection. ]]> diff --git a/xml/System.Configuration/IConfigurationSectionHandler.xml b/xml/System.Configuration/IConfigurationSectionHandler.xml index f410324b070..366cd745abc 100644 --- a/xml/System.Configuration/IConfigurationSectionHandler.xml +++ b/xml/System.Configuration/IConfigurationSectionHandler.xml @@ -36,9 +36,7 @@ ## Remarks > [!IMPORTANT] - > is deprecated in .NET Framework 2.0 and above. But, because it is used internally, it has been kept. You can find an example at [How to: Create Custom Configuration Sections Using IConfigurationSectionHandler](https://learn.microsoft.com/previous-versions/aspnet/ms228056(v=vs.100)). If you use the previous example, please build it with the .NET Framework version 1.0 or 1.1. - - In .NET Framework version 2.0 and above, you must instead derive from the class to implement the related configuration section handler. You can find an example at [How to: Create Custom Configuration Sections Using ConfigurationSection](https://learn.microsoft.com/previous-versions/aspnet/2tw134k3(v=vs.100)). + > is deprecated starting in .NET Framework 2.0. In .NET Framework version 2.0 and later, you must instead derive from the class to implement the related configuration section handler. You can find an example at [How to: Create Custom Configuration Sections Using ConfigurationSection](https://learn.microsoft.com/previous-versions/aspnet/2tw134k3(v=vs.100)). Instances of the class must be thread safe and stateless. The method must be callable from multiple threads simultaneously. diff --git a/xml/System.Configuration/IdnElement.xml b/xml/System.Configuration/IdnElement.xml index 7c69dace16e..c06e473e131 100644 --- a/xml/System.Configuration/IdnElement.xml +++ b/xml/System.Configuration/IdnElement.xml @@ -32,19 +32,19 @@ Provides the configuration setting for International Domain Name (IDN) processing in the class. - class has been extended to provide support for International Resource Identifiers (IRI) based on RFC 3987. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. - - The configuration setting for the is indirectly controlled by the configuration setting that controls IRI processing in the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. - - The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. - - The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. - - For more information on IRI support, see the Remarks section for the class. - + class has been extended to provide support for International Resource Identifiers (IRI) based on RFC 3987. Users upgrading from .NET Framework 2.0 won't see any change in behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of .NET Framework. + + The configuration setting for the is indirectly controlled by the configuration setting that controls IRI processing in the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. + + The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. + + The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. + + For more information on IRI support, see the Remarks section for the class. + ]]> @@ -79,11 +79,11 @@ Initializes a new instance of the class. - instance - + instance + ]]> @@ -125,17 +125,17 @@ Gets or sets the value of the configuration setting. A that contains the current configuration setting for IDN processing. - is indirectly controlled by the configuration setting that controls IRI processing in the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. - - The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. - - For more information on IRI support, see the Remarks section for the class. - + is indirectly controlled by the configuration setting that controls IRI processing in the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. + + The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. + + For more information on IRI support, see the Remarks section for the class. + ]]> diff --git a/xml/System.Configuration/IriParsingElement.xml b/xml/System.Configuration/IriParsingElement.xml index 13e79a4f203..3478e8776a4 100644 --- a/xml/System.Configuration/IriParsingElement.xml +++ b/xml/System.Configuration/IriParsingElement.xml @@ -32,15 +32,15 @@ Provides the configuration setting for International Resource Identifier (IRI) processing in the class. - class has been extended to provide support for International Resource Identifiers (IRI) based on RFC 3987. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. - - The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. - - For more information on IRI support, see the Remarks section for the class. - + class has been extended to provide support for International Resource Identifiers (IRI) based on RFC 3987. Users upgrading from .NET Framework 2.0 won't see any change in behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. + + The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. + + For more information on IRI support, see the Remarks section for the class. + ]]> @@ -75,11 +75,11 @@ Initializes a new instance of the class. - instance. - + instance. + ]]> @@ -121,15 +121,15 @@ Gets or sets the value of the configuration setting. A Boolean that indicates if International Resource Identifier (IRI) processing is enabled. - configuration setting controls IRI processing in the class. This setting also indirectly controls International Domain Name (IDN) processing set with the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. - - The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. - - For more information on IRI support, see the Remarks section for the class. - + configuration setting controls IRI processing in the class. This setting also indirectly controls International Domain Name (IDN) processing set with the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. + + The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. + + For more information on IRI support, see the Remarks section for the class. + ]]> diff --git a/xml/System.Configuration/UriSection.xml b/xml/System.Configuration/UriSection.xml index 312b6db77e5..b4c24629786 100644 --- a/xml/System.Configuration/UriSection.xml +++ b/xml/System.Configuration/UriSection.xml @@ -33,13 +33,13 @@ Represents the Uri section within a configuration file. - class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI and IDN. This ensures application compatibility with prior versions of the .NET Framework. - - The configuration settings for IRI and IDN can be retrieved using the class. - + class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names. Users upgrading from .NET Framework 2.0 won't see any change in behavior unless they specifically enable IRI and IDN. This ensures application compatibility with prior versions of the .NET Framework. + + The configuration settings for IRI and IDN can be retrieved using the class. + ]]> Network Settings Schema @@ -78,15 +78,15 @@ Initializes a new instance of the class. - class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI and IDN. This ensures application compatibility with prior versions of the .NET Framework. - - The configuration settings for IRI and IDN can be retrieved using the class. - - For more information on IRI support, see the Remarks section for the class. - + class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names. Users upgrading from .NET Framework 2.0 won't see any change in behavior unless they specifically enable IRI and IDN. This ensures application compatibility with prior versions of the .NET Framework. + + The configuration settings for IRI and IDN can be retrieved using the class. + + For more information on IRI support, see the Remarks section for the class. + ]]> @@ -128,21 +128,21 @@ Gets an object that contains the configuration setting for International Domain Name (IDN) processing in the class. The configuration setting for International Domain Name (IDN) processing in the class. - class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI and IDN. This ensures application compatibility with prior versions of the .NET Framework. - - The configuration settings for IRI and IDN can be retrieved using the class. The property returns the configuration setting for IDN processing in the class. - - IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. - - The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. - - The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. - - For more information on IRI support, see the Remarks section for the class. - + class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names. Users upgrading from .NET Framework 2.0 won't see any change in behavior unless they specifically enable IRI and IDN. This ensures application compatibility with prior versions of the .NET Framework. + + The configuration settings for IRI and IDN can be retrieved using the class. The property returns the configuration setting for IDN processing in the class. + + IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. + + The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. + + The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. + + For more information on IRI support, see the Remarks section for the class. + ]]> @@ -188,21 +188,21 @@ Gets an object that contains the configuration setting for International Resource Identifiers (IRI) parsing in the class. The configuration setting for International Resource Identifiers (IRI) parsing in the class. - class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI and IDN. This ensures application compatibility with prior versions of the .NET Framework. - - The configuration settings for IRI and IDN can be retrieved using the class. The property returns the configuration setting for IRI parsing in the class. - - IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. - - The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. - - The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. - - For more information on IRI support, see the Remarks section for the class. - + class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names. Users upgrading from .NET Framework 2.0 won't see any change in behavior unless they specifically enable IRI and IDN. This ensures application compatibility with prior versions of the .NET Framework. + + The configuration settings for IRI and IDN can be retrieved using the class. The property returns the configuration setting for IRI parsing in the class. + + IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. + + The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. + + The configuration setting for the will be read once when the first class is constructed. Changes to configuration settings after that time are ignored. + + For more information on IRI support, see the Remarks section for the class. + ]]> @@ -289,11 +289,11 @@ Gets a object that contains the configuration settings for scheme parsing in the class. The configuration settings for scheme parsing in the class. - property is not generic. Only the genericUriParserOptions="DontUnescapePathDotsAndSlashes" configuration setting for HTTP and HTTPS schemes are supported. All other settings are ignored. - + property is not generic. Only the genericUriParserOptions="DontUnescapePathDotsAndSlashes" configuration setting for HTTP and HTTPS schemes are supported. All other settings are ignored. + ]]> diff --git a/xml/System.Data.Design/TypedDataSetSchemaImporterExtension.xml b/xml/System.Data.Design/TypedDataSetSchemaImporterExtension.xml index 3562fbcc11c..9be7e120f16 100644 --- a/xml/System.Data.Design/TypedDataSetSchemaImporterExtension.xml +++ b/xml/System.Data.Design/TypedDataSetSchemaImporterExtension.xml @@ -17,11 +17,11 @@ Generates internal mappings to .NET types for XML schema element declarations, including literal XSD message parts in a WSDL document. - to provide additional functionality for typed datasets. - + to provide additional functionality for typed datasets. + ]]> @@ -34,11 +34,11 @@ Initializes a new instance of the class. - to provide additional functionality for typed datasets and generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document. - + to provide additional functionality for typed datasets and generates internal mappings to .NET types for XML schema element declarations, including literal XSD message parts in a WSDL document. + ]]> @@ -65,11 +65,11 @@ Initializes a new instance of the class. - to provide additional functionality for typed datasets and generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document. - + to provide additional functionality for typed datasets and generates internal mappings to .NET types for XML schema element declarations, including literal XSD message parts in a WSDL document. + ]]> @@ -94,11 +94,11 @@ The value for generating typed datasets that enable LINQ to DataSet and Hierarchical Update. Initializes a new instance of the class. - value to the . - + value to the . + ]]> @@ -111,11 +111,11 @@ Generates internal type mapping information for an element defined in an XML schema document. - to provide additional functionality for typed datasets and generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document. - + to provide additional functionality for typed datasets and generates internal mappings to .NET types for XML schema element declarations, including literal XSD message parts in a WSDL document. + ]]> @@ -150,22 +150,22 @@ The XML schema type. An that represents the root class for the Xml schema object model hierarchy and serves as a base class for classes such as the XmlSchema class. An class that represents a collection of XML schemas. - The base that generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document. + The base that generates internal mappings to .NET types for XML schema element declarations, including literal XSD message parts in a WSDL document. The to contain the generated code. The main namespace. - The that specifies various options to use when generating .NET Framework types for use with an XML Web service. + The that specifies various options to use when generating .NET types for use with an XML Web service. The language specific to use to generate the dataset. Generates internal type mapping information for an element defined in an XML schema document. A string representing the name of the typed dataset class. - to provide additional functionality for typed datasets and generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document. - + + Expands upon the to provide additional functionality for typed datasets and generates internal mappings to .NET types for XML schema element declarations, including literal XSD message parts in a WSDL document. + ]]> @@ -202,22 +202,22 @@ A representing the namespace of the XML schema. An that represents the root class for the XML schema object model hierarchy and serves as a base class for classes such as the XmlSchema class. An class that represents a collection of XML schemas. - The base that generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document. + The base that generates internal mappings to .NET types for XML schema element declarations, including literal XSD message parts in a WSDL document. The to contain the generated code. The that contains the generated dataset. - The that specifies various options to use when generating .NET Framework types for use with an XML Web service. + The that specifies various options to use when generating .NET types for use with an XML Web service. The language specific to use to generate the dataset. Generates internal type mapping information for an element defined in an XML schema document. A representing the name of the typed dataset class. - to provide additional functionality for typed datasets and generates internal mappings to .NET Framework types for XML schema element declarations, including literal XSD message parts in a WSDL document. - + + Expands upon the to provide additional functionality for typed datasets and generates internal mappings to .NET types for XML schema element declarations, including literal XSD message parts in a WSDL document. + ]]> diff --git a/xml/System.Data.Odbc/OdbcType.xml b/xml/System.Data.Odbc/OdbcType.xml index a4ba827eb9b..1fb8af18faf 100644 --- a/xml/System.Data.Odbc/OdbcType.xml +++ b/xml/System.Data.Odbc/OdbcType.xml @@ -32,11 +32,11 @@ Specifies the data type of a field, property, for use in an . - data types, ODBC data types (shown in parentheses), and .NET Framework types. - + data types, ODBC data types (shown in parentheses), and .NET types. + ]]> diff --git a/xml/System.Data.OleDb/OleDbConnection.xml b/xml/System.Data.OleDb/OleDbConnection.xml index 110e37c18c5..a4760aac031 100644 --- a/xml/System.Data.OleDb/OleDbConnection.xml +++ b/xml/System.Data.OleDb/OleDbConnection.xml @@ -1478,15 +1478,12 @@ method of the object. +The following are allowed state changes: +- From `Closed` to `Open`, using the method of the object. - From `Open` to `Closed`, using either the method or the **Dispose** method of the object. -> [!NOTE] -> In previous version of the .NET Framework, calling the property increased application overhead because each call caused a call to the OLE DB DBPROP_CONNECTIONSTATUS property for an open connection. With the release of the .NET Framework 2.0, this is no longer an issue. - ]]> Connecting to Data Sources diff --git a/xml/System.Data.OleDb/OleDbDataReader.xml b/xml/System.Data.OleDb/OleDbDataReader.xml index d4241dbd779..19aa6def502 100644 --- a/xml/System.Data.OleDb/OleDbDataReader.xml +++ b/xml/System.Data.OleDb/OleDbDataReader.xml @@ -57,25 +57,25 @@ Provides a way of reading a forward-only stream of data rows from a data source. This class cannot be inherited. - , you must call the method of the object, instead of directly using a constructor. - - Before you close the , first close the object. You must also close the object if you plan to resuse an object.For example, you cannot retrieve output parameters until after you call . - - Changes made to a result set by another process or thread while data is being read may be visible to the user of the . However, the precise behavior is timing dependent. - - and are the only properties that you can call after the is closed. Although the property may be accessed while the exists, always call before returning the value of to guarantee an accurate return value. - - - -## Examples - The following example creates an , an , and an . The example reads through the data, writing it out to the console. Finally, the example closes the and then the . - + , you must call the method of the object, instead of directly using a constructor. + + Before you close the , first close the object. You must also close the object if you plan to resuse an object.For example, you cannot retrieve output parameters until after you call . + + Changes made to a result set by another process or thread while data is being read may be visible to the user of the . However, the precise behavior is timing dependent. + + and are the only properties that you can call after the is closed. Although the property may be accessed while the exists, always call before returning the value of to guarantee an accurate return value. + + + +## Examples + The following example creates an , an , and an . The example reads through the data, writing it out to the console. Finally, the example closes the and then the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbDataReader Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbDataReader Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbDataReader Example/VB/source.vb" id="Snippet1"::: + ]]> DataAdapters and DataReaders @@ -114,22 +114,22 @@ Closes the object. - method when you are through using the to use the associated for any other purpose. - + method when you are through using the to use the associated for any other purpose. + > [!CAUTION] -> Do not call **Close** or **Dispose** on a Connection, a DataReader, or any other managed object in the **Finalize** method of your class. In a finalizer, you should only release unmanaged resources that your class owns directly. If your class does not own any unmanaged resources, do not include a **Finalize** method in your class definition. For more information, see [Garbage Collection](/dotnet/standard/garbage-collection/). - - - -## Examples - The following example creates an , an , and an . The example reads through the data, writing it out to the console. Finally, the example closes the , and then the . - +> Do not call **Close** or **Dispose** on a Connection, a DataReader, or any other managed object in the **Finalize** method of your class. In a finalizer, you should only release unmanaged resources that your class owns directly. If your class does not own any unmanaged resources, do not include a **Finalize** method in your class definition. For more information, see [Garbage Collection](/dotnet/standard/garbage-collection/). + + + +## Examples + The following example creates an , an , and an . The example reads through the data, writing it out to the console. Finally, the example closes the , and then the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData IDataReader.Read Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData IDataReader.Read Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData IDataReader.Read Example/VB/source.vb" id="Snippet1"::: + ]]> DataAdapters and DataReaders @@ -166,11 +166,11 @@ Gets a value that indicates the depth of nesting for the current row. The depth of nesting for the current row. - DataAdapters and DataReaders @@ -207,13 +207,13 @@ Gets the number of columns in the current row. When not positioned in a valid recordset, 0; otherwise the number of columns in the current record. The default is -1. - to exclude hidden fields. - - After executing a query that does not return rows, returns 0. - + to exclude hidden fields. + + After executing a query that does not return rows, returns 0. + ]]> There is no current connection to a data source. @@ -281,13 +281,13 @@ Gets the value of the specified column as a Boolean. The value of the column. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -331,13 +331,13 @@ Gets the value of the specified column as a byte. The value of the specified column as a byte. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -390,15 +390,15 @@ Reads a stream of bytes from the specified column offset into the buffer as an array starting at the given buffer offset. The actual number of bytes read. - returns the number of available bytes in the field. Most of the time this is the exact length of the field. However, the number returned may be less than the true length of the field if `GetBytes` has already been used to obtain bytes from the field. This may be the case, for example, when the is reading a large data structure into a buffer. For more information, see the `SequentialAccess` setting for . - - If you pass a buffer that is `null`, returns the length of the field in bytes. - - No conversions are performed; therefore, the data retrieved must already be a byte array. - + returns the number of available bytes in the field. Most of the time this is the exact length of the field. However, the number returned may be less than the true length of the field if `GetBytes` has already been used to obtain bytes from the field. This may be the case, for example, when the is reading a large data structure into a buffer. For more information, see the `SequentialAccess` setting for . + + If you pass a buffer that is `null`, returns the length of the field in bytes. + + No conversions are performed; therefore, the data retrieved must already be a byte array. + ]]> DataAdapters and DataReaders @@ -447,11 +447,11 @@ Gets the value of the specified column as a character. The value of the specified column. - . - + . + ]]> The specified cast is not valid. @@ -504,15 +504,15 @@ Reads a stream of characters from the specified column offset into the buffer as an array starting at the given buffer offset. The actual number of characters read. - returns the number of available characters in the field. Most of the time this is the exact length of the field. However, the number returned may be less than the true length of the field if `GetChars` has already been used to obtain characters from the field. This may be the case, for example, when the is reading a large data structure into a buffer. For more information, see the `SequentialAccess` setting for . - - If you pass a buffer that is `null`, returns the length of the field in characters. - - No conversions are performed; therefore, the data retrieved must already be a character array. - + returns the number of available characters in the field. Most of the time this is the exact length of the field. However, the number returned may be less than the true length of the field if `GetChars` has already been used to obtain characters from the field. This may be the case, for example, when the is reading a large data structure into a buffer. For more information, see the `SequentialAccess` setting for . + + If you pass a buffer that is `null`, returns the length of the field in characters. + + No conversions are performed; therefore, the data retrieved must already be a character array. + ]]> DataAdapters and DataReaders @@ -554,11 +554,11 @@ Returns an object for the requested column ordinal. An object. - will call if the provider returns a that has a column that supports . - + will call if the provider returns a that has a column that supports . + ]]> DataAdapters and DataReaders @@ -641,13 +641,13 @@ Gets the value of the specified column as a object. The value of the specified column. - object. - - Call to look for null values before calling this method. - + object. + + Call to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -721,13 +721,13 @@ Gets the value of the specified column as a object. The value of the specified column. - object. - - Call to look for null values before calling this method. - + object. + + Call to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -771,13 +771,13 @@ Gets the value of the specified column as a double-precision floating-point number. The value of the specified column. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -809,11 +809,11 @@ Returns an that can be used to iterate through the rows in the data reader. An that can be used to iterate through the rows in the data reader. - DataAdapters and DataReaders @@ -896,13 +896,13 @@ Gets the value of the specified column as a single-precision floating-point number. The value of the specified column. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -946,13 +946,13 @@ Gets the value of the specified column as a globally unique identifier (GUID). The value of the specified column. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -996,13 +996,13 @@ Gets the value of the specified column as a 16-bit signed integer. The value of the specified column. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -1046,13 +1046,13 @@ Gets the value of the specified column as a 32-bit signed integer. The value of the specified column. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -1096,13 +1096,13 @@ Gets the value of the specified column as a 64-bit signed integer. The value of the specified column. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -1186,23 +1186,23 @@ Gets the column ordinal, given the name of the column. The zero-based column ordinal. - performs a case-sensitive lookup first. If it fails, a second case-insensitive search is made. The method throws an `IndexOutOfRange` exception if the zero-based column ordinal is not found. - - is kana-width insensitive. - - Because ordinal-based lookups are more efficient than named lookups, it is inefficient to call within a loop. Save time by calling one time and assigning the results to an integer variable for use within the loop. - - - -## Examples - The following example demonstrates how to use the method. - + performs a case-sensitive lookup first. If it fails, a second case-insensitive search is made. The method throws an `IndexOutOfRange` exception if the zero-based column ordinal is not found. + + is kana-width insensitive. + + Because ordinal-based lookups are more efficient than named lookups, it is inefficient to call within a loop. Save time by calling one time and assigning the results to an integer variable for use within the loop. + + + +## Examples + The following example demonstrates how to use the method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData OleDbDataReader.GetOrdinal/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbDataReader.GetOrdinal/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData OleDbDataReader.GetOrdinal/VB/source.vb" id="Snippet1"::: + ]]> The name specified is not a valid column name. @@ -1244,35 +1244,35 @@ Returns a that describes the column metadata of the . A that describes the column metadata. - method maps to the OLE DB **IColumnsRowset::GetColumnsRowset** method, and returns metadata about each column in the following order: - -|DataReader column|OLE DB column ID|Description| -|-----------------------|----------------------|-----------------| -|ColumnName|DBCOLUMN_NAME|The name of the column; this might not be unique. If this cannot be determined, a null value is returned. This name always reflects the most recent renaming of the column in the current view or command text.| -|ColumnOrdinal|DBCOLUMN_NUMBER|The zero-based ordinal of the column. This column cannot contain a null value.| -|ColumnSize|DBCOLUMN_COLUMNSIZE|The maximum possible length of a value in the column. For columns that use a fixed-length data type, this is the size of the data type.| -|NumericPrecision|DBCOLUMN_PRECISION|If DbType is a numeric data type, this is the maximum precision of the column. The precision of columns with a data type of DBTYPE_DECIMAL or DBTYPE_NUMERIC depends on the definition of the column. If DbType is not a numeric data type, this is a null value.| -|NumericScale|DBCOLUMN_SCALE|If DbType is DBTYPE_DECIMAL or DBTYPE_NUMERIC, this is the number of digits to the right of the decimal point. Otherwise, this is a null value.| -|DataType|None|Maps to the .NET Framework type of the column.| -|ProviderType|DBCOLUMN_TYPE|The indicator of the column's data type. If the data type of the column varies from row to row, this must be DBTYPE_VARIANT. This column cannot contain a null value.| -|IsLong|DBCOLUMNFLAGS_ISLONG|The provider sets DBCOLUMNFLAGS_ISLONG if the column contains a Binary Long Object (BLOB) that contains very long data. The definition of very long data is provider-specific. The setting of this flag corresponds to the value of the IS_LONG column in the PROVIDER_TYPES rowset for the data type.| -|AllowDBNull|DBCOLUMNFLAGS_ISNULLABLE|The provider sets DBCOLUMNFLAGS_ISNULLABLE if the consumer can set the column to a null value, or if the provider cannot determine whether the consumer can set the column to a null value. A column may contain null values, even if it cannot be set to a null value.| -|IsReadOnly|DBCOLUMNFLAGS_WRITE|`true` if the column cannot be modified; otherwise `false`. The column is assumed to be writable if the provider has set either the DBCOLUMNFLAGS_WRITE or DBCOLUMNFLAGS_WRITEUNKNOWN flag.| -|IsRowVersion|DBCOLUMNFLAGS_ISROWID|The provider sets DBCOLUMNFLAGS_ISROWID if the column contains a persistent row identifier that cannot be written to, and has no meaningful value except to identity the row.| -|IsUnique|DBCOLUMN_ISUNIQUE|VARIANT_TRUE: No two rows in the base table-the table returned in BaseTableName-can have the same value in this column. IsUnique is guaranteed to be VARIANT_TRUE if the column represents a key by itself or if there is a constraint of type UNIQUE that applies only to this column.

VARIANT_FALSE: The column can contain duplicate values in the base table. The default of this column is VARIANT_FALSE.| -|IsKey|DBCOLUMN_KEYCOLUMN|VARIANT_TRUE: The column is one of a set of columns in the rowset that, taken together, uniquely identify the row. The set of columns with IsKey set to VARIANT_TRUE must uniquely identify a row in the rowset. There is no requirement that this set of columns is a minimal set of columns. This set of columns may be generated from a base table primary key, a unique constraint or a unique index.

VARIANT_FALSE: The column is not required to uniquely identify the row.| -|IsAutoIncrement|DBCOLUMN_ISAUTOINCREMENT|VARIANT_TRUE: The column assigns values to new rows in fixed increments.

VARIANT_FALSE: The column does not assign values to new rows in fixed increments. The default of this column is VARIANT_FALSE.| -|BaseSchemaName|DBCOLUMN_BASESCHEMANAME|The name of the schema in the data store that contains the column. A null value if the base schema name cannot be determined. The default of this column is a null value.| -|BaseCatalogName|DBCOLUMN_BASECATALOGNAME|The name of the catalog in the data store that contains the column. A null value if the base catalog name cannot be determined. The default of this column is a null value.| -|BaseTableName|DBCOLUMN_BASETABLENAME|The name of the table or view in the data store that contains the column. A null value if the base table name cannot be determined. The default of this column is a null value.| -|BaseColumnName|DBCOLUMN_BASECOLUMNNAME|The name of the column in the data store. This might be different from the column name returned in the ColumnName column if an alias was used. A null value if the base column name cannot be determined or if the rowset column is derived, but not identical to, a column in the data store. The default of this column is a null value.| - + method maps to the OLE DB **IColumnsRowset::GetColumnsRowset** method, and returns metadata about each column in the following order: + +|DataReader column|OLE DB column ID|Description| +|-----------------------|----------------------|-----------------| +|ColumnName|DBCOLUMN_NAME|The name of the column; this might not be unique. If this cannot be determined, a null value is returned. This name always reflects the most recent renaming of the column in the current view or command text.| +|ColumnOrdinal|DBCOLUMN_NUMBER|The zero-based ordinal of the column. This column cannot contain a null value.| +|ColumnSize|DBCOLUMN_COLUMNSIZE|The maximum possible length of a value in the column. For columns that use a fixed-length data type, this is the size of the data type.| +|NumericPrecision|DBCOLUMN_PRECISION|If DbType is a numeric data type, this is the maximum precision of the column. The precision of columns with a data type of DBTYPE_DECIMAL or DBTYPE_NUMERIC depends on the definition of the column. If DbType is not a numeric data type, this is a null value.| +|NumericScale|DBCOLUMN_SCALE|If DbType is DBTYPE_DECIMAL or DBTYPE_NUMERIC, this is the number of digits to the right of the decimal point. Otherwise, this is a null value.| +|DataType|None|Maps to the .NET type of the column.| +|ProviderType|DBCOLUMN_TYPE|The indicator of the column's data type. If the data type of the column varies from row to row, this must be DBTYPE_VARIANT. This column cannot contain a null value.| +|IsLong|DBCOLUMNFLAGS_ISLONG|The provider sets DBCOLUMNFLAGS_ISLONG if the column contains a Binary Long Object (BLOB) that contains very long data. The definition of very long data is provider-specific. The setting of this flag corresponds to the value of the IS_LONG column in the PROVIDER_TYPES rowset for the data type.| +|AllowDBNull|DBCOLUMNFLAGS_ISNULLABLE|The provider sets DBCOLUMNFLAGS_ISNULLABLE if the consumer can set the column to a null value, or if the provider cannot determine whether the consumer can set the column to a null value. A column may contain null values, even if it cannot be set to a null value.| +|IsReadOnly|DBCOLUMNFLAGS_WRITE|`true` if the column cannot be modified; otherwise `false`. The column is assumed to be writable if the provider has set either the DBCOLUMNFLAGS_WRITE or DBCOLUMNFLAGS_WRITEUNKNOWN flag.| +|IsRowVersion|DBCOLUMNFLAGS_ISROWID|The provider sets DBCOLUMNFLAGS_ISROWID if the column contains a persistent row identifier that cannot be written to, and has no meaningful value except to identity the row.| +|IsUnique|DBCOLUMN_ISUNIQUE|VARIANT_TRUE: No two rows in the base table-the table returned in BaseTableName-can have the same value in this column. IsUnique is guaranteed to be VARIANT_TRUE if the column represents a key by itself or if there is a constraint of type UNIQUE that applies only to this column.

VARIANT_FALSE: The column can contain duplicate values in the base table. The default of this column is VARIANT_FALSE.| +|IsKey|DBCOLUMN_KEYCOLUMN|VARIANT_TRUE: The column is one of a set of columns in the rowset that, taken together, uniquely identify the row. The set of columns with IsKey set to VARIANT_TRUE must uniquely identify a row in the rowset. There is no requirement that this set of columns is a minimal set of columns. This set of columns may be generated from a base table primary key, a unique constraint or a unique index.

VARIANT_FALSE: The column is not required to uniquely identify the row.| +|IsAutoIncrement|DBCOLUMN_ISAUTOINCREMENT|VARIANT_TRUE: The column assigns values to new rows in fixed increments.

VARIANT_FALSE: The column does not assign values to new rows in fixed increments. The default of this column is VARIANT_FALSE.| +|BaseSchemaName|DBCOLUMN_BASESCHEMANAME|The name of the schema in the data store that contains the column. A null value if the base schema name cannot be determined. The default of this column is a null value.| +|BaseCatalogName|DBCOLUMN_BASECATALOGNAME|The name of the catalog in the data store that contains the column. A null value if the base catalog name cannot be determined. The default of this column is a null value.| +|BaseTableName|DBCOLUMN_BASETABLENAME|The name of the table or view in the data store that contains the column. A null value if the base table name cannot be determined. The default of this column is a null value.| +|BaseColumnName|DBCOLUMN_BASECOLUMNNAME|The name of the column in the data store. This might be different from the column name returned in the ColumnName column if an alias was used. A null value if the base column name cannot be determined or if the rowset column is derived, but not identical to, a column in the data store. The default of this column is a null value.| + > [!NOTE] -> To make sure that metadata columns return the correct information, you must call with the `behavior` parameter set to `KeyInfo`. Otherwise, some of the columns in the schema table may return default, null, or incorrect data. - +> To make sure that metadata columns return the correct information, you must call with the `behavior` parameter set to `KeyInfo`. Otherwise, some of the columns in the schema table may return default, null, or incorrect data. + ]]> The is closed. @@ -1316,13 +1316,13 @@ Gets the value of the specified column as a string. The value of the specified column. - to look for null values before calling this method. - + to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -1358,13 +1358,13 @@ Gets the value of the specified column as a object. The value of the specified column. - object. - - Call to look for null values before calling this method. - + object. + + Call to look for null values before calling this method. + ]]> The specified cast is not valid. @@ -1408,11 +1408,11 @@ Gets the value of the column at the specified ordinal in its native format. The value to return. - for null database columns. - + for null database columns. + ]]> DataAdapters and DataReaders @@ -1455,21 +1455,21 @@ Populates an array of objects with the column values of the current row. The number of instances of in the array. - method provides an efficient means for retrieving all columns, instead of retrieving each column individually. - - You can pass an array that contains fewer than the number of columns that are contained in the resulting row. Only the amount of data the array holds is copied to the array. You can also pass an array whose length is more than the number of columns that are contained in the resulting row. - - This method returns for null database columns. - - - -## Examples + method provides an efficient means for retrieving all columns, instead of retrieving each column individually. + + You can pass an array that contains fewer than the number of columns that are contained in the resulting row. Only the amount of data the array holds is copied to the array. You can also pass an array whose length is more than the number of columns that are contained in the resulting row. + + This method returns for null database columns. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/oledbdatareader_getvalues/cs/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/oledbdatareader_getvalues/vb/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/oledbdatareader_getvalues/vb/source.vb" id="Snippet1"::: + ]]> DataAdapters and DataReaders @@ -1539,11 +1539,11 @@ if the is closed; otherwise, . - and are the only properties that you can call after the is closed. - + and are the only properties that you can call after the is closed. + ]]> DataAdapters and DataReaders @@ -1587,11 +1587,11 @@ if the specified column value is equivalent to ; otherwise, . - , , and so on) to avoid raising an error. - + , , and so on) to avoid raising an error. + ]]> DataAdapters and DataReaders @@ -1681,13 +1681,13 @@ Gets the value of the specified column in its native format given the column name. The value of the specified column in its native format. - No column with the specified name was found. @@ -1729,13 +1729,13 @@ if there are more result sets; otherwise, . - DataAdapters and DataReaders @@ -1776,21 +1776,21 @@ if there are more rows; otherwise, . - is before the first record. Therefore, you must call to start accessing any data. - - While the is being used, the associated is busy serving it until you call . - - - -## Examples - The following example creates an , an , and an . The example reads through the data, writing it out to the console. Finally, the example closes the and then the . - + is before the first record. Therefore, you must call to start accessing any data. + + While the is being used, the associated is busy serving it until you call . + + + +## Examples + The following example creates an , an , and an . The example reads through the data, writing it out to the console. Finally, the example closes the and then the . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_ADO.NET/Classic WebData IDataReader.Read Example/CS/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData IDataReader.Read Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_ADO.NET/Classic WebData IDataReader.Read Example/VB/source.vb" id="Snippet1"::: + ]]> DataAdapters and DataReaders @@ -1827,15 +1827,15 @@ Gets the number of rows changed, inserted, or deleted by execution of the SQL statement. The number of rows changed, inserted, or deleted; 0 if no rows were affected or the statement failed; and -1 for SELECT statements. - property is not set until all rows are read and you close the . - - The value of this property is cumulative. For example, if two records are inserted in batch mode, the value of is two. - - and are the only properties that you can call after the is closed. - + property is not set until all rows are read and you close the . + + The value of this property is cumulative. For example, if two records are inserted in batch mode, the value of is two. + + and are the only properties that you can call after the is closed. + ]]> DataAdapters and DataReaders @@ -1968,11 +1968,11 @@ This member is an explicit interface member implementation. It can be used only Gets the number of fields in the that are not hidden. The number of fields that are not hidden. - are visible. For example, a SELECT on a partial primary key returns the remaining parts of the key as hidden fields. The hidden fields are always appended behind the visible fields. - + are visible. For example, a SELECT on a partial primary key returns the remaining parts of the key as hidden fields. The hidden fields are always appended behind the visible fields. + ]]> DataAdapters and DataReaders diff --git a/xml/System.Data.OleDb/OleDbType.xml b/xml/System.Data.OleDb/OleDbType.xml index b61494f0e6d..c4b89941ef5 100644 --- a/xml/System.Data.OleDb/OleDbType.xml +++ b/xml/System.Data.OleDb/OleDbType.xml @@ -32,11 +32,11 @@ Specifies the data type of a field, a property, for use in an . - data types, OLE DB data types (shown in parentheses), and the .NET Framework types. The data types accept `System.Char[]` as `Parameter.Value` in parameterized queries. - + data types, OLE DB data types (shown in parentheses), and the .NET types. The data types accept `System.Char[]` as `Parameter.Value` in parameterized queries. + ]]> @@ -498,8 +498,8 @@ 9 A pointer to an interface (DBTYPE_IDISPATCH). This maps to . - -This data type is not currently supported by ADO.NET. Its usage may cause unpredictable results. + +This data type is not currently supported by ADO.NET. Its usage may cause unpredictable results. To be added. @@ -555,8 +555,8 @@ This data type is not currently supported by ADO.NET. Its usage may cause unpred 13 - A pointer to an interface (DBTYPE_UNKNOWN). This maps to . -This data type is not currently supported by ADO.NET. Its usage may cause unpredictable results. + A pointer to an interface (DBTYPE_UNKNOWN). This maps to . +This data type is not currently supported by ADO.NET. Its usage may cause unpredictable results. To be added. diff --git a/xml/System.Data.OracleClient/OracleParameter.xml b/xml/System.Data.OracleClient/OracleParameter.xml index e41ab7b7484..1788a52fdda 100644 --- a/xml/System.Data.OracleClient/OracleParameter.xml +++ b/xml/System.Data.OracleClient/OracleParameter.xml @@ -167,7 +167,7 @@ OleDbDataReader reader = command.ExecuteReader(); in the `value` parameter, the is inferred from the Microsoft .NET Framework type of the . + When you specify an in the `value` parameter, the is inferred from the Microsoft .NET type of the . Use caution when you are using this overload of the constructor. Because this overload takes a `value` of type , you must convert the integral value to an type when the value is zero, as the following C# example demonstrates. diff --git a/xml/System.Data.SqlClient/SqlDataReader.xml b/xml/System.Data.SqlClient/SqlDataReader.xml index 82e58d55ba1..8a4fc695f9a 100644 --- a/xml/System.Data.SqlClient/SqlDataReader.xml +++ b/xml/System.Data.SqlClient/SqlDataReader.xml @@ -2615,7 +2615,7 @@ Boolean, Byte, Char, DateTime, DateTimeOffset, Decimal, Double, Float, Guid, Int returns data using the native SQL Server types. To retrieve data using the .NET Framework types, see . + returns data using the native SQL Server types. To retrieve data using the .NET types, see . ]]> @@ -3050,7 +3050,7 @@ Boolean, Byte, Char, DateTime, DateTimeOffset, Decimal, Double, Float, Guid, Int returns data using the .NET Framework types. + returns data using the .NET types. ]]> diff --git a/xml/System.Data.SqlClient/SqlParameter.xml b/xml/System.Data.SqlClient/SqlParameter.xml index b9704454bbe..43ab0ec43eb 100644 --- a/xml/System.Data.SqlClient/SqlParameter.xml +++ b/xml/System.Data.SqlClient/SqlParameter.xml @@ -243,7 +243,7 @@ in the `value` parameter, the is inferred from the Microsoft .NET Framework type of the . + When you specify an in the `value` parameter, the is inferred from the Microsoft .NET type of the . Use caution when you use this overload of the constructor to specify integer parameter values. Because this overload takes a `value` of type , you must convert the integral value to an type when the value is zero, as the following C# example demonstrates. diff --git a/xml/System.Data.SqlClient/SqlParameterCollection.xml b/xml/System.Data.SqlClient/SqlParameterCollection.xml index f45bb27a302..1cceff0c6c3 100644 --- a/xml/System.Data.SqlClient/SqlParameterCollection.xml +++ b/xml/System.Data.SqlClient/SqlParameterCollection.xml @@ -771,8 +771,7 @@ This member is an explicit interface member implementation. It can be used only This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - +This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples @@ -1236,8 +1235,7 @@ This member is an explicit interface member implementation. It can be used only This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. - Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In the earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. - + This method uses the collection's objects' and methods on `item` to determine whether `item` exists. ## Examples diff --git a/xml/System.Data/SqlDbType.xml b/xml/System.Data/SqlDbType.xml index 120aeff4520..33fce89c853 100644 --- a/xml/System.Data/SqlDbType.xml +++ b/xml/System.Data/SqlDbType.xml @@ -1427,6 +1427,32 @@ . A special data type that can contain numeric, string, binary, or date data as well as the SQL Server values Empty and Null, which is assumed if no other type is declared. + + + + + + + + Field + + System.Data.Common + 10.0.0.0 + + + netstandard + + + System.Data.SqlClient + + + System.Data.SqlDbType + + 36 + + To be added. + + diff --git a/xml/System.Diagnostics/DebuggableAttribute.xml b/xml/System.Diagnostics/DebuggableAttribute.xml index 2a64294d42f..44d398a7593 100644 --- a/xml/System.Diagnostics/DebuggableAttribute.xml +++ b/xml/System.Diagnostics/DebuggableAttribute.xml @@ -336,10 +336,10 @@ ## Remarks controls whether the runtime tracks information important to the debugger during code generation. This information helps the debugger provide a rich debugging experience. - Starting with the .NET Framework 2.0, JIT tracking information is always enabled during debugging, and this property value is ignored. + Starting in .NET Framework 2.0, JIT tracking information is always enabled during debugging, and this property value is ignored. > [!NOTE] -> This property does not control the ability to debug, but tells the just-in-time (JIT) compiler to generate tracking information. Specifically, the compiler tracks the Microsoft Intermediate Language (MSIL)-offset to the native-code offset within a method. +> This property does not control the ability to debug, but tells the just-in-time (JIT) compiler to generate tracking information. Specifically, the compiler tracks the Microsoft Intermediate Language (MSIL)-offset to the native-code offset within a method. ]]> diff --git a/xml/System.Diagnostics/EventLog.xml b/xml/System.Diagnostics/EventLog.xml index 3b893178c09..e7bf915f077 100644 --- a/xml/System.Diagnostics/EventLog.xml +++ b/xml/System.Diagnostics/EventLog.xml @@ -75,7 +75,7 @@ There are three default event logs: Application, System, and Security. A Security log is read-only. Other applications and services you install, such as Active Directory, might have additional event logs. - There are security considerations when using the class. requires permissions for specific actions in the .NET Framework 2.0 and later versions, or full trust in the .NET Framework 1.0 and 1.1. We recommend that not be granted to partially trusted code. You should never pass any event log object, including and objects, to less trusted code. For example, creating an object, writing an entry, and then passing the object to partially trusted code can create a security issue, because the ability to read and write to the event log allows code to perform actions such as issuing event log messages in the name of another application. + There are security considerations when using the class. requires permissions for specific actions. We recommend that not be granted to partially trusted code. You should never pass any event log object, including and objects, to less trusted code. For example, creating an object, writing an entry, and then passing the object to partially trusted code can create a security issue, because the ability to read and write to the event log allows code to perform actions such as issuing event log messages in the name of another application. Starting with Windows Vista, User Account Control (UAC) determines the credentials of a user. If you are a member of the Built-in Administrators group, you are assigned two run-time access tokens: a standard user access token and an administrator access token. By default, you are in the standard user role. To run the code that accesses the Security log, you must first elevate your credentials from standard user to administrator. You can do this when you start an application by opening the shortcut menu for the application (if you're using a mouse, right-click the application icon) and indicating that you want to run as an administrator. diff --git a/xml/System.Diagnostics/PerformanceCounter.xml b/xml/System.Diagnostics/PerformanceCounter.xml index c9281fb13f1..e75154ae19c 100644 --- a/xml/System.Diagnostics/PerformanceCounter.xml +++ b/xml/System.Diagnostics/PerformanceCounter.xml @@ -87,11 +87,11 @@ To obtain performance data for counters that required an initial or previous value for performing the necessary calculation, call the method twice and use the information returned as your application requires. > [!NOTE] -> Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. For more information about the file mapping size, see [<performanceCounters>](/dotnet/framework/configure-apps/file-schema/trace-debug/performancecounters-element). +> Performance counter categories installed with .NET use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. For more information about the file mapping size, see [<performanceCounters>](/dotnet/framework/configure-apps/file-schema/trace-debug/performancecounters-element). ## Examples The following code example demonstrates the use of the class to create and use an counter type. The example creates categories, sets up counters, collects data from the counters, and calls the class to interpret the performance counter data. The intermediate and final results are displayed in the console window. For additional examples of other performance counter types, see the enumeration. - + :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/CounterCreationData/Overview/averagecount32.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/PerformanceCounterType.AverageCounter64/VB/averagecount32.vb" id="Snippet1"::: diff --git a/xml/System.Diagnostics/PerformanceCounterCategory.xml b/xml/System.Diagnostics/PerformanceCounterCategory.xml index 82b4148b479..5ce488d353d 100644 --- a/xml/System.Diagnostics/PerformanceCounterCategory.xml +++ b/xml/System.Diagnostics/PerformanceCounterCategory.xml @@ -57,7 +57,7 @@ > It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. > [!NOTE] -> Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. For more information about the file mapping size, see [<performanceCounters>](/dotnet/framework/configure-apps/file-schema/trace-debug/performancecounters-element). +> Performance counter categories installed with .NET use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. For more information about the file mapping size, see [<performanceCounters>](/dotnet/framework/configure-apps/file-schema/trace-debug/performancecounters-element). @@ -385,7 +385,7 @@ ## Remarks The property indicates whether the object can have multiple instances. The possible values are , , or . - There are two types of performance counter categories: single-instance and multi-instance. By default, a category is single-instance when it is created and becomes multi-instance when another instance is added. Categories are created when an application is set up, and instances are added at run time. In the .NET Framework versions 1.0 and 1.1, it is not necessary to know if a performance counter category is multi-instance or single-instance. In the .NET Framework 2.0, the enumeration is used to indicate whether a performance counter can have multiple instances. + There are two types of performance counter categories: single-instance and multi-instance. By default, a category is single-instance when it is created and becomes multi-instance when another instance is added. Categories are created when an application is set up, and instances are added at run time. The enumeration is used to indicate whether a performance counter can have multiple instances. ]]> @@ -774,9 +774,9 @@ enumeration is used to indicate whether a performance counter can have multiple instances. + The `categoryType` parameter specifies whether the performance counter category is single-instance or multi-instance. By default, a category is single-instance when it is created and becomes multi-instance when another instance is added. Categories are created when an application is set up, and instances are added at run time. The enumeration is used to indicate whether a performance counter can have multiple instances. - Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. + Performance counter categories installed with .NET use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. > [!NOTE] > It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. @@ -970,9 +970,9 @@ enumeration is used to indicate whether a performance counter can have multiple instances. + The `categoryType` parameter specifies whether the performance counter category is single-instance or multi-instance. By default, a category is single-instance when it is created and becomes multi-instance when another instance is added. Categories are created when an application is set up, and instances are added at run time. The enumeration is used to indicate whether a performance counter can have multiple instances. - Performance counter categories installed with the .NET Framework 2.0 use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. + Performance counter categories installed with .NET use separate shared memory, with each performance counter category having its own memory. You can specify the size of separate shared memory by creating a DWORD named FileMappingSize in the registry key HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\\*\*\Performance. The FileMappingSize value is set to the shared memory size of the category. The default size is 131072 decimal. If the FileMappingSize value is not present, the `fileMappingSize` attribute value for the `performanceCounters` element specified in the Machine.config file is used, causing additional overhead for configuration file processing. You can realize a performance improvement for application startup by setting the file mapping size in the registry. > [!NOTE] > It is strongly recommended that new performance counter categories be created during the installation of the application, not during the execution of the application. This allows time for the operating system to refresh its list of registered performance counter categories. If the list has not been refreshed, the attempt to use the category will fail. diff --git a/xml/System.DirectoryServices/SchemaNameCollection.xml b/xml/System.DirectoryServices/SchemaNameCollection.xml index 868669773e8..9c22f38d8cf 100644 --- a/xml/System.DirectoryServices/SchemaNameCollection.xml +++ b/xml/System.DirectoryServices/SchemaNameCollection.xml @@ -357,11 +357,11 @@ The schema name to insert into this collection. Inserts a schema name into this collection at a specified index. - @@ -395,13 +395,13 @@ Gets or sets the object that exists at a specified index. The object that exists at the specified index. - class. - - In JScript, you can use the default indexed properties defined by a type, but you cannot explicitly define your own. However, specifying the expando attribute on a class automatically provides a default indexed property whose type is Object and whose index type is . - + class. + + In JScript, you can use the default indexed properties defined by a type, but you cannot explicitly define your own. However, specifying the expando attribute on a class automatically provides a default indexed property whose type is Object and whose index type is . + ]]> @@ -507,10 +507,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of elements in the source is greater than the available space from to the end of the destination . The type of the source cannot be cast automatically to the type of the destination . @@ -542,37 +542,37 @@ if access to the is synchronized (thread safe); otherwise, . - returns an object, which can be used to synchronize access to the . - - Most collection classes in the namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. - - Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - - - The following example shows how to lock the collection using the during the entire enumeration: - -```csharp -ICollection myCollection = new ICollection(); - lock(myCollection.SyncRoot) { - foreach (Object item in myCollection) { - // Insert your code here. - } - } -``` - -```vb -Dim myCollection As New ICollection() - Dim item As Object - SyncLock myCollection.SyncRoot - For Each item In myCollection - ' Insert your code here. - Next item - End SyncLock -``` - + returns an object, which can be used to synchronize access to the . + + Most collection classes in the namespace also implement a Synchronized method, which provides a synchronized wrapper around the underlying collection. + + Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + + + The following example shows how to lock the collection using the during the entire enumeration: + +```csharp +ICollection myCollection = new ICollection(); + lock(myCollection.SyncRoot) { + foreach (Object item in myCollection) { + // Insert your code here. + } + } +``` + +```vb +Dim myCollection As New ICollection() + Dim item As Object + SyncLock myCollection.SyncRoot + For Each item In myCollection + ' Insert your code here. + Next item + End SyncLock +``` + ]]> @@ -610,53 +610,53 @@ Dim myCollection As New ICollection() Gets an object that can be used to synchronize access to the . An object that can be used to synchronize access to the . - namespace also implement a `Synchronized` method, which provides a synchronized wrapper around the underlying collection. However, derived classes can provide their own synchronized version of the collection using the property. The synchronizing code must perform operations on the of the collection, not directly on the collection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance. - - In the absence of a `Synchronized` method on a collection, the expected usage for looks like this: - -```csharp -ICollection MyCollection =... - lock(MyCollection.SyncRoot) { - // Some operation on the collection, which is now thread safe. - } -``` - -```vb -Dim myCollection as New ICollection() - SyncLock myCollection.SyncRoot - ' Some operation on the collection, which is now thread safe. - End SyncLock -``` - - Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. - - - The following example shows how to lock the collection using the during the entire enumeration: - -```csharp -ICollection myCollection = new ICollection(); - lock(myCollection.SyncRoot) { - foreach (Object item in myCollection) { - // Insert your code here. - } - } -``` - -```vb -Dim myCollection As New ICollection() - Dim item As Object - SyncLock myCollection.SyncRoot - For Each item In myCollection - ' Insert your code here. - Next item - End SyncLock -``` - + namespace also implement a `Synchronized` method, which provides a synchronized wrapper around the underlying collection. However, derived classes can provide their own synchronized version of the collection using the property. The synchronizing code must perform operations on the of the collection, not directly on the collection. This ensures proper operation of collections that are derived from other objects. Specifically, it maintains proper synchronization with other threads that might be simultaneously modifying the collection instance. + + In the absence of a `Synchronized` method on a collection, the expected usage for looks like this: + +```csharp +ICollection MyCollection =... + lock(MyCollection.SyncRoot) { + // Some operation on the collection, which is now thread safe. + } +``` + +```vb +Dim myCollection as New ICollection() + SyncLock myCollection.SyncRoot + ' Some operation on the collection, which is now thread safe. + End SyncLock +``` + + Enumerating through a collection is intrinsically not a thread-safe procedure. Even when a collection is synchronized, other threads can still modify the collection, which causes the enumerator to throw an exception. To guarantee thread safety during enumeration, you can either lock the collection during the entire enumeration or catch the exceptions resulting from changes made by other threads. + + + The following example shows how to lock the collection using the during the entire enumeration: + +```csharp +ICollection myCollection = new ICollection(); + lock(myCollection.SyncRoot) { + foreach (Object item in myCollection) { + // Insert your code here. + } + } +``` + +```vb +Dim myCollection As New ICollection() + Dim item As Object + SyncLock myCollection.SyncRoot + For Each item In myCollection + ' Insert your code here. + Next item + End SyncLock +``` + ]]> @@ -729,11 +729,12 @@ Dim myCollection As New ICollection() if the value is found in the list, otherwise . - @@ -770,11 +771,12 @@ Dim myCollection As New ICollection() Determines the index of a specified item in the list. The index of if found in the list; otherwise, -1. - @@ -812,13 +814,13 @@ Dim myCollection As New ICollection() The item to insert into the list. Inserts an item to the list at the specified index. - @@ -850,11 +852,11 @@ Dim myCollection As New ICollection() if the has a fixed size; otherwise, . - @@ -886,11 +888,11 @@ Dim myCollection As New ICollection() if the is read-only; otherwise, . - @@ -926,11 +928,11 @@ Dim myCollection As New ICollection() Gets or sets the element at the specified index. The element at the specified index. - @@ -969,11 +971,11 @@ Dim myCollection As New ICollection() The to remove from the list. Removes the first occurrence of a specific from the list. - diff --git a/xml/System.Drawing/Font.xml b/xml/System.Drawing/Font.xml index 35e22d4891e..f03aa79079f 100644 --- a/xml/System.Drawing/Font.xml +++ b/xml/System.Drawing/Font.xml @@ -152,11 +152,6 @@ operator, the constructor, and the property. This example is designed to be used with a Windows Form that contains a button named `Button2`. Paste the following code into your form and associate the `Button2_Click` method with the button's event. diff --git a/xml/System.Globalization/CultureTypes.xml b/xml/System.Globalization/CultureTypes.xml index faca7081668..2ee0e1a9ce4 100644 --- a/xml/System.Globalization/CultureTypes.xml +++ b/xml/System.Globalization/CultureTypes.xml @@ -188,7 +188,7 @@ On .NET Framework 4 and later versions and .NET Core running on Windows, it incl 64 - **This member is deprecated**; using this value with returns neutral and specific cultures shipped with the .NET Framework 2.0. + **This member is deprecated**; using this value with returns neutral and specific cultures shipped with .NET Framework 2.0. diff --git a/xml/System.Globalization/NumberFormatInfo.xml b/xml/System.Globalization/NumberFormatInfo.xml index 543fdec0b41..0d344c77046 100644 --- a/xml/System.Globalization/NumberFormatInfo.xml +++ b/xml/System.Globalization/NumberFormatInfo.xml @@ -2108,7 +2108,7 @@ On Windows, the initial value of this property is derived from the settings in t property is used with the "P" standard format string to define the pattern of negative percentage values. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). This property has one of the values in the following table. The symbol "%" is the , the symbol "-" is the , and `n` is a number. Values 3-11 were introduced in the .NET Framework 2.0 and cannot be used in earlier versions. + The property is used with the "P" standard format string to define the pattern of negative percentage values. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). This property has one of the values in the following table. The symbol "%" is the , the symbol "-" is the , and `n` is a number. | Value | Associated pattern | |-------|--------------------| diff --git a/xml/System.Net.Security/SslStream.xml b/xml/System.Net.Security/SslStream.xml index 8d8433c12c0..e9a91abd28a 100644 --- a/xml/System.Net.Security/SslStream.xml +++ b/xml/System.Net.Security/SslStream.xml @@ -85,7 +85,7 @@ assumes that a timeout along with any other when one is thrown from the inner stream will be treated as fatal by its caller. Reusing a instance after a timeout will return garbage. An application should the and throw an exception in these cases. - The .NET Framework 4.6 includes a new security feature that blocks insecure cipher and hashing algorithms for connections. Applications using TLS/SSL through APIs such as HttpClient, HttpWebRequest, FTPClient, SmtpClient, SslStream, etc. and targeting .NET Framework 4.6 get the more-secure behavior by default. + The .NET Framework 4.6 includes a security feature that blocks insecure cipher and hashing algorithms for connections. Applications using TLS/SSL through APIs such as HttpClient, HttpWebRequest, FTPClient, SmtpClient, and SslStream and targeting .NET Framework 4.6 get the more-secure behavior by default. Developers may want to opt out of this behavior in order to maintain interoperability with their existing SSL3 services OR TLS w/ RC4 services. [This article](https://support.microsoft.com/kb/3069494) explains how to modify your code so that the new behavior is disabled. diff --git a/xml/System.Net/ServicePointManager.xml b/xml/System.Net/ServicePointManager.xml index a61f5afc598..af6ad8fafdc 100644 --- a/xml/System.Net/ServicePointManager.xml +++ b/xml/System.Net/ServicePointManager.xml @@ -66,7 +66,7 @@ When an application requests a connection to an Internet resource Uniform Resource Identifier (URI) through the object, the returns a object that contains connection information for the host and scheme identified by the URI. If there is an existing object for that host and scheme, the object returns the existing object; otherwise, the object creates a new object. - The .NET Framework 4.6 includes a new security feature that blocks insecure cipher and hashing algorithms for connections. Applications using TLS/SSL through APIs such as , , , , , etc. and targeting .NET Framework 4.6 get the more-secure behavior by default. + The .NET Framework 4.6 includes a security feature that blocks insecure cipher and hashing algorithms for connections. Applications using TLS/SSL through APIs such as , , , , and and targeting .NET Framework 4.6 or later get the more-secure behavior by default. Developers may want to opt out of this behavior in order to maintain interoperability with their existing SSL3 services or TLS w/ RC4 services. [This article](https://support.microsoft.com/kb/3069494) explains how to modify your code so that the new behavior is disabled. @@ -1120,7 +1120,7 @@ For versions of the .NET Framework through the .NET Framework 4.6.2, no default Your code should never implicitly depend on using a particular protection level, or on the assumption that a given security level is used by default. If your app depends on the use of a particular security level, you must explicitly specify that level and then check to be sure that it is actually in use on the established connection. Further, your code should be designed to be robust in the face of changes to which protocols are supported, as such changes are often made with little advance notice in order to mitigate emerging threats. - The .NET Framework 4.6 includes a new security feature that blocks insecure cipher and hashing algorithms for connections. Applications using TLS/SSL through APIs such as HttpClient, HttpWebRequest, FTPClient, SmtpClient, SslStream, etc. and targeting .NET Framework 4.6 get the more-secure behavior by default. + The .NET Framework 4.6 includes a security feature that blocks insecure cipher and hashing algorithms for connections. Applications using TLS/SSL through APIs such as HttpClient, HttpWebRequest, FTPClient, SmtpClient, and SslStream and targeting .NET Framework 4.6 get the more-secure behavior by default. Developers may want to opt out of this behavior in order to maintain interoperability with their existing SSL3 services OR TLS w/ RC4 services. [This article](https://support.microsoft.com/kb/3069494) explains how to modify your code so that the new behavior is disabled. diff --git a/xml/System.Numerics/Matrix3x2.xml b/xml/System.Numerics/Matrix3x2.xml index 527f34f8448..b07e1c7f249 100644 --- a/xml/System.Numerics/Matrix3x2.xml +++ b/xml/System.Numerics/Matrix3x2.xml @@ -164,6 +164,144 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix3x2 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix3x2 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix3x2 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix3x2 + + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + System.Numerics.Vectors @@ -996,6 +1134,45 @@ + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Single + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -1047,6 +1224,43 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector2 + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -1190,6 +1404,43 @@ To be added. + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector2 + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -2244,5 +2495,184 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Matrix3x2 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Matrix3x2 + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector2 + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector2 + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector2 + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Numerics/Matrix4x4.xml b/xml/System.Numerics/Matrix4x4.xml index 4868ce3cb59..8cb56c62a50 100644 --- a/xml/System.Numerics/Matrix4x4.xml +++ b/xml/System.Numerics/Matrix4x4.xml @@ -245,6 +245,197 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix4x4 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix4x4 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix4x4 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix4x4 + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Matrix4x4 + + + + + + + + + + + + + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -2535,6 +2726,45 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Single + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -2586,6 +2816,43 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector4 + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -2729,6 +2996,43 @@ To be added. + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector4 + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -4298,5 +4602,217 @@ To be added. + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector4 + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Matrix4x4 + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [System.Runtime.CompilerServices.IsReadOnly] + [<System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Matrix4x4 + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector4 + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector4 + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + + [get: System.Runtime.CompilerServices.IsReadOnly] + [<get: System.Runtime.CompilerServices.IsReadOnly>] + + + + System.Numerics.Vector4 + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Numerics/Plane.xml b/xml/System.Numerics/Plane.xml index ca32dfe60d4..a5b8317644e 100644 --- a/xml/System.Numerics/Plane.xml +++ b/xml/System.Numerics/Plane.xml @@ -210,6 +210,107 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Plane + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Plane + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Plane + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Numerics/Quaternion.xml b/xml/System.Numerics/Quaternion.xml index 31257ffa6bb..dd4fd62f61a 100644 --- a/xml/System.Numerics/Quaternion.xml +++ b/xml/System.Numerics/Quaternion.xml @@ -315,6 +315,76 @@ w = cos(theta/2) To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Quaternion + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Quaternion + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Numerics/Vector.xml b/xml/System.Numerics/Vector.xml index 5c02ac9f7a9..76882607640 100644 --- a/xml/System.Numerics/Vector.xml +++ b/xml/System.Numerics/Vector.xml @@ -183,6 +183,60 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -548,6 +602,34 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector2 + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -578,6 +660,34 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector3 + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -608,6 +718,34 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector3 + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -2936,6 +3074,96 @@ Note that this method returns a instead of an integral type The type of () is not supported. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -8292,6 +8520,240 @@ Note that this method returns a instead of an integral type To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector<System.Single> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Numerics.Vector<System.SByte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector<System.Int16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector<System.Int32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Numerics.Vector<System.Byte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Numerics.Vector<System.UInt16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Numerics.Vector<System.UInt32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -10628,6 +11090,60 @@ Note that this method returns a instead of an integral type To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics.Vector<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Numerics/Vector2.xml b/xml/System.Numerics/Vector2.xml index 32d75d42502..2250e8f42d9 100644 --- a/xml/System.Numerics/Vector2.xml +++ b/xml/System.Numerics/Vector2.xml @@ -1094,6 +1094,68 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Vector2 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Vector2 + + + + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Numerics/Vector3.xml b/xml/System.Numerics/Vector3.xml index 9a9d1b0012a..0c57cc1f166 100644 --- a/xml/System.Numerics/Vector3.xml +++ b/xml/System.Numerics/Vector3.xml @@ -1177,6 +1177,68 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Vector3 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Vector3 + + + + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Numerics/Vector4.xml b/xml/System.Numerics/Vector4.xml index 648bd41256f..bf806883c37 100644 --- a/xml/System.Numerics/Vector4.xml +++ b/xml/System.Numerics/Vector4.xml @@ -1264,6 +1264,68 @@ To be added. + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Vector4 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Numerics.Vectors + 10.0.0.0 + + + netstandard + + + System.Numerics + + + System.Numerics.Vector4 + + + + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Reflection.Emit/AssemblyBuilder.xml b/xml/System.Reflection.Emit/AssemblyBuilder.xml index 07e99e27bfe..212c3298a15 100644 --- a/xml/System.Reflection.Emit/AssemblyBuilder.xml +++ b/xml/System.Reflection.Emit/AssemblyBuilder.xml @@ -181,11 +181,6 @@ The following code example shows how to define and use a dynamic assembly. The e The specified resource file must be in the directory where the assembly will be saved. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following code sample demonstrates how to attach a resource file to a dynamically created assembly, using `AddResourceFile`. @@ -263,11 +258,6 @@ The following code example shows how to define and use a dynamic assembly. The e The specified resource file must be in the directory where the assembly will be saved. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following code sample demonstrates how to attach a resource file to a dynamically created assembly, using `AddResourceFile`. @@ -591,11 +581,6 @@ The following code example shows how to define and use a dynamic assembly. The e > [!NOTE] > To suppress optimizations when debugging dynamic modules, apply the attribute to the dynamic assembly before calling . Create an instance of with the flag and apply it using the method. The attribute must be applied to the dynamic assembly. It has no effect if applied to the module. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The code example below demonstrates how to create a transient dynamic module using `DefineDynamicModule`. @@ -681,11 +666,6 @@ The following code example shows how to define and use a dynamic assembly. The e > [!NOTE] > To suppress optimizations when debugging dynamic modules, apply the attribute to the dynamic assembly before calling . Create an instance of with the flag and apply it using the method. The attribute must be applied to the dynamic assembly. It has no effect if applied to the module. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The code example below demonstrates how to create a transient dynamic module using `DefineDynamicModule`, suppressing symbol information. @@ -766,11 +746,6 @@ The following code example shows how to define and use a dynamic assembly. The e > [!NOTE] > To suppress optimizations when debugging dynamic modules, apply the attribute to the dynamic assembly before calling . Create an instance of with the flag and apply it using the method. The attribute must be applied to the dynamic assembly. It has no effect if applied to the module. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The code example below demonstrates how to create a persistent dynamic module using `DefineDynamicModule`. @@ -858,11 +833,6 @@ The following code example shows how to define and use a dynamic assembly. The e > [!NOTE] > To suppress optimizations when debugging dynamic modules, apply the attribute to the dynamic assembly before calling . Create an instance of with the flag and apply it using the method. The attribute must be applied to the dynamic assembly. It has no effect if applied to the module. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The code example below demonstrates how to create a persistent dynamic module with symbol emission using `DefineDynamicModule`. @@ -987,11 +957,6 @@ The following code example shows how to define and use a dynamic assembly. The e The runtime calls the method when the dynamic assembly is saved. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example uses the method to get a resource writer. The example uses the resource writer to add three resource strings. @@ -1075,9 +1040,6 @@ The following code example shows how to define and use a dynamic assembly. The e The runtime calls the method when the dynamic assembly is saved. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - ]]> @@ -1201,11 +1163,6 @@ The following code example shows how to define and use a dynamic assembly. The e ## Remarks An assembly can be associated with only one unmanaged resource. This means that calling or after either one of the methods was called previously will throw the System.ArgumentException. Multiple unmanaged resources need to be merged with a tool such as the Microsoft ResMerge utility (not supplied with the common language runtime). -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The example below demonstrates a call to `DefineUnmanagedResource`, passing an external resource file. @@ -1280,11 +1237,6 @@ The following code example shows how to define and use a dynamic assembly. The e The information is inferred from the `AssemblyName` object used to define this dynamic assembly. This assembly's custom attributes override information specified in the `AssemblyName` object. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The example below illustrates the usage of `DefineVersionInfoResource`. @@ -1348,11 +1300,6 @@ The following code example shows how to define and use a dynamic assembly. The e The structure of the version resource includes data that identifies the version, language, and distribution of the file. Installation programs use the functions in the file installation library (VER.DLL) to retrieve the version information resource from a file and to extract the version information blocks from the resource. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The example below illustrates the usage of `DefineVersionInfoResource`. @@ -3448,11 +3395,6 @@ For information on how to format `binaryAttribute`, see the metadata specificati > [!NOTE] > cannot be used to set declarative security attributes. Use one of the overloads of that takes required, optional, and refused permissions. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following code sample illustrates the use of `SetCustomAttribute` to attach a custom attribute to a dynamically generated assembly. @@ -3585,16 +3527,7 @@ For information on how to format `binaryAttribute`, see the metadata specificati A reference to the method that represents the entry point for this dynamic assembly. The type of the assembly executable being built. Sets the entry point for this assembly and defines the type of the portable executable (PE file) being built. - - [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> - + To be added. is . diff --git a/xml/System.Reflection.Emit/DynamicMethod.xml b/xml/System.Reflection.Emit/DynamicMethod.xml index 144835452dc..4c06196d25f 100644 --- a/xml/System.Reflection.Emit/DynamicMethod.xml +++ b/xml/System.Reflection.Emit/DynamicMethod.xml @@ -474,7 +474,7 @@ The following code example creates a dynamic method that takes two parameters. T The example code creates an instance of `Example` and then creates two delegates. The first is of type `UseLikeStatic`, which has the same parameters as the dynamic method. The second is of type `UseLikeInstance`, which lacks the first parameter (of type `Example`). This delegate is created using the method overload; the second parameter of that method overload is an instance of `Example`, in this case the instance just created, which is bound to the newly created delegate. Whenever that delegate is invoked, the dynamic method acts on the bound instance of `Example`. > [!NOTE] -> This is an example of the relaxed rules for delegate binding introduced in the .NET Framework 2.0, along with new overloads of the method. For more information, see the class. +> This is an example of the relaxed rules for delegate binding introduced in .NET Framework 2.0, along with new overloads of the method. For more information, see the class. The `UseLikeStatic` delegate is invoked, passing in the instance of `Example` that is bound to the `UseLikeInstance` delegate. Then the `UseLikeInstance` delegate is invoked, so that both delegates act on the same instance of `Example`. The changes in the values of the internal field are displayed after each call. Finally, a `UseLikeInstance` delegate is bound to an instance of `DerivedFromExample`, and the delegate calls are repeated. @@ -1221,7 +1221,7 @@ The following code example creates a dynamic method that takes two parameters. T The example code creates an instance of `Example` and then creates two delegates. The first is of type `UseLikeStatic`, which has the same parameters as the dynamic method. The second is of type `UseLikeInstance`, which lacks the first parameter (of type `Example`). This delegate is created using the method overload; the second parameter of that method overload is an instance of `Example`, in this case the instance just created, which is bound to the newly created delegate. Whenever that delegate is invoked, the dynamic method acts on the bound instance of `Example`. > [!NOTE] -> This is an example of the relaxed rules for delegate binding introduced in the .NET Framework 2.0, along with new overloads of the method. For more information, see the class. +> This is an example of the relaxed rules for delegate binding introduced in .NET Framework 2.0, along with new overloads of the method. For more information, see the class. The `UseLikeStatic` delegate is invoked, passing in the instance of `Example` that is bound to the `UseLikeInstance` delegate. Then the `UseLikeInstance` delegate is invoked, so that both delegates act on the same instance of `Example`. The changes in the values of the internal field are displayed after each call. Finally, a `UseLikeInstance` delegate is bound to an instance of `DerivedFromExample`, and the delegate calls are repeated. diff --git a/xml/System.Reflection.Emit/MethodBuilder.xml b/xml/System.Reflection.Emit/MethodBuilder.xml index 22f7f91f430..5099a726feb 100644 --- a/xml/System.Reflection.Emit/MethodBuilder.xml +++ b/xml/System.Reflection.Emit/MethodBuilder.xml @@ -2283,7 +2283,7 @@ The following example uses the class ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0 and the .NET Compact Framework 2.0, this member is inherited from the base class, . See . +> This member is inherited from the base class, . See . ]]> diff --git a/xml/System.Reflection.Emit/ModuleBuilder.xml b/xml/System.Reflection.Emit/ModuleBuilder.xml index d75e49c5969..d5a822832b3 100644 --- a/xml/System.Reflection.Emit/ModuleBuilder.xml +++ b/xml/System.Reflection.Emit/ModuleBuilder.xml @@ -208,11 +208,6 @@ ## Remarks This method should be called when the user is done with defining all the global functions within this dynamic module. After calling this function, no more new global functions or new global data are allowed. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following sample illustrates the use of `CreateGlobalFunctions` to create a static global method from a implemented with . @@ -448,11 +443,6 @@ > [!NOTE] > In the .NET Framework versions 1.0 and 1.1, it is necessary to define enumerations using because emits enumerations whose elements are of type instead of the enumeration type. In the .NET Framework version 2.0, emits enumerations whose elements have the correct type. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example illustrates the use of `DefineEnum` to implement an enumeration class in a dynamic module. The example defines an enumeration named `Elevation` that has an underlying type of , and creates two elements: `Low`, with a value of 0, and `High`, with a value of 1. After the type has been created, the assembly is saved with the name `TempAssembly.dll`. You can use the [Ildasm.exe (IL Disassembler)](/dotnet/framework/tools/ildasm-exe-il-disassembler) to examine the contents of this assembly. @@ -590,11 +580,6 @@ ## Remarks The global method that this method defines is not usable until you call . -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example illustrates the use of `DefineGlobalMethod` to create a type-independent method tied to the current . After building the global method, must be called in order to complete it. @@ -689,11 +674,6 @@ ## Remarks You cannot use the global method that this method defines until you call . -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following code sample illustrates the use of `DefineGlobalMethod` to create a type-independent method tied to the current . After building the global method, must be called in order to complete it. @@ -819,12 +799,7 @@ ## Remarks This overload is provided for designers of managed compilers. - You cannot use the global method that this method defines until you call . - -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + You cannot use the global method that this method defines until you call . ]]> The method is not static. That is, does not include . @@ -984,11 +959,6 @@ The data defined by this method is not created until the method is called. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example uses the method to define an initialized data field in the `.sdata` section of the portable executable (PE) file. @@ -1219,11 +1189,6 @@ ## Remarks Some DLL import attributes (see the description of System.Runtime.InteropServices.DllImportAttribute) cannot be specified as arguments to this method. Such attributes should be set by emitting a custom attribute for the method. For example, the DLL import attribute `PreserveSig` is set by emitting a custom attribute. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example illustrates the use of the `DefinePInvokeMethod` method to create a for an external unmanaged method, `MessageBoxA`, in the Windows API. The example displays a message box with **Retry** and **Cancel** buttons, and displays the return value from the message box. @@ -1336,11 +1301,6 @@ ## Remarks Some DLL import attributes (see the description of ) cannot be specified as arguments to this method. Such attributes should be set by emitting a custom attribute for the method. For example, the DLL import attribute `PreserveSig` is set by emitting a custom attribute. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example illustrates the use of the `DefinePInvokeMethod` method to create a for an external unmanaged method, `MessageBoxA`, in the Windows API. The example displays a message box with **Retry** and **Cancel** buttons, and displays the return value from the message box. @@ -1476,11 +1436,6 @@ Use this method to embed a managed resource. To embed a manifest resource blob, use the method. For a summary of embedding and linking managed resources and manifest resource blobs, see the method. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example illustrates the use of `DefineResource` to add an external resource to the current . @@ -1542,11 +1497,6 @@ Use this method to embed a managed resource. To embed a manifest resource blob, use the method. For a summary of embedding and linking managed resources and manifest resource blobs, see the method. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example illustrates the use of DefineResource to add an external resource to the current . @@ -1630,11 +1580,6 @@ ## Remarks Type names must be unique within an assembly. You cannot have two types with the same name in two different modules of an assembly. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example creates a in the current dynamic module using `CreateType`, builds and completes the type, and saves the assembly. @@ -1708,11 +1653,6 @@ ## Remarks Type names must be unique within an assembly. You cannot have two types with the same name in two different modules of an assembly. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example creates a in the current dynamic module using `CreateType`, builds and completes the type, and saves the assembly. @@ -1800,11 +1740,6 @@ ## Remarks Type names must be unique within an assembly. You cannot have two types with the same name in two different modules of an assembly. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example creates a in the current dynamic module using `CreateType`, builds and completes the type, and saves the assembly. @@ -1894,11 +1829,6 @@ ## Remarks Type names must be unique within an assembly. It is forbidden to have two types with the same name in two different modules of an assembly. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example creates a in the current dynamic module using `CreateType`, builds and completes the type, and saves the assembly. @@ -1988,11 +1918,6 @@ ## Remarks Type names must be unique within an assembly. You cannot have two types with the same name in two different modules of an assembly. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example creates a in the current dynamic module using `CreateType`, builds and completes the type, and saves the assembly. @@ -2093,11 +2018,6 @@ ## Remarks Type names must be unique within an assembly. You cannot have two types with the same name in two different modules of an assembly. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example creates a in the current dynamic module using `CreateType`, builds and completes the type, and saves the assembly. @@ -2189,11 +2109,6 @@ ## Remarks Type names must be unique within an assembly. You cannot have two types with the same name in two different modules of an assembly. -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - - ## Examples The following example creates a in the current dynamic module using `CreateType`, builds and completes the type, and saves the assembly. @@ -2327,12 +2242,7 @@ ## Remarks is automatically included in `attributes`. - The data defined by this method is not created until the method is called. - -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + The data defined by this method is not created until the method is called. ]]> The length of is zero. @@ -2422,12 +2332,7 @@ . Multiple unmanaged resources need to be merged with a tool such as the Microsoft ResMerge utility (not supplied with the common language runtime). - -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + An assembly can be associated with only one unmanaged resource. This means that calling `DefineVersionInfoResource` or `DefineUnmanagedResource` after either one of the methods was called previously throws . Multiple unmanaged resources need to be merged with a tool such as the Microsoft ResMerge utility (not supplied with the common language runtime). ]]> An unmanaged resource has already been defined in the module's assembly. @@ -2473,12 +2378,7 @@ . Multiple unmanaged resources need to be merged with a tool such as the Microsoft ResMerge utility (not supplied with the common language runtime). - -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + An assembly can be associated with only one unmanaged resource. This means that calling `DefineVersionInfoResource` or `DefineUnmanagedResource` after either one of the methods was called previously throws . Multiple unmanaged resources need to be merged with a tool such as the Microsoft ResMerge utility (not supplied with the common language runtime). ]]> An unmanaged resource has already been defined in the module's assembly. @@ -3913,12 +3813,7 @@ [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> +## Remarks ]]> @@ -3997,12 +3892,7 @@ , , and methods instead. - -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + Do not use this method to generate array types, pointer types, or byref types. Use the , , and methods instead. ]]> Length of is zero or is greater than 1023. @@ -4079,12 +3969,7 @@ , , and methods instead. - -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + Do not use this method to generate array types, pointer types, or byref types. Use the , , and methods instead. ]]> Length of is zero or is greater than 1023. @@ -4165,12 +4050,7 @@ ## Remarks The `throwOnError` parameter only affects what happens when the type is not found. It does not affect any other exceptions that might be thrown. In particular, if the type is found but cannot be loaded, can be thrown even if `throwOnError` is `false`. - Do not use this method to generate array types, pointer types, or byref types. Use the , , and methods instead. - -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + Do not use this method to generate array types, pointer types, or byref types. Use the , , and methods instead. ]]> Length of is zero or is greater than 1023. @@ -4260,12 +4140,7 @@ ## Remarks `ReflectionTypeLoadException` is a special class load exception. The `ReflectionTypeLoadException.Types` property contains the array of classes that were defined in the module and loaded. This array can contain some null values. The `ReflectionTypeLoadException.LoaderExceptions` property is an array of exceptions that represent the exceptions that were thrown by the class loader. The holes in the class array line up with the exceptions. - For example, if the class initializers of one of the classes throws an exception while it is being loaded, a `TargetInvocationException` is stored in the corresponding element of the `LoaderExceptions` array. - -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + For example, if the class initializers of one of the classes throws an exception while it is being loaded, a `TargetInvocationException` is stored in the corresponding element of the `LoaderExceptions` array. ]]> One or more classes in a module could not be loaded. The caller does not have the required permission. @@ -5263,12 +5138,7 @@ [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> +## Remarks ]]> is . @@ -5331,12 +5201,7 @@ [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + For more information about how to format `binaryAttribute`, see the Common Language Infrastructure (CLI) documentation, especially "Partition II: Metadata Definition and Semantics". For more information, see [ECMA 335 Common Language Infrastructure (CLI)](https://www.ecma-international.org/publications-and-standards/standards/ecma-335/). ]]> or is . @@ -5461,12 +5326,7 @@ [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> + The compiler might generate a startup stub before calling user main. The startup stub will be the entry point. While the user main will be the user entry point so that debugger will not step into the compiler entry point. ]]> is . diff --git a/xml/System.Reflection.Emit/TypeBuilder.xml b/xml/System.Reflection.Emit/TypeBuilder.xml index e146ffbfae8..833458c6add 100644 --- a/xml/System.Reflection.Emit/TypeBuilder.xml +++ b/xml/System.Reflection.Emit/TypeBuilder.xml @@ -8394,16 +8394,7 @@ See for a description of the format of the An instance of a helper class to define the custom attribute. Set a custom attribute using a custom attribute builder. - - [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> - + To be added. is . For the current dynamic type, the property is , but the property is . @@ -8469,9 +8460,6 @@ See for a description of the format of the For more information on how to format `binaryAttribute`, see [ECMA C# and Common Language Infrastructure Standards](/dotnet/standard/components#applicable-standards) and [Standard ECMA-335 - Common Language Infrastructure (CLI)](https://www.ecma-international.org/publications-and-standards/standards/ecma-335/). -> [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this member no longer requires with the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) To use this functionality, your application should target the .NET Framework 3.5 or later. - ]]> diff --git a/xml/System.Reflection/ConstructorInfo.xml b/xml/System.Reflection/ConstructorInfo.xml index 5bb2e0a821d..adc5f111903 100644 --- a/xml/System.Reflection/ConstructorInfo.xml +++ b/xml/System.Reflection/ConstructorInfo.xml @@ -440,7 +440,7 @@ This method is a convenience method for the following overloaded version, using default values. This method cannot be overridden. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -532,7 +532,7 @@ Note: In .NET for Win > To create an instance of a value type that has no instance constructors, use the method. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> diff --git a/xml/System.Reflection/FieldInfo.xml b/xml/System.Reflection/FieldInfo.xml index 89bb31e3d86..5f67174eb22 100644 --- a/xml/System.Reflection/FieldInfo.xml +++ b/xml/System.Reflection/FieldInfo.xml @@ -952,11 +952,9 @@ > Access restrictions are ignored for fully trusted code. That is, private constructors, methods, fields, and properties can be accessed and invoked through reflection whenever the code is fully trusted. > [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) > -> To use this functionality, your application should target the .NET Framework 3.5 or later. - - +> To use this functionality, your application should target .NET Framework 3.5 or later. ## Examples The following example uses the method to retrieve the value of a static field. Note that the value of the `obj` argument is `null`. @@ -2349,11 +2347,9 @@ This method cannot be used to set values of static, init-only (`readonly` in C#) > Fully trusted code has the permissions that are needed to access and invoke private constructors, methods, fields, and properties using reflection. > [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) > -> To use this functionality, your application should target the .NET Framework 3.5 or later. - - +> To use this functionality, your application should target .NET Framework 3.5 or later. ## Examples The following example sets the value of a field, gets and displays the value, modifies the field, and displays the result. @@ -2446,9 +2442,9 @@ This method cannot be used to set values of static, init-only (`readonly` in C#) > Fully trusted code has the permissions that are needed to access and invoke private constructors, methods, fields, and properties using reflection. > [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) > -> To use this functionality, your application should target the .NET Framework 3.5 or later. +> To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -2522,9 +2518,9 @@ This method cannot be used to set values of static, init-only (`readonly` in C#) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) > -> To use this functionality, your application should target the .NET Framework 3.5 or later. +> To use this functionality, your application should target .NET Framework 3.5 or later. ]]> diff --git a/xml/System.Reflection/MethodBase.xml b/xml/System.Reflection/MethodBase.xml index 0858f66d8b4..1ffe39d960c 100644 --- a/xml/System.Reflection/MethodBase.xml +++ b/xml/System.Reflection/MethodBase.xml @@ -1081,7 +1081,7 @@ > If this method overload is used to invoke an instance constructor, the object supplied for `obj` is reinitialized; that is, all instance initializers are executed. The return value is `null`. If a class constructor is invoked, the class is reinitialized; that is, all class initializers are executed. The return value is `null`. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. If a parameter of the reflected method is a value type, and the corresponding argument in `parameters` is `null`, the runtime passes a zero-initialized instance of the value type. @@ -1209,7 +1209,7 @@ This method dynamically invokes the method reflected by this instance on `obj`, If the invoked method throws an exception, the method returns the originating exception. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. diff --git a/xml/System.Reflection/MethodImplAttributes.xml b/xml/System.Reflection/MethodImplAttributes.xml index 76f76e1a6b1..d769d66e56a 100644 --- a/xml/System.Reflection/MethodImplAttributes.xml +++ b/xml/System.Reflection/MethodImplAttributes.xml @@ -209,6 +209,35 @@ Specifies that the method should be optimized whenever possible. + + + + + + + + Field + + System.Runtime + 10.0.0.0 + + + System.Reflection.Primitives + + + mscorlib + + + netstandard + + + System.Reflection.MethodImplAttributes + + 8192 + + To be added. + + diff --git a/xml/System.Reflection/PropertyInfo.xml b/xml/System.Reflection/PropertyInfo.xml index bfec937c51c..26918164658 100644 --- a/xml/System.Reflection/PropertyInfo.xml +++ b/xml/System.Reflection/PropertyInfo.xml @@ -1526,9 +1526,7 @@ Console.WriteLine("CurrCult: " + To use the `GetValue` method, first get the class `Type`. From the `Type`, get the `PropertyInfo`. From the `PropertyInfo`, use the `GetValue` method. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. - - +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ## Examples The following example shows how to get the value of an indexed property. The property is the default property (the indexer in C#) of the class. @@ -1628,7 +1626,7 @@ Console.WriteLine("CurrCult: " + To use the `GetValue` method, first get the class `Type`. From the `Type`, get the `PropertyInfo`. From the `PropertyInfo`, use the `GetValue` method. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -2093,7 +2091,7 @@ Console.WriteLine("CurrCult: " + To use the method, first get a object that represents the class. From the , get the object. From the object, call the method. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ## Examples The following example declares a class named `Example` with one `static` (`Shared` in Visual Basic) and one instance property. The example uses the method to change the original property values and displays the original and final values. @@ -2308,7 +2306,7 @@ Note: In - - - - - - + + + + + + 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.FieldInfo[] + System.Reflection.FieldInfo[] - + + + + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)] + [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields)>] + + + To be added. @@ -635,22 +656,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.MemberInfo[] + System.Reflection.MemberInfo[] - + + + + [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)>] + + + To be added. @@ -708,23 +750,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.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. @@ -786,46 +850,24 @@ - - - - - - - + + + + + + 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.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. @@ -837,12 +879,37 @@ - - - - - - + + + + + + + Method + + System.Reflection.TypeExtensions + 4.1.5.0 + + + System.Reflection.MethodInfo[] + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + Method System.Reflection.TypeExtensions @@ -869,37 +936,12 @@ - [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)] - [<System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods)>] + [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. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Reflection.TypeExtensions - 4.1.5.0 - - - System.Reflection.MethodInfo[] - - - - + To be added. @@ -910,24 +952,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. @@ -939,23 +1003,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.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. diff --git a/xml/System.Runtime.CompilerServices/AsyncHelpers.xml b/xml/System.Runtime.CompilerServices/AsyncHelpers.xml new file mode 100644 index 00000000000..3df5af40810 --- /dev/null +++ b/xml/System.Runtime.CompilerServices/AsyncHelpers.xml @@ -0,0 +1,433 @@ + + + + + + + + + System.Runtime + 10.0.0.0 + + + System.Object + + + + + [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] + [<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>] + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5007", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + T + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + T + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + T + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + T + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + System.Void + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + System.Runtime.CompilerServices.INotifyCompletion + + + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime + 10.0.0.0 + + + + [System.Runtime.Versioning.RequiresPreviewFeatures] + [<System.Runtime.Versioning.RequiresPreviewFeatures>] + + + + System.Void + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + System.Runtime.CompilerServices.ICriticalNotifyCompletion + + + + + + + + To be added. + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.Runtime.CompilerServices/MethodImplOptions.xml b/xml/System.Runtime.CompilerServices/MethodImplOptions.xml index cf4419f85c0..150d7fdd9af 100644 --- a/xml/System.Runtime.CompilerServices/MethodImplOptions.xml +++ b/xml/System.Runtime.CompilerServices/MethodImplOptions.xml @@ -165,6 +165,32 @@ + + + + + + + + Field + + System.Runtime + 10.0.0.0 + + + mscorlib + + + netstandard + + + System.Runtime.CompilerServices.MethodImplOptions + + 8192 + + To be added. + + diff --git a/xml/System.Runtime.CompilerServices/UnsafeAccessorTypeAttribute.xml b/xml/System.Runtime.CompilerServices/UnsafeAccessorTypeAttribute.xml new file mode 100644 index 00000000000..42839f31451 --- /dev/null +++ b/xml/System.Runtime.CompilerServices/UnsafeAccessorTypeAttribute.xml @@ -0,0 +1,74 @@ + + + + + + + + + System.Runtime + 10.0.0.0 + + + System.Attribute + + + + + [System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue, AllowMultiple=false, Inherited=false)] + [<System.AttributeUsage(System.AttributeTargets.Parameter | System.AttributeTargets.ReturnValue, AllowMultiple=false, Inherited=false)>] + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + To be added. + To be added. + + + + + + + + + + Constructor + + System.Runtime + 10.0.0.0 + + + + + + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Runtime + 10.0.0.0 + + + System.String + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.Runtime.InteropServices.Marshalling/GeneratedComInterfaceAttribute.xml b/xml/System.Runtime.InteropServices.Marshalling/GeneratedComInterfaceAttribute.xml index 35205dabff7..5134abe72d5 100644 --- a/xml/System.Runtime.InteropServices.Marshalling/GeneratedComInterfaceAttribute.xml +++ b/xml/System.Runtime.InteropServices.Marshalling/GeneratedComInterfaceAttribute.xml @@ -49,6 +49,27 @@ To be added. + + + + + + + + Property + + System.Runtime.InteropServices + 10.0.0.0 + + + System.Type + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Runtime.InteropServices.Marshalling/StrategyBasedComWrappers.xml b/xml/System.Runtime.InteropServices.Marshalling/StrategyBasedComWrappers.xml index 7769bb20c9f..9bb4ada2379 100644 --- a/xml/System.Runtime.InteropServices.Marshalling/StrategyBasedComWrappers.xml +++ b/xml/System.Runtime.InteropServices.Marshalling/StrategyBasedComWrappers.xml @@ -24,6 +24,22 @@ [System.Runtime.CompilerServices.Nullable(0)] [<System.Runtime.CompilerServices.Nullable(0)>] + + [System.Runtime.Versioning.UnsupportedOSPlatform("android")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("android")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("ios")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("ios")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("tvos")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("tvos")>] + A -based type that uses customizable strategy objects to implement COM object wrappers and managed object wrappers exposed to COM. @@ -165,6 +181,37 @@ + + + + + + + + Method + + System.Runtime.InteropServices + 10.0.0.0 + + + System.Object + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Runtime.InteropServices/ComWrappers.xml b/xml/System.Runtime.InteropServices/ComWrappers.xml index 45b9c0db934..a687af256b9 100644 --- a/xml/System.Runtime.InteropServices/ComWrappers.xml +++ b/xml/System.Runtime.InteropServices/ComWrappers.xml @@ -166,6 +166,37 @@ If the object cannot be created and `null` is returned, the call to + + + + + + + + Method + + System.Runtime.InteropServices + 10.0.0.0 + + + System.Object + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -291,6 +322,42 @@ If a managed object was previously created for the specified `externalComObject` + + + + + + + + Method + + System.Runtime.InteropServices + 10.0.0.0 + + + System.Object + + + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Runtime.InteropServices/CreatedWrapperFlags.xml b/xml/System.Runtime.InteropServices/CreatedWrapperFlags.xml new file mode 100644 index 00000000000..ade0a56fb6d --- /dev/null +++ b/xml/System.Runtime.InteropServices/CreatedWrapperFlags.xml @@ -0,0 +1,87 @@ + + + + + + + + + System.Runtime.InteropServices + 10.0.0.0 + + + System.Enum + + + + [System.Flags] + [<System.Flags>] + + + + To be added. + To be added. + + + + + + + + + + Field + + System.Runtime.InteropServices + 10.0.0.0 + + + System.Runtime.InteropServices.CreatedWrapperFlags + + 0 + + To be added. + + + + + + + + + + Field + + System.Runtime.InteropServices + 10.0.0.0 + + + System.Runtime.InteropServices.CreatedWrapperFlags + + 2 + + To be added. + + + + + + + + + + Field + + System.Runtime.InteropServices + 10.0.0.0 + + + System.Runtime.InteropServices.CreatedWrapperFlags + + 1 + + To be added. + + + + diff --git a/xml/System.Runtime.InteropServices/HandleRef.xml b/xml/System.Runtime.InteropServices/HandleRef.xml index 4fdec848817..5a949d07e58 100644 --- a/xml/System.Runtime.InteropServices/HandleRef.xml +++ b/xml/System.Runtime.InteropServices/HandleRef.xml @@ -59,19 +59,19 @@ Wraps a managed object holding a handle to a resource that is passed to unmanaged code using platform invoke. - [!IMPORTANT] -> Starting with the .NET Framework 2.0, the functionality of the class has been replaced by the class and its derived classes, as well as by the class. - - If you use platform invoke to call a managed object, and the object is not referenced elsewhere after the platform invoke call, it is possible for the garbage collector to finalize the managed object. This action releases the resource and invalidates the handle, causing the platform invoke call to fail. Wrapping a handle with guarantees that the managed object is not garbage collected until the platform invoke call completes. For a description of platform invoke services, see [Consuming Unmanaged DLL Functions](/dotnet/framework/interop/consuming-unmanaged-dll-functions). - - The value type, like , is a special type recognized by the interop marshaler. A normal, nonpinned also prevents untimely garbage collection, yet provides better performance. Although using to keep an object alive for the duration of a platform invoke call is preferred, you can also use the method for the same purpose. - - The constructor takes two parameters: an representing the wrapper, and an representing the unmanaged handle. The interop marshaler passes only the handle to unmanaged code, and guarantees that the wrapper (passed as the first parameter to the constructor of the `HandleRef`) remains alive for the duration of the call. - +> The functionality of the class has been replaced by the class and its derived classes, as well as by the class. + + If you use platform invoke to call a managed object, and the object is not referenced elsewhere after the platform invoke call, it is possible for the garbage collector to finalize the managed object. This action releases the resource and invalidates the handle, causing the platform invoke call to fail. Wrapping a handle with guarantees that the managed object is not garbage collected until the platform invoke call completes. For a description of platform invoke services, see [Consuming Unmanaged DLL Functions](/dotnet/framework/interop/consuming-unmanaged-dll-functions). + + The value type, like , is a special type recognized by the interop marshaler. A normal, nonpinned also prevents untimely garbage collection, yet provides better performance. Although using to keep an object alive for the duration of a platform invoke call is preferred, you can also use the method for the same purpose. + + The constructor takes two parameters: an representing the wrapper, and an representing the unmanaged handle. The interop marshaler passes only the handle to unmanaged code, and guarantees that the wrapper (passed as the first parameter to the constructor of the `HandleRef`) remains alive for the duration of the call. + ]]> diff --git a/xml/System.Runtime.Intrinsics.Arm/Sve2+Arm64.xml b/xml/System.Runtime.Intrinsics.Arm/Sve2+Arm64.xml new file mode 100644 index 00000000000..14774896f28 --- /dev/null +++ b/xml/System.Runtime.Intrinsics.Arm/Sve2+Arm64.xml @@ -0,0 +1,43 @@ + + + + + + + + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Arm.Sve+Arm64 + + + + To be added. + To be added. + + + + + + + + + + Property + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.Runtime.Intrinsics.Arm/Sve2.xml b/xml/System.Runtime.Intrinsics.Arm/Sve2.xml new file mode 100644 index 00000000000..0a6a63c1383 --- /dev/null +++ b/xml/System.Runtime.Intrinsics.Arm/Sve2.xml @@ -0,0 +1,285 @@ + + + + + + + + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Arm.Sve + + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5003", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Vector<System.Byte> + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Vector<System.Int16> + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Vector<System.Int32> + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Vector<System.Int64> + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Vector<System.SByte> + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Vector<System.UInt16> + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Vector<System.UInt32> + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Vector<System.UInt64> + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Property + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Boolean + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.Runtime.Intrinsics.X86/Avx10v2.xml b/xml/System.Runtime.Intrinsics.X86/Avx10v2.xml index 65b22079953..64107bfc1f2 100644 --- a/xml/System.Runtime.Intrinsics.X86/Avx10v2.xml +++ b/xml/System.Runtime.Intrinsics.X86/Avx10v2.xml @@ -24,973 +24,201 @@ To be added. - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Double> - - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Single> - - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.Int32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.Int32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.Int32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.Int32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.Int32> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.Single> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.Single> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.Single> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.UInt16> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.UInt32> - - - - - - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector128<System.UInt32> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Double> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Double> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Int64> + System.Runtime.Intrinsics.Vector128<System.Int32> - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Int64> - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Single> + System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Single> + System.Runtime.Intrinsics.Vector128<System.Int32> - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.UInt32> + System.Runtime.Intrinsics.Vector256<System.Int32> - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.UInt64> + System.Runtime.Intrinsics.Vector128<System.Int32> - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.UInt64> + System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Double> + System.Runtime.Intrinsics.Vector128<System.Int32> - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + - To be added. - To be added. - To be added. + To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Single> + System.Runtime.Intrinsics.Vector256<System.Int32> - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + - To be added. - To be added. - To be added. + To be added. To be added. To be added. To be added. @@ -1233,287 +461,153 @@ To be added. - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Double> - - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Runtime.Intrinsics - 10.0.0.0 - - - System.Runtime.Intrinsics.Vector256<System.Single> - - - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Double> + System.Runtime.Intrinsics.Vector128<System.Int16> - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + - To be added. - To be added. - To be added. + To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Single> + System.Runtime.Intrinsics.Vector128<System.Int32> - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + - To be added. - To be added. - To be added. + To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Double> + System.Runtime.Intrinsics.Vector128<System.UInt16> - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Single> + System.Runtime.Intrinsics.Vector128<System.UInt32> - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + To be added. - To be added. To be added. To be added. To be added. - - - - - - - + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Double> + System.Void - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + + - To be added. - To be added. - To be added. + To be added. + To be added. To be added. - To be added. To be added. - - - - - - - + + + + + + Method System.Runtime.Intrinsics 10.0.0.0 - System.Runtime.Intrinsics.Vector256<System.Single> + System.Void - - - - - - [System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)] - [<System.Diagnostics.CodeAnalysis.ConstantExpected(Max=System.Runtime.Intrinsics.X86.FloatRoundingMode.ToZero)>] - - - + + - To be added. - To be added. - To be added. + To be added. + To be added. To be added. - To be added. To be added. diff --git a/xml/System.Runtime.Intrinsics/Vector128.xml b/xml/System.Runtime.Intrinsics/Vector128.xml index 920bf313161..82005b46e94 100644 --- a/xml/System.Runtime.Intrinsics/Vector128.xml +++ b/xml/System.Runtime.Intrinsics/Vector128.xml @@ -136,6 +136,57 @@ The type of and () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector128<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -834,6 +885,56 @@ The type of () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Plane + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Numerics.Quaternion + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -1197,6 +1298,56 @@ The type of () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector128<System.Single> + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector128<System.Single> + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -9071,6 +9222,219 @@ This method may bypass the cache on certain platforms. To be added. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector128<System.Single> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector128<System.SByte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector128<System.Int16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector128<System.Int32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector128<System.Byte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector128<System.UInt16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector128<System.UInt32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -11378,6 +11742,57 @@ This method may bypass the cache on certain platforms. The type of and () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector128<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Runtime.Intrinsics/Vector256.xml b/xml/System.Runtime.Intrinsics/Vector256.xml index 61183bda0d8..37d15afd5d8 100644 --- a/xml/System.Runtime.Intrinsics/Vector256.xml +++ b/xml/System.Runtime.Intrinsics/Vector256.xml @@ -136,6 +136,57 @@ The type of and () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector256<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -9032,6 +9083,219 @@ This method may bypass the cache on certain platforms. To be added. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector256<System.Single> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector256<System.SByte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector256<System.Int16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector256<System.Int32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector256<System.Byte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector256<System.UInt16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector256<System.UInt32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -11339,6 +11603,57 @@ This method may bypass the cache on certain platforms. The type of and () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector256<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Runtime.Intrinsics/Vector512.xml b/xml/System.Runtime.Intrinsics/Vector512.xml index 3f28bfd58cf..9a883f0fc3f 100644 --- a/xml/System.Runtime.Intrinsics/Vector512.xml +++ b/xml/System.Runtime.Intrinsics/Vector512.xml @@ -119,6 +119,57 @@ The type of and () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector512<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -8418,6 +8469,219 @@ To be added. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector512<System.Single> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector512<System.SByte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector512<System.Int16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector512<System.Int32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector512<System.Byte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector512<System.UInt16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector512<System.UInt32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -10631,6 +10895,57 @@ The type of and () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector512<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Runtime.Intrinsics/Vector64.xml b/xml/System.Runtime.Intrinsics/Vector64.xml index 0542e954e77..b742e757931 100644 --- a/xml/System.Runtime.Intrinsics/Vector64.xml +++ b/xml/System.Runtime.Intrinsics/Vector64.xml @@ -136,6 +136,57 @@ The type of and () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector64<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -7820,6 +7871,219 @@ This method may bypass the cache on certain platforms. To be added. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector64<System.Single> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector64<System.SByte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector64<System.Int16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector64<System.Int32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector64<System.Byte> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector64<System.UInt16> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + + [System.CLSCompliant(false)] + [<System.CLSCompliant(false)>] + + + + System.Runtime.Intrinsics.Vector64<System.UInt32> + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -9936,6 +10200,57 @@ This method may bypass the cache on certain platforms. The type of and () is not supported. + + + + + + + + Method + + System.Runtime.Intrinsics + 10.0.0.0 + + + System.Runtime.Intrinsics.Vector64<T> + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + + [System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })] + [<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>] + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Runtime.Serialization.Formatters.Soap/SoapFormatter.xml b/xml/System.Runtime.Serialization.Formatters.Soap/SoapFormatter.xml index d91d663d8f1..34075c19380 100644 --- a/xml/System.Runtime.Serialization.Formatters.Soap/SoapFormatter.xml +++ b/xml/System.Runtime.Serialization.Formatters.Soap/SoapFormatter.xml @@ -27,7 +27,7 @@ [!NOTE] -> Beginning with .NET Framework 2.0, this class is obsolete. +> This class is obsolete. [!INCLUDE[binaryformatter](~/includes/binaryformatter.md)] diff --git a/xml/System.Runtime.Serialization/NetDataContractSerializer.xml b/xml/System.Runtime.Serialization/NetDataContractSerializer.xml index 2105195bc27..ec298b120b1 100644 --- a/xml/System.Runtime.Serialization/NetDataContractSerializer.xml +++ b/xml/System.Runtime.Serialization/NetDataContractSerializer.xml @@ -20,7 +20,7 @@ - Serializes and deserializes an instance of a type into XML stream or document using the supplied .NET Framework types. This class cannot be inherited. + Serializes and deserializes an instance of a type into XML stream or document using the supplied .NET types. This class cannot be inherited. The to transform into an XML schema. - Transforms the specified .NET Framework type into an XML schema definition language (XSD) schema. + Transforms the specified .NET type into an XML schema definition language (XSD) schema. Use the if you are creating a Web service that must interoperate with an existing Web service, or to create data contract types from XML schemas. will transform a - set of XML schemas and create the .NET Framework types that represent the data contract in a selected programming language. + set of XML schemas and create the .NET types that represent the data contract in a selected programming language. To create the code, use the classes in the namespace. - + Conversely, use the class when you have created a Web service that incorporates data represented by CLR types and when you need to export XML schemas for each data type to be consumed by other Web services.That is, transforms a set of CLR types into a set of XML schemas. @@ -106,19 +106,19 @@ Initializes a new instance of the class with the that will be used to generate CLR code. - that has already been generated. - - - -## Examples - The following example creates an and calls the method to create a . The is then used to create both Visual C# and Visual Basic code files. - + that has already been generated. + + + +## Examples + The following example creates an and calls the method to create a . The is then used to create both Visual C# and Visual Basic code files. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/xsddatacontractimporter/cs/xsddatacontractimporterexample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xsddatacontractimporter/vb/xsddatacontractimporterexample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xsddatacontractimporter/vb/xsddatacontractimporterexample.vb" id="Snippet1"::: + ]]> @@ -131,11 +131,11 @@ Gets a value that indicates whether the schemas can be transformed into a . - @@ -177,14 +177,14 @@ if the schemas can be transformed to data contract types; otherwise, . - method to determine whether the can be generated. - + method to determine whether the can be generated. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/xsddatacontractimporter/cs/xsddatacontractimporterexample.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xsddatacontractimporter/vb/xsddatacontractimporterexample.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xsddatacontractimporter/vb/xsddatacontractimporterexample.vb" id="Snippet2"::: + ]]> The parameter is . @@ -273,11 +273,11 @@ if the element can be imported; otherwise, . - The or parameter is . @@ -323,11 +323,11 @@ if the schemas can be transformed to data contract types; otherwise, . - The or parameter is . @@ -360,19 +360,19 @@ A used to store the CLR types generated. - to access the in which all the generated code is stored. - - - -## Examples - The following example uses creates a . The is then used to create both a Visual C# and Visual Basic code file. - + to access the in which all the generated code is stored. + + + +## Examples + The following example uses creates a . The is then used to create both a Visual C# and Visual Basic code file. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/xsddatacontractimporter/cs/xsddatacontractimporterexample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xsddatacontractimporter/vb/xsddatacontractimporterexample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xsddatacontractimporter/vb/xsddatacontractimporterexample.vb" id="Snippet1"::: + ]]> @@ -424,11 +424,11 @@ A reference to the CLR type generated for the schema type with the typeName specified. - method. The contains the name of the generated type and can be used to look up the corresponding in the . - + method. The contains the name of the generated type and can be used to look up the corresponding in the . + ]]> @@ -471,13 +471,13 @@ A that represents the type that was generated for the specified schema type. - . The element is passed in so that this importer can look up the element-level information and return the correct type reference accordingly. - - When importing WSDL, each parameter is imported separately and therefore the parameter elements need to be passed in separately. - + . The element is passed in so that this importer can look up the element-level information and return the correct type reference accordingly. + + When importing WSDL, each parameter is imported separately and therefore the parameter elements need to be passed in separately. + ]]> @@ -525,13 +525,13 @@ A collection of type . - class. ) However, for the top-level type, there needs to be a way to return the set of known types generated. This method returns the for known types that were generated for a specific schema type. - - For more information, see [Data Contract Known Types](/dotnet/framework/wcf/feature-details/data-contract-known-types). - + class. ) However, for the top-level type, there needs to be a way to return the set of known types generated. This method returns the for known types that were generated for a specific schema type. + + For more information, see [Data Contract Known Types](/dotnet/framework/wcf/feature-details/data-contract-known-types). + ]]> @@ -582,14 +582,14 @@ Transforms the specified set of XML schemas contained in an into a . - method to test whether a set of schemas can be imported. If the method returns `true`, the code invokes the method. - + method to test whether a set of schemas can be imported. If the method returns `true`, the code invokes the method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_CFX/xsddatacontractimporter/cs/xsddatacontractimporterexample.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xsddatacontractimporter/vb/xsddatacontractimporterexample.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CFX/xsddatacontractimporter/vb/xsddatacontractimporterexample.vb" id="Snippet2"::: + ]]> The parameter is . @@ -756,11 +756,11 @@ A that contains settable options. - class to customize how the CLR types are generated during schema import. - + class to customize how the CLR types are generated during schema import. + ]]> diff --git a/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml b/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml index b14b6d95f6e..c8467ef61f1 100644 --- a/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml +++ b/xml/System.Security.Cryptography.Pkcs/CmsSigner.xml @@ -368,15 +368,15 @@ System.Security - + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - - - + + + To be added. diff --git a/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml b/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml index 316379dcf10..754af2b2818 100644 --- a/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml +++ b/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml @@ -95,8 +95,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -110,6 +110,41 @@ To be added. + + + + + + + + Constructor + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -130,8 +165,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -145,6 +180,41 @@ To be added. + + + + + + + + Constructor + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + + + + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml b/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml index c2b4c6119c2..3d8bf66fce2 100644 --- a/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml +++ b/xml/System.Security.Cryptography.X509Certificates/PublicKey.xml @@ -115,6 +115,39 @@ has not been overridden in a derived class. + + + + + + + + Constructor + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + + + + + + + To be added. + To be added. + To be added. + + @@ -135,8 +168,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -148,6 +181,39 @@ To be added. + + + + + + + + Constructor + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + + + + + To be added. + To be added. + To be added. + + @@ -543,8 +609,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] @@ -581,8 +647,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] @@ -638,6 +704,44 @@ The key contents are corrupt or could not be read successfully. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + [System.Runtime.Versioning.UnsupportedOSPlatform("browser")] + [<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>] + + + + System.Security.Cryptography.SlhDsa + + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml b/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml index 65c716eff02..52645139a32 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509Certificate2.xml @@ -1475,8 +1475,8 @@ The specified private key doesn't match the public key for this certificate. - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -1512,8 +1512,8 @@ The specified private key doesn't match the public key for this certificate. - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -1529,6 +1529,43 @@ The specified private key doesn't match the public key for this certificate.To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + + System.Security.Cryptography.X509Certificates.X509Certificate2 + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -2387,8 +2424,8 @@ The certificate is encoded according to the IETF RFC 7468 "strict" - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -2421,8 +2458,8 @@ The certificate is encoded according to the IETF RFC 7468 "strict" - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -2455,8 +2492,8 @@ The certificate is encoded according to the IETF RFC 7468 "strict" - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -2489,8 +2526,8 @@ The certificate is encoded according to the IETF RFC 7468 "strict" - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -2570,6 +2607,74 @@ The certificate is encoded according to the IETF RFC 7468 "strict" + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + + System.Security.Cryptography.SlhDsa + + + + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + + System.Security.Cryptography.SlhDsa + + + + To be added. + To be added. + To be added. + + diff --git a/xml/System.Security.Cryptography.X509Certificates/X509SignatureGenerator.xml b/xml/System.Security.Cryptography.X509Certificates/X509SignatureGenerator.xml index dd6488d63ae..0608a32eeb6 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509SignatureGenerator.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509SignatureGenerator.xml @@ -199,8 +199,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -269,6 +269,43 @@ The specified padding mode is not valid for this algorithm. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + netstandard + + + System.Security.Cryptography.X509Certificates + + + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] + + + + System.Security.Cryptography.X509Certificates.X509SignatureGenerator + + + + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Security.Cryptography/HMACSHA384.xml b/xml/System.Security.Cryptography/HMACSHA384.xml index ed2e8903e11..15183f83b0d 100644 --- a/xml/System.Security.Cryptography/HMACSHA384.xml +++ b/xml/System.Security.Cryptography/HMACSHA384.xml @@ -1033,7 +1033,7 @@ Boolean property is to enable .NET Framework 2.0 Service Pack 1 applications to interact with .NET Framework 2.0 applications. When you set this property to `true`, the object produces values that match the values produced by the .NET Framework 2.0. You should set this property only once after you create your HMAC object. You will need to reset your key afterwards, as shown in the following example. + The purpose of the Boolean property is to enable .NET Framework 2.0 Service Pack 1 applications to interact with .NET Framework 2.0 applications. When you set this property to `true`, the object produces values that match the values produced by .NET Framework 2.0. You should set this property only once after you create your HMAC object. You will need to reset your key afterwards, as shown in the following example. ```csharp public static void Test() diff --git a/xml/System.Security.Cryptography/HMACSHA512.xml b/xml/System.Security.Cryptography/HMACSHA512.xml index b4768d235fe..4e89afdeef0 100644 --- a/xml/System.Security.Cryptography/HMACSHA512.xml +++ b/xml/System.Security.Cryptography/HMACSHA512.xml @@ -1033,7 +1033,7 @@ Boolean property is to enable .NET Framework 2.0 Service Pack 1 applications to interact with .NET Framework 2.0 applications. When you set this property to `true`, the object produces values that match the values produced by the .NET Framework 2.0. You should set this property only once after you create your HMAC object. You will need to reset your key afterwards, as shown in the following example. + The purpose of the Boolean property is to enable .NET Framework 2.0 Service Pack 1 applications to interact with .NET Framework 2.0 applications. When you set this property to `true`, the object produces values that match the values produced by .NET Framework 2.0. You should set this property only once after you create your HMAC object. You will need to reset your key afterwards, as shown in the following example. ```csharp public static void Test() diff --git a/xml/System.Security.Cryptography/MLDsa.xml b/xml/System.Security.Cryptography/MLDsa.xml index 3291b62196e..b16e9dea0ff 100644 --- a/xml/System.Security.Cryptography/MLDsa.xml +++ b/xml/System.Security.Cryptography/MLDsa.xml @@ -19,8 +19,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -192,6 +192,33 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Byte[] + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -260,6 +287,33 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.String + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -586,6 +640,33 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Security.Cryptography.MLDsa + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -652,6 +733,60 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Security.Cryptography.MLDsa + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Security.Cryptography.MLDsa + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -683,6 +818,31 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Security.Cryptography.MLDsa + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -785,6 +945,31 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Security.Cryptography.MLDsa + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -816,6 +1001,31 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Security.Cryptography.MLDsa + + + + + + To be added. + To be added. + To be added. + To be added. + + @@ -924,27 +1134,6 @@ To be added. - - - - - - - - Method - - System.Security.Cryptography - 10.0.0.0 - - - System.Void - - - - To be added. - To be added. - - @@ -1021,6 +1210,44 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Boolean + + + + + + + + [System.Runtime.CompilerServices.Nullable(0)] + [<System.Runtime.CompilerServices.Nullable(0)>] + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + @@ -1048,6 +1275,33 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Security.Cryptography/MLDsaAlgorithm.xml b/xml/System.Security.Cryptography/MLDsaAlgorithm.xml index 32957f315bc..8b61131a7a9 100644 --- a/xml/System.Security.Cryptography/MLDsaAlgorithm.xml +++ b/xml/System.Security.Cryptography/MLDsaAlgorithm.xml @@ -15,8 +15,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Runtime.CompilerServices.Nullable(0)] diff --git a/xml/System.Security.Cryptography/MLDsaOpenSsl.xml b/xml/System.Security.Cryptography/MLDsaOpenSsl.xml index fe48401e8d1..e7d582a262b 100644 --- a/xml/System.Security.Cryptography/MLDsaOpenSsl.xml +++ b/xml/System.Security.Cryptography/MLDsaOpenSsl.xml @@ -15,8 +15,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] @@ -217,6 +217,33 @@ To be added. + + + + + + + + Method + + System.Security.Cryptography + 10.0.0.0 + + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System.Security.Cryptography/MLKem.xml b/xml/System.Security.Cryptography/MLKem.xml index 01c7207fbfe..f199c671ae4 100644 --- a/xml/System.Security.Cryptography/MLKem.xml +++ b/xml/System.Security.Cryptography/MLKem.xml @@ -22,18 +22,14 @@ - - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Runtime.CompilerServices.Nullable(0)] [<System.Runtime.CompilerServices.Nullable(0)>] - - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - To be added. @@ -1144,51 +1140,14 @@ System.Security.Cryptography - - - System.Security.Cryptography.MLKem - - - - - - - To be added. - To be added. - To be added. - To be added. - To be added. - - - - - - - - - - Method - - System.Security.Cryptography - 10.0.0.0 - - - Microsoft.Bcl.Cryptography 10.0.0.0 System.Security.Cryptography.MLKem - - - - - [System.Runtime.CompilerServices.Nullable(0)] - [<System.Runtime.CompilerServices.Nullable(0)>] - - - + + To be added. diff --git a/xml/System.Security.Cryptography/MLKemAlgorithm.xml b/xml/System.Security.Cryptography/MLKemAlgorithm.xml index aab40fcd482..3ce910afb9a 100644 --- a/xml/System.Security.Cryptography/MLKemAlgorithm.xml +++ b/xml/System.Security.Cryptography/MLKemAlgorithm.xml @@ -22,18 +22,14 @@ - - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Runtime.CompilerServices.Nullable(0)] [<System.Runtime.CompilerServices.Nullable(0)>] - - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - [System.Diagnostics.DebuggerDisplay("{Name,nq}")] [<System.Diagnostics.DebuggerDisplay("{Name,nq}")>] diff --git a/xml/System.Security.Cryptography/MLKemOpenSsl.xml b/xml/System.Security.Cryptography/MLKemOpenSsl.xml index 2cb37b57320..6c2f6eb628b 100644 --- a/xml/System.Security.Cryptography/MLKemOpenSsl.xml +++ b/xml/System.Security.Cryptography/MLKemOpenSsl.xml @@ -15,8 +15,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] diff --git a/xml/System.Security.Cryptography/SlhDsa.xml b/xml/System.Security.Cryptography/SlhDsa.xml index aa5ae242315..1ba8e09a3d2 100644 --- a/xml/System.Security.Cryptography/SlhDsa.xml +++ b/xml/System.Security.Cryptography/SlhDsa.xml @@ -22,15 +22,11 @@ - - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] - - + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - + [System.Runtime.CompilerServices.Nullable(0)] [<System.Runtime.CompilerServices.Nullable(0)>] @@ -81,12 +77,6 @@ Microsoft.Bcl.Cryptography 10.0.0.0 - - - [System.Runtime.CompilerServices.Nullable(1)] - [<System.Runtime.CompilerServices.Nullable(1)>] - - System.Security.Cryptography.SlhDsaAlgorithm @@ -242,13 +232,14 @@ System.Security.Cryptography + 10.0.0.0 System.Byte[] - - + + To be added. @@ -348,13 +339,14 @@ System.Security.Cryptography + 10.0.0.0 System.String - - + + To be added. @@ -430,6 +422,7 @@ System.Security.Cryptography + 10.0.0.0 System.Byte[] @@ -442,17 +435,12 @@ - - + + - - - - - - - - + + + Method System.Security.Cryptography @@ -463,8 +451,7 @@ 10.0.0.0 - System.Int32 - System.Void + System.Void @@ -518,6 +505,7 @@ System.Security.Cryptography + 10.0.0.0 System.Byte[] @@ -530,17 +518,12 @@ - - + + - - - - - - - - + + + Method System.Security.Cryptography @@ -551,8 +534,7 @@ 10.0.0.0 - System.Int32 - System.Void + System.Void @@ -761,13 +743,14 @@ System.Security.Cryptography + 10.0.0.0 System.Security.Cryptography.SlhDsa - - + + To be added. @@ -865,13 +848,14 @@ System.Security.Cryptography + 10.0.0.0 System.Security.Cryptography.SlhDsa - - + + To be added. @@ -895,13 +879,14 @@ System.Security.Cryptography + 10.0.0.0 System.Security.Cryptography.SlhDsa - - + + To be added. @@ -960,12 +945,13 @@ System.Security.Cryptography + 10.0.0.0 System.Security.Cryptography.SlhDsa - + To be added. @@ -988,12 +974,13 @@ System.Security.Cryptography + 10.0.0.0 System.Security.Cryptography.SlhDsa - + To be added. @@ -1051,13 +1038,14 @@ System.Security.Cryptography + 10.0.0.0 System.Security.Cryptography.SlhDsa - - + + To be added. @@ -1119,13 +1107,14 @@ System.Security.Cryptography + 10.0.0.0 System.Security.Cryptography.SlhDsa - - + + To be added. @@ -1187,12 +1176,13 @@ System.Security.Cryptography + 10.0.0.0 System.Security.Cryptography.SlhDsa - + To be added. @@ -1274,15 +1264,16 @@ System.Security.Cryptography + 10.0.0.0 System.Byte[] - - + + - + [System.Runtime.CompilerServices.Nullable(2)] [<System.Runtime.CompilerServices.Nullable(2)>] @@ -1298,15 +1289,11 @@ - - + + - - - - - - + + Method System.Security.Cryptography @@ -1317,8 +1304,7 @@ 10.0.0.0 - System.Int32 - System.Void + System.Void @@ -1489,22 +1475,23 @@ System.Security.Cryptography + 10.0.0.0 System.Boolean - - - + + + - + [System.Runtime.CompilerServices.Nullable(0)] [<System.Runtime.CompilerServices.Nullable(0)>] - + To be added. @@ -1561,13 +1548,14 @@ System.Security.Cryptography + 10.0.0.0 System.Boolean - - + + To be added. @@ -1621,16 +1609,17 @@ System.Security.Cryptography + 10.0.0.0 System.Boolean - - - + + + - + [System.Runtime.CompilerServices.Nullable(2)] [<System.Runtime.CompilerServices.Nullable(2)>] diff --git a/xml/System.Security.Cryptography/SlhDsaAlgorithm.xml b/xml/System.Security.Cryptography/SlhDsaAlgorithm.xml index 751982ecd0f..f18b3ad4f51 100644 --- a/xml/System.Security.Cryptography/SlhDsaAlgorithm.xml +++ b/xml/System.Security.Cryptography/SlhDsaAlgorithm.xml @@ -18,18 +18,14 @@ - - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] [System.Runtime.CompilerServices.Nullable(0)] [<System.Runtime.CompilerServices.Nullable(0)>] - - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] - [System.Diagnostics.DebuggerDisplay("{Name,nq}")] [<System.Diagnostics.DebuggerDisplay("{Name,nq}")>] diff --git a/xml/System.Security.Cryptography/SlhDsaOpenSsl.xml b/xml/System.Security.Cryptography/SlhDsaOpenSsl.xml index 795dc03391c..3812dfab7fc 100644 --- a/xml/System.Security.Cryptography/SlhDsaOpenSsl.xml +++ b/xml/System.Security.Cryptography/SlhDsaOpenSsl.xml @@ -15,8 +15,8 @@ - [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")] - [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006")>] + [System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("SYSLIB5006", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>] diff --git a/xml/System.Security.Permissions/ReflectionPermissionAttribute.xml b/xml/System.Security.Permissions/ReflectionPermissionAttribute.xml index 30c388771a0..4a1f654f013 100644 --- a/xml/System.Security.Permissions/ReflectionPermissionAttribute.xml +++ b/xml/System.Security.Permissions/ReflectionPermissionAttribute.xml @@ -53,16 +53,16 @@ Allows security actions for to be applied to code using declarative security. - that is used. - - The security information declared by a security attribute is stored in the metadata of the attribute target and is accessed by the system at run time. Security attributes are used only for declarative security. For imperative security, use the corresponding permission class. - + The scope of the declaration that is allowed depends on the that is used. + + The security information declared by a security attribute is stored in the metadata of the attribute target and is accessed by the system at run time. Security attributes are used only for declarative security. For imperative security, use the corresponding permission class. + ]]> @@ -141,13 +141,13 @@ Creates and returns a new . A that corresponds to this attribute. - @@ -271,18 +271,7 @@ Gets or sets a value that indicates whether use of certain features in , such as emitting debug symbols, is allowed. if use of the affected features is allowed; otherwise, . - - [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, emitting code no longer requires with the flag. Some features of reflection emit, such as emitting debug symbols, still require the flag. (See [Security Issues in Reflection Emit](/dotnet/framework/reflection-and-codedom/security-issues-in-reflection-emit).) -> -> To use this functionality, your application should target the .NET Framework 3.5 or later. - - ]]> - + To be added. @@ -317,16 +306,7 @@ Gets or sets a value that indicates whether restricted invocation of non-public members is allowed. Restricted invocation means that the grant set of the assembly that contains the non-public member that is being invoked must be equal to, or a subset of, the grant set of the invoking assembly. if restricted invocation of non-public members is allowed; otherwise, . - - [!NOTE] -> This property is introduced in the .NET Framework 2.0 Service Pack 1. To use this property, your application should target the .NET Framework 3.5 or later. - - ]]> - + To be added. Security Issues in Reflection Emit Security Considerations for Reflection @@ -379,11 +359,11 @@ if reflection on members that are not visible is allowed; otherwise, . - . - + . + ]]> diff --git a/xml/System.Security.Permissions/ReflectionPermissionFlag.xml b/xml/System.Security.Permissions/ReflectionPermissionFlag.xml index b6da1e72f46..ff8d809c7b8 100644 --- a/xml/System.Security.Permissions/ReflectionPermissionFlag.xml +++ b/xml/System.Security.Permissions/ReflectionPermissionFlag.xml @@ -52,36 +52,28 @@ Specifies the permitted use of the and namespaces. - and classes. If no is granted, reflection is allowed on all types and members, but invocation operations are allowed only on visible types and members. For more information, see [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection). - + This enumeration is used by the and classes. If no is granted, reflection is allowed on all types and members, but invocation operations are allowed only on visible types and members. For more information, see [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection). + > [!CAUTION] -> Because can provide access to private class members, we recommend that you grant to Internet code only with the `RestrictedMemberAccess` flag, and not with any other flags. - - The `RestrictedMemberAccess` flag is introduced in the .NET Framework 2.0 SP1. To use this flag, your application should target the .NET Framework 3.5 or later. - +> Because can provide access to private class members, we recommend that you grant to Internet code only with the `RestrictedMemberAccess` flag, and not with any other flags. + > [!IMPORTANT] -> `AllFlags` does not include the `RestrictedMemberAccess` flag. To get a mask that includes all flags in this enumeration, you must use the combination of `AllFlags` with `RestrictedMemberAccess`. - - Starting with the .NET Framework 2.0 SP1, the `ReflectionEmit` flag is no longer required to emit code, unless debug symbols are emitted. To use this feature, your application should target the .NET Framework 3.5 or later. - - Starting with the .NET Framework 2.0, the `TypeInformation` flag is no longer required to reflect on nonpublic types and members; the flag has been marked obsolete. - - - -## Examples - The following example shows how to use the `ReflectionPermissionFlag` enumeration to initialize a new instance of the class that represents the right to perform restricted member access. This example is part of a larger example that is provided for the class. - - For an example that shows how to use the RestrictedMemberAccess flag with Internet code, see [Walkthrough: Emitting Code in Partial Trust Scenarios](/dotnet/framework/reflection-and-codedom/walkthrough-emitting-code-in-partial-trust-scenarios). - +> `AllFlags` does not include the `RestrictedMemberAccess` flag. To get a mask that includes all flags in this enumeration, you must use the combination of `AllFlags` with `RestrictedMemberAccess`. + +## Examples + The following example shows how to use the `ReflectionPermissionFlag` enumeration to initialize a new instance of the class that represents the right to perform restricted member access. This example is part of a larger example that is provided for the class. + + For an example that shows how to use the RestrictedMemberAccess flag with Internet code, see [Walkthrough: Emitting Code in Partial Trust Scenarios](/dotnet/framework/reflection-and-codedom/walkthrough-emitting-code-in-partial-trust-scenarios). + :::code language="csharp" source="~/snippets/csharp/System.Security.Permissions/ReflectionPermission/.ctor/reflectionpermission.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.ReflectionPermission/VB/reflectionpermission.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Security.Permissions.ReflectionPermission/VB/reflectionpermission.vb" id="Snippet8"::: + ]]> @@ -252,7 +244,7 @@ 4 - Emitting debug symbols is allowed. Beginning with the .NET Framework 2.0 Service Pack 1, this flag is no longer required to emit code. + Emitting debug symbols is allowed. Beginning with .NET Framework 2.0 Service Pack 1, this flag is no longer required to emit code. @@ -291,7 +283,7 @@ 8 - Restricted member access is provided for partially trusted code. Partially trusted code can access nonpublic types and members, but only if the grant set of the partially trusted code includes all permissions in the grant set of the assembly that contains the nonpublic types and members being accessed. This flag is new in the .NET Framework 2.0 SP1. + Restricted member access is provided for partially trusted code. Partially trusted code can access nonpublic types and members, but only if the grant set of the partially trusted code includes all permissions in the grant set of the assembly that contains the nonpublic types and members being accessed. diff --git a/xml/System.Security/SecurityRuleSet.xml b/xml/System.Security/SecurityRuleSet.xml index 4feecd2d84e..371ce69065f 100644 --- a/xml/System.Security/SecurityRuleSet.xml +++ b/xml/System.Security/SecurityRuleSet.xml @@ -41,11 +41,11 @@ Identifies the set of security rules the common language runtime should enforce for an assembly. - Security Changes in the .NET Framework Version 4.0 diff --git a/xml/System.Text.RegularExpressions/CaptureCollection.xml b/xml/System.Text.RegularExpressions/CaptureCollection.xml index 97e3c78e635..16435a58a75 100644 --- a/xml/System.Text.RegularExpressions/CaptureCollection.xml +++ b/xml/System.Text.RegularExpressions/CaptureCollection.xml @@ -1271,7 +1271,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. +This method uses the collection's objects' and methods on `value` to determine whether `value` exists. ]]> @@ -1322,7 +1322,7 @@ Starting with the .NET Framework 2.0, this method uses the collection's objects' ## Remarks -Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. +This method uses the collection's objects' and methods on `value` to determine whether `value` exists. ]]> diff --git a/xml/System.Text.RegularExpressions/MatchCollection.xml b/xml/System.Text.RegularExpressions/MatchCollection.xml index af8f248a014..c35d6095551 100644 --- a/xml/System.Text.RegularExpressions/MatchCollection.xml +++ b/xml/System.Text.RegularExpressions/MatchCollection.xml @@ -1313,7 +1313,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. +This method uses the collection's objects' and methods on `value` to determine whether `value` exists. ]]> @@ -1364,7 +1364,7 @@ Starting with the .NET Framework 2.0, this method uses the collection's objects' ## Remarks -Starting with the .NET Framework 2.0, this method uses the collection's objects' and methods on `item` to determine whether item exists. In earlier versions of the .NET Framework, this determination was made by using the and methods of the `item` parameter on the objects in the collection. +This method uses the collection's objects' and methods on `value` to determine whether `value` exists. ]]> diff --git a/xml/System.Text.RegularExpressions/Regex.xml b/xml/System.Text.RegularExpressions/Regex.xml index 0e4fe10fb97..5d4b22dddc0 100644 --- a/xml/System.Text.RegularExpressions/Regex.xml +++ b/xml/System.Text.RegularExpressions/Regex.xml @@ -554,7 +554,7 @@ The value in a set operation is less than zero. - In the .NET Framework prior to the .NET Framework 2.0 SP1, regular expressions used in both static and instance method calls were cached. Beginning with the .NET Framework 2.0 SP1, only regular expressions used in static method calls are cached. + Only regular expressions used in static method calls are cached. @@ -6374,12 +6374,9 @@ For more details about `startat`, see the Remarks section of will split the string into an array of single-character strings because the empty string delimiter can be found at every location. For example: + If the regular expression can match the empty string, splits the string into an array of single-character strings because the empty string delimiter can be found at every location. For example: :::code language="csharp" source="~/snippets/csharp/System.Text.RegularExpressions/Regex/Split/split11.cs" interactive="try-dotnet" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.RegularExpressions.Regex.Split/vb/split11.vb" id="Snippet11"::: @@ -6460,7 +6457,7 @@ For more details about `startat`, see the Remarks section of method then specifies a maximum of two elements in the returned array. If the example code is compiled and run under the .NET Framework 1.0 or 1.1, the method returns a two-element string array. If it is compiled and run under the .NET Framework 2.0 or later versions, the method returns a three-element string array. +If the regular expression pattern includes multiple sets of capturing parentheses, and a match isn't found within the first set of capturing parentheses, captured text from additional capturing parentheses is included in the returned array. However, elements in the returned array that contain captured text are not counted in determining whether the number of matched substrings equals `count`. For example, in the following code, a regular expression uses two sets of capturing parentheses to extract the elements of a date from a date string. The first set of capturing parentheses captures the hyphen, and the second set captures the forward slash. The call to the method then specifies a maximum of two elements in the returned array. The method returns a three-element string array. :::code language="csharp" source="~/snippets/csharp/System.Text.RegularExpressions/Regex/Split/split5.cs" interactive="try-dotnet" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.RegularExpressions.Regex.Split/vb/split5.vb" id="Snippet5"::: @@ -6560,10 +6557,7 @@ For more details about `startat`, see the Remarks section of will split the string into an array of single-character strings because the empty string delimiter can be found at every location. For example: @@ -6656,12 +6650,9 @@ For more details about `startat`, see the Remarks section of will split the string into an array of single-character strings because the empty string delimiter can be found at every location. The following example splits the string "characters" into as many elements as the input string contains, starting with the character "a". Because the null string matches the end of the input string, a null string is inserted at the end of the returned array. + If the regular expression can match the empty string, splits the string into an array of single-character strings because the empty string delimiter can be found at every location. The following example splits the string "characters" into as many elements as the input string contains, starting with the character "a". Because the null string matches the end of the input string, a null string is inserted at the end of the returned array. :::code language="csharp" source="~/snippets/csharp/System.Text.RegularExpressions/Regex/Split/split14.cs" interactive="try-dotnet" id="Snippet14"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.RegularExpressions.Regex.Split/vb/split14.vb" id="Snippet14"::: @@ -6758,10 +6749,7 @@ For more details about `startat`, see the Remarks section of will split the string into an array of single-character strings because the empty string delimiter can be found at every location. @@ -6861,10 +6849,7 @@ For more details about `startat`, see the Remarks section of will split the string into an array of single-character strings because the empty string delimiter can be found at every location. diff --git a/xml/System.Threading/Interlocked.xml b/xml/System.Threading/Interlocked.xml index 0b5a99cdae5..292d8139635 100644 --- a/xml/System.Threading/Interlocked.xml +++ b/xml/System.Threading/Interlocked.xml @@ -951,7 +951,7 @@ ## Remarks > [!IMPORTANT] -> Beginning with .NET Framework 2.0, the method overload provides a type-safe alternative for reference types. We recommend that you call it instead of this overload. +> The method overload provides a type-safe alternative for reference types. We recommend that you call it instead of this overload. If `comparand` and the object in `location1` are equal by reference, then `value` is stored in `location1`. Otherwise, no operation is performed. The compare and exchange operations are performed as an atomic operation. The return value of is the original value in `location1`, whether or not the exchange takes place. @@ -2008,7 +2008,7 @@ If `comparand` and the object in `location1` are equal by reference, then `value ## Remarks > [!IMPORTANT] -> Beginning with .NET Framework 2.0, the method overload provides a type-safe alternative for reference types. We recommend that you call it instead of this overload. +> The method overload provides a type-safe alternative for reference types. We recommend that you call it instead of this overload. ]]> diff --git a/xml/System.Web.Compilation/BuildManager.xml b/xml/System.Web.Compilation/BuildManager.xml index 826afc981c0..e95133b024e 100644 --- a/xml/System.Web.Compilation/BuildManager.xml +++ b/xml/System.Web.Compilation/BuildManager.xml @@ -17,13 +17,13 @@ Provides a set of methods to help manage the compilation of an ASP.NET application. - class manages the process of compiling assemblies and pages for an application. It is a sealed class and cannot be inherited. - - contains static members that provide information about the compiled assemblies. - + class manages the process of compiling assemblies and pages for an application. It is a sealed class and cannot be inherited. + + contains static members that provide information about the compiled assemblies. + ]]> @@ -53,11 +53,11 @@ A string that represents a dependency. Specifies a string that represents a dependency that the build manager uses to help determine if a clean build is required. - The parameter is or an empty string. @@ -86,17 +86,17 @@ The assembly to add. Adds an assembly to the application's set of referenced assemblies. - method will return the set of assemblies that are determined from configuration files and any assemblies that were added by using this method. - - If an attempt is made to add an assembly that has already been added, the duplicate entry is ignored. - - This method must be called before the `Application_Start` event in the Global.asax file occurs. - + method will return the set of assemblies that are determined from configuration files and any assemblies that were added by using this method. + + If an attempt is made to add an assembly that has already been added, the duplicate entry is ignored. + + This method must be called before the `Application_Start` event in the Global.asax file occurs. + ]]> The parameter is or empty. @@ -129,13 +129,13 @@ if batch compilation is always enabled, if batch compilation is never enabled, or if the compilation setting is determined from the configuration file. The default value is . - . - + . + ]]> The property was not set in the method. @@ -186,13 +186,13 @@ Creates a cached file. The object for the new file. - method enable you to perform caching that persists across application domain restarts in partial-trust environments. It is used by the MVC framework to cache results of the controller lookup. - - To cache data, you write to the object that is returned by this method. - + method enable you to perform caching that persists across application domain restarts in partial-trust environments. It is used by the MVC framework to cache results of the controller lookup. + + To cache data, you write to the object that is returned by this method. + ]]> @@ -223,11 +223,11 @@ Processes a file, given its virtual path, and creates an instance of the result. The that represents the instance of the processed file. - method works for compiled and non-compile pages. - + method works for compiled and non-compile pages. + ]]> @@ -299,13 +299,13 @@ Returns a build dependency set for a virtual path if the path is located in the ASP.NET cache, even if the content is not current. A object that is stored in the cache, or if the object cannot be retrieved from the cache. - method overload behaves like the method overload. Both overloads return a current build dependency set if one exists, otherwise they return `null`. - - However, the method overload includes the option to return any build dependency set that is available, even an outdated one. If the `ensureIsUpToDate` parameter value is set to `false`, the method will return any available build dependency set. - + method overload behaves like the method overload. Both overloads return a current build dependency set if one exists, otherwise they return `null`. + + However, the method overload includes the option to return any build dependency set that is available, even an outdated one. If the `ensureIsUpToDate` parameter value is set to `false`, the method will return any available build dependency set. + ]]> @@ -415,11 +415,11 @@ Gets an object that represents the compiled type for the Global.asax file. An object that represents the compiled type for the Global.asax file. - An attempt was made to call this method before the Global.asax page was compiled. @@ -451,29 +451,29 @@ Gets an object factory for the specified virtual path. The object factory. - - The virtual path does not exist. - - -or- - - A higher-level exception already existed when this method was called. - - -or- - - This method was called while the compilation process was building top-level files. - - -or- - - This is a precompiled application and the virtual path was not found in the cache. - - -or- - + The virtual path does not exist. + + -or- + + A higher-level exception already existed when this method was called. + + -or- + + This method was called while the compilation process was building top-level files. + + -or- + + This is a precompiled application and the virtual path was not found in the cache. + + -or- + A circular reference was detected. @@ -498,13 +498,13 @@ Returns a list of assembly references that all page compilations must reference. An collection of assembly references. - method includes assemblies specified in the [assemblies](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/bfyb45k1(v=vs.100)) element of the Web.config file, assemblies built from custom code in the App_Code directory, and assemblies in other top-level folders. - - is introduced in the .NET Framework version 3.5. For more information, see [.NET Framework Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + method includes assemblies specified in the [assemblies](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/bfyb45k1(v=vs.100)) element of the Web.config file, assemblies built from custom code in the App_Code directory, and assemblies in other top-level folders. + + is introduced in the .NET Framework version 3.5. For more information, see [.NET Framework Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -517,11 +517,11 @@ Finds a type in the top-level assemblies or in assemblies that are defined in configuration. - @@ -559,22 +559,22 @@ Finds a type in the top-level assemblies or in assemblies that are defined in configuration, and optionally throws an exception on failure. A object that represents the requested parameter. - - is invalid. - + is invalid. + -or- - - is ambiguous. - + + is ambiguous. + -or- - + could not be found, and is . @@ -608,22 +608,22 @@ Finds a type in the top-level assemblies, or in assemblies that are defined in configuration, by using a case-insensitive search and optionally throwing an exception on failure. A object that represents the requested parameter. - - is invalid. - + is invalid. + -or- - - is ambiguous. - + + is ambiguous. + -or- - + could not be found, and is . @@ -720,13 +720,13 @@ Reads a cached file. The object for the file, or if the file does not exist. - method enable you to perform caching that persists across application domain restarts in partial-trust environments. It is used by the MVC framework to cache results of the controller lookup. - - To retrieve cached data, you read from the object that is returned by this method. - + method enable you to perform caching that persists across application domain restarts in partial-trust environments. It is used by the MVC framework to cache results of the controller lookup. + + To retrieve cached data, you read from the object that is returned by this method. + ]]> @@ -750,22 +750,15 @@ Gets the target version of the .NET Framework for the current Web site. The target version of the .NET Framework for the current Web site. - diff --git a/xml/System.Web.Configuration/MachineKeySection.xml b/xml/System.Web.Configuration/MachineKeySection.xml index 7f55ac027d6..d64cc675e20 100644 --- a/xml/System.Web.Configuration/MachineKeySection.xml +++ b/xml/System.Web.Configuration/MachineKeySection.xml @@ -157,11 +157,11 @@ The following values can be specified for the property: -- `Framework20SP1`. This value specifies that ASP.NET uses encryption methods that were available in versions of ASP.NET earlier than 2.0 SP2. Use this value for all servers in a web farm if any server has a version of the .NET Framework earlier than 2.0 SP2. This is the default value unless the application Web.config file has the `targetFramework` attribute of the `httpRuntime` element set to "4.5". +- `Framework20SP1`. This value specifies that ASP.NET uses encryption methods that were available in versions of ASP.NET earlier than 2.0 SP2. Use this value for all servers in a web farm if any server has a version of the .NET Framework earlier than 2.0 SP2. This is the default value unless the application Web.config file has the `targetFramework` attribute of the `httpRuntime` element set to "4.5". -- `Framework20SP2`. This value specifies that ASP.NET uses upgraded encryption methods that were introduced in the .NET Framework 2.0 SP2. Use this value for all servers in a web farm if all servers have the .NET Framework 2.0 SP2 or later but at least one does not have the .NET Framework 4.5. +- `Framework20SP2`. This value specifies that ASP.NET uses upgraded encryption methods that were introduced in the .NET Framework 2.0 SP2. Use this value for all servers in a web farm if all servers have .NET Framework 2.0 SP2 or later but at least one does not have the .NET Framework 4.5. -- `Framework45`. Cryptographic enhancements for ASP.NET 4.5 are in effect. This is the default value if the application Web.config file has the `targetFramework` attribute of the `httpRuntime` element set to "4.5". +- `Framework45`. Cryptographic enhancements for ASP.NET 4.5 are in effect. This is the default value if the application Web.config file has the `targetFramework` attribute of the `httpRuntime` element set to "4.5". When this property is set to `Framework45`, the following restrictions are in effect: @@ -256,11 +256,11 @@ ## Remarks The property supports the following decryption values: -- `Auto`, which is the default value, specifies that ASP.NET determines which encryption algorithm to use based on configuration default settings. +- `Auto`, which is the default value, specifies that ASP.NET determines which encryption algorithm to use based on configuration default settings. -- `AES`, which specifies that ASP.NET uses the algorithm to encrypt data. `AES` is the default algorithm to encrypt data. +- `AES`, which specifies that ASP.NET uses the algorithm to encrypt data. `AES` is the default algorithm to encrypt data. -- `3DES`, which specifies that ASP.NET uses the algorithm to encrypt data. +- `3DES`, which specifies that ASP.NET uses the algorithm to encrypt data. - A custom algorithm. diff --git a/xml/System.Web.Configuration/TrustSection.xml b/xml/System.Web.Configuration/TrustSection.xml index dbd26fec575..b9244216a18 100644 --- a/xml/System.Web.Configuration/TrustSection.xml +++ b/xml/System.Web.Configuration/TrustSection.xml @@ -155,7 +155,7 @@ - Partial trust application domains revert to being full trust at the application domain level. -- The legacy partial trust files located in the CONFIG directory in the .NET Framework install directory are used instead of the new partial trust configuration files that are located in the same directory. The legacy files include the membership conditions that were found in the .NET Framework 1.1 or .NET Framework 2.0 SP1 versions of the .NET Framework. +- The legacy partial trust files located in the CONFIG directory in the .NET Framework install directory are used instead of the new partial trust configuration files that are located in the same directory. The legacy files include the membership conditions that were found in .NET Framework 1.1 and .NET Framework 2.0 SP1. - Additional membership conditions to evaluate permissions are applied, as defined in ASP.NET partial trust files. The CONFIG directory that ships with the .NET Framework 4 release contains legacy partial-trust policy files. The names of these files include the string "legacy" and contain the .NET Framework 2.0 SP1 sections. These sections contain non-empty membership conditions that are needed to evaluating CAS policy against assemblies. diff --git a/xml/System.Web.ModelBinding/ModelMetadata.xml b/xml/System.Web.ModelBinding/ModelMetadata.xml index 2ca2957eb83..7cf0c334001 100644 --- a/xml/System.Web.ModelBinding/ModelMetadata.xml +++ b/xml/System.Web.ModelBinding/ModelMetadata.xml @@ -16,15 +16,15 @@ Provides a container for metadata for a model. - attribute of a data-bound control specifies the type of a data element that the data control is bound to. This type is typically referred to as the model, and it typically corresponds to a row in a database table. The properties of the model typically correspond to columns of the table. - - A object can provide metadata for the model itself or for a property of the model, or for a property of a complex property. When the object pertains to a property, the word *model* refers to the property, and the word *container* refers to the model. - - For example, the model might be **Contact**, which has **Name** and **Age** properties, and the **Name** property might be a complex property composed of **FirstName** and **LastName**. When the object pertains to the **Contact** object, the model type is **Contact** and there is no container. When the object pertains to the **Name** property, the model type is **Name** and the container type is **Contact**. When the object pertains to the **FirstName** property, the model type is **FirstName** and the container type is **Name**. - + attribute of a data-bound control specifies the type of a data element that the data control is bound to. This type is typically referred to as the model, and it typically corresponds to a row in a database table. The properties of the model typically correspond to columns of the table. + + A object can provide metadata for the model itself or for a property of the model, or for a property of a complex property. When the object pertains to a property, the word *model* refers to the property, and the word *container* refers to the model. + + For example, the model might be **Contact**, which has **Name** and **Age** properties, and the **Name** property might be a complex property composed of **FirstName** and **LastName**. When the object pertains to the **Contact** object, the model type is **Contact** and there is no container. When the object pertains to the **Name** property, the model type is **Name** and the container type is **Contact**. When the object pertains to the **FirstName** property, the model type is **FirstName** and the container type is **Name**. + ]]> @@ -141,11 +141,11 @@ Gets or sets the name of the data type. The name of the data type. - property is set to , this property might be "EmailAddress" or "Url" - that is, a name that indicates more than just that the data is typed as a string. - + property is set to , this property might be "EmailAddress" or "Url" - that is, a name that indicates more than just that the data is typed as a string. + ]]> @@ -297,18 +297,18 @@ Returns text to display for the model when the model represents a complex object. - The property value is derived by examining the following sequence of related values until a return value is found. - -1. If the property value is not , that value is returned. - -2. If the property is , the property value is returned. - -3. If an attempt to convert the property to a string returns , an empty string is returned. - -4. If the string conversion of the property value is the same as the property of the property type, that value is returned. - -5. If there are no properties in the collection, an empty string is returned. - + The property value is derived by examining the following sequence of related values until a return value is found. + +1. If the property value is not , that value is returned. + +2. If the property is , the property value is returned. + +3. If an attempt to convert the property to a string returns , an empty string is returned. + +4. If the string conversion of the property value is the same as the property of the property type, that value is returned. + +5. If there are no properties in the collection, an empty string is returned. + 6. If none of the preceding tests have returned a value, the return value comes from the first property in the collection. If the property of the first property is , the property value is returned; otherwise the result of converting the first property's property to a string is returned. To be added. @@ -380,11 +380,11 @@ if the model is a complex type; otherwise, . - @@ -643,11 +643,11 @@ Gets or sets a short version of the display name. The text to display when a short version of the model name is required. - property should be used. - + property should be used. + ]]> @@ -759,11 +759,11 @@ Gets or sets watermark text for a text box. The watermark text. - diff --git a/xml/System.Web.ModelBinding/TypeConverterModelBinder.xml b/xml/System.Web.ModelBinding/TypeConverterModelBinder.xml index c43e5ca9274..5b63939571d 100644 --- a/xml/System.Web.ModelBinding/TypeConverterModelBinder.xml +++ b/xml/System.Web.ModelBinding/TypeConverterModelBinder.xml @@ -18,7 +18,7 @@ - Maps a browser request to a data object. This type is used when model binding requires conversions using a .NET Framework type converter. + Maps a browser request to a data object. This type is used when model binding requires conversions using a .NET type converter. To be added. diff --git a/xml/System.Web.Services.Description/SoapProtocolImporter.xml b/xml/System.Web.Services.Description/SoapProtocolImporter.xml index e6a4b42d8eb..1072b3177ab 100644 --- a/xml/System.Web.Services.Description/SoapProtocolImporter.xml +++ b/xml/System.Web.Services.Description/SoapProtocolImporter.xml @@ -18,13 +18,13 @@ Generates classes for Web services that use the SOAP protocol. - class generates client proxy code or abstract server code according to the SOAP protocol. The class generates a class for each supported binding defined in a Web Services Description Language (WSDL) document. - - Typically, instead of invoking directly, a developer uses the class indirectly through the class. - + class generates client proxy code or abstract server code according to the SOAP protocol. The class generates a class for each supported binding defined in a Web Services Description Language (WSDL) document. + + Typically, instead of invoking directly, a developer uses the class indirectly through the class. + ]]> @@ -70,11 +70,11 @@ Initializes the generation of a binding class. A binding class. - method executes before the class generates methods that correspond to operations. - + method executes before the class generates methods that correspond to operations. + ]]> @@ -100,11 +100,11 @@ Performs initialization for an entire code namespace during code generation. - method executes before the class generates classes that represent bindings. - + method executes before the class generates classes that represent bindings. + ]]> @@ -130,11 +130,11 @@ Processes a binding class after the generation of methods. - method executes after the class generates methods that correspond to operations. - + method executes after the class generates methods that correspond to operations. + ]]> @@ -160,11 +160,11 @@ Performs processing for an entire code namespace after binding class generation. - method executes after the class generates classes that represent bindings. - + method executes after the class generates classes that represent bindings. + ]]> @@ -191,11 +191,11 @@ Generates method code for a binding class. The method code for a binding class. - method executes for each binding class method that represents an operation. - + method executes for each binding class method that represents an operation. + ]]> @@ -223,11 +223,11 @@ if the class can be generated for the current binding; otherwise . - method determines whether to generate a class for the current binding, as represented by the property. The method checks whether the property's property contains a instance. In addition, the transport mechanism obtained through the property must be supported by the current Web services configuration. - + method determines whether to generate a class for the current binding, as represented by the property. The method checks whether the property's property contains a instance. In addition, the transport mechanism obtained through the property must be supported by the current Web services configuration. + ]]> @@ -258,13 +258,13 @@ if the current operation's operation flow is supported; otherwise . - method determines whether to generate a method for the current operation, as represented by the property. This evaluation takes place for each operation in a binding for which a class is being generated. If a `false` value is returned, the method executes. A `true` value is returned only if the input value is or . - - For more information, see the property. The property is of type . - + method determines whether to generate a method for the current operation, as represented by the property. This evaluation takes place for each operation in a binding for which a class is being generated. If a `false` value is returned, the method executes. A `true` value is returned only if the input value is or . + + For more information, see the property. The property is of type . + ]]> @@ -361,14 +361,14 @@ System.Xml.Serialization.SoapCodeExporter - Gets the object of type used internally by the class to generate code from mappings between SOAP-encoded XML schema content and .NET Framework types. - An object of type used internally by the class to generate code from mappings between SOAP-encoded XML schema content and .NET Framework types. + Gets the object of type used internally by the class to generate code from mappings between SOAP-encoded XML schema content and .NET types. + An object of type used internally by the class to generate code from mappings between SOAP-encoded XML schema content and .NET types. - class uses a object to create code from .NET Framework type mappings for XML schema elements and data types that enable SOAP encoding, as opposed to literal XML Schema usage. SOAP encoding is specified in section 5 of the SOAP 1.1 specification. SOAP encoding uses the namespace "". - + class uses a object to create code from .NET type mappings for XML schema elements and data types that enable SOAP encoding, as opposed to literal XML Schema usage. SOAP encoding is specified in section 5 of the SOAP 1.1 specification. SOAP encoding uses the namespace "". + ]]> @@ -391,14 +391,14 @@ System.Xml.Serialization.SoapSchemaImporter - Gets the object of type used internally by the class to generate mappings between SOAP-encoded XML schema content and .NET Framework types. - An object of type used internally by the class to generate mappings between SOAP-encoded XML schema content and .NET Framework types. + Gets the object of type used internally by the class to generate mappings between SOAP-encoded XML schema content and .NET types. + An object of type used internally by the class to generate mappings between SOAP-encoded XML schema content and .NET types. - class uses a object to create .NET Framework type mappings for XML schema elements and data types that enable SOAP encoding, as opposed to literal XML Schema usage. SOAP encoding is specified in section 5 of the SOAP 1.1 specification. SOAP encoding uses the namespace "". - + class uses a object to create .NET type mappings for XML schema elements and data types that enable SOAP encoding, as opposed to literal XML Schema usage. SOAP encoding is specified in section 5 of the SOAP 1.1 specification. SOAP encoding uses the namespace "". + ]]> @@ -421,14 +421,14 @@ System.Xml.Serialization.XmlCodeExporter - Gets the object of type used internally by the class to generate code from mappings between literal XML schema content and .NET Framework types. - An object of type used internally by the class to generate code from mappings between literal XML schema content and .NET Framework types. + Gets the object of type used internally by the class to generate code from mappings between literal XML schema content and .NET types. + An object of type used internally by the class to generate code from mappings between literal XML schema content and .NET types. - class uses an object to create .NET Framework type mappings for XML schema elements and data types that require literal XML Schema usage, as opposed to SOAP encoding. SOAP encoding is specified in section 5 of the SOAP 1.1 specification. - + class uses an object to create .NET type mappings for XML schema elements and data types that require literal XML Schema usage, as opposed to SOAP encoding. SOAP encoding is specified in section 5 of the SOAP 1.1 specification. + ]]> @@ -451,14 +451,14 @@ System.Xml.Serialization.XmlSchemaImporter - Gets the object of type used internally by the class to generate mappings between literal XML schema content and .NET Framework types. - An object of type used internally by the class to generate mappings between literal XML schema content and .NET Framework types. + Gets the object of type used internally by the class to generate mappings between literal XML schema content and .NET types. + An object of type used internally by the class to generate mappings between literal XML schema content and .NET types. - class uses an object to create code from .NET Framework type mappings for XML schema elements and data types that require literal XML Schema usage, as opposed to SOAP encoding. SOAP encoding is specified in section 5 of the SOAP 1.1 specification. - + class uses an object to create code from .NET type mappings for XML schema elements and data types that require literal XML Schema usage, as opposed to SOAP encoding. SOAP encoding is specified in section 5 of the SOAP 1.1 specification. + ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/DataPoint.xml b/xml/System.Web.UI.DataVisualization.Charting/DataPoint.xml index aa9ae6d2748..a15ae0bedf4 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/DataPoint.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/DataPoint.xml @@ -447,7 +447,7 @@ The following .NET types can be used for the object type parameter: > [!IMPORTANT] > The property determines the maximum number of Y-values that all data points in a can have. If you specify more than the allowable number of Y-values, an exception will be raised. -The following .NET Framework types can be used for the object type parameter: +The following .NET types can be used for the object type parameter: - String - DateTime diff --git a/xml/System.Web.UI.WebControls.WebParts/IPersonalizable.xml b/xml/System.Web.UI.WebControls.WebParts/IPersonalizable.xml index 139e21a8534..eecd7a9ae0d 100644 --- a/xml/System.Web.UI.WebControls.WebParts/IPersonalizable.xml +++ b/xml/System.Web.UI.WebControls.WebParts/IPersonalizable.xml @@ -165,7 +165,7 @@ When using the standard ASP.NET implementation of Web Parts, controls must ensure that objects placed in the state dictionary can be serialized by the ASP.NET class. In practice, this means the following: -- Primitive .NET Framework types, strings, and collection-oriented .NET Framework types such as arrays, array lists, hash tables, and hybrid dictionaries, are automatically serializable. +- Primitive .NET types, strings, and collection-oriented .NET types such as arrays, array lists, hash tables, and hybrid dictionaries, are automatically serializable. - Custom types that supply their own classes capable of serializing to and deserializing from strings are considered serializable. diff --git a/xml/System.Web.UI/DataBinding.xml b/xml/System.Web.UI/DataBinding.xml index 8ebf85b166b..48195de5e66 100644 --- a/xml/System.Web.UI/DataBinding.xml +++ b/xml/System.Web.UI/DataBinding.xml @@ -18,19 +18,19 @@ Contains information about a single data-binding expression in an ASP.NET server control, which allows rapid-application development (RAD) designers, such as Microsoft Visual Studio, to create data-binding expressions at design time. This class cannot be inherited. - class. Any server control that contains one or more data-binding expressions has a object that contains the objects. This collection is accessible through the class implementing the interface. When you create a custom RAD designer, use that implementation to access the collection. Any or objects associated with a server control exist only at design time. They do not exist at run time and, therefore, are not accessible during run time. - - - -## Examples - The following code example creates a object and sets it equal to an existing object in the control's collection that has a `propertyName` parameter with a value of `Text`. If the collection contains a object with a `propertyName` value of `Text`, this code returns the value of the object's property. If there is no such object, it returns an empty string (""). - + class. Any server control that contains one or more data-binding expressions has a object that contains the objects. This collection is accessible through the class implementing the interface. When you create a custom RAD designer, use that implementation to access the collection. Any or objects associated with a server control exist only at design time. They do not exist at run time and, therefore, are not accessible during run time. + + + +## Examples + The following code example creates a object and sets it equal to an existing object in the control's collection that has a `propertyName` parameter with a value of `Text`. If the collection contains a object with a `propertyName` value of `Text`, this code returns the value of the object's property. If there is no such object, it returns an empty string (""). + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataBinding_Sample1/CS/databinding_samp1.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet2"::: + ]]> @@ -65,18 +65,18 @@ The property to bind data to. - The .NET Framework type of the property to bind data to. + The .NET type of the property to bind data to. The data-binding expression to be evaluated. Initializes a new instance of the class. - object and sets it equal to an existing object in the control's collection that has a `propertyName` parameter with a value of `Text`. If the collection contains a object with a `propertyName` value of `Text`, this code returns the value of the object's property. If there is no such object, it returns an empty string (""). - + object and sets it equal to an existing object in the control's collection that has a `propertyName` parameter with a value of `Text`. If the collection contains a object with a `propertyName` value of `Text`, this code returns the value of the object's property. If there is no such object, it returns an empty string (""). + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataBinding_Sample1/CS/databinding_samp1.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet3"::: + ]]> @@ -142,14 +142,14 @@ Gets or sets the data-binding expression to be evaluated. The data-binding expression to be evaluated. - object and sets it equal to an existing object in the control's collection that has a `propertyName` parameter with a value of `Text`. If the collection contains a object with a `propertyName` value of `Text`, this code returns the value of the object's property. If there is no such object, it returns an empty string (""). - + object and sets it equal to an existing object in the control's collection that has a `propertyName` parameter with a value of `Text`. If the collection contains a object with a `propertyName` value of `Text`, this code returns the value of the object's property. If there is no such object, it returns an empty string (""). + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataBinding_Sample1/CS/databinding_samp1.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet3"::: + ]]> @@ -176,11 +176,11 @@ Retrieves the hash code for an instance of the object. A 32-bit signed integer hash code. - objects are placed in a object, accessible only at design time. The collection is a hash table that represents the bindings on a control. There can only be one binding per property, so the hash code computation matches the implementation and only takes the property name into account. - + objects are placed in a object, accessible only at design time. The collection is a hash table that represents the bindings on a control. There can only be one binding per property, so the hash code computation matches the implementation and only takes the property name into account. + ]]> @@ -213,14 +213,14 @@ Gets the name of the ASP.NET server control property to bind data to. The property to bind data to. - object, `myDataBinding2`. It then assigns the value of the property to `dataBindingOutput1`, concatenates it with the string "The property name is ", and writes the value to a file. - + object, `myDataBinding2`. It then assigns the value of the property to `dataBindingOutput1`, concatenates it with the string "The property name is ", and writes the value to a file. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataBinding_Sample1/CS/databinding_samp1.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet6"::: + ]]> @@ -249,17 +249,17 @@ System.Type - Gets the .NET Framework type of the data-bound ASP.NET server control property. - The .NET Framework type of the data-bound property. + Gets the .NET type of the data-bound ASP.NET server control property. + The .NET type of the data-bound property. - object, `myDataBinding2`. The property value is assigned to `dataBindingOutput2` and concatenated with the string "The property type is ", and writes the value to a file. - + object, `myDataBinding2`. The property value is assigned to `dataBindingOutput2` and concatenated with the string "The property type is ", and writes the value to a file. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataBinding_Sample1/CS/databinding_samp1.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataBinding_Sample1/VB/databinding_samp1.vb" id="Snippet6"::: + ]]> diff --git a/xml/System.Windows.Controls/Grid.xml b/xml/System.Windows.Controls/Grid.xml index 240029f15ad..b90b728469f 100644 --- a/xml/System.Windows.Controls/Grid.xml +++ b/xml/System.Windows.Controls/Grid.xml @@ -162,12 +162,16 @@ - + - - - + + + + + + + Property PresentationFramework @@ -185,6 +189,10 @@ [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)] [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)>] + + [System.ComponentModel.TypeConverter(typeof(System.Windows.Controls.ColumnDefinitionCollectionConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.Windows.Controls.ColumnDefinitionCollectionConverter))>] + [System.ComponentModel.DesignerSerializationVisibility] [<System.ComponentModel.DesignerSerializationVisibility>] @@ -762,12 +770,16 @@ - + - - - + + + + + + + Property PresentationFramework @@ -785,6 +797,10 @@ [System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)] [<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Content)>] + + [System.ComponentModel.TypeConverter(typeof(System.Windows.Controls.RowDefinitionCollectionConverter))] + [<System.ComponentModel.TypeConverter(typeof(System.Windows.Controls.RowDefinitionCollectionConverter))>] + [System.ComponentModel.DesignerSerializationVisibility] [<System.ComponentModel.DesignerSerializationVisibility>] diff --git a/xml/System.Windows.Forms/AccessibleStates.xml b/xml/System.Windows.Forms/AccessibleStates.xml index 7a21ac9b102..2e531eb5021 100644 --- a/xml/System.Windows.Forms/AccessibleStates.xml +++ b/xml/System.Windows.Forms/AccessibleStates.xml @@ -29,21 +29,21 @@ Specifies values representing possible states for an accessible object. - and classes to expose accessible information. The control plots two curves along with a legend. The `ChartControlAccessibleObject` class, which derives from `ControlAccessibleObject`, is used in the method to provide custom accessible information for the chart control. Because the chart legend is not an actual control based on , but instead is drawn by the chart control, it does not contain any built-in accessible information. Because of this, the `ChartControlAccessibleObject` class overrides the method to return the `CurveLegendAccessibleObject` that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information. - - This code excerpt demonstrates using the enumeration with the property. See the class overview for the complete code example. - + and classes to expose accessible information. The control plots two curves along with a legend. The `ChartControlAccessibleObject` class, which derives from `ControlAccessibleObject`, is used in the method to provide custom accessible information for the chart control. Because the chart legend is not an actual control based on , but instead is drawn by the chart control, it does not contain any built-in accessible information. Because of this, the `ChartControlAccessibleObject` class overrides the method to return the `CurveLegendAccessibleObject` that represents accessible information for each part of the legend. When an accessible-aware application uses this control, the control can provide the necessary accessible information. + + This code excerpt demonstrates using the enumeration with the property. See the class overview for the complete code example. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/CPP/chartcontrol.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/AccessibleEvents/Overview/chartcontrol.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/VB/chartcontrol.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.AccessibleObject/VB/chartcontrol.vb" id="Snippet4"::: + ]]> @@ -1011,7 +1011,7 @@ 1073741823 - A valid object. This property is deprecated in .NET Framework 2.0. + A valid object. This property is deprecated. diff --git a/xml/System.Windows.Forms/Application.xml b/xml/System.Windows.Forms/Application.xml index 2b33d0c5f62..9bf0f2de09e 100644 --- a/xml/System.Windows.Forms/Application.xml +++ b/xml/System.Windows.Forms/Application.xml @@ -718,9 +718,7 @@ - If one of more of the handlers cancels the event, then returns without further action. Otherwise, a event is raised for every open form, then all running message loops and forms are closed. > [!NOTE] -> The method does not raise the and events, which are obsolete as of .NET Framework 2.0. - - +> The method does not raise the and events, which are obsolete. ## Examples The following code example lists numbers in a list box on a form. Each time you click `button1`, the application adds another number to the list. @@ -1848,7 +1846,7 @@ ## Remarks Certain Windows Forms controls can render their text using either the class, which is based on the GDI graphics library, or the class, which is based on the GDI+ graphics library. This change was made in .NET Framework 2.0 because of performance and localization issues with GDI+. Use to set the default value of the `UseCompatibleTextRendering` property for controls that support that property. - The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and apps that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. + The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and apps that perform custom text rendering using the class. In most cases, it's recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. The GDI-based class was introduced in .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true`. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with an argument of `true`. diff --git a/xml/System.Windows.Forms/ButtonBase.xml b/xml/System.Windows.Forms/ButtonBase.xml index 3e160088069..0f3b80fd44f 100644 --- a/xml/System.Windows.Forms/ButtonBase.xml +++ b/xml/System.Windows.Forms/ButtonBase.xml @@ -2283,9 +2283,9 @@ If you set the property, the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. + The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, it's recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. - The GDI based class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. +You can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. ]]> diff --git a/xml/System.Windows.Forms/CheckedListBox.xml b/xml/System.Windows.Forms/CheckedListBox.xml index d207b058b7b..7289571efb3 100644 --- a/xml/System.Windows.Forms/CheckedListBox.xml +++ b/xml/System.Windows.Forms/CheckedListBox.xml @@ -1963,9 +1963,9 @@ The property should not be o class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. + The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, it's recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. - The GDI based class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. +You can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. ]]> diff --git a/xml/System.Windows.Forms/Clipboard.xml b/xml/System.Windows.Forms/Clipboard.xml index a87a2e1a041..453e67abe44 100644 --- a/xml/System.Windows.Forms/Clipboard.xml +++ b/xml/System.Windows.Forms/Clipboard.xml @@ -46,7 +46,7 @@ Call to retrieve data from the Clipboard. The data is returned as an object that implements the interface. Use the methods specified by and fields in to extract the data from the object. If you do not know the format of the data you retrieved, call the method of the interface to get a list of all formats that data is stored in. Then call the method of the interface, and specify a format that your application can use. - In .NET Framework 2.0, the class provides additional methods that make it easier to work with the system Clipboard. Call the method to remove all data from the Clipboard. To add data of a particular format to the Clipboard, replacing the existing data, call the appropriate `Set`*Format* method, such as , or call the method to specify the format. To retrieve data of a particular format from the Clipboard, first call the appropriate `Contains`*Format* method (such as ) method to determine whether the Clipboard contains data in that format, and then call the appropriate `Get`*Format* method (such as ) to retrieve the data if the Clipboard contains it. To specify the format in these operations, call the and methods instead. +The class provides additional methods that make it easier to work with the system Clipboard. Call the method to remove all data from the Clipboard. To add data of a particular format to the Clipboard, replacing the existing data, call the appropriate `Set`*Format* method, such as , or call the method to specify the format. To retrieve data of a particular format from the Clipboard, first call the appropriate `Contains`*Format* method (such as ) method to determine whether the Clipboard contains data in that format, and then call the appropriate `Get`*Format* method (such as ) to retrieve the data if the Clipboard contains it. To specify the format in these operations, call the and methods instead. > [!NOTE] > All Windows-based applications share the system Clipboard, so the contents are subject to change when you switch to another application. diff --git a/xml/System.Windows.Forms/ColumnHeader.xml b/xml/System.Windows.Forms/ColumnHeader.xml index 5be686dd0a2..4a84f743ff8 100644 --- a/xml/System.Windows.Forms/ColumnHeader.xml +++ b/xml/System.Windows.Forms/ColumnHeader.xml @@ -813,9 +813,7 @@ If you set the property, th You can use this property to provide different text alignment settings for the text displayed in each . > [!NOTE] -> Due to a limitation in the underlying control, this property has no effect on the first column in the control, which is always aligned to the left. To work around this limitation in .NET Framework 2.0, you can handle the event and paint the column header yourself. - - +> Due to a limitation in the underlying control, this property has no effect on the first column in the control, which is always aligned to the left. To work around this limitation, you can handle the event and paint the column header yourself. ## Examples The following code example demonstrates initializing a control. The example creates objects and sets the column header's , and properties. The example also adds items and subitems to the . To run this example paste the following code in a form and call the `PopulateListView` method from the form's constructor or event handler. diff --git a/xml/System.Windows.Forms/ContainerControl.xml b/xml/System.Windows.Forms/ContainerControl.xml index 80cf9be64ca..b7b81648b90 100644 --- a/xml/System.Windows.Forms/ContainerControl.xml +++ b/xml/System.Windows.Forms/ContainerControl.xml @@ -582,7 +582,7 @@ class can enable native IME support by overriding this property to return `true`. However, the application is then responsible for making sure that there are no conflicts between the native IME and the Windows Forms IME. This scenario is not supported. diff --git a/xml/System.Windows.Forms/Control.xml b/xml/System.Windows.Forms/Control.xml index 63c7eb6e1fc..f5b8b157b00 100644 --- a/xml/System.Windows.Forms/Control.xml +++ b/xml/System.Windows.Forms/Control.xml @@ -5613,10 +5613,7 @@ Point clientPoint = targetControl.PointToClient(new Point(de.X, de.Y)); ## Remarks The event is raised when the user first drags the mouse cursor over the control during a drag-and-drop operation. -> [!NOTE] -> In versions earlier than .NET Framework 2.0, if you put a with and events on a Windows Form and drag and drop something onto the at design time, the `DropDrop` and `DropEnter` events are raised. However, when you close and reopen the solution, the and events are not raised again. - - The following describes how and when events related to drag-and-drop operations are raised. + The following information describes how and when events related to drag-and-drop operations are raised. The method determines the control under the current cursor location. It then checks to see if the control is a valid drop target. diff --git a/xml/System.Windows.Forms/DataObject.xml b/xml/System.Windows.Forms/DataObject.xml index 901c375f1af..eb40b5ded5f 100644 --- a/xml/System.Windows.Forms/DataObject.xml +++ b/xml/System.Windows.Forms/DataObject.xml @@ -71,7 +71,7 @@ To determine what formats the data is stored in, call . To determine if a format is available, call with the desired format. - In .NET Framework 2.0, the class provides additional methods that make it easier to work with data in common formats. To add data of a particular format to the , use the appropriate `Set`*Format* method, such as . To retrieve data of a particular format from the , first call the appropriate `Contains`*Format* method (such as ) to determine whether the contains data in that format, then call the appropriate `Get`*Format* method (such as ) to retrieve the data if the contains it. +The class provides additional methods that make it easier to work with data in common formats. To add data of a particular format to the , use the appropriate `Set`*Format* method, such as . To retrieve data of a particular format from the , first call the appropriate `Contains`*Format* method (such as ) to determine whether the contains data in that format, then call the appropriate `Get`*Format* method (such as ) to retrieve the data if the contains it. > [!NOTE] > Special considerations may be necessary when using the metafile format with the Clipboard. Due to a limitation in the current implementation of the class, the metafile format used by the .NET Framework may not be recognized by applications that use an older metafile format. In this case, you must interoperate with the Win32 Clipboard application programming interfaces (APIs). diff --git a/xml/System.Windows.Forms/Form.xml b/xml/System.Windows.Forms/Form.xml index db499a4c430..e2eeac2afda 100644 --- a/xml/System.Windows.Forms/Form.xml +++ b/xml/System.Windows.Forms/Form.xml @@ -1385,9 +1385,6 @@ > [!NOTE] > When the method is called on a displayed as a modeless window, you cannot call the method to make the form visible, because the form's resources have already been released. To hide a form and then make it visible, use the method. -> [!CAUTION] -> Prior to the .NET Framework 2.0, the and events are not raised when the method is called to exit your application. If you have validation code in either of these events that must be executed, you should call the method for each open form individually before calling the method. - ]]> The form was closed while a handle was being created. @@ -1518,7 +1515,7 @@ ## Remarks > [!CAUTION] -> The event is obsolete starting with the .NET Framework 2.0; use the event instead. +> The event is obsolete; use the event instead. The event occurs as the form is being closed. When a form is closed, all resources created within the object are released and the form is disposed. If you cancel this event, the form remains opened. To cancel the closure of a form, set the property of the passed to your event handler to `true`. @@ -2726,7 +2723,7 @@ ## Remarks > [!IMPORTANT] -> The method is obsolete starting with the .NET Framework 2.0. This member has been retained for backward compatibility. For more information about automatic scaling, see [Automatic Scaling in Windows Forms](/dotnet/desktop/winforms/automatic-scaling-in-windows-forms). +> The method is obsolete. This member has been retained for backward compatibility. For more information about automatic scaling, see [Automatic Scaling in Windows Forms](/dotnet/desktop/winforms/automatic-scaling-in-windows-forms). You can use this method to determine the size a form would autoscale to for a specific font before applying the font to the form. If you want to determine the size a form is autoscaled to based on the font currently assigned to the form, use the property. @@ -4732,7 +4729,7 @@ By default Windows Forms anchors MDI children to the bottom left of the parent f ## Remarks > [!CAUTION] -> The method is obsolete starting with the .NET Framework 2.0; use the method instead. +> The method is obsolete; use the method instead. Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). @@ -4808,7 +4805,7 @@ By default Windows Forms anchors MDI children to the bottom left of the parent f ## Remarks > [!CAUTION] -> The method is obsolete starting with the .NET Framework 2.0; use the method instead. +> The method is obsolete; use the method instead. Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). diff --git a/xml/System.Windows.Forms/GroupBox.xml b/xml/System.Windows.Forms/GroupBox.xml index 848a77ecd02..be91ffd84e1 100644 --- a/xml/System.Windows.Forms/GroupBox.xml +++ b/xml/System.Windows.Forms/GroupBox.xml @@ -1363,9 +1363,9 @@ class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. + The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, it's recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. - The GDI based class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. +You can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. ]]> diff --git a/xml/System.Windows.Forms/IAsyncDropTarget.xml b/xml/System.Windows.Forms/IAsyncDropTarget.xml new file mode 100644 index 00000000000..c86c8d76eb9 --- /dev/null +++ b/xml/System.Windows.Forms/IAsyncDropTarget.xml @@ -0,0 +1,53 @@ + + + + + + + + + System.Windows.Forms + 10.0.0.0 + + + + System.Windows.Forms.IDropTarget + + + + + [System.Diagnostics.CodeAnalysis.Experimental("WFO5003", UrlFormat="https://aka.ms/winforms-warnings/{0}")] + [<System.Diagnostics.CodeAnalysis.Experimental("WFO5003", UrlFormat="https://aka.ms/winforms-warnings/{0}")>] + + + + To be added. + To be added. + + + + + + + + + + Method + + System.Windows.Forms + 10.0.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + diff --git a/xml/System.Windows.Forms/Keys.xml b/xml/System.Windows.Forms/Keys.xml index 2008a3f2de0..a5842b546fe 100644 --- a/xml/System.Windows.Forms/Keys.xml +++ b/xml/System.Windows.Forms/Keys.xml @@ -62,21 +62,19 @@ The following table shows the key code values represented by two enumerated values, representing both the general original equipment manufacturer (OEM) keys and the more specific U.S.-keyboard associations. -|Hexadecimal value|U.S. keyboard|General OEM| -|-----------------------|-------------------|-----------------| -|BA|OemSemicolon|Oem1| -|BF|OemQuestion|Oem2| -|C0|Oemtilde|Oem3| -|DB|OemOpenBrackets|Oem4| -|DC|OemPipe|Oem5| -|DD|OemCloseBrackets|Oem6| -|DE|OemQuotes|Oem7| -|E2|OemBackslash|Oem102| +| Hexadecimal value | U.S. keyboard | General OEM | +|-------------------|------------------|-------------| +| BA | OemSemicolon | Oem1 | +| BF | OemQuestion | Oem2 | +| C0 | Oemtilde | Oem3 | +| DB | OemOpenBrackets | Oem4 | +| DC | OemPipe | Oem5 | +| DD | OemCloseBrackets | Oem6 | +| DE | OemQuotes | Oem7 | +| E2 | OemBackslash | Oem102 | > [!CAUTION] -> For the .NET Framework 2.0, a member IMEAccept was added that supersedes the previous entry, IMEAceept, which was spelled incorrectly. The older version has been retained for backward compatibility, but it may be deleted in future versions of the .NET Framework - - +> For .NET Framework 2.0, a member `IMEAccept` was added that supersedes the previous entry, `IMEAceept`, which was spelled incorrectly. The older version has been retained for backward compatibility, but it might be deleted in future versions of .NET. ## Examples The following code example uses the event to determine the type of character entered into the control. diff --git a/xml/System.Windows.Forms/Label.xml b/xml/System.Windows.Forms/Label.xml index 816bda3a867..d7fdac863ca 100644 --- a/xml/System.Windows.Forms/Label.xml +++ b/xml/System.Windows.Forms/Label.xml @@ -2612,9 +2612,9 @@ If you set the property, the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. + The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, it's recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. - The GDI based class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. +You can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. ]]> diff --git a/xml/System.Windows.Forms/LinkLabel.xml b/xml/System.Windows.Forms/LinkLabel.xml index 9521e17786d..608ac5f6ef7 100644 --- a/xml/System.Windows.Forms/LinkLabel.xml +++ b/xml/System.Windows.Forms/LinkLabel.xml @@ -54,37 +54,37 @@ Represents a Windows label control that can display hyperlinks. - control replaces and adds functionality to the and controls. However, the and controls are retained for both backward compatibility and future use, if you choose. - - The control is similar to a control with the exception that it can display a hyperlink. Multiple hyperlinks can be specified in the text of the control. Each hyperlink can perform a different task within an application. For example, you can use a hyperlink to display a web page in a browser or to load a log file associated with an application. - - Each hyperlink displayed in the control is an instance of the class. The class defines display information, state, and location of the hyperlink. In addition, the property of the class enables you to associate information, such as a URL to display, with the hyperlink. When a user clicks a hyperlink within the control, the event is raised, and the object representing the hyperlink that was clicked is passed as part of the object that is passed as a parameter to the event handler. You can use this object to obtain the object associated with the hyperlink that was clicked by the user. All hyperlinks contained within the control are stored in the class instance for the control. - - There are two ways to add a hyperlink to the control. The quickest way is to specify a and assign it to the property. This enables you to specify a single hyperlink within the text of the control. To add multiple hyperlinks, you can use the method of the class by accessing the collection through the property. - - When a control is created, a default hyperlink that contains all the text within the control is added to the . You can override this default link by specifying a new link area with the property, or specify a link using the method of the . You can also remove the default hyperlink by using the method of the class. - - The property is `true` by default, as long as there is at least one link of greater than zero length in the collection. The control has a single value. However, each link of greater than zero length gets its own tab stop, in left-to-right order. To prevent tab navigation to the control, set the property to `false`. However, be aware that adding new links to the collection will automatically set the property to `true` again. - - The provides a number of properties that enable you to define the display appearance of hyperlinks in the control. The , , , and properties define the colors used when displaying a hyperlink in various states. The property defines the display of the underline that is associated with a hyperlink. - - - -## Examples - The following example demonstrates using the class. The example handles the event by opening a Web site. - + control replaces and adds functionality to the and controls. However, the and controls are retained for both backward compatibility and future use, if you choose. + + The control is similar to a control with the exception that it can display a hyperlink. Multiple hyperlinks can be specified in the text of the control. Each hyperlink can perform a different task within an application. For example, you can use a hyperlink to display a web page in a browser or to load a log file associated with an application. + + Each hyperlink displayed in the control is an instance of the class. The class defines display information, state, and location of the hyperlink. In addition, the property of the class enables you to associate information, such as a URL to display, with the hyperlink. When a user clicks a hyperlink within the control, the event is raised, and the object representing the hyperlink that was clicked is passed as part of the object that is passed as a parameter to the event handler. You can use this object to obtain the object associated with the hyperlink that was clicked by the user. All hyperlinks contained within the control are stored in the class instance for the control. + + There are two ways to add a hyperlink to the control. The quickest way is to specify a and assign it to the property. This enables you to specify a single hyperlink within the text of the control. To add multiple hyperlinks, you can use the method of the class by accessing the collection through the property. + + When a control is created, a default hyperlink that contains all the text within the control is added to the . You can override this default link by specifying a new link area with the property, or specify a link using the method of the . You can also remove the default hyperlink by using the method of the class. + + The property is `true` by default, as long as there is at least one link of greater than zero length in the collection. The control has a single value. However, each link of greater than zero length gets its own tab stop, in left-to-right order. To prevent tab navigation to the control, set the property to `false`. However, be aware that adding new links to the collection will automatically set the property to `true` again. + + The provides a number of properties that enable you to define the display appearance of hyperlinks in the control. The , , , and properties define the colors used when displaying a hyperlink in various states. The property defines the display of the underline that is associated with a hyperlink. + + + +## Examples + The following example demonstrates using the class. The example handles the event by opening a Web site. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkLabel/Overview/form.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelSimple/VB/form.vb" id="Snippet1"::: - - The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelSimple/VB/form.vb" id="Snippet1"::: + + The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> @@ -117,15 +117,15 @@ Initializes a new default instance of the class. - class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - + class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> @@ -157,25 +157,25 @@ Gets or sets the color used to display an active link. A that represents the color to display an active link. The default color is specified by the system, typically this color is . - control. You can use this property to specify the color that the link is displayed in when the link is in the process of being clicked. - - There are a number of colors associated with a link. The specifies the color of all links displayed in the control. The property enables you to specify the color of a link after it has been visited by the user. When a link is disabled, the is used to display the link in a disabled state. - + control. You can use this property to specify the color that the link is displayed in when the link is in the process of being clicked. + + There are a number of colors associated with a link. The specifies the color of all links displayed in the control. The property enables you to specify the color of a link after it has been visited by the user. When a link is disabled, the is used to display the link in a disabled state. + > [!NOTE] -> When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is `Color.Red` and this property is set to `Color.Red`, the text is not shown properly when the link is in the process of being clicked. - - - -## Examples - The following example demonstrates setting the property using the enumeration. It also demonstrates setting the , and properties. To run this sample paste it in a blank form and call `InitializeLinkLabel` from the form's constructor or `Load` method. - +> When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is `Color.Red` and this property is set to `Color.Red`, the text is not shown properly when the link is in the process of being clicked. + + + +## Examples + The following example demonstrates setting the property using the enumeration. It also demonstrates setting the , and properties. To run this sample paste it in a blank form and call `InitializeLinkLabel` from the form's constructor or `Load` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelExample/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkBehavior/Overview/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelExample/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelExample/VB/form1.vb" id="Snippet1"::: + ]]> @@ -212,15 +212,15 @@ Creates a new accessibility object for the control. A new for the control. - method, it will be called when the property is referenced. - - Note: To get or set the property, you must add a reference to the Accessibility assembly installed with the .NET Framework. - - Notes to Inheritors: When overriding in a derived class, you should not call the base class's method. - + method, it will be called when the property is referenced. + + Note: To get or set the property, you must add a reference to the Accessibility assembly installed with the .NET Framework. + + Notes to Inheritors: When overriding in a derived class, you should not call the base class's method. + ]]> @@ -281,25 +281,25 @@ Gets or sets the color used when displaying a disabled link. A that represents the color when displaying a disabled link. The default is . - . Disabled links do not cause the event to be raised. - - There are a number of colors associated with a link. All links in the are initially displayed with the color defined in the property. The property enables you to specify the color of the link when it is in the process of being clicked. The property enables you to specify the color of a link after it has been visited by the user. - + . Disabled links do not cause the event to be raised. + + There are a number of colors associated with a link. All links in the are initially displayed with the color defined in the property. The property enables you to specify the color of the link when it is in the process of being clicked. The property enables you to specify the color of a link after it has been visited by the user. + > [!NOTE] -> When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is `Color.Red` and this property is set to `Color.Red`, the text is not shown properly when the link is disabled. - - - -## Examples - The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - +> When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is `Color.Red` and this property is set to `Color.Red`, the text is not shown properly when the link is disabled. + + + +## Examples + The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> @@ -369,11 +369,11 @@ Gets or sets the flat style appearance of the . One of the values. - @@ -431,36 +431,36 @@ Gets or sets the range in the text to treat as a link. A that represents the area treated as a link. - property provides a quick way to specify a single hyperlink to display in the text of the control. The object provides properties that specify the starting position of the link within the text of the control and the length of text for the hyperlink. When a hyperlink is specified using the property, the hyperlink is added to the of the control. The property converts the object assigned to it to a object that is stored within the collection. - - To add multiple hyperlinks to the text of the control, you can use the property. The property enables you to access the properties and methods of the , which stores the links specified for the control. This method of adding links to the also enables you to specify data in the property that is associated with the link being created. The value of the property can be used to store the location of a file to display or the address of a Web site. - - When a control is created, a default hyperlink that contains all the text within the control is added to the . You can override this default link by specifying a new link area with the property, or specify a link using the method of the . You can also remove the default hyperlink by using the method of the class. - + property provides a quick way to specify a single hyperlink to display in the text of the control. The object provides properties that specify the starting position of the link within the text of the control and the length of text for the hyperlink. When a hyperlink is specified using the property, the hyperlink is added to the of the control. The property converts the object assigned to it to a object that is stored within the collection. + + To add multiple hyperlinks to the text of the control, you can use the property. The property enables you to access the properties and methods of the , which stores the links specified for the control. This method of adding links to the also enables you to specify data in the property that is associated with the link being created. The value of the property can be used to store the location of a file to display or the address of a Web site. + + When a control is created, a default hyperlink that contains all the text within the control is added to the . You can override this default link by specifying a new link area with the property, or specify a link using the method of the . You can also remove the default hyperlink by using the method of the class. + > [!NOTE] -> The property always returns the first item in the , regardless of how the hyperlink was added to the collection. - +> The property always returns the first item in the , regardless of how the hyperlink was added to the collection. + > [!NOTE] -> The property on will differ if you call , and the property contains double-byte characters. If you call , it will return the number of bytes in the string. Otherwise, it will return the number of actual characters. - - - -## Examples - The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - +> The property on will differ if you call , and the property contains double-byte characters. If you call , it will return the number of bytes in the string. Otherwise, it will return the number of actual characters. + + + +## Examples + The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> - The property of the object is less than zero. - - -or- - + The property of the object is less than zero. + + -or- + The property of the object is less than -1. @@ -502,20 +502,20 @@ Gets or sets a value that represents the behavior of a link. One of the values. The default is . - . - - - -## Examples - The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - + . + + + +## Examples + The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> A value is assigned that is not one of the values. @@ -555,27 +555,27 @@ Occurs when a link is clicked within the control. - event is handled to perform tasks when the user clicks on a link in the control. The event handler for the event is passed an instance of the class that contains a object that is associated with the link that was clicked. You can use information specified in the property of class to determine which link was clicked or what type of task to perform when the link is clicked. For example, if a control has a object defined with its property set to the string `www.microsoft.com`, you can use this information in an event handler for the event to display the Web site. - - For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). - - - -## Examples - The following example demonstrates using the class. The example handles the event by opening a Web site. - + event is handled to perform tasks when the user clicks on a link in the control. The event handler for the event is passed an instance of the class that contains a object that is associated with the link that was clicked. You can use information specified in the property of class to determine which link was clicked or what type of task to perform when the link is clicked. For example, if a control has a object defined with its property set to the string `www.microsoft.com`, you can use this information in an event handler for the event to display the Web site. + + For more information about handling events, see [Handling and Raising Events](/dotnet/standard/events/). + + + +## Examples + The following example demonstrates using the class. The example handles the event by opening a Web site. + :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkLabel/Overview/form.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelSimple/VB/form.vb" id="Snippet1"::: - - The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelSimple/VB/form.vb" id="Snippet1"::: + + The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> @@ -609,25 +609,25 @@ Gets or sets the color used when displaying a normal link. A that represents the color used to displaying a normal link. The default color is specified by the system, typically this color is . - . - - There are a number of colors associated with a link. The property enables you to specify the color of the link when it is in the process of being clicked. The property enables you to specify the color of a link after it has been visited by the user. When a link is disabled, the is used to display the link in a disabled state. - + . + + There are a number of colors associated with a link. The property enables you to specify the color of the link when it is in the process of being clicked. The property enables you to specify the color of a link after it has been visited by the user. When a link is disabled, the is used to display the link in a disabled state. + > [!NOTE] -> When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is `Color.Red` and this property is set to `Color.Red`, the text of the link is not shown properly. - - - -## Examples - The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - +> When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is `Color.Red` and this property is set to `Color.Red`, the text of the link is not shown properly. + + + +## Examples + The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> @@ -681,24 +681,24 @@ Gets the collection of links contained within the . A that represents the links contained within the control. - control can display any number of links within the text of the control. This property enables you to access the instance associated with the that represents the collection of links displayed in the control. You can then use the members of the class to add, remove, and find links in the collection. For more information on the types of tasks you can perform with the link collection, see . - - When a control is created, a default hyperlink that contains all the text within the control is added to the . You can override this default link by specifying a new link area with the property, or specify a link using the method of the . You can also remove the default hyperlink by using the method of the class. - - If you do not need to specify more than one link to display within the , you can use the property. - - - -## Examples - The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - + control can display any number of links within the text of the control. This property enables you to access the instance associated with the that represents the collection of links displayed in the control. You can then use the members of the class to add, remove, and find links in the collection. For more information on the types of tasks you can perform with the link collection, see . + + When a control is created, a default hyperlink that contains all the text within the control is added to the . You can override this default link by specifying a new link area with the property, or specify a link using the method of the . You can also remove the default hyperlink by using the method of the class. + + If you do not need to specify more than one link to display within the , you can use the property. + + + +## Examples + The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> @@ -738,23 +738,23 @@ if links should display as though they were visited; otherwise, . The default is . - control does not automatically denote that a link is a visited link. To display the link as a visited link, you can set the value of this property to `true` in an event handler for the event of a . A visited link is displayed using the color specified in the property of the control. Once the form containing the control is closed, the "all display" state associated with the link is deleted. In order to retain the display state of the link, you need to store the display state of the link in a registry setting associated with your application. - + control does not automatically denote that a link is a visited link. To display the link as a visited link, you can set the value of this property to `true` in an event handler for the event of a . A visited link is displayed using the color specified in the property of the control. Once the form containing the control is closed, the "all display" state associated with the link is deleted. In order to retain the display state of the link, you need to store the display state of the link in a registry setting associated with your application. + > [!NOTE] -> This property only affects the first link defined in the control. If you have more than one link specified in the control, use the property of the class. You can access all the links defined in the by using the property. - - - -## Examples - The following example demonstrates setting the property using the enumeration. It also demonstrates setting the , and properties. To run this sample paste it in a blank form and call `InitializeLinkLabel` from the form's constructor or `Load` method. - +> This property only affects the first link defined in the control. If you have more than one link specified in the control, use the property of the class. You can access all the links defined in the by using the property. + + + +## Examples + The following example demonstrates setting the property using the enumeration. It also demonstrates setting the , and properties. To run this sample paste it in a blank form and call `InitializeLinkLabel` from the form's constructor or `Load` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelExample/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkBehavior/Overview/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelExample/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabelExample/VB/form1.vb" id="Snippet1"::: + ]]> @@ -788,13 +788,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -832,13 +832,13 @@ An that contains the event data. Provides handling for the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -908,11 +908,11 @@ An that contains the event data. Raises the event. - @@ -954,11 +954,11 @@ A that contains the event data. Raises the event. - @@ -999,13 +999,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -1045,11 +1045,11 @@ An that contains the event data. Raises the event. - @@ -1091,11 +1091,11 @@ A that contains the event data. Raises the event. - @@ -1136,11 +1136,11 @@ An that contains the event data. Raises the event. - @@ -1181,11 +1181,11 @@ A that contains the event data. Raises the event. - @@ -1226,11 +1226,11 @@ A that contains the event data. Raises the event. - @@ -1270,13 +1270,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -1314,11 +1314,11 @@ A that contains the event data. Raises the event. - @@ -1539,11 +1539,11 @@ Gets the link located at the specified client coordinates. A representing the link located at the specified coordinates. If the point does not contain a link, is returned. - control. You can use this method in an event handler for the event of the control to determine whether the mouse pointer is hovering over a link in the control. Once you have determined that the mouse pointer is over a link, you can then display additional information about the link to the user through text or a . - + control. You can use this method in an event handler for the event of the control to determine whether the mouse pointer is hovering over a link in the control. Once you have determined that the mouse pointer is over a link, you can then display additional information about the link to the user through text or a . + ]]> @@ -1581,11 +1581,11 @@ to consume the key; to allow further processing. - @@ -1665,11 +1665,11 @@ Which values were specified. This parameter reflects user intent, not which values have changed. Performs the work of setting the bounds of this control. - @@ -1703,11 +1703,11 @@ For a description of this member, see . One of the values. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -1746,11 +1746,11 @@ if the control should behave as a default button; otherwise, . Notifies the control that it is the default button. - control appears the same regardless of whether it is the default button, so calling this method will not change the appearance or behavior of the . - + control appears the same regardless of whether it is the default button, so calling this method will not change the appearance or behavior of the . + ]]> @@ -1785,11 +1785,11 @@ Generates a event for the control. - to be clicked. - + to be clicked. + ]]> @@ -1830,11 +1830,11 @@ if the user can tab to the ;otherwise, . The default is . - property is `true` by default, as long as there is at least one link of greater than zero length in the collection. The control has a single value. However, each link of greater than zero length gets its own tab stop, in left-to-right order. To prevent tab navigation to the control, set the property to `false`. However, be aware that adding new links to the collection will automatically set the property to `true` again. - + property is `true` by default, as long as there is at least one link of greater than zero length in the collection. The control has a single value. However, each link of greater than zero length gets its own tab stop, in left-to-right order. To prevent tab navigation to the control, set the property to `false`. However, be aware that adding new links to the collection will automatically set the property to `true` again. + ]]> @@ -1879,21 +1879,21 @@ Occurs when the value of the property changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `LinkLabel1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `LinkLabel1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet460"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet460"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet460"::: + ]]> @@ -1974,17 +1974,17 @@ if the class should be used to perform text rendering for compatibility with versions 1.0 and 1.1. of the .NET Framework; otherwise, . The default is . - property is set to `false`, the covers the entire text. For example, text such as "abcd " is rendered with the trailing space underlined. - - If the property is set to `true`, the does not cover the entire text. - - The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. - - The GDI based class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. - + property is set to `false`, the covers the entire text. For example, text such as "abcd " is rendered with the trailing space underlined. + + If the property is set to `true`, the does not cover the entire text. + + The `UseCompatibleTextRendering` property is intended to provide visual compatibility between Windows Forms controls that render text using the class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, it's recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. + +You can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. + ]]> @@ -2020,25 +2020,25 @@ Gets or sets the color used when displaying a link that has been previously visited. A that represents the color used to display links that have been visited. The default color is specified by the system, typically this color is . - that have been visited by the user. - - There are a number of colors associated with a link. All links in the are initially displayed with the color defined in the property. The property enables you to specify the color of the link when it is in the process of being clicked. When a link is disabled, the is used to display the link in a disabled state. - + that have been visited by the user. + + There are a number of colors associated with a link. All links in the are initially displayed with the color defined in the property. The property enables you to specify the color of the link when it is in the process of being clicked. When a link is disabled, the is used to display the link in a disabled state. + > [!NOTE] -> When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is `Color.Red` and this property is set to `Color.Red`, the text is not shown properly when the link is displayed as a visited link. - - - -## Examples - The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. - +> When setting this property, ensure that the color you are setting the property to does not conflict with the color of the control's background or the text does not display properly. For example, if the background color of the control is `Color.Red` and this property is set to `Color.Red`, the text is not shown properly when the link is displayed as a visited link. + + + +## Examples + The following example demonstrates using the class, with multiple sections defined, to display a label on a form. The example demonstrates setting the , , , , and properties to customize the look of the . The first is specified using the property. Additional links are added to the using the method. The example handles the event by starting the Web browser for hyperlinks, and displaying a for other links. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/CPP/linklabel.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LinkArea/Overview/linklabel.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.LinkLabel/VB/linklabel.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Windows.Forms/ListView.xml b/xml/System.Windows.Forms/ListView.xml index c5806908e55..26eab4eab4d 100644 --- a/xml/System.Windows.Forms/ListView.xml +++ b/xml/System.Windows.Forms/ListView.xml @@ -6928,17 +6928,14 @@ When this property is set to `false`, selected items in the System.Boolean - Gets or sets a value indicating whether the uses state image behavior that is compatible with the .NET Framework 1.1 or the .NET Framework 2.0. + Gets or sets a value indicating whether the uses state image behavior that is compatible with .NET Framework 1.1 or .NET Framework 2.0 and later. - if the state image behavior is compatible with the .NET Framework 1.1; if the behavior is compatible with the .NET Framework 2.0. The default is . + if the state image behavior is compatible with .NET Framework 1.1; if the behavior is compatible with .NET Framework 2.0 and later. The default is . control in the .NET Framework 2.0 enable custom state images to be set to indicate whether an item is checked or unchecked or in an indeterminate state. With the addition of this feature, the .NET Framework 2.0 has different behavior than the .NET Framework 1.1. If you have created applications that depend on the behavior in the .NET Framework 1.1, be sure that the property is set to `true`, which is the default value. In order to fully take advantage of custom state images, set to `false`. - -> [!NOTE] -> If you are using the Microsoft Visual Studio 2005 designer, the property will be set to `false`. + Changes to the control in .NET Framework 2.0 enabled custom state images to be set to indicate whether an item is checked or unchecked or in an indeterminate state. If you created applications that depend on the behavior in .NET Framework 1.1, check that the property is set to `true`, which is the default value. To fully take advantage of custom state images, set to `false`. ]]> diff --git a/xml/System.Windows.Forms/PropertyGrid.xml b/xml/System.Windows.Forms/PropertyGrid.xml index 588aa3dded2..9cdd876c8e3 100644 --- a/xml/System.Windows.Forms/PropertyGrid.xml +++ b/xml/System.Windows.Forms/PropertyGrid.xml @@ -57,37 +57,37 @@ Provides a user interface for browsing the properties of an object. - class on a parent control and set to the object to display the properties for. - - The information displayed in the grid is a snapshot of the properties at the time the object is assigned. If a property value of the object specified by the is changed in code at run time, the new value is not displayed until an action is taken in the grid that causes the grid to refresh. - - The property tabs within the property grid appear as buttons on the toolbar at the top of the , and can vary in scope as defined in the . - - You can use the property to display large buttons instead of the default smaller ones. Large buttons are 32-by-32 pixels rather than the standard 16-by-16 pixels. The large and small buttons and the property list expander icons (the plus or minus icons) are resized according to the system DPI setting when the app.config file contains the following entry: - -``` - - - - -``` - - The control is not initially presented in the toolbox in the development environment. You can add a property grid to the toolbox, which enables you to drag a onto your form. You can also define an instance of by adding the appropriate code in your source code. - - All public properties of the will be displayed in the by default. You can hide a property so that it is not displayed in the control by decorating it with the and setting the value to `false`. You can specify the category that a property appears in by providing a category with the . You can provide descriptive text for your property that appears at the bottom of the control by using the . - - - -## Examples - The following code example illustrates creating a property grid and setting its location on a form. This example requires that you have a form with a on it. - + class on a parent control and set to the object to display the properties for. + + The information displayed in the grid is a snapshot of the properties at the time the object is assigned. If a property value of the object specified by the is changed in code at run time, the new value is not displayed until an action is taken in the grid that causes the grid to refresh. + + The property tabs within the property grid appear as buttons on the toolbar at the top of the , and can vary in scope as defined in the . + + You can use the property to display large buttons instead of the default smaller ones. Large buttons are 32-by-32 pixels rather than the standard 16-by-16 pixels. The large and small buttons and the property list expander icons (the plus or minus icons) are resized according to the system DPI setting when the app.config file contains the following entry: + +``` + + + + +``` + + The control is not initially presented in the toolbox in the development environment. You can add a property grid to the toolbox, which enables you to drag a onto your form. You can also define an instance of by adding the appropriate code in your source code. + + All public properties of the will be displayed in the by default. You can hide a property so that it is not displayed in the control by decorating it with the and setting the value to `false`. You can specify the category that a property appears in by providing a category with the . You can provide descriptive text for your property that appears at the bottom of the control by using the . + + + +## Examples + The following code example illustrates creating a property grid and setting its location on a form. This example requires that you have a form with a on it. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic PropertyGrid Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/PropertyGrid/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyGrid Example/VB/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic PropertyGrid Example/VB/source.vb" id="Snippet1"::: + ]]> @@ -116,11 +116,11 @@ Initializes a new instance of the class. - property. - + property. + ]]> @@ -163,11 +163,11 @@ if enabled; otherwise, . - @@ -244,11 +244,11 @@ This property is not relevant for this class. The background image of the property grid. - @@ -294,11 +294,11 @@ Occurs when the value of the property changes. - @@ -339,11 +339,11 @@ This property is not relevant for this class. The background image layout of the property grid. - @@ -388,11 +388,11 @@ Occurs when the value of the property changes. - @@ -442,13 +442,13 @@ Gets or sets the browsable attributes associated with the object that the property grid is attached to. The collection of browsable attributes associated with the object. - . The default is an containing only . - - Assigning an attribute collection that is empty or is `null` causes a new to be created with set. - + . The default is an containing only . + + Assigning an attribute collection that is empty or is `null` causes a new to be created with set. + ]]> @@ -493,11 +493,11 @@ if the commands pane can be made visible; otherwise, . - is `true` and the object has commands available. - + is `true` and the object has commands available. + ]]> @@ -572,11 +572,11 @@ Gets or sets the text color used for category headings. A structure representing the text color. - property. - + property. + ]]> @@ -641,11 +641,11 @@ Collapses all the categories in the . - @@ -863,11 +863,11 @@ if the commands pane is visible; otherwise, . The default is . - property is `true`. - + property is `true`. + ]]> @@ -957,11 +957,11 @@ Gets the default location for the shortcut menu. The default location for the shortcut menu if the command is invoked. Typically, this is centered over the selected property. - @@ -1011,11 +1011,11 @@ This property is not relevant for this class. The controls associated with the property grid. - @@ -1080,11 +1080,11 @@ When overridden in a derived class, enables the creation of a . The newly created property tab. Returns in its default implementation. - for more information about creating property tabs. - + for more information about creating property tabs. + ]]> @@ -1165,11 +1165,11 @@ Gets the type of the default tab. A representing the default tab. - . Override this property to specify a modified version of the . - + . Override this property to specify a modified version of the . + ]]> @@ -1238,14 +1238,14 @@ to release both managed and unmanaged resources; to release only unmanaged resources. Disposes of the resources (other than memory) used by the . - when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the memory it was occupying can be reclaimed by garbage collection. - + when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the memory it was occupying can be reclaimed by garbage collection. + > [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources the is using will not be freed until garbage collection calls the destructor of . - +> Always call before you release your last reference to the . Otherwise, the resources the is using will not be freed until garbage collection calls the destructor of . + ]]> @@ -1352,11 +1352,11 @@ This property is not relevant for this class. The foreground color of the control. - @@ -1402,11 +1402,11 @@ Occurs when the value of the property changes. - @@ -1556,11 +1556,11 @@ if the help text is visible; otherwise, . The default is . - @@ -1605,21 +1605,21 @@ Occurs when a key is first pressed. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet522"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet522"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet522"::: + ]]> @@ -1664,21 +1664,21 @@ Occurs when a key is pressed while the control has focus. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet523"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet523"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet523"::: + ]]> @@ -1723,21 +1723,21 @@ Occurs when a key is released while the control has focus. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet524"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet524"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet524"::: + ]]> @@ -1776,18 +1776,18 @@ if buttons on the control appear large; otherwise, . The default is . - - - - -``` - + + + + +``` + ]]> @@ -1871,11 +1871,11 @@ Occurs when the user clicks the control with the mouse. - @@ -1920,11 +1920,11 @@ Occurs when the mouse pointer enters the control. - @@ -1969,11 +1969,11 @@ Occurs when the mouse pointer leaves the control. - @@ -2018,11 +2018,11 @@ Occurs when the mouse pointer moves over the control. - @@ -2067,11 +2067,11 @@ Occurs when the mouse pointer is over the control and the user releases a mouse button. - @@ -2106,13 +2106,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2149,13 +2149,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2226,13 +2226,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2270,13 +2270,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2347,13 +2347,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2391,13 +2391,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2435,13 +2435,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2489,13 +2489,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2533,13 +2533,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2576,13 +2576,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2620,13 +2620,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2664,13 +2664,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2708,13 +2708,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2752,13 +2752,13 @@ A that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2796,13 +2796,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2840,13 +2840,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2884,13 +2884,13 @@ An that contains the event data. Raises the event. - method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -2942,11 +2942,11 @@ This property is not relevant for this class. A value. - @@ -2991,11 +2991,11 @@ Occurs when the value of the property changes. - @@ -3071,25 +3071,25 @@ Gets or sets the type of sorting the uses to display properties. One of the values. The default is or . - property, the appearance of the property sort buttons on the grid changes to reflect the current state of the property. Setting to causes the properties to be displayed in the order they were retrieved. - - Setting to both and is the same as setting to alone. The categorized view is always shown as alphabetical. - + property, the appearance of the property sort buttons on the grid changes to reflect the current state of the property. Setting to causes the properties to be displayed in the order they were retrieved. + + Setting to both and is the same as setting to alone. The categorized view is always shown as alphabetical. + > [!NOTE] -> To do custom sorting, implement on the component to return the properties in the desired order. - - - -## Examples - The following code example demonstrates initializing a control using the , properties. In addition, this example sets the control's property to `false` so the grid will not be visible when the example is run. To run this example paste the following code in a form and call the `InitializePropertyGrid` method from the form's constructor or event-handling method. To view the property grid when the form is running, change the grid's property to `true`, recompile, and rerun the form. - +> To do custom sorting, implement on the component to return the properties in the desired order. + + + +## Examples + The following code example demonstrates initializing a control using the , properties. In addition, this example sets the control's property to `false` so the grid will not be visible when the example is run. To run this example paste the following code in a form and call the `InitializePropertyGrid` method from the form's constructor or event-handling method. To view the property grid when the form is running, change the grid's property to `true`, recompile, and rerun the form. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.PropertyGridExample/CPP/form1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/CheckedListBox+ObjectCollection/Add/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.PropertyGridExample/VB/form1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.PropertyGridExample/VB/form1.vb" id="Snippet2"::: + ]]> The assigned value is not one of the values. @@ -3128,21 +3128,21 @@ Occurs when the sort mode is changed. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet532"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet532"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet532"::: + ]]> @@ -3180,21 +3180,21 @@ Occurs when a property tab changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet531"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet531"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet531"::: + ]]> @@ -3244,11 +3244,11 @@ Gets the collection of property tabs that are displayed in the grid. A containing the collection of objects being displayed by the . - class. - + class. + ]]> @@ -3286,21 +3286,21 @@ Occurs when a property value changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet530"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet530"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet530"::: + ]]> @@ -3365,11 +3365,11 @@ Either the or value of . Refreshes the property tabs of the specified scope. - method first deletes the property tabs of the specified scope, it then requires the objects and documents to rebuild the tabs. - + method first deletes the property tabs of the specified scope, it then requires the objects and documents to rebuild the tabs. + ]]> The parameter is not the or value of . @@ -3429,11 +3429,11 @@ Resets the selected property to its default value. - method is invoked by right clicking on the property. This method discards changes and attempts to reset the property to its default value. - + method is invoked by right clicking on the property. This method discards changes and attempts to reset the property to its default value. + ]]> @@ -3476,11 +3476,11 @@ The vertical scaling factor. This method is not relevant for this class. - @@ -3535,13 +3535,13 @@ Gets or sets the selected grid item. The currently selected row in the property grid. - corresponds to a property of the . - - You can use the returned to view type information, the , the parent, and the children of the selected object. - + corresponds to a property of the . + + You can use the returned to view type information, the , the parent, and the children of the selected object. + ]]> @@ -3579,21 +3579,21 @@ Occurs when the selected is changed. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet533"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet533"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet533"::: + ]]> @@ -3706,11 +3706,11 @@ Gets or sets the object for which the grid displays properties. The first object in the object list. If there is no currently selected object the return is . - property sets a single object into the grid to be browsed. If multiple objects are being browsed, this property returns the first one in the list. If no objects are selected, `null` is returned. - + property sets a single object into the grid to be browsed. If multiple objects are being browsed, this property returns the first one in the list. If no objects are selected, `null` is returned. + ]]> @@ -3756,11 +3756,11 @@ Gets or sets the currently selected objects. An array of type . The default is an empty array. - only displays the properties that are common to all the objects that are in the array. Assigning an array to the replaces the reference to any you might make. - + only displays the properties that are common to all the objects that are in the array. Assigning an array to the replaces the reference to any you might make. + ]]> One of the items in the array of objects had a null value. @@ -3799,21 +3799,21 @@ Occurs when the objects selected by the property have changed. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet534"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet534"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet534"::: + ]]> @@ -3863,11 +3863,11 @@ Gets the currently selected property tab. The that is providing the selected view. - class. - + class. + ]]> @@ -4185,11 +4185,11 @@ This member is an explicit interface member implementation. It can be used only Closes any open drop-down controls on the control. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -4226,11 +4226,11 @@ This member is an explicit interface member implementation. It can be used only if all the successfully commits changes; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -4265,11 +4265,11 @@ This member is an explicit interface member implementation. It can be used only Activates the control when the user chooses properties for a control in Design view. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -4304,11 +4304,11 @@ This member is an explicit interface member implementation. It can be used only if the control is currently setting one of the properties of its selected object; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -4354,13 +4354,13 @@ This member is an explicit interface member implementation. It can be used only The registry key that contains the user states. Loads user states from the registry into the control. For a description of this member, see . - instance is cast to an interface. - - Visual Studio 2005 saves some of the control states, such as the and properties, to the registry and loads them the next time the user runs the application. - + instance is cast to an interface. + + Visual Studio 2005 saves some of the control states, such as the and properties, to the registry and loads them the next time the user runs the application. + ]]> @@ -4406,13 +4406,13 @@ This member is an explicit interface member implementation. It can be used only The registry key that contains the user states. Saves user states from the control to the registry. For a description of this member, see . - instance is cast to an interface. - - Visual Studio 2005 saves some of the control states, such as the and properties, to the registry and loads them the next time the user runs the application. - + instance is cast to an interface. + + Visual Studio 2005 saves some of the control states, such as the and properties, to the registry and loads them the next time the user runs the application. + ]]> @@ -4496,21 +4496,21 @@ This member is an explicit interface member implementation. It can be used only Occurs when the text of the changes. - event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . - - To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. - + event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing with or appending the message to a multiline . + + To run the example code, paste it into a project that contains an instance of type named `PropertyGrid1`. Then ensure that the event handler is associated with the event. + :::code language="csharp" source="~/snippets/csharp/System.ComponentModel/CollectionChangeEventArgs/Overview/EventExamples.cs" id="Snippet521"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet521"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb" id="Snippet521"::: + ]]> @@ -4553,15 +4553,15 @@ This member is an explicit interface member implementation. It can be used only if the toolbar is visible; otherwise, . The default is . - control using the , properties. In addition, this example sets the control's property to `false` so the grid will not be visible when the example is run. To run this example paste the following code in a form and call the `InitializePropertyGrid` method from the form's constructor or event-handling method. To view the property grid when the form is running, change the grid's property to `true`, recompile, and rerun the form. - + control using the , properties. In addition, this example sets the control's property to `false` so the grid will not be visible when the example is run. To run this example paste the following code in a form and call the `InitializePropertyGrid` method from the form's constructor or event-handling method. To view the property grid when the form is running, change the grid's property to `true`, recompile, and rerun the form. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.PropertyGridExample/CPP/form1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/CheckedListBox+ObjectCollection/Add/form1.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.PropertyGridExample/VB/form1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.PropertyGridExample/VB/form1.vb" id="Snippet2"::: + ]]> @@ -4632,15 +4632,15 @@ This member is an explicit interface member implementation. It can be used only Gets or sets a value that determines whether to use the class (GDI+) or the class (GDI) to render text. - if the class should be used to perform text rendering for compatibility with versions 1.0 and 1.1. of the .NET Framework; otherwise, . The default is . + if the class should be used to perform text rendering for compatibility with versions 1.0 and 1.1. of .NET Framework; otherwise, . The default is . - class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, if your application is not being upgraded from .NET Framework 1.0 or .NET Framework 1.1, it is recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. - - The GDI based class was introduced in the .NET Framework 2.0 to improve performance, make text look better, and improve support for international fonts. In earlier versions of the .NET Framework, the GDI+ based class was used to perform all text rendering. GDI calculates character spacing and word wrapping differently from GDI+. In a Windows Forms application that uses the class to render text, this could cause the text for controls that use to appear different from the other text in the application. To resolve this incompatibility, you can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. - + class and .NET Framework 1.0 and .NET Framework 1.1 applications that perform custom text rendering using the class. In most cases, it's recommended that you leave `UseCompatibleTextRendering` set to the default value of `false`. + +You can set the `UseCompatibleTextRendering` property to `true` for a specific control. To set `UseCompatibleTextRendering` to `true` for all supported controls in the application, call the method with a parameter of `true`. + ]]> diff --git a/xml/System.Windows.Forms/TabControl.xml b/xml/System.Windows.Forms/TabControl.xml index 68f702fb28f..95b2817a780 100644 --- a/xml/System.Windows.Forms/TabControl.xml +++ b/xml/System.Windows.Forms/TabControl.xml @@ -63,31 +63,23 @@ ## Remarks A contains tab pages, which are represented by objects that you add through the property. The order of tab pages in this collection reflects the order the tabs appear in the control. - The user can change the current by clicking one of the tabs in the control. You can also programmatically change the current by using one of the following properties: + The user can change the current by clicking one of the tabs in the control. You can also programmatically change the current by using one of the following properties and methods: -- +- +- +- +- -- +You can respond when the current tab changes by handling one of the following events: - In .NET Framework 2.0, you can also use one of the following methods: - -- - -- - - In .NET Framework 2.0, you can respond when the current tab changes by handling one of the following events: - -- - -- - -- - -- +- +- +- +- The tabs in a are part of the , but not parts of the individual controls. Members of the class, such as the property, affect only the client rectangle of the tab page, but not the tabs. Additionally, the method of the will not hide the tab. To hide the tab, you must remove the control from the collection. - In .NET Framework 2.0, the tab is considered part of the tab page for determining when the and events of the occur. In earlier versions of the .NET Framework, the and events of the do not occur when focus enters or leaves a tab, but only when focus enters or leaves the client rectangle of the tab page. +The tab is considered part of the tab page for determining when the and events of the occur. The following events are not raised for the class unless there is at least one in the collection: , , , , , , and . If there is at least one in the collection, and the user interacts with the tab control's header (where the names appear), the raises the appropriate event. However, if the user interaction is within the of the tab page, the raises the appropriate event. @@ -728,13 +720,13 @@ ## Remarks When the current tab changes in a , the following events occur in the following order. -- +- -- +- -- +- -- +- These events let you perform tasks such as canceling a tab change if a is in an invalid state or updating the state of a newly displayed . @@ -799,13 +791,13 @@ ## Remarks When the current tab changes in a , the following events occur in the following order. -- +- -- +- -- +- -- +- These events let you perform tasks such as canceling a tab change if a is in an invalid state or updating the state of a newly displayed . @@ -1956,7 +1948,8 @@ event of the current . In .NET Framework 2.0, the tab is considered part of the tab page for determining when the and events of the occur. In earlier versions of the .NET Framework, the and events of the do not occur when focus enters or leaves a tab, but only when focus enters or leaves the client rectangle of the tab page. + +This method also raises the event of the current . The tab is considered part of the tab page for determining when the and events of the occur. Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2202,7 +2195,8 @@ event of the current . In .NET Framework 2.0, the tab is considered part of the tab page for determining when the and events of the occur. In earlier versions of the .NET Framework, the and events of the do not occur when focus enters or leaves a tab, but only when focus enters or leaves the client rectangle of the tab page. + +This method also raises the event of the current . The tab is considered part of the tab page for determining when the and events of the occur. Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). @@ -2900,13 +2894,13 @@ ## Remarks When the current tab changes in a , the following events occur in the following order. -- +- -- +- -- +- -- +- These events let you perform tasks such as canceling a tab change if a is in an invalid state or updating the state of a newly displayed . @@ -3165,13 +3159,13 @@ ## Remarks When the current tab changes in a , the following events occur in the following order. -- +- -- +- -- +- -- +- These events let you perform tasks such as canceling a tab change if a is in an invalid state or updating the state of a newly displayed . diff --git a/xml/System.Windows.Forms/TabPage.xml b/xml/System.Windows.Forms/TabPage.xml index 77203912f6c..1924b987018 100644 --- a/xml/System.Windows.Forms/TabPage.xml +++ b/xml/System.Windows.Forms/TabPage.xml @@ -66,34 +66,32 @@ Represents a single tab page in a . - controls represent the tabbed pages in a control. The order of tab pages in the collection reflects the order of tabs in the control. To change the order of tabs in the control, you must change their positions in the collection by removing them and inserting them at new indexes. - - controls are constrained by their container, so some of the properties inherited from the base class will have no effect, including , , , , , and . - - The tabs in a are part of the but not parts of the individual controls. Members of the class, such as the property, affect only the client rectangle of the tab page, but not the tabs. Additionally, the method of the will not hide the tab. To hide the tab, you must remove the control from the collection. - + controls represent the tabbed pages in a control. The order of tab pages in the collection reflects the order of tabs in the control. To change the order of tabs in the control, you must change their positions in the collection by removing them and inserting them at new indexes. + + controls are constrained by their container, so some of the properties inherited from the base class will have no effect, including , , , , , and . + + The tabs in a are part of the but not parts of the individual controls. Members of the class, such as the property, affect only the client rectangle of the tab page, but not the tabs. Additionally, the method of the will not hide the tab. To hide the tab, you must remove the control from the collection. + > [!NOTE] -> In .NET Framework 2.0, the tab is considered part of the tab page for determining when the and events of the occur. In earlier versions of the .NET Framework, the and events of the do not occur when focus enters or leaves a tab, but only when focus enters or leaves the client rectangle of the tab page. - - For more information about how this control responds to the and methods, see the following members: , , , , , . - +> The tab is considered part of the tab page for determining when the and events of the occur. + + For more information about how this control responds to the and methods, see the following members: , , , , , . + > [!NOTE] -> Controls contained in a are not created until the tab page is shown, and any data bindings in these controls are not activated until the tab page is shown. - - In .NET Framework 2.0, the property lets you indicate whether the background of the tab page should render using the current visual style. This occurs only when the and property values are both `true` and the property of the parent is . Otherwise, the background is painted normally. - - - -## Examples - The following code example creates a with one . - +> Controls contained in a are not created until the tab page is shown, and any data bindings in these controls are not activated until the tab page is shown. + +The property lets you indicate whether the background of the tab page should render using the current visual style. This occurs only when the and property values are both `true` and the property of the parent is . Otherwise, the background is painted normally. + +## Examples + The following code example creates a with one . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/TabPage/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/TabPage/Overview/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage/VB/form1.vb" id="Snippet1"::: + ]]> @@ -133,15 +131,15 @@ Initializes a new instance of the class. - with one . The constructor instantiates `tabPage1`. - + with one . The constructor instantiates `tabPage1`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/TabPage_constructor/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/TabPage/.ctor/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage_constructor/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage_constructor/VB/form1.vb" id="Snippet1"::: + ]]> @@ -174,20 +172,20 @@ The text for the tab. Initializes a new instance of the class and specifies the text for the tab. - property is set to the value of the `text` parameter. - - - -## Examples - This example creates a with a . The constructor accepts the `myTabPage` string as for `tabPage1`. - + property is set to the value of the `text` parameter. + + + +## Examples + This example creates a with a . The constructor accepts the `myTabPage` string as for `tabPage1`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/TabPage_withText/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/TabPage/.ctor/form11.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage_withText/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage_withText/VB/form1.vb" id="Snippet1"::: + ]]> @@ -313,11 +311,11 @@ Occurs when the value of the property changes. - property and handle this event to determine when the value changes, the property is not meaningful for this control. - + property and handle this event to determine when the value changes, the property is not meaningful for this control. + ]]> @@ -398,13 +396,13 @@ Gets or sets the background color for the . A that represents the background color of the . - property is the value of the property unless the and property values are both `true` and the property of the parent has a value of , in which case the default value of the property is . Child controls that you place on the inherit the value by default, so this behavior causes the background of the child controls to render with the current visual style. - - Changing the value of the property automatically sets the property to `false`. If you want the background to render using visual styles but you want the child controls to inherit a value that you specify, set the property after you set the property. - + property is the value of the property unless the and property values are both `true` and the property of the parent has a value of , in which case the default value of the property is . Child controls that you place on the inherit the value by default, so this behavior causes the background of the child controls to render with the current visual style. + + Changing the value of the property automatically sets the property to `false`. If you want the background to render using visual styles but you want the child controls to inherit a value that you specify, set the property after you set the property. + ]]> @@ -549,11 +547,11 @@ Occurs when the value of the property changes. - property is not meaningful for this control, although you can change its value and handle the event to detect the change. - + property is not meaningful for this control, although you can change its value and handle the event to detect the change. + ]]> @@ -634,11 +632,11 @@ Occurs when the value of the property changes. - property is not meaningful for this control, although you can change its value and handle the event to detect the change. - + property is not meaningful for this control, although you can change its value and handle the event to detect the change. + ]]> @@ -675,15 +673,15 @@ Retrieves the tab page that contains the specified object. The that contains the specified object, or if the object cannot be found. - with two objects, each containing one component. The parameter `button2` is passed to the method, which retrieves the containing `button2`. To verify that the correct tab page is retrieved, the property sets the containing `button2` to the currently selected tab page. - + with two objects, each containing one component. The parameter `button2` is passed to the method, which retrieves the containing `button2`. To verify that the correct tab page is retrieved, the property sets the containing `button2` to the currently selected tab page. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/GetTabPageOfComponent/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/TabPage/GetTabPageOfComponent/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/GetTabPageOfComponent/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/GetTabPageOfComponent/VB/form1.vb" id="Snippet1"::: + ]]> @@ -749,22 +747,22 @@ Gets or sets the index to the image displayed on this tab. The zero-based index to the image in the that appears on the tab. The default is -1, which signifies no image. - points to an image in the associated of the . - + points to an image in the associated of the . + and are mutually exclusive, meaning if one is set, the other is set to an invalid value and ignored. -If you set the property, the property is automatically set to -1. Alternatively, if you set the property, the is automatically set to an empty string (""). - - -## Examples - The following code example creates a with one . This example uses the property to specify which image from `myImages` displays on the tab of `tabPage1`. - +If you set the property, the property is automatically set to -1. Alternatively, if you set the property, the is automatically set to an empty string (""). + + +## Examples + The following code example creates a with one . This example uses the property to specify which image from `myImages` displays on the tab of `tabPage1`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/TabPage.ImageIndex/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/TabPage/ImageIndex/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage.ImageIndex/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage.ImageIndex/VB/form1.vb" id="Snippet1"::: + ]]> @@ -832,13 +830,13 @@ If you set the property, the Gets or sets the key accessor for the image in the of the associated . A string representing the key of the image. - property specifies the image from the image list to display on the control. - + property specifies the image from the image list to display on the control. + and are mutually exclusive, meaning if one is set, the other is set to an invalid value and ignored. -If you set the property, the property is automatically set to -1. Alternatively, if you set the property, the is automatically set to an empty string (""). +If you set the property, the property is automatically set to -1. Alternatively, if you set the property, the is automatically set to an empty string (""). ]]> @@ -918,11 +916,11 @@ If you set the property, the Occurs when the value of the property changes. - property and handle this event to determine when the value changes, the property is not meaningful for this control. - + property and handle this event to determine when the value changes, the property is not meaningful for this control. + ]]> @@ -1040,15 +1038,16 @@ If you set the property, the An that contains the event data. Raises the event of the . - and events of the occur. In earlier versions of the .NET Framework, the and events of the do not occur when focus enters or leaves a tab, but only when focus enters or leaves the client rectangle of the tab page. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + and events of the occur. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -1090,15 +1089,16 @@ If you set the property, the An that contains the event data. Raises the event of the . - and events of the occur. In earlier versions of the .NET Framework, the and events of the do not occur when focus enters or leaves a tab, but only when focus enters or leaves the client rectangle of the tab page. - - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + and events of the occur. + + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> @@ -1136,11 +1136,11 @@ If you set the property, the A that contains data useful for painting the background. Paints the background of the . - . When the and property values are both `true` and the property of the parent is , this method paints the background using the current visual style. Otherwise, this method paints the background as usual. - + . When the and property values are both `true` and the property of the parent is , this method paints the background using the current visual style. Otherwise, this method paints the background as usual. + ]]> @@ -1260,11 +1260,11 @@ If you set the property, the This property is not meaningful for this control. The tab order of the control. - property indicates the order in which controls receive focus as a user presses the TAB key on a form. controls are contained within controls, however, and do not receive focus individually as part of the form's TAB order. This property is therefore meaningless for this class. - + property indicates the order in which controls receive focus as a user presses the TAB key on a form. controls are contained within controls, however, and do not receive focus individually as part of the form's TAB order. This property is therefore meaningless for this class. + ]]> @@ -1307,11 +1307,11 @@ If you set the property, the Occurs when the value of the property changes. - property is not meaningful for this control, although you can change its value and handle the event to detect the change. - + property is not meaningful for this control, although you can change its value and handle the event to detect the change. + ]]> @@ -1353,11 +1353,11 @@ If you set the property, the This member is not meaningful for this control. The default is . - controls are contained within controls and do not receive focus individually as part of the form's TAB order. This property is therefore meaningless for this class. - + controls are contained within controls and do not receive focus individually as part of the form's TAB order. This property is therefore meaningless for this class. + ]]> @@ -1399,11 +1399,11 @@ If you set the property, the Occurs when the value of the property changes. - property is not meaningful for this control, although you can change its value and handle the event to detect the change. - + property is not meaningful for this control, although you can change its value and handle the event to detect the change. + ]]> @@ -1453,20 +1453,20 @@ If you set the property, the Gets or sets the text to display on the tab. The text to display on the tab. - property value does not automatically center the new value on the tab if the has a property value of . You can work around this limitation by setting the property or by removing the from the collection and adding it back to the collection. Both of these actions will automatically center the text. - - - -## Examples - The following code example creates a with one . The property sets the tab page text to `myTabPage`. - + property value does not automatically center the new value on the tab if the has a property value of . You can work around this limitation by setting the property or by removing the from the collection and adding it back to the collection. Both of these actions will automatically center the text. + + + +## Examples + The following code example creates a with one . The property sets the tab page text to `myTabPage`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/TabText/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/TabPage/Text/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabText/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabText/VB/form1.vb" id="Snippet1"::: + ]]> @@ -1554,20 +1554,20 @@ If you set the property, the Gets or sets the ToolTip text for this tab. The ToolTip text for this tab. - . The ToolTip text appears when the user moves the mouse over the tab if the property of the is `true`. For more information about ToolTips, see the class. - - - -## Examples - The following code example creates a with two objects. The is set to allow ToolTips, and the tab pages are assigned ToolTip text. - + . The ToolTip text appears when the user moves the mouse over the tab if the property of the is `true`. For more information about ToolTips, see the class. + + + +## Examples + The following code example creates a with two objects. The is set to allow ToolTips, and the tab pages are assigned ToolTip text. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/ToolTipText/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/TabControl/ShowToolTips/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ToolTipText/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/ToolTipText/VB/form1.vb" id="Snippet1"::: + ]]> @@ -1602,15 +1602,15 @@ If you set the property, the Returns a string containing the value of the property. A string containing the value of the property. - with a . The method creates a string that includes the value for `tabPage1` and returns it to the `tabPage1` property. - + with a . The method creates a string that includes the value for `tabPage1` and returns it to the `tabPage1` property. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/TabPage.ToString/CPP/form1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/TabPage/ToString/form1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage.ToString/VB/form1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TabPage.ToString/VB/form1.vb" id="Snippet1"::: + ]]> @@ -1652,15 +1652,15 @@ If you set the property, the to render the background using the current visual style; otherwise, . The default is . - background uses the current visual style only when the and property values are both `true`. - - When the and property values are both `true` and the property of the parent is , the default value of the property is . Child controls that you place on the inherit the value by default, so this behavior causes the background of the child controls to render with the current visual style. - - Changing the value of the property automatically sets the property to `false`. If you want the background to render using visual styles but you want the child controls to inherit a value that you specify, set the property after you set the property. - + background uses the current visual style only when the and property values are both `true`. + + When the and property values are both `true` and the property of the parent is , the default value of the property is . Child controls that you place on the inherit the value by default, so this behavior causes the background of the child controls to render with the current visual style. + + Changing the value of the property automatically sets the property to `false`. If you want the background to render using visual styles but you want the child controls to inherit a value that you specify, set the property after you set the property. + ]]> @@ -1707,13 +1707,13 @@ If you set the property, the This member is not meaningful for this control. The default is . - , you must remove it from the control's collection. - + , you must remove it from the control's collection. + ]]> @@ -1755,13 +1755,13 @@ If you set the property, the Occurs when the value of the property changes. - property is not meaningful for this control, although you can change its value and handle the event to detect the change. - - To hide a tab in a , you must remove it from the control's collection. - + property is not meaningful for this control, although you can change its value and handle the event to detect the change. + + To hide a tab in a , you must remove it from the control's collection. + ]]> diff --git a/xml/System.Windows.Forms/TreeView.xml b/xml/System.Windows.Forms/TreeView.xml index 1a6d42ae02b..4e8687154b0 100644 --- a/xml/System.Windows.Forms/TreeView.xml +++ b/xml/System.Windows.Forms/TreeView.xml @@ -2236,11 +2236,6 @@ If you set the property, the property value is anything other than `null`, all the tree nodes display the first stored in the . You can specify which images from the list are displayed for selected and unselected nodes by setting the and properties. Individual objects can specify which image is displayed by setting their and properties. These individual settings will override the settings in the corresponding properties. -> [!NOTE] -> In the .NET Framework version 1.1, there is an issue that prevents images from appearing on nodes when your application calls . To work around this issue, call in your `Main` method immediately after you call . This issue is fixed in the .NET Framework 2.0. - - - ## Examples The following code example creates and assigns an to a control and fills the control with objects. The tree nodes are assigned images from the that are displayed when in a selected or unselected state. This example requires that you have a that contains a , and an that contains `Customer` objects that each contain `Order` objects. diff --git a/xml/System.Workflow.ComponentModel.Compiler/AuthorizedType.xml b/xml/System.Workflow.ComponentModel.Compiler/AuthorizedType.xml index b2b89006a29..aa66814dc6e 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/AuthorizedType.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/AuthorizedType.xml @@ -27,17 +27,17 @@ Represents a set of types that are either allowed or disallowed in compiled workflows by the workflow compiler (depending on the value of the property). This class cannot be inherited. - [!NOTE] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - - During the validation phase of workflow compilation, a workflow source document is rejected if it or the companion rules file directly references any .NET Framework types not present on a list of authorized types. The list of authorized types is an XML document where each entry indicates an `Assembly`, a `Namespace`, a `TypeName`, and an Authorized {`true`|`false`} indicator. This class corresponds to an entry on the list. Also note that wildcard character designations are allowed, to include or exclude complete namespaces. For example, using `Type="System.*"` includes all types in , including types contained in child namespaces. - - The use of a list of authorized types is controlled by the option `'/checktypes'` - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + + During the validation phase of workflow compilation, a workflow source document is rejected if it or the companion rules file directly references any .NET types not present on a list of authorized types. The list of authorized types is an XML document where each entry indicates an `Assembly`, a `Namespace`, a `TypeName`, and an Authorized {`true`|`false`} indicator. This class corresponds to an entry on the list. Also note that wildcard character designations are allowed, to include or exclude complete namespaces. For example, using `Type="System.*"` includes all types in , including types contained in child namespaces. + + The use of a list of authorized types is controlled by the option `'/checktypes'` + ]]> @@ -171,11 +171,11 @@ Gets the associated with this instance. The regular expression associated with this instance. - when wildcard naming is used. This property provides direct access to that . - + when wildcard naming is used. This property provides direct access to that . + ]]> diff --git a/xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml b/xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml index 6473911db60..cfdc571f312 100644 --- a/xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml +++ b/xml/System.Workflow.ComponentModel.Compiler/IWorkflowCompilerOptionsService.xml @@ -20,13 +20,13 @@ Defines the interface implemented by the environment hosting the workflow designer and compiler to provide environment-specific compilation information during the validation and compilation processes. - [!IMPORTANT] -> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] - +> [!INCLUDE[DeprecatedContent](~/includes/deprecatedcontent-md.md)] + ]]> @@ -52,13 +52,13 @@ if types are checked, otherwise . - property is `true` and the workflow or the companion rules file directly references any .NET Framework types not present on a list of authorized types. The list of authorized types is an XML document where each entry indicates an `Assembly`, a `Namespace`, a `TypeName`, and an `Authorized` {`true` or `false`} indicator. This class corresponds to an entry on the list. Also note that wildcard character designations are allowed, to include or exclude complete namespaces. For example, using `Type="System.*"` includes all types in , including types contained in child namespaces. - - The use of a list of authorized types is controlled by the option **/checktypes** or by using the property. - + property is `true` and the workflow or the companion rules file directly references any .NET types not present on a list of authorized types. The list of authorized types is an XML document where each entry indicates an `Assembly`, a `Namespace`, a `TypeName`, and an `Authorized` {`true` or `false`} indicator. This class corresponds to an entry on the list. Also note that wildcard character designations are allowed, to include or exclude complete namespaces. For example, using `Type="System.*"` includes all types in , including types contained in child namespaces. + + The use of a list of authorized types is controlled by the option **/checktypes** or by using the property. + ]]> @@ -83,14 +83,14 @@ Gets the programming language used by the environment, such as Visual Studio, when compiling the workflow. The name of the programming language used by the development environment. - @@ -115,19 +115,19 @@ Gets the root namespace set for the project. The name of the root namespace. - diff --git a/xml/System.Xml.Serialization.Configuration/SchemaImporterExtensionElement.xml b/xml/System.Xml.Serialization.Configuration/SchemaImporterExtensionElement.xml index 0e0b855add8..73918e1dd78 100644 --- a/xml/System.Xml.Serialization.Configuration/SchemaImporterExtensionElement.xml +++ b/xml/System.Xml.Serialization.Configuration/SchemaImporterExtensionElement.xml @@ -17,19 +17,19 @@ Handles the configuration for the class. This class cannot be inherited. - , create an application configuration file and use the following XML elements to specify types used by the class when mapping XSD types to .NET Framework types: - -- [<system.xml.serialization> Element](/dotnet/standard/serialization/system-xml-serialization-element) - -- [<schemaImporterExtensions> Element](/dotnet/standard/serialization/schemaimporterextensions-element) - -- [<add> Element for <xmlSchemaImporterExtensions>](/dotnet/standard/serialization/add-element-for-xmlschemaimporterextensions) - + , create an application configuration file and use the following XML elements to specify types used by the class when mapping XSD types to .NET types: + +- [<system.xml.serialization> Element](/dotnet/standard/serialization/system-xml-serialization-element) + +- [<schemaImporterExtensions> Element](/dotnet/standard/serialization/schemaimporterextensions-element) + +- [<add> Element for <xmlSchemaImporterExtensions>](/dotnet/standard/serialization/add-element-for-xmlschemaimporterextensions) + ]]> @@ -141,11 +141,11 @@ Gets or sets the name of the extension. The name of the extension. - diff --git a/xml/System.Xml.Serialization.Configuration/SchemaImporterExtensionsSection.xml b/xml/System.Xml.Serialization.Configuration/SchemaImporterExtensionsSection.xml index ff58ef9e92e..53eeeb2478f 100644 --- a/xml/System.Xml.Serialization.Configuration/SchemaImporterExtensionsSection.xml +++ b/xml/System.Xml.Serialization.Configuration/SchemaImporterExtensionsSection.xml @@ -17,19 +17,19 @@ Handles the configuration for the class. This class cannot be inherited. - , create an application configuration file and use the following XML elements to specify types used by the class when mapping XSD types to .NET Framework types: - -- [<system.xml.serialization> Element](/dotnet/standard/serialization/system-xml-serialization-element) - -- [<schemaImporterExtensions> Element](/dotnet/standard/serialization/schemaimporterextensions-element) - -- [<add> Element for <xmlSchemaImporterExtensions>](/dotnet/standard/serialization/add-element-for-xmlschemaimporterextensions) - + , create an application configuration file and use the following XML elements to specify types used by the class when mapping XSD types to .NET types: + +- [<system.xml.serialization> Element](/dotnet/standard/serialization/system-xml-serialization-element) + +- [<schemaImporterExtensions> Element](/dotnet/standard/serialization/schemaimporterextensions-element) + +- [<add> Element for <xmlSchemaImporterExtensions>](/dotnet/standard/serialization/add-element-for-xmlschemaimporterextensions) + ]]> diff --git a/xml/System.Xml.Serialization/CodeIdentifier.xml b/xml/System.Xml.Serialization/CodeIdentifier.xml index 2a2fb4bc215..2a7130d879c 100644 --- a/xml/System.Xml.Serialization/CodeIdentifier.xml +++ b/xml/System.Xml.Serialization/CodeIdentifier.xml @@ -50,13 +50,13 @@ Provides static methods to convert input text into names for code entities. - class are used by the XML serialization infrastructure while producing .NET Framework types from XML element and data type definitions. XML element or attribute names typically provide the methods' input text. - - You do not need to call the methods of the class directly from your code. Instead, use the various tools and APIs provided by the .NET Framework for XML serialization, such as the , or the [XML Schema Definition Tool (Xsd.exe)](/dotnet/standard/serialization/xml-schema-definition-tool-xsd-exe) tool. - + class are used by the XML serialization infrastructure while producing .NET types from XML element and data type definitions. XML element or attribute names typically provide the methods' input text. + + You do not need to call the methods of the class directly from your code. Instead, use the various tools and APIs provided by the .NET Framework for XML serialization, such as the , or the [XML Schema Definition Tool (Xsd.exe)](/dotnet/standard/serialization/xml-schema-definition-tool-xsd-exe) tool. + ]]> @@ -155,13 +155,13 @@ Produces a camel-case string from an input string. A camel-case version of the parameter string. - method converts the initial character from an upper-case to lower-case letter, if necessary. - - You do not need to call this method directly. - + method converts the initial character from an upper-case to lower-case letter, if necessary. + + You do not need to call this method directly. + ]]> @@ -210,13 +210,13 @@ Produces a Pascal-case string from an input string. A Pascal-case version of the parameter string. - method converts the initial character from a lower-case to upper-case letter, if necessary. - - You do not need to call this method directly. - + method converts the initial character from a lower-case to upper-case letter, if necessary. + + You do not need to call this method directly. + ]]> @@ -265,13 +265,13 @@ Produces a valid code entity name from an input string. A string that can be used as a code identifier, such as the name of a method parameter. - method removes any characters that cannot appear in a code identifier. It returns the string "Item" if no characters are valid. It prefixes the string "Item" to an input that begins with an invalid start character, for example, a digit, or a currency symbol. - - You do not need to call this method directly. - + method removes any characters that cannot appear in a code identifier. It returns the string "Item" if no characters are valid. It prefixes the string "Item" to an input that begins with an invalid start character, for example, a digit, or a currency symbol. + + You do not need to call this method directly. + ]]> diff --git a/xml/System.Xml.Serialization/IXmlSerializable.xml b/xml/System.Xml.Serialization/IXmlSerializable.xml index d1b6dfcaee3..ea1ab6cb928 100644 --- a/xml/System.Xml.Serialization/IXmlSerializable.xml +++ b/xml/System.Xml.Serialization/IXmlSerializable.xml @@ -146,7 +146,7 @@ If providing schema information is necessary, you should use the attribute. The `GetSchema` method should still return `null` (or `Nothing`). - Some .NET Framework types as well as legacy custom types implementing the `IXmlSerializable` interface may be using `GetSchema` instead of `XmlSchemaProvider`. In this case, the method returns an accurate XML schema that describes the XML representation of the object generated by the method. + Some .NET types as well as legacy custom types implementing the `IXmlSerializable` interface may be using `GetSchema` instead of `XmlSchemaProvider`. In this case, the method returns an accurate XML schema that describes the XML representation of the object generated by the method. ]]> diff --git a/xml/System.Xml.Serialization/SoapCodeExporter.xml b/xml/System.Xml.Serialization/SoapCodeExporter.xml index 8c0eab9eedc..2b608e91000 100644 --- a/xml/System.Xml.Serialization/SoapCodeExporter.xml +++ b/xml/System.Xml.Serialization/SoapCodeExporter.xml @@ -249,7 +249,7 @@ The collection of objects for the generated type, to which the method adds an attribute declaration. - An internal .NET Framework type mapping for a single part of a WSDL message definition. + An internal .NET type mapping for a single part of a WSDL message definition. Add a declaration to a method parameter or return value corresponding to a part element of a SOAP message definition in a WSDL document. The collection of objects for the generated type to which the method adds an attribute declaration. - An internal .NET Framework type mapping for a single part of a WSDL message definition. + An internal .NET type mapping for a single part of a WSDL message definition. to add an initial argument that contains the XML element name for the attribute declaration that is being generated; otherwise, . Adds a declaration to a method parameter or return value that corresponds to a part element of a SOAP message definition in a WSDL document. @@ -322,8 +322,8 @@ - Internal .NET Framework type mappings for the element parts of a WSDL message definition. - Generates a .NET Framework type, plus attribute declarations, for each of the parts that belong to a SOAP message definition in a WSDL document. + Internal .NET type mappings for the element parts of a WSDL message definition. + Generates a .NET type, plus attribute declarations, for each of the parts that belong to a SOAP message definition in a WSDL document. - Internal .NET Framework type mapping information for a SOAP header element. - Generates a .NET Framework type, plus attribute declarations, for a SOAP header. + Internal .NET type mapping information for a SOAP header element. + Generates a .NET type, plus attribute declarations, for a SOAP header. - Populates objects with XML Schema data type definitions for .NET Framework types that are serialized using SOAP encoding. + Populates objects with XML Schema data type definitions for .NET types that are serialized using SOAP encoding. - class provides a programmatic representation of an XML Schema definition language (XSD) document. - - You should not use the class directly. - + class provides a programmatic representation of an XML Schema definition language (XSD) document. + + You should not use the class directly. + ]]> @@ -56,11 +56,11 @@ A collection of objects to which element declarations obtained from type mappings are to be added. Initializes a new instance of the class, which supplies the collection of objects to which XML Schema element declarations are to be added. - class directly. - + class directly. + ]]> @@ -102,14 +102,14 @@ - Internal .NET Framework type mappings for the element parts of a WSDL message definition. + Internal .NET type mappings for the element parts of a WSDL message definition. Adds to the applicable object a data type definition for each of the element parts of a SOAP-encoded message definition. - class directly. - + class directly. + ]]> @@ -137,16 +137,16 @@ - Internal .NET Framework type mappings for the element parts of a WSDL message definition. + Internal .NET type mappings for the element parts of a WSDL message definition. to export a type definition for the parent element of the WSDL parts; otherwise, . Adds to the applicable object a data type definition for each of the element parts of a SOAP-encoded message definition. - class directly. - + class directly. + ]]> @@ -173,14 +173,14 @@ - An internal mapping between a .NET Framework type and an XML Schema element. - Adds to the applicable object a data type definition for a .NET Framework type. + An internal mapping between a .NET type and an XML Schema element. + Adds to the applicable object a data type definition for a .NET type. - class directly. - + class directly. + ]]> diff --git a/xml/System.Xml.Serialization/SoapSchemaImporter.xml b/xml/System.Xml.Serialization/SoapSchemaImporter.xml index c789d0a1d51..a5b5b947ffa 100644 --- a/xml/System.Xml.Serialization/SoapSchemaImporter.xml +++ b/xml/System.Xml.Serialization/SoapSchemaImporter.xml @@ -22,14 +22,14 @@ - Used within the .NET Framework to generate internal mappings to .NET Framework types for SOAP-encoded message parts in a WSDL document. + Used within the .NET Framework to generate internal mappings to .NET types for SOAP-encoded message parts in a WSDL document. class is used by the [Web Services Description Language Tool (Wsdl.exe)](https://msdn.microsoft.com/library/b9210348-8bc2-4367-8c91-d1a04b403e88), and the class, while generating client proxy classes or abstract server classes from a Web Services Description Language (WSDL) document. Instead of using this class directly, use Wsdl.exe. - The class has methods to generate internal mappings to .NET Framework types for part elements defined in a WSDL document. The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. + The class has methods to generate internal mappings to .NET types for part elements defined in a WSDL document. The class is used only when a WSDL document specifies SOAP encoding, as described in Section 5 of the SOAP 1.1 specification. ]]> @@ -136,7 +136,7 @@ A collection of objects. - One of the that specifies various options for generating a .NET Framework type. + One of the that specifies various options for generating a .NET type. An that describes the context in which a set of schema are bound to .NET Framework code entities. Initializes a new instance of the class specifying the schemas, compiler options, and the context of the schemas. To be added. @@ -164,7 +164,7 @@ A collection of objects. A that maintains a group of names for related code entities or type mappings that are generated by the .NET Framework's XML serialization infrastructure. - One of the that specifies various options for generating a .NET Framework type. + One of the that specifies various options for generating a .NET type. Initializes a new instance of the class specifying the schemas, compiler options, and names of related code entities. To be added. @@ -197,7 +197,7 @@ An containing a collection of objects. - One of the that specifies various options for generating a .NET Framework type. + One of the that specifies various options for generating a .NET type. A used to generate the serialization code. An that describes the context in which a set of schema are bound to .NET Framework code entities. Initializes a new instance of the class specifying the schemas, compiler options, and names of related code entities. @@ -228,12 +228,12 @@ - An that specifies the name of an element's type for which a .NET Framework type is being generated. - A base type for the .NET Framework type being generated. + An that specifies the name of an element's type for which a .NET type is being generated. + A base type for the .NET type being generated. to indicate that the type being generated may indirectly inherit from the base type; otherwise, . Generates internal type mapping information for the type of a SOAP-encoded element part defined in a WSDL document where a base type is specified. - The .NET Framework type mapping information for a derived type corresponding to a WSDL message part. + The .NET type mapping information for a derived type corresponding to a WSDL message part. The message namespace. A object that provides information about the part element. Generates internal type mapping information for a single SOAP-encoded element part defined in a WSDL document. - The .NET Framework type mapping for a single element part of a WSDL message definition. + The .NET type mapping for a single element part of a WSDL message definition. The message namespace. An array of type that provides information about the part elements. Generates internal type mapping information for the element parts of a SOAP-encoded message defined in a WSDL document. - The .NET Framework type mappings for the element parts of a WSDL message definition. + The .NET type mappings for the element parts of a WSDL message definition. to have elements defined by the parts enclosed in an extra, wrapper element in a SOAP message; otherwise, . Generates internal type mapping information for the element parts of a SOAP-encoded message defined in a WSDL document. - The .NET Framework type mappings for the element parts of a WSDL message definition. + The .NET type mappings for the element parts of a WSDL message definition. An array of type that provides information about the part elements. to have elements defined by the parts enclosed in an extra, wrapper element in a SOAP message; otherwise, . - A base type for all .NET Framework types that are generated to correspond to message parts. + A base type for all .NET types that are generated to correspond to message parts. to indicate that types corresponding to message parts can indirectly inherit from the base type; otherwise, . Generates internal type mapping information for the element parts of a SOAP-encoded message defined in a WSDL document. - The .NET Framework type mappings for the element parts of a WSDL message definition. + The .NET type mappings for the element parts of a WSDL message definition. class generates .NET Framework types or attribute declarations from internal mappings to .NET Framework types. These internal mappings are generated by the class for elements defined in an XSD document or as parts in a Web Services Description Language (WSDL) document. is not used directly; it is used with the Web Services Description Language tool (Wsdl.exe) or the XML Schema Definition tool (Xsd.exe). + The class generates .NET types or attribute declarations from internal mappings to .NET types. These internal mappings are generated by the class for elements defined in an XSD document or as parts in a Web Services Description Language (WSDL) document. is not used directly; it is used with the Web Services Description Language tool (Wsdl.exe) or the XML Schema Definition tool (Xsd.exe). Wsdl.exe uses the types or attribute declarations that are generated by and the internal mappings generated by the class to generate client proxy classes or abstract server classes from a WSDL document. Wsdl.exe uses and the class when a WSDL document specifies: @@ -140,7 +140,7 @@ The namespace of the types to generate. A program graph container to which used assembly references are automatically added. - An enumeration value that provides options for generating .NET Framework types from XML schema custom data types. + An enumeration value that provides options for generating .NET types from XML schema custom data types. Initializes a new instance of the class using the specified namespace, code compile unit, and code generation options. The namespace of the types to generate. A program graph container to which used assembly references are automatically added. - An enumeration value that provides options for generating .NET Framework types from XML schema custom data types. + An enumeration value that provides options for generating .NET types from XML schema custom data types. A that contains objects. Initializes a new instance of the class using the specified .NET Framework namespace, code compile unit containing the graph of the objects, an object representing code generation options, and a collection of mapping objects. To be added. @@ -211,7 +211,7 @@ The namespace of the types to generate. A program graph container to which used assembly references are automatically added. - An enumeration value that provides options for generating .NET Framework types from XML schema custom data types. + An enumeration value that provides options for generating .NET types from XML schema custom data types. A that contains special instructions for code creation. A that contains objects. Initializes a new instance of the class using the specified .NET Framework namespace, code compile unit containing the graph of the objects, an enumeration specifying code options, and a collection of mapping objects. @@ -252,7 +252,7 @@ The collection of objects for the generated type to which the method adds an attribute declaration. - An internal .NET Framework type mapping for a single element part of a WSDL message definition. + An internal .NET type mapping for a single element part of a WSDL message definition. The XML namespace of the SOAP message part for which the type mapping information in the member parameter has been generated. Adds an declaration to a method parameter or return value that corresponds to a element of a SOAP message definition in a Web Services Description Language (WSDL) document. @@ -290,7 +290,7 @@ The collection of objects for the generated type to which the method adds an attribute declaration. - The internal .NET Framework type mapping information for an XML schema element. + The internal .NET type mapping information for an XML schema element. The XML namespace of the SOAP message part for which the type mapping information in the member parameter has been generated. Adds an declaration to a method return value that corresponds to a element of a non-SOAP message definition in a Web Services Description Language (WSDL) document. @@ -329,7 +329,7 @@ The collection of objects for the generated type to which the method adds an attribute declaration. - An internal .NET Framework type mapping for a single element part of a WSDL message definition. + An internal .NET type mapping for a single element part of a WSDL message definition. The XML namespace of the SOAP message part for which the type mapping information in the member parameter has been generated. Flag that helps determine whether to add an initial argument containing the XML element name for the attribute declaration being generated. Adds an declaration to a method parameter or return value that corresponds to a element of a SOAP message definition in a Web Services Description Language (WSDL) document. @@ -365,8 +365,8 @@ - The internal .NET Framework type mappings for the element parts of a WSDL message definition. - Generates a .NET Framework type, plus attribute declarations, for each of the parts that belong to a SOAP message definition in a Web Services Description Language (WSDL) document. + The internal .NET type mappings for the element parts of a WSDL message definition. + Generates a .NET type, plus attribute declarations, for each of the parts that belong to a SOAP message definition in a Web Services Description Language (WSDL) document. - The internal .NET Framework type mapping information for an XML schema element. - Generates a .NET Framework type, plus attribute declarations, for an XML schema element. + The internal .NET type mapping information for an XML schema element. + Generates a .NET type, plus attribute declarations, for an XML schema element. class for the conditio System.String - Gets the XML namespace of the XML schema element that represents a SOAP message for which .NET Framework type mapping information is being provided. + Gets the XML namespace of the XML schema element that represents a SOAP message for which .NET type mapping information is being provided. The XML namespace of the schema element. 4.0.0.0 - Generates a mapping to an XML Schema element for a specified .NET Framework type. + Generates a mapping to an XML Schema element for a specified .NET type. @@ -1071,7 +1071,7 @@ - The .NET Framework type for which to save type mapping information. + The .NET type for which to save type mapping information. Includes mappings for a type for later use when import methods are invoked. - The internal .NET Framework type mappings for the element parts of a Web Services Description Language (WSDL) message definition. + The internal .NET type mappings for the element parts of a Web Services Description Language (WSDL) message definition. Adds an element declaration to the applicable for each of the element parts of a literal SOAP message definition. - The internal mapping between a .NET Framework type and an XML schema element. + The internal mapping between a .NET type and an XML schema element. if the schema elements that enclose the schema are to be included; otherwise, . Adds an element declaration to the applicable for each of the element parts of a literal SOAP message definition, and specifies whether enclosing elements are included. @@ -420,7 +420,7 @@ - Internal .NET Framework type mappings for the element parts of a Web Services Description Language (WSDL) message definition. + Internal .NET type mappings for the element parts of a Web Services Description Language (WSDL) message definition. Adds an element declaration to the applicable object for a single element part of a literal SOAP message definition. An that represents the qualified XML name of the exported element declaration. diff --git a/xml/System.Xml.Serialization/XmlSchemaImporter.xml b/xml/System.Xml.Serialization/XmlSchemaImporter.xml index b1e288e2c2d..c6488d21fcc 100644 --- a/xml/System.Xml.Serialization/XmlSchemaImporter.xml +++ b/xml/System.Xml.Serialization/XmlSchemaImporter.xml @@ -277,7 +277,7 @@ A collection of objects. A object that specifies a collection of classes being generated for bindings defined in a WSDL document. - A bitwise combination of the values that specifies the options to use when generating .NET Framework types for a Web service. + A bitwise combination of the values that specifies the options to use when generating .NET types for a Web service. Initializes a new instance of the class, taking a collection of objects that represents the XML schemas used by SOAP literal messages, plus classes being generated for bindings defined in a WSDL document, and a enumeration value. A collection of objects. - A bitwise combination of the values that specifies the options to use when generating .NET Framework types for a Web service. + A bitwise combination of the values that specifies the options to use when generating .NET types for a Web service. A used to generate the serialization code. A instance that specifies the import context. Initializes a new instance of the class. @@ -390,10 +390,10 @@ - An that specifies the name of an element's type for which a .NET Framework type is generated. + An that specifies the name of an element's type for which a .NET type is generated. The name of the part element in the WSDL document. Generates internal type mapping information for a single, (SOAP) literal element part defined in a WSDL document. - An representing the .NET Framework type mapping for a single element part of a WSDL message definition. + An representing the .NET type mapping for a single element part of a WSDL message definition. An that specifies the name of an element defined in an XML schema document. - A base type for the .NET Framework type that is generated to correspond to an XSD element's type. + A base type for the .NET type that is generated to correspond to an XSD element's type. Generates internal type mapping information for an element defined in an XML schema document. - An representing the.NET Framework type mapping information for an XML schema element. + An representing the.NET type mapping information for an XML schema element. An that specifies the name of an element defined in an XML schema document. - A base type for the .NET Framework type that is generated to correspond to an XSD element's type. + A base type for the .NET type that is generated to correspond to an XSD element's type. to indicate that the type corresponding to an XSD element can indirectly inherit from the base type; otherwise, . Generates internal type mapping information for an element defined in an XML schema document or as a part in a WSDL document. - The .NET Framework type mapping information for an XML schema element. + The .NET type mapping information for an XML schema element. An that specifies the name of the message part. Generates internal type mapping information for a single element part of a literal-use SOAP message defined in a WSDL document. - The .NET Framework type mapping for a WSDL message definition containing a single element part. + The .NET type mapping for a WSDL message definition containing a single element part. An array of type that specifies the names of the message parts. Generates internal type mapping information for the element parts of a literal-use SOAP message defined in a WSDL document. - An that represents the .NET Framework type mappings for the element parts of a WSDL message definition. + An that represents the .NET type mappings for the element parts of a WSDL message definition. An array of type that specifies the names of the message parts. - A base type for all .NET Framework types that are generated to correspond to message parts. + A base type for all .NET types that are generated to correspond to message parts. to indicate that the types corresponding to message parts can indirectly inherit from the base type; otherwise, . Generates internal type mapping information for the element parts of a literal-use SOAP message defined in a WSDL document. - The .NET Framework type mappings for the element parts of a WSDL message definition. + The .NET type mappings for the element parts of a WSDL message definition. An that specifies the name of an element defined in an XML schema document. Generates internal type mapping information for an element defined in an XML schema document. - The .NET Framework type mapping information for an XML schema element. + The .NET type mapping information for an XML schema element. Delegate used by the class for deserialization of types from SOAP-encoded, non-root XML data. The object returned by the callback. - class. During this process, the .NET Framework generates read methods that implement the delegate. It does so for certain mappings between .NET Framework types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Then, as necessary, a read method is called during deserialization. - - Do not directly create instances of the class. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + class. During this process, the .NET Framework generates read methods that implement the delegate. It does so for certain mappings between .NET types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Then, as necessary, a read method is called during deserialization. + + Do not directly create instances of the class. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> diff --git a/xml/System.Xml.Serialization/XmlSerializationReader.xml b/xml/System.Xml.Serialization/XmlSerializationReader.xml index f4d03aa43a9..34d7be0029b 100644 --- a/xml/System.Xml.Serialization/XmlSerializationReader.xml +++ b/xml/System.Xml.Serialization/XmlSerializationReader.xml @@ -57,13 +57,13 @@ Controls deserialization by the class. - class. is also implemented within the .NET Framework for deserialization of XML documents into and objects. - - You should not derive classes from . Instead, call one of the methods. - + class. is also implemented within the .NET Framework for deserialization of XML documents into and objects. + + You should not derive classes from . Instead, call one of the methods. + ]]> @@ -118,11 +118,11 @@ Stores an object that contains a callback method to subsequently be called, as necessary, to fill in .NET Framework collections or enumerations that map to SOAP-encoded arrays or SOAP-encoded, multi-referenced elements. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -170,15 +170,15 @@ A delegate and the callback method's input data. Stores an object that contains a callback method that will be called, as necessary, to fill in .NET collections or enumerations that map to SOAP-encoded arrays or SOAP-encoded, multi-referenced elements. - are intended for use only by derived classes that are used internally within the .NET XML serialization infrastructure. - - During initialization, the .NET XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that is derived from . During this process, the infrastructure generates methods and it creates objects to store the fix-up methods and their input data. The infrastructure does so for SOAP-encoded arrays or SOAP-encoded, multi-referenced elements whose data types, in either case, map to .NET collections or enumerations. Next, as necessary, the methods are invoked during deserialization to fill in array items or multi-referenced objects. - - You should not directly create an instance of the or class. - + are intended for use only by derived classes that are used internally within the .NET XML serialization infrastructure. + + During initialization, the .NET XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that is derived from . During this process, the infrastructure generates methods and it creates objects to store the fix-up methods and their input data. The infrastructure does so for SOAP-encoded arrays or SOAP-encoded, multi-referenced elements whose data types, in either case, map to .NET collections or enumerations. Next, as necessary, the methods are invoked during deserialization to fill in array items or multi-referenced objects. + + You should not directly create an instance of the or class. + ]]> @@ -227,17 +227,17 @@ An delegate and the callback method's input data. Stores an object that contains a callback method instance that will be called, as necessary, to fill in the objects in a SOAP-encoded array. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - While deserializing XML documents into .NET Framework objects, the .NET Framework XML serialization infrastructure dynamically creates instances of fix-up methods that implement the delegate and creates instances of the class to store the fix-up methods and their input data. The infrastructure does so for SOAP-encoded arrays whose data types map to .NET Framework reference types. Next, as necessary, a fix-up method is called to fill in the objects in the array. - - In addition, during initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that derives from . During this process, the infrastructure generates methods and objects for SOAP-encoded, multi-referenced XML data. The methods are then invoked during deserialization. - - You should not directly create instances of the or classes. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + While deserializing XML documents into .NET Framework objects, the .NET Framework XML serialization infrastructure dynamically creates instances of fix-up methods that implement the delegate and creates instances of the class to store the fix-up methods and their input data. The infrastructure does so for SOAP-encoded arrays whose data types map to .NET Framework reference types. Next, as necessary, a fix-up method is called to fill in the objects in the array. + + In addition, during initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that derives from . During this process, the infrastructure generates methods and objects for SOAP-encoded, multi-referenced XML data. The methods are then invoked during deserialization. + + You should not directly create instances of the or classes. + ]]> @@ -285,21 +285,21 @@ - The name of the .NET Framework type that is being deserialized. - The namespace of the .NET Framework type that is being deserialized. + The name of the .NET type that is being deserialized. + The namespace of the .NET type that is being deserialized. The to be deserialized. An delegate. Stores an implementation of the delegate and its input data for a later invocation. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that derives from . During this process, the .NET Framework generates read methods that implement the delegate. It does so for certain mappings between .NET Framework types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Next, as necessary, a read method is called during deserialization. - - You should not directly create an instance of the class. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that derives from . During this process, the .NET Framework generates read methods that implement the delegate. It does so for certain mappings between .NET types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Next, as necessary, a read method is called during deserialization. + + You should not directly create an instance of the class. + ]]> @@ -350,15 +350,15 @@ The object that is deserialized from the XML element. Stores an object that is being deserialized from a SOAP-encoded element for later access through the method. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times by `ref` attributes (or `href` attributes in SOAP 1.1) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times by `ref` attributes (or `href` attributes in SOAP 1.1) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -407,13 +407,13 @@ The current . Checks whether the deserializer has advanced. - method is used when the `checkDeserializerAdvances` attribute of the `` configuration element is set to `true`. For more information, see [<xmlSerializer> Element](/dotnet/standard/serialization/xmlserializer-element). - + method is used when the `checkDeserializerAdvances` attribute of the `` configuration element is set to `true`. For more information, see [<xmlSerializer> Element](/dotnet/standard/serialization/xmlserializer-element). + ]]> The has not advanced. @@ -469,11 +469,11 @@ Removes all occurrences of white space characters from the beginning and end of the specified string. The trimmed string. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -532,11 +532,11 @@ Creates an that indicates that an object being deserialized should be abstract. An exception. - are intended only for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended only for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -596,16 +596,16 @@ The namespace of the derived XML Schema data type. The local name of the base XML Schema data type. The namespace of the base XML Schema data type. - The namespace of the derived .NET Framework type. - The name of the base .NET Framework type. + The namespace of the derived .NET type. + The name of the base .NET type. Populates an object from its XML representation at the current location of the , with an option to read the inner element. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -654,11 +654,11 @@ Creates an that indicates that an object being deserialized cannot be instantiated because the constructor throws a security exception. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -707,11 +707,11 @@ Creates an that indicates that an object being deserialized cannot be instantiated because there is no constructor available. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -726,11 +726,11 @@ Creates an that indicates that an explicit reference conversion failed. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -794,11 +794,11 @@ Creates an that indicates that an explicit reference conversion failed. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -865,11 +865,11 @@ Creates an that indicates that an explicit reference conversion failed. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -928,11 +928,11 @@ Creates an that indicates that a derived type that is mapped to an XML Schema data type cannot be located. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -977,15 +977,15 @@ - The fully qualified name of the .NET Framework type for which there is a mapping. + The fully qualified name of the .NET type for which there is a mapping. Creates an that indicates that a SOAP-encoded collection type cannot be modified and its values cannot be filled in. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1044,11 +1044,11 @@ Creates an that indicates that an enumeration value is not valid. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1094,11 +1094,11 @@ Creates an that indicates that the current position of represents an unknown XML node. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1147,11 +1147,11 @@ Creates an that indicates that a type is unknown. An exception. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1206,11 +1206,11 @@ if XML strings are decoded into valid .NET type names; otherwise, . - method writes valid XML from invalid sources. For example, the property of the class can contain spaces, which are invalid as XML. The reads the encoded XML and restores it to the original value. However, the method of the class cannot read such encoded XML. In that case, set the property to `false` to disable the encoding of the XML. - + method writes valid XML from invalid sources. For example, the property of the class can contain spaces, which are invalid as XML. The reads the encoded XML and restores it to the original value. However, the method of the class cannot read such encoded XML. In that case, set the property to `false` to disable the encoding of the XML. + ]]> @@ -1255,11 +1255,11 @@ Gets the XML document object into which the XML document is being deserialized. An that represents the deserialized data. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1326,11 +1326,11 @@ Ensures that a given array, or a copy, is large enough to contain a specified index. The existing , if it is already large enough; otherwise, a new, larger array that contains the original array's elements. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1378,17 +1378,17 @@ An object that contains the array whose values are filled in. Fills in the values of a SOAP-encoded array whose data type maps to a .NET reference type. - are intended for use only by derived classes that are used internally within the .NET XML serialization infrastructure. - - The method implements the delegate for deserialization of SOAP-encoded XML data. - - While deserializing XML documents into .NET objects, the .NET XML serialization infrastructure dynamically creates an instance of the method for SOAP-encoded arrays whose data types map to .NET reference types. The method then is called by to fill in the objects in the array. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET XML serialization infrastructure. + + The method implements the delegate for deserialization of SOAP-encoded XML data. + + While deserializing XML documents into .NET objects, the .NET XML serialization infrastructure dynamically creates an instance of the method for SOAP-encoded arrays whose data types map to .NET reference types. The method then is called by to fill in the objects in the array. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -1439,13 +1439,13 @@ Gets the length of the SOAP-encoded array where the is currently positioned. The length of the SOAP array. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method applies to the `arrayType` attribute that is used with SOAP encoding and specified with the namespace "". - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method applies to the `arrayType` attribute that is used with SOAP encoding and specified with the namespace "". + ]]> @@ -1492,11 +1492,11 @@ if is currently positioned over a null attribute with the value ; otherwise, . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1545,13 +1545,13 @@ Gets an object that is being deserialized from a SOAP-encoded element and that was stored earlier by . An object to be deserialized from a SOAP-encoded element. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -1598,13 +1598,13 @@ Gets the value of the attribute for the XML element at the current location of the . An XML qualified name that indicates the data type of an XML element. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The `type` attribute from the instance of the XML Schema namespace explicitly specifies the data type of an XML element. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The `type` attribute from the instance of the XML Schema namespace explicitly specifies the data type of an XML element. + ]]> @@ -1659,19 +1659,19 @@ Initializes callback methods that populate objects that map to SOAP-encoded XML data. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that is derived from . During this process, the .NET Framework generates read methods that implement the delegate. It does so for certain mappings between .NET Framework types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Next, as necessary, a read method is called during deserialization. - - The abstract method is where the temporary derived class creates an instance of and initializes read callback methods. - - You should not directly create an instance of . - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for deserialization that is derived from . During this process, the .NET Framework generates read methods that implement the delegate. It does so for certain mappings between .NET types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Next, as necessary, a read method is called during deserialization. + + The abstract method is where the temporary derived class creates an instance of and initializes read callback methods. + + You should not directly create an instance of . + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -1716,13 +1716,13 @@ Stores element and attribute names in a object. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is abstract. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is abstract. + ]]> @@ -1774,11 +1774,11 @@ , if the value is a return value. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1828,13 +1828,13 @@ if the XML attribute name indicates an XML namespace; otherwise, . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - An attribute name indicates an XML namespace if it takes the form `xmlns:key`, where "key" is the namespace name. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + An attribute name indicates an XML namespace if it takes the form `xmlns:key`, where "key" is the namespace name. + ]]> @@ -1882,13 +1882,13 @@ An that may have the type . Sets the value of the XML attribute if it is of type from the Web Services Description Language (WSDL) namespace. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - WSDL uses the namespace "". - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + WSDL uses the namespace "". + ]]> @@ -1934,11 +1934,11 @@ Makes the read the fully qualified name of the element where it is currently positioned. The fully qualified name of the current XML element. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -1983,11 +1983,11 @@ Makes the read an XML end tag. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -2038,11 +2038,11 @@ Gets the object that is being used by . The that is being used by the . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -2086,13 +2086,13 @@ Gets the current count of the . The current count of an . - uses an instance of the class to count when a read operation occurs. The count is incremented each time the reader calls an appropriate method, for example the method or the method. - + uses an instance of the class to count when a read operation occurs. The count is incremented each time the reader calls an appropriate method, for example the method or the method. + ]]> @@ -2139,11 +2139,11 @@ if the element has a null="true" attribute value and has been read; otherwise, . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -2190,11 +2190,11 @@ Instructs the to read the fully qualified name of the element where it is currently positioned. A that represents the fully qualified name of the current XML element; otherwise, if a null="true" attribute value is present. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -2241,11 +2241,11 @@ Instructs the to read a simple, text-only XML element that could be . The string value; otherwise, . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -2303,17 +2303,17 @@ if the value was read; otherwise, . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The opening `#` symbol is stripped from the `href` attribute value. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The opening `#` symbol is stripped from the `href` attribute value. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -2328,11 +2328,11 @@ Deserializes an object from a SOAP-encoded element. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -2392,17 +2392,17 @@ Deserializes an object from a SOAP-encoded XML element. The value of the referenced element in the document. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method obtains the XML Schema data type by reading the `xsi:type` attribute of the `multiRef` element. The prefix `xsi` refers to the instance of the XML Schema namespace. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method obtains the XML Schema data type by reading the `xsi:type` attribute of the `multiRef` element. The prefix `xsi` refers to the instance of the XML Schema namespace. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -2464,17 +2464,17 @@ Deserializes an object from a SOAP-encoded XML element. The value of the referenced element in the document. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - This signature of the method obtains the XML Schema data type of the `multiRef` element from the method parameters rather than by reading the `xsi:type` attribute. The prefix `xsi` refers to the instance of the XML Schema namespace. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + This signature of the method obtains the XML Schema data type of the `multiRef` element from the method parameters rather than by reading the `xsi:type` attribute. The prefix `xsi` refers to the instance of the XML Schema namespace. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -2529,15 +2529,15 @@ Deserializes objects from the SOAP-encoded elements in a SOAP message. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -2552,11 +2552,11 @@ Deserializes an object from an XML element in a SOAP message that contains a reference to a element. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -2619,15 +2619,15 @@ Deserializes an object from an XML element in a SOAP message that contains a reference to a element. The deserialized object. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -2695,15 +2695,15 @@ Deserializes an object from an XML element in a SOAP message that contains a reference to a element. The deserialized object. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -2770,15 +2770,15 @@ Deserializes an object from an XML element in a SOAP message that contains a reference to a element. The deserialized object. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -2843,11 +2843,11 @@ Populates an object from its XML representation at the current location of the . An object that implements the interface with its members populated from the location of the . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -2966,11 +2966,11 @@ Produces the result of a call to the method appended to the input value. The result of call to the method appended to the input value. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -3139,11 +3139,11 @@ Gets the value of the XML node at which the is currently positioned. The value of the node as a .NET Framework value type, if the value is a simple XML Schema data type. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -3194,11 +3194,11 @@ Instructs the to read an XML document root element at its current position. An that contains the root element that has been read. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -3249,11 +3249,11 @@ Instructs the to read the XML node at its current position. An that represents the XML node that has been read. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -3302,15 +3302,15 @@ The object to be deserialized. Stores an object to be deserialized from a SOAP-encoded element. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + SOAP encoding allows a unique XML element to appear once within a SOAP message as a `multiRef` element identified by an `id` attribute. The `id` value can be referenced multiple times using `href` attributes (or `ref` attributes in SOAP 1.2) in substitute elements. + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> @@ -3365,13 +3365,13 @@ Gets a dynamically generated assembly by name. A dynamically generated . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + ]]> @@ -3441,11 +3441,11 @@ Ensures that a given array, or a copy, is no larger than a specified length. The existing , if it is already small enough; otherwise, a new, smaller array that contains the original array's elements up to the size of . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -3460,11 +3460,11 @@ Reads the current value and returns it as a base-64 byte array. - are intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -3514,11 +3514,11 @@ Instructs the to read the string value at its current position and return it as a base-64 byte array. A base-64 byte array; otherwise, if the value of the parameter is . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -3574,13 +3574,13 @@ Produces a base-64 byte array from an input string. A base-64 byte array. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + ]]> @@ -3641,11 +3641,11 @@ Instructs the to read the string value at its current position and return it as a hexadecimal byte array. A hexadecimal byte array; otherwise, if the value of the parameter is . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + ]]> @@ -3701,13 +3701,13 @@ Produces a hexadecimal byte array from an input string. A hexadecimal byte array. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + ]]> @@ -3756,13 +3756,13 @@ Produces a object from an input string. A object. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + ]]> @@ -3811,13 +3811,13 @@ Produces a object from an input string. A object. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + ]]> @@ -3866,13 +3866,13 @@ Produces a object from an input string. A object. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + ]]> @@ -3925,13 +3925,13 @@ Produces a numeric enumeration value from a string that consists of delimited identifiers that represent constants from the enumerator list. A long value that consists of the enumeration value as a series of bitwise operations. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + ]]> @@ -3980,13 +3980,13 @@ Produces a from a string that represents the time. A object. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + ]]> @@ -4042,15 +4042,15 @@ Decodes an XML name. A decoded string. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - - converts 4-digit hexadecimal UCS-2 codes into Unicode. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + + converts 4-digit hexadecimal UCS-2 codes into Unicode. + ]]> @@ -4106,15 +4106,15 @@ Decodes an XML name. A decoded string. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - - converts 4-digit hexadecimal UCS-2 codes into Unicode. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + + converts 4-digit hexadecimal UCS-2 codes into Unicode. + ]]> @@ -4170,15 +4170,15 @@ Decodes an XML name. A decoded string. - are only intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - - converts 4-digit hexadecimal UCS-2 codes into Unicode. - + are only intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + + converts 4-digit hexadecimal UCS-2 codes into Unicode. + ]]> @@ -4234,15 +4234,15 @@ Decodes an XML name. A decoded string. - are intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - The method is static. - - converts 4-digit hexadecimal UCS-2 codes into Unicode. - + are intended for use by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + The method is static. + + converts 4-digit hexadecimal UCS-2 codes into Unicode. + ]]> @@ -4299,13 +4299,13 @@ Obtains an from a name that may contain a prefix. An that represents a namespace-qualified XML name. - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - If a prefix is present, the method looks up the associated namespace for the current XML document and places the value in the object. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + If a prefix is present, the method looks up the associated namespace for the current XML document and places the value in the object. + ]]> @@ -4379,13 +4379,13 @@ An that represents the attribute in question. Raises an event for the current position of the . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - Add a handler method to the method to handle unknown attributes while the is executing its method. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + Add a handler method to the method to handle unknown attributes while the is executing its method. + ]]> @@ -4728,15 +4728,15 @@ An object that the is attempting to deserialize, subsequently accessible through the property. Raises an event for the current position of the . - are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - - SOAP encoding, as specified in Section 5 of the SOAP 1.1 specification, allows for elements referenced multiple times in a SOAP message (or optionally, just once) to be referred by an `href` attribute in the main message. An event occurs when such an element appears, but there is no `href` reference to it. - - Add a handler method to to provide custom handling for unreferenced objects while the executes its method. - + are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. + + SOAP encoding, as specified in Section 5 of the SOAP 1.1 specification, allows for elements referenced multiple times in a SOAP message (or optionally, just once) to be referred by an `href` attribute in the main message. An event occurs when such an element appears, but there is no `href` reference to it. + + Add a handler method to to provide custom handling for unreferenced objects while the executes its method. + ]]> diff --git a/xml/System.Xml.Serialization/XmlSerializationWriteCallback.xml b/xml/System.Xml.Serialization/XmlSerializationWriteCallback.xml index 3878ac62303..807dd437bba 100644 --- a/xml/System.Xml.Serialization/XmlSerializationWriteCallback.xml +++ b/xml/System.Xml.Serialization/XmlSerializationWriteCallback.xml @@ -50,15 +50,15 @@ The object being serialized. Delegate that is used by the class for serialization of types from SOAP-encoded, non-root XML data. - class. During this process, the .NET Framework generates write methods that implement the class delegate. It does so for certain mappings between .NET Framework types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Then, as necessary, a write method is called during serialization. - - You should not directly instantiate . - - SOAP encoding is described in Section 5 of the SOAP 1.1 specification. - + class. During this process, the .NET Framework generates write methods that implement the class delegate. It does so for certain mappings between .NET types and XML data types that are serialized through SOAP-encoded XML and are not root elements. Then, as necessary, a write method is called during serialization. + + You should not directly instantiate . + + SOAP encoding is described in Section 5 of the SOAP 1.1 specification. + ]]> diff --git a/xml/System.Xml.Serialization/XmlSerializationWriter.xml b/xml/System.Xml.Serialization/XmlSerializationWriter.xml index 778cfdb6a00..e754f3fa38b 100644 --- a/xml/System.Xml.Serialization/XmlSerializationWriter.xml +++ b/xml/System.Xml.Serialization/XmlSerializationWriter.xml @@ -169,7 +169,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for serialization that is derived from . During this process, the .NET Framework generates write methods that implement the delegate. It does so for certain mappings between .NET Framework types and XML data types that are serialized via SOAP-encoded XML and are not root elements. Then, as necessary, a write method is called during serialization. + During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for serialization that is derived from . During this process, the .NET Framework generates write methods that implement the delegate. It does so for certain mappings between .NET types and XML data types that are serialized via SOAP-encoded XML and are not root elements. Then, as necessary, a write method is called during serialization. You should not directly create an instance of . @@ -1629,7 +1629,7 @@ ## Remarks The protected members of are intended for use only by derived classes that are used internally within the .NET Framework XML serialization infrastructure. - During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for serialization that is derived from . During this process, the .NET Framework generates write methods that implement the delegate. It does so for certain mappings between .NET Framework types and XML data types that are serialized using SOAP-encoded XML and are not root elements. Then, as necessary, a write method is called during serialization. + During initialization, the .NET Framework XML serialization infrastructure dynamically generates and compiles a temporary class for serialization that is derived from . During this process, the .NET Framework generates write methods that implement the delegate. It does so for certain mappings between .NET types and XML data types that are serialized using SOAP-encoded XML and are not root elements. Then, as necessary, a write method is called during serialization. The abstract method is where the temporary derived class creates an instance of and initializes write callback methods. diff --git a/xml/System.Xml.XPath/XPathItem.xml b/xml/System.Xml.XPath/XPathItem.xml index e342d083bf4..c1f95a6e497 100644 --- a/xml/System.Xml.XPath/XPathItem.xml +++ b/xml/System.Xml.XPath/XPathItem.xml @@ -62,34 +62,34 @@ Represents an item in the XQuery 1.0 and XPath 2.0 Data Model. - - When you inherit from the class, you must override the following members: : - -- - -- - -- - -- - -- - -- - -- - -- - -- - + When you inherit from the class, you must override the following members: : + +- + +- + +- + +- + +- + +- + +- + +- + +- + - @@ -137,11 +137,11 @@ Initializes a new instance of the class. - @@ -230,16 +230,16 @@ System.Object - When overridden in a derived class, gets the current item as a boxed object of the most appropriate .NET Framework 2.0 type according to its schema type. - The current item as a boxed object of the most appropriate .NET Framework type. + When overridden in a derived class, gets the current item as a boxed object of the most appropriate .NET type according to its schema type. + The current item as a boxed object of the most appropriate .NET type. - property is equivalent to the value of the property. - - For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). - + property is equivalent to the value of the property. + + For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). + ]]> @@ -351,11 +351,11 @@ Returns the item's value as the specified type. The value of the item as the type requested. - method attempts to convert the value of the item to the .NET Framework 2.0 type specified. - + method attempts to convert the value of the item to the specified .NET type. + ]]> The item's value is not in the correct format for the target type. @@ -420,15 +420,15 @@ When overridden in a derived class, returns the item's value as the type specified using the object specified to resolve namespace prefixes. The value of the item as the type requested. - method attempts to convert the value of the item to the .NET Framework 2.0 type specified. - - The object is used to resolve namespace prefixes related to type conversions. For example, when converting an `xs:QName` to an `xs:string`. - - For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). - + method attempts to convert the value of the item to the specified .NET type. + + The object is used to resolve namespace prefixes related to type conversions. For example, when converting an `xs:QName` to an `xs:string`. + + For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). + ]]> The item's value is not in the correct format for the target type. @@ -480,13 +480,13 @@ When overridden in a derived class, gets the item's value as a . The item's value as a . - property attempts to convert the value of the item to the .NET Framework 2.0 type according to the XPath 2.0 rules for casting the item's type. - - For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). - + property attempts to convert the value of the item to the .NET type according to the XPath 2.0 rules for casting the item's type. + + For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). + ]]> The item's value is not in the correct format for the type. @@ -536,13 +536,13 @@ When overridden in a derived class, gets the item's value as a . The item's value as a . - property attempts to convert the value of the item to the .NET Framework 2.0 type according to the XPath 2.0 rules for casting the item's type. - - For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). - + property attempts to convert the value of the item to the .NET type according to the XPath 2.0 rules for casting the item's type. + + For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). + ]]> The item's value is not in the correct format for the type. @@ -592,13 +592,13 @@ When overridden in a derived class, gets the item's value as a . The item's value as a . - property attempts to convert the value of the item to the .NET Framework 2.0 type according to the XPath 2.0 rules for casting the item's type. - - For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). - + property attempts to convert the value of the item to the .NET type according to the XPath 2.0 rules for casting the item's type. + + For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). + ]]> The item's value is not in the correct format for the type. @@ -649,13 +649,13 @@ When overridden in a derived class, gets the item's value as an . The item's value as an . - property attempts to convert the value of the item to the .NET Framework 2.0 type according to the XPath 2.0 rules for casting the item's type. - - For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). - + property attempts to convert the value of the item to the .NET type according to the XPath 2.0 rules for casting the item's type. + + For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). + ]]> The item's value is not in the correct format for the type. @@ -706,13 +706,13 @@ When overridden in a derived class, gets the item's value as an . The item's value as an . - property attempts to convert the value of the item to the .NET Framework 2.0 type according to the XPath 2.0 rules for casting the item's type. - - For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). - + property attempts to convert the value of the item to the .NET type according to the XPath 2.0 rules for casting the item's type. + + For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). + ]]> The item's value is not in the correct format for the type. @@ -760,18 +760,18 @@ System.Type - When overridden in a derived class, gets the .NET Framework 2.0 type of the item. - The .NET Framework type of the item. The default value is . + When overridden in a derived class, gets the .NET type of the item. + The .NET type of the item. The default value is . - property gets the .NET Framework type of the typed value of the item. - - For example, an element of type `xs:int` would have a of by default. However, the could be any one of the valid types that can be mapped to `xs:int`, such as or . - - For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). - + property gets the .NET type of the typed value of the item. + + For example, an element of type `xs:int` would have a of by default. However, the could be any one of the valid types that can be mapped to `xs:int`, such as or . + + For more information about type support in the namespace, see [Type Support in the System.Xml Classes](/dotnet/standard/data/xml/type-support-in-the-system-xml-classes). + ]]> @@ -829,11 +829,11 @@ When overridden in a derived class, gets the for the item. The for the item. - property gets the for the item. For example, the or . - + property gets the for the item. For example, the or . + ]]> diff --git a/xml/System.Xml/WriteState.xml b/xml/System.Xml/WriteState.xml index 65652b51da7..92a562af9a1 100644 --- a/xml/System.Xml/WriteState.xml +++ b/xml/System.Xml/WriteState.xml @@ -261,8 +261,6 @@ 6 An exception has been thrown, which has left the in an invalid state. You can call the method to put the in the state. Any other method calls results in an . - -This field was added in .NET Framework 2.0. diff --git a/xml/System.Xml/XmlNodeReader.xml b/xml/System.Xml/XmlNodeReader.xml index 0fcd7c1e034..5a9e562482c 100644 --- a/xml/System.Xml/XmlNodeReader.xml +++ b/xml/System.Xml/XmlNodeReader.xml @@ -130,7 +130,7 @@ Output: ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. For more information and examples of the code used to create an `XmlNodeReader`, see and overloads of the method. @@ -182,7 +182,7 @@ Output: ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property is relevant to `Element`, `DocumentType` and `XmlDeclaration` nodes only. (Other node types do not have attributes.) @@ -242,7 +242,7 @@ Output: ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. A networked XML document is comprised of chunks of data aggregated using various W3C standard inclusion mechanisms and therefore contains nodes that come from different places. DTD entities are an example of this, but this is not limited to DTDs. The base URI tells you where these nodes came from. If there is no base URI for the nodes being returned (for example, they were parsed from an in-memory string), String.Empty is returned. @@ -308,7 +308,7 @@ Output: ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. The binary content read methods include the , , , and methods. @@ -361,7 +361,7 @@ Output: ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -411,7 +411,7 @@ Output: ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method also releases any resources held while reading. If `Close` has already been called, no action is performed. @@ -481,7 +481,7 @@ Output: ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -532,7 +532,7 @@ Output: ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -660,7 +660,7 @@ This method does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method does not move the reader. @@ -736,7 +736,7 @@ This method does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. The following XML contains an attribute in a specific namespace: @@ -809,7 +809,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -868,7 +868,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. The following table lists node types that have a value to return. @@ -941,7 +941,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property applies to attribute nodes only. If the reader is not positioned on an attribute node, this property returns `false`. @@ -994,7 +994,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property enables you to determine the difference between the following: @@ -1127,7 +1127,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property does not move the reader. @@ -1182,7 +1182,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1251,7 +1251,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. In the following XML string, if the reader is positioned on the `href` attribute, the prefix `a` is resolved by calling `reader.LookupNamespace("a")`. The returned string is `urn:456`. @@ -1324,7 +1324,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1388,7 +1388,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. After calling this method, the , , and properties reflect the properties of that attribute. @@ -1455,7 +1455,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. After calling this method, the , , and properties reflect the properties of that attribute. @@ -1509,7 +1509,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. Use this method to return to an element after navigating through its attributes. This method moves the reader to one of the following node types: `Element`, `DocumentType`, or `XmlDeclaration`. @@ -1571,7 +1571,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET FrameworkFor more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET FrameworkFor more information, see the Remarks section in the reference page. @@ -1631,7 +1631,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. If the current node is not an attribute node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. @@ -1711,7 +1711,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1773,7 +1773,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property is relevant to `Element` and `Attribute` nodes only. @@ -1833,7 +1833,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. All node and attribute names returned from this class are atomized using the `NameTable`. When the same name is returned multiple times (for example, `Customer`), then the same `String` object is returned for that name. This makes it possible for you to write efficient code that does object comparisons on these strings instead of expensive string comparisons. @@ -1886,7 +1886,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1948,7 +1948,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -1992,7 +1992,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -2050,7 +2050,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. When a reader is first created and initialized, there is no information available. You must call `Read` to read the first node. @@ -2120,7 +2120,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. Use this method after calling to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node; it increments and decrements by one when you step into and out of general entity references. @@ -2187,7 +2187,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method streams the content, decodes the Base64 content, and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). @@ -2263,7 +2263,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method streams the content, decodes the BinHex content, and returns the decoded binary bytes (for example, an inline BinHex encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. @@ -2339,7 +2339,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method reads the content, decodes it using Base64 encoding, and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). @@ -2418,7 +2418,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This method reads the element content, decodes it using BinHex encoding, and returns the decoded binary bytes (for example, an inline BinHex encoded GIF image) into the buffer. @@ -2496,7 +2496,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -2549,7 +2549,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. If positioned on an element, `ReadString` concatenates all text, significant white space, white space, and CData section node types together and returns the concatenated data as the element content. It stops when any markup is encountered. This could occur in a mixed content model, or when an element end tag is read. @@ -2611,7 +2611,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. When the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. @@ -2681,7 +2681,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. The interface represents the Post Schema Validation Infoset (PSVI) of the underlying XML node. The PSVI contents of this property are set after the node has been validated. @@ -2735,7 +2735,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. For example, suppose you have the following XML input: @@ -3002,7 +3002,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. @@ -3064,7 +3064,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. This property represents the xml:lang scope within which the current node resides. For example, here is an XML fragment with `xml:lang` set to US English in the root element: @@ -3126,7 +3126,7 @@ This property does not move the reader. ## Remarks > [!NOTE] -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +> To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> diff --git a/xml/System.Xml/XmlTextReader.xml b/xml/System.Xml/XmlTextReader.xml index 3d5d0a40312..0878ae3fd8a 100644 --- a/xml/System.Xml/XmlTextReader.xml +++ b/xml/System.Xml/XmlTextReader.xml @@ -66,7 +66,7 @@ Represents a reader that provides fast, non-cached, forward-only access to XML data. - Starting with the .NET Framework 2.0, we recommend that you use the class instead. + We recommend that you use the class instead. For more information about this API, see Supplemental API remarks for XmlTextReader. This class has an inheritance demand. Full trust is required to inherit from . @@ -88,7 +88,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -176,7 +176,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The decodes the stream using . @@ -231,7 +231,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. It is assumed that the `TextReader` is already set to the correct encoding. This is used by clients that have already read some things from the stream in a multi-part MIME scenario. @@ -299,7 +299,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. If the file is located on a resource that requires access credentials, use the property to specify the necessary credentials. @@ -391,7 +391,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -444,7 +444,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The decodes the stream using . @@ -502,7 +502,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. It is assumed that the `TextReader` is already set to the correct encoding. This is used by clients that have already read some things from the stream in a multi-part MIME scenario. @@ -565,7 +565,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -627,7 +627,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. It is assumed that the `TextReader` is already set to the correct encoding. This is used by clients that have already read some things from the stream in a multi-part MIME scenario. @@ -689,7 +689,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -764,7 +764,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This constructor parses the given string as a fragment of XML. If the XML fragment is an element or attribute, you can bypass the root level rules for well-formed XML documents. @@ -848,7 +848,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -911,7 +911,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. It is assumed that the `TextReader` is already set to the correct encoding. This is used by clients that have already read some things from the stream in a multi-part MIME scenario. @@ -984,7 +984,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This constructor parses the given string as a fragment of XML. If the XML fragment is an element or attribute, you can bypass the root level rules for well-formed XML documents. This constructor can handle strings returned from . @@ -1058,7 +1058,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property is relevant to `Element`, `DocumentType` and `XmlDeclaration` nodes only. (Other node types do not have attributes.) @@ -1120,7 +1120,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. A networked XML document is comprised of chunks of data aggregated using various W3C standard inclusion mechanisms and therefore contains nodes that come from different places. DTD entities are an example of this, but this is not limited to DTDs. The base URI tells you where these nodes came from. If there is no base URI for the nodes being returned (for example, they were parsed from an in-memory string), `String.Empty` is returned. @@ -1185,7 +1185,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The binary content read methods include the , , , and methods. @@ -1238,7 +1238,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The throws a if the method is called. @@ -1291,9 +1291,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. - - This is a change in the .NET Framework 2.0 release. In previous versions, the `XmlTextReader` class could not resolve entities and `CanResolveEntity` always returned `false`. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -1344,7 +1342,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method also releases any resources held while reading. If this reader was constructed using a stream, this method also calls `Close` on the underlying stream. @@ -1399,7 +1397,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -1565,7 +1563,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property can be changed on the fly and takes effect after the next call. @@ -1642,7 +1640,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -1663,7 +1661,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -1717,7 +1715,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method does not move the reader. @@ -1782,7 +1780,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method does not move the reader. @@ -1863,7 +1861,7 @@ XmlTextReader reader = new XmlTextReader(s); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The following XML contains an attribute in a specific namespace: @@ -1939,7 +1937,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The dictionary consists of a collection of namespace names keyed by prefix. It can be used to enumerate the in-scope namespaces. The dictionary is a disconnected copy of the namespace list of the reader. It remains unchanged as the reader position, current in-scope namespace list, changes. @@ -2001,7 +1999,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. Because does a buffered `Read`, it must be able to return the remainder of the unused buffer so that no data is lost. This allows protocols (such as multi-part MIME) to package XML in the same stream as other things. @@ -2072,7 +2070,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -2124,7 +2122,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The following table lists node types that have a value to return. @@ -2201,7 +2199,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property applies only to attribute nodes. @@ -2255,7 +2253,7 @@ String dt4 = reader.GetAttribute("dt",http://www.w3.org/2000/xmlns/); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property enables you to determine the difference between the following: @@ -2436,7 +2434,7 @@ If the reader is positioned on a `DocumentType` node, this method can be used to ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property is most commonly used for error reporting, but can be called at any time. The starting value for this property is `1`. @@ -2576,7 +2574,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -2650,7 +2648,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. In the following XML, if the reader is positioned on the `href` attribute, the prefix `a` is resolved by calling `reader.LookupNamespace("a")`. The returned string is `urn:456`. @@ -2682,7 +2680,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -2735,7 +2733,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -2800,7 +2798,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. After calling `MoveToAttribute`, the , , and properties reflects the properties of that attribute. @@ -2868,7 +2866,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. After calling `MoveToAttribute`, the , , and properties reflects the properties of that attribute. @@ -2923,7 +2921,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. Use this method to return to an element after navigating through its attributes. This method moves the reader to one of the following node types: `Element`, `DocumentType`, or `XmlDeclaration`. @@ -2986,7 +2984,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -3051,7 +3049,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. If the current node is an element node, this method is equivalent to . If `MoveToNextAttribute` returns `true`, the reader moves to the next attribute; otherwise, the position of the reader does not change. @@ -3132,7 +3130,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -3196,7 +3194,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property determines whether the reader supports the W3C [Namespaces in XML](https://www.w3.org/TR/REC-xml-names) recommendation. @@ -3252,7 +3250,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property is relevant to `Element` and `Attribute` nodes only. @@ -3317,7 +3315,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. All node and attribute names returned from are atomized using the `NameTable`. When the same name is returned multiple times (for example, `Customer`), then the same `String` object is returned for that name. This makes it possible for you to write efficient code that does object comparisons on these strings instead of expensive string comparisons. @@ -3371,7 +3369,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property never returns the following `XmlNodeType` types: `Document`, `DocumentFragment`, `Entity`, `EndEntity`, or `Notation`. @@ -3437,7 +3435,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property can be changed at any time and takes effect on the next read operation. @@ -3520,7 +3518,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -3594,7 +3592,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. DTD processing is enabled by default for backwards compatibility. However, unless your application requires DTD processing, you should disable this setting. Disabling DTD processing can be useful in preventing certain denial of service attacks. If set to `true`, the reader throws an when any DTD content is encountered. @@ -3649,7 +3647,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property applies only to an attribute node. @@ -3704,7 +3702,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. When a reader is first created and initialized, there is no information available. You must call `Read` to read the first node. @@ -3779,7 +3777,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. Use this method after calling `MoveToAttribute` to read through the text or entity reference nodes that make up the attribute value. The of the attribute value nodes is one plus the depth of the attribute node; it increments and decrements by one when you step into and out of general entity references. @@ -3848,7 +3846,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. Like , this method can be called successively to read large streams of embedded text. It decodes Base64 content and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. See RFC 1521. (You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org).) @@ -3926,7 +3924,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. Like , this method can be called successively to read large streams of embedded text. It decodes `BinHex` content and returns the decoded binary bytes (for example, an inline `BinHex` encoded GIF image) into the buffer. @@ -4003,7 +4001,7 @@ abc ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This is the most efficient way to process very large streams of text embedded in an XML document. Rather than allocating large string objects, `ReadChars` returns text content a buffer at a time. This method is designed to work only on element nodes. Other node types cause `ReadChars` to return `0`. @@ -4126,7 +4124,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method streams the content, decodes the `Base64` content, and returns the decoded binary bytes (for example, an inline `Base64`-encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). @@ -4203,7 +4201,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method streams the content, decodes the `BinHex` content, and returns the decoded binary bytes (for example, an inline `BinHex` encoded GIF image) into the buffer. This method can be called successively to read large streams of embedded text. @@ -4281,7 +4279,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method reads the element content, decodes it using Base64 encoding, and returns the decoded binary bytes (for example, an inline Base64 encoded GIF image) into the buffer. For more information, see RFC 1521, "MIME (Multipurpose Internet Mail Extensions) Part One: Mechanisms for Specifying and Describing the Format of Internet Message Bodies". You can obtain RFCs from the [Request for Comments Web site](https://www.rfc-editor.org). @@ -4361,7 +4359,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method reads the element content, decodes it using `BinHex` encoding, and returns the decoded binary bytes (for example, an inline `BinHex` encoded GIF image) into the buffer. @@ -4434,7 +4432,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. ]]> @@ -4486,7 +4484,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. If positioned on an element, `ReadString` concatenates all text, significant white space, white space, and `CData` section node types together and returns the concatenated data as the element content. It stops when any markup is encountered, including comments and processing instructions. This could occur in a mixed content model, or when an element end tag is read. @@ -4555,7 +4553,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This method enables you to parse multiple XML documents in a single stream. When you reach the end of an XML document, you can call `ResetState` to reset the state of the reader in preparation for the next XML document. @@ -4631,7 +4629,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. If the reader is positioned on an `EntityReference` node (`XmlNodeType.EntityReference`), if is called after calling this method, the entity replacement text is parsed. When the entity replacement text is finished, an `EndEntity` node is returned to close the entity reference scope. @@ -4672,7 +4670,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks -> In the .NET Framework 2.0, the recommended practice is to create instances using the class and the method. This allows you to take full advantage of all the new features introduced in the .NET Framework. For more information, see the Remarks section in the reference page. +To take advantage of newer features, the recommended practice is to create instances using the class and the method. For more information, see the Remarks section in the reference page. ]]> @@ -4721,7 +4719,7 @@ if (XmlNodeType.Element == reader.NodeType && "thing" == reader.Name) ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. In the following XML input if the reader is positioned on the `` node or any of its attributes, calling `Skip` positions the reader to the `` node. @@ -5008,7 +5006,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. @@ -5071,7 +5069,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property can be changed at any time and takes effect on the next read operation. @@ -5136,7 +5134,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. This property represents the `xml:lang` scope within which the current node resides. For example, here is an XML fragment with `xml:lang` set to US English in the root element: @@ -5214,7 +5212,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. The reader uses `XmlResolver` to resolve the location of the file loaded into the reader and also to resolve DTD references. For example, if your XML included the DOCTYPE declaration, `` the reader resolves this external file and ensures that the DTD is well-formed. The reader does not use the DTD for validation. @@ -5287,7 +5285,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method to take advantage of new functionality. +> We recommend that you create instances by using the method to take advantage of new functionality. diff --git a/xml/System.Xml/XmlTextWriter.xml b/xml/System.Xml/XmlTextWriter.xml index ac34b341b02..6d3f285e69a 100644 --- a/xml/System.Xml/XmlTextWriter.xml +++ b/xml/System.Xml/XmlTextWriter.xml @@ -54,7 +54,7 @@ Represents a writer that provides a fast, non-cached, forward-only way of generating streams or files containing XML data that conforms to the W3C Extensible Markup Language (XML) 1.0 and the Namespaces in XML recommendations. - Starting with the .NET Framework 2.0, we recommend that you use the class instead. +We recommend that you use the class instead. For more information about this API, see Supplemental API remarks for XmlTextWriter. XML Documents and Data @@ -73,7 +73,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -123,7 +123,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -183,7 +183,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -246,7 +246,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -309,7 +309,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If the writer was constructed using a `TextWriter` that is derived from the `StreamWriter` class, this property is equivalent to the property. If the writer was constructed using a , this property returns the `Stream` passed to the constructor. If the writer was constructed using a file name, this property returns the `Stream` representing the file. @@ -361,7 +361,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. Any elements or attributes left open are automatically closed. @@ -423,7 +423,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This is called instead of when you want to write more to the underlying stream without losing what is still in the buffer. @@ -489,7 +489,7 @@ ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If the `Indented` option is set, child elements are indented using the and properties. Only element content is indented. The following C# code writes out HTML elements including mixed content: @@ -580,7 +580,7 @@ XmlTextWriter w = new XmlTextWriter(Console.Out); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. Indentation is performed on following node types: `DocumentType`, `Element`, `Comment`, `ProcessingInstruction`, and `CDATASection`. All other node types are not affected. The `XmlTextWriter` does not indent the internal DTD subset. However, you could do the following to apply formatting to the internal DTD subset. @@ -670,7 +670,7 @@ tw.WriteDocType(name, pubid, sysid, subset); The `XmlTextWriter` allows you to set this property to any character. To ensure valid XML, you must specify a valid white space character, 0x9, 0x10, 0x13, or 0x20. > [!NOTE] -> Starting with .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +> We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -733,7 +733,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. @@ -802,7 +802,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This property determines whether the writer supports the W3C [Namespaces in XML](https://www.w3.org/TR/REC-xml-names) recommendation. @@ -861,7 +861,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -919,7 +919,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. @@ -990,7 +990,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -1050,7 +1050,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If `text` is either `null` or `String.Empty`, this method writes an empty CDATA block, for example \. @@ -1115,7 +1115,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method writes the Unicode character in hexadecimal character entity reference format. @@ -1184,7 +1184,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method can be used to write large amounts of text one buffer at a time. @@ -1258,7 +1258,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If `text` is either `null` or `String.Empty`, this method writes a `Comment` with no data content, for example \. @@ -1337,7 +1337,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method does not check for invalid characters in `pubid`, `sysid` or `subset`. It also does not check that the internal subset is well-formed. @@ -1407,7 +1407,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If you call `WriteStartAttribute`, you can close the attribute with this method. @@ -1469,7 +1469,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. @@ -1534,7 +1534,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If the element contains no content a short end tag "/>" is written; otherwise a full end tag is written. @@ -1597,7 +1597,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. @@ -1662,7 +1662,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method always writes the full end tag. This is useful when dealing with elements that must include a full end tag. For example, browsers expect HTML script blocks to be closed with "\". @@ -1725,7 +1725,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If is set to `true`, `WriteName` also checks that the name is also valid according to the W3C Namespaces in XML recommendation. @@ -1782,7 +1782,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -1847,7 +1847,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. If `text` is either `null` or `String.Empty`, this method writes a `ProcessingInstruction` with no data content, for example \. @@ -1925,7 +1925,7 @@ The `XmlTextWriter` allows you to set this property to any character. To ensure ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. For example, the following Microsoft Visual C# code: @@ -1987,7 +1987,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -2040,7 +2040,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method does not escape special characters. @@ -2110,7 +2110,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method does not escape special characters. @@ -2191,7 +2191,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This is a more advanced version of that allows you to write an attribute value using multiple write methods, such as . @@ -2224,7 +2224,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -2280,7 +2280,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. The encoding level of the document is determined by how the writer is implemented. For example, if an object is specified in the `XmlTextWriter` constructor, this determines the value of the encoding attribute. This method does not create a standalone attribute. @@ -2348,7 +2348,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. The encoding level of the document is determined by how the writer is implemented. For example, if an object is specified in the `XmlTextWriter` constructor, this determines the value of the encoding attribute. @@ -2420,7 +2420,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. After calling this method you can either write attributes or create content using , , or for child elements. You can close the element with at which time an end tag is written out. @@ -2481,7 +2481,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. ]]> @@ -2535,7 +2535,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. `WriteString` does the following @@ -2609,7 +2609,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method is only applicable on systems that use UTF-16 encoding. @@ -2672,7 +2672,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This method is used to manually format your document. Use the property to have the writer format the output automatically. @@ -2741,7 +2741,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This property allows one component to find out what state another component has left the writer in. For example, perhaps one component wants to tell another which language help text to generate. The language information is communicated by writing an `xml:lang` attribute. @@ -2811,7 +2811,7 @@ writer.WriteStartElement("root"); ## Remarks > [!NOTE] -> Starting with the .NET Framework 2.0, we recommend that you create instances by using the method and the class to take advantage of new functionality. +>We recommend that you create instances by using the method and the class to take advantage of new functionality. This property allows one component to find out in what state another component has left the writer. diff --git a/xml/System.Xml/XmlValidatingReader.xml b/xml/System.Xml/XmlValidatingReader.xml index 5240dda1bd0..a6a25b8352c 100644 --- a/xml/System.Xml/XmlValidatingReader.xml +++ b/xml/System.Xml/XmlValidatingReader.xml @@ -74,7 +74,7 @@ Represents a reader that provides document type definition (DTD), XML-Data Reduced (XDR) schema, and XML Schema definition language (XSD) validation. - This class is obsolete. Starting with the .NET Framework 2.0, we recommend that you use the class and the method to create a validating XML reader. + This class is obsolete. We recommend that you use the class and the method to create a validating XML reader. and methods. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to create nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to create nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -243,7 +243,7 @@ For information about other exceptions that can be thrown by invoked methods, see the Exceptions section of the and methods. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to create nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to create nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -404,7 +404,7 @@ The constructor to be invoked must be accessible. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ## Examples The following code example demonstrates how to call the method. Instances of several different types are created and their default values are displayed. @@ -575,7 +575,7 @@ Note: In .NET for Win For more information on how the common language runtime identifies and loads assemblies, see [How the Runtime Locates Assemblies](/dotnet/framework/deployment/how-the-runtime-locates-assemblies). For information on using the application configuration file to define assembly locations, see [Specifying an Assembly's Location](/dotnet/framework/configure-apps/specify-assembly-location). If `assemblyName` is found, it is loaded in the default context. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to create nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to create nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. @@ -691,7 +691,7 @@ Note: In .NET for Win ## Remarks > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access nonpublic types and members if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access nonpublic types and members if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -807,7 +807,7 @@ Note: In .NET for Win The constructor to be invoked must be accessible and must provide the most specific match with the specified argument list. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. @@ -1019,7 +1019,7 @@ Note: In .NET for Win Use to unwrap the return value. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to create nonpublic types if the caller has been granted with the flag and if the grant set of the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to create nonpublic types if the caller has been granted with the flag and if the grant set of the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -1135,7 +1135,7 @@ An error occurred when attempting remote activation in a target specified in [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access nonpublic types if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -1251,7 +1251,7 @@ An error occurred when attempting remote activation in a target specified in [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access nonpublic types and members if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access nonpublic types and members if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -1367,7 +1367,7 @@ An error occurred when attempting remote activation in a target specified in [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to access nonpublic types and members if the caller has been granted with the flag and if the grant set of the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to access nonpublic types and members if the caller has been granted with the flag and if the grant set of the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -1494,7 +1494,7 @@ An error occurred when attempting remote activation in a target specified in to unwrap the return value. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to create nonpublic types and members if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to create nonpublic types and members if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> @@ -1693,7 +1693,7 @@ An error occurred when attempting remote activation in a target specified in to unwrap the return value. > [!NOTE] -> Starting with .NET Framework 2.0, this method can be used to create nonpublic types and members if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. +> This method can be used to create nonpublic types and members if the caller has been granted with the flag and if the grant set of the assembly that contains the nonpublic types and members is restricted to the caller's grant set or to a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) To use this functionality, your application should target .NET Framework 3.5 or later. ]]> diff --git a/xml/System/Array.xml b/xml/System/Array.xml index bbfb1b46648..1ce29b83c23 100644 --- a/xml/System/Array.xml +++ b/xml/System/Array.xml @@ -6385,7 +6385,7 @@ This method is an O(`n`) operation, where `n` is the of `array`. - In .NET Framework 2.0 and later versions, this method uses the and methods of the to determine whether the specified by the `value` parameter exists. In earlier versions of .NET Framework, this determination was made by using the and methods of the `value` itself. + This method uses the and methods of the to determine whether the specified by the `value` parameter exists. methods of the `item` parameter on the objects in the collection. @@ -6482,7 +6482,7 @@ This method is an O(`n`) operation, where `n` is the number of elements from the beginning of `array` to `startIndex`. - In .NET Framework 2.0 and later versions, this method uses the and methods of the to determine whether the specified by the `value` parameter exists. In earlier versions of .NET Framework, this determination was made by using the and methods of the `value` itself. + This method uses the and methods of the to determine whether the specified by the `value` parameter exists. ## Examples The following code example shows how to determine the index of the last occurrence of a specified element in an array. @@ -6585,7 +6585,7 @@ This method is an O(`n`) operation, where `n` is `count`. - In .NET Framework 2.0 and later versions, this method uses the and methods of the to determine whether the specified by the `value` parameter exists. In earlier versions of .NET Framework, this determination was made by using the and methods of the `value` itself. + This method uses the and methods of the to determine whether the specified by the `value` parameter exists. ## Examples The following code example shows how to determine the index of the last occurrence of a specified element in an array. Note that the method is a backward search; therefore, `count` must be less than or equal to (`startIndex` minus the lower bound of the array plus 1). diff --git a/xml/System/BadImageFormatException.xml b/xml/System/BadImageFormatException.xml index 2c48c4ce335..67fb8be1abd 100644 --- a/xml/System/BadImageFormatException.xml +++ b/xml/System/BadImageFormatException.xml @@ -97,7 +97,7 @@ To address this exception, set the project's **Platform target** property to x86 (instead of x64 or AnyCPU) and recompile. -- Your application's components were created using different versions of .NET. Typically, this exception occurs when an application or component that was developed using the .NET Framework 1.0 or the .NET Framework 1.1 tries to load an assembly that was developed using the .NET Framework 2.0 SP1 or later, or when an application that was developed using the .NET Framework 2.0 SP1 or .NET Framework 3.5 tries to load an assembly that was developed using the .NET Framework 4 or later. The may be reported as a compile-time error, or the exception may be thrown at run time. The following example defines a `StringLib` class that has a single member, `ToProperCase`, and that resides in an assembly named StringLib.dll. +- Your application's components were created using different versions of .NET. Typically, this exception occurs when an application that was developed using .NET Framework 2.0 SP1 or .NET Framework 3.5 tries to load an assembly that was developed using .NET Framework 4 or later. The may be reported as a compile-time error, or the exception may be thrown at run time. The following example defines a `StringLib` class that has a single member, `ToProperCase`, and that resides in an assembly named StringLib.dll. :::code language="csharp" source="~/snippets/csharp/System/BadImageFormatException/Overview/stringlib.cs" id="Snippet2"::: :::code language="fsharp" source="~/snippets/fsharp/VS_Snippets_CLR_System/system.badimageformatexception.class/fs/stringlib.fs" id="Snippet2"::: diff --git a/xml/System/EventHandler`1.xml b/xml/System/EventHandler`1.xml index 20e53d225e0..a40bed66722 100644 --- a/xml/System/EventHandler`1.xml +++ b/xml/System/EventHandler`1.xml @@ -1,11 +1,14 @@ - + - + - + + + + diff --git a/xml/System/EventHandler`2.xml b/xml/System/EventHandler`2.xml new file mode 100644 index 00000000000..59b675799b4 --- /dev/null +++ b/xml/System/EventHandler`2.xml @@ -0,0 +1,56 @@ + + + + + + + + + System.Runtime + 10.0.0.0 + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + Contravariant + AllowByRefLike + + + + + + [System.Runtime.CompilerServices.Nullable(2)] + [<System.Runtime.CompilerServices.Nullable(2)>] + + + + Contravariant + AllowByRefLike + + + + + System.Delegate + + + + + + + System.Void + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + diff --git a/xml/System/GenericUriParser.xml b/xml/System/GenericUriParser.xml index 5b4cc2b20c6..afd32bf1b8a 100644 --- a/xml/System/GenericUriParser.xml +++ b/xml/System/GenericUriParser.xml @@ -43,19 +43,17 @@ A customizable parser for a hierarchical URI. - , , , , or . - - When creating a customizable parser, the behavior of the parser is specified by passing a bitwise combination of the values available in the enumeration to the constructor. - - The existing class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names (IDN). Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. - - All parsers derived from will not gain IRI and IDN support by default. The option does not include IRI and IDN support. Two new values are added to the enumeration to indicate if a custom parser supports IRI and IDN. - - For more information on IRI and IDN support, see the Remarks section for the class. - + , , , , or . + + When creating a customizable parser, the behavior of the parser is specified by passing a bitwise combination of the values available in the enumeration to the constructor. + + The class provides support for International Resource Identifiers (IRI) and Internationalized Domain Names (IDN). Parsers derived from don't have IRI and IDN support by default. The option does not include IRI and IDN support. The and fields indicate if a custom parser supports IDN and IRI respectively. + + For more information on IRI and IDN support, see the Remarks section for the class. + ]]> @@ -98,29 +96,27 @@ Specify the options for this . Create a customizable parser for a hierarchical URI. - - - If you want to create a parser based on a well-known scheme, use , , , , or . - - When creating a customizable parser, the behavior of the parser is specified by passing a bitwise combination of the values available in the enumeration to the constructor. - - The existing class has been extended to provide support for International Resource Identifiers (IRI) and Internationalized Domain Names (IDN). Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. - - All parsers derived from will not gain IRI and IDN support by default. The option does not include IRI and IDN support. Two new values are added to the enumeration to indicate if a custom parser supports IRI and IDN. - - The type indicates the parser supports the parsing rules specified in RFC 3987 for International Resource Identifiers (IRI). Whether IRI is used is dictated by configuration values. - - The type indicates the parser supports Internationalized Domain Name (IDN) parsing (IDN) of host names. Whether IDN is used is dictated by configuration values. - - The configuration setting for the is indirectly controlled by the configuration setting that controls IRI processing in the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. - - The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. - - For more information on IRI and IDN support, see the Remarks section for the class. - + + + If you want to create a parser based on a well-known scheme, use , , , , or . + + When creating a customizable parser, the behavior of the parser is specified by passing a bitwise combination of the values available in the enumeration to the constructor. + + The class provides support for International Resource Identifiers (IRI) and Internationalized Domain Names (IDN). Parsers derived from don't have IRI and IDN support by default. The option does not include IRI and IDN support. + + The type indicates the parser supports the parsing rules specified in RFC 3987 for International Resource Identifiers (IRI). Whether IRI is used is dictated by configuration values. + + The type indicates the parser supports Internationalized Domain Name (IDN) parsing (IDN) of host names. Whether IDN is used is dictated by configuration values. + + The configuration setting for the is indirectly controlled by the configuration setting that controls IRI processing in the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. + + The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. + + For more information on IRI and IDN support, see the Remarks section for the class. + ]]> diff --git a/xml/System/GenericUriParserOptions.xml b/xml/System/GenericUriParserOptions.xml index bb5e0d9594c..d1f65b9c6c6 100644 --- a/xml/System/GenericUriParserOptions.xml +++ b/xml/System/GenericUriParserOptions.xml @@ -48,19 +48,19 @@ Specifies options for a . - constructor. - - The existing class has been extended to provide support for International Resource Identifiers (IRI) based on RFC 3987. Current users will not see any change from the .NET Framework 2.0 behavior unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. - - The configuration setting for the is indirectly controlled by the configuration setting that controls IRI processing in the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. - - The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. - - For more information on IRI support, see the Remarks section for the class. - + constructor. + + The existing class has been extended to provide support for International Resource Identifiers (IRI) based on RFC 3987. Users upgrading from .NET Framework 2.0 won't see any behavior change unless they specifically enable IRI. This ensures application compatibility with prior versions of the .NET Framework. + + The configuration setting for the is indirectly controlled by the configuration setting that controls IRI processing in the class. IRI processing must be enabled for IDN processing to be possible. If IRI processing is disabled, then IDN processing will be set to the default setting where the .NET Framework 2.0 behavior is used for compatibility and IDN names are not used. + + The Internationalized Domain Name (IDN) attribute only controls IDN processing. All other IRI processing (character normalization, for example) is performed by default. + + For more information on IRI support, see the Remarks section for the class. + ]]> diff --git a/xml/System/Object.xml b/xml/System/Object.xml index cb75e7e2473..5115fad16ee 100644 --- a/xml/System/Object.xml +++ b/xml/System/Object.xml @@ -504,14 +504,10 @@ For an additional example that overrides the me ## Remarks Because is the base class for all types in the .NET type system, the method can be used to return objects that represent all .NET types. .NET recognizes the following five categories of types: -- Classes, which are derived from , - +- Classes, which are derived from . - Value types, which are derived from . - -- Interfaces, which are derived from starting with the .NET Framework 2.0. - +- Interfaces, which are derived from . - Enumerations, which are derived from . - - Delegates, which are derived from . For two objects `x` and `y` that have identical runtime types, `Object.ReferenceEquals(x.GetType(),y.GetType())` returns `true`. The following example uses the method with the method to determine whether one numeric value is the same type as two other numeric values. diff --git a/xml/System/StackOverflowException.xml b/xml/System/StackOverflowException.xml index 4e5005e0919..6daf88e0e72 100644 --- a/xml/System/StackOverflowException.xml +++ b/xml/System/StackOverflowException.xml @@ -59,25 +59,24 @@ The exception that is thrown when the execution stack exceeds the stack size. This class cannot be inherited. - intermediate language (IL) instruction throws `StackOverflowException`. For a list of initial property values for a `StackOverflowException` object, see the constructors. - - Starting with the .NET Framework 2.0, you can't catch a `StackOverflowException` object with a `try`/`catch` block, and the corresponding process is terminated by default. Consequently, you should write your code to detect and prevent a stack overflow. For example, if your app depends on recursion, use a counter or a state condition to terminate the recursive loop. -See the [Examples](#examples) section for an illustration of this technique. - + + `StackOverflowException` uses the HRESULT COR_E_STACKOVERFLOW, which has the value 0x800703E9. The intermediate language (IL) instruction throws `StackOverflowException`. For a list of initial property values for a `StackOverflowException` object, see the constructors. + +You can't catch a `StackOverflowException` object with a `try`/`catch` block, and the corresponding process is terminated by default. Consequently, you should write your code to detect and prevent a stack overflow. For example, if your app depends on recursion, use a counter or a state condition to terminate the recursive loop. For an illustration of this technique, see the [Examples](#examples) section. + > [!NOTE] -> Applying the attribute to a method that throws a `StackOverflowException` has no effect. You still cannot handle the exception from user code. +> Applying the attribute to a method that throws a `StackOverflowException` has no effect. You still cannot handle the exception from user code. If your app hosts the common language runtime (CLR), it can specify that the CLR should unload the application domain where the stack overflow exception occurs and let the corresponding process continue. For more information, see [ICLRPolicyManager Interface](/dotnet/framework/unmanaged-api/hosting/iclrpolicymanager-interface). ## Examples The following example uses a counter to ensure that the number of recursive calls to the `Execute` method do not exceed a maximum defined by the MAX_RECURSIVE_CALLS constant. - + :::code language="csharp" source="~/snippets/csharp/System/StackOverflowException/Overview/example1a.cs" interactive="try-dotnet" id="Snippet1"::: :::code language="fsharp" source="~/snippets/fsharp/System/StackOverflowException/Overview/example1a.fs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.stackoverflowexception.class/vb/example1a.vb" id="Snippet1"::: @@ -133,16 +132,16 @@ See the [Examples](#examples) section for an illustration of this technique. Initializes a new instance of the class, setting the property of the new instance to a system-supplied message that describes the error, such as "The requested operation caused a stack overflow." This message takes into account the current system culture. - . - -|Property|Value| -|--------------|-----------| -||`null`.| -||The localized error message string.| - + . + +|Property|Value| +|--------------|-----------| +||`null`.| +||The localized error message string.| + ]]> @@ -187,16 +186,16 @@ See the [Examples](#examples) section for an illustration of this technique. A that describes the error. The content of message is intended to be understood by humans. The caller of this constructor is required to ensure that this string has been localized for the current system culture. Initializes a new instance of the class with a specified error message. - . - -|Property|Value| -|--------------|-----------| -||A null reference (`Nothing` in Visual Basic).| -||The error message string.| - + . + +|Property|Value| +|--------------|-----------| +||A null reference (`Nothing` in Visual Basic).| +||The error message string.| + ]]> @@ -243,18 +242,18 @@ See the [Examples](#examples) section for an illustration of this technique. The exception that is the cause of the current exception. If the parameter is not a null reference ( in Visual Basic), the current exception is raised in a block that handles the inner exception. Initializes a new instance of the class with a specified error message and a reference to the inner exception that is the cause of this exception. - property. The property returns the same value that is passed into the constructor, or a null reference (`Nothing` in Visual Basic) if the property does not supply the inner exception value to the constructor. - - The following table shows the initial property values for an instance of . - -|Property|Value| -|--------------|-----------| -||The inner exception reference.| -||The error message string.| - + property. The property returns the same value that is passed into the constructor, or a null reference (`Nothing` in Visual Basic) if the property does not supply the inner exception value to the constructor. + + The following table shows the initial property values for an instance of . + +|Property|Value| +|--------------|-----------| +||The inner exception reference.| +||The error message string.| + ]]> diff --git a/xml/System/TimeZone.xml b/xml/System/TimeZone.xml index bc340fb27f9..43589ec2355 100644 --- a/xml/System/TimeZone.xml +++ b/xml/System/TimeZone.xml @@ -623,7 +623,7 @@ ]]> - Although it is not required, in most cases derived classes running under the .NET Framework version 2.0 should override the default implementation of this method. In the .NET Framework versions 1.0 and 1.1, the method called the method and adjusted for daylight saving time when returning the local time. However, starting with the .NET Framework 2.0, the behavior of the default implementation depends on the property of the parameter. If its value is , this method returns unchanged. If its value is either or , this method assumes is UTC and converts it to the local system time without calling the method. + Although it is not required, in most cases derived classes running under .NET Framework version 2.0 or later should override the default implementation of this method. The behavior of the default implementation depends on the property of the parameter. If its value is , this method returns unchanged. If its value is either or , this method assumes is UTC and converts it to the local system time without calling the method. The following code provides a simple override of the default implementation of the method. In this code, the variable represents a private instance of the class: diff --git a/xml/System/Type.xml b/xml/System/Type.xml index 964ee577296..3dffbdf216a 100644 --- a/xml/System/Type.xml +++ b/xml/System/Type.xml @@ -11462,11 +11462,9 @@ Calling this method overload is the same as calling the [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) > -> To use this functionality, your application should target the .NET Framework 3.5 or later. - - +> To use this functionality, your application should target .NET Framework 3.5 or later. ## Examples The following example uses `InvokeMember` to access members of a type. @@ -11698,7 +11696,7 @@ Calling this method overload is the same as calling the [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) > > To use this functionality, your application should target the .NET Framework 3.5 or later. @@ -11941,7 +11939,7 @@ Calling this method overload is the same as calling the [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) > > To use this functionality, your application should target the .NET Framework 3.5 or later. diff --git a/xml/System/TypedReference.xml b/xml/System/TypedReference.xml index 522ab9ba1c3..1117a0f44a2 100644 --- a/xml/System/TypedReference.xml +++ b/xml/System/TypedReference.xml @@ -63,18 +63,18 @@ Describes objects that contain both a managed pointer to a location and a runtime representation of the type that may be stored at that location. - @@ -269,37 +269,37 @@ Makes a for a field identified by a specified object and list of field descriptions. A for the field described by the last element of . - method returns a typed reference to some terminal field, where the `target` parameter contains the field described by the first element of `flds`, the field described by the first element of `flds` contains the field described by the second element of `flds`, and so on until the terminal field is reached. - + method returns a typed reference to some terminal field, where the `target` parameter contains the field described by the first element of `flds`, the field described by the first element of `flds` contains the field described by the second element of `flds`, and so on until the terminal field is reached. + > [!NOTE] -> Starting with the .NET Framework 2.0 Service Pack 1, this method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) -> -> To use this functionality, your application should target the .NET Framework 3.5 or later. - +> This method can be used to access non-public members if the caller has been granted with the flag and if the grant set of the non-public members is restricted to the caller's grant set, or a subset thereof. (See [Security Considerations for Reflection](/dotnet/framework/reflection-and-codedom/security-considerations-for-reflection).) +> +> To use this functionality, your application should target .NET Framework 3.5 or later. + ]]> - or is . - - -or- - + or is . + + -or- + An element of is . - The array has no elements. - - -or- - - An element of is not a object. - - -or- - + The array has no elements. + + -or- + + An element of is not a object. + + -or- + The or property of an element of is . - Parameter does not contain the field described by the first element of , or an element of describes a field that is not contained in the field described by the succeeding element of . - - -or- - + Parameter does not contain the field described by the first element of , or an element of describes a field that is not contained in the field described by the succeeding element of . + + -or- + The field described by an element of is not a value type. @@ -358,11 +358,11 @@ The value to be converted. Converts the specified value to a . This method is not supported. - . - + . + ]]> In all cases. @@ -462,11 +462,11 @@ Converts the specified to an . An converted from a . - diff --git a/xml/ns-System.Web.ClientServices.Providers.xml b/xml/ns-System.Web.ClientServices.Providers.xml index bf4b555766c..764c94fc176 100644 --- a/xml/ns-System.Web.ClientServices.Providers.xml +++ b/xml/ns-System.Web.ClientServices.Providers.xml @@ -5,7 +5,7 @@ namespace include client application service providers that enable Windows-based applications to use the Microsoft Ajax authentication, roles, and profile services. You can enable these services and specify client service providers in your application configuration file, and then access the services through existing .NET Framework 2.0 membership, identity, and application settings infrastructures. The client service providers also support occasional connectivity by storing and retrieving user information in a local data cache when the application is offline. For more information, see [Client Application Services](/dotnet/framework/common-client-technologies/client-application-services). + The classes in the namespace include client application service providers that enable Windows-based applications to use the Microsoft Ajax authentication, roles, and profile services. You can enable these services and specify client service providers in your application configuration file, and then access the services through existing .NET membership, identity, and application settings infrastructures. The client service providers also support occasional connectivity by storing and retrieving user information in a local data cache when the application is offline. For more information, see [Client Application Services](/dotnet/framework/common-client-technologies/client-application-services). To access the login service, you can use either Windows or Forms authentication by specifying the or in your application configuration. Windows authentication uses the identity supplied when a user logs in to the operating system. Forms authentication requires that you to retrieve login information from the user and pass it to the service. You can do this by specifying an implementation with your configuration. The method returns a object that contains user login information. You can populate this object, for example, by displaying a login dialog box in the method. diff --git a/xml/ns-System.Web.ClientServices.xml b/xml/ns-System.Web.ClientServices.xml index ea5ca0843d6..a8cb82871e5 100644 --- a/xml/ns-System.Web.ClientServices.xml +++ b/xml/ns-System.Web.ClientServices.xml @@ -5,7 +5,7 @@ namespace support the client application service providers in the namespace. These service providers enable Windows-based applications to use the Microsoft Ajax authentication, roles, and profiles services through existing .NET Framework 2.0 membership, identity, and application settings infrastructures. The client service providers also support occasional connectivity by storing and retrieving user information in a local data cache when the application is offline. For more information, see [Client Application Services](/dotnet/framework/common-client-technologies/client-application-services). + The classes in the namespace support the client application service providers in the namespace. These service providers enable Windows-based applications to use the Microsoft Ajax authentication, roles, and profiles services through existing .NET membership, identity, and application settings infrastructures. The client service providers also support occasional connectivity by storing and retrieving user information in a local data cache when the application is offline. For more information, see [Client Application Services](/dotnet/framework/common-client-technologies/client-application-services). The and classes provide properties and methods related to a user's identity, role, and authentication state. diff --git a/xml/ns-System.Windows.Forms.xml b/xml/ns-System.Windows.Forms.xml index 4e93efa6c0d..904f4d7dd0a 100644 --- a/xml/ns-System.Windows.Forms.xml +++ b/xml/ns-System.Windows.Forms.xml @@ -21,8 +21,6 @@ > [!CAUTION] > Classes within the Windows Forms namespace are not supported for use within a Windows service. Trying to use these classes from within a service may produce unexpected problems, such as diminished service performance and run-time exceptions. -> -> If you are using .NET Framework version 1.1 or .NET Framework 1.0 and you must make your Windows Forms application support Windows XP visual styles, make sure that you set the `FlatStyle` property of your controls to and include a manifest with your executable file. A manifest is an XML file that is included either as a resource within your application executable file or as a separate file that resides in the same directory as the executable file. For an example of a manifest, see the Example section for the enumeration. By default visual styles are enabled for the .NET Framework versions 1.1, 1.2, and 2.0. ]]>