Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 8 additions & 37 deletions xml/Microsoft.VisualBasic/Financial.xml

Large diffs are not rendered by default.

6 changes: 0 additions & 6 deletions xml/System.Data.Objects/CompiledQuery.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
## Remarks
Provides for compilation and caching of queries for reuse. Conceptually this class contains a single `Compile` method with several overloads. You call the `Compile` method to create a new delegate to represent the compiled query. The delegate, when invoked with the <xref:System.Data.Objects.ObjectContext> input parameter and other parameter values, produces some result (such as an <xref:System.Linq.IQueryable%601> instance). The query is translated and cached when the delegate is invoked for the first time.



## Examples
The following example compiles and then invokes a query that accepts <xref:System.DateTime> and <xref:System.Decimal> input parameters and returns a sequence of orders where the order date is later than March 8, 2003 and the total due is less than $300.00:

Expand Down Expand Up @@ -129,8 +127,6 @@
## Remarks
For more information and examples, see [Compiled Queries (LINQ to Entities)](/dotnet/framework/data/adonet/ef/language-reference/compiled-queries-linq-to-entities).



## Examples
The following example compiles and then invokes a query that accepts a <xref:System.Decimal> input parameter and returns a sequence of orders where the total due is greater than or equal to $200.00:

Expand Down Expand Up @@ -185,8 +181,6 @@
## Remarks
For more information and examples, see [Compiled Queries (LINQ to Entities)](/dotnet/framework/data/adonet/ef/language-reference/compiled-queries-linq-to-entities).



## Examples
The following example compiles and then invokes a query that accepts <xref:System.DateTime> and <xref:System.Decimal> input parameters and returns a sequence of orders where the order date is later than March 8, 2003 and the total due is less than $300.00:

