From 592660db911f8302595bb1e72e52f4b2b377ce33 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Mon, 2 Dec 2024 06:57:28 -0800 Subject: [PATCH] Escape $ signs where needed (#10715) --- xml/Microsoft.VisualBasic/Financial.xml | 417 +++--- xml/System.Data.Objects/CompiledQuery.xml | 220 ++- .../IDataServiceConfiguration.xml | 70 +- xml/System.Diagnostics/EventLogInstaller.xml | 1328 ++++++++--------- xml/System.Globalization/NumberFormatInfo.xml | 191 +-- xml/System.Net/Cookie.xml | 594 ++++---- xml/System.Net/CookieException.xml | 2 +- .../CodeConnectAccess.xml | 324 ++-- .../SrgsRule.xml | 10 +- .../RecognizedWordUnit.xml | 922 ++++++------ .../JsonPolymorphismOptions.xml | 2 +- .../ReferenceResolver.xml | 18 +- .../JsonSerializerOptions.xml | 8 +- xml/System.Text/UTF7Encoding.xml | 750 +++++----- xml/System.Web.UI.WebControls/BoundField.xml | 602 ++++---- xml/System.Web.UI.WebControls/ListControl.xml | 6 +- .../RegularExpressionValidator.xml | 4 +- xml/System/Byte.xml | 4 +- 18 files changed, 2690 insertions(+), 2782 deletions(-) diff --git a/xml/Microsoft.VisualBasic/Financial.xml b/xml/Microsoft.VisualBasic/Financial.xml index c60d0cdf01d..01c63250521 100644 --- a/xml/Microsoft.VisualBasic/Financial.xml +++ b/xml/Microsoft.VisualBasic/Financial.xml @@ -37,20 +37,18 @@ - The module contains procedures used to perform financial operations. + Contains procedures used to perform financial operations. - Financial Summary @@ -101,24 +99,22 @@ Returns a value specifying the depreciation of an asset for a specific time period using the double-declining balance method or some other method you specify. The depreciation of an asset for a specific time period using the double-declining balance method or some other method you specify. - @@ -178,22 +174,20 @@ Returns a value specifying the future value of an annuity based on periodic, fixed payments and a fixed interest rate. The future value of an annuity based on periodic, fixed payments and a fixed interest rate. - Financial Summary @@ -239,27 +233,25 @@ Required. The payment period in the range 1 through . Required. The total number of payment periods in the annuity. For example, if you make monthly payments on a four-year car loan, your loan has a total of 4 x 12 (or 48) payment periods. Required. The present value, or value today, of a series of future payments or receipts. For example, when you borrow money to buy a car, the loan amount is the present value to the lender of the monthly car payments you will make. - Optional. The future value or cash balance you want after you've made the final payment. For example, the future value of a loan is $0 because that's its value after the final payment. However, if you want to save $50,000 over 18 years for your child's education, then $50,000 is the future value. If omitted, 0 is assumed. + Optional. The future value or cash balance you want after you've made the final payment. For example, the future value of a loan is \\$0 because that's its value after the final payment. However, if you want to save \\$50,000 over 18 years for your child's education, then \\$50,000 is the future value. If omitted, 0 is assumed. Optional. Object of type that specifies when payments are due. This argument must be either DueDate.EndOfPeriod if payments are due at the end of the payment period, or DueDate.BegOfPeriod if payments are due at the beginning of the period. If omitted, DueDate.EndOfPeriod is assumed. Returns a value specifying the interest payment for a given period of an annuity based on periodic, fixed payments and a fixed interest rate. The interest payment for a given period of an annuity based on periodic, fixed payments and a fixed interest rate. - @@ -305,22 +297,20 @@ Returns a value specifying the internal rate of return for a series of periodic cash flows (payments and receipts). The internal rate of return for a series of periodic cash flows (payments and receipts). - Array argument values are invalid or <= -1. @@ -370,22 +360,20 @@ Returns a value specifying the modified internal rate of return for a series of periodic cash flows (payments and receipts). The modified internal rate of return for a series of periodic cash flows (payments and receipts). - Rank of does not equal 1, = -1, or = -1 @@ -435,25 +423,23 @@ Required. The interest rate per period. For example, if you get a car loan at an annual percentage rate (APR) of 10 percent and make monthly payments, the rate per period is 0.1/12, or 0.0083. Required. The payment to be made each period. Payments usually contain principal and interest that does not change over the life of the annuity. Required. The present value, or value today, of a series of future payments or receipts. For example, when you borrow money to buy a car, the loan amount is the present value to the lender of the monthly car payments you will make. - Optional. The future value or cash balance you want after you have made the final payment. For example, the future value of a loan is $0 because that is its value after the final payment. However, if you want to save $50,000 over 18 years for your child's education, then $50,000 is the future value. If omitted, 0 is assumed. + Optional. The future value or cash balance you want after you have made the final payment. For example, the future value of a loan is \\$0 because that is its value after the final payment. However, if you want to save \\$50,000 over 18 years for your child's education, then \\$50,000 is the future value. If omitted, 0 is assumed. Optional. Object of type that specifies when payments are due. This argument must be either DueDate.EndOfPeriod if payments are due at the end of the payment period, or DueDate.BegOfPeriod if payments are due at the beginning of the period. If omitted, DueDate.EndOfPeriod is assumed. Returns a value specifying the number of periods for an annuity based on periodic fixed payments and a fixed interest rate. The number of periods for an annuity based on periodic fixed payments and a fixed interest rate. - @@ -500,26 +486,24 @@ Returns a value specifying the net present value of an investment based on a series of periodic cash flows (payments and receipts) and a discount rate. The net present value of an investment based on a series of periodic cash flows (payments and receipts) and a discount rate. - @@ -574,27 +558,25 @@ Required. The interest rate per period. For example, if you get a car loan at an annual percentage rate (APR) of 10 percent and make monthly payments, the rate per period is 0.1/12, or 0.0083. Required. The total number of payment periods in the annuity. For example, if you make monthly payments on a four-year car loan, your loan has a total of 4 × 12 (or 48) payment periods. Required. The present value (or lump sum) that a series of payments to be paid in the future is worth now. For example, when you borrow money to buy a car, the loan amount is the present value to the lender of the monthly car payments you will make. - Optional. The future value or cash balance you want after you have made the final payment. For example, the future value of a loan is $0 because that is its value after the final payment. However, if you want to save $50,000 during 18 years for your child's education, then $50,000 is the future value. If omitted, 0 is assumed. + Optional. The future value or cash balance you want after you have made the final payment. For example, the future value of a loan is \\$0 because that is its value after the final payment. However, if you want to save \\$50,000 during 18 years for your child's education, then \\$50,000 is the future value. If omitted, 0 is assumed. Optional. Object of type that specifies when payments are due. This argument must be either DueDate.EndOfPeriod if payments are due at the end of the payment period, or DueDate.BegOfPeriod if payments are due at the beginning of the period. If omitted, DueDate.EndOfPeriod is assumed. Returns a value specifying the payment for an annuity based on periodic, fixed payments and a fixed interest rate. The payment for an annuity based on periodic, fixed payments and a fixed interest rate. - @@ -643,27 +625,25 @@ Required. The payment period in the range 1 through . Required. The total number of payment periods in the annuity. For example, if you make monthly payments on a four-year car loan, your loan has a total of 4 x 12 (or 48) payment periods. Required. The current value of a series of future payments or receipts. For example, when you borrow money to buy a car, the loan amount is the present value to the lender of the monthly car payments you will make. - Optional. The future value or cash balance you want after you have made the final payment. For example, the future value of a loan is $0 because that is its value after the final payment. However, if you want to save $50,000 over 18 years for your child's education, then $50,000 is the future value. If omitted, 0 is assumed. + Optional. The future value or cash balance you want after you have made the final payment. For example, the future value of a loan is \\$0 because that is its value after the final payment. However, if you want to save \\$50,000 over 18 years for your child's education, then \\$50,000 is the future value. If omitted, 0 is assumed. Optional. Object of type that specifies when payments are due. This argument must be either DueDate.EndOfPeriod if payments are due at the end of the payment period, or DueDate.BegOfPeriod if payments are due at the beginning of the period. If omitted, DueDate.EndOfPeriod is assumed. Returns a value specifying the principal payment for a given period of an annuity based on periodic fixed payments and a fixed interest rate. The principal payment for a given period of an annuity based on periodic fixed payments and a fixed interest rate. - @@ -710,27 +690,25 @@ Required. The interest rate per period. For example, if you get a car loan at an annual percentage rate (APR) of 10 percent and make monthly payments, the rate per period is 0.1/12, or 0.0083. Required. The total number of payment periods in the annuity. For example, if you make monthly payments on a four-year car loan, your loan has 4 x 12 (or 48) payment periods. Required. The payment to be made each period. Payments usually contain principal and interest that does not change during the life of the annuity. - Optional. The future value or cash balance you want after you make the final payment. For example, the future value of a loan is $0 because that is its value after the final payment. However, if you want to save $50,000 over 18 years for your child's education, then $50,000 is the future value. If omitted, 0 is assumed. + Optional. The future value or cash balance you want after you make the final payment. For example, the future value of a loan is \\$0 because that is its value after the final payment. However, if you want to save \\$50,000 over 18 years for your child's education, then \\$50,000 is the future value. If omitted, 0 is assumed. Optional. Object of type that specifies when payments are due. This argument must be either DueDate.EndOfPeriod if payments are due at the end of the payment period, or DueDate.BegOfPeriod if payments are due at the beginning of the period. If omitted, DueDate.EndOfPeriod is assumed. Returns a value specifying the present value of an annuity based on periodic, fixed payments to be paid in the future and a fixed interest rate. The present value of an annuity based on periodic, fixed payments to be paid in the future and a fixed interest rate. - Financial Summary @@ -775,28 +753,26 @@ Required. The total number of payment periods in the annuity. For example, if you make monthly payments on a four-year car loan, your loan has a total of 4 * 12 (or 48) payment periods. Required. The payment to be made each period. Payments usually contain principal and interest that doesn't change over the life of the annuity. Required. The present value, or value today, of a series of future payments or receipts. For example, when you borrow money to buy a car, the loan amount is the present value to the lender of the monthly car payments you will make. - Optional. The future value or cash balance you want after you make the final payment. For example, the future value of a loan is $0 because that is its value after the final payment. However, if you want to save $50,000 over 18 years for your child's education, then $50,000 is the future value. If omitted, 0 is assumed. + Optional. The future value or cash balance you want after you make the final payment. For example, the future value of a loan is \\$0 because that is its value after the final payment. However, if you want to save \\$50,000 over 18 years for your child's education, then \\$50,000 is the future value. If omitted, 0 is assumed. Optional. Object of type that specifies when payments are due. This argument must be either DueDate.EndOfPeriod if payments are due at the end of the payment period, or DueDate.BegOfPeriod if payments are due at the beginning of the period. If omitted, DueDate.EndOfPeriod is assumed. Optional. The value you estimate is returned by . If omitted, is 0.1 (10 percent). Returns a value specifying the interest rate per period for an annuity. The interest rate per period for an annuity. - @@ -845,18 +821,16 @@ Returns a value specifying the straight-line depreciation of an asset for a single period. The straight-line depreciation of an asset for a single period. - @@ -909,18 +883,15 @@ Returns a value specifying the sum-of-years digits depreciation of an asset for a specified period. The sum-of-years digits depreciation of an asset for a specified period. - diff --git a/xml/System.Data.Objects/CompiledQuery.xml b/xml/System.Data.Objects/CompiledQuery.xml index da7aff110c3..6e93d70d983 100644 --- a/xml/System.Data.Objects/CompiledQuery.xml +++ b/xml/System.Data.Objects/CompiledQuery.xml @@ -17,19 +17,17 @@ Represents a cached LINQ to Entities query. - input parameter and other parameter values, produces some result (such as an 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 and 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: - + input parameter and other parameter values, produces some result (such as an 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 and 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: + :::code language="csharp" source="~/snippets/csharp/System.Data.Objects/CompiledQuery/Overview/Program.cs" id="Snippetcompiledquery5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/DP L2E Conceptual Examples/VB/Module1.vb" id="Snippetcompiledquery5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/DP L2E Conceptual Examples/VB/Module1.vb" id="Snippetcompiledquery5"::: + ]]> Compiled Queries (LINQ to Entities) @@ -70,19 +68,19 @@ , a generic delegate that represents the compiled LINQ to Entities query. - instance: - + instance: + :::code language="csharp" source="~/snippets/csharp/System.Data.Objects/CompiledQuery/Overview/Program.cs" id="Snippetcompiledquery1_mq"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/DP L2E Conceptual Examples/VB/Module1.vb" id="Snippetcompiledquery1_mq"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/DP L2E Conceptual Examples/VB/Module1.vb" id="Snippetcompiledquery1_mq"::: + ]]> @@ -124,19 +122,17 @@ , a generic delegate that represents the compiled LINQ to Entities query. - input parameter and returns a sequence of orders where the total due is greater than or equal to $200.00: - + input parameter and returns a sequence of orders where the total due is greater than or equal to $200.00: + :::code language="csharp" source="~/snippets/csharp/System.Data.Objects/CompiledQuery/Overview/Program.cs" id="Snippetcompiledquery2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/DP L2E Conceptual Examples/VB/Module1.vb" id="Snippetcompiledquery2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/DP L2E Conceptual Examples/VB/Module1.vb" id="Snippetcompiledquery2"::: + ]]> @@ -180,19 +176,17 @@ , a generic delegate that represents the compiled LINQ to Entities query. - and 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: - + and 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: + :::code language="csharp" source="~/snippets/csharp/System.Data.Objects/CompiledQuery/Overview/Program.cs" id="Snippetcompiledquery5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/DP L2E Conceptual Examples/VB/Module1.vb" id="Snippetcompiledquery5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Data/DP L2E Conceptual Examples/VB/Module1.vb" id="Snippetcompiledquery5"::: + ]]> @@ -238,11 +232,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -289,11 +283,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -342,11 +336,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -397,11 +391,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -454,11 +448,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -513,11 +507,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -574,11 +568,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -637,11 +631,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -702,11 +696,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -769,11 +763,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -838,11 +832,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -909,11 +903,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - @@ -982,11 +976,11 @@ , a generic delegate that represents the compiled LINQ to Entities query. - diff --git a/xml/System.Data.Services/IDataServiceConfiguration.xml b/xml/System.Data.Services/IDataServiceConfiguration.xml index c87d40c7e7e..20b5f0514ba 100644 --- a/xml/System.Data.Services/IDataServiceConfiguration.xml +++ b/xml/System.Data.Services/IDataServiceConfiguration.xml @@ -14,11 +14,11 @@ The is used by WCF Data Services to set up the behavior of the service, including rights on entity sets and service operations, limits on the allowed requests, registering types not discoverable by default, and the default verbosity on error handling. - classes to configure the service by implementing a static method named InitializeService, returning void, and taking a single argument of type . The configuration object may only be used during the call to service initialization. - + classes to configure the service by implementing a static method named InitializeService, returning void, and taking a single argument of type . The configuration object may only be used during the call to service initialization. + ]]> @@ -84,16 +84,16 @@ System.Int32 - Gets or sets the maximum number of segments that can be expanded by the $expand query option for all requests to the data service. + Gets or sets the maximum number of segments that can be expanded by the query option for all requests to the data service. The maximum number of segments to expand. - @@ -118,13 +118,13 @@ Gets or sets a maximum number of segments supported in a single $expand path for all requests to the data service. Integer representing the maximum number of supported segments in $expand path. - @@ -223,11 +223,11 @@ The rights allowed for the entity set. Sets the access rules for the specified entity set. - @@ -257,11 +257,11 @@ The rights allowed according to enumeration. Sets the access rules for the specified service operation. - @@ -286,11 +286,11 @@ Gets or sets whether verbose errors are used by default for all responses from the data service. A Boolean value that indicates whether verbose errors are returned. - diff --git a/xml/System.Diagnostics/EventLogInstaller.xml b/xml/System.Diagnostics/EventLogInstaller.xml index 9bbb7b3cf6b..0127fb3f5d0 100644 --- a/xml/System.Diagnostics/EventLogInstaller.xml +++ b/xml/System.Diagnostics/EventLogInstaller.xml @@ -18,47 +18,47 @@ Allows you to install and configure an event log that your application reads from or writes to when running. - is used by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool) when installing an event log. The class can install event logs only on the local computer. - - Use the class when your application writes to an event log; it is not necessary to use an event log installer for your application to read from an event log. Applications and services should write to the Application log or a custom log. Device drivers should write to the System log. - + is used by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool) when installing an event log. The class can install event logs only on the local computer. + + Use the class when your application writes to an event log; it is not necessary to use an event log installer for your application to read from an event log. Applications and services should write to the Application log or a custom log. Device drivers should write to the System log. + > [!NOTE] -> The Security log is read-only. - - The installer creates the event source that you specify in the property and registers it for the event log specified in property. This behavior is similar to calling on the component. - - Use the and methods to write events to an event log. You must specify an event source to write events; you must create and configure the event source before writing the first entry with the source. - - Create the new event source during the installation of your application. This allows time for the operating system to refresh its list of registered event sources and their configurations. If the operating system has not refreshed its list of event sources, and you attempt to write an event with the new source, the write operation will fail. You can configure a new source using an , or using the method. You must have administrative rights on the computer to create a new event source. - - You can create an event source for an existing event log or a new event log. When you create a new source for a new event log, the system registers the source for that log, but the log is not created until the first entry is written to it. - - To install an event log, create a project installer class that inherits from , and set the for the class to `true`. Within your project, create an for each event log that your application will write to and add the instance to your project installer class. - - When the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool) is called, it looks at the . If it is `true`, the tool installs all the items in the collection that are associated with your project installer. If is `false`, the tool ignores the project installer. - - You modify other properties of an either before or after adding the instance to the collection of your project installer, but before the installer tool runs. You must set the property if your application will be writing to the event log. - - Use to register a new source for a new or existing event log; do not use to change an existing source. The class does not modify the configuration properties of an existing source to match the specified installation properties. The method throws an exception if the property matches a source name that is registered for a different event log on the computer. The method does not register the source if the property matches a source name that is already registered for the same event log specified in the property. - - You can register the event source with localized resource files for your event category and message strings. Your application can write event log entries using resource identifiers, rather than specifying the actual string. The Event Viewer uses the resource identifier to find and display the corresponding string from the localized resource file based on current language settings. You can register a separate file for event categories, messages, and parameter insertion strings, or you can register the same resource file for all three types of strings. Use the , , , and properties to configure the source to write localized entries to the event log. If your application writes strings values directly to the event log, you do not need to set these properties. - - The source must be configured either for writing localized entries or for writing direct strings. If your application writes entries using both resource identifiers and string values, you must register two separate sources. For example, configure one source with resource files, and then use that source in the method to write entries using resource identifiers to the event log. Create a different source without resource files and then use that source in the method to write strings directly to the event log using that source. - - Typically, you do not call the methods of the class from within your code; they are generally called only by Installutil.exe. The tool automatically calls the method during the installation process. It backs out failures, if necessary, by calling the method for the object that generated the exception. - - - -## Examples - The following code example sets the installation properties for a new event source. The code example sets the source name and the event log name, and adds the to the collection. - +> The Security log is read-only. + + The installer creates the event source that you specify in the property and registers it for the event log specified in property. This behavior is similar to calling on the component. + + Use the and methods to write events to an event log. You must specify an event source to write events; you must create and configure the event source before writing the first entry with the source. + + Create the new event source during the installation of your application. This allows time for the operating system to refresh its list of registered event sources and their configurations. If the operating system has not refreshed its list of event sources, and you attempt to write an event with the new source, the write operation will fail. You can configure a new source using an , or using the method. You must have administrative rights on the computer to create a new event source. + + You can create an event source for an existing event log or a new event log. When you create a new source for a new event log, the system registers the source for that log, but the log is not created until the first entry is written to it. + + To install an event log, create a project installer class that inherits from , and set the for the class to `true`. Within your project, create an for each event log that your application will write to and add the instance to your project installer class. + + When the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool) is called, it looks at the . If it is `true`, the tool installs all the items in the collection that are associated with your project installer. If is `false`, the tool ignores the project installer. + + You modify other properties of an either before or after adding the instance to the collection of your project installer, but before the installer tool runs. You must set the property if your application will be writing to the event log. + + Use to register a new source for a new or existing event log; do not use to change an existing source. The class does not modify the configuration properties of an existing source to match the specified installation properties. The method throws an exception if the property matches a source name that is registered for a different event log on the computer. The method does not register the source if the property matches a source name that is already registered for the same event log specified in the property. + + You can register the event source with localized resource files for your event category and message strings. Your application can write event log entries using resource identifiers, rather than specifying the actual string. The Event Viewer uses the resource identifier to find and display the corresponding string from the localized resource file based on current language settings. You can register a separate file for event categories, messages, and parameter insertion strings, or you can register the same resource file for all three types of strings. Use the , , , and properties to configure the source to write localized entries to the event log. If your application writes strings values directly to the event log, you do not need to set these properties. + + The source must be configured either for writing localized entries or for writing direct strings. If your application writes entries using both resource identifiers and string values, you must register two separate sources. For example, configure one source with resource files, and then use that source in the method to write entries using resource identifiers to the event log. Create a different source without resource files and then use that source in the method to write strings directly to the event log using that source. + + Typically, you do not call the methods of the class from within your code; they are generally called only by Installutil.exe. The tool automatically calls the method during the installation process. It backs out failures, if necessary, by calling the method for the object that generated the exception. + + + +## Examples + The following code example sets the installation properties for a new event source. The code example sets the source name and the event log name, and adds the to the collection. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/EventLogInstaller/CPP/eventloginstaller.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventLogInstaller/Overview/eventloginstaller.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/EventLogInstaller/VB/eventloginstaller.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/EventLogInstaller/VB/eventloginstaller.vb" id="Snippet1"::: + ]]> @@ -111,137 +111,137 @@ Gets or sets the number of categories in the category resource file. The number of categories in the category resource file. The default value is zero. - and properties to write events with localized category strings. The Event Viewer displays the category for an event entry, if you supply a category when you write the event. Event log categories are application-defined strings that help filter events, or provide information on an event. For example, your application can define separate categories for different components or different operations. - - Event categories are optional; if your application does not use categories, do not set the and properties. - - 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. - + and properties to write events with localized category strings. The Event Viewer displays the category for an event entry, if you supply a category when you write the event. Event log categories are application-defined strings that help filter events, or provide information on an event. For example, your application can define separate categories for different components or different operations. + + Event categories are optional; if your application does not use categories, do not set the and properties. + + 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. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/eventlogInstaller_Resources/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventLogInstaller/CategoryCount/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventlogInstaller_Resources/VB/source.vb" id="Snippet1"::: - - The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings. - -``` -; // EventLogMsgs.mc -; // ******************************************************** - -; // Use the following commands to build this file: - -; // mc -s EventLogMsgs.mc -; // rc EventLogMsgs.rc -; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res -; // ******************************************************** - -; // - Event categories - -; // Categories must be numbered consecutively starting at 1. -; // ******************************************************** - -MessageId=0x1 -Severity=Success -SymbolicName=INSTALL_CATEGORY -Language=English -Installation -. - -MessageId=0x2 -Severity=Success -SymbolicName=QUERY_CATEGORY -Language=English -Database Query -. - -MessageId=0x3 -Severity=Success -SymbolicName=REFRESH_CATEGORY -Language=English -Data Refresh -. - -; // - Event messages - -; // ********************************* - -MessageId = 1000 -Severity = Success -Facility = Application -SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 -Language=English -My application message text, in English, for message id 1000, called from %1. -. - -MessageId = 1001 -Severity = Warning -Facility = Application -SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 -Language=English -My application message text, in English, for message id 1001, called from %1. -. - -MessageId = 1002 -Severity = Success -Facility = Application -SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 -Language=English -My generic information message in English, for message id 1002. -. - -MessageId = 1003 -Severity = Warning -Facility = Application -SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 -Language=English -My generic warning message in English, for message id 1003, called from %1. -. - -MessageId = 1004 -Severity = Success -Facility = Application -SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 -Language=English -The update cycle is complete for %%5002. -. - -MessageId = 1005 -Severity = Warning -Facility = Application -SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 -Language=English -The refresh operation did not complete because the connection to server %1 could not be established. -. - -; // - Event log display name - -; // ******************************************************** - -MessageId = 5001 -Severity = Success -Facility = Application -SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID -Language=English -Sample Event Log -. - -; // - Event message parameters - -; // Language independent insertion strings -; // ******************************************************** - -MessageId = 5002 -Severity = Success -Facility = Application -SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID -Language=English -SVC_UPDATE.EXE -. -``` - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventlogInstaller_Resources/VB/source.vb" id="Snippet1"::: + + The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings. + +``` +; // EventLogMsgs.mc +; // ******************************************************** + +; // Use the following commands to build this file: + +; // mc -s EventLogMsgs.mc +; // rc EventLogMsgs.rc +; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res +; // ******************************************************** + +; // - Event categories - +; // Categories must be numbered consecutively starting at 1. +; // ******************************************************** + +MessageId=0x1 +Severity=Success +SymbolicName=INSTALL_CATEGORY +Language=English +Installation +. + +MessageId=0x2 +Severity=Success +SymbolicName=QUERY_CATEGORY +Language=English +Database Query +. + +MessageId=0x3 +Severity=Success +SymbolicName=REFRESH_CATEGORY +Language=English +Data Refresh +. + +; // - Event messages - +; // ********************************* + +MessageId = 1000 +Severity = Success +Facility = Application +SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 +Language=English +My application message text, in English, for message id 1000, called from %1. +. + +MessageId = 1001 +Severity = Warning +Facility = Application +SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 +Language=English +My application message text, in English, for message id 1001, called from %1. +. + +MessageId = 1002 +Severity = Success +Facility = Application +SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 +Language=English +My generic information message in English, for message id 1002. +. + +MessageId = 1003 +Severity = Warning +Facility = Application +SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 +Language=English +My generic warning message in English, for message id 1003, called from %1. +. + +MessageId = 1004 +Severity = Success +Facility = Application +SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 +Language=English +The update cycle is complete for %%5002. +. + +MessageId = 1005 +Severity = Warning +Facility = Application +SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 +Language=English +The refresh operation did not complete because the connection to server %1 could not be established. +. + +; // - Event log display name - +; // ******************************************************** + +MessageId = 5001 +Severity = Success +Facility = Application +SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID +Language=English +Sample Event Log +. + +; // - Event message parameters - +; // Language independent insertion strings +; // ******************************************************** + +MessageId = 5002 +Severity = Success +Facility = Application +SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID +Language=English +SVC_UPDATE.EXE +. +``` + ]]> @@ -291,137 +291,137 @@ SVC_UPDATE.EXE Gets or sets the path of the resource file that contains category strings for the source. The path of the category resource file. The default is an empty string (""). - and properties to write events with localized category strings. The Event Viewer displays the category for an event entry if you supply a category when you write the event. Event log categories are application-defined strings that help filter events, or provide information about an event. For example, your application might have separate categories for different components or different operations. - - Event categories are optional; if your application does not use categories, do not set the and properties. - - 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. - + and properties to write events with localized category strings. The Event Viewer displays the category for an event entry if you supply a category when you write the event. Event log categories are application-defined strings that help filter events, or provide information about an event. For example, your application might have separate categories for different components or different operations. + + Event categories are optional; if your application does not use categories, do not set the and properties. + + 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. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/eventlogInstaller_Resources/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventLogInstaller/CategoryCount/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventlogInstaller_Resources/VB/source.vb" id="Snippet1"::: - - The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings. - -``` -; // EventLogMsgs.mc -; // ******************************************************** - -; // Use the following commands to build this file: - -; // mc -s EventLogMsgs.mc -; // rc EventLogMsgs.rc -; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res -; // ******************************************************** - -; // - Event categories - -; // Categories must be numbered consecutively starting at 1. -; // ******************************************************** - -MessageId=0x1 -Severity=Success -SymbolicName=INSTALL_CATEGORY -Language=English -Installation -. - -MessageId=0x2 -Severity=Success -SymbolicName=QUERY_CATEGORY -Language=English -Database Query -. - -MessageId=0x3 -Severity=Success -SymbolicName=REFRESH_CATEGORY -Language=English -Data Refresh -. - -; // - Event messages - -; // ********************************* - -MessageId = 1000 -Severity = Success -Facility = Application -SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 -Language=English -My application message text, in English, for message id 1000, called from %1. -. - -MessageId = 1001 -Severity = Warning -Facility = Application -SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 -Language=English -My application message text, in English, for message id 1001, called from %1. -. - -MessageId = 1002 -Severity = Success -Facility = Application -SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 -Language=English -My generic information message in English, for message id 1002. -. - -MessageId = 1003 -Severity = Warning -Facility = Application -SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 -Language=English -My generic warning message in English, for message id 1003, called from %1. -. - -MessageId = 1004 -Severity = Success -Facility = Application -SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 -Language=English -The update cycle is complete for %%5002. -. - -MessageId = 1005 -Severity = Warning -Facility = Application -SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 -Language=English -The refresh operation did not complete because the connection to server %1 could not be established. -. - -; // - Event log display name - -; // ******************************************************** - -MessageId = 5001 -Severity = Success -Facility = Application -SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID -Language=English -Sample Event Log -. - -; // - Event message parameters - -; // Language independent insertion strings -; // ******************************************************** - -MessageId = 5002 -Severity = Success -Facility = Application -SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID -Language=English -SVC_UPDATE.EXE -. -``` - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventlogInstaller_Resources/VB/source.vb" id="Snippet1"::: + + The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings. + +``` +; // EventLogMsgs.mc +; // ******************************************************** + +; // Use the following commands to build this file: + +; // mc -s EventLogMsgs.mc +; // rc EventLogMsgs.rc +; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res +; // ******************************************************** + +; // - Event categories - +; // Categories must be numbered consecutively starting at 1. +; // ******************************************************** + +MessageId=0x1 +Severity=Success +SymbolicName=INSTALL_CATEGORY +Language=English +Installation +. + +MessageId=0x2 +Severity=Success +SymbolicName=QUERY_CATEGORY +Language=English +Database Query +. + +MessageId=0x3 +Severity=Success +SymbolicName=REFRESH_CATEGORY +Language=English +Data Refresh +. + +; // - Event messages - +; // ********************************* + +MessageId = 1000 +Severity = Success +Facility = Application +SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 +Language=English +My application message text, in English, for message id 1000, called from %1. +. + +MessageId = 1001 +Severity = Warning +Facility = Application +SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 +Language=English +My application message text, in English, for message id 1001, called from %1. +. + +MessageId = 1002 +Severity = Success +Facility = Application +SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 +Language=English +My generic information message in English, for message id 1002. +. + +MessageId = 1003 +Severity = Warning +Facility = Application +SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 +Language=English +My generic warning message in English, for message id 1003, called from %1. +. + +MessageId = 1004 +Severity = Success +Facility = Application +SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 +Language=English +The update cycle is complete for %%5002. +. + +MessageId = 1005 +Severity = Warning +Facility = Application +SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 +Language=English +The refresh operation did not complete because the connection to server %1 could not be established. +. + +; // - Event log display name - +; // ******************************************************** + +MessageId = 5001 +Severity = Success +Facility = Application +SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID +Language=English +Sample Event Log +. + +; // - Event message parameters - +; // Language independent insertion strings +; // ******************************************************** + +MessageId = 5002 +Severity = Success +Facility = Application +SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID +Language=English +SVC_UPDATE.EXE +. +``` + ]]> @@ -453,21 +453,21 @@ SVC_UPDATE.EXE An to use as a template for the . Copies the property values of an component that are required at installation time for an event log. - ; otherwise, an exception is thrown. - - Typically, you do not call the methods of the from within your code; they are generally called only by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool). is used by Installutil.exe to set the property values for the to the values of an existing . - - If the of the that is passed in is an empty string (""), you must set the property to a valid value before the installer executes. - + ; otherwise, an exception is thrown. + + Typically, you do not call the methods of the from within your code; they are generally called only by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool). is used by Installutil.exe to set the property values for the to the values of an existing . + + If the of the that is passed in is an empty string (""), you must set the property to a valid value before the installer executes. + ]]> - The specified component is not an . - - -or- - + The specified component is not an . + + -or- + The or property of the specified component is either or empty. @@ -495,17 +495,17 @@ SVC_UPDATE.EXE An used to save information needed to perform a rollback or uninstall operation. Performs the installation and writes event log information to the registry. - method writes event log information to the registry, and associates the event log with a log that is specified by the property. If the log does not already exist (and a source is specified), creates a log and associates the new source with it. - - Typically, you do not call the methods of the from within your code; they are generally called only by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool). The tool automatically calls the method during the installation process to write registry information that is associated with the event log being installed. Installation is transactional, so if there is a failure of any installation project component during the installation, all the previously-installed components are rolled back to their pre-installation states. This is accomplished by calling each component's method. - - Use to register a new source for a new or existing event log; do not use to change an existing source. The class does not modify the configuration properties of an existing source to match the specified installation properties. The method throws an exception if the property matches a source name that is registered for a different event log on the computer. The method skips registering the source if the property matches a source name that is already registered for the same event log specified in the property. - - An application's install routine uses the project installer's property to automatically maintain information about the components that have already been installed. This state information, which is passed to as the `stateSaver` parameter, is continuously updated as the tool installs each . Usually, it is not necessary for your code to explicitly modify this state information. - + method writes event log information to the registry, and associates the event log with a log that is specified by the property. If the log does not already exist (and a source is specified), creates a log and associates the new source with it. + + Typically, you do not call the methods of the from within your code; they are generally called only by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool). The tool automatically calls the method during the installation process to write registry information that is associated with the event log being installed. Installation is transactional, so if there is a failure of any installation project component during the installation, all the previously-installed components are rolled back to their pre-installation states. This is accomplished by calling each component's method. + + Use to register a new source for a new or existing event log; do not use to change an existing source. The class does not modify the configuration properties of an existing source to match the specified installation properties. The method throws an exception if the property matches a source name that is registered for a different event log on the computer. The method skips registering the source if the property matches a source name that is already registered for the same event log specified in the property. + + An application's install routine uses the project installer's property to automatically maintain information about the components that have already been installed. This state information, which is passed to as the `stateSaver` parameter, is continuously updated as the tool installs each . Usually, it is not necessary for your code to explicitly modify this state information. + ]]> The name specified in the property is already registered for a different event log. @@ -540,11 +540,11 @@ SVC_UPDATE.EXE if this installer and the installer specified by the parameter would install or uninstall the same source; otherwise, . - from within your code; they are generally called only by the Installer tool (Installutil.exe). - + from within your code; they are generally called only by the Installer tool (Installutil.exe). + ]]> @@ -585,19 +585,19 @@ SVC_UPDATE.EXE Gets or sets the name of the log to set the source to. The name of the log. This can be Application, System, or a custom log name. The default is an empty string (""). - property to associate the source you specify in the property with either an existing log or a new log on the local computer. The [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool) uses this information to map the source to the log in the computer's registry. Applications and services should write to the Application log or a custom log. Device drivers should write to the System log. - - To write entries to an event log, you must create a source and register it with an event log. An event source can only write to one log at a time. The installer uses the value of the property to register your application with the event log as a valid source of entries. If you do not specify a log name before the installer runs, the installer registers your source to the Application log. If you specify a new source and an existing log, the installer creates a new event source and associates it with the log you specify. If you specify both a new source and a new log, the installer associates the new source with the new log in the registry, but the log is not created until the first entry is written to it. - - The operating system stores event logs as files. When you use or the method to create a new event log, the associated file is stored in the %SystemRoot%\System32\Config directory on the specified computer. The file name is set by appending the first 8 characters of the property with the ".evt" file name extension. - - Use to register a new source for a new or existing event log; do not use to change an existing source. The class does not modify the configuration properties of an existing source to match the specified installation properties. The method throws an exception if the property matches a source name that is registered for a different event log on the computer. The method does not register the source if the property matches a source name that is already registered for the same event log specified in the property. - - For more detailed information about the behaviors of event logs and sources, see the class documentation for the and properties. - + property to associate the source you specify in the property with either an existing log or a new log on the local computer. The [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool) uses this information to map the source to the log in the computer's registry. Applications and services should write to the Application log or a custom log. Device drivers should write to the System log. + + To write entries to an event log, you must create a source and register it with an event log. An event source can only write to one log at a time. The installer uses the value of the property to register your application with the event log as a valid source of entries. If you do not specify a log name before the installer runs, the installer registers your source to the Application log. If you specify a new source and an existing log, the installer creates a new event source and associates it with the log you specify. If you specify both a new source and a new log, the installer associates the new source with the new log in the registry, but the log is not created until the first entry is written to it. + + The operating system stores event logs as files. When you use or the method to create a new event log, the associated file is stored in the %SystemRoot%\System32\Config directory on the specified computer. The file name is set by appending the first 8 characters of the property with the ".evt" file name extension. + + Use to register a new source for a new or existing event log; do not use to change an existing source. The class does not modify the configuration properties of an existing source to match the specified installation properties. The method throws an exception if the property matches a source name that is registered for a different event log on the computer. The method does not register the source if the property matches a source name that is already registered for the same event log specified in the property. + + For more detailed information about the behaviors of event logs and sources, see the class documentation for the and properties. + ]]> @@ -646,143 +646,141 @@ SVC_UPDATE.EXE Gets or sets the path of the resource file that contains message formatting strings for the source. The path of the message resource file. The default is an empty string (""). - property to configure an event log source to write localized event messages. Event messages are application-defined strings that describe the event to the user. - - Your application can write event log entries using resource identifiers. A resource identifier indexes a message located in the . The Event Viewer uses the resource identifier to find and display the corresponding string from the localized resource file based on current language settings. - - The event source must be configured either for writing localized entries or for writing direct strings. Use the method to write localized entries for a source configured with a message resource file. - - If your application writes event message strings directly, rather than using a resource identifier in a localized resource file, do not set the property. - - If the property is not the local computer identifier ("."), the .NET Framework assumes that the resource file is on a remote computer. If the property value contains a drive letter, the resource file is assumed to be on the \\\\\\$ share (for example, \\\server\c$). If the value contains the string %systemroot%, the resource file is assumed to be on the \\\\\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. - + property to configure an event log source to write localized event messages. Event messages are application-defined strings that describe the event to the user. + + Your application can write event log entries using resource identifiers. A resource identifier indexes a message located in the . The Event Viewer uses the resource identifier to find and display the corresponding string from the localized resource file based on current language settings. + + The event source must be configured either for writing localized entries or for writing direct strings. Use the method to write localized entries for a source configured with a message resource file. + + If your application writes event message strings directly, rather than using a resource identifier in a localized resource file, do not set the property. + + If the property is not the local computer identifier ("."), the .NET Framework assumes that the resource file is on a remote computer. If the property value contains a drive letter, the resource file is assumed to be on the \\\\\\\\$ share (for example, \\\server\c\\$). If the value contains the string %systemroot%, the resource file is assumed to be on the \\\\\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. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/eventlogInstaller_Resources/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventLogInstaller/CategoryCount/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventlogInstaller_Resources/VB/source.vb" id="Snippet1"::: - - The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings. - -``` -; // EventLogMsgs.mc -; // ******************************************************** - -; // Use the following commands to build this file: - -; // mc -s EventLogMsgs.mc -; // rc EventLogMsgs.rc -; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res -; // ******************************************************** - -; // - Event categories - -; // Categories must be numbered consecutively starting at 1. -; // ******************************************************** - -MessageId=0x1 -Severity=Success -SymbolicName=INSTALL_CATEGORY -Language=English -Installation -. - -MessageId=0x2 -Severity=Success -SymbolicName=QUERY_CATEGORY -Language=English -Database Query -. - -MessageId=0x3 -Severity=Success -SymbolicName=REFRESH_CATEGORY -Language=English -Data Refresh -. - -; // - Event messages - -; // ********************************* - -MessageId = 1000 -Severity = Success -Facility = Application -SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 -Language=English -My application message text, in English, for message id 1000, called from %1. -. - -MessageId = 1001 -Severity = Warning -Facility = Application -SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 -Language=English -My application message text, in English, for message id 1001, called from %1. -. - -MessageId = 1002 -Severity = Success -Facility = Application -SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 -Language=English -My generic information message in English, for message id 1002. -. - -MessageId = 1003 -Severity = Warning -Facility = Application -SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 -Language=English -My generic warning message in English, for message id 1003, called from %1. -. - -MessageId = 1004 -Severity = Success -Facility = Application -SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 -Language=English -The update cycle is complete for %%5002. -. - -MessageId = 1005 -Severity = Warning -Facility = Application -SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 -Language=English -The refresh operation did not complete because the connection to server %1 could not be established. -. - -; // - Event log display name - -; // ******************************************************** - -MessageId = 5001 -Severity = Success -Facility = Application -SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID -Language=English -Sample Event Log -. - -; // - Event message parameters - -; // Language independent insertion strings -; // ******************************************************** - -MessageId = 5002 -Severity = Success -Facility = Application -SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID -Language=English -SVC_UPDATE.EXE -. -``` - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventlogInstaller_Resources/VB/source.vb" id="Snippet1"::: + + The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings. + +``` +; // EventLogMsgs.mc +; // ******************************************************** + +; // Use the following commands to build this file: + +; // mc -s EventLogMsgs.mc +; // rc EventLogMsgs.rc +; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res +; // ******************************************************** + +; // - Event categories - +; // Categories must be numbered consecutively starting at 1. +; // ******************************************************** + +MessageId=0x1 +Severity=Success +SymbolicName=INSTALL_CATEGORY +Language=English +Installation +. + +MessageId=0x2 +Severity=Success +SymbolicName=QUERY_CATEGORY +Language=English +Database Query +. + +MessageId=0x3 +Severity=Success +SymbolicName=REFRESH_CATEGORY +Language=English +Data Refresh +. + +; // - Event messages - +; // ********************************* + +MessageId = 1000 +Severity = Success +Facility = Application +SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 +Language=English +My application message text, in English, for message id 1000, called from %1. +. + +MessageId = 1001 +Severity = Warning +Facility = Application +SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 +Language=English +My application message text, in English, for message id 1001, called from %1. +. + +MessageId = 1002 +Severity = Success +Facility = Application +SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 +Language=English +My generic information message in English, for message id 1002. +. + +MessageId = 1003 +Severity = Warning +Facility = Application +SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 +Language=English +My generic warning message in English, for message id 1003, called from %1. +. + +MessageId = 1004 +Severity = Success +Facility = Application +SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 +Language=English +The update cycle is complete for %%5002. +. + +MessageId = 1005 +Severity = Warning +Facility = Application +SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 +Language=English +The refresh operation did not complete because the connection to server %1 could not be established. +. + +; // - Event log display name - +; // ******************************************************** + +MessageId = 5001 +Severity = Success +Facility = Application +SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID +Language=English +Sample Event Log +. + +; // - Event message parameters - +; // Language independent insertion strings +; // ******************************************************** + +MessageId = 5002 +Severity = Success +Facility = Application +SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID +Language=English +SVC_UPDATE.EXE +. +``` + ]]> @@ -830,164 +828,164 @@ SVC_UPDATE.EXE Gets or sets the path of the resource file that contains message parameter strings for the source. The path of the message parameter resource file. The default is an empty string (""). - property to configure an event log source to write localized event messages with inserted parameter strings. Each localized event message specified in the property can contain placeholders for insertion strings. These placeholders are used to specify the position and resource identifier for a language-independent string within the event message. The Event Viewer replaces the placeholders with the corresponding strings from the and formats the event log message for the localized event entry. - - For example, the following section of a message text file defines a string with a parameter placeholder: - -``` - -MessageId = 1501 -Severity = Success -Facility = Application -SymbolicName = COMPONENT_STARTING -Language=English -Component %%6050 is starting. -. -``` - - Within the parameter resource file, the insertion string must be defined with the resource identifier that corresponds to the placeholder, as shown below: - -``` -MessageId = 6050 -Severity = Success -Facility = Application -SymbolicName = COMPONENT_NAME_MSGID -Language=English -TRIGGER.EXE -. -``` - - The event source must be configured either for writing localized entries or for writing direct strings. Use the method to write localized entries for a source configured with a message resource file. - - If your application writes event message strings directly to the event log, or if your does not contain messages with parameter insertion placeholders, do not set the property. - - 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. - + property to configure an event log source to write localized event messages with inserted parameter strings. Each localized event message specified in the property can contain placeholders for insertion strings. These placeholders are used to specify the position and resource identifier for a language-independent string within the event message. The Event Viewer replaces the placeholders with the corresponding strings from the and formats the event log message for the localized event entry. + + For example, the following section of a message text file defines a string with a parameter placeholder: + +``` + +MessageId = 1501 +Severity = Success +Facility = Application +SymbolicName = COMPONENT_STARTING +Language=English +Component %%6050 is starting. +. +``` + + Within the parameter resource file, the insertion string must be defined with the resource identifier that corresponds to the placeholder, as shown below: + +``` +MessageId = 6050 +Severity = Success +Facility = Application +SymbolicName = COMPONENT_NAME_MSGID +Language=English +TRIGGER.EXE +. +``` + + The event source must be configured either for writing localized entries or for writing direct strings. Use the method to write localized entries for a source configured with a message resource file. + + If your application writes event message strings directly to the event log, or if your does not contain messages with parameter insertion placeholders, do not set the property. + + 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. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/eventlogInstaller_Resources/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Diagnostics/EventLogInstaller/CategoryCount/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventlogInstaller_Resources/VB/source.vb" id="Snippet1"::: - - The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings. Specifically, the message defined for resource identifier 1004 uses a placeholder for a parameter string defined for resource identifier 5002. - -``` -; // EventLogMsgs.mc -; // ******************************************************** - -; // Use the following commands to build this file: - -; // mc -s EventLogMsgs.mc -; // rc EventLogMsgs.rc -; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res -; // ******************************************************** - -; // - Event categories - -; // Categories must be numbered consecutively starting at 1. -; // ******************************************************** - -MessageId=0x1 -Severity=Success -SymbolicName=INSTALL_CATEGORY -Language=English -Installation -. - -MessageId=0x2 -Severity=Success -SymbolicName=QUERY_CATEGORY -Language=English -Database Query -. - -MessageId=0x3 -Severity=Success -SymbolicName=REFRESH_CATEGORY -Language=English -Data Refresh -. - -; // - Event messages - -; // ********************************* - -MessageId = 1000 -Severity = Success -Facility = Application -SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 -Language=English -My application message text, in English, for message id 1000, called from %1. -. - -MessageId = 1001 -Severity = Warning -Facility = Application -SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 -Language=English -My application message text, in English, for message id 1001, called from %1. -. - -MessageId = 1002 -Severity = Success -Facility = Application -SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 -Language=English -My generic information message in English, for message id 1002. -. - -MessageId = 1003 -Severity = Warning -Facility = Application -SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 -Language=English -My generic warning message in English, for message id 1003, called from %1. -. - -MessageId = 1004 -Severity = Success -Facility = Application -SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 -Language=English -The update cycle is complete for %%5002. -. - -MessageId = 1005 -Severity = Warning -Facility = Application -SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 -Language=English -The refresh operation did not complete because the connection to server %1 could not be established. -. - -; // - Event log display name - -; // ******************************************************** - -MessageId = 5001 -Severity = Success -Facility = Application -SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID -Language=English -Sample Event Log -. - -; // - Event message parameters - -; // Language independent insertion strings -; // ******************************************************** - -MessageId = 5002 -Severity = Success -Facility = Application -SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID -Language=English -SVC_UPDATE.EXE -. -``` - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/eventlogInstaller_Resources/VB/source.vb" id="Snippet1"::: + + The code example uses the following message text file, built into the resource library EventLogMsgs.dll. A message text file is the source from which the message resource file is created. The message text file defines the resource identifiers and text for the category, event message, and parameter insertion strings. Specifically, the message defined for resource identifier 1004 uses a placeholder for a parameter string defined for resource identifier 5002. + +``` +; // EventLogMsgs.mc +; // ******************************************************** + +; // Use the following commands to build this file: + +; // mc -s EventLogMsgs.mc +; // rc EventLogMsgs.rc +; // link /DLL /SUBSYSTEM:WINDOWS /NOENTRY /MACHINE:x86 EventLogMsgs.Res +; // ******************************************************** + +; // - Event categories - +; // Categories must be numbered consecutively starting at 1. +; // ******************************************************** + +MessageId=0x1 +Severity=Success +SymbolicName=INSTALL_CATEGORY +Language=English +Installation +. + +MessageId=0x2 +Severity=Success +SymbolicName=QUERY_CATEGORY +Language=English +Database Query +. + +MessageId=0x3 +Severity=Success +SymbolicName=REFRESH_CATEGORY +Language=English +Data Refresh +. + +; // - Event messages - +; // ********************************* + +MessageId = 1000 +Severity = Success +Facility = Application +SymbolicName = AUDIT_SUCCESS_MESSAGE_ID_1000 +Language=English +My application message text, in English, for message id 1000, called from %1. +. + +MessageId = 1001 +Severity = Warning +Facility = Application +SymbolicName = AUDIT_FAILED_MESSAGE_ID_1001 +Language=English +My application message text, in English, for message id 1001, called from %1. +. + +MessageId = 1002 +Severity = Success +Facility = Application +SymbolicName = GENERIC_INFO_MESSAGE_ID_1002 +Language=English +My generic information message in English, for message id 1002. +. + +MessageId = 1003 +Severity = Warning +Facility = Application +SymbolicName = GENERIC_WARNING_MESSAGE_ID_1003 +Language=English +My generic warning message in English, for message id 1003, called from %1. +. + +MessageId = 1004 +Severity = Success +Facility = Application +SymbolicName = UPDATE_CYCLE_COMPLETE_MESSAGE_ID_1004 +Language=English +The update cycle is complete for %%5002. +. + +MessageId = 1005 +Severity = Warning +Facility = Application +SymbolicName = SERVER_CONNECTION_DOWN_MESSAGE_ID_1005 +Language=English +The refresh operation did not complete because the connection to server %1 could not be established. +. + +; // - Event log display name - +; // ******************************************************** + +MessageId = 5001 +Severity = Success +Facility = Application +SymbolicName = EVENT_LOG_DISPLAY_NAME_MSGID +Language=English +Sample Event Log +. + +; // - Event message parameters - +; // Language independent insertion strings +; // ******************************************************** + +MessageId = 5002 +Severity = Success +Facility = Application +SymbolicName = EVENT_LOG_SERVICE_NAME_MSGID +Language=English +SVC_UPDATE.EXE +. +``` + ]]> @@ -1017,15 +1015,15 @@ SVC_UPDATE.EXE An that contains the pre-installation state of the computer. Restores the computer to the state it was in before the installation by rolling back the event log information that the installation procedure wrote to the registry. - method undoes the effects of the method. is called if the installation of any component in the installation project fails. The method creates or sets the properties for an event log and event source. either deletes the event log and source or resets the properties of a pre-existing source to its pre-installation values. - - Typically, you do not call the methods of the from within your code; they are generally called only by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool). The tool calls the method, when this or another component has failed to install, to undo any changes that the installation process has already made. - - An application's install routine uses the project installer's property to automatically maintain information about the components that have already been installed. This state information, which is passed to as the `savedState` parameter, is continuously updated as the tool rolls back each . Usually, it is not necessary for your code to explicitly modify this state information. - + method undoes the effects of the method. is called if the installation of any component in the installation project fails. The method creates or sets the properties for an event log and event source. either deletes the event log and source or resets the properties of a pre-existing source to its pre-installation values. + + Typically, you do not call the methods of the from within your code; they are generally called only by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool). The tool calls the method, when this or another component has failed to install, to undo any changes that the installation process has already made. + + An application's install routine uses the project installer's property to automatically maintain information about the components that have already been installed. This state information, which is passed to as the `savedState` parameter, is continuously updated as the tool rolls back each . Usually, it is not necessary for your code to explicitly modify this state information. + ]]> @@ -1068,19 +1066,19 @@ SVC_UPDATE.EXE Gets or sets the source name to register with the log. The name to register with the event log as a source of entries. The default is an empty string (""). - property to register your application with the event log as a valid source of entries. A new source name cannot match an existing source name or an existing event log name. Each source can only write to one event log at a time; however, your application can use multiple sources to write to multiple event logs. For example, your application might require multiple sources configured for different event logs or different resource files. - - Applications and services should write to the Application log or a custom log. Device drivers should write to the System log. If you do not specify a log name before the installer runs, the installer registers your source to the Application log. If you specify the name of a log that does not exist, the system registers the to that log, but the log is not created until the first entry is written to it. - - Use to register a new source for a new or existing event log; do not use to change an existing source. The class does not modify the configuration properties of an existing source to match the specified installation properties. The method throws an exception if the property matches a source name that is registered for a different event log on the computer. The method does not register the source if the property matches a source name that is already registered for the same event log specified in the property. - - For more detailed information about the behaviors of event logs and sources, see the class documentation for the and properties. - + property to register your application with the event log as a valid source of entries. A new source name cannot match an existing source name or an existing event log name. Each source can only write to one event log at a time; however, your application can use multiple sources to write to multiple event logs. For example, your application might require multiple sources configured for different event logs or different resource files. + + Applications and services should write to the Application log or a custom log. Device drivers should write to the System log. If you do not specify a log name before the installer runs, the installer registers your source to the Application log. If you specify the name of a log that does not exist, the system registers the to that log, but the log is not created until the first entry is written to it. + + Use to register a new source for a new or existing event log; do not use to change an existing source. The class does not modify the configuration properties of an existing source to match the specified installation properties. The method throws an exception if the property matches a source name that is registered for a different event log on the computer. The method does not register the source if the property matches a source name that is already registered for the same event log specified in the property. + + For more detailed information about the behaviors of event logs and sources, see the class documentation for the and properties. + ]]> @@ -1111,15 +1109,15 @@ SVC_UPDATE.EXE An that contains the pre-installation state of the computer. Removes an installation by removing event log information from the registry. - property value is `Remove`, the method deletes the source and the associated log that the installer created if the and properties specified the creation of a new event log and source. - - Typically, you do not call the methods of the from within your code; they are generally called only by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool) in uninstall mode. The tool automatically calls the method to restore the parts of the system that were affected by the installation to their pre-installation states. This includes deleting registry information that is associated with the event log being uninstalled. - - An application's uninstall routine uses the project installer's property to automatically maintain information about the components that have already been uninstalled. This state information, which is passed to as the `savedState` parameter, is continuously updated as the tool uninstalls each . Usually, it is not necessary for your code to explicitly modify this state information. - + property value is `Remove`, the method deletes the source and the associated log that the installer created if the and properties specified the creation of a new event log and source. + + Typically, you do not call the methods of the from within your code; they are generally called only by the [Installutil.exe (Installer Tool)](/dotnet/framework/tools/installutil-exe-installer-tool) in uninstall mode. The tool automatically calls the method to restore the parts of the system that were affected by the installation to their pre-installation states. This includes deleting registry information that is associated with the event log being uninstalled. + + An application's uninstall routine uses the project installer's property to automatically maintain information about the components that have already been uninstalled. This state information, which is passed to as the `savedState` parameter, is continuously updated as the tool uninstalls each . Usually, it is not necessary for your code to explicitly modify this state information. + ]]> @@ -1153,11 +1151,11 @@ SVC_UPDATE.EXE Gets or sets a value that indicates whether the Installutil.exe (Installer Tool) should remove the event log or leave it in its installed state at uninstall time. One of the values that indicates what state to leave the event log in when the is uninstalled. The default is . - to their pre-installation values. - + to their pre-installation values. + ]]> diff --git a/xml/System.Globalization/NumberFormatInfo.xml b/xml/System.Globalization/NumberFormatInfo.xml index f2bbfbe1a37..7a8598e2009 100644 --- a/xml/System.Globalization/NumberFormatInfo.xml +++ b/xml/System.Globalization/NumberFormatInfo.xml @@ -82,14 +82,21 @@ Provides culture-specific information for formatting and parsing numeric values. - For more information about this API, see Supplemental API remarks for NumberFormatInfo. - - The following example shows how to retrieve a object for a corresponding object, and use the retrieved object to query number formatting information for the particular culture. + + + For more information about this API, see [Supplemental API remarks for NumberFormatInfo](/dotnet/fundamentals/runtime-libraries/system-globalization-numberformatinfo). + + ## Example + + The following example shows how to retrieve a object for a corresponding object, and use the retrieved object to query number formatting information for the particular culture. + + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/NumberFormatInfo/cpp/NumberFormatInfo.cpp" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/System.Globalization/NumberFormatInfo/Overview/NumberFormatInfo.cs" id="Snippet1"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/NumberFormatInfo/vb/numberformatinfo.vb" id="Snippet1"::: + + ]]> + Custom Numeric Format Strings @@ -272,8 +279,6 @@ ## Remarks The property is used with the "C" standard format string without a precision specifier in numeric formatting operations. It defines the default number of fractional digits that appear after the decimal separator. This value is overridden if a precision specifier is used. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - - ## Examples The following example demonstrates the effect of changing the property. @@ -341,12 +346,10 @@ property is used with the "C" standard format string to define the symbol that separates integral from fractional digits. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - - ## Examples The following example demonstrates the effect of changing the property. @@ -415,12 +418,10 @@ property is used with the "C" standard format string to define the symbol that separates groups of integral digits. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - - ## Examples The following example demonstrates the effect of changing the property. @@ -492,9 +493,7 @@ The first element of the array defines the number of elements in the least significant group of digits immediately to the left of the . Each subsequent element refers to the next significant group of digits to the left of the previous group. If the last element of the array is not 0, the remaining digits are grouped based on the last element of the array. If the last element is 0, the remaining digits are not grouped. - For example, if the array contains { 3, 4, 5 }, the digits are grouped similar to "$55,55555,55555,55555,4444,333.00". If the array contains { 3, 4, 0 }, the digits are grouped similar to "$55555555555555555,4444,333.00". - - + For example, if the array contains { 3, 4, 5 }, the digits are grouped similar to "\\$55,55555,55555,55555,4444,333.00". If the array contains { 3, 4, 0 }, the digits are grouped similar to "\\$55555555555555555,4444,333.00". ## Examples The following example demonstrates the effect of changing the property. @@ -563,34 +562,32 @@ Gets or sets the format pattern for negative currency values. - The format pattern for negative currency values. The default for is 0, which represents "($n)", where "$" is the and is a number. + The format pattern for negative currency values. The default for is 0, which represents "(\\$n)", where "\\$" is the and is a number. property is used with the "C" standard format string to define the pattern of negative currency values. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). This property has one of the values in the following table. The symbol "$" is the , the symbol "-" is the , and `n` is a number. -|Value|Associated pattern| -|-----------|------------------------| -|0|($n)| -|1|-$n| -|2|$-n| -|3|$n-| -|4|(n$)| -|5|-n$| -|6|n-$| -|7|n$-| -|8|-n $| -|9|-$ n| -|10|n $-| -|11|$ n-| -|12|$ -n| -|13|n- $| -|14|($ n)| -|15|(n $)| -|16|$- n| - - +| Value | Associated pattern | +|-------|--------------------| +| 0 | ($n) | +| 1 | -$n | +| 2 | $-n | +| 3 | $n- | +| 4 | (n$) | +| 5 | -n$ | +| 6 | n-$ | +| 7 | n$- | +| 8 | -n $ | +| 9 | -$ n | +| 10 | n $- | +| 11 | $ n- | +| 12 | $ -n | +| 13 | n- $ | +| 14 | ($ n) | +| 15 | (n $) | +| 16 | $- n | ## Examples The following example shows how the property defines the format of negative currency values. It retrieves all the specific cultures that are defined on the host computer and displays each culture's property value, its associated pattern, and a number formatted as a currency value. @@ -653,21 +650,21 @@ Gets or sets the format pattern for positive currency values. - The format pattern for positive currency values. The default for is 0, which represents "$n", where "$" is the and is a number. + The format pattern for positive currency values. The default for is 0, which represents "\\$n", where "\\$" is the and is a number. property is used with the "C" standard format string to define pattern of positive currency values. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). This property has one of the values in the following table. The symbol "$" is the and `n` is a number. -|Value|Associated pattern| -|-----------|------------------------| -|0|$n| -|1|n$| -|2|$ n| -|3|n $| +| Value | Associated pattern | +|-------|--------------------| +| 0 | $n | +| 1 | n$ | +| 2 | $ n | +| 3 | n $ | - Note that the pattern does not support a positive sign. +The pattern does not support a positive sign. ]]> @@ -730,8 +727,6 @@ ## Remarks The string assigned to the property is included in the result string when a numeric value is formatted with the "C" [standard numeric format string](/dotnet/standard/base-types/standard-numeric-format-strings). - - ## Examples The following example displays the currency symbol for the current culture and uses the "C" standard numeric format string to format a currency value. @@ -807,8 +802,6 @@ ## Remarks Retrieving a object from the property is equivalent to retrieving a object from the `CultureInfo.CurrentCulture.NumberFormat` property. - - ## Examples The following example shows that the objects returned by the and `CultureInfo.CurrentCulture.NumberFormat` properties are identical. It then uses reflection to display the property values of the object returned by the property on a system whose current culture is en-US. @@ -869,10 +862,8 @@ [!IMPORTANT] -> The property is reserved for future use. Currently, it is not used in either parsing or formatting operations for the current object. +> The property is reserved for future use. Currently, it is not used in either parsing or formatting operations for the current object. ]]> @@ -1014,9 +1005,8 @@ Your application gets a object for a specific culture using one of the following methods: -- Through the property. - -- Through the method where `provider` is a . +- Through the property. +- Through the method where `provider` is a . A object is created only for the invariant culture or for specific cultures, not for neutral cultures. For more information about the invariant culture, specific cultures, and neutral cultures, see the class. @@ -1073,8 +1063,6 @@ ## Remarks This object returned by this property does not change, regardless of the current culture. It represents the formatting conventions of the invariant culture, which is a culture associated with the English language but not with any country/region. The invariant culture is used in formatting operations that are culture-independent or that produce result strings suitable for display across multiple cultures. - - ## Examples The following example displays the default property values of the . @@ -1252,9 +1240,7 @@ ## Remarks > [!IMPORTANT] -> The character set that is specified by the property has no effect on parsing or formatting operations. Only the Basic Latin digits 0 (U+0030) through 9 (U+0039) are used when formatting or parsing numeric values or date and time values. - - +> The character set that's specified by the property has no effect on parsing or formatting operations. Only the Basic Latin digits 0 (U+0030) through 9 (U+0039) are used when formatting or parsing numeric values or date and time values. ## Examples The following example demonstrates the property. @@ -1332,7 +1318,6 @@ or . ]]> @@ -1391,8 +1376,6 @@ ## Remarks This property is used in both formatting and parsing operations. For more information on its use in formatting operations, see the [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings) and [Custom Numeric Format Strings](/dotnet/standard/base-types/custom-numeric-format-strings) topics. - - ## Examples The following example instantiates a read-write object that represents the invariant culture and assigns the OVERLINE character (U+203E) to its property. It then uses this object to format an array of negative floating-point numbers. @@ -1454,8 +1437,6 @@ ## Remarks The property is used with the "F" and "N" standard format strings without a precision specifier in numeric formatting operations. It defines the default number of fractional digits that appear after the decimal separator. This value is overridden if a precision specifier is used. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - - ## Examples The following example demonstrates the effect of changing the property. @@ -1524,9 +1505,7 @@ ## Remarks The property is used with the "E", "F", "G", "N", and "R" standard format strings to define the symbol that separates integral from fractional digits. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - The initial value of this property is derived from the settings in the **Region and Language** item in Control Panel. - - +On Windows, the initial value of this property is derived from the settings in the **Region and Language** item in Control Panel. ## Examples The following example demonstrates the effect of changing the property. @@ -1597,9 +1576,7 @@ ## Remarks The property is used with the "N" standard format string to define the symbol that separates groups of integral digits. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - The initial value of this property is derived from the settings in the **Region and Language** item in Control Panel. - - +On Windows, the initial value of this property is derived from the settings in the **Region and Language** item in Control Panel. ## Examples The following example demonstrates the effect of changing the property. @@ -1675,8 +1652,6 @@ For example, if the array contains { 3, 4, 5 }, the digits are grouped similar to "55,55555,55555,55555,4444,333.00". If the array contains { 3, 4, 0 }, the digits are grouped similar to "55555555555555555,4444,333.00". - - ## Examples The following example demonstrates the effect of changing the property. @@ -1756,18 +1731,16 @@ ## Remarks The property defines the format of negative values formatted with the "N" standard numeric format string. This property has one of the values in the following table. The symbol "-" is the and `n` is a number. -|Value|Associated pattern| -|-----------|------------------------| -|0|(n)| -|1|-n| -|2|- n| -|3|n-| -|4|n -| +| Value | Associated pattern | +|-------|--------------------| +| 0 | (n) | +| 1 | -n | +| 2 | - n | +| 3 | n- | +| 4 | n - | The default value for the invariant culture returned by the property is 1, which represents "-n", where *n* is a number. - - ## Examples The following example displays a value using different patterns. @@ -1836,8 +1809,6 @@ ## Remarks The property is used with the "P" standard format string without a precision specifier in numeric formatting operations. It defines the default number of fractional digits that appear after the decimal separator. This value is overridden if a precision specifier is used. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - - ## Examples The following example demonstrates the effect of changing the property. @@ -1907,8 +1878,6 @@ ## Remarks The property is used with the "P" standard format string to define the symbol that separates integral from fractional digits. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - - ## Examples The following example demonstrates the effect of changing the property. @@ -1979,8 +1948,6 @@ ## Remarks The property is used with the "P" standard format string to define the symbol that separates groups of integers. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). - - ## Examples The following example demonstrates the effect of changing the property. @@ -2054,8 +2021,6 @@ For example, if the array contains { 3, 4, 5 }, the digits are grouped similar to "55,55555,55555,55555,4444,333.00%". If the array contains { 3, 4, 0 }, the digits are grouped similar to "55555555555555555,4444,333.00%". - - ## Examples The following example demonstrates the effect of changing the property. @@ -2130,20 +2095,20 @@ ## Remarks The property is used with the "P" standard format string to define the pattern of negative percentage values. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). This property has one of the values in the following table. The symbol "%" is the , the symbol "-" is the , and `n` is a number. Values 3-11 were introduced in the .NET Framework 2.0 and cannot be used in earlier versions. -|Value|Associated pattern| -|-----------|------------------------| -|0|-n %| -|1|-n%| -|2|-%n| -|3|%-n| -|4|%n-| -|5|n-%| -|6|n%-| -|7|-% n| -|8|n %-| -|9|% n-| -|10|% -n| -|11|n- %| +| Value | Associated pattern | +|-------|--------------------| +| 0 | -n % | +| 1 | -n% | +| 2 | -%n | +| 3 | %-n | +| 4 | %n- | +| 5 | n-% | +| 6 | n%- | +| 7 | -% n | +| 8 | n %- | +| 9 | % n- | +| 10 | % -n | +| 11 | n- % | ]]> @@ -2207,12 +2172,12 @@ ## Remarks The property is used with the "P" standard format string to define pattern of positive percentage values. For more information, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). This property has one of the values in the following table. The symbol "%" is the and `n` is a number. -|Value|Associated pattern| -|-----------|------------------------| -|0|n %| -|1|n%| -|2|%n| -|3|% n| +| Value | Associated pattern | +|-------|--------------------| +| 0 | n % | +| 1 | n% | +| 2 | %n | +| 3 | % n | ]]> diff --git a/xml/System.Net/Cookie.xml b/xml/System.Net/Cookie.xml index 7f0d7c562e0..07788ff778b 100644 --- a/xml/System.Net/Cookie.xml +++ b/xml/System.Net/Cookie.xml @@ -62,22 +62,22 @@ Provides a set of properties and methods that are used to manage cookies. This class cannot be inherited. - class is used by a client application to retrieve information about cookies that are received with HTTP responses. The following cookie formats are supported during parsing of the HTTP response headers: the original Netscape specification, RFC 2109, and RFC 2965. - - For a list of initial property values for an instance of , see the various constructors. - - - -## Examples - The following example sends a request to a URL and displays the cookies returned in the response. - + class is used by a client application to retrieve information about cookies that are received with HTTP responses. The following cookie formats are supported during parsing of the HTTP response headers: the original Netscape specification, RFC 2109, and RFC 2965. + + For a list of initial property values for an instance of , see the various constructors. + + + +## Examples + The following example sends a request to a URL and displays the cookies returned in the response. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet1"::: + ]]> @@ -137,11 +137,11 @@ Initializes a new instance of the class. - property must be initialized before using an instance of the class. - + property must be initialized before using an instance of the class. + ]]> @@ -200,47 +200,47 @@ The value of a . The following characters must not be used inside : semicolon, comma. Initializes a new instance of the class with a specified and . - must not be a `null` reference (Nothing in Visual Basic). The semicolon (";") and comma (",") characters are reserved and cannot be passed in the `value` parameter unless the string passed in the `value` parameter is enclosed in double quotes. So the following example constructor would succeed, but when you try to add this to a instance with the or methods, the operation will fail and throw an exception: - + must not be a `null` reference (Nothing in Visual Basic). The semicolon (";") and comma (",") characters are reserved and cannot be passed in the `value` parameter unless the string passed in the `value` parameter is enclosed in double quotes. So the following example constructor would succeed, but when you try to add this to a instance with the or methods, the operation will fail and throw an exception: + ```csharp System.Net.Cookie cookie = new System.Net.Cookie("contoso", "123,456"); cookie.Domain = "contoso.com"; new CookieContainer().Add(cookie); - ``` - - However, the following constructor with these special characters escaped will create a that can be added to a instance: - + ``` + + However, the following constructor with these special characters escaped will create a that can be added to a instance: + ```csharp System.Net.Cookie cookie = new System.Net.Cookie("contoso", "\"123,456\""); cookie.Domain = "contoso.com"; new CookieContainer().Add(cookie); ``` - - The comma character is used as a delimiter between separate cookies on the same line. - + + The comma character is used as a delimiter between separate cookies on the same line. + ]]> - The parameter is . - - -or- - - The parameter is of zero length. - - -or- - - The parameter contains an invalid character. - - -or- - - The parameter is . - - -or - - + The parameter is . + + -or- + + The parameter is of zero length. + + -or- + + The parameter contains an invalid character. + + -or- + + The parameter is . + + -or - + The parameter contains a string not enclosed in quotes that contains an invalid character. @@ -303,47 +303,47 @@ The subset of URIs on the origin server to which this applies. The default value is "/". Initializes a new instance of the class with a specified , , and . - must not be a `null` reference (Nothing in Visual Basic). The semicolon (";") and comma (",") characters are reserved and cannot be passed in the `value` parameter unless the string passed in the `value` parameter is enclosed in double quotes. So the following example constructor would succeed, but when you try to add this to a instance with the or methods, the operation will fail and throw an exception: - + must not be a `null` reference (Nothing in Visual Basic). The semicolon (";") and comma (",") characters are reserved and cannot be passed in the `value` parameter unless the string passed in the `value` parameter is enclosed in double quotes. So the following example constructor would succeed, but when you try to add this to a instance with the or methods, the operation will fail and throw an exception: + ```csharp System.Net.Cookie cookie = new System.Net.Cookie("contoso", "123,456", ""); cookie.Domain = "contoso.com"; new CookieContainer().Add(cookie); - ``` - - However, the following constructor with these special characters escaped will create a that can be added to a instance: - + ``` + + However, the following constructor with these special characters escaped will create a that can be added to a instance: + ```csharp System.Net.Cookie cookie = new System.Net.Cookie("contoso", "\"123,456\"", ""); cookie.Domain = "contoso.com"; new CookieContainer().Add(cookie); - ``` - - The comma character is used as a delimiter between separate cookies on the same line. - + ``` + + The comma character is used as a delimiter between separate cookies on the same line. + ]]> - The parameter is . - - -or- - - The parameter is of zero length. - - -or- - - The parameter contains an invalid character. - - -or- - - The parameter is . - - -or - - + The parameter is . + + -or- + + The parameter is of zero length. + + -or- + + The parameter contains an invalid character. + + -or- + + The parameter is . + + -or - + The parameter contains a string not enclosed in quotes that contains an invalid character. @@ -408,45 +408,45 @@ The optional internet domain for which this is valid. The default value is the host this has been received from. Initializes a new instance of the class with a specified , , , and . - must not be a `null` reference (Nothing in Visual Basic). The semicolon (";") and comma (",") characters are reserved and cannot be passed in the `value` parameter unless the string passed in the `value` parameter is enclosed in double quotes. So the following example constructor would succeed, but when you try to add this to a instance with the or methods, the operation will fail and throw an exception: - + must not be a `null` reference (Nothing in Visual Basic). The semicolon (";") and comma (",") characters are reserved and cannot be passed in the `value` parameter unless the string passed in the `value` parameter is enclosed in double quotes. So the following example constructor would succeed, but when you try to add this to a instance with the or methods, the operation will fail and throw an exception: + ```csharp System.Net.Cookie cookie = new System.Net.Cookie("contoso", "123,456", "", "contoso.com"); new CookieContainer().Add(cookie); - ``` - - However, the following constructor with these special characters escaped will create a that can be added to a instance: - + ``` + + However, the following constructor with these special characters escaped will create a that can be added to a instance: + ```csharp System.Net.Cookie cookie = new System.Net.Cookie("contoso", "\"123,456\"", "", "contoso.com"); new CookieContainer().Add(cookie); - ``` - - The comma character is used as a delimiter between separate cookies on the same line. - + ``` + + The comma character is used as a delimiter between separate cookies on the same line. + ]]> - The parameter is . - - -or- - - The parameter is of zero length. - - -or- - - The parameter contains an invalid character. - - -or- - - The parameter is . - - -or - - + The parameter is . + + -or- + + The parameter is of zero length. + + -or- + + The parameter contains an invalid character. + + -or- + + The parameter is . + + -or - + The parameter contains a string not enclosed in quotes that contains an invalid character. @@ -503,20 +503,20 @@ Gets or sets a comment that the server can add to a . An optional comment to document intended usage for this . - class topic. - + class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -583,20 +583,20 @@ Gets or sets a URI comment that the server can provide with a . An optional comment that represents the intended usage of the URI reference for this . The value must conform to URI format. - . - - - -## Examples - The following example displays the properties of cookies that are returned in a response. For the complete example, see the class topic. - + . + + + +## Examples + The following example displays the properties of cookies that are returned in a response. For the complete example, see the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -659,20 +659,20 @@ if the client is to discard the at the end of the current session; otherwise, . The default is . - on the user's hard disk when a session ends. - - - -## Examples - The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. - + on the user's hard disk when a session ends. + + + +## Examples + The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -730,20 +730,20 @@ Gets or sets the URI for which the is valid. The URI for which the is valid. - class topic. - + class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -857,20 +857,20 @@ if the has expired; otherwise, . The default is . - class topic. - + class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -932,22 +932,22 @@ Gets or sets the expiration date and time for the as a . The expiration date and time for the as a instance. - makes this a session cookie, which is its default value. - - The property of is used to determine if the cookie is set to or . If the property is set to , then is assumed. - - - -## Examples - The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. - + makes this a session cookie, which is its default value. + + The property of is used to determine if the cookie is set to or . If the property is set to , then is assumed. + + + +## Examples + The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -1000,11 +1000,11 @@ Overrides the method. The 32-bit signed integer hash code for this instance. - @@ -1062,11 +1062,11 @@ Determines whether a page script or other active content can access this cookie. Boolean value that determines whether a page script or other active content can access this cookie. - @@ -1121,28 +1121,26 @@ Gets or sets the name for the . The name for the . - property must be initialized before using an instance of the class. - - 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 class topic. - + property must be initialized before using an instance of the class. + + 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 class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> - The value specified for a set operation is or the empty string - + The value specified for a set operation is or the empty string + -or- - + The value specified for a set operation contained an illegal character. The following characters must not be used inside the property: equal sign, semicolon, comma, newline (\n), return (\r), tab (\t), and space character. The dollar sign character ("$") cannot be the first character. @@ -1199,20 +1197,20 @@ Gets or sets the URIs to which the applies. The URIs to which the applies. - property specifies the subset of URIs on the origin server to which this applies. If this property is not specified, then this will be sent to all pages on the origin server or servers. - - - -## Examples - The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. - + property specifies the subset of URIs on the origin server to which this applies. If this property is not specified, then this will be sent to all pages on the origin server or servers. + + + +## Examples + The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -1270,20 +1268,20 @@ Gets or sets a list of TCP ports that the applies to. The list of TCP ports that the applies to. - may be sent. The default value means no restriction. Setting this to the empty string ("") will restrict the port to the one used in the HTTP response. Otherwise, the value must be a double-quoted string that contains port values delimited with commas. - - - -## Examples - The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. - + may be sent. The default value means no restriction. Setting this to the empty string ("") will restrict the port to the one used in the HTTP response. Otherwise, the value must be a double-quoted string that contains port values delimited with commas. + + + +## Examples + The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> The value specified for a set operation could not be parsed or is not enclosed in double quotes. @@ -1347,20 +1345,20 @@ if the client is only to return the cookie in subsequent requests if those requests use Secure Hypertext Transfer Protocol (HTTPS); otherwise, . The default is . - class topic. - + class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -1418,20 +1416,20 @@ Gets the time when the cookie was issued as a . The time when the cookie was issued as a . - class topic. - + class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -1484,20 +1482,20 @@ Overrides the method. Returns a string representation of this object that is suitable for including in a HTTP Cookie: request header. - class topic. - + class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet4"::: + ]]> @@ -1552,22 +1550,22 @@ Gets or sets the for the . The for the . - of a must not be `null`. If a `null` value is assigned to this property, it's replaced with an empty string. + of a must not be `null`. If a `null` value is assigned to this property, it's replaced with an empty string. Semicolons and commas are reserved characters that cannot be used in the value of this property. Assigning invalid characters to this property doesn't throw an exception; but when you try to add this to a instance with the method, the operation will fail and throw an exception. - - - -## Examples - The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. - + + + +## Examples + The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> @@ -1625,22 +1623,22 @@ Gets or sets the version of HTTP state maintenance to which the cookie conforms. The version of HTTP state maintenance to which the cookie conforms. - property is 0, complying with the original Netscape specification. If the value is explicitly set to 1, then this must conform to RFC 2109. Note that if a was created automatically by receiving a Set-Cookie2 HTTP response header, the conformance is set to RFC 2965. - - An attempt to set the property to a value less than zero will throw an exception. - - - -## Examples - The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. - + property is 0, complying with the original Netscape specification. If the value is explicitly set to 1, then this must conform to RFC 2109. Note that if a was created automatically by receiving a Set-Cookie2 HTTP response header, the conformance is set to RFC 2965. + + An attempt to set the property to a value less than zero will throw an exception. + + + +## Examples + The following example displays the properties of cookies returned in a response. For the complete example, see the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NCLCookies/CPP/cookiessnippets.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Net/Cookie/Overview/cookiessnippets.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/NCLCookies/VB/cookiessnippets.vb" id="Snippet3"::: + ]]> The value specified for a version is not allowed. diff --git a/xml/System.Net/CookieException.xml b/xml/System.Net/CookieException.xml index a22f6aaf715..bb4c39b8a33 100644 --- a/xml/System.Net/CookieException.xml +++ b/xml/System.Net/CookieException.xml @@ -69,7 +69,7 @@ ## Remarks This exception is thrown if an attempt is made to a with length greater than to a . - **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 with length greater than to a . The default maximum cookie size is 4096 bytes. diff --git a/xml/System.Security.Policy/CodeConnectAccess.xml b/xml/System.Security.Policy/CodeConnectAccess.xml index e2ebbe6c698..26a894b1225 100644 --- a/xml/System.Security.Policy/CodeConnectAccess.xml +++ b/xml/System.Security.Policy/CodeConnectAccess.xml @@ -40,23 +40,23 @@ Specifies the network resource access that is granted to code. - class to control how executing code can connect back to the site it was downloaded from. These classes provide programmatic control of the granted to executing code that controls what schemes and ports the code can use access its origin site. You can specify scheme and port pairs that are permitted based on the scheme in the URL where the code originates. - - To create a object based on the code's origin scheme, use the method. - - To create a object that can use any scheme but is restricted by port, use the method. - - - -## Examples - The following code example creates a object and adds it to the User policy level. - + class to control how executing code can connect back to the site it was downloaded from. These classes provide programmatic control of the granted to executing code that controls what schemes and ports the code can use access its origin site. You can specify scheme and port pairs that are permitted based on the scheme in the URL where the code originates. + + To create a object based on the code's origin scheme, use the method. + + To create a object that can use any scheme but is restricted by port, use the method. + + + +## Examples + The following code example creates a object and adds it to the User policy level. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet3"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet3"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet3"::: + ]]> @@ -94,40 +94,40 @@ The port represented by the current instance. Initializes a new instance of the class. - property is set using the `allowScheme` parameter. The scheme is converted to lowercase. The value of controls the scheme that executing code can use to connect to a network resource. - - The property is set using the `allowPort` parameter. The value of controls the port that executing code can use to connect to a network resource. - - - -## Examples - The following code example demonstrates creating a object that permits downloaded code to connect back to its origin server using the HTTP protocol and the same port it was downloaded on. For an example that demonstrates using objects to create a code group and adding the code group to a policy level, see the class overview. - + property is set using the `allowScheme` parameter. The scheme is converted to lowercase. The value of controls the scheme that executing code can use to connect to a network resource. + + The property is set using the `allowPort` parameter. The value of controls the port that executing code can use to connect to a network resource. + + + +## Examples + The following code example demonstrates creating a object that permits downloaded code to connect back to its origin server using the HTTP protocol and the same port it was downloaded on. For an example that demonstrates using objects to create a code group and adding the code group to a policy level, see the class overview. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet2"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet2"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet2"::: + ]]> - is . - - -or- - - is an empty string (""). - - -or- - - contains characters that are not permitted in schemes. - - -or- - - is less than 0. - - -or- - + is . + + -or- + + is an empty string (""). + + -or- + + contains characters that are not permitted in schemes. + + -or- + + is less than 0. + + -or- + is greater than 65,535. @@ -161,21 +161,21 @@ Contains the string value that represents the scheme wildcard. - object using this value, you can call the method to obtain a object that represents a specified port and any scheme. - - The value of this field is "*". - - - -## Examples - The following code example displays the value of this field. - + object using this value, you can call the method to obtain a object that represents a specified port and any scheme. + + The value of this field is "*". + + + +## Examples + The following code example displays the value of this field. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet6"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet6"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet6"::: + ]]> @@ -215,26 +215,26 @@ Returns a instance that represents access to the specified port using any scheme. A instance for the specified port. - instance returned by this method uses the scheme wildcard value ("*") to represent the scheme. - - - -## Examples - The following code example demonstrates calling this method. For an example that demonstrates using objects to create a code group and adding the code group to a policy level, see the class overview. - + instance returned by this method uses the scheme wildcard value ("*") to represent the scheme. + + + +## Examples + The following code example demonstrates calling this method. For an example that demonstrates using objects to create a code group and adding the code group to a policy level, see the class overview. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet5"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet5"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet5"::: + ]]> - is less than 0. - - -or- - + is less than 0. + + -or- + is greater than 65,535. @@ -273,26 +273,26 @@ Returns a instance that represents access to the specified port using the code's scheme of origin. A instance for the specified port. - instance returned by this method has the scheme value . The origin scheme is the scheme value from the URI where the code originated. - - - -## Examples - The following code example demonstrates using objects to create a code group and adding the code group to a policy level. - + instance returned by this method has the scheme value . The origin scheme is the scheme value from the URI where the code originated. + + + +## Examples + The following code example demonstrates using objects to create a code group and adding the code group to a policy level. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet3"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet3"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet3"::: + ]]> - is less than 0. - - -or- - + is less than 0. + + -or- + is greater than 65,535. @@ -326,21 +326,21 @@ Contains the value used to represent the default port. - object that has the default port for a specified scheme, use this field as the `allowPort` parameter of the constructor. - - The value of this field is -3. - - - -## Examples - The following code example demonstrates creating a object that specifies FTP for the scheme and the default port for FTP. - + object that has the default port for a specified scheme, use this field as the `allowPort` parameter of the constructor. + + The value of this field is -3. + + + +## Examples + The following code example demonstrates creating a object that specifies FTP for the scheme and the default port for FTP. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet1"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet1"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet1"::: + ]]> @@ -381,11 +381,11 @@ if the two objects represent the same scheme and port; otherwise, . - objects are equal if their and property values are equal. - + objects are equal if their and property values are equal. + ]]> @@ -455,21 +455,21 @@ Contains the value used to represent the port value in the URI where code originated. - object that has the same port as the port in the executing code's URL evidence, use this field as the `allowPort` parameter of the constructor. - - The value of this field is -4. - - - -## Examples - The following code example demonstrates creating a object that specifies the HTTP scheme and origin port. - + object that has the same port as the port in the executing code's URL evidence, use this field as the `allowPort` parameter of the constructor. + + The value of this field is -4. + + + +## Examples + The following code example demonstrates creating a object that specifies the HTTP scheme and origin port. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet2"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet2"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet2"::: + ]]> @@ -504,21 +504,19 @@ Contains the value used to represent the scheme in the URL where the code originated. - constructor. Instead, use the method. - - The value of this field is "$origin". - - - -## Examples - The following code example displays the value of this field. - + constructor. Instead, use the method. + + The value of this field is "$origin". + +## Examples + The following code example displays the value of this field. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet6"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet6"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet6"::: + ]]> @@ -554,19 +552,19 @@ Gets the port represented by the current instance. A value that identifies a computer port used in conjunction with the property. - . - - - -## Examples - The following code example demonstrates displaying the value of this property. - + . + + + +## Examples + The following code example demonstrates displaying the value of this property. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet4"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet4"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet4"::: + ]]> @@ -602,19 +600,19 @@ Gets the URI scheme represented by the current instance. A that identifies a URI scheme, converted to lowercase. - . - - - -## Examples - The following code example demonstrates displaying the value of this property. - + . + + + +## Examples + The following code example demonstrates displaying the value of this property. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/NclCodeGroup/cpp/sample.cpp" id="Snippet4"::: - :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet4"::: - + :::code language="csharp" source="~/snippets/csharp/System.Security.Policy/CodeConnectAccess/Overview/sample.cs" id="Snippet4"::: + ]]> diff --git a/xml/System.Speech.Recognition.SrgsGrammar/SrgsRule.xml b/xml/System.Speech.Recognition.SrgsGrammar/SrgsRule.xml index 42ddd64befa..8e22744d1ef 100644 --- a/xml/System.Speech.Recognition.SrgsGrammar/SrgsRule.xml +++ b/xml/System.Speech.Recognition.SrgsGrammar/SrgsRule.xml @@ -97,8 +97,6 @@ - `id` contains at least one invalid rule ID character. These characters are: '?', '*', '+', '|', '(', '), '^', '$', '/', ';', '.', '=', '\<', '>', '[', ']', '{', '}', '\\\\', ' ', '\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 object named `winnerRule` and passes in the identifier `WorldCupWinner` as a . The object consists of an array of new objects containing alternatives to be recognized by the rule. @@ -190,8 +188,6 @@ public void WorldSoccerWinners () - `id` contains at least one invalid rule ID character. These characters are: '?', '*', '+', '|', '(', '), '^', '$', '/', ';', '.', '=', '\<', '>', '[', ']', '{', '}', '\\\\', ' ', '\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 objects, `ruleEurope` and `ruleSAmerica`, passing in a for the rule identifier and an array containing a object. Subsequently, the example adds rule references to `ruleEurope` and `ruleSAmerica` from the rule `WorldCupWinner`. @@ -446,11 +442,11 @@ document.Root = winnerRule; A value used to set must adhere to the following rules: -- The value must be a valid XML name, as defined in [Extensible Markup Language (XML) 1.0 (Fifth Edition)](https://www.w3.org/TR/REC-xml/). To paraphrase this definition, a valid XML name must begin with a letter, an underscore ('_'), or a colon (':') and can be followed by zero or more NameChar characters (also defined in the XML specification). +- The value must be a valid XML name, as defined in [Extensible Markup Language (XML) 1.0 (Fifth Edition)](https://www.w3.org/TR/REC-xml/). To paraphrase this definition, a valid XML name must begin with a letter, an underscore ('_'), or a colon (':') and can be followed by zero or more NameChar characters (also defined in the XML specification). -- The value can be "NULL" or "VOID" or "GARBAGE". +- The value can be "NULL" or "VOID" or "GARBAGE". -- The value cannot contain any invalid rule ID character. These characters are: '?', '*', '+', '|', '(', '), '^', '$', '/', ';', '.', '=', '\<', '>', '[', ']', '{', '}', '\\\\', ' ', '\t', '\r', and '\n'. +- The value cannot contain any invalid rule ID character. These characters are: '?', '*', '+', '|', '(', '), '^', '$', '/', ';', '.', '=', '\<', '>', '[', ']', '{', '}', '\\\\', ' ', '\t', '\r', and '\n'. ]]> diff --git a/xml/System.Speech.Recognition/RecognizedWordUnit.xml b/xml/System.Speech.Recognition/RecognizedWordUnit.xml index 38928898cce..c7102aefc54 100644 --- a/xml/System.Speech.Recognition/RecognizedWordUnit.xml +++ b/xml/System.Speech.Recognition/RecognizedWordUnit.xml @@ -30,86 +30,86 @@ Provides the atomic unit of recognized speech. - objects. - - An array of objects is accessible for any recognition operation through the property on the object. - - In addition to providing a measure of recognition certainty () a instance provides: - -- Normalized and exact (or lexical) text representations for a recognized word. For more information, see , , and . - -- Pronunciation information using characters from a supported phonetic alphabet, such as the International Phonetic Alphabet (IPA) or the Universal Phone Set (UPS). For more information see . - -- Formatting for printing. For more information see the class and its property. - - - -## Examples - The following example shows a utility routine (`stringFromWordArray`) that generates strings. The strings contain lexical output (using ), normalized text (using ), or phonetic characters from the International Phonetic Alphabet (using ). Strings are formatted using objects obtained from the property from a of objects. The objects are obtained from the property on the object. - -```csharp - -internal enum WordType -{ - Text, - Normalized = Text, - Lexical, - Pronunciation -} -``` - -```csharp -internal static string stringFromWordArray(ReadOnlyCollection words, WordType type) -{ - string text = ""; - foreach (RecognizedWordUnit word in words) - { - string wordText = ""; - if (type == WordType.Text || type == WordType.Normalized) - { - wordText = word.Text; - } - else if (type == WordType.Lexical) - { - wordText = word.LexicalForm; - } - else if (type == WordType.Pronunciation) - { - wordText = word.Pronunciation; - } - else - { - throw new InvalidEnumArgumentException(String.Format("[0}: is not a valid input", type)); - } - // Use display attribute - - if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) - { - wordText = wordText.TrimStart(); - } - if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) - { - wordText = wordText.TrimEnd(); - } - - text += wordText; - - } - return text; -} -``` - + objects. + + An array of objects is accessible for any recognition operation through the property on the object. + + In addition to providing a measure of recognition certainty () a instance provides: + +- Normalized and exact (or lexical) text representations for a recognized word. For more information, see , , and . + +- Pronunciation information using characters from a supported phonetic alphabet, such as the International Phonetic Alphabet (IPA) or the Universal Phone Set (UPS). For more information see . + +- Formatting for printing. For more information see the class and its property. + + + +## Examples + The following example shows a utility routine (`stringFromWordArray`) that generates strings. The strings contain lexical output (using ), normalized text (using ), or phonetic characters from the International Phonetic Alphabet (using ). Strings are formatted using objects obtained from the property from a of objects. The objects are obtained from the property on the object. + +```csharp + +internal enum WordType +{ + Text, + Normalized = Text, + Lexical, + Pronunciation +} +``` + +```csharp +internal static string stringFromWordArray(ReadOnlyCollection words, WordType type) +{ + string text = ""; + foreach (RecognizedWordUnit word in words) + { + string wordText = ""; + if (type == WordType.Text || type == WordType.Normalized) + { + wordText = word.Text; + } + else if (type == WordType.Lexical) + { + wordText = word.LexicalForm; + } + else if (type == WordType.Pronunciation) + { + wordText = word.Pronunciation; + } + else + { + throw new InvalidEnumArgumentException(String.Format("[0}: is not a valid input", type)); + } + // Use display attribute + + if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) + { + wordText = wordText.TrimStart(); + } + if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) + { + wordText = wordText.TrimEnd(); + } + + text += wordText; + + } + return text; +} +``` + ]]> @@ -139,88 +139,88 @@ internal static string stringFromWordArray(ReadOnlyCollection - The normalized text for a recognized word. - + The normalized text for a recognized word. + This value can be , "", or . A value from 0.0 through 1.0 indicating the certainty of word recognition. - The phonetic spelling of a recognized word. - + The phonetic spelling of a recognized word. + This value can be , "", or . - The unnormalized text for a recognized word. - + The unnormalized text for a recognized word. + This argument is required and may not be , "", or . Defines the use of white space to display recognized words. - The location of the recognized word in the audio input stream. - + The location of the recognized word in the audio input stream. + This value can be . - The length of the audio input corresponding to the recognized word. - + The length of the audio input corresponding to the recognized word. + This value can be . Initializes a new instance of the class. - and the is used in a recognition operation, the recognition engine will generate appropriate values in any output instance. - - Direct construction of instances is typically used only when emulating recognition operations using the or methods of the class and the or methods of the class. - - For actual applications, do not directly construct , rather obtain it through the property on the object. - - - -## Examples - The following example is a somewhat contrived test of emulation, where new words are generated from the input and passed to the emulator, and then verified. - -```csharp -private void _emulateAndVerify_Click(object sender, EventArgs e) -{ - char[] delimiterChars = { ' ', ',', '.', ':', ';', '\t' }; - string text = _emulateTextBox.Text; - string[] words = text.Split(delimiterChars); - - RecognizedWordUnit[] InputWordUnits = new RecognizedWordUnit[words.Length]; - for (int i = 0; i < words.Length; i++) - { - InputWordUnits[i] = new RecognizedWordUnit( - "", - 0, - "", - words[i].ToLower(), - DisplayAttributes.OneTrailingSpace, - new TimeSpan(), - new TimeSpan()); - } - - RecognitionResult rec = _recognizer.EmulateRecognize( - InputWordUnits, - System.Globalization.CompareOptions.IgnoreCase); - if (rec == null) - { - MessageBox.Show(String.Format("Recognition emulation for {0} failed.\n", text)); - } - else if (InputWordUnits.Length != rec.Words.Count) - { - MessageBox.Show( - String.Format("Length mismatch: Input was {0} words, Recognition has {1} words.\n}")); - } - else - { - for (int i = 0; i < InputWordUnits.Length; i++) - { - - if (rec.Words[i].LexicalForm.ToLower() != InputWordUnits[i].LexicalForm.ToLower()) - { - MessageBox.Show( - String.Format("Input word {0} \"{1}\" not found. Recognition output is {2}", - i, InputWordUnits[i].LexicalForm, rec.Words[i].LexicalForm)); - continue; - } - } - } -} -``` - + and the is used in a recognition operation, the recognition engine will generate appropriate values in any output instance. + + Direct construction of instances is typically used only when emulating recognition operations using the or methods of the class and the or methods of the class. + + For actual applications, do not directly construct , rather obtain it through the property on the object. + + + +## Examples + The following example is a somewhat contrived test of emulation, where new words are generated from the input and passed to the emulator, and then verified. + +```csharp +private void _emulateAndVerify_Click(object sender, EventArgs e) +{ + char[] delimiterChars = { ' ', ',', '.', ':', ';', '\t' }; + string text = _emulateTextBox.Text; + string[] words = text.Split(delimiterChars); + + RecognizedWordUnit[] InputWordUnits = new RecognizedWordUnit[words.Length]; + for (int i = 0; i < words.Length; i++) + { + InputWordUnits[i] = new RecognizedWordUnit( + "", + 0, + "", + words[i].ToLower(), + DisplayAttributes.OneTrailingSpace, + new TimeSpan(), + new TimeSpan()); + } + + RecognitionResult rec = _recognizer.EmulateRecognize( + InputWordUnits, + System.Globalization.CompareOptions.IgnoreCase); + if (rec == null) + { + MessageBox.Show(String.Format("Recognition emulation for {0} failed.\n", text)); + } + else if (InputWordUnits.Length != rec.Words.Count) + { + MessageBox.Show( + String.Format("Length mismatch: Input was {0} words, Recognition has {1} words.\n}")); + } + else + { + for (int i = 0; i < InputWordUnits.Length; i++) + { + + if (rec.Words[i].LexicalForm.ToLower() != InputWordUnits[i].LexicalForm.ToLower()) + { + MessageBox.Show( + String.Format("Input word {0} \"{1}\" not found. Recognition output is {2}", + i, InputWordUnits[i].LexicalForm, rec.Words[i].LexicalForm)); + continue; + } + } + } +} +``` + ]]> @@ -254,17 +254,17 @@ private void _emulateAndVerify_Click(object sender, EventArgs e) Gets a value, assigned by the recognizer, that represents the likelihood that a recognized word matches a given input. A relative measure of the certainty of correct recognition for a word. The value is from 0.0 to 1.0, for low to high confidence, respectively. - are relative and unique to each recognition engine. There is no definition of how confidence values between two different recognition engines compare, nor how the of individual objects define the of a . - - A speech recognition engine may assign a low confidence score to spoken input for various reasons, including background interference, inarticulate speech, or unanticipated words or word sequences. If your application is using a instance, you can modify the confidence level at which speech input is accepted or rejected with one of the methods. Confidence thresholds for the shared recognizer, managed by , are associated with a user profile and stored in the Windows registry. Applications should not write changes to the registry for the properties of the shared recognizer. - + are relative and unique to each recognition engine. There is no definition of how confidence values between two different recognition engines compare, nor how the of individual objects define the of a . + + A speech recognition engine may assign a low confidence score to spoken input for various reasons, including background interference, inarticulate speech, or unanticipated words or word sequences. If your application is using a instance, you can modify the confidence level at which speech input is accepted or rejected with one of the methods. Confidence thresholds for the shared recognizer, managed by , are associated with a user profile and stored in the Windows registry. Applications should not write changes to the registry for the properties of the shared recognizer. + ]]> @@ -296,81 +296,81 @@ private void _emulateAndVerify_Click(object sender, EventArgs e) Gets formatting information used to create the text output from the current instance. Specifies the use of white space to display of the contents of a object. - object returned by the property specifies the leading and trailing spaces to be used with a given word, if any. - - For more information about how to use this formatting information, see the enumeration. - - - -## Examples - The following example shows a utility routine (`stringFromWordArray`) that generates a string that is formatted in one of three ways: lexically (using ), normalized (using ), or phonetically (using ). The text output is obtained from the property on a of objects, which is obtained from the property on a object. - -```csharp - -internal enum WordType -{ - Text, - Normalized = Text, - Lexical, - Pronunciation -} -``` - -```csharp -internal static string stringFromWordArray( - ReadOnlyCollection words, - WordType type) -{ - string text = ""; - foreach (RecognizedWordUnit word in words) - { - string wordText = ""; - if (type == WordType.Text || type == WordType.Normalized) - { - wordText = word.Text; - } - else if (type == WordType.Lexical) - { - wordText = word.LexicalForm; - } - else if (type == WordType.Pronunciation) - { - wordText = word.Pronunciation; - } - else - { - throw new InvalidEnumArgumentException( - String.Format("[0}: is not a valid input", type)); - } - - // Use display attribute - if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) - { - wordText = wordText.TrimStart(); - } - if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) - { - wordText = wordText.TrimEnd(); - } - - text += wordText; - - } - return text; -} -``` - + object returned by the property specifies the leading and trailing spaces to be used with a given word, if any. + + For more information about how to use this formatting information, see the enumeration. + + + +## Examples + The following example shows a utility routine (`stringFromWordArray`) that generates a string that is formatted in one of three ways: lexically (using ), normalized (using ), or phonetically (using ). The text output is obtained from the property on a of objects, which is obtained from the property on a object. + +```csharp + +internal enum WordType +{ + Text, + Normalized = Text, + Lexical, + Pronunciation +} +``` + +```csharp +internal static string stringFromWordArray( + ReadOnlyCollection words, + WordType type) +{ + string text = ""; + foreach (RecognizedWordUnit word in words) + { + string wordText = ""; + if (type == WordType.Text || type == WordType.Normalized) + { + wordText = word.Text; + } + else if (type == WordType.Lexical) + { + wordText = word.LexicalForm; + } + else if (type == WordType.Pronunciation) + { + wordText = word.Pronunciation; + } + else + { + throw new InvalidEnumArgumentException( + String.Format("[0}: is not a valid input", type)); + } + + // Use display attribute + if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) + { + wordText = wordText.TrimStart(); + } + if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) + { + wordText = wordText.TrimEnd(); + } + + text += wordText; + + } + return text; +} +``` + ]]> @@ -403,81 +403,79 @@ internal static string stringFromWordArray( Gets the unnormalized text of a recognized word. Returns a containing the text of a recognized word, without any normalization. - and are identical. However, recognition engines may use speech normalization to return more user-friendly or colloquial text representations of audio input. - - 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 ), normalized (using ), and phonetic (using ). The text output is obtained from a of objects, which is obtained from the property on the object. - -```csharp - -internal enum WordType -{ - Text, - Normalized = Text, - Lexical, - Pronunciation -} -``` - -```csharp -internal static string stringFromWordArray( - ReadOnlyCollection words, - WordType type) -{ - string text = ""; - foreach (RecognizedWordUnit word in words) - { - string wordText = ""; - if (type == WordType.Text || type == WordType.Normalized) - { - wordText = word.Text; - } - else if (type == WordType.Lexical) - { - wordText = word.LexicalForm; - } - else if (type == WordType.Pronunciation) - { - wordText = word.Pronunciation; - } - else - { - throw new InvalidEnumArgumentException( - String.Format("[0}: is not a valid input", type)); - } - - // Use display attribute - if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) - { - wordText = wordText.TrimStart(); - } - if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) - { - wordText = wordText.TrimEnd(); - } - - text += wordText; - - } - return text; -} -``` - + and are identical. However, recognition engines may use speech normalization to return more user-friendly or colloquial text representations of audio input. + + 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 ), normalized (using ), and phonetic (using ). The text output is obtained from a of objects, which is obtained from the property on the object. + +```csharp + +internal enum WordType +{ + Text, + Normalized = Text, + Lexical, + Pronunciation +} +``` + +```csharp +internal static string stringFromWordArray( + ReadOnlyCollection words, + WordType type) +{ + string text = ""; + foreach (RecognizedWordUnit word in words) + { + string wordText = ""; + if (type == WordType.Text || type == WordType.Normalized) + { + wordText = word.Text; + } + else if (type == WordType.Lexical) + { + wordText = word.LexicalForm; + } + else if (type == WordType.Pronunciation) + { + wordText = word.Pronunciation; + } + else + { + throw new InvalidEnumArgumentException( + String.Format("[0}: is not a valid input", type)); + } + + // Use display attribute + if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) + { + wordText = wordText.TrimStart(); + } + if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) + { + wordText = wordText.TrimEnd(); + } + + text += wordText; + + } + return text; +} +``` + ]]> @@ -510,80 +508,80 @@ internal static string stringFromWordArray( Gets the phonetic spelling of a recognized word. A string of characters from a supported phonetic alphabet, such as the International Phonetic Alphabet (IPA) or the Universal Phone Set (UPS). - indicate which pronunciation the speech recognition engine used to match speech input to one of its loaded objects. Pronunciations may be defined in the speech recognition engine's internal lexicon, in a lexicon document that is linked from a recognition grammar in a loaded object, or inline in a recognition grammar in a loaded object. A speech recognition engine may also create pronunciations for uncommon words whose pronunciations are not defined in a lexicon or grammar to which the speech recognition engine currently has access. - - Many Windows-based Unicode fonts, such as Courier New, support the display of IPA strings. For more information, see [International Phonetic Alphabet](https://www.internationalphoneticassociation.org/content/ipa-chart). - - - -## Examples - The following example shows a utility routine that generates a string with one of three possible formats: lexical (using ), normalized (using ), and phonetic (using ). The text output is obtained from a of objects, which is obtained from the property on the object. - -```csharp - -internal enum WordType -{ - Text, - Normalized = Text, - Lexical, - Pronunciation -} -``` - -```csharp -internal static string stringFromWordArray( - ReadOnlyCollection words, - WordType type) -{ - string text = ""; - foreach (RecognizedWordUnit word in words) - { - string wordText = ""; - if (type == WordType.Text || type == WordType.Normalized) - { - wordText = word.Text; - } - else if (type == WordType.Lexical) - { - wordText = word.LexicalForm; - } - else if (type == WordType.Pronunciation) - { - wordText = word.Pronunciation; - } - else - { - throw new InvalidEnumArgumentException( - String.Format("[0}: is not a valid input", type)); - } - // Use display attribute - - if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) - { - wordText = wordText.TrimStart(); - } - if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) - { - wordText = wordText.TrimEnd(); - } - - text += wordText; - } - return text; -} -``` - + indicate which pronunciation the speech recognition engine used to match speech input to one of its loaded objects. Pronunciations may be defined in the speech recognition engine's internal lexicon, in a lexicon document that is linked from a recognition grammar in a loaded object, or inline in a recognition grammar in a loaded object. A speech recognition engine may also create pronunciations for uncommon words whose pronunciations are not defined in a lexicon or grammar to which the speech recognition engine currently has access. + + Many Windows-based Unicode fonts, such as Courier New, support the display of IPA strings. For more information, see [International Phonetic Alphabet](https://www.internationalphoneticassociation.org/content/ipa-chart). + + + +## Examples + The following example shows a utility routine that generates a string with one of three possible formats: lexical (using ), normalized (using ), and phonetic (using ). The text output is obtained from a of objects, which is obtained from the property on the object. + +```csharp + +internal enum WordType +{ + Text, + Normalized = Text, + Lexical, + Pronunciation +} +``` + +```csharp +internal static string stringFromWordArray( + ReadOnlyCollection words, + WordType type) +{ + string text = ""; + foreach (RecognizedWordUnit word in words) + { + string wordText = ""; + if (type == WordType.Text || type == WordType.Normalized) + { + wordText = word.Text; + } + else if (type == WordType.Lexical) + { + wordText = word.LexicalForm; + } + else if (type == WordType.Pronunciation) + { + wordText = word.Pronunciation; + } + else + { + throw new InvalidEnumArgumentException( + String.Format("[0}: is not a valid input", type)); + } + // Use display attribute + + if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) + { + wordText = wordText.TrimStart(); + } + if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) + { + wordText = wordText.TrimEnd(); + } + + text += wordText; + } + return text; +} +``` + ]]> @@ -617,81 +615,79 @@ internal static string stringFromWordArray( Gets the normalized text for a recognized word. A string that contains the normalized text output for a given input word. - and will be identical. However, recognition engines may use speech normalization to return more user-friendly or colloquial text representations of audio input. - - 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 ), normalized (using ), and phonetic (using ). The text output is obtained from a of objects, which is obtained from the property on the object. - -```csharp - -internal enum WordType -{ - Text, - Normalized = Text, - Lexical, - Pronunciation -} -``` - -```csharp -internal static string stringFromWordArray( - ReadOnlyCollection words, - WordType type) -{ - string text = ""; - foreach (RecognizedWordUnit word in words) - { - string wordText = ""; - if (type == WordType.Text || type == WordType.Normalized) - { - wordText = word.Text; - } - else if (type == WordType.Lexical) - { - wordText = word.LexicalForm; - } - else if (type == WordType.Pronunciation) - { - wordText = word.Pronunciation; - } - else - { - throw new InvalidEnumArgumentException( - String.Format("[0}: is not a valid input", type)); - } - - // Use display attribute - if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) - { - wordText += " "; - } - if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) - { - wordText = wordText.TrimStart(); - } - if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) - { - wordText = wordText.TrimEnd(); - } - - text += wordText; - - } - return text; -} -``` - + and will be identical. However, recognition engines may use speech normalization to return more user-friendly or colloquial text representations of audio input. + + 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 ), normalized (using ), and phonetic (using ). The text output is obtained from a of objects, which is obtained from the property on the object. + +```csharp + +internal enum WordType +{ + Text, + Normalized = Text, + Lexical, + Pronunciation +} +``` + +```csharp +internal static string stringFromWordArray( + ReadOnlyCollection words, + WordType type) +{ + string text = ""; + foreach (RecognizedWordUnit word in words) + { + string wordText = ""; + if (type == WordType.Text || type == WordType.Normalized) + { + wordText = word.Text; + } + else if (type == WordType.Lexical) + { + wordText = word.LexicalForm; + } + else if (type == WordType.Pronunciation) + { + wordText = word.Pronunciation; + } + else + { + throw new InvalidEnumArgumentException( + String.Format("[0}: is not a valid input", type)); + } + + // Use display attribute + if ((word.DisplayAttributes & DisplayAttributes.OneTrailingSpace) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.TwoTrailingSpaces) != 0) + { + wordText += " "; + } + if ((word.DisplayAttributes & DisplayAttributes.ConsumeLeadingSpaces) != 0) + { + wordText = wordText.TrimStart(); + } + if ((word.DisplayAttributes & DisplayAttributes.ZeroTrailingSpaces) != 0) + { + wordText = wordText.TrimEnd(); + } + + text += wordText; + + } + return text; +} +``` + ]]> diff --git a/xml/System.Text.Json.Serialization.Metadata/JsonPolymorphismOptions.xml b/xml/System.Text.Json.Serialization.Metadata/JsonPolymorphismOptions.xml index 0413a6bea9d..facd6007299 100644 --- a/xml/System.Text.Json.Serialization.Metadata/JsonPolymorphismOptions.xml +++ b/xml/System.Text.Json.Serialization.Metadata/JsonPolymorphismOptions.xml @@ -111,7 +111,7 @@ System.String - Gets or sets a custom type discriminator property name for the polymorhic type. + Gets or sets a custom type discriminator property name for the polymorphic type. Uses the default '$type' property name if left unset. To be added. To be added. diff --git a/xml/System.Text.Json.Serialization/ReferenceResolver.xml b/xml/System.Text.Json.Serialization/ReferenceResolver.xml index b0d823b32ab..1da13554605 100644 --- a/xml/System.Text.Json.Serialization/ReferenceResolver.xml +++ b/xml/System.Text.Json.Serialization/ReferenceResolver.xml @@ -76,7 +76,7 @@ The identifier of the JSON object or array. The value of the CLR reference type object that results from parsing the JSON object. - Adds an entry to the bag of references using the specified id and value. + 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. To be added. @@ -105,11 +105,11 @@ - The value of the CLR reference type object to get an id for. + The value of the CLR reference type object to get an ID for. When this method returns, if a reference to value already exists; otherwise, . - 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. - The reference id for the specified object. + 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. + The reference ID for the specified object. To be added. @@ -136,10 +136,10 @@ - The reference id related to the returned object. - Returns the CLR reference type object related to the specified reference id. - This method gets called when $ref metadata property is read. - The reference type object related to the specified reference id. + The reference ID related to the returned object. + Returns the CLR reference type object related to the specified reference ID. + This method is called when $ref metadata property is read. + The reference type object related to the specified reference ID. To be added. diff --git a/xml/System.Text.Json/JsonSerializerOptions.xml b/xml/System.Text.Json/JsonSerializerOptions.xml index 8a883d3a467..655e5ac2bf3 100644 --- a/xml/System.Text.Json/JsonSerializerOptions.xml +++ b/xml/System.Text.Json/JsonSerializerOptions.xml @@ -189,13 +189,9 @@ similar to how Allows JSON metadata properties to be specified after regular properties in a deserialized JSON object. To be added. - - When set to , removes the requirement that JSON metadata properties - such as $id and $type should be specified at the very start of the deserialized JSON object. - It should be noted that enabling this setting can result in over-buffering - when deserializing large JSON payloads in the context of streaming deserialization. + When set to , 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. - Thrown if this property is set after serialization or deserialization has occurred. + This property is set after serialization or deserialization has occurred. diff --git a/xml/System.Text/UTF7Encoding.xml b/xml/System.Text/UTF7Encoding.xml index beabc66e056..c43a0f95ffc 100644 --- a/xml/System.Text/UTF7Encoding.xml +++ b/xml/System.Text/UTF7Encoding.xml @@ -58,36 +58,36 @@ Represents a UTF-7 encoding of Unicode characters. - [!NOTE] -> does not provide error detection. For security reasons, the application should use , , or and enable error detection. - - For more information about the UTFs and other encodings supported by , see [Character Encoding in the .NET Framework](/dotnet/standard/base-types/character-encoding). - - The method determines how many bytes result in encoding a set of Unicode characters, and the method performs the actual encoding. - - Likewise, the method determines how many characters result in decoding a sequence of bytes, and the and methods perform the actual decoding. - - corresponds to the Windows code page 65000. - +> does not provide error detection. For security reasons, the application should use , , or and enable error detection. + + For more information about the UTFs and other encodings supported by , see [Character Encoding in the .NET Framework](/dotnet/standard/base-types/character-encoding). + + The method determines how many bytes result in encoding a set of Unicode characters, and the method performs the actual encoding. + + Likewise, the method determines how many characters result in decoding a sequence of bytes, and the and methods perform the actual decoding. + + corresponds to the Windows code page 65000. + > [!NOTE] -> The state of a UTF-7 encoded object is not preserved if the object is serialized and deserialized using different .NET Framework versions. - - - -## Examples - The following code example demonstrates how to use a to encode a string of Unicode characters and store them in a byte array. Notice that when the byte array is decoded back to a string, no data is lost. - +> The state of a UTF-7 encoded object is not preserved if the object is serialized and deserialized using different .NET Framework versions. + + + +## Examples + The following code example demonstrates how to use a to encode a string of Unicode characters and store them in a byte array. Notice that when the byte array is decoded back to a string, no data is lost. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding Example/CPP/snippet.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/Overview/snippet.cs" interactive="try-dotnet" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding Example/VB/snippet.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding Example/VB/snippet.vb" id="Snippet1"::: + ]]> @@ -146,25 +146,25 @@ Initializes a new instance of the class. - constructor is equivalent to calling the constructor that takes an `allowOptionals` parameter and specifying `false` for that parameter. - - If an instance allows optional characters, Unicode code points are encoded with a corresponding optional character instead of a modified base 64 character. The optional characters are exclamation point ("!"), backward slash ("\\"), vertical line ("|"), double quote ("""), number sign ("#"), dollar sign ("$"), percent sign ("%"), ampersand ("&"), asterisk ("*"), semicolon (";"), left angle bracket ("\<"), right angle bracket (">"), left curly bracket ("{"), right curly bracket ("}"), left square bracket ("["), right square bracket ("]"), equal sign ("="), at sign ("@"), circumflex accent ("^"), underscore ("_"), and grave accent ("`"). - + constructor is equivalent to calling the constructor that takes an `allowOptionals` parameter and specifying `false` for that parameter. + + If an instance allows optional characters, Unicode code points are encoded with a corresponding optional character instead of a modified base 64 character. The optional characters are exclamation point ("!"), backward slash ("\\"), vertical line ("|"), double quote ("""), number sign ("#"), dollar sign ("$"), percent sign ("%"), ampersand ("&"), asterisk ("*"), semicolon (";"), left angle bracket ("\<"), right angle bracket (">"), left curly bracket ("{"), right curly bracket ("}"), left square bracket ("["), right square bracket ("]"), equal sign ("="), at sign ("@"), circumflex accent ("^"), underscore ("_"), and grave accent ("`"). + > [!NOTE] -> does not provide error detection. For security reasons, your applications are recommended to use , , or and enable error detection. - - - -## Examples - The following code example demonstrates how to create a new instance and display the name of the encoding. - +> does not provide error detection. For security reasons, your applications are recommended to use , , or and enable error detection. + + + +## Examples + The following code example demonstrates how to create a new instance and display the name of the encoding. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.ctor1 Example/CPP/ctor.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/.ctor/ctor.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.ctor1 Example/VB/ctor.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.ctor1 Example/VB/ctor.vb" id="Snippet1"::: + ]]> @@ -215,23 +215,23 @@ to specify that optional characters are allowed; otherwise, . Initializes a new instance of the class. A parameter specifies whether to allow optional characters. - "), left curly bracket ("{"), right curly bracket ("}"), left square bracket ("["), right square bracket ("]"), equal sign ("="), at sign ("@"), circumflex accent ("^"), underscore ("_"), and grave accent ("`"). - + "), left curly bracket ("{"), right curly bracket ("}"), left square bracket ("["), right square bracket ("]"), equal sign ("="), at sign ("@"), circumflex accent ("^"), underscore ("_"), and grave accent ("`"). + > [!NOTE] -> does not provide error detection. For security reasons, your applications are recommended to use , , or and enable error detection. - - - -## Examples - The following code example demonstrates how to create a new instance that allows optional characters. - +> does not provide error detection. For security reasons, your applications are recommended to use , , or and enable error detection. + + + +## Examples + The following code example demonstrates how to create a new instance that allows optional characters. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.ctor2 Example/CPP/ctor-boolean.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/.ctor/ctor-boolean.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.ctor2 Example/VB/ctor-boolean.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.ctor2 Example/VB/ctor-boolean.vb" id="Snippet1"::: + ]]> @@ -293,11 +293,11 @@ if is a object and is equal to the current object; otherwise, . - objects are equal if they both either allow or disallow optional characters, and if their underlying and properties are equal. - + objects are equal if they both either allow or disallow optional characters, and if their underlying and properties are equal. + ]]> @@ -366,29 +366,29 @@ Calculates the number of bytes produced by encoding the characters in the specified object. The number of bytes produced by encoding the specified characters. - requires to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - - -## Examples - The following code example demonstrates how to use the method to return the number of bytes required to encode a character array. - + requires to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + + +## Examples + The following code example demonstrates how to use the method to return the number of bytes required to encode a character array. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetByteCount Example/CPP/getbytecount-char[]-int32-int32.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetByteCount/getbytecount-char[]-int32-int32.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetByteCount Example/VB/getbytecount-char[]-int32-int32.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetByteCount Example/VB/getbytecount-char[]-int32-int32.vb" id="Snippet1"::: + ]]> is (). The resulting number of bytes is greater than the maximum number that can be returned as an int. A fallback occurred (for more information, see Character Encoding in .NET). - - -and- - + + -and- + is set to . @@ -452,25 +452,25 @@ Calculates the number of bytes produced by encoding a set of characters starting at the specified character pointer. The number of bytes produced by encoding the specified characters. - requires to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - + requires to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + ]]> is ( in Visual Basic .NET). - is less than zero. - - -or- - + is less than zero. + + -or- + The resulting number of bytes is greater than the maximum number that can be returned as an int. A fallback occurred (for more information, see Character Encoding in .NET) - - -and- - + + -and- + is set to . @@ -530,38 +530,38 @@ Calculates the number of bytes produced by encoding a set of characters from the specified character array. The number of bytes produced by encoding the specified characters. - to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - - -## Examples - The following code example demonstrates how to use the method to return the number of bytes required to encode an array of Unicode characters. - + to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + + +## Examples + The following code example demonstrates how to use the method to return the number of bytes required to encode an array of Unicode characters. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetByteCount Example/CPP/getbytecount-char[]-int32-int32.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetByteCount/getbytecount-char[]-int32-int32.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetByteCount Example/VB/getbytecount-char[]-int32-int32.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetByteCount Example/VB/getbytecount-char[]-int32-int32.vb" id="Snippet1"::: + ]]> is (). - or is less than zero. - - -or- - - and do not denote a valid range in . - - -or- - + or is less than zero. + + -or- + + and do not denote a valid range in . + + -or- + The resulting number of bytes is greater than the maximum number that can be returned as an int. A fallback occurred (for more information, see Character Encoding in .NET) - - -and- - + + -and- + is set to . @@ -639,32 +639,32 @@ Encodes a set of characters starting at the specified character pointer into a sequence of bytes that are stored starting at the specified byte pointer. The actual number of bytes written at the location indicated by . - to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. - + to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. + > [!NOTE] -> does not provide error detection. Invalid characters are encoded as a modified base 64 character. For security reasons, your applications are recommended to use , , or and enable error detection. - +> does not provide error detection. Invalid characters are encoded as a modified base 64 character. For security reasons, your applications are recommended to use , , or and enable error detection. + ]]> - is (). - - -or- - + is (). + + -or- + is (). or is less than zero. is less than the resulting number of bytes. A fallback occurred (see Character Encoding in .NET for fuller explanation). - - -and- - + + -and- + is set to . @@ -728,49 +728,49 @@ Encodes a set of characters from the specified character array into the specified byte array. The actual number of bytes written into . - to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. - + to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. + > [!NOTE] -> does not provide error detection. Invalid characters are encoded as a modified base 64 character. For security reasons, your applications are recommended to use , , or and enable error detection. - - - -## Examples - The following code example demonstrates how to use the method to encode a range of characters from a and store the encoded bytes in a range of elements in a byte array. - +> does not provide error detection. Invalid characters are encoded as a modified base 64 character. For security reasons, your applications are recommended to use , , or and enable error detection. + + + +## Examples + The following code example demonstrates how to use the method to encode a range of characters from a and store the encoded bytes in a range of elements in a byte array. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetBytes Example/CPP/getbytes-char[]-int32-int32-byte[]-int32.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetBytes/getbytes-char[]-int32-int32-byte[]-int32.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetBytes Example/VB/getbytes-char[]-int32-int32-byte[]-int32.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetBytes Example/VB/getbytes-char[]-int32-int32-byte[]-int32.vb" id="Snippet1"::: + ]]> - is (). - - -or- - + is (). + + -or- + is (). - or or is less than zero. - - -or- - - and do not denote a valid range in . - - -or- - + or or is less than zero. + + -or- + + and do not denote a valid range in . + + -or- + is not a valid index in . does not have enough capacity from to the end of the array to accommodate the resulting bytes. A fallback occurred (see Character Encoding in .NET for fuller explanation). - - -and- - + + -and- + is set to . @@ -837,49 +837,49 @@ Encodes a set of characters from the specified into the specified byte array. The actual number of bytes written into . - to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. - + to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. + > [!NOTE] -> does not provide error detection. Invalid characters are encoded as a modified base 64 character. For security reasons, your applications are recommended to use , , or and enable error detection. - - - -## Examples - The following code example demonstrates how to use the method to encode a range of elements from a Unicode character array, and store the encoded bytes in a range of elements in a byte array. - +> does not provide error detection. Invalid characters are encoded as a modified base 64 character. For security reasons, your applications are recommended to use , , or and enable error detection. + + + +## Examples + The following code example demonstrates how to use the method to encode a range of elements from a Unicode character array, and store the encoded bytes in a range of elements in a byte array. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetBytes Example/CPP/getbytes-char[]-int32-int32-byte[]-int32.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetBytes/getbytes-char[]-int32-int32-byte[]-int32.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetBytes Example/VB/getbytes-char[]-int32-int32-byte[]-int32.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetBytes Example/VB/getbytes-char[]-int32-int32-byte[]-int32.vb" id="Snippet1"::: + ]]> - is (). - - -or- - + is (). + + -or- + is (). - or or is less than zero. - - -or- - - and do not denote a valid range in . - - -or- - + or or is less than zero. + + -or- + + and do not denote a valid range in . + + -or- + is not a valid index in . does not have enough capacity from to the end of the array to accommodate the resulting bytes. A fallback occurred (see Character Encoding in .NET for fuller explanation). - - -and- - + + -and- + is set to . @@ -953,25 +953,25 @@ Calculates the number of characters produced by decoding a sequence of bytes starting at the specified byte pointer. The number of characters produced by decoding the specified sequence of bytes. - to store the resulting characters, use . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - + to store the resulting characters, use . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + ]]> is (). - is less than zero. - - -or- - + is less than zero. + + -or- + The resulting number of characters is greater than the maximum number that can be returned as an int. A fallback occurred (for more information, see Character Encoding in .NET). - - -and- - + + -and- + is set to . @@ -1031,38 +1031,38 @@ Calculates the number of characters produced by decoding a sequence of bytes from the specified byte array. The number of characters produced by decoding the specified sequence of bytes. - to store the resulting characters, use . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - - -## Examples - The following code example demonstrates how to use the method to return the number of characters produced by decoding a range of elements in a byte array. - + to store the resulting characters, use . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + + +## Examples + The following code example demonstrates how to use the method to return the number of characters produced by decoding a range of elements in a byte array. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UnicodeEncoding.GetCharCount Example/CPP/getcharcount-byte[]-int32-int32.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UnicodeEncoding/GetCharCount/getcharcount-byte[]-int32-int32.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UnicodeEncoding.GetCharCount Example/VB/getcharcount-byte[]-int32-int32.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UnicodeEncoding.GetCharCount Example/VB/getcharcount-byte[]-int32-int32.vb" id="Snippet1"::: + ]]> is (). - or is less than zero. - - -or- - - and do not denote a valid range in . - - -or- - + or is less than zero. + + -or- + + and do not denote a valid range in . + + -or- + The resulting number of characters is greater than the maximum number that can be returned as an int. A fallback occurred (for more information, see Character Encoding in .NET) - - -and- - + + -and- + is set to . @@ -1140,32 +1140,32 @@ Decodes a sequence of bytes starting at the specified byte pointer into a set of characters that are stored starting at the specified character pointer. The actual number of characters written at the location indicated by . - to store the resulting characters, use . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. - + to store the resulting characters, use . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. + > [!NOTE] -> does not provide error detection. When invalid bytes are encountered, generally emits the invalid bytes. If a byte is larger than hexadecimal 0x7F, the byte value is zero-extended into a Unicode character, the result is stored in the `chars` array, and any shift sequence is terminated. For example, if the byte to encode is hexadecimal 0x81, the resulting character is U+0081. For security reasons, your applications are recommended to use , , or and enable error detection. - +> does not provide error detection. When invalid bytes are encountered, generally emits the invalid bytes. If a byte is larger than hexadecimal 0x7F, the byte value is zero-extended into a Unicode character, the result is stored in the `chars` array, and any shift sequence is terminated. For example, if the byte to encode is hexadecimal 0x81, the resulting character is U+0081. For security reasons, your applications are recommended to use , , or and enable error detection. + ]]> - is (). - - -or- - + is (). + + -or- + is (). or is less than zero. is less than the resulting number of characters. A fallback occurred (for more information, see Character Encoding in .NET) - - -and- - + + -and- + is set to . @@ -1230,49 +1230,49 @@ Decodes a sequence of bytes from the specified byte array into the specified character array. The actual number of characters written into . - to store the resulting characters, use . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. - + to store the resulting characters, use . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + Data to be converted, such as data read from a stream, might be available only in sequential blocks. In this case, or if the amount of data is so large that it needs to be divided into smaller blocks, the application should use the or the provided by the method or the method, respectively. + > [!NOTE] -> does not provide error detection. When invalid bytes are encountered, generally emits the invalid bytes. If a byte is larger than hexadecimal 0x7F, the byte value is zero-extended into a Unicode character, the result is stored in the `chars` array, and any shift sequence is terminated. For example, if the byte to encode is hexadecimal 0x81, the resulting character is U+0081. For security reasons, your applications are recommended to use , , or and enable error detection. - - - -## Examples - The following code example demonstrates how to use the method to decode a range of elements in a byte array and store the result in a character array. - +> does not provide error detection. When invalid bytes are encountered, generally emits the invalid bytes. If a byte is larger than hexadecimal 0x7F, the byte value is zero-extended into a Unicode character, the result is stored in the `chars` array, and any shift sequence is terminated. For example, if the byte to encode is hexadecimal 0x81, the resulting character is U+0081. For security reasons, your applications are recommended to use , , or and enable error detection. + + + +## Examples + The following code example demonstrates how to use the method to decode a range of elements in a byte array and store the result in a character array. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetChars Example/CPP/getchars-byte[]-int32-int32-char[]-int32.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetChars/getchars-byte[]-int32-int32-char[]-int32.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetChars Example/VB/getchars-byte[]-int32-int32-char[]-int32.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetChars Example/VB/getchars-byte[]-int32-int32-char[]-int32.vb" id="Snippet1"::: + ]]> - is (). - - -or- - + is (). + + -or- + is (). - or or is less than zero. - - -or- - - and do not denote a valid range in . - - -or- - + or or is less than zero. + + -or- + + and do not denote a valid range in . + + -or- + is not a valid index in . does not have enough capacity from to the end of the array to accommodate the resulting characters. A fallback occurred (for more information, see Character Encoding in .NET) - - -and- - + + -and- + is set to . @@ -1320,20 +1320,20 @@ Obtains a decoder that converts a UTF-7 encoded sequence of bytes into a sequence of Unicode characters. A that converts a UTF-7 encoded sequence of bytes into a sequence of Unicode characters. - method converts sequential blocks of bytes into sequential blocks of characters, in a manner similar to the method of this class. However, a maintains state information between calls so it can correctly decode byte sequences that span blocks. The also preserves trailing bytes at the end of data blocks and uses the trailing bytes in the next decoding operation. Therefore, and are useful for network transmission and file operations, because those operations often deal with blocks of data instead of a complete data stream. - - - -## Examples - The following code example demonstrates how to use the method to obtain a decoder to convert the UTF-7 encoded bytes into a sequence of characters. - + method converts sequential blocks of bytes into sequential blocks of characters, in a manner similar to the method of this class. However, a maintains state information between calls so it can correctly decode byte sequences that span blocks. The also preserves trailing bytes at the end of data blocks and uses the trailing bytes in the next decoding operation. Therefore, and are useful for network transmission and file operations, because those operations often deal with blocks of data instead of a complete data stream. + + + +## Examples + The following code example demonstrates how to use the method to obtain a decoder to convert the UTF-7 encoded bytes into a sequence of characters. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetDecoder Example/CPP/getdecoder-.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetDecoder/getdecoder-.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetDecoder Example/VB/getdecoder-.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetDecoder Example/VB/getdecoder-.vb" id="Snippet1"::: + ]]> @@ -1384,20 +1384,20 @@ Obtains an encoder that converts a sequence of Unicode characters into a UTF-7 encoded sequence of bytes. A that converts a sequence of Unicode characters into a UTF-7 encoded sequence of bytes. - method converts sequential blocks of bytes into sequential blocks of characters, in a manner similar to the method. However, a maintains state information between calls so it can correctly decode byte sequences that span blocks. The also preserves trailing bytes at the end of data blocks and uses the trailing bytes in the next decoding operation. Therefore, and are useful for network transmission and file operations, because those operations often deal with blocks of data instead of a complete data stream. - - - -## Examples - The following code example demonstrates how to use the method to obtain an encoder to convert a sequence of characters into a UTF-7 encoded sequence of bytes. - + method converts sequential blocks of bytes into sequential blocks of characters, in a manner similar to the method. However, a maintains state information between calls so it can correctly decode byte sequences that span blocks. The also preserves trailing bytes at the end of data blocks and uses the trailing bytes in the next decoding operation. Therefore, and are useful for network transmission and file operations, because those operations often deal with blocks of data instead of a complete data stream. + + + +## Examples + The following code example demonstrates how to use the method to obtain an encoder to convert a sequence of characters into a UTF-7 encoded sequence of bytes. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetEncoder Example/CPP/getencoder-.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetEncoder/getencoder-.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetEncoder Example/VB/getencoder-.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetEncoder Example/VB/getencoder-.vb" id="Snippet1"::: + ]]> @@ -1452,11 +1452,11 @@ Returns the hash code for the current object. A 32-bit signed integer hash code. - method is not suitable for distinguishing one object from another. If your application needs a unique hash code, it should override the method. - + method is not suitable for distinguishing one object from another. If your application needs a unique hash code, it should override the method. + ]]> @@ -1504,41 +1504,41 @@ Calculates the maximum number of bytes produced by encoding the specified number of characters. The maximum number of bytes produced by encoding the specified number of characters. - to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - is a worst-case number, including the worst case for the currently selected . If a fallback is chosen with a potentially large string, can return large values. - - In most cases, this method returns reasonable numbers for small strings. For large strings, you might have to choose between using very large buffers and catching errors in the rare case that a more reasonable buffer is exceeded. You might also want to consider a different approach using or . While UTF-7 is very efficient at encoding ASCII data, one byte per character, it is extremely inefficient for other data. As remarked above, deals with a worst case. If the data to be encoded is largely ASCII, and especially if the ASCII characters cluster together, UTF-7 is significantly more efficient than the number returned by this method suggests. - - has no relation to . If your application needs a similar function to use with , it should use . - + to store the resulting bytes, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + is a worst-case number, including the worst case for the currently selected . If a fallback is chosen with a potentially large string, can return large values. + + In most cases, this method returns reasonable numbers for small strings. For large strings, you might have to choose between using very large buffers and catching errors in the rare case that a more reasonable buffer is exceeded. You might also want to consider a different approach using or . While UTF-7 is very efficient at encoding ASCII data, one byte per character, it is extremely inefficient for other data. As remarked above, deals with a worst case. If the data to be encoded is largely ASCII, and especially if the ASCII characters cluster together, UTF-7 is significantly more efficient than the number returned by this method suggests. + + has no relation to . If your application needs a similar function to use with , it should use . + > [!NOTE] -> `GetMaxByteCount(N)` is not necessarily the same value as `N* GetMaxByteCount(1)`. - - - -## Examples - The following code example demonstrates how to use the method to return the maximum number of bytes required to encode a specified number of characters. - +> `GetMaxByteCount(N)` is not necessarily the same value as `N* GetMaxByteCount(1)`. + + + +## Examples + The following code example demonstrates how to use the method to return the maximum number of bytes required to encode a specified number of characters. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetMaxByteCount Example/CPP/getmaxbytecount-int32.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetMaxByteCount/getmaxbytecount-int32.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetMaxByteCount Example/VB/getmaxbytecount-int32.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetMaxByteCount Example/VB/getmaxbytecount-int32.vb" id="Snippet1"::: + ]]> - is less than zero. - - -or- - + is less than zero. + + -or- + The resulting number of bytes is greater than the maximum number that can be returned as an int. A fallback occurred (for more information, see Character Encoding in .NET) - - -and- - + + -and- + is set to . @@ -1588,41 +1588,41 @@ Calculates the maximum number of characters produced by decoding the specified number of bytes. The maximum number of characters produced by decoding the specified number of bytes. - to store the resulting characters, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. - - is a worst-case number, including the worst case for the currently selected . If a fallback is chosen with a potentially large string, can return large values. - - In most cases, this method returns reasonable numbers for small strings. For large strings, you might have to choose between using very large buffers and catching errors in the rare case that a more reasonable buffer is exceeded. You might also want to consider a different approach using or . - - has no relation to . If your application needs a similar function to use with , it should use . - + to store the resulting characters, the application uses . To calculate the maximum array size, the application should use . The method generally allows allocation of less memory, while the method generally executes faster. + + is a worst-case number, including the worst case for the currently selected . If a fallback is chosen with a potentially large string, can return large values. + + In most cases, this method returns reasonable numbers for small strings. For large strings, you might have to choose between using very large buffers and catching errors in the rare case that a more reasonable buffer is exceeded. You might also want to consider a different approach using or . + + has no relation to . If your application needs a similar function to use with , it should use . + > [!NOTE] -> `GetMaxCharCount(N)` is not necessarily the same value as `N* GetMaxCharCount(1)`. - - - -## Examples - The following code example demonstrates how to use the method to return the maximum number of characters produced by decoding a specified number of bytes. - +> `GetMaxCharCount(N)` is not necessarily the same value as `N* GetMaxCharCount(1)`. + + + +## Examples + The following code example demonstrates how to use the method to return the maximum number of characters produced by decoding a specified number of bytes. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetMaxCharCount Example/CPP/getmaxcharcount-int32.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetMaxCharCount/getmaxcharcount-int32.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetMaxCharCount Example/VB/getmaxcharcount-int32.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.GetMaxCharCount Example/VB/getmaxcharcount-int32.vb" id="Snippet1"::: + ]]> - is less than zero. - - -or- - + is less than zero. + + -or- + The resulting number of characters is greater than the maximum number that can be returned as an int. A fallback occurred (for more information, see Character Encoding in .NET) - - -and- - + + -and- + is set to . @@ -1686,37 +1686,37 @@ Decodes a range of bytes from a byte array into a string. A containing the results of decoding the specified sequence of bytes. - or the provided by the method or the method, respectively. - + or the provided by the method or the method, respectively. + > [!NOTE] -> does not provide error detection. When invalid bytes are encountered, generally emits the invalid bytes. If a byte is larger than hexadecimal 0x7F, the byte value is zero-extended into a Unicode character, the result is stored in the `chars` array, and any shift sequence is terminated. For example, if the byte to encode is hexadecimal 0x81, the resulting character is U+0081. For security reasons, your applications are recommended to use , , or and enable error detection. - - - -## Examples - The following code example encodes a string into an array of bytes, and then decodes the bytes back into a string. - +> does not provide error detection. When invalid bytes are encountered, generally emits the invalid bytes. If a byte is larger than hexadecimal 0x7F, the byte value is zero-extended into a Unicode character, the result is stored in the `chars` array, and any shift sequence is terminated. For example, if the byte to encode is hexadecimal 0x81, the resulting character is U+0081. For security reasons, your applications are recommended to use , , or and enable error detection. + + + +## Examples + The following code example encodes a string into an array of bytes, and then decodes the bytes back into a string. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR_System/system.Text.UTF7Encoding.getstring/CPP/getstring.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Text/UTF7Encoding/GetString/getstring.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.getstring/VB/getstring.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR_System/system.Text.UTF7Encoding.getstring/VB/getstring.vb" id="Snippet1"::: + ]]> is (). - or is less than zero. - - -or- - + or is less than zero. + + -or- + and do not denote a valid range in . A fallback occurred (for more information, see Character Encoding in .NET). - - -and- - + + -and- + is set to . diff --git a/xml/System.Web.UI.WebControls/BoundField.xml b/xml/System.Web.UI.WebControls/BoundField.xml index 4d1abf82294..bfd70f6a7a9 100644 --- a/xml/System.Web.UI.WebControls/BoundField.xml +++ b/xml/System.Web.UI.WebControls/BoundField.xml @@ -17,37 +17,37 @@ Represents a field that is displayed as text in a data-bound control. - class is used by data-bound controls (such as and ) to display the value of a field as text. The object is displayed differently depending on the data-bound control in which it is used. For example, the control displays a object as a column, while the control displays it as a row. - - To specify the field to display in a object, set the property to the field's name. The field's value can be HTML-encoded before it is displayed by setting the property to `true`. You can apply a custom formatting string to the field's value by setting the property. When the property is `true`, the encoded string value of the field is used in the custom format string. By default, the formatting string is applied to field values only when the data-bound control is in read-only mode. To apply the formatting string to values displayed while the data-bound control is in edit mode, set the property to `true`. If a field's value is null, you can display a custom caption by setting the property. The object can also automatically convert empty string ("") field values to null values by setting the property to `true`. - - You can hide a object in a data-bound control by setting the property to `false`. To prevent the value of a field from being modified in edit mode, set the property to `true`. In data-bound controls that support inserting records (such as the control), you can hide a object by setting the property to `false`. This is commonly done when you want to hide an automatically generated key field in insert mode. - - You can customize the header and footer sections of a object. To display a caption in the header or footer sections, set the or properties, respectively. Instead of displaying text in the header section, you can display an image by setting the property. The header section can be hidden in the object by setting the property to `false`. - + class is used by data-bound controls (such as and ) to display the value of a field as text. The object is displayed differently depending on the data-bound control in which it is used. For example, the control displays a object as a column, while the control displays it as a row. + + To specify the field to display in a object, set the property to the field's name. The field's value can be HTML-encoded before it is displayed by setting the property to `true`. You can apply a custom formatting string to the field's value by setting the property. When the property is `true`, the encoded string value of the field is used in the custom format string. By default, the formatting string is applied to field values only when the data-bound control is in read-only mode. To apply the formatting string to values displayed while the data-bound control is in edit mode, set the property to `true`. If a field's value is null, you can display a custom caption by setting the property. The object can also automatically convert empty string ("") field values to null values by setting the property to `true`. + + You can hide a object in a data-bound control by setting the property to `false`. To prevent the value of a field from being modified in edit mode, set the property to `true`. In data-bound controls that support inserting records (such as the control), you can hide a object by setting the property to `false`. This is commonly done when you want to hide an automatically generated key field in insert mode. + + You can customize the header and footer sections of a object. To display a caption in the header or footer sections, set the or properties, respectively. Instead of displaying text in the header section, you can display an image by setting the property. The header section can be hidden in the object by setting the property to `false`. + > [!NOTE] -> Some data-bound controls (such as the control) can show or hide only the entire header section of the control. These data-bound controls do not support the property for an individual bound field. To show or hide the entire header section of a data-bound control (if available), use the control's `ShowHeader` property. - - You also can customize the appearance of the object (font color, background color, and so on) by setting the style properties for the different parts of the field. The following table lists the different style properties. - -|Style property|Description| -|--------------------|-----------------| -||The style settings for the child Web server controls of the object.| -||The style settings for the footer section of the object.| -||The style settings for the header section of the object.| -||The style settings for the data items in the object.| - - - -## Examples - The following code example demonstrates how to use a object to display the values of a field in a control. - +> Some data-bound controls (such as the control) can show or hide only the entire header section of the control. These data-bound controls do not support the property for an individual bound field. To show or hide the entire header section of a data-bound control (if available), use the control's `ShowHeader` property. + + You also can customize the appearance of the object (font color, background color, and so on) by setting the style properties for the different parts of the field. The following table lists the different style properties. + +|Style property|Description| +|--------------------|-----------------| +||The style settings for the child Web server controls of the object.| +||The style settings for the footer section of the object.| +||The style settings for the header section of the object.| +||The style settings for the data items in the object.| + + + +## Examples + The following code example demonstrates how to use a object to display the values of a field in a control. + :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/BoundField/CS/boundfieldcs.aspx" id="Snippet1"::: - :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/BoundField/VB/boundfieldvb.aspx" id="Snippet1"::: - + :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/BoundField/VB/boundfieldvb.aspx" id="Snippet1"::: + ]]> @@ -93,24 +93,24 @@ Initializes a new instance of the class. - class. This constructor is commonly used when adding fields to a dynamically created data-bound control. - - To dynamically add a object to a data-bound control, create a new object, set its properties, and then add it to the data-bound control's field collection. For example, if you are using the control, add the object to the collection. - + class. This constructor is commonly used when adding fields to a dynamically created data-bound control. + + To dynamically add a object to a data-bound control, create a new object, set its properties, and then add it to the data-bound control's field collection. For example, if you are using the control, add the object to the collection. + > [!NOTE] -> Although you can dynamically add fields to a data-bound control, it is strongly recommended that fields be statically declared and then shown or hidden, as appropriate. Statically declaring all of your fields reduces the size of the view state for the parent data-bound control. - - - -## Examples - The following code example demonstrates how to use the constructor to dynamically add a object to a control. - +> Although you can dynamically add fields to a data-bound control, it is strongly recommended that fields be statically declared and then shown or hidden, as appropriate. Statically declaring all of your fields reduces the size of the view state for the parent data-bound control. + + + +## Examples + The following code example demonstrates how to use the constructor to dynamically add a object to a control. + :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/BoundFieldCtor/CS/boundfieldctorcs.aspx" id="Snippet1"::: - :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/BoundFieldCtor/VB/boundfieldctorvb.aspx" id="Snippet1"::: - + :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/BoundFieldCtor/VB/boundfieldctorvb.aspx" id="Snippet1"::: + ]]> @@ -144,22 +144,22 @@ to apply the formatting string to field values in edit mode; otherwise, . The default is . - , , and ) have different display modes that allow the user to read, edit, or insert records. By default, the formatting string specified by the property is applied to field values only when the data-bound control is in read-only mode. To apply the formatting string to values displayed while the data-bound control is in edit mode, set the property to `true`. - + , , and ) have different display modes that allow the user to read, edit, or insert records. By default, the formatting string specified by the property is applied to field values only when the data-bound control is in read-only mode. To apply the formatting string to values displayed while the data-bound control is in edit mode, set the property to `true`. + > [!NOTE] -> A object does not automatically remove the formatting when the field is updated in the data source. If you do not want the formatting as part of the value stored, you will need to remove the formatting programmatically. - - - -## Examples - The following code example demonstrates how to use the property to apply the formatting string to field values while a control is in edit mode. The formatting is then programmatically removed before the value is updated in the data source. - +> A object does not automatically remove the formatting when the field is updated in the data source. If you do not want the formatting as part of the value stored, you will need to remove the formatting programmatically. + + + +## Examples + The following code example demonstrates how to use the property to apply the formatting string to field values while a control is in edit mode. The formatting is then programmatically removed before the value is updated in the data source. + :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/boundfieldapplyformatineditmode/CS/boundfieldapplyformatineditmodecs.aspx" id="Snippet1"::: - :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/boundfieldapplyformatineditmode/VB/boundfieldapplyformatineditmodevb.aspx" id="Snippet1"::: - + :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/boundfieldapplyformatineditmode/VB/boundfieldapplyformatineditmodevb.aspx" id="Snippet1"::: + ]]> @@ -194,22 +194,22 @@ to automatically convert empty string values to null values; otherwise, the . The default is . - property to specify whether an empty string value is automatically converted to null when the data field is updated in the data source. - + property to specify whether an empty string value is automatically converted to null when the data field is updated in the data source. + > [!NOTE] -> By default, a object displays null values as empty strings. To display a different value, set the property. - - - -## Examples - The following code example demonstrates how to use the property to specify that an empty string ("") field value should automatically be converted to null. - +> By default, a object displays null values as empty strings. To display a different value, set the property. + + + +## Examples + The following code example demonstrates how to use the property to specify that an empty string ("") field value should automatically be converted to null. + :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/boundfieldconvertemptystringtonull/CS/boundfieldconvertemptystingtonullcs.aspx" id="Snippet1"::: - :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/boundfieldconvertemptystringtonull/VB/boundfieldconvertemptystingtonullvb.aspx" id="Snippet1"::: - + :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/boundfieldconvertemptystringtonull/VB/boundfieldconvertemptystingtonullvb.aspx" id="Snippet1"::: + ]]> @@ -240,11 +240,11 @@ The to copy the properties of the current to. Copies the properties of the current object to the specified object. - method is a helper method used by the method to copy the properties of the current object to the object created by the method. - + method is a helper method used by the method to copy the properties of the current object to the object created by the method. + ]]> @@ -272,11 +272,11 @@ Creates an empty object. An empty . - method is a helper method used by the method to create an empty object to copy the properties of the current object to. - + method is a helper method used by the method to create an empty object to copy the properties of the current object to. + ]]> @@ -317,22 +317,22 @@ Gets or sets the name of the data field to bind to the object. The name of the data field to bind to the . The default is an empty string (""), which indicates that this property is not set. - property to specify the name of the data field to bind to the object. The values of the specified field are displayed in the object as text. You can optionally format the displayed text by setting the property. - + property to specify the name of the data field to bind to the object. The values of the specified field are displayed in the object as text. You can optionally format the displayed text by setting the property. + > [!NOTE] -> If a field's value is null, an empty string ("") is displayed for the value by default. To specify an alternate caption, set the property. - - - -## Examples - The following code example demonstrates how to use the property to specify which field to display in a field column of a control. - +> If a field's value is null, an empty string ("") is displayed for the value by default. To specify an alternate caption, set the property. + + + +## Examples + The following code example demonstrates how to use the property to specify which field to display in a field column of a control. + :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/BoundField/CS/boundfieldcs.aspx" id="Snippet1"::: - :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/BoundField/VB/boundfieldvb.aspx" id="Snippet1"::: - + :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/BoundField/VB/boundfieldvb.aspx" id="Snippet1"::: + ]]> @@ -365,78 +365,76 @@ Gets or sets the string that specifies the display format for the value of the field. A formatting string that specifies the display format for the value of the field. The default is an empty string (""), which indicates that no special formatting is applied to the field value. - property to specify a custom display format for the values that are displayed in the object. If the property is not set, the field's value is displayed without any special formatting. - + property to specify a custom display format for the values that are displayed in the object. If the property is not set, the field's value is displayed without any special formatting. + > [!NOTE] -> In versions of ASP.NET earlier than 3.5, you must set the property to `false` in order to format fields that are not string data types. Otherwise, the field value is converted to a string by the default conversion method before the format string that is stored in the property is applied. - - By default, the formatting string is applied to the field value only when the data-bound control that contains the object is in read-only mode. To apply the formatting string to field values while in edit mode, set the property to `true`. - - The formatting string can be any literal string and usually includes a placeholder for the field's value. For example, in the formatting string `Item Value: {0}`, the field's value is substituted for the {0} placeholder when the string is displayed in the object. The rest of the formatting string is displayed as literal text. - - If the formatting string does not include a placeholder, only the formatting string itself is included in the final display text (the field's value from the data source is not included). If the placeholder is a 0 (zero) enclosed in curly braces as shown in the preceding example, the field value is converted to a string by the default method. You can append to the zero a string that specifies how the field value should be formatted. For example, the placeholder `{0:C}` for a numeric field specifies that value of the field should be converted to a currency format. - - Formatting is applied by using the method. The number that follows the left curly brace is part of the syntax used by that method and indicates which one of a series of values the placeholder should use. Because there is only one field value in each cell, the number that follows the left curly brace can only be set to 0. - - The following table lists the standard format characters for numeric fields. These format characters are not case-sensitive, except for `X`, which displays hexadecimal characters in the case that is specified. You can append a number to most format characters in order to specify how many significant digits or decimal places you want to display. - +> In versions of ASP.NET earlier than 3.5, you must set the property to `false` in order to format fields that are not string data types. Otherwise, the field value is converted to a string by the default conversion method before the format string that is stored in the property is applied. + + By default, the formatting string is applied to the field value only when the data-bound control that contains the object is in read-only mode. To apply the formatting string to field values while in edit mode, set the property to `true`. + + The formatting string can be any literal string and usually includes a placeholder for the field's value. For example, in the formatting string `Item Value: {0}`, the field's value is substituted for the {0} placeholder when the string is displayed in the object. The rest of the formatting string is displayed as literal text. + + If the formatting string does not include a placeholder, only the formatting string itself is included in the final display text (the field's value from the data source is not included). If the placeholder is a 0 (zero) enclosed in curly braces as shown in the preceding example, the field value is converted to a string by the default method. You can append to the zero a string that specifies how the field value should be formatted. For example, the placeholder `{0:C}` for a numeric field specifies that value of the field should be converted to a currency format. + + Formatting is applied by using the method. The number that follows the left curly brace is part of the syntax used by that method and indicates which one of a series of values the placeholder should use. Because there is only one field value in each cell, the number that follows the left curly brace can only be set to 0. + + The following table lists the standard format characters for numeric fields. These format characters are not case-sensitive, except for `X`, which displays hexadecimal characters in the case that is specified. You can append a number to most format characters in order to specify how many significant digits or decimal places you want to display. + > [!NOTE] -> In most cases, formatting depends on the server's culture setting. The examples are for a culture setting of `en-US`. - -|Format character|Description|Example| -|----------------------|-----------------|-------------| -|`C` or `c`|Displays numeric values in currency format. You can specify the number of decimal places.|Format: `{0:C}`

123.456 -> $123.46

Format: `{0:C3}`

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}`

1234 -> 1234

Format: `{0:D6}`

1234 -> 001234| -|`E` or `e`|Displays numeric values in scientific (exponential) format. You can specify the number of decimal places.|Format: `{0:E}`

1052.0329112756 -> 1.052033E+003

Format: `{0:E2}`

-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}`

