diff --git a/docfx.json b/docfx.json index fff3ba04e27..34db0237af2 100644 --- a/docfx.json +++ b/docfx.json @@ -44,7 +44,7 @@ "ms.author": "dotnetcontent", "ms.date": "04/30/2018", "searchScope": [".NET"], - "uhfHeaderId": "MSDocsHeader-DotNet", + "uhfHeaderId": [], "apiPlatform": "dotnet", "ms.topic": "managed-reference", "ms.prod": "dotnet-api", diff --git a/xml/Microsoft.Extensions.Hosting/HostEnvironmentEnvExtensions.xml b/xml/Microsoft.Extensions.Hosting/HostEnvironmentEnvExtensions.xml index f2ba543e88d..79d01daa16a 100644 --- a/xml/Microsoft.Extensions.Hosting/HostEnvironmentEnvExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting/HostEnvironmentEnvExtensions.xml @@ -40,10 +40,13 @@ An instance of . - Checks if the current host environment name is . + Checks if the current host environment name is . This API should not be used in libraries, see remarks for details. if the environment name is ; otherwise, . - To be added. + + The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library + authors should avoid coupling specific behavior to these environment names. + @@ -69,10 +72,13 @@ An instance of . Environment name to validate against. - Compares the current host environment name against the specified value. + Compares the current host environment name against the specified value. Library authors should avoid using this API, see remarks for details. if the specified name is the same as the current environment; otherwise, . - To be added. + + Environment names are generally specific to an application. Libraries designed for use in many different applications + should avoid coupling behavior to specific environment names. + @@ -96,10 +102,13 @@ An instance of . - Checks if the current host environment name is . + Checks if the current host environment name is . This API should not be used in libraries, see remarks for details. if the environment name is ; otherwise, . - To be added. + + The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library + authors should avoid coupling specific behavior to these environment names. + @@ -123,10 +132,13 @@ An instance of . - Checks if the current host environment name is . + Checks if the current host environment name is . This API should not be used in libraries, see remarks for details. if the environment name is ; otherwise, . - To be added. + + The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library + authors should avoid coupling specific behavior to these environment names. + diff --git a/xml/Microsoft.Extensions.Hosting/HostingEnvironmentExtensions.xml b/xml/Microsoft.Extensions.Hosting/HostingEnvironmentExtensions.xml index be478ecf01d..37d7ea622b9 100644 --- a/xml/Microsoft.Extensions.Hosting/HostingEnvironmentExtensions.xml +++ b/xml/Microsoft.Extensions.Hosting/HostingEnvironmentExtensions.xml @@ -44,10 +44,13 @@ An instance of . - Checks if the current hosting environment name is . + Checks if the current hosting environment name is . This API should not be used in libraries, see remarks for details. if the environment name is ; otherwise, . - To be added. + + The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library + authors should avoid coupling specific behavior to these environment names. + @@ -75,10 +78,13 @@ An instance of . Environment name to validate against. - Compares the current hosting environment name against the specified value. + Compares the current hosting environment name against the specified value. Library authors should avoid using this API, see remarks for details. if the specified name is the same as the current environment; otherwise, . - To be added. + + Environment names are generally specific to an application. Libraries designed for use in many different applications + should avoid coupling behavior to specific environment names. + @@ -104,10 +110,13 @@ An instance of . - Checks if the current hosting environment name is . + Checks if the current hosting environment name is . This API should not be used in libraries, see remarks for details. if the environment name is ; otherwise, . - To be added. + + The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library + authors should avoid coupling specific behavior to these environment names. + @@ -133,10 +142,13 @@ An instance of . - Checks if the current hosting environment name is . + Checks if the current hosting environment name is . This API should not be used in libraries, see remarks for details. if the environment name is ; otherwise, . - To be added. + + The environment names "Development", "Production" and "Staging" are provided as a utility for application developers. Library + authors should avoid coupling specific behavior to these environment names. + diff --git a/xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml b/xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml index 655c3ab487f..625378ea6e2 100644 --- a/xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml +++ b/xml/Microsoft.Extensions.Primitives/CancellationChangeToken.xml @@ -1,4 +1,4 @@ - + @@ -83,8 +83,8 @@ System.Boolean - To be added. - To be added. + Indicates if this token will pro-actively raise callbacks. If , the token consumer must poll to detect changes. + if the token will proactively raise callbacks; otherwise. To be added. @@ -115,8 +115,8 @@ System.Boolean - To be added. - To be added. + Gets a value that indicates if a change has occurred. + if a change has occured; otherwise. To be added. @@ -151,10 +151,10 @@ - To be added. - To be added. - To be added. - To be added. + The to invoke. + State to be passed into the callback. + Registers for a callback that will be invoked when the entry has changed. must be set before the callback is invoked. + An that is used to unregister the callback. To be added. diff --git a/xml/Microsoft.Extensions.Primitives/ChangeToken.xml b/xml/Microsoft.Extensions.Primitives/ChangeToken.xml index 1c65e66dd76..ff27cbe762f 100644 --- a/xml/Microsoft.Extensions.Primitives/ChangeToken.xml +++ b/xml/Microsoft.Extensions.Primitives/ChangeToken.xml @@ -90,7 +90,7 @@ - To be added. + The type of the state for the action. Produces the change token. Action called when the token changes. state for the consumer. diff --git a/xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml b/xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml index 42f03d116f4..203260d45e8 100644 --- a/xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml +++ b/xml/Microsoft.Extensions.Primitives/CompositeChangeToken.xml @@ -1,4 +1,4 @@ - + @@ -77,8 +77,8 @@ System.Boolean - To be added. - To be added. + Indicates if this token will pro-actively raise callbacks. If , the token consumer must poll to detect changes. + if the token will proactively raise callbacks; otherwise. To be added. @@ -105,7 +105,7 @@ Returns the list of which compose the current . - To be added. + The list of instances which compose the current . To be added. @@ -133,8 +133,8 @@ System.Boolean - To be added. - To be added. + Gets a value that indicates if a change has occurred. + if a change has occured; otherwise. To be added. @@ -167,10 +167,10 @@ - To be added. - To be added. - To be added. - To be added. + The to invoke. + State to be passed into the callback. + Registers for a callback that will be invoked when the entry has changed. must be set before the callback is invoked. + An that is used to unregister the callback. To be added. diff --git a/xml/Microsoft.Extensions.Primitives/IChangeToken.xml b/xml/Microsoft.Extensions.Primitives/IChangeToken.xml index 317e0365ac1..5eee511c19f 100644 --- a/xml/Microsoft.Extensions.Primitives/IChangeToken.xml +++ b/xml/Microsoft.Extensions.Primitives/IChangeToken.xml @@ -47,7 +47,7 @@ Indicates if this token will pro-actively raise callbacks. If , the token consumer must poll to detect changes. - To be added. + if the token will proactively raise callbacks; otherwise. To be added. @@ -75,7 +75,7 @@ Gets a value that indicates if a change has occurred. - To be added. + if a change has occurred; otherwise. To be added. diff --git a/xml/Microsoft.Extensions.Primitives/StringSegment.xml b/xml/Microsoft.Extensions.Primitives/StringSegment.xml index cf2c6fe0c50..07d8e64762c 100644 --- a/xml/Microsoft.Extensions.Primitives/StringSegment.xml +++ b/xml/Microsoft.Extensions.Primitives/StringSegment.xml @@ -1,4 +1,4 @@ - + @@ -182,9 +182,11 @@ Gets the buffer for this . - To be added. + The buffer for this . To be added. + Gets the value of this segment as a . + The value of this segment as a . @@ -556,7 +558,7 @@ Gets whether this contains a valid value. - To be added. + if the contains a valid value; otherwise. To be added. @@ -901,7 +903,7 @@ Gets the length of this . - To be added. + The length of this . To be added. @@ -929,7 +931,7 @@ Gets the offset within the buffer for this . - To be added. + The offset within the buffer for this . To be added. @@ -991,8 +993,8 @@ - To be added. - To be added. + The to convert to a . + Creates a see from the given . To be added. To be added. @@ -1020,8 +1022,8 @@ - To be added. - To be added. + The to convert to a . + Creates a see from the given . To be added. To be added. @@ -1450,7 +1452,7 @@ Gets the value of this segment as a . - To be added. + The value of this segment as a . To be added. diff --git a/xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml b/xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml index dc77e08fd85..2b80ec9fe1c 100644 --- a/xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml +++ b/xml/Microsoft.Extensions.Primitives/StringSegmentComparer.xml @@ -1,4 +1,4 @@ - + @@ -61,11 +61,25 @@ - To be added. - To be added. - To be added. - To be added. - To be added. + The first object to compare. + The second object to compare. + Compares two objects and returns a value indicating whether one is less than, equal to, or greater than the other. + A signed integer that indicates the relative values of and . + + + @@ -96,10 +110,11 @@ - To be added. - To be added. - To be added. - To be added. + The first object of type to compare. + The second object of type to compare. + Determines whether the specified objects are equal. + + if the specified objects are equal; otherwise, . To be added. @@ -130,9 +145,9 @@ - To be added. - To be added. - To be added. + The for which a hash code is to be returned. + Returns a hash code for the specified object. + A hash code for the specified object. To be added. diff --git a/xml/Microsoft.Extensions.Primitives/StringTokenizer+Enumerator.xml b/xml/Microsoft.Extensions.Primitives/StringTokenizer+Enumerator.xml index 42ada1bb8d6..5fa588fbbec 100644 --- a/xml/Microsoft.Extensions.Primitives/StringTokenizer+Enumerator.xml +++ b/xml/Microsoft.Extensions.Primitives/StringTokenizer+Enumerator.xml @@ -1,4 +1,4 @@ - + @@ -94,8 +94,8 @@ Microsoft.Extensions.Primitives.StringSegment - To be added. - To be added. + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. To be added. @@ -126,7 +126,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. @@ -157,8 +157,9 @@ - To be added. - To be added. + Advances the enumerator to the next element of the collection. + + if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. To be added. @@ -189,7 +190,7 @@ - To be added. + Sets the enumerator to its initial position, which is before the first element in the collection. To be added. @@ -219,9 +220,17 @@ System.Object - To be added. - To be added. - To be added. + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. + + instance is cast to an interface. + + ]]> + diff --git a/xml/Microsoft.Extensions.Primitives/StringTokenizer.xml b/xml/Microsoft.Extensions.Primitives/StringTokenizer.xml index b2ab134995d..56111e79187 100644 --- a/xml/Microsoft.Extensions.Primitives/StringTokenizer.xml +++ b/xml/Microsoft.Extensions.Primitives/StringTokenizer.xml @@ -1,4 +1,4 @@ - + @@ -151,8 +151,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. To be added. @@ -183,9 +183,17 @@ - To be added. - To be added. - To be added. + Returns an enumerator that iterates through a collection. + An object that can be used to iterate through the collection. + + instance is cast to an interface. + + ]]> + diff --git a/xml/Microsoft.Extensions.Primitives/StringValues+Enumerator.xml b/xml/Microsoft.Extensions.Primitives/StringValues+Enumerator.xml index e574664df42..4f408473574 100644 --- a/xml/Microsoft.Extensions.Primitives/StringValues+Enumerator.xml +++ b/xml/Microsoft.Extensions.Primitives/StringValues+Enumerator.xml @@ -1,4 +1,4 @@ - + @@ -31,7 +31,7 @@ - To be added. + Enumerates the string values of a . To be added. @@ -89,8 +89,8 @@ System.String - To be added. - To be added. + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. To be added. @@ -119,7 +119,7 @@ - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. To be added. @@ -150,8 +150,9 @@ - To be added. - To be added. + Advances the enumerator to the next element of the collection. + + if the enumerator was successfully advanced to the next element; if the enumerator has passed the end of the collection. To be added. @@ -181,9 +182,17 @@ System.Object - To be added. - To be added. - To be added. + Gets the element in the collection at the current position of the enumerator. + The element in the collection at the current position of the enumerator. + + instance is cast to an interface. + + ]]> + @@ -213,8 +222,16 @@ - To be added. - To be added. + Sets the enumerator to its initial position, which is before the first element in the collection. + + instance is cast to an interface. + + ]]> + @@ -238,8 +255,16 @@ - To be added. - To be added. + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + instance is cast to an interface. + + ]]> + diff --git a/xml/Microsoft.Extensions.Primitives/StringValues.xml b/xml/Microsoft.Extensions.Primitives/StringValues.xml index 697584dc92a..3a417931726 100644 --- a/xml/Microsoft.Extensions.Primitives/StringValues.xml +++ b/xml/Microsoft.Extensions.Primitives/StringValues.xml @@ -1,4 +1,4 @@ - + @@ -91,8 +91,8 @@ - To be added. - To be added. + A string value or . + Initializes a new instance of the structure using the specified string. To be added. @@ -119,8 +119,8 @@ - To be added. - To be added. + A string array. + Initializes a new instance of the structure using the specified array of strings. To be added. @@ -151,10 +151,10 @@ - To be added. - To be added. - To be added. - To be added. + The first to concatenate. + The second to concatenate. + Concatenates two specified instances of . + The concatenation of and . To be added. @@ -182,10 +182,10 @@ - To be added. - To be added. - To be added. - To be added. + The to concatenate. + The string to concatenate. + Concatenates specified instance of with specified . + The concatenation of and . To be added. @@ -213,10 +213,10 @@ - To be added. - To be added. - To be added. - To be added. + The string to concatenate. + The to concatenate. + Concatenates specified instance of with specified . + The concatenation of and . To be added. @@ -247,8 +247,8 @@ System.Int32 - To be added. - To be added. + Gets the number of string elements contained in this . + The number of string elements contained in this . To be added. @@ -275,8 +275,16 @@ Microsoft.Extensions.Primitives.StringValues - To be added. - To be added. + A readonly instance of the struct whose value is an empty string array. + + that has `null` string values. + + ]]> + @@ -308,9 +316,10 @@ - To be added. - To be added. - To be added. + The string to compare to this instance. + Determines whether this instance and another specified object have the same values. + + if the value of is the same as the value of this instance; otherwise, . To be added. @@ -340,9 +349,10 @@ - To be added. - To be added. - To be added. + An object to compare with this object. + Determines whether this instance and a specified object have the same value. + + if the current object is equal to ; otherwise, . To be added. @@ -375,9 +385,10 @@ - To be added. - To be added. - To be added. + The string to compare to this instance. + Determines whether this instance and a specified string have the same value. + + if the value of is the same as this instance; otherwise, . If is , returns . To be added. @@ -410,9 +421,10 @@ - To be added. - To be added. - To be added. + The string array to compare to this instance. + Determines whether this instance and a specified string array have the same values. + + if the value of is the same as this instance; otherwise, . To be added. @@ -443,10 +455,11 @@ - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two specified objects have the same values in the same order. + + if the value of is the same as the value of ; otherwise, . To be added. @@ -477,10 +490,11 @@ - To be added. - To be added. - To be added. - To be added. + The to compare. + The to compare. + Determines whether the specified and objects have the same values. + + if the value of is the same as the value of ; otherwise, . If is , the method returns . To be added. @@ -511,10 +525,11 @@ - To be added. - To be added. - To be added. - To be added. + The to compare. + The string array to compare. + Determines whether the specified and string array objects have the same values. + + if the value of is the same as the value of ; otherwise, . To be added. @@ -545,10 +560,11 @@ - To be added. - To be added. - To be added. - To be added. + The string to compare. + The to compare. + Determines whether the specified and objects have the same values. + + if the value of is the same as the value of ; otherwise, . If is , the method returns . To be added. @@ -579,10 +595,11 @@ - To be added. - To be added. - To be added. - To be added. + The string array to compare. + The to compare. + Determines whether the specified string array and objects have the same values. + + if the value of is the same as the value of ; otherwise, . To be added. @@ -610,8 +627,8 @@ - To be added. - To be added. + Retrieves an object that can iterate through the individual strings in this . + An enumerator that can be used to iterate through the . To be added. @@ -670,9 +687,10 @@ - To be added. - To be added. - To be added. + The to test. + Indicates whether the specified contains no string values. + + if value contains a single string or empty array; otherwise, . To be added. @@ -705,9 +723,9 @@ - To be added. - To be added. - To be added. + The zero-based index of the element to get. + Gets the string at index. + The string at the specified index. To be added. @@ -738,10 +756,11 @@ - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two specified have the same values. + + if the value of is the same as the value of ; otherwise, . To be added. @@ -772,10 +791,11 @@ - To be added. - To be added. - To be added. - To be added. + The to compare. + The to compare. + Determines whether the specified and , which must be a , , or array of , have the same value. + + if the object is equal to the ; otherwise, . To be added. @@ -874,10 +894,11 @@ - To be added. - To be added. - To be added. - To be added. + The to compare. + The to compare. + Determines whether the specified , which must be a , , or array of , and specified , have the same value. + + if the object is equal to the ; otherwise, . To be added. @@ -975,9 +996,9 @@ - To be added. - To be added. - To be added. + A to implicitly convert. + Defines an implicit conversion of a given to a string, with multiple values joined as a comma separated string. + Returns where has been initialized from an empty string array or is . Otherwise, it returns the implicit conversion of to a string. To be added. @@ -1007,8 +1028,8 @@ - To be added. - To be added. + A to implicitly convert. + Defines an implicit conversion of a given to a string array. To be added. To be added. @@ -1039,8 +1060,8 @@ - To be added. - To be added. + A string to implicitly convert. + Defines an implicit conversion of a given string to a . To be added. To be added. @@ -1071,8 +1092,8 @@ - To be added. - To be added. + A string array to implicitly convert. + Defines an implicit conversion of a given string array to a . To be added. To be added. @@ -1104,10 +1125,11 @@ - To be added. - To be added. - To be added. - To be added. + The first to compare. + The second to compare. + Determines whether two specified have different values. + + if the value of is different to the value of ; otherwise, . To be added. @@ -1138,10 +1160,11 @@ - To be added. - To be added. - To be added. - To be added. + The to compare. + The to compare. + Determines whether the specified and , which must be a , , or array of , have different values. + + if the object is equal to the ; otherwise, . To be added. @@ -1172,10 +1195,11 @@ - To be added. - To be added. - To be added. - To be added. + The to compare. + The to compare. + Determines whether the specified and objects have different values. + + if the value of is different to the value of ; otherwise, . To be added. @@ -1206,10 +1230,11 @@ - To be added. - To be added. - To be added. - To be added. + The to compare. + The string array to compare. + Determines whether the specified and string array have different values. + + if the value of is different to the value of ; otherwise, . To be added. @@ -1240,10 +1265,11 @@ - To be added. - To be added. - To be added. - To be added. + The to compare. + The to compare. + Determines whether the specified and object have the same values. + + if the object is equal to the ; otherwise, . To be added. @@ -1274,10 +1300,11 @@ - To be added. - To be added. - To be added. - To be added. + The string to compare. + The to compare. + Determines whether the specified and objects have different values. + + if the value of is different to the value of ; otherwise, . To be added. @@ -1308,10 +1335,11 @@ - To be added. - To be added. - To be added. - To be added. + The string array to compare. + The to compare. + Determines whether the specified string array and have different values. + + if the value of is different to the value of ; otherwise, . To be added. @@ -1344,8 +1372,8 @@ - To be added. - To be added. + The object to add to the collection. + Adds an item to the collection. To be added. @@ -1376,7 +1404,7 @@ - To be added. + Removes all items from the collection. To be added. @@ -1409,9 +1437,10 @@ - To be added. - To be added. - To be added. + The string to locate in the . + Determines whether a string is in the . + + if is found in the ; otherwise, . To be added. @@ -1445,9 +1474,9 @@ - To be added. - To be added. - To be added. + The one-dimensional that is the destination of the elements copied from. The must have zero-based indexing. + The zero-based index in the destination array at which copying begins. + Copies the entire to a string array, starting at the specified index of the target array. To be added. @@ -1477,8 +1506,9 @@ System.Boolean - To be added. - To be added. + Gets a value indicating whether the collection is read-only. + + if the collection is read-only; otherwise, . To be added. @@ -1511,9 +1541,10 @@ - To be added. - To be added. - To be added. + The object to remove from the collection. + Removes the first occurrence of a specific object from the collection. + + if was successfully removed from the collection; otherwise, . This method also returns if is not found in the original collection. To be added. @@ -1544,8 +1575,8 @@ - To be added. - To be added. + Returns an enumerator that iterates through the collection. + An enumerator that can be used to iterate through the collection. To be added. @@ -1578,9 +1609,9 @@ - To be added. - To be added. - To be added. + The string to locate in the . + Returns the zero-based index of the first occurrence of an item in the . + the zero-based index of the first occurrence of within the , if found; otherwise, –1. To be added. @@ -1614,9 +1645,9 @@ - To be added. - To be added. - To be added. + The zero-based index at which should be inserted. + The object to insert into the . + Inserts an item to the at the specified index. To be added. @@ -1649,9 +1680,9 @@ - To be added. - To be added. - To be added. + The zero-based index of the element to get. + Gets the at index. + The string at the specified index. To be added. @@ -1684,8 +1715,8 @@ - To be added. - To be added. + The zero-based index of the item to remove. + Removes the item at the specified index. To be added. @@ -1716,9 +1747,17 @@ - To be added. - To be added. - To be added. + Returns an enumerator that iterates through a collection. + An object that can be used to iterate through the collection. + + instance is cast to an interface. + + ]]> + @@ -1745,9 +1784,17 @@ - To be added. - To be added. - To be added. + Creates a string array from the current object. + A string array represented by this instance. + + contains a single string internally, it is copied to a new array.If the contains an array internally it returns that array instance. + + ]]> + @@ -1774,8 +1821,8 @@ - To be added. - To be added. + Converts the value of the current object to its equivalent string representation, with multiple values joined as a comma separated string. + A string representation of the value of the current object. To be added. diff --git a/xml/System.Data.SqlClient/SqlColumnEncryptionCertificateStoreProvider.xml b/xml/System.Data.SqlClient/SqlColumnEncryptionCertificateStoreProvider.xml index 447f6fc067a..08bdd2995a6 100644 --- a/xml/System.Data.SqlClient/SqlColumnEncryptionCertificateStoreProvider.xml +++ b/xml/System.Data.SqlClient/SqlColumnEncryptionCertificateStoreProvider.xml @@ -20,8 +20,8 @@ The implementation of the key store provider for Windows Certificate Store. This class enables using certificates stored in the Windows Certificate Store as column master keys. For details, see Always Encrypted. To be added. - Always Encrypted (blog posts) - Always Encrypted (client development) + Get started with Always Encrypted (blog post) + Develop apps using Always Encrypted diff --git a/xml/System.Data.SqlClient/SqlColumnEncryptionCngProvider.xml b/xml/System.Data.SqlClient/SqlColumnEncryptionCngProvider.xml index 4fbb9a0ddde..8dde7ae863c 100644 --- a/xml/System.Data.SqlClient/SqlColumnEncryptionCngProvider.xml +++ b/xml/System.Data.SqlClient/SqlColumnEncryptionCngProvider.xml @@ -23,8 +23,8 @@ ]]> - Always Encrypted (blog posts) - Always Encrypted (client development) + Get started with Always Encrypted (blog post) + Develop apps using Always Encrypted diff --git a/xml/System.Data.SqlClient/SqlColumnEncryptionCspProvider.xml b/xml/System.Data.SqlClient/SqlColumnEncryptionCspProvider.xml index da588583e90..944e9bb75f8 100644 --- a/xml/System.Data.SqlClient/SqlColumnEncryptionCspProvider.xml +++ b/xml/System.Data.SqlClient/SqlColumnEncryptionCspProvider.xml @@ -23,8 +23,8 @@ ]]> - Always Encrypted (blog posts) - Always Encrypted (client development) + Get started with Always Encrypted (blog post) + Develop apps using Always Encrypted diff --git a/xml/System.Data.SqlClient/SqlColumnEncryptionKeyStoreProvider.xml b/xml/System.Data.SqlClient/SqlColumnEncryptionKeyStoreProvider.xml index ae695a1696e..3b190e75b6e 100644 --- a/xml/System.Data.SqlClient/SqlColumnEncryptionKeyStoreProvider.xml +++ b/xml/System.Data.SqlClient/SqlColumnEncryptionKeyStoreProvider.xml @@ -16,8 +16,8 @@ Base class for all key store providers. A custom provider must derive from this class and override its member functions and then register it using SqlConnection.RegisterColumnEncryptionKeyStoreProviders(). For details see, Always Encrypted. To be added. - Always Encrypted (blog posts) - Always Encrypted (client development) + Get started with Always Encrypted (blog post) + Develop apps using Always Encrypted diff --git a/xml/System.Net/HttpListenerRequest.xml b/xml/System.Net/HttpListenerRequest.xml index b4d0c59d039..85773cb99d0 100644 --- a/xml/System.Net/HttpListenerRequest.xml +++ b/xml/System.Net/HttpListenerRequest.xml @@ -1203,9 +1203,7 @@ In a URL, the query information is separated from the path information by a question mark (?). Name/value pairs are separated by an equals sign (=). To access the query data as a single string, get the property value from the object returned by . > [!NOTE] -> Queries without an equal sign (example: [http://www.contoso.com/query.htm?Name](http://www.contoso.com/query.htm?Name) ) are added to the `null` key in the . - - +> Queries without an equals sign (for example, `http://www.contoso.com/query.htm?Name`) are added to the `null` key in the . ## Examples The following code example demonstrates using the property. diff --git a/xml/System.Reflection.Metadata.Ecma335/MetadataBuilder.xml b/xml/System.Reflection.Metadata.Ecma335/MetadataBuilder.xml index 684d5c04f7a..0005a95cc52 100644 --- a/xml/System.Reflection.Metadata.Ecma335/MetadataBuilder.xml +++ b/xml/System.Reflection.Metadata.Ecma335/MetadataBuilder.xml @@ -372,11 +372,11 @@ Entries may be added in any order. The table is automatically sorted when serial ## Remarks -For more information about `name`, see . +For more information about `name`, see . -For more information about common values for `hashAlgorithm`, see . +For more information about common values for `hashAlgorithm`, see . -For more information about common values for `language`, see . +For more information about common values for `language`, see . ]]> @@ -778,7 +778,7 @@ Constraints must be added in the same order as the corresponding generic paramet ## Remarks -For more information about `imports`, see . +For more information about `imports`, see . ]]> @@ -860,7 +860,7 @@ If a type implements multiple interfaces, the corresponding entries must be adde ## Remarks -For more information about `signature`, see: [LocalConstantSig Blob](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#localconstantsig-blob) on GitHub. +For more information about `signature`, see: [LocalConstantSig Blob](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#localconstantsig-blob) on GitHub. ]]> @@ -1093,7 +1093,7 @@ Entries may be added in any order. The table is automatically sorted when serial ## Remarks -For more information about `sequencePoints`, see: [Sequence Points Blob](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#sequence-points-blob) on GitHub. +For more information about `sequencePoints`, see: [Sequence Points Blob](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#sequence-points-blob) on GitHub. ]]> @@ -1931,7 +1931,7 @@ Entires must be added in the same order as the corresponding type definitions. ## Remarks -For more information about document name blobs, see: https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#DocumentNameBlob +For more information about document name blobs, see: https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#DocumentNameBlob ]]> diff --git a/xml/System.Reflection.Metadata/Document.xml b/xml/System.Reflection.Metadata/Document.xml index 3b84b986f76..a7a735c487e 100644 --- a/xml/System.Reflection.Metadata/Document.xml +++ b/xml/System.Reflection.Metadata/Document.xml @@ -31,7 +31,7 @@ ## Remarks -For more information, see [Portable PDB v1.0: Format Specification](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#document-table-0x30). +For more information, see [Portable PDB v1.0: Format Specification](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#document-table-0x30). ]]> diff --git a/xml/System.Reflection.Metadata/ImportScope.xml b/xml/System.Reflection.Metadata/ImportScope.xml index 3591b92d9ef..e13d7552a27 100644 --- a/xml/System.Reflection.Metadata/ImportScope.xml +++ b/xml/System.Reflection.Metadata/ImportScope.xml @@ -31,7 +31,7 @@ ## Remarks -See [ImportScope Table" 0x35](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#importscope-table-0x35) for more information. +See [ImportScope Table" 0x35](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#importscope-table-0x35) for more information. ]]> diff --git a/xml/System.Reflection.Metadata/LocalConstant.xml b/xml/System.Reflection.Metadata/LocalConstant.xml index 3bf156fc0f0..d083b62b3a2 100644 --- a/xml/System.Reflection.Metadata/LocalConstant.xml +++ b/xml/System.Reflection.Metadata/LocalConstant.xml @@ -31,7 +31,7 @@ ## Remarks -See [LocalConstant Table: 0x34](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#localconstant-table-0x34). +See [LocalConstant Table: 0x34](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#localconstant-table-0x34). ]]> diff --git a/xml/System.Reflection.Metadata/LocalScope.xml b/xml/System.Reflection.Metadata/LocalScope.xml index b23df890b4f..905df7707b1 100644 --- a/xml/System.Reflection.Metadata/LocalScope.xml +++ b/xml/System.Reflection.Metadata/LocalScope.xml @@ -31,7 +31,7 @@ ## Remarks -See [LocalScope Table: 0x32](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#localscope-table-0x32). +See [LocalScope Table: 0x32](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#localscope-table-0x32). ]]> diff --git a/xml/System.Reflection.Metadata/LocalVariable.xml b/xml/System.Reflection.Metadata/LocalVariable.xml index 6ace820e4af..c4879c9890a 100644 --- a/xml/System.Reflection.Metadata/LocalVariable.xml +++ b/xml/System.Reflection.Metadata/LocalVariable.xml @@ -31,7 +31,7 @@ ## Remarks -See [LocalVariable Table: 0x33](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#localvariable-table-0x33) for more information. +See [LocalVariable Table: 0x33](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#localvariable-table-0x33) for more information. ]]> diff --git a/xml/System.Reflection.Metadata/MethodDebugInformation.xml b/xml/System.Reflection.Metadata/MethodDebugInformation.xml index f754d58f126..55de1e915e3 100644 --- a/xml/System.Reflection.Metadata/MethodDebugInformation.xml +++ b/xml/System.Reflection.Metadata/MethodDebugInformation.xml @@ -31,7 +31,7 @@ ## Remarks -See [MethodDebugInformation Table: 0x31](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#methoddebuginformation-table-0x31). +See [MethodDebugInformation Table: 0x31](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PortablePdb-Metadata.md#methoddebuginformation-table-0x31). ]]> diff --git a/xml/System.Reflection.PortableExecutable/DebugDirectoryEntryType.xml b/xml/System.Reflection.PortableExecutable/DebugDirectoryEntryType.xml index 959cd532a89..c7cd9621078 100644 --- a/xml/System.Reflection.PortableExecutable/DebugDirectoryEntryType.xml +++ b/xml/System.Reflection.PortableExecutable/DebugDirectoryEntryType.xml @@ -29,10 +29,10 @@ See the following for the specifications related to individual enumeration membe |Member|Specification| |---|---| -|`CodeView`|[CodeView Debug Directory Entry (type 2)](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PE-COFF.md#codeview-debug-directory-entry-type-2)| -|`EmbeddedPortablePdb`|[Embedded Portale PDB Debu Directory Entry (type 17)](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PE-COFF.md#embedded-portable-pdb-debug-directory-entry-type-17)| -|`PdbChecksum`|[PDB Checksum Debug Directory Entry (type 19)](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PE-COFF.md#pdb-checksum-debug-directory-entry-type-19)| -|`Reproducible`|See [Deterministic Debug Directory Entry (type 16)](https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PE-COFF.md#deterministic-debug-directory-entry-type-16)| +|`CodeView`|[CodeView Debug Directory Entry (type 2)](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PE-COFF.md#codeview-debug-directory-entry-type-2)| +|`EmbeddedPortablePdb`|[Embedded Portale PDB Debu Directory Entry (type 17)](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PE-COFF.md#embedded-portable-pdb-debug-directory-entry-type-17)| +|`PdbChecksum`|[PDB Checksum Debug Directory Entry (type 19)](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PE-COFF.md#pdb-checksum-debug-directory-entry-type-19)| +|`Reproducible`|See [Deterministic Debug Directory Entry (type 16)](https://github.com/dotnet/runtime/blob/master/docs/design/specs/PE-COFF.md#deterministic-debug-directory-entry-type-16)| ### DebugDirectoryEntryType.Reproducible @@ -75,7 +75,7 @@ The debug directory entry of type @@ -145,7 +145,7 @@ The Embedded Portable PDB blob has the following format: blob ::= uncompressed-size data Data spans the remainder of the blob and contains a Deflate-compressed Portable PDB. - See https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PE-COFF.md#embedded-portable-pdb-debug-directory-entry-type-17 for specification. + See https://github.com/dotnet/runtime/blob/master/docs/design/specs/PE-COFF.md#embedded-portable-pdb-debug-directory-entry-type-17 for specification. ]]> @@ -180,7 +180,7 @@ The Embedded Portable PDB blob has the following format: The hash can be used to validate that a given PDB file was built with the PE/COFF file and not altered in any way. More than one entry can be present, in case multiple PDBs were produced during the build of the PE/COFF file (e.g. private and public symbols). - See https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PE-COFF.md#pdb-checksum-debug-directory-entry-type-19 for specification. + See https://github.com/dotnet/runtime/blob/master/docs/design/specs/PE-COFF.md#pdb-checksum-debug-directory-entry-type-19 for specification. ]]> @@ -219,7 +219,7 @@ The hash can be used to validate that a given PDB file was built with the PE/COF The value of field TimeDateStamp in COFF File Header of a deterministic PE/COFF file does not indicate the date and time when the file was produced and should not be interpreted that way. Instead the value of the field is derived from a hash of the file content. The algorithm to calculate this value is an implementation detail of the tool that produced the file. The debug directory entry of type must have all fields, except for Type zeroed. - See https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PE-COFF.md#deterministic-debug-directory-entry-type-16 for specification. + See https://github.com/dotnet/runtime/blob/master/docs/design/specs/PE-COFF.md#deterministic-debug-directory-entry-type-16 for specification. ]]> diff --git a/xml/System.Reflection.PortableExecutable/PdbChecksumDebugDirectoryData.xml b/xml/System.Reflection.PortableExecutable/PdbChecksumDebugDirectoryData.xml index 62c6f45acdf..0436aa128ba 100644 --- a/xml/System.Reflection.PortableExecutable/PdbChecksumDebugDirectoryData.xml +++ b/xml/System.Reflection.PortableExecutable/PdbChecksumDebugDirectoryData.xml @@ -28,7 +28,7 @@ ## Remarks -For more information, see: https://github.com/dotnet/runtime/blob/master/src/libraries/System.Reflection.Metadata/specs/PE-COFF.md#pdb-checksum-debug-directory-entry-type-19 +For more information, see: https://github.com/dotnet/runtime/blob/master/docs/design/specs/PE-COFF.md#pdb-checksum-debug-directory-entry-type-19 ]]> diff --git a/xml/System.Runtime.CompilerServices/INotifyCompletion.xml b/xml/System.Runtime.CompilerServices/INotifyCompletion.xml index 07d9d4f8717..d2a3c89bc1d 100644 --- a/xml/System.Runtime.CompilerServices/INotifyCompletion.xml +++ b/xml/System.Runtime.CompilerServices/INotifyCompletion.xml @@ -40,7 +40,7 @@ Represents an operation that schedules continuations when it completes. To be added. - What's New for Parallelism in .NET 4.5 + What's New for Parallelism in .NET 4.5 diff --git a/xml/System.Windows.Controls.Primitives/CustomPopupPlacementCallback.xml b/xml/System.Windows.Controls.Primitives/CustomPopupPlacementCallback.xml index c94109aa95e..157984746cb 100644 --- a/xml/System.Windows.Controls.Primitives/CustomPopupPlacementCallback.xml +++ b/xml/System.Windows.Controls.Primitives/CustomPopupPlacementCallback.xml @@ -41,6 +41,6 @@ - Popup Placement Sample + Popup Placement Sample diff --git a/xml/System.Windows.Controls.Primitives/Popup.xml b/xml/System.Windows.Controls.Primitives/Popup.xml index b73d3763c62..25d6afe0fd1 100644 --- a/xml/System.Windows.Controls.Primitives/Popup.xml +++ b/xml/System.Windows.Controls.Primitives/Popup.xml @@ -1138,9 +1138,7 @@ ||| |-|-| |Identifier field|| -|Metadata properties set to `true`|None| - - +|Metadata properties set to `true`|None| ## Examples The following example sets the property of a . The , , , and properties of the are 50, 50, 50, and 100, respectively. The is relative to the bounds of the property. Note that the property does not create a visible element in the application; the example creates a with the same bounds to represent the . @@ -1153,7 +1151,7 @@ - Popup Placement Sample + Popup Placement Sample diff --git a/xml/System.Windows.Controls/ContextMenu.xml b/xml/System.Windows.Controls/ContextMenu.xml index 1a2109b21a4..fafed50f974 100644 --- a/xml/System.Windows.Controls/ContextMenu.xml +++ b/xml/System.Windows.Controls/ContextMenu.xml @@ -195,8 +195,8 @@ The delegate returns an array of possible points that are defined with respect to the . When the context menu is displayed, a point is chosen that maximizes the amount of the window that is visible. - The behavior is the same as it is for the popup. For more information, see [How to: Specify a Custom Popup Position](~/docs/framework/wpf/controls/how-to-specify-a-custom-popup-position.md) and [Popup Placement Sample](https://go.microsoft.com/fwlink/?LinkID=160032). - + The behavior is the same as it is for the popup. For more information, see [How to: Specify a Custom Popup Position](~/docs/framework/wpf/controls/how-to-specify-a-custom-popup-position.md) and [Popup Placement Sample](https://github.com/dotnet/dotnet-api-docs/tree/master/samples/snippets/csharp/VS_Snippets_Wpf/PopupPositionSnippet/CS). + ## Dependency Property Information diff --git a/xml/System.Windows.Controls/ToolTip.xml b/xml/System.Windows.Controls/ToolTip.xml index 637849b8c7b..eb6a6e031a9 100644 --- a/xml/System.Windows.Controls/ToolTip.xml +++ b/xml/System.Windows.Controls/ToolTip.xml @@ -210,12 +210,10 @@ ||| |-|-| |Identifier field|| -|Metadata properties set to `true`|None| - - +|Metadata properties set to `true`|None| ## Examples - The following example shows how to set the property and create the corresponding delegate. The same technique is used to by the , which is demonstrated in the [Popup Placement Sample](https://go.microsoft.com/fwlink/?LinkID=160032). + The following example shows how to set the property and create the corresponding delegate. The same technique is used to by the , which is demonstrated in the [Popup Placement Sample](https://github.com/dotnet/dotnet-api-docs/tree/master/samples/snippets/csharp/VS_Snippets_Wpf/PopupPositionSnippet/CS). [!code-csharp[ToolTipCustom#CustomPopupPlacementCallback](~/samples/snippets/csharp/VS_Snippets_Wpf/ToolTipCustom/CSharp/Pane1.xaml.cs#custompopupplacementcallback)] [!code-vb[ToolTipCustom#CustomPopupPlacementCallback](~/samples/snippets/visualbasic/VS_Snippets_Wpf/ToolTipCustom/visualbasic/pane1.xaml.vb#custompopupplacementcallback)] diff --git a/xml/System.Windows.Forms/Control+ControlCollection.xml b/xml/System.Windows.Forms/Control+ControlCollection.xml index 3d40f4da453..17ea7a8fff8 100644 --- a/xml/System.Windows.Forms/Control+ControlCollection.xml +++ b/xml/System.Windows.Forms/Control+ControlCollection.xml @@ -93,6 +93,7 @@ A representing the control that owns the control collection. Initializes a new instance of the class. To be added. + .NET 5.0 and later: The argument is . diff --git a/xml/System.Windows.Forms/DataGridViewComboBoxEditingControl.xml b/xml/System.Windows.Forms/DataGridViewComboBoxEditingControl.xml index b66fbeb27c4..7d9cf606c56 100644 --- a/xml/System.Windows.Forms/DataGridViewComboBoxEditingControl.xml +++ b/xml/System.Windows.Forms/DataGridViewComboBoxEditingControl.xml @@ -125,6 +125,7 @@ ]]> + .NET 5.0 and later: The argument is . diff --git a/xml/System.Windows.Forms/PictureBox.xml b/xml/System.Windows.Forms/PictureBox.xml index f59e5141356..4a731719470 100644 --- a/xml/System.Windows.Forms/PictureBox.xml +++ b/xml/System.Windows.Forms/PictureBox.xml @@ -66,9 +66,7 @@ The property, which is set to values in the enumeration, controls the clipping and positioning of the image in the display area. You can change the size of the display area at run time with the property. - By default, the control is displayed by without any borders. You can provide a standard or three-dimensional border using the property to distinguish the picture box from the rest of the form, even if it contains no image. The is not a selectable control, which means that it cannot receive input focus. - - + By default, the control is displayed by without any borders. You can provide a standard or three-dimensional border using the property to distinguish the picture box from the rest of the form, even if it contains no image. The is not a selectable control, which means that it cannot receive input focus. ## Examples The following code example illustrates how you can set an image and resize the display area of the picture box. This example requires that `ShowMyImage` is called in an existing form, and that the namespace has been added to the source code for your form. @@ -109,9 +107,7 @@ |Item|Description| |----------|-----------------| ||`null`| -||| - - +||| ## Examples The following code example demonstrates the use of the and controls. The is initialized by setting the and properties using the and enumerations, respectively. The is populated with pictures from the Sample Pictures directory. The method is used when handling the event of the control to determine whether an item is selected. If an item is selected, the event handler displays the selected file by setting the property. The example requires that you have JPG files located in the C:\Documents and Settings\All Users\Documents\My Pictures\Sample Pictures directory. To run the example, paste the code into a form and call the `InitializePictureBox` and `PopulateListView` methods in the form's constructor or event-handling method. Ensure all events are associated with their event-handling methods. @@ -194,9 +190,7 @@ and controls. The is initialized by setting the and properties using the and enumerations, respectively. The is populated with pictures from the Sample Pictures directory. The method is used in when handling the event of the control to determine whether an item is selected. If an item is selected, the event handler displays the selected file by setting the property. The example requires that you have JPG files located in the C:\Documents and Settings\All Users\Documents\My Pictures\Sample Pictures directory. To run this example, paste the code into a form and call the `InitializePictureBox` and `PopulateListView` methods in the form's constructor or event-handling method. Ensure all events are associated with their event-handling methods. @@ -235,9 +229,7 @@ image is loaded asynchronously when the property is `false` and the method is used to load the image. If a load is canceled with the method cancellation is reported by raising the event with the property of the set to `true`. - - + A image is loaded asynchronously when the property is `false` and the method is used to load the image. If a load is canceled with the method cancellation is reported by raising the event with the property of the set to `true`. ## Examples The following code example demonstrates how to use the method. To run this example, paste the following code into a Windows Form that contains a named `pictureBox1` and two controls named `startLoadButton` and `cancelLoadButton`. Make sure that the event for the buttons is associated with their event-handling method in this example. You must change the image file path to a path that is valid on your system. @@ -692,9 +684,7 @@ The property is set to the to display. You can do this either at design time or at run time. > [!NOTE] -> If you want to use the same image in multiple controls, create a clone of the image for each . Accessing the same image from multiple controls causes an exception to occur. - - +> If you want to use the same image in multiple controls, create a clone of the image for each . Accessing the same image from multiple controls causes an exception to occur. ## Examples The following code example demonstrates how to create a bitmap at runtime and display it in a by setting the property. To run this example, paste it into a Windows Form and call `CreateBitmapAtRuntime` from the form's constructor. @@ -745,7 +735,7 @@ method sets the property to the value of `url`. + If the `url` parameter indicates a local file, the recommended format is a local file path. For example, an image file named myPicture.jpglocated atc:\ would be accessed by passing **c:\myPicture.jpg** for the `url` parameter. A full path, such as `http://www.contoso.com/path/images/image.jpg`, or a relative path, such as **./images/image.jpg**, can be used. If a relative path is used, it will be considered relative to the working directory. A call to the method sets the property to the value of `url`. ]]> @@ -1158,11 +1148,9 @@ method sets the property to the value of `url`. + If the `url` parameter indicates a local file, the recommended format is a local file path. For example, an image file named myPicture.jpglocated atc:\ would be accessed by passing **c:\myPicture.jpg** for the `url` parameter. A full path, such as `http://www.contoso.com/path/images/image.jpg`, or a relative path, such as **./images/image.jpg**, can be used. If a relative path is used, it will be considered relative to the working directory. A call to the method sets the property to the value of `url`. - A call to the method sets the property to the value of `url`. Besides calling the method, you must set the property to `false` to load an image asynchronously. When you load an image asynchronously, you can handle the event to determine the progress of an image load or the event to determine when an image load has completed. If an error occurs during an asynchronous image-loading operation, it will be caught and reported by the property of the . - - + A call to the method sets the property to the value of `url`. Besides calling the method, you must set the property to `false` to load an image asynchronously. When you load an image asynchronously, you can handle the event to determine the progress of an image load or the event to determine when an image load has completed. If an error occurs during an asynchronous image-loading operation, it will be caught and reported by the property of the . ## Examples The following code example demonstrates how to use the method. To run this example, paste the following code into a Windows Form that contains a named `pictureBox1` and a named `startLoadButton`. Make sure that the event for the button is associated with the `startLoadButton_Click` method in this example. You must change the image file path to a path that is valid on your system. @@ -1199,9 +1187,7 @@ ## Remarks The occurs only when the image is loaded asynchronously by using one of the methods, and is `false`. If the image-load is canceled by calling the method the property of the will be set to `true`. If an exception or error occurs during the load process, it will be caught and the property of the will contain the exception information. - For more information about handling events, see [Handling and Raising Events](~/docs/standard/events/index.md). - - + For more information about handling events, see [Handling and Raising Events](~/docs/standard/events/index.md). ## Examples The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the 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 . @@ -1242,9 +1228,7 @@ Handle the if you want to reflect the progress of an asynchronous image-loading operation in a or similar control. Use the property of the to update the progress value. - For more information about handling events, see [Handling and Raising Events](~/docs/standard/events/index.md). - - + For more information about handling events, see [Handling and Raising Events](~/docs/standard/events/index.md). ## Examples The following code example demonstrates how to handle the event. To run this example, paste the following code into a Windows Form that contains a named `pictureBox1`, a named `startLoadButton`, and a named `progressBar1`. Make sure that the `startLoadButton_Click` method is associated with the event for the button and the `pictureBox1_LoadProgressChanged` method is associated with the event for `pictureBox1`. You must change the image file path to a path that is valid on your system. @@ -1763,9 +1747,7 @@ By default, in mode, the is positioned in the upper-left corner of the , and any part of the image that is too big for the is clipped. Using the value causes the image to stretch or shrink to fit the . Using the value causes the image to be stretched or shrunk to fit the ; however, the aspect ratio in the original is maintained. - Using the value causes the control to resize to always fit the image. Using the value causes the image to be centered in the client area. - - + Using the value causes the control to resize to always fit the image. Using the value causes the image to be centered in the client area. ## Examples The following code example demonstrates the use of the property. To run this example, paste the following code into a Windows Form and call the `InitializePictureBoxAndButton` method from the form's constructor or Load-event handling method. @@ -1804,9 +1786,7 @@ 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 . @@ -2181,9 +2161,7 @@ property to `true` means the image is loaded synchronously. This causes the user interface to be blocked from other input until the image is loaded. When is `false` (the default) and the method is used to load the image, the image is displayed when the specified image is loaded, and the user can interact with the interface during the load process. - - + Setting the property to `true` means the image is loaded synchronously. This causes the user interface to be blocked from other input until the image is loaded. When is `false` (the default) and the method is used to load the image, the image is displayed when the specified image is loaded, and the user can interact with the interface during the load process. ## Examples The following code example demonstrates how to use the property. To run this example, paste the following code into a Windows Form that contains a named `pictureBox1` and a named `startLoadButton`. Make sure that the event for the button is associated with the `startLoadButton_Click` method in this example. You must change the image file path to one that is valid on your system. diff --git a/xml/System.Windows.Forms/RichTextBox.xml b/xml/System.Windows.Forms/RichTextBox.xml index 9829ca4c8c2..31420964f39 100644 --- a/xml/System.Windows.Forms/RichTextBox.xml +++ b/xml/System.Windows.Forms/RichTextBox.xml @@ -52,7 +52,7 @@ Applications that already use controls can easily be adapted to make use of controls. However, the control does not have the same 64K character capacity limit of the control. The is typically used to provide text manipulation and display features similar to word processing applications such as Microsoft Word. > [!NOTE] -> The method does not work with the or events. +> The method does not work with the or events. @@ -1063,7 +1063,7 @@ The method searches for the text specified in the `str` parameter and returns the location of the first character within the control. If the property returns a negative value, the text string being searched for was not found within the contents of the control. You can use this method to create search functionality that can be provided to the user of the control. You can also use this method to search for text to be replaced with a specific format. For example, if the user entered dates into the control, you could use the method to search for all dates in the document and replace them with the appropriate format before using the method of the control. > [!NOTE] -> The methods that accept a `string` as a parameter cannot find text that is contained on more than one line of text within the . Performing such a search will return a value of negative one (-1). +> The methods that accept a `string` as a parameter cannot find text that is contained on more than one line of text within the . Performing such a search will return a value of negative one (-1). @@ -1174,7 +1174,7 @@ With this version of the method, you can specify options that enable you to expand or narrow your search. You can specify options that enable you to match the casing of the search word or to search for entire words instead of partial words. By specifying the `RichTextBoxFinds.Reverse` enumeration in the `options` parameter, you can search for text from the bottom of the document to the top instead of the default top to bottom search method. > [!NOTE] -> The methods that accept a `string` as a parameter cannot find text that is contained on more than one line of text within the . Performing such a search will return a value of negative one (-1). +> The methods that accept a `string` as a parameter cannot find text that is contained on more than one line of text within the . Performing such a search will return a value of negative one (-1). @@ -1279,7 +1279,7 @@ With this version of the method, you can specify options that enable you to expand or narrow your search. You can specify options that enable you to match the casing of the search word or to search for entire words instead of partial words. By specifying the `RichTextBoxFinds.Reverse` enumeration in the `options` parameter, you can search for text from the bottom of the document to the top instead of the default top to bottom search method. This version of the method also enables you to narrow the search for text by selecting a specific starting position within the control's text. This feature can enable you to avoid text that might have already been searched or where the specific text you are searching for is known not to exist. When the `RichTextBoxFinds.Reverse` value is specified in the `options` parameter, the value of the `start` parameter indicates the position where the reverse search will end since the search will start at the bottom of the document when using this version of the method. > [!NOTE] -> The methods that accept a `string` as a parameter cannot find text that is contained on more than one line of text within the . Performing such a search will return a value of negative one (-1). +> The methods that accept a `string` as a parameter cannot find text that is contained on more than one line of text within the . Performing such a search will return a value of negative one (-1). @@ -1334,7 +1334,7 @@ With this version of the method, you can specify options that enable you to expand or narrow your search. You can specify options that enable you to match the casing of the search word or to search for entire words instead of partial words. By specifying the `RichTextBoxFinds.Reverse` enumeration in the `options` parameter, you can search for text from the bottom of the document to the top instead of the default top to bottom search method. This version of the method also enables you to narrow the search for text by selecting a specific start and end position within the control's text. This feature can enable you to limit the search range to a specific section of the control's text. If a value of negative one (-1) is assigned to the `end` parameter, the method will search until the end of the text in the for normal searches. For reverse searches, a value of negative one (-1) assigned to the `end` parameter indicates that text will be searched from the end of text (bottom) to the position defined by `start` parameter. When the `start` and `end` parameters are provided the same value the entire control is searched for normal searches. For a reverse search, the entire control is searched but the search begins at the bottom of the document and searches to the top of the document. > [!NOTE] -> The methods that accept a `string` as a parameter cannot find text that is contained on more than one line of text within the . Performing such a search will return a value of negative one (-1). +> The methods that accept a `string` as a parameter cannot find text that is contained on more than one line of text within the . Performing such a search will return a value of negative one (-1). @@ -1526,7 +1526,7 @@ The parameter was less the par In these cases, validate the input before calling . > [!NOTE] -> If the character index specified in the `index` parameter is beyond the available number of lines contained within the control, the last line number is returned. +> If the character index specified in the `index` parameter is beyond the available number of lines contained within the control, the last line number is returned. @@ -1761,7 +1761,7 @@ The parameter was less the par You can create an event handler for this event to process a link that has been clicked within the control. Using the information provided to the event handler, you can determine which link was clicked in the document. > [!IMPORTANT] -> By default, links are displayed as text and are not clickable. To make them clickable set the property to `true`. +> By default, links are displayed as text and are not clickable. To make them clickable set the property to `true`. For more information about how to handle events, see [Handling and Raising Events](~/docs/standard/events/index.md). @@ -1824,12 +1824,10 @@ The parameter was less the par When loading a file with the method, the contents of the file being loaded replace the entire contents of the control. This will cause the values of the and properties to change. You can use this method to load a previously created text or RTF document into the control for manipulation. If you want to save the file, you can use the method. > [!NOTE] -> With this version of the method, if the file being loaded is not an RTF document, an exception will occur. To load a different type of file such as an ASCII text file, use the other versions of this method that accept a value from the enumeration as a parameter. +> With this version of the method, if the file being loaded is not an RTF document, an exception will occur. To load a different type of file such as an ASCII text file, use the other versions of this method that accept a value from the enumeration as a parameter. > [!NOTE] -> The method will not open a file until a handle is created for the . Ensure that the control's handle is created before calling the method. - - +> The method will not open a file until a handle is created for the . Ensure that the control's handle is created before calling the method. ## Examples The following code example opens an RTF file into the control. The example uses the class to display a dialog to request the file from the user. The code then loads that file assuming that it is an RTF document file. If the file is not, the example code will throw an exception. This example requires that the code is placed in a class that has a control named `richTextBox1`. @@ -1880,14 +1878,12 @@ The parameter was less the par This version of the method also enables you to specify the type of data that is being loaded into the control. This feature enables you to use data streams that contain data other than rich text format (RTF) documents into the control. > [!NOTE] -> The method will not open a file until a handle is created for the . Ensure that the control's handle is created before calling the method. - - +> The method will not open a file until a handle is created for the . Ensure that the control's handle is created before calling the method. ## Examples The following code example demonstrates using the and methods with streams. It also demonstrates using the , , , and members. - This is a complete example that is ready to run when you copy it to your project. + This is a complete example that's ready to run when you copy it to your project. [!code-cpp[System.Windows.Forms.RichTextBoxSaveFile#1](~/samples/snippets/cpp/VS_Snippets_Winforms/System.Windows.Forms.RichTextBoxSaveFile/CPP/form1.cpp#1)] [!code-csharp[System.Windows.Forms.RichTextBoxSaveFile#1](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.RichTextBoxSaveFile/CS/form1.cs#1)] @@ -1896,6 +1892,7 @@ The parameter was less the par ]]> An error occurred while loading the file into the control. + .NET 5.0 and later: The argument is . The file being loaded is not an RTF document. @@ -1937,7 +1934,7 @@ The parameter was less the par You can use this version of the method to specify the file type of the file being loaded. This feature enables you to load files other than RTF documents into the control. > [!NOTE] -> The method will not open a file until a handle is created for the . Ensure that the control's handle is created before calling the method. +> The method will not open a file until a handle is created for the . Ensure that the control's handle is created before calling the method. @@ -1989,7 +1986,7 @@ The parameter was less the par When this property is set to 0, the maximum length of the text that can be entered in the control is 64 KB of characters. This property is typically used when the is used to display a single line of rich text format (RTF) text. You can use this property to restrict the length of text entered in the control for values such as postal codes and telephone numbers, or to restrict the length of text entered when the data is to be entered in a database. You can limit the text entered into the control to the maximum length of the corresponding field in the database. > [!NOTE] -> In code, you can set the value of the property to a value that has a length greater than the value specified by the property. This property only affects text entered into the control at run time. +> In code, you can set the value of the property to a value that has a length greater than the value specified by the property. This property only affects text entered into the control at run time. @@ -2936,7 +2933,7 @@ The parameter was less the par The method enables you to save the entire contents of the control to an RTF file that can be used by other programs such as Microsoft Word and Windows WordPad. If the file name that is passed to the `path` parameter already exists at the specified directory, the file will be overwritten without notice. You can use the method to load the contents of a file into the . > [!NOTE] -> To save the contents of the control to a different type of file format such as ASCII text, use the other versions of this method that accept a value from the enumeration as a parameter. +> To save the contents of the control to a different type of file format such as ASCII text, use the other versions of this method that accept a value from the enumeration as a parameter. @@ -3094,7 +3091,7 @@ The parameter was less the par This property enables you to provide horizontal and vertical scroll bars to the user of the control to enable scrolling text within the control that is outside of the physical dimensions of the control. You can also use this property to remove scroll bars from the control to restrict scrolling the contents of the control. > [!NOTE] -> Horizontal scroll bars will not be shown if the is `true`, regardless of the value of the property. +> Horizontal scroll bars will not be shown if the is `true`, regardless of the value of the property. ]]> @@ -3236,7 +3233,7 @@ The parameter was less the par If a selection is made within the control when the property is set, all paragraphs selected are aligned based on this property setting. You can use this property to align the paragraphs in a document being created in the . For example, if you want all paragraphs in a document to be centered, you can select all the paragraphs in the control and set the property to `HorizontalAlignment.Center`. > [!NOTE] -> returns `SelectionAlignment.Left` when the text selection contains multiple paragraphs with mixed alignment. +> returns `SelectionAlignment.Left` when the text selection contains multiple paragraphs with mixed alignment. @@ -3769,7 +3766,7 @@ The parameter was less the par If this property is set to `true`, the event is raised when the user attempts to change the current text selection. > [!NOTE] -> This property will return `true` only if the entire selection within the control contains protected content. +> This property will return `true` only if the entire selection within the control contains protected content. @@ -3954,7 +3951,7 @@ The parameter was less the par You can use this property to enable the user to easily select lines of text in the . The selection margin is added to the left side of the . This margin makes it easier for the user to select text starting on the left side of the control. The user can click in the selection margin to select a single line of text or double-click to select the entire paragraph that the line double-clicked is contained within. > [!NOTE] -> If the property is set to `true`, setting the property to `RichTextBoxScrollBars.Horizontal`, `RichTextBoxScrollBars.Vertical`, or `RichTextBoxScrollBars.Both` will not cause scroll bars to be displayed. In order to display scroll bars while the property is set to `true`, set the property to `RichTextBoxScrollBars.ForcedHorizontal`, `RichTextBoxScrollBars.ForcedVertical`, or `RichTextBoxScrollBars.ForcedBoth`. +> If the property is set to `true`, setting the property to `RichTextBoxScrollBars.Horizontal`, `RichTextBoxScrollBars.Vertical`, or `RichTextBoxScrollBars.Both` will not cause scroll bars to be displayed. In order to display scroll bars while the property is set to `true`, set the property to `RichTextBoxScrollBars.ForcedHorizontal`, `RichTextBoxScrollBars.ForcedVertical`, or `RichTextBoxScrollBars.ForcedBoth`. ]]> diff --git a/xml/System.Windows.Forms/TabControl.xml b/xml/System.Windows.Forms/TabControl.xml index e96a0379da2..864bcedc9c2 100644 --- a/xml/System.Windows.Forms/TabControl.xml +++ b/xml/System.Windows.Forms/TabControl.xml @@ -751,12 +751,11 @@ ]]> - - is . + The argument is . -or- - does not match the property of any in the collection. + The argument does not match the property of any in the collection. @@ -804,8 +803,7 @@ -or- is not in the collection. - - is . + The argument is . @@ -1248,6 +1246,8 @@ Gets the ToolTip for the specified . The ToolTip text. To be added. + .NET 5.0 and later: The argument is . + .NET 5.0 and later: The argument is not of type . @@ -2715,12 +2715,11 @@ ]]> - - is . + The argument is . -or- - does not match the property of any in the collection. + The argument does not match the property of any in the collection. @@ -2768,8 +2767,7 @@ -or- is not in the collection. - - is . + The argument is . diff --git a/xml/System.Windows.Forms/TableLayoutControlCollection.xml b/xml/System.Windows.Forms/TableLayoutControlCollection.xml index 811b101ba89..5d5b44bfa8b 100644 --- a/xml/System.Windows.Forms/TableLayoutControlCollection.xml +++ b/xml/System.Windows.Forms/TableLayoutControlCollection.xml @@ -74,6 +74,7 @@ ]]> + .NET 5.0 and later: The argument is . diff --git a/xml/System.Windows.Forms/ToolStripRenderer.xml b/xml/System.Windows.Forms/ToolStripRenderer.xml index dbded327033..7a3d1ee96e1 100644 --- a/xml/System.Windows.Forms/ToolStripRenderer.xml +++ b/xml/System.Windows.Forms/ToolStripRenderer.xml @@ -942,6 +942,7 @@ ]]> + .NET 5.0 and later: The argument is . When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. @@ -976,9 +977,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](~/docs/standard/events/index.md). - 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. - - + 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. ## Examples The following code example demonstrates how to override the method to draw a border around a control's . This code example is part of a larger example provided for the class. @@ -1179,6 +1178,7 @@ ]]> + .NET 5.0 and later: The argument is . When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. @@ -1217,6 +1217,7 @@ ]]> + .NET 5.0 and later: The argument is . When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. @@ -1255,6 +1256,7 @@ ]]> + .NET 5.0 and later: The argument is . When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. @@ -1483,6 +1485,7 @@ ]]> + .NET 5.0 and later: The argument is . When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. diff --git a/xml/System/Char.xml b/xml/System/Char.xml index 3edf889f362..904eb75456c 100644 --- a/xml/System/Char.xml +++ b/xml/System/Char.xml @@ -1270,6 +1270,13 @@ When a managed type, which is represented as a Unicode UTF-16 ## Remarks Valid digits are members of the category. +## Examples + The following code example demonstrates . + + :::code language="cpp" source="~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Char.IsDigit/CPP/isdigit.cpp" id="Snippet4"::: + :::code language="csharp" source="~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Char.IsDigit/CS/isdigit.cs" interactive="try-dotnet" id="Snippet4"::: + :::code language="vb" source="~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Char.IsDigit/VB/isdigit.vb" id="Snippet4"::: + ]]> @@ -1324,15 +1331,6 @@ When a managed type, which is represented as a Unicode UTF-16 Valid digits are members of the category. - - -## Examples - The following code example demonstrates . - - [!code-cpp[System.Char.IsDigit#4](~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Char.IsDigit/CPP/isdigit.cpp#4)] - [!code-csharp[System.Char.IsDigit#4](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Char.IsDigit/CS/isdigit.cs#4)] - [!code-vb[System.Char.IsDigit#4](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Char.IsDigit/VB/isdigit.vb#4)] - ]]> @@ -1399,15 +1397,6 @@ When a managed type, which is represented as a Unicode UTF-16 Valid digits are members of the category. - - -## Examples - The following code example demonstrates . - - [!code-cpp[System.Char.IsDigit#4](~/samples/snippets/cpp/VS_Snippets_CLR_System/system.Char.IsDigit/CPP/isdigit.cpp#4)] - [!code-csharp[System.Char.IsDigit#4](~/samples/snippets/csharp/VS_Snippets_CLR_System/system.Char.IsDigit/CS/isdigit.cs#4)] - [!code-vb[System.Char.IsDigit#4](~/samples/snippets/visualbasic/VS_Snippets_CLR_System/system.Char.IsDigit/VB/isdigit.vb#4)] - ]]> diff --git a/xml/System/Uri.xml b/xml/System/Uri.xml index 5ca2166590c..b2e3491d474 100644 --- a/xml/System/Uri.xml +++ b/xml/System/Uri.xml @@ -188,6 +188,36 @@ Uri uri1 = new Uri("C:/test/path/file.txt") // Implicit file path. Uri uri2 = new Uri("file:///C:/test/path/file.txt") // Explicit file path. ``` These implicit file paths are not compliant with the URI specification and so should be avoided when possible. When using .NET Core on Unix-based systems, implicit file paths can be especially problematic, because an absolute implicit file path is *indistinguishable* from a relative path. When such ambiguity is present, default to interpreting the path as an absolute URI. + +## Security Considerations + +Because of security concerns, your application should use caution when accepting instances from untrusted sources and with `dontEscape` set to `true` in the [constructor](xref:System.Uri.%23ctor(System.String,System.Boolean)). You can check a URI string for validity by calling the method. + +When dealing with untrusted user input, confirm assumptions about the newly created `Uri` instance before trusting its properties. +This can be done in the following way: + +```csharp +string userInput = ...; + +Uri baseUri = new Uri("https://myWebsite/files/"); + +if (!Uri.TryCreate(baseUri, userInput, out Uri newUri)) +{ + // Fail: invalid input. +} + +if (!baseUri.IsBaseOf(newUri)) +{ + // Fail: the Uri base has been modified - the created Uri is not rooted in the original directory. +} +``` + +This validation can be used in other cases, like when dealing with UNC paths, by simply changing the `baseUri`: + +```csharp +Uri baseUri = new Uri(@"\\host\share\some\directory\name\"); +``` + ## Performance Considerations If you use a *Web.config *file that contains URIs to initialize your application, additional time is required to process the URIs if their scheme identifiers are nonstandard. In such a case, initialize the affected parts of your application when the URIs are needed, not at start time. @@ -203,9 +233,6 @@ Uri uri2 = new Uri("file:///C:/test/path/file.txt") // Explicit file path. ]]> - - Because of security concerns, your application should use caution when accepting instances from untrusted sources and with set to .You can check a URI string for validity by calling the method. - diff --git a/xml/_filter.xml b/xml/_filter.xml index b35fe82245a..b6f5350c514 100644 --- a/xml/_filter.xml +++ b/xml/_filter.xml @@ -165,5 +165,14 @@ + + + + + + + + +