Expand Down
2 changes: 1 addition & 1 deletion xml/System.Data.Services/IDataServiceConfiguration.xml
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the maximum number of segments that can be expanded by the $expand query option for all requests to the data service.</summary>
<summary>Gets or sets the maximum number of segments that can be expanded by the <see langword="$expand" /> query option for all requests to the data service.</summary>
<value>The maximum number of segments to expand.</value>
<remarks>
<format type="text/markdown"><![CDATA[
Expand Down
4 changes: 1 addition & 3 deletions xml/System.Diagnostics/EventLogInstaller.xml
Original file line number Diff line number Diff line change
Expand Up @@ -657,12 +657,10 @@ SVC_UPDATE.EXE

If your application writes event message strings directly, rather than using a resource identifier in a localized resource file, do not set the <xref:System.Diagnostics.EventLogInstaller.MessageResourceFile%2A> property.

If the <xref:System.Diagnostics.EventLog.MachineName%2A> property is not the local computer identifier ("."), the .NET Framework assumes that the resource file is on a remote computer. If the <xref:System.Diagnostics.EventLogInstaller.MessageResourceFile%2A> property value contains a drive letter, the resource file is assumed to be on the \\\\<machinename\>\\<drive\>$ share (for example, \\\server\c$). If the value contains the string %systemroot%, the resource file is assumed to be on the \\\\<machinename\>\admin$ share (for example, \\\server\admin$).
If the <xref:System.Diagnostics.EventLog.MachineName%2A> property is not the local computer identifier ("."), the .NET Framework assumes that the resource file is on a remote computer. If the <xref:System.Diagnostics.EventLogInstaller.MessageResourceFile%2A> property value contains a drive letter, the resource file is assumed to be on the \\\\<machinename\>\\<drive\>\\$ share (for example, \\\server\c\\$). If the value contains the string %systemroot%, the resource file is assumed to be on the \\\\<machinename\>\admin\\$ share (for example, \\\server\admin\\$).

For details about defining event messages and building event resource files, see the [Message Compiler](/windows/win32/wes/message-compiler--mc-exe-) article in the Platform SDK documentation.



## Examples
The following code example sets the installation properties for a new event source. The code example sets the event source name, event log name, and resource file for localized event text.

Expand Down
85 changes: 25 additions & 60 deletions xml/System.Globalization/NumberFormatInfo.xml

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions xml/System.Net/Cookie.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1128,8 +1128,6 @@

The following characters are reserved and cannot be used for this attribute value: equal sign, semicolon, comma, new line (\n), return (\r), tab (\t), and space character. The dollar sign ($) character cannot be the first character.



## Examples
The following example displays the properties of cookies returned in a response. For the complete example, see the <xref:System.Net.Cookie> class topic.

Expand Down
2 changes: 1 addition & 1 deletion xml/System.Net/CookieException.xml
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
## Remarks
This exception is thrown if an attempt is made to <xref:System.Net.CookieContainer.Add%2A> a <xref:System.Net.Cookie> with length greater than <xref:System.Net.CookieContainer.MaxCookieSize%2A> to a <xref:System.Net.CookieContainer>.

**Associated Tips**
### Tips

**Make sure the cookie size does not exceed the maximum allowed by the cookie container.**
This exception is thrown when an attempt is made to add a <xref:System.Net.Cookie> with length greater than <xref:System.Net.CookieContainer.MaxCookieSize%2A> to a <xref:System.Net.CookieContainer>. The default maximum cookie size is 4096 bytes.
Expand Down
2 changes: 0 additions & 2 deletions xml/System.Security.Policy/CodeConnectAccess.xml
Original file line number Diff line number Diff line change
Expand Up @@ -511,8 +511,6 @@

The value of this field is "$origin".



## Examples
The following code example displays the value of this field.

Expand Down
4 changes: 0 additions & 4 deletions xml/System.Speech.Recognition.SrgsGrammar/SrgsRule.xml
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,6 @@

- `id` contains at least one invalid rule ID character. These characters are: '?', '*', '+', '&#124;', '(', '), '^', '$', '/', ';', '.', '=', '\<', '>', '[', ']', '{', '}', '\\\\', ' ', '\t', '\r', and '\n'.



## Examples
The following example creates a grammar that recognizes the phrase "A nation that has won the World Cup is" followed by the name of a country that has won the World Cup. The example creates a <xref:System.Speech.Recognition.SrgsGrammar.SrgsRule> object named `winnerRule` and passes in the identifier `WorldCupWinner` as a <xref:System.String>. The <xref:System.Speech.Recognition.SrgsGrammar.SrgsOneOf> object consists of an array of new <xref:System.Speech.Recognition.SrgsGrammar.SrgsItem> objects containing alternatives to be recognized by the rule.

Expand Down Expand Up @@ -190,8 +188,6 @@ public void WorldSoccerWinners ()

- `id` contains at least one invalid rule ID character. These characters are: '?', '*', '+', '&#124;', '(', '), '^', '$', '/', ';', '.', '=', '\<', '>', '[', ']', '{', '}', '\\\\', ' ', '\t', '\r', and '\n'.



## Examples
The following example creates a grammar that recognizes the phrase "A nation that has won the World Cup is" followed by the name of a country that has won the World Cup. The example creates a public rule named `WorldCupWinner`. The example then creates two <xref:System.Speech.Recognition.SrgsGrammar.SrgsRule> objects, `ruleEurope` and `ruleSAmerica`, passing in a <xref:System.String> for the rule identifier and an <xref:System.Speech.Recognition.SrgsGrammar.SrgsElement> array containing a <xref:System.Speech.Recognition.SrgsGrammar.SrgsOneOf> object. Subsequently, the example adds rule references to `ruleEurope` and `ruleSAmerica` from the rule `WorldCupWinner`.

Expand Down
4 changes: 0 additions & 4 deletions xml/System.Speech.Recognition/RecognizedWordUnit.xml
Original file line number Diff line number Diff line change
Expand Up @@ -410,8 +410,6 @@ internal static string stringFromWordArray(

Speech normalization is the use of special constructs or symbols to express speech in writing. For example, normalization can replace the spoken words "a dollar and sixteen cents" with "$1.16" in output text.



## Examples
The following example shows a utility routine that generates text in one of three formats: lexical (using <xref:System.Speech.Recognition.RecognizedWordUnit.LexicalForm%2A>), normalized (using <xref:System.Speech.Recognition.RecognizedWordUnit.Text%2A>), and phonetic (using <xref:System.Speech.Recognition.RecognizedWordUnit.Pronunciation%2A>). The text output is obtained from a <xref:System.Collections.ObjectModel.ReadOnlyCollection%601> of <xref:System.Speech.Recognition.RecognizedWordUnit> objects, which is obtained from the <xref:System.Speech.Recognition.RecognizedPhrase.Words%2A> property on the <xref:System.Speech.Recognition.RecognizedPhrase> object.

Expand Down Expand Up @@ -624,8 +622,6 @@ internal static string stringFromWordArray(

Speech normalization is the use of special constructs or symbols to express speech in writing. For example, normalization can replace the spoken words "a dollar and sixteen cents" with "$1.16" in output text.



## Examples
The following example shows a utility routine that generates a string in one of three formats: lexical (using <xref:System.Speech.Recognition.RecognizedWordUnit.LexicalForm%2A>), normalized (using <xref:System.Speech.Recognition.RecognizedWordUnit.Text%2A>), and phonetic (using <xref:System.Speech.Recognition.RecognizedWordUnit.Pronunciation%2A>). The text output is obtained from a <xref:System.Collections.ObjectModel.ReadOnlyCollection%601> of <xref:System.Speech.Recognition.RecognizedWordUnit> objects, which is obtained from the <xref:System.Speech.Recognition.RecognizedPhrase.Words%2A> property on the <xref:System.Speech.Recognition.RecognizedPhrase> object.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a custom type discriminator property name for the polymorhic type.
<summary>Gets or sets a custom type discriminator property name for the polymorphic type.
Uses the default '$type' property name if left unset.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
Expand Down
18 changes: 9 additions & 9 deletions xml/System.Text.Json.Serialization/ReferenceResolver.xml
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
<Docs>
<param name="referenceId">The identifier of the JSON object or array.</param>
<param name="value">The value of the CLR reference type object that results from parsing the JSON object.</param>
<summary>Adds an entry to the bag of references using the specified id and value.
<summary>Adds an entry to the bag of references using the specified ID and value.
This method gets called when an $id metadata property from a JSON object is read.</summary>
<remarks>To be added.</remarks>
</Docs>
Expand Down Expand Up @@ -105,11 +105,11 @@
<Parameter Name="alreadyExists" Type="System.Boolean" RefType="out" />
</Parameters>
<Docs>
<param name="value">The value of the CLR reference type object to get an id for.</param>
<param name="value">The value of the CLR reference type object to get an ID for.</param>
<param name="alreadyExists">When this method returns, <see langword="true" /> if a reference to value already exists; otherwise, <see langword="false" />.</param>
<summary>Gets the reference identifier of the specified value if exists; otherwise a new id is assigned.
This method gets called before a CLR object is written so we can decide whether to write $id and enumerate the rest of its properties or $ref and step into the next object.</summary>
<returns>The reference id for the specified object.</returns>
<summary>Gets the reference identifier of the specified value if exists; otherwise a new ID is assigned.
This method gets called before a CLR object is written so we can decide whether to write \\$id and enumerate the rest of its properties or \\$ref and step into the next object.</summary>
<returns>The reference ID for the specified object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand All @@ -136,10 +136,10 @@
<Parameter Name="referenceId" Type="System.String" />
</Parameters>
<Docs>
<param name="referenceId">The reference id related to the returned object.</param>
<summary>Returns the CLR reference type object related to the specified reference id.
This method gets called when $ref metadata property is read.</summary>
<returns>The reference type object related to the specified reference id.</returns>
<param name="referenceId">The reference ID related to the returned object.</param>
<summary>Returns the CLR reference type object related to the specified reference ID.
This method is called when $ref metadata property is read.</summary>
<returns>The reference type object related to the specified reference ID.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down
8 changes: 2 additions & 6 deletions xml/System.Text.Json/JsonSerializerOptions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -189,13 +189,9 @@ similar to how <xref:System.Text.Json.Serialization.Metadata.JsonTypeInfoResolve
<Docs>
<summary>Allows JSON metadata properties to be specified after regular properties in a deserialized JSON object.</summary>
<value>To be added.</value>
<remarks>
<para>When set to <see langword="true" />, removes the requirement that JSON metadata properties</para>
<para>such as $id and $type should be specified at the very start of the deserialized JSON object.</para>
<para>It should be noted that enabling this setting can result in over-buffering</para>
<para>when deserializing large JSON payloads in the context of streaming deserialization.</para>
<remarks>When set to <see langword="true" />, removes the requirement that JSON metadata properties, such as \\$id and \\$type, be specified at the very start of the deserialized JSON object. If you enable this setting, it can result in over-buffering when deserializing large JSON payloads in the context of streaming deserialization.
</remarks>
<exception cref="T:System.InvalidOperationException">Thrown if this property is set after serialization or deserialization has occurred.</exception>
<exception cref="T:System.InvalidOperationException">This property is set after serialization or deserialization has occurred.</exception>
</Docs>
</Member>
<Member MemberName="AllowTrailingCommas">
Expand Down
Empty file modified xml/System.Text/UTF7Encoding.xml
Whitespace-only changes.
4 changes: 1 addition & 3 deletions xml/System.Web.UI.WebControls/BoundField.xml
Original file line number Diff line number Diff line change
Expand Up @@ -388,7 +388,7 @@

|Format character|Description|Example|
|----------------------|-----------------|-------------|
|`C` or `c`|Displays numeric values in currency format. You can specify the number of decimal places.|Format: `{0:C}`<br /><br /> 123.456 -> $123.46<br /><br /> Format: `{0:C3}`<br /><br /> 123.456 -> $123.456|
|`C` or `c`|Displays numeric values in currency format. You can specify the number of decimal places.|Format: `{0:C}`<br /><br /> 123.456 -> \\$123.46<br /><br /> Format: `{0:C3}`<br /><br /> 123.456 -> \\$123.456|
|`D` or `d`|Displays integer values in decimal format. You can specify the number of digits. (Although the type is referred to as "decimal", the numbers are formatted as integers.)|Format: `{0:D}`<br /><br /> 1234 -> 1234<br /><br /> Format: `{0:D6}`<br /><br /> 1234 -> 001234|
|`E` or `e`|Displays numeric values in scientific (exponential) format. You can specify the number of decimal places.|Format: `{0:E}`<br /><br /> 1052.0329112756 -> 1.052033E+003<br /><br /> Format: `{0:E2}`<br /><br /> -1052.0329112756 -> -1.05e+003|
|`F` or `f`|Displays numeric values in fixed format. You can specify the number of decimal places.|Format: `{0:F}`<br /><br /> 1234.567 -> 1234.57<br /><br /> Format: `{0:F3}`<br /><br /> 1234.567 -> 1234.567|
Expand Down Expand Up @@ -429,8 +429,6 @@

The following example shows how to use the <xref:System.Web.UI.WebControls.BoundField.DataFormatString%2A> property to specify a custom display format for the values of a field.



The following example shows one row of the output that is produced by this example.

|ProductID|Name|ProductNumber|ListPrice|Weight|ModifiedDate|
Expand Down
6 changes: 3 additions & 3 deletions xml/System.Web.UI.WebControls/ListControl.xml
Original file line number Diff line number Diff line change
Expand Up @@ -564,8 +564,8 @@ The items in the <xref:System.Web.UI.WebControls.ListControl.Items> collection a

|Numeric Value|Format String|Result|
|-------------------|-------------------|------------|
|12345.6789|"{0:C}"|$12,345.68|
|-12345.6789|"{0:C}"|($12,345.68)|
|12345.6789|"{0:C}"|\\$12,345.68|
|-12345.6789|"{0:C}"|(\\$12,345.68)|
|12345|"{0:D}"|12345|
|12345|"{0:D8}"|00012345|
|12345.6789|"{0:E}"|1234568E+004|
Expand All @@ -576,7 +576,7 @@ The items in the <xref:System.Web.UI.WebControls.ListControl.Items> collection a
|123456789|"{0:G7}"|1.234568E8|
|12345.6789|"{0:N}"|12,345.68|
|123456789|"{0:N4}"|123,456,789.0000|
|12345.6789|"Total: {0:C}"|Total: $12345.68|
|12345.6789|"Total: {0:C}"|Total: \\$12345.68|

For more information on formatting strings, see [Formatting Types](/dotnet/standard/base-types/formatting-types).

Expand Down
4 changes: 1 addition & 3 deletions xml/System.Web.UI.WebControls/RegularExpressionValidator.xml
Original file line number Diff line number Diff line change
Expand Up @@ -266,12 +266,10 @@
For more information on regular expressions, see [.NET Framework Regular Expressions](/dotnet/standard/base-types/regular-expressions).

> [!NOTE]
> If you experience problems with pattern matching constructs, try wrapping the expression with "^(" and ")$". For example, "a&#124;ab" becomes "^(a&#124;ab)$".
> If you experience problems with pattern matching constructs, try wrapping the expression with "^(" and ")\\$". For example, "a&#124;ab" becomes "^(a&#124;ab)\\$".

This property cannot be set by themes or style sheet themes. For more information, see <xref:System.Web.UI.ThemeableAttribute> and [ASP.NET Themes and Skins](https://learn.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)).



## Examples
The following example demonstrates how to use the <xref:System.Web.UI.WebControls.RegularExpressionValidator.ValidationExpression%2A> property to validate a field with five numeric digits. When the <xref:System.Web.UI.WebControls.Button> control is clicked, the resulting <xref:System.Web.UI.WebControls.Button.OnClick%2A> event handler checks the <xref:System.Web.UI.Page.IsValid%2A> property of the <xref:System.Web.UI.Page> to determine whether the text in the <xref:System.Web.UI.WebControls.TextBox> satisfies the regular expression.

Expand Down
4 changes: 2 additions & 2 deletions xml/System/Byte.xml
Original file line number Diff line number Diff line change
Expand Up @@ -1607,12 +1607,12 @@ For <xref:System.Numerics.IFloatingPoint%601>, this method matches the IEEE 754:
<param name="s">A string that contains a number to convert. The string is interpreted using the style specified by <paramref name="style" />.</param>
<param name="style">A bitwise combination of enumeration values that indicates the style elements that can be present in <paramref name="s" />. A typical value to specify is <see cref="F:System.Globalization.NumberStyles.Integer" />.</param>
<summary>Converts the string representation of a number in a specified style to its <see cref="T:System.Byte" /> equivalent.</summary>
<returns>A byte value that is equivalent to the number contained in <paramref name="s" />.</returns>
<returns>A byte value that's equivalent to the number contained in <paramref name="s" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The `style` parameter defines the style elements (such as white space or the positive sign) that are allowed in the `s` parameter for the parse operation to succeed. It must be a combination of bit flags from the <xref:System.Globalization.NumberStyles> enumeration. Depending on the value of `style`, the `s` parameter may include the following elements:
The `style` parameter defines the style elements (such as white space or the positive sign) that are allowed in the `s` parameter for the parse operation to succeed. It must be a combination of bit flags from the <xref:System.Globalization.NumberStyles> enumeration. Depending on the value of `style`, the `s` parameter can include the following elements:

[ws][$][sign]digits[.fractional_digits][e[sign]digits][ws]

Expand Down