1234.567 -> 1234.57

Format: `{0:F3}`

1234.567 -> 1234.567| -|`G` or `g`|Displays numeric values in general format (the most compact of either fixed-point or scientific notation). You can specify the number of significant digits.|Format: `{0:G}`

-123.456 -> -123.456

Format: `{0:G2}`

-123.456 -> -120| -|`N` or `n`|Displays numeric values in number format (including group separators and optional negative sign). You can specify the number of decimal places.|Format: `{0:N}`

1234.567 -> 1,234.57

Format: `{0:N4}`

1234.567 -> 1,234.5670| -|`P` or `p`|Displays numeric values in percent format. You can specify the number of decimal places.|Format: `{0:P}`

1 -> 100.00%

Format: `{0:P1}`

.5 -> 50.0%| -|`R` or `r`|Displays , , or `BigInteger` values in round-trip format.|Format: `{0:R}`

123456789.12345678 -> 123456789.12345678| -|`X` or `x`|Displays integer values in hexadecimal format. You can specify the number of digits.|Format: `{0:X}`

255 -> FF

Format: `{0:x4}`

255 -> 00ff| - - For more information and for examples that show formatting for other culture values, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). You can also create custom numeric format strings. For more information, see [Custom Numeric Format Strings](/dotnet/standard/base-types/custom-numeric-format-strings). - - The following table lists format characters for fields. Most of these formatting specifications result in a different output depending on culture settings. The examples are for a value of 6/15/2009 1:45:30 PM with a culture setting of `en-US`. - -|Format character|Description|Example| -|----------------------|-----------------|-------------| -|`d`|Short date pattern.|Format: `{0:d}`

6/15/2009 1:45:30 PM -> 6/15/2009| -|`D`|Long date pattern.|Format: `{0:D}`

6/15/2009 1:45:30 PM ->Monday, June 15, 2009| -|`f`|Full date/time pattern (short time).|Format: `{0:f}`

6/15/2009 1:45:30 PM -> Monday, June 15, 2009 1:45 PM| -|`F`|Full date/time pattern (long time).|Format: `{0:F}`

6/15/2009 1:45:30 PM -> Monday, June 15, 2009 1:45:30 PM| -|`g`|General date/time pattern (short time).|Format: `{0:g}`

6/15/2009 1:45:30 PM -> 6/15/2009 1:45 PM| -|`G`|General date/time pattern (long time).|Format: `{0:G}`

6/15/2009 1:45:30 PM -> 6/15/2009 1:45:30 PM| -|`M` or `m`|Month/day pattern.|Format: `{0:M}`

6/15/2009 1:45:30 PM -> June 15| -|`O` or `o`|Round-trip date/time pattern.|Format: `{0:o}`

6/15/2009 1:45:30 PM -> 2009-06-15T13:45:30.0900000| -|`R` or `r`|RFC1123 pattern (for information, see ).|Format: `{0:R}`

6/15/2009 1:45:30 PM -> Mon, 15 Jun 2009 20:45:30 GMT| -|`s`|Sortable date/time pattern.|Format: `{0:s}`

6/15/2009 1:45:30 PM -> 2009-06-15T13:45:30| -|`t`|Short time pattern.|Format: `{0:t}`

6/15/2009 1:45:30 PM -> 1:45 PM| -|`T`|Long time pattern.|Format: `{0:T}`

6/15/2009 1:45:30 PM -> 1:45:30 PM| -|`u`|Universal sortable date/time pattern.|Format: `{0:u}`

6/15/2009 1:45:30 PM -> 2009-06-15 20:45:30Z| -|`U`|Universal full date/time pattern.|Format: `{0:U}`

6/15/2009 1:45:30 PM -> Monday, June 15, 2009 8:45:30 PM| -|`Y` or `y`|Year month pattern.|Format: `{0:Y}`

6/15/2009 1:45:30 PM -> June, 2009| - - For more information and for examples that show formatting for other culture values, see [Standard Date and Time Format Strings](/dotnet/standard/base-types/standard-date-and-time-format-strings). You can also create custom date and time format strings. For more information, see [Custom Date and Time Format Strings](/dotnet/standard/base-types/custom-date-and-time-format-strings). - - - -## Examples - A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=191889). - - The following example shows how to use the 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| -|---------------|----------|-------------------|---------------|------------|------------------| -|`000680`|`HL Road Frame - Black, 58`|`#FR-R92B-58`|`$1,431.50`|`1016.040`|`3/11/2004`| - +> In most cases, formatting depends on the server's culture setting. The examples are for a culture setting of `en-US`. + +|Format character|Description|Example| +|----------------------|-----------------|-------------| +|`C` or `c`|Displays numeric values in currency format. You can specify the number of decimal places.|Format: `{0:C}`

123.456 -> \\$123.46

Format: `{0:C3}`

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}`

1234 -> 1234

Format: `{0:D6}`

1234 -> 001234| +|`E` or `e`|Displays numeric values in scientific (exponential) format. You can specify the number of decimal places.|Format: `{0:E}`

1052.0329112756 -> 1.052033E+003

Format: `{0:E2}`

-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}`

1234.567 -> 1234.57

Format: `{0:F3}`

1234.567 -> 1234.567| +|`G` or `g`|Displays numeric values in general format (the most compact of either fixed-point or scientific notation). You can specify the number of significant digits.|Format: `{0:G}`

-123.456 -> -123.456

Format: `{0:G2}`

-123.456 -> -120| +|`N` or `n`|Displays numeric values in number format (including group separators and optional negative sign). You can specify the number of decimal places.|Format: `{0:N}`

1234.567 -> 1,234.57

Format: `{0:N4}`

1234.567 -> 1,234.5670| +|`P` or `p`|Displays numeric values in percent format. You can specify the number of decimal places.|Format: `{0:P}`

1 -> 100.00%

Format: `{0:P1}`

.5 -> 50.0%| +|`R` or `r`|Displays , , or `BigInteger` values in round-trip format.|Format: `{0:R}`

123456789.12345678 -> 123456789.12345678| +|`X` or `x`|Displays integer values in hexadecimal format. You can specify the number of digits.|Format: `{0:X}`

255 -> FF

Format: `{0:x4}`

255 -> 00ff| + + For more information and for examples that show formatting for other culture values, see [Standard Numeric Format Strings](/dotnet/standard/base-types/standard-numeric-format-strings). You can also create custom numeric format strings. For more information, see [Custom Numeric Format Strings](/dotnet/standard/base-types/custom-numeric-format-strings). + + The following table lists format characters for fields. Most of these formatting specifications result in a different output depending on culture settings. The examples are for a value of 6/15/2009 1:45:30 PM with a culture setting of `en-US`. + +|Format character|Description|Example| +|----------------------|-----------------|-------------| +|`d`|Short date pattern.|Format: `{0:d}`

6/15/2009 1:45:30 PM -> 6/15/2009| +|`D`|Long date pattern.|Format: `{0:D}`

6/15/2009 1:45:30 PM ->Monday, June 15, 2009| +|`f`|Full date/time pattern (short time).|Format: `{0:f}`

6/15/2009 1:45:30 PM -> Monday, June 15, 2009 1:45 PM| +|`F`|Full date/time pattern (long time).|Format: `{0:F}`

6/15/2009 1:45:30 PM -> Monday, June 15, 2009 1:45:30 PM| +|`g`|General date/time pattern (short time).|Format: `{0:g}`

6/15/2009 1:45:30 PM -> 6/15/2009 1:45 PM| +|`G`|General date/time pattern (long time).|Format: `{0:G}`

6/15/2009 1:45:30 PM -> 6/15/2009 1:45:30 PM| +|`M` or `m`|Month/day pattern.|Format: `{0:M}`

6/15/2009 1:45:30 PM -> June 15| +|`O` or `o`|Round-trip date/time pattern.|Format: `{0:o}`

6/15/2009 1:45:30 PM -> 2009-06-15T13:45:30.0900000| +|`R` or `r`|RFC1123 pattern (for information, see ).|Format: `{0:R}`

6/15/2009 1:45:30 PM -> Mon, 15 Jun 2009 20:45:30 GMT| +|`s`|Sortable date/time pattern.|Format: `{0:s}`

6/15/2009 1:45:30 PM -> 2009-06-15T13:45:30| +|`t`|Short time pattern.|Format: `{0:t}`

6/15/2009 1:45:30 PM -> 1:45 PM| +|`T`|Long time pattern.|Format: `{0:T}`

6/15/2009 1:45:30 PM -> 1:45:30 PM| +|`u`|Universal sortable date/time pattern.|Format: `{0:u}`

6/15/2009 1:45:30 PM -> 2009-06-15 20:45:30Z| +|`U`|Universal full date/time pattern.|Format: `{0:U}`

6/15/2009 1:45:30 PM -> Monday, June 15, 2009 8:45:30 PM| +|`Y` or `y`|Year month pattern.|Format: `{0:Y}`

6/15/2009 1:45:30 PM -> June, 2009| + + For more information and for examples that show formatting for other culture values, see [Standard Date and Time Format Strings](/dotnet/standard/base-types/standard-date-and-time-format-strings). You can also create custom date and time format strings. For more information, see [Custom Date and Time Format Strings](/dotnet/standard/base-types/custom-date-and-time-format-strings). + + + +## Examples + A Visual Studio Web site project with source code is available to accompany this topic: [Download](https://go.microsoft.com/fwlink/?LinkId=191889). + + The following example shows how to use the 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| +|---------------|----------|-------------------|---------------|------------|------------------| +|`000680`|`HL Road Frame - Black, 58`|`#FR-R92B-58`|`$1,431.50`|`1016.040`|`3/11/2004`| + ]]>
@@ -474,19 +472,19 @@ to include the values of read-only fields; otherwise, . Fills the specified object with the values from the specified object. - method is provided as a convenient way to retrieve the values of the fields from the specified object in a object. - + method is provided as a convenient way to retrieve the values of the fields from the specified object in a object. + > [!NOTE] -> This method is used primarily by control developers. - - This method does not have a return value. Instead, the field values are returned by reference through the object passed in for the `dictionary` parameter. After the method has been called, iterate through the object to access the field values. - +> This method is used primarily by control developers. + + This method does not have a return value. Instead, the field values are returned by reference through the object passed in for the `dictionary` parameter. After the method has been called, iterate through the object to access the field values. + > [!NOTE] -> If the object contains read-only field values, you must pass in `true` for the `includeReadOnly` parameter to include those values. - +> If the object contains read-only field values, you must pass in `true` for the `includeReadOnly` parameter to include those values. + ]]> @@ -520,14 +518,14 @@ Formats the specified field value for a cell in the object. The field value converted to the format specified by . - method is a helper method used to transform a field value to the format specified by the property. If a field value is null, the value of the property is returned. - + method is a helper method used to transform a field value to the format specified by the property. If a field value is null, the value of the property is returned. + > [!NOTE] -> This method is used primarily by control developers. - +> This method is used primarily by control developers. + ]]> @@ -556,14 +554,14 @@ Retrieves the value used for a field's value when rendering the object in a designer. The value to display in the designer as the field's value. - method is a helper method used to determine what value to display for a field when rendering the object in a designer. If real data cannot be retrieved from the data source at design time, the value returned by this method is displayed instead. - + method is a helper method used to determine what value to display for a field when rendering the object in a designer. If real data cannot be retrieved from the data source at design time, the value returned by this method is displayed instead. + > [!NOTE] -> This method is used primarily by control developers. - +> This method is used primarily by control developers. + ]]> @@ -596,24 +594,24 @@ Retrieves the value of the field bound to the object. The value of the field bound to the . - method is a helper method used to determine the value of a field. If the object is being displayed in a designer and the field value cannot be determined at design time, the value returned from the method is returned instead of the actual field value. - + method is a helper method used to determine the value of a field. If the object is being displayed in a designer and the field value cannot be determined at design time, the value returned from the method is returned instead of the actual field value. + > [!NOTE] -> This method is used primarily by control developers. - +> This method is used primarily by control developers. + ]]> - The container specified by the parameter is . - + The container specified by the parameter is . + -or- - - The container specified by the parameter does not have a data item. - + + The container specified by the parameter does not have a data item. + -or- - + The data field was not found. When extending the class, you can override this method to provide a custom routine to determine a field's value. @@ -641,11 +639,11 @@ Gets or sets the text that is displayed in the header of a data control. The text displayed in the header of a data control. The default value is an empty string (""). - property to identify a field in a data control with a friendly name. The most common application of the property is to provide meaningful column names to data-bound fields in a or control. - + property to identify a field in a data control with a friendly name. The most common application of the property is to provide meaningful column names to data-bound fields in a or control. + ]]> @@ -678,22 +676,22 @@ if field values are HTML-encoded before they are displayed in a object; otherwise, . The default is . - property to specify whether field values are HTML-encoded to their respective string representations before they are displayed in a object. For example, if this property is `true`, a string value of "\