diff --git a/xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml b/xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml index d28f28ebdf5..9a6cbbd82cd 100644 --- a/xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml +++ b/xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml @@ -37,9 +37,7 @@ ## Remarks You use the class to retrieve information about a profile property when you access profiles through the class. You can retrieve the name and type of the property, whether it is read-only, whether it can be accessed by users who have not been authenticated, and the default value. An application can take the appropriate actions based on these values, such as not trying to set a read-only property. - To access the object from an application that is compatible with the Windows Communication Framework (WCF), use the method of the class. The user does not have to be logged on to retrieve the object because the metadata for profile properties is not specific to a user's profile property values. - - The values in the class are set in the Web.config file in the element of the section when the property is defined. + To access the object from an application that's compatible with Windows Communication Framework (WCF), use the method of the class. The user does not have to be logged on to retrieve the object because the metadata for profile properties is not specific to a user's profile property values. ]]> @@ -107,7 +105,7 @@ property in the element of the section of the Web.config file when the property is defined. From the client application, use the property to determine whether a profile property can be set for an anonymous user. + When you enable anonymous identification, you can set which profile properties are available to anonymous users. From the client application, use the property to determine whether a profile property can be set for an anonymous user. ]]> @@ -225,14 +223,7 @@ Gets or sets a value that indicates whether a profile property is read-only. if the profile property is read-only; otherwise, . - - property in the element of the section of the Web.config file when the property is defined. - - ]]> - + To be added. @@ -268,14 +259,7 @@ Gets or sets the name of the profile property. The name of the profile property as defined in the Web.config file. - - property in the element of the section of the Web.config file when the property is defined. - - ]]> - + To be added. @@ -311,14 +295,7 @@ Gets or sets a value that indicates how to serialize the property value. The enumeration value. - - property in the element of the section of the Web.config file when the property is defined. - - ]]> - + To be added. @@ -354,14 +331,7 @@ Gets or sets the assembly-qualified name of the profile property type. The assembly-qualified name of the profile property type. - - property in the element of the section of the Web.config file when the property is defined. - - ]]> - + To be added. diff --git a/xml/System.Web.Caching/OutputCacheUtility.xml b/xml/System.Web.Caching/OutputCacheUtility.xml index cb66b3f0f1a..7f3659f4e3a 100644 --- a/xml/System.Web.Caching/OutputCacheUtility.xml +++ b/xml/System.Web.Caching/OutputCacheUtility.xml @@ -62,7 +62,7 @@ - A string that contains the URI to flush. + A string that contains the URI to flush. Flushes the kernel cache for a specific Uniform Resource Identifier (URI). To be added. diff --git a/xml/System.Web.Caching/SqlCacheDependency.xml b/xml/System.Web.Caching/SqlCacheDependency.xml index 690aeb2d338..45d4f38904c 100644 --- a/xml/System.Web.Caching/SqlCacheDependency.xml +++ b/xml/System.Web.Caching/SqlCacheDependency.xml @@ -24,12 +24,12 @@ The class also supports integration with the class when using a SQL Server 2005 database. The query notification mechanism of SQL Server 2005 detects changes to data that invalidate the results of an SQL query and removes any cached items associated with the SQL query from the . - You can use the class to add items to your application's that are dependent on either a SQL Server database table or on an SQL query when using SQL Server 2005. You can also use this class with the directive to make an output-cached page or a user control dependent on a SQL Server database table. Finally, you can use the class with the page directive to make an output-cached page dependent on the results of an SQL query when using SQL Server 2005. Query notification using SQL Server 2005 is not supported on the directive for user controls. + You can use the class to add items to your application's that are dependent on either a SQL Server database table or on an SQL query when using SQL Server 2005. You can also use this class with the `@ OutputCache` directive to make an output-cached page or a user control dependent on a SQL Server database table. Finally, you can use the class with the `@ OutputCache` page directive to make an output-cached page dependent on the results of an SQL query when using SQL Server 2005. Query notification using SQL Server 2005 is not supported on the `@ OutputCache` directive for user controls. > [!NOTE] -> For this class to work correctly when using table-based notifications, the database and any tables that you want to make dependencies on must have notifications enabled. You can enable notifications by calling methods of the class or by using the command-line tool. In addition, the proper configuration settings must be included in the application's Web.config file. +> For this class to work correctly when using table-based notifications, the database and any tables that you want to make dependencies on must have notifications enabled. You can enable notifications by calling methods of the class or by using the `aspnet_regsql.exe` command-line tool. In addition, the proper configuration settings must be included in the application's Web.config file. > -> Using a object with SQL Server 2005 query notification does not require any explicit configuration. Consult the SQL Server 2005 Books Online for information about restrictions on the types of Transact-SQL queries that are allowed when using query notification. +> Using a object with SQL Server 2005 query notification does not require any explicit configuration. Consult the SQL Server documentation for information about restrictions on the types of Transact-SQL queries that are allowed when using query notification. The following example shows an ASP.NET Web.config file that enables table-based dependencies on a SQL Server database table. @@ -114,7 +114,7 @@ ]]> The parameter is . - The instance has its property set to and there is an directive on the page with the attribute set to CommandNotification. + The instance has its property set to and there is an `@ OutputCache` directive on the page with the attribute set to CommandNotification. @@ -167,7 +167,7 @@ ``` - Two exceptions are commonly thrown when this constructor is used: and . If a is thrown, you can call the method in exception-handling code, or use the command-line tool to set up the database for notifications. If a is thrown, you can call the method or use to set up the table for notifications. + Two exceptions are commonly thrown when this constructor is used: and . If a is thrown, you can call the method in exception-handling code, or use the `aspnet_regsql.exe` command-line tool to set up the database for notifications. If a is thrown, you can call the method or use `aspnet_regsql.exe` to set up the table for notifications. diff --git a/xml/System.Web.Compilation/BuildProvider.xml b/xml/System.Web.Compilation/BuildProvider.xml index 111ebffbf32..c245628e452 100644 --- a/xml/System.Web.Compilation/BuildProvider.xml +++ b/xml/System.Web.Compilation/BuildProvider.xml @@ -30,7 +30,7 @@ To define custom build actions for a file type within an ASP.NET application, you must derive a class from , implement members within the derived class for building the file type, and configure the build provider for the corresponding file extension within the application configuration file. - The specifies the file extension for supported files, and whether the build provider supports code files, Web files, resource files or all files. Use the `type` attribute to specify the fully qualified type name of the build provider implementation. Use the class to specify whether the build provider applies to files in the App_Code directory, to files in a Web content directory, to global or local resources, or to all files. Use the `extension` attribute to specify the file extension used to identify files that the class supports. Use the class to examine build providers in a configuration file. For more information about configuring a build provider, see [buildProviders Element for compilation (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/40fa889d-5412-487a-b6a9-21eb011c2384). + The `add` element specifies the file extension for supported files, and whether the build provider supports code files, Web files, resource files, or all files. Use the `type` attribute to specify the fully qualified type name of the build provider implementation. Use the class to specify whether the build provider applies to files in the App_Code directory, to files in a Web content directory, to global or local resources, or to all files. Use the `extension` attribute to specify the file extension used to identify files that the class supports. Use the class to examine build providers in a configuration file. For more information about configuring a build provider, see [buildProviders Element for compilation (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/40fa889d-5412-487a-b6a9-21eb011c2384). To implement a build provider that generates source code for a custom file type, derive a class from , and override the method to generate source code for the supported file type. The generated source is added to the object in the form of a CodeDOM graph, or as content that represents a physical source code file. If the build provider requires a specific programming language, override the property to return a object for the supported programming language. If the build provider does not require a specific programming language, do not override the property; use the base class implementation, which indicates that the build provider can use any .NET Framework language, such as Visual Basic or C#. @@ -276,7 +276,7 @@ ## Remarks Use the method to examine the default compiler type for a build provider. Use the method to examine the compiler type configured in a build provider for a specific language name. - The base class determines the default compiler type using the `defaultLanguage` attribute value in the section of the application configuration file. If there is no default language setting in the compilation section, the default compiler type is set using the language provider. + The base class determines the default compiler type using the `defaultLanguage` attribute value in the `compilation` section of the application configuration file. If there is no default language setting in the `compilation` section, the default compiler type is set using the language provider. When deriving from the class, you can use to set the property within your implementation. @@ -315,7 +315,7 @@ ## Remarks Use the method to examine the compiler type configured in the build provider for a specific language name. Use the method to examine the default compiler type for a build provider. - The base class determines the default compiler type using the elements in the property of the object for the configuration file. This is equivalent to examining the elements in the and the elements in the sections of the configuration file. For example, for the `language` value VB, the base class method returns a object that corresponds to the configured settings for an instance of . + The base class determines the default compiler type using the elements in the property of the object for the configuration file. This is equivalent to examining the `buildProviders` elements and the `compiler` elements in the `compilers` sections of the configuration file. For example, for the `language` value `VB`, the base class method returns a object that corresponds to the configured settings for an instance of . When you derive from the class, you can use to set the property value for the language supported by your implementation. @@ -626,7 +626,7 @@ method. The ASP.NET build environment resolves external types during assembly compilation using both the referenced assemblies added by build providers and the default collection of assemblies available for reference. diff --git a/xml/System.Web.Configuration/AnonymousIdentificationSection.xml b/xml/System.Web.Configuration/AnonymousIdentificationSection.xml index fb7bb9825a9..037084df582 100644 --- a/xml/System.Web.Configuration/AnonymousIdentificationSection.xml +++ b/xml/System.Web.Configuration/AnonymousIdentificationSection.xml @@ -244,9 +244,7 @@ ## Remarks To improve the protection of your cookie, you may want also set the property to `true`. - Be sure to use the default value for this property if you want both data validation and encryption to help protect the cookie. This option uses the configured data-validation algorithm, based on the element. Triple-DES (3DES) is used for encryption, if available and if the key is long enough (48 bytes or more). - - + Be sure to use the default value for this property if you want both data validation and encryption to help protect the cookie. This option uses the configured data-validation algorithm. Triple-DES (3DES) is used for encryption, if available and if the key is long enough (48 bytes or more). ## Examples The following code example shows how to access the property. diff --git a/xml/System.Web.Configuration/FormsAuthenticationConfiguration.xml b/xml/System.Web.Configuration/FormsAuthenticationConfiguration.xml index cdd2380a400..39624a919ff 100644 --- a/xml/System.Web.Configuration/FormsAuthenticationConfiguration.xml +++ b/xml/System.Web.Configuration/FormsAuthenticationConfiguration.xml @@ -296,9 +296,7 @@ This property corresponds to the value of . - This setting will take precedence over the `domain` attribute of the section for forms authentication cookies. - - + This setting will take precedence over the `domain` attribute of the `forms` section for forms authentication cookies. ## Examples The following code example shows how to access the property. Refer to the code example in the class topic to learn how to get the section. diff --git a/xml/System.Web.Configuration/OutputCacheProfile.xml b/xml/System.Web.Configuration/OutputCacheProfile.xml index 1433c3f665f..043ffd7c6cc 100644 --- a/xml/System.Web.Configuration/OutputCacheProfile.xml +++ b/xml/System.Web.Configuration/OutputCacheProfile.xml @@ -24,10 +24,10 @@ The object centralizes frequently used configuration settings such as dependencies, cache location, and cache expiration time, eliminating the need to specify them on every page. - The can be applied to a page using the `CacheProfile` attribute of the directive. + The can be applied to a page using the `CacheProfile` attribute of the `@ OutputCache` directive. > [!NOTE] -> The directive can override all the settings contained by an object except for the attribute. This is to enable or disable the without having to modify the directives in all the pages that might have overridden it. +> The `@ OutputCache` directive can override all the settings contained by an object except for the attribute. This is to enable or disable the without having to modify the directives in all the pages that might have overridden it. The class monitors the dependencies so that when any cached item changes, the cached item will be automatically removed. @@ -102,7 +102,7 @@ The represents the time in seconds that the page or user control is cached. Setting this property establishes an expiration policy for HTTP responses from the page or control to which it applies and will automatically cause the caching of their output. > [!NOTE] -> The must be defined in either the profile or the directive of a page using the profile. +> The must be defined in either the profile or the `@ OutputCache` directive of a page using the profile. @@ -245,7 +245,7 @@ to assign a value to the `CacheProfile` attribute of the directive if you want to apply the values to a page or control. + You use the to assign a value to the `CacheProfile` attribute of the `@ OutputCache` directive if you want to apply the values to a page or control. @@ -410,7 +410,7 @@ settings are the same ones used by the `VaryByContentEncoding` attribute of the directive. + The settings are the same ones used by the `VaryByContentEncoding` attribute of the `@ OutputCache` directive. is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). @@ -453,7 +453,7 @@ For more information, see [Caching Multiple Versions of User Control Output](https://msdn.microsoft.com/library/7f7d839a-c060-4d2a-9c4e-7fd1080ec0ad). > [!NOTE] -> The settings are the same ones used by the `VaryByControls` attribute of the directive. +> The settings are the same ones used by the `VaryByControl` attribute of the `@ OutputCache` directive. @@ -501,7 +501,7 @@ The can be any text that represents custom output-caching requirements. If a custom string is entered, you must override the method in the application's Global.asax file. > [!NOTE] -> The settings are the same ones used by the `VaryByCustom` attribute of the directive. +> The settings are the same ones used by the `VaryByCustom` attribute of the `@ OutputCache` directive. @@ -598,7 +598,7 @@ ## Remarks The is a semicolon-delimited set of parameters used to vary the cached output. It allows varying the cached output by GET query string or form POST parameters. For instance, you can vary the user-control output to the cache by specifying the user-control name along with either a query string or a form POST parameter. For more information, see [Caching Multiple Versions of User Control Output](https://msdn.microsoft.com/library/7f7d839a-c060-4d2a-9c4e-7fd1080ec0ad). - The setting must be defined in either the profile or the directive of the page using the profile. + The setting must be defined in either the profile or the `@ OutputCache` directive of the page using the profile. > [!NOTE] > The settings are the same ones used by the `VaryByParam` attribute of the [@ OutputCache](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)). Varying by all parameters by setting the value of "\*" is not recommended. It can result in cache overflow or a denial of service attack on the Web server. diff --git a/xml/System.Web.Configuration/SystemWebCachingSectionGroup.xml b/xml/System.Web.Configuration/SystemWebCachingSectionGroup.xml index f818c285e32..9422983e54e 100644 --- a/xml/System.Web.Configuration/SystemWebCachingSectionGroup.xml +++ b/xml/System.Web.Configuration/SystemWebCachingSectionGroup.xml @@ -201,7 +201,7 @@ The output cache settings enable or disable disk-based persistent output cache, define the location for persisting the data to be cached, and specify the maximum size of the cache per application. - ASP.NET allows you to cache multiple versions of a page response declaratively by using attributes of the directive and programmatically using the properties and methods of the class. + ASP.NET allows you to cache multiple versions of a page response declaratively by using attributes of the `@ OutputCache` directive and programmatically using the properties and methods of the class. You can achieve the same results by configuring the application using the or the type. diff --git a/xml/System.Web.Configuration/TicketCompatibilityMode.xml b/xml/System.Web.Configuration/TicketCompatibilityMode.xml index 601f0ac21ca..9fd05fd4305 100644 --- a/xml/System.Web.Configuration/TicketCompatibilityMode.xml +++ b/xml/System.Web.Configuration/TicketCompatibilityMode.xml @@ -18,14 +18,12 @@ diff --git a/xml/System.Web.Configuration/TraceSection.xml b/xml/System.Web.Configuration/TraceSection.xml index a32f2229bec..a424ed6d326 100644 --- a/xml/System.Web.Configuration/TraceSection.xml +++ b/xml/System.Web.Configuration/TraceSection.xml @@ -20,14 +20,9 @@ class provides a way to programmatically access and modify the content of the configuration file `trace` section. The trace section configures the ASP.NET trace functionality and controls how trace results are gathered, stored, and displayed. + The class provides a way to programmatically access and modify the content of the configuration file `trace` section. The `trace` section configures the ASP.NET trace functionality and controls how trace results are gathered, stored, and displayed. - When tracing is enabled, each page request generates trace messages that can be appended to the page output or stored in an application trace log. You can use the ASP.NET trace viewer (Trace.axd) to view the contents of the trace log. - -> [!NOTE] -> The element is allowed in the section of the configuration hierarchy in the Machine.config file and the Web.config files. It is not allowed in configuration files of Web subdirectories. - - + When tracing is enabled, each page request generates trace messages that can be appended to the page output or stored in an application trace log. You can use the ASP.NET trace viewer (Trace.axd) to view the contents of the trace log. ## Examples The following code example shows how to use the type. diff --git a/xml/System.Web.Configuration/WebConfigurationManager.xml b/xml/System.Web.Configuration/WebConfigurationManager.xml index 1b4c399ac64..0f7465a81e1 100644 --- a/xml/System.Web.Configuration/WebConfigurationManager.xml +++ b/xml/System.Web.Configuration/WebConfigurationManager.xml @@ -213,7 +213,7 @@ Note: If you use a static method that takes a A valid configuration file could not be loaded. - The return value must be cast to the expected configuration type before use. To avoid possible casting exceptions, you should use a conditional casting operation like the operator in C# or the function in Visual Basic. + The return value must be cast to the expected configuration type before use. To avoid possible casting exceptions, you should use a conditional casting operation like the operator in C#. @@ -275,7 +275,7 @@ Note: If you use a static method that takes a The method is called from outside a Web application. A valid configuration file could not be loaded. - The return value must be cast to the expected configuration type before use. To avoid possible casting exceptions, you should use a conditional casting operation like the operator in C# or the function in Visual Basic. + The return value must be cast to the expected configuration type before use. To avoid possible casting exceptions, you should use a conditional casting operation like the operator in C#. @@ -329,7 +329,7 @@ Note: If you use a static method that takes a A valid configuration file could not be loaded. - The return value must be cast to the expected configuration type before use. To avoid possible casting exceptions, you should use a conditional casting operation like the operator in C# or the function in Visual Basic. + The return value must be cast to the expected configuration type before use. To avoid possible casting exceptions, you should use a conditional casting operation like the operator in C#. diff --git a/xml/System.Web.Handlers/TraceHandler.xml b/xml/System.Web.Handlers/TraceHandler.xml index ec883c99024..9ebfda276f3 100644 --- a/xml/System.Web.Handlers/TraceHandler.xml +++ b/xml/System.Web.Handlers/TraceHandler.xml @@ -101,7 +101,7 @@ method writes an that includes all current trace information. The trace information includes calls to the `protected`, , and methods. + The method writes an that includes all current trace information. The trace information includes calls to the `protected` , , and methods. The class implements the method to delegate to the implementation of the method. If you extend the class, implement your own method to display different tracing information. diff --git a/xml/System.Web.Hosting/HostSecurityPolicyResolver.xml b/xml/System.Web.Hosting/HostSecurityPolicyResolver.xml index 96939651981..641af6243b4 100644 --- a/xml/System.Web.Hosting/HostSecurityPolicyResolver.xml +++ b/xml/System.Web.Hosting/HostSecurityPolicyResolver.xml @@ -22,11 +22,11 @@ In complex Web hosting environments such as SharePoint and Web farms, you might have to extend the ASP.NET code access security policy. By extending the type, you can implement custom security policy behavior that overrides the ASP.NET code access security policy. ## Configuring a HostSecurityPolicyResolver Class - In the configuration files, you can configure a custom instance by adding the attribute to the element. The attribute can be set to the name of the custom type that will be loaded by ASP.NET. The attribute value contains the fully qualified name of the derived type. By default, .NET Framework 4 does not set this attribute. + In the configuration files, you can configure a custom instance by adding the attribute to the `trust` element. The attribute can be set to the name of the custom type that will be loaded by ASP.NET. The attribute value contains the fully qualified name of the derived type. By default, .NET Framework 4 does not set this attribute. The following syntax shows how to configure the attribute: -``` +```xml ``` - When specifying the [profile](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ms164644(v%3dvs.100)) section, you must specify a default provider by setting the `defaultProvider` attribute. If you do not specify a section in your Web.config file, the values from the machine configuration are used and the instance named AspNetSqlProvider is established as the default provider. + When specifying the [profile](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ms164644(v%3dvs.100)) section, you must specify a default provider by setting the `defaultProvider` attribute. If you do not specify a `profile` section in your Web.config file, the values from the machine configuration are used and the instance named AspNetSqlProvider is established as the default provider. You can obtain a strongly typed reference to a provider from the collection by indexing the profile provider by name and casting it as the desired type. diff --git a/xml/System.Web.Profile/ProfileModule.xml b/xml/System.Web.Profile/ProfileModule.xml index 0792e76bf3d..2f38f0343b6 100644 --- a/xml/System.Web.Profile/ProfileModule.xml +++ b/xml/System.Web.Profile/ProfileModule.xml @@ -204,14 +204,12 @@ You can use the event to copy profile property values from an anonymous profile to an authenticated profile when a user who has been anonymously using your application logs in. - When an application that has the user profile enabled is started, ASP.NET creates a new class of type `ProfileCommon`, which inherits from the class. Strongly typed accessors are added to the `ProfileCommon` class for each property defined in the configuration section. A `GetProfile` method enables you to retrieve a `ProfileCommon` object based on a user name. You can use the `GetProfile` method of the current, authenticated profile to retrieve the property values of the anonymous profile. The anonymous property values can then be copied to the current profile for the authenticated user. - - + When an application that has the user profile enabled is started, ASP.NET creates a new class of type `ProfileCommon`, which inherits from the class. Strongly typed accessors are added to the `ProfileCommon` class for each property defined in the \ configuration section. A `GetProfile` method enables you to retrieve a `ProfileCommon` object based on a user name. You can use the `GetProfile` method of the current, authenticated profile to retrieve the property values of the anonymous profile. The anonymous property values can then be copied to the current profile for the authenticated user. ## Examples The following example shows a Web.config file that enables anonymous identification and profile properties that support anonymous users. -``` +```xml diff --git a/xml/System.Web.Profile/SqlProfileProvider.xml b/xml/System.Web.Profile/SqlProfileProvider.xml index e9aee3f451f..e0583e0721a 100644 --- a/xml/System.Web.Profile/SqlProfileProvider.xml +++ b/xml/System.Web.Profile/SqlProfileProvider.xml @@ -164,7 +164,7 @@ aspnet_regsql.exe -A p ## Examples - The following code example shows the element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies the application's instance and sets the property value to `MyApplication`. + The following code example shows the `profile` element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies the application's instance and sets the property value to `MyApplication`. ``` diff --git a/xml/System.Web.Routing/RouteCollection.xml b/xml/System.Web.Routing/RouteCollection.xml index b7a59f6ac6e..fb6f93fff63 100644 --- a/xml/System.Web.Routing/RouteCollection.xml +++ b/xml/System.Web.Routing/RouteCollection.xml @@ -37,7 +37,7 @@ ## Remarks The class provides methods that enable you to manage a collection of objects that derive from the class. - Typically, you will use the `static` property of the class to retrieve a object. The property stores all the routes for an ASP.NET application. ASP.NET routing iterates through the routes in the property to find the route that matches a URL. + Typically, you will use the `static` property of the class to retrieve a object. The property stores all the routes for an ASP.NET application. ASP.NET routing iterates through the routes in the property to find the route that matches a URL. To construct a URL, you call the method and pass in a collection of values. The method finds the first route with parameters that match the values that you passed in, and returns a object that contains information about the matching route. You retrieve the URL through the property of the object. diff --git a/xml/System.Web.Security/AnonymousIdentificationEventHandler.xml b/xml/System.Web.Security/AnonymousIdentificationEventHandler.xml index dd0878d33dc..07b349dc946 100644 --- a/xml/System.Web.Security/AnonymousIdentificationEventHandler.xml +++ b/xml/System.Web.Security/AnonymousIdentificationEventHandler.xml @@ -34,9 +34,7 @@ You can use the property of the object supplied to the **AnonymousIdentification_Creating** event to set the anonymous identifier to a custom value. If you do not specify a value for the property during the **AnonymousIdentification_Creating** event, a is used. - The **AnonymousIdentification_Creating** event is only raised when anonymous identification is by setting the configuration element to `true`. - - + The **AnonymousIdentification_Creating** event is only raised when anonymous identification is by setting the \ configuration element to `true`. ## Examples The following code example uses the **AnonymousIdentification_Creating** event to set the anonymous identifier to a custom value. diff --git a/xml/System.Web.Security/AuthorizationStoreRoleProvider.xml b/xml/System.Web.Security/AuthorizationStoreRoleProvider.xml index 9ca63d7a912..fc96bc09987 100644 --- a/xml/System.Web.Security/AuthorizationStoreRoleProvider.xml +++ b/xml/System.Web.Security/AuthorizationStoreRoleProvider.xml @@ -57,7 +57,7 @@ msxml:// ## Examples The following code example shows a Web.config file set to use the for role management. -``` +```xml @@ -252,7 +252,7 @@ msxml:// ## Examples - The following example shows the element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies the application's instance and sets the property to `MyApplication`. + The following example shows the \ element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies the application's instance and sets the property to `MyApplication`. ``` property can be set using the `scopeName` configuration attribute for the provider instance in the `providers` section of the configuration section. + The property can be set using the `scopeName` configuration attribute for the provider instance in the `providers` section of the `roleManager` configuration section. > [!CAUTION] > Because a single default role provider instance is used for all of the requests served by an object, you can have multiple requests executing concurrently and attempting to set the property value. The property is not thread safe for multiple writes, and changing the property value can result in unexpected behavior when there are multiple users of an application. We recommend that you avoid writing code that allows users to set the property unless you must. An example of an application where setting the property may be required is an administrative application that manages role data for multiple applications. Such an application should be a single-user application and not a Web application. diff --git a/xml/System.Web.Security/DefaultAuthenticationEventArgs.xml b/xml/System.Web.Security/DefaultAuthenticationEventArgs.xml index 6a3d8edd86e..876ac7b19a5 100644 --- a/xml/System.Web.Security/DefaultAuthenticationEventArgs.xml +++ b/xml/System.Web.Security/DefaultAuthenticationEventArgs.xml @@ -64,7 +64,7 @@ You can use the property of the object supplied to the **DefaultAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property of the referenced by the property, the sets the property of the to a object that contains no user information. - The **DefaultAuthentication_OnAuthenticate** event is raised after the event and before the event. If you have an section that depends on the user name to deny or allow access to your application, modifying the property of the current can affect the behavior of your application. Be sure that the user name you set during the **DefaultAuthentication_OnAuthenticate** event is considered when you specify the section in your configuration. + The **DefaultAuthentication_OnAuthenticate** event is raised after the event and before the event. If you have an `authorization` section that depends on the user name to deny or allow access to your application, modifying the property of the current can affect the behavior of your application. Be sure that the user name you set during the **DefaultAuthentication_OnAuthenticate** event is considered when you specify the `authorization` section in your configuration. @@ -72,7 +72,7 @@ The following code example uses the **DefaultAuthentication_OnAuthenticate** event to test whether the property of the current is `null`. If the property is `null`, the example sets the property of the current to a object where the property of the object is a object with a property value of "default". > [!NOTE] -> The **DefaultAuthentication_OnAuthenticate** event is raised before the event. As a result, if you set the property of the current to a custom identity, it can affect the behavior of your application. For example, if you are using the class and you are ensuring that only authenticated users have access to your site, by using the section and specifying ``, you will cause the element in this example to be ignored, as the user will have a name, which is "default". Instead you would specify `` to ensure that only authenticated users can access your site. +> The **DefaultAuthentication_OnAuthenticate** event is raised before the event. As a result, if you set the property of the current to a custom identity, it can affect the behavior of your application. For example, if you are using the class and you are ensuring that only authenticated users have access to your site, by using the `authorization` section and specifying ``, you will cause the `deny` element in this example to be ignored, as the user will have a name, which is "default". Instead you would specify `` to ensure that only authenticated users can access your site. [!code-csharp[System.Web.Security.DefaultAuthenticationModule#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.DefaultAuthenticationModule/CS/global.asax#1)] [!code-vb[System.Web.Security.DefaultAuthenticationModule#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.DefaultAuthenticationModule/VB/global.asax#1)] diff --git a/xml/System.Web.Security/DefaultAuthenticationEventHandler.xml b/xml/System.Web.Security/DefaultAuthenticationEventHandler.xml index 90b61caee25..2bd8c557000 100644 --- a/xml/System.Web.Security/DefaultAuthenticationEventHandler.xml +++ b/xml/System.Web.Security/DefaultAuthenticationEventHandler.xml @@ -33,7 +33,7 @@ You can use the property of the object supplied to the **DefaultAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property of the supplied during the **DefaultAuthentication_OnAuthenticate** event, the sets the property of the to a object that contains no user information. - The **DefaultAuthentication_OnAuthenticate** event is raised after the event and before the event. If you have an section that depends on the user name to deny or allow access to your application, modifying the property of the current can affect the behavior of your application. Be sure that the user name you set during the **DefaultAuthentication_OnAuthenticate** event is considered when you specify the section in your configuration. + The **DefaultAuthentication_OnAuthenticate** event is raised after the event and before the event. If you have an `authorization` section that depends on the user name to deny or allow access to your application, modifying the property of the current can affect the behavior of your application. Be sure that the user name you set during the **DefaultAuthentication_OnAuthenticate** event is considered when you specify the `authorization` section in your configuration. @@ -41,7 +41,7 @@ The following code example uses the **DefaultAuthentication_OnAuthenticate** event to test whether the property of the current is `null`. If the property is `null`, the sample sets the property of the current to a object, where the of the object is a with a value of "default". > [!NOTE] -> The **DefaultAuthentication_OnAuthenticate** event is raised before the event. As a result, if you set the property of the current to a custom identity, it can affect the behavior of your application. For example, if you are using the class and you are ensuring that only authenticated users have access to your site, by using the section and specifying ``, this sample will cause the element to be ignored, as the user will have a name, which is "default". Instead you would specify `` to ensure that only authenticated users can access your site. +> The **DefaultAuthentication_OnAuthenticate** event is raised before the event. As a result, if you set the property of the current to a custom identity, it can affect the behavior of your application. For example, if you are using the class and you are ensuring that only authenticated users have access to your site, by using the `authorization` section and specifying ``, this sample will cause the `deny` element to be ignored, as the user will have a name, which is "default". Instead you would specify `` to ensure that only authenticated users can access your site. [!code-csharp[System.Web.Security.DefaultAuthenticationModule#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.DefaultAuthenticationModule/CS/global.asax#1)] [!code-vb[System.Web.Security.DefaultAuthenticationModule#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.DefaultAuthenticationModule/VB/global.asax#1)] diff --git a/xml/System.Web.Security/DefaultAuthenticationModule.xml b/xml/System.Web.Security/DefaultAuthenticationModule.xml index f47b5710c11..21da70702b4 100644 --- a/xml/System.Web.Security/DefaultAuthenticationModule.xml +++ b/xml/System.Web.Security/DefaultAuthenticationModule.xml @@ -111,7 +111,7 @@ You can use the property of the object in the **DefaultAuthentication_OnAuthenticate** event to set the property of the current instance to a custom object. If you do not specify a value for the property, the sets the property of the instance to a object that contains no user information. - The **DefaultAuthentication_OnAuthenticate** event is raised after the event and before the event. If you have an section that depends on the user name to deny or allow access to your application, modifying the property of the current instance can affect the behavior of your application. Be sure that the user name you set during the **DefaultAuthentication_OnAuthenticate** event is considered when you specify the [authorization](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/8d82143t(v%3dvs.100)) section in your configuration. + The **DefaultAuthentication_OnAuthenticate** event is raised after the event and before the event. If you have an `authorization` section that depends on the user name to deny or allow access to your application, modifying the property of the current instance can affect the behavior of your application. Be sure that the user name you set during the **DefaultAuthentication_OnAuthenticate** event is considered when you specify the [authorization](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/8d82143t(v%3dvs.100)) section in your configuration. > [!NOTE] > If the Web application is running in IIS 7.0 in Integrated mode, the event of the is not raised. If the `mode` attribute of the [authentication](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/532aee0e(v%3dvs.100)) configuration element is set to "None" and the application subscribes to the event, a error is raised. In this scenario, to receive authentication notification, subscribe to the event of the instance. For more information about compatibility issues in Integrated mode, see [Moving an ASP.NET Application from IIS 6.0 to IIS 7.0](https://msdn.microsoft.com/library/76f9cc78-f978-4837-b1c8-51d642ec4847). diff --git a/xml/System.Web.Security/RoleManagerEventArgs.xml b/xml/System.Web.Security/RoleManagerEventArgs.xml index a2958f3738b..62a9067ab1c 100644 --- a/xml/System.Web.Security/RoleManagerEventArgs.xml +++ b/xml/System.Web.Security/RoleManagerEventArgs.xml @@ -20,7 +20,7 @@ object provides event information to the event of the class. The object provides access to the of the current request, and a `Boolean` property is used to enable or cancel creation of a by the . + The object provides event information to the event of the class. The object provides access to the of the current request, and a `Boolean` property is used to enable or cancel creation of a by the . ]]> @@ -56,7 +56,7 @@ object provides event information to the event of the class. The object provides access to the of the current request, and a `Boolean` property is used to enable or cancel creation of a by the . + The object provides event information to the event of the class. The object provides access to the of the current request, and a `Boolean` property is used to enable or cancel creation of a by the . ]]> diff --git a/xml/System.Web.Security/SqlRoleProvider.xml b/xml/System.Web.Security/SqlRoleProvider.xml index 9447a72818b..50cc0c93a8f 100644 --- a/xml/System.Web.Security/SqlRoleProvider.xml +++ b/xml/System.Web.Security/SqlRoleProvider.xml @@ -33,7 +33,7 @@ ## Examples - The following example shows the Web.config file for an ASP.NET application configured to use a object and the . The element is configured to only allow access to authenticated users in the Administrators role. + The following example shows the Web.config file for an ASP.NET application configured to use a object and the . The `authorization` element is configured to only allow access to authenticated users in the Administrators role. ``` @@ -47,8 +47,8 @@ - - + + @@ -248,7 +248,7 @@ ## Examples - The following example shows the element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies the application's instance and sets the property to `MyApplication`. + The following example shows the `roleManager` element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies the application's instance and sets the property to `MyApplication`. ``` class to retrieve role information for Windows users. The element specifies that only users in the BUILTIN\Administrators group are allowed access to the application. + The following example shows the Web.config file for an ASP.NET application. It specifies that the application uses both Windows authentication and the class to retrieve role information for Windows users. The `authorization` element specifies that only users in the BUILTIN\Administrators group are allowed access to the application. ``` @@ -36,8 +36,8 @@ - - + + instance and sets the property to `MyApplication`. + The following example shows the `roleManager` element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies the application's instance and sets the property to `MyApplication`. ``` `abstract` class exposes an `abstract` method, , which allows a derived class to add metadata to any method that represents an operation in a binding. The method itself is not an input method. The code attributes, which are added to all Web methods in a binding class, represent extensions to the SOAP Web services protocol, for example, for adding extra headers to an outgoing SOAP message or doing extra processing on an incoming SOAP message. + The `abstract` class exposes an `abstract` method, , which allows a derived class to add metadata to any method that represents an operation in a binding. The method itself is not an input method. The code attributes, which are added to all Web methods in a binding class, represent extensions to the SOAP Web services protocol, for example, for adding extra headers to an outgoing SOAP message or doing extra processing on an incoming SOAP message. - You can use a class derived from to extend the generation of client proxy code or `abstract` server code. You can use such a derived class in conjunction with a class derived from the `abstract` class, which extends run-time processing of SOAP messages on the client or service. + You can use a class derived from to extend the generation of client proxy code or `abstract` server code. You can use such a derived class in conjunction with a class derived from the `abstract` class, which extends run-time processing of SOAP messages on the client or service. You can specify in a configuration file through the `soapExtensionImporterTypes` configuration element and its child `add` element. You can apply the configuration to: diff --git a/xml/System.Web.Services.Description/SoapExtensionReflector.xml b/xml/System.Web.Services.Description/SoapExtensionReflector.xml index 914baee2d09..251ea7ace20 100644 --- a/xml/System.Web.Services.Description/SoapExtensionReflector.xml +++ b/xml/System.Web.Services.Description/SoapExtensionReflector.xml @@ -100,7 +100,7 @@ `abstract` class, you do not need to implement a class that is derived from to invoke the method or to set the property. + If you implement a class that's derived from the `abstract` class, you do not need to implement a class that is derived from to invoke the method or to set the property. ]]> diff --git a/xml/System.Web.UI.Design/DesignerAutoFormat.xml b/xml/System.Web.UI.Design/DesignerAutoFormat.xml index 55bb51bb388..8779f09e364 100644 --- a/xml/System.Web.UI.Design/DesignerAutoFormat.xml +++ b/xml/System.Web.UI.Design/DesignerAutoFormat.xml @@ -254,7 +254,7 @@ Gets a object that is used by the object to render a design-time preview of the associated control. - An object that is used by the object to render a design-time preview of the associated control. + An object that's used by the object to render a design-time preview of the associated control. attribute of the directive, or you can disable view state on individual controls by setting their individual properties. + You can disable view-state management for the page by using the attribute of the `@ Page` directive, or you can disable view state on individual controls by setting their individual properties. ]]> diff --git a/xml/System.Web.UI.MobileControls/MobileControl.xml b/xml/System.Web.UI.MobileControls/MobileControl.xml index 74a8c2c63ee..b78ae96b6c6 100644 --- a/xml/System.Web.UI.MobileControls/MobileControl.xml +++ b/xml/System.Web.UI.MobileControls/MobileControl.xml @@ -2145,7 +2145,7 @@ public override void EnsureTemplatedUI() ## Examples - The following example demonstrates how to use the property by setting the `FirstForm` property based on the capabilities of the browser. This code sample is part of a larger example for the property. + The following example demonstrates how to use the property by setting the `FirstForm` property based on the capabilities of the browser. This code sample is part of a larger example for the property. diff --git a/xml/System.Web.UI.MobileControls/MobileControlsSection.xml b/xml/System.Web.UI.MobileControls/MobileControlsSection.xml index bf7020873dd..f6d6148f746 100644 --- a/xml/System.Web.UI.MobileControls/MobileControlsSection.xml +++ b/xml/System.Web.UI.MobileControls/MobileControlsSection.xml @@ -26,11 +26,11 @@ class provides programmatic access to the values in the section of a configuration file. + The class provides programmatic access to the values in the `mobileControls` section of a configuration file. ]]> - Configuration Files in the Mobile Controls + Configuration Files in the Mobile Controls diff --git a/xml/System.Web.UI.WebControls/AdRotator.xml b/xml/System.Web.UI.WebControls/AdRotator.xml index 56c07ac53ae..82da3b02b2f 100644 --- a/xml/System.Web.UI.WebControls/AdRotator.xml +++ b/xml/System.Web.UI.WebControls/AdRotator.xml @@ -59,10 +59,8 @@ ## Remarks In this topic: -- [Introduction](#Introduction) - -- [XML Advertisement File Format](#XMLAdvertisementFileFormat) - +- [Introduction](#Introduction) +- [XML Advertisement File Format](#XMLAdvertisementFileFormat) - [Declarative Syntax](#DeclarativeSyntax) @@ -73,9 +71,8 @@ To secure your advertisement file from unauthorized Internet access, do one or more of the following: -- Store it in the App_Data directory, which is configured to deny Internet access for files of any type. - -- Rename the file with an extension that is not .xml, and map the extension to the `HttpForbiddenHandler` in Web.config. For more information, see the section in your Machine.config file. +- Store it in the App_Data directory, which is configured to deny internet access for files of any type. +- Rename the file with an extension that is not .xml, and map the extension to the `HttpForbiddenHandler` in Web.config. For more information, see the `httpHandlers` section in your Machine.config file. As an alternative to an XML file as the source of data, it is possible to provide advertisement information through a callback event. This event can also be used in combination with the XML file to extend the behavior of the control, such as redirecting to another page. See the property for additional information on the file format. @@ -425,10 +422,7 @@ To secure your advertisement file from unauthorized Internet access, do one or more of the following: - Store it in the Data directory, which is configured in Machine.config to deny Internet access for files of any type. - -- Rename the file with an extension that is not .xml, and map the extension to `HttpForbiddenHandler` in Web.config. For more information, see the section in your Machine.config file. - - +- Rename the file with an extension that is not .xml, and map the extension to `HttpForbiddenHandler` in Web.config. For more information, see the `httpHandlers` section in your Machine.config file. ## Examples The following code example demonstrates how to use the property to specify the location of the XML file that contains advertisement information. diff --git a/xml/System.Web.UI.WebControls/Login.xml b/xml/System.Web.UI.WebControls/Login.xml index 961696514ee..98e3cc8e813 100644 --- a/xml/System.Web.UI.WebControls/Login.xml +++ b/xml/System.Web.UI.WebControls/Login.xml @@ -730,7 +730,7 @@ ## Remarks The property specifies the page that is displayed when a login attempt is successful. - The default behavior of the control is to return the user to the referring page, or to the page defined in the `defaultUrl` attribute of the element in the Web.config file. + The default behavior of the control is to return the user to the referring page, or to the page defined in the `defaultUrl` attribute of the `forms` element in the Web.config file. The property overrides the default behavior of the control, as well as the `defaultUrl` setting made in the configuration file. diff --git a/xml/System.Web.UI.WebControls/ObjectDataSourceView.xml b/xml/System.Web.UI.WebControls/ObjectDataSourceView.xml index 6016a3aba7e..ff2a380fc6c 100644 --- a/xml/System.Web.UI.WebControls/ObjectDataSourceView.xml +++ b/xml/System.Web.UI.WebControls/ObjectDataSourceView.xml @@ -28,7 +28,7 @@ The class implements the data functionality for the control, including the , , , and operations, sorting, filtering, and management of settings kept in view state. - A object is created for each instance of the class at run time. Calls to data operations of the instance of the class are handled by the instance of the object. Page developers do not access the instance of the class directly. Control developers can create custom data controls by extending the and classes. + A object is created for each instance of the class at run time. Calls to data operations of the instance of the class are handled by the instance of the object. Page developers do not access the instance of the class directly. Control developers can create custom data controls by extending the and classes. The class performs data operations by calling methods on business or data objects using reflection. At run time, the control creates an instance of the type that is identified by the property, and then calls the appropriate method for the data operation. The instantiated object is not cached in memory by the . The object is created and destroyed for every data method call. If the method is `static` (`Shared` in Visual Basic), an instance is not created but the data operation method is still called. @@ -1572,7 +1572,7 @@ event is raised before the instance of the business object is discarded. If the business object implements the interface, the method is called after The event is raised. + The event is raised before the instance of the business object is discarded. If the business object implements the interface, the method is called after The event is raised. Handle the event to call other methods on the object and set properties or to perform clean-up that is specific to the object before the object is destroyed. A reference to the object is accessed by the property, which is exposed by the object. diff --git a/xml/System.Web.UI.WebControls/Table.xml b/xml/System.Web.UI.WebControls/Table.xml index b83f80ea9c1..58c8f43a551 100644 --- a/xml/System.Web.UI.WebControls/Table.xml +++ b/xml/System.Web.UI.WebControls/Table.xml @@ -71,7 +71,7 @@ A table can be built at design time given some static content, but the power of a Web server control is often realized when the table is built programmatically with dynamic contents. > [!NOTE] -> If the `controlRenderingCompatibilityVersion` attribute of the element in the Web.config file is set to `3.5`, the control renders a `border` attribute that is set to "0" on the HTML `table` element. +> If the `controlRenderingCompatibilityVersion` attribute of the `pages` element in the Web.config file is set to `3.5`, the control renders a `border` attribute that is set to "0" on the HTML `table` element. It is important to remember that any programmatic addition or modification of table rows or cells will not persist across posts to the server. This is because table rows and cells are controls of their own, and not properties of the control. To persist any changes to the table, rows and cells must be reconstructed after each postback. In fact, if substantial modifications are expected, it is recommended that a , , or control be used instead of the control. As a result, the class is primarily used by control developers. diff --git a/xml/System.Web.UI.WebControls/WebControl.xml b/xml/System.Web.UI.WebControls/WebControl.xml index 92931d8496c..c062cee561f 100644 --- a/xml/System.Web.UI.WebControls/WebControl.xml +++ b/xml/System.Web.UI.WebControls/WebControl.xml @@ -1328,7 +1328,7 @@ void Application_Start(object sender, EventArgs e) property returns `true` when the instance has attribute name/value pairs. The attribute pairs can be set either in the property or in the view state. + The property returns `true` when the instance has attribute name/value pairs. ]]> diff --git a/xml/System.Web.UI/AsyncPostBackTrigger.xml b/xml/System.Web.UI/AsyncPostBackTrigger.xml index 56260d725d4..6c261514367 100644 --- a/xml/System.Web.UI/AsyncPostBackTrigger.xml +++ b/xml/System.Web.UI/AsyncPostBackTrigger.xml @@ -202,7 +202,7 @@ method to provide custom logic for determining whether the trigger was invoked. To see a custom trigger in the `Triggers` element of the control, you can add an directive to the page or to the element of the Web.config file. + Control developers can override the method to provide custom logic for determining whether the trigger was invoked. ]]> diff --git a/xml/System.Web.UI/ClientScriptManager.xml b/xml/System.Web.UI/ClientScriptManager.xml index ae1b2fa2886..71d59dabaac 100644 --- a/xml/System.Web.UI/ClientScriptManager.xml +++ b/xml/System.Web.UI/ClientScriptManager.xml @@ -352,7 +352,7 @@ method requires the control that handles the postback to implement the interface. To implement the interface for a , use the directive. + Using the method requires the control that handles the postback to implement the interface. To implement the interface for a , use the `@ Implements` directive. @@ -411,7 +411,7 @@ method requires the control that handles the postback to implement the interface. To implement the interface for a , use the directive. + Using the method requires the control that handles the postback to implement the interface. To implement the interface for a , use the `@ Implements` directive. ]]> @@ -461,7 +461,7 @@ interface for a , use the directive. + To implement the interface for a , use the `@ Implements` directive. The method can be used with the control when the property is `false`. In this scenario, the method returns the client postback event for the control. @@ -509,7 +509,7 @@ interface for a , use the directive. + To implement the interface for a , use the `@ Implements` directive. The method can be used with the control when the property is `false`. In this scenario, the method returns the client postback event for the control. @@ -564,7 +564,7 @@ interface for a object, use the directive. + To implement the interface for a object, use the `@ Implements` directive. The method can be used with the control when the property is `false`. In this scenario, the method returns the client postback event for the control. @@ -617,7 +617,7 @@ interface for a , use the directive. + To implement the interface for a , use the `@ Implements` directive. The method can be used with the control when the property is `false`. In this scenario, the method returns the client postback event for the control. diff --git a/xml/System.Web.UI/ControlCachePolicy.xml b/xml/System.Web.UI/ControlCachePolicy.xml index eb0b10fe395..d8f3ad075d9 100644 --- a/xml/System.Web.UI/ControlCachePolicy.xml +++ b/xml/System.Web.UI/ControlCachePolicy.xml @@ -24,7 +24,7 @@ Using the class is one of several ways you can enable output caching. The following list describes methods you can use to enable output caching: -- Use the directive to enable output caching in declarative scenarios. +- Use the `@ OutputCache` directive to enable output caching in declarative scenarios. - Use the attribute to enable caching for a user control in a code-behind file. @@ -336,7 +336,7 @@ instance, which signals that either an directive was parsed by the ASP.NET parser or the user control was decorated with a attribute. + A user control supports caching if it is associated with a instance, which signals that either an `@ OutputCache` directive was parsed by the ASP.NET parser or the user control was decorated with a attribute. ]]> diff --git a/xml/System.Web.UI/HtmlTextWriter.xml b/xml/System.Web.UI/HtmlTextWriter.xml index d8bd8bdbac6..39ac931f3e3 100644 --- a/xml/System.Web.UI/HtmlTextWriter.xml +++ b/xml/System.Web.UI/HtmlTextWriter.xml @@ -1146,7 +1146,7 @@ If the attribute type is `Style`, the value won't be encoded even if `fEndode` i ## Examples The following code example demonstrates how to use a custom class named `TextSample`, derived from the class, that uses the method to apply a style to a string of text. - The method renders the HTML``. The method call closes the `` element after the text has been rendered. + The method renders the HTML ``. The method call closes the `` element after the text has been rendered. :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.HtmlTextWriter_EnterStyle/VB/styledtext.vb" id="Snippet1"::: diff --git a/xml/System.Web.UI/Page.xml b/xml/System.Web.UI/Page.xml index 6845f9a640e..61d019b4528 100644 --- a/xml/System.Web.UI/Page.xml +++ b/xml/System.Web.UI/Page.xml @@ -2378,8 +2378,7 @@ ## Remarks This method is not intended to be used directly from your code. To enable and manipulate output caching for a page, use one of these approaches: -- Set options declaratively using the directive in the .aspx file. - +- Set options declaratively using the `@ OutputCache` directive in the .aspx file. - Use the methods and properties of the class, which is exposed by the `Response.Cache` object in the page's code. For more information, see [Caching ASP.NET Pages](https://docs.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)). @@ -2420,7 +2419,7 @@ class. The latter are accessible through `Response.Cache` syntax in the page's code declaration block or code-behind file. For more information, see [Caching ASP.NET Pages](https://docs.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)). + You should not call this method. To enable and manipulate output caching for a page, use either the `@ OutputCache` directive in the .aspx file, or the methods and properties of the class. The latter are accessible through `Response.Cache` syntax in the page's code declaration block or code-behind file. For more information, see [Caching ASP.NET Pages](https://docs.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)). ]]> @@ -2479,7 +2478,7 @@ class. The latter are accessible through `Response.Cache` syntax in the page's code. For more information, see [Caching ASP.NET Pages](https://docs.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)). + You should not call this method. To enable and manipulate output caching for a page, use either the `@ OutputCache` directive in the .aspx file, or the methods and properties of the class. The latter are accessible through `Response.Cache` syntax in the page's code. For more information, see [Caching ASP.NET Pages](https://docs.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)). ]]> @@ -2530,7 +2529,7 @@ class. The latter are accessible through `Response.Cache` syntax in the page's code. For more information, see [Caching ASP.NET Pages](https://docs.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)). + You should not call this method. To enable and manipulate output caching for a page, use either the `@ OutputCache` directive in the .aspx file, or methods and properties of the class. The latter are accessible through `Response.Cache` syntax in the page's code. For more information, see [Caching ASP.NET Pages](https://docs.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)). ]]> @@ -5524,7 +5523,7 @@ int year = Convert.ToInt32(Page.RouteData.Values["year"]) property specifies the name of a theme that is applied to a page early in the page life cycle, whereas the property specifies the name of a theme that is applied to a page later in the page life cycle. This means that settings on the page take precedence over settings in the style sheet theme. For more information, see [ASP.NET Themes and Skins](https://docs.microsoft.com/previous-versions/aspnet/ykzx33wh(v=vs.100)). diff --git a/xml/System.Web.UI/PartialCachingAttribute.xml b/xml/System.Web.UI/PartialCachingAttribute.xml index 01865a17c55..f5a51efb373 100644 --- a/xml/System.Web.UI/PartialCachingAttribute.xml +++ b/xml/System.Web.UI/PartialCachingAttribute.xml @@ -31,13 +31,13 @@ Using the is one of several ways you can enable output caching. The following list describes methods you can use to enable output caching. -- Use the directive to enable output caching in declarative scenarios. +- Use the `@ OutputCache` directive to enable output caching in declarative scenarios. - Use the to enable caching for a user control in a code-behind file. - Use the class to programmatically specify cache settings in programmatic scenarios in which you are working with instances. - If a user control contains an directive or has a applied, the ASP.NET parser generates an instance of the class to wrap the user control. + If a user control contains an `@ OutputCache` directive or has a applied, the ASP.NET parser generates an instance of the class to wrap the user control. For more information about ASP.NET caching, see [Caching](https://docs.microsoft.com/previous-versions/aspnet/xsbfdd8c(v=vs.100)). For more information about using attributes, see [Attributes](/dotnet/standard/attributes/). diff --git a/xml/System.Web.UI/PostBackTrigger.xml b/xml/System.Web.UI/PostBackTrigger.xml index 22ecb3c4990..51bc9842ee3 100644 --- a/xml/System.Web.UI/PostBackTrigger.xml +++ b/xml/System.Web.UI/PostBackTrigger.xml @@ -130,7 +130,7 @@ property to provide custom logic for determining whether the trigger was activated. To see your custom trigger appear at design time in the `` element of the control, you can add an directive on the page or in the section of the Web.config file. + Control developers can override the property to provide custom logic for determining whether the trigger was activated. ]]> diff --git a/xml/System.Web.UI/RoleServiceManager.xml b/xml/System.Web.UI/RoleServiceManager.xml index f417a5364e0..3dd1cc976ea 100644 --- a/xml/System.Web.UI/RoleServiceManager.xml +++ b/xml/System.Web.UI/RoleServiceManager.xml @@ -134,7 +134,7 @@ > [!NOTE] > When is `true`, all the roles that the current authenticated user belongs to are sent to the browser. Because users can potentially see the role information, this can be a security issue. - The property can be specified in the control or in an associated control. If is set to `true` for a proxy instance, the list of roles is retrieved and added to the page. If is `false`, the roles are not added to the page markup. In that case, you can use the method to store role information in memory in the browser. + The property can be specified in the control or in an associated control. If is set to `true` for a proxy instance, the list of roles is retrieved and added to the page. If is `false`, the roles are not added to the page markup. In that case, you can use the method to store role information in memory in the browser. ]]> diff --git a/xml/System.Web.UI/ScriptManager.xml b/xml/System.Web.UI/ScriptManager.xml index f7dcac03154..f846a80736b 100644 --- a/xml/System.Web.UI/ScriptManager.xml +++ b/xml/System.Web.UI/ScriptManager.xml @@ -2713,9 +2713,7 @@ The registered control does not implement the method can be called only during an asynchronous postback. To determine whether a postback is asynchronous, use the property. - The data items that are registered by using the method can be accessed in client script during the `pageLoading`, `pageLoaded`, and `endRequest` events of the `PageRequestManager` object. When you handle these events, the custom data is passed in an event argument object. For example, if you provide a handler for the `pageLoading` event, the custom data is passed in the `PageLoadingEventArgs` class, which exposes a property. - - + The data items that are registered by using the method can be accessed in client script during the `pageLoading`, `pageLoaded`, and `endRequest` events of the `PageRequestManager` object. When you handle these events, the custom data is passed in an event argument object. For example, if you provide a handler for the `pageLoading` event, the custom data is passed in the `PageLoadingEventArgs` class, which exposes a `dataItems` property. ## Examples The following example shows how to send data to two controls on a page during an asynchronous postback. The controls are not inside an control. This example shows the overload that does not take the `isJsonSerialized` parameter. Otherwise, the procedure for retrieving the `dataItems` property of the `PageLoadingEventArgs` object is the same as if you did not use that overload. diff --git a/xml/System.Web.UI/StaticPartialCachingControl.xml b/xml/System.Web.UI/StaticPartialCachingControl.xml index c9d19acf648..5a35ffdd547 100644 --- a/xml/System.Web.UI/StaticPartialCachingControl.xml +++ b/xml/System.Web.UI/StaticPartialCachingControl.xml @@ -21,7 +21,7 @@ class in the user control's code-behind file. When the user control is included declaratively in its containing page (as opposed to being dynamically loaded using the method in the control class), the instance is placed in the control hierarchy of the page as a parent to the cached user control. + An instance of this class is created when a user control is specified for output caching, using either an `@ OutputCache` directive in the declarative .ascx file, or the class in the user control's code-behind file. When the user control is included declaratively in its containing page (as opposed to being dynamically loaded using the method in the control class), the instance is placed in the control hierarchy of the page as a parent to the cached user control. ]]> diff --git a/xml/System.Web.UI/UpdateProgress.xml b/xml/System.Web.UI/UpdateProgress.xml index 393103ed27c..bc5ef97e5a4 100644 --- a/xml/System.Web.UI/UpdateProgress.xml +++ b/xml/System.Web.UI/UpdateProgress.xml @@ -113,7 +113,7 @@ :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_Atlas/System.Web.UI.UpdateProgress4/CS/default.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_Atlas/System.Web.UI.UpdateProgress4/VB/default.aspx" id="Snippet1"::: - You can use the example code by setting the `onClick` attribute of an `HtmlButton` control to "AbortPostBack()". For more information, see the method and the property of the class. + You can use the example code by setting the `onClick` attribute of an `HtmlButton` control to "AbortPostBack()". ## Putting UpdateProgress Controls on the Page @@ -121,9 +121,9 @@ ## Customizing When UpdateProgress Controls Are Displayed - By default, the control waits .5 seconds (500 milliseconds) before it displays its contents. This helps prevent the control from flashing if an asynchronous postback is very quick. You can specify the delay by setting the property. + By default, the control waits 0.5 seconds (500 milliseconds) before it displays its contents. This helps prevent the control from flashing if an asynchronous postback is very quick. You can specify the delay by setting the property. - If you need finer control over when an control is displayed, you can provide client script for the and events of the class. In the `beginRequest` event handler, you can display the DOM element that represents the control. In the `endRequest` event handler, you can hide it. + If you need finer control over when an control is displayed, you can provide client script for the `beginRequest` and `endRequest` events of the `PageRequestManager` class. In the `beginRequest` event handler, you can display the DOM element that represents the control. In the `endRequest` event handler, you can hide it. You must provide client script to display an control when a target control is updated in the following circumstances: diff --git a/xml/System.Web.UI/ViewStateEncryptionMode.xml b/xml/System.Web.UI/ViewStateEncryptionMode.xml index 5b9ad64d2a6..e9cb4cd6ccb 100644 --- a/xml/System.Web.UI/ViewStateEncryptionMode.xml +++ b/xml/System.Web.UI/ViewStateEncryptionMode.xml @@ -19,9 +19,7 @@ enumeration provides values for specifying whether the view-state information in a object is encrypted. The value can be set only in the [@ Page](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ydy4x04a(v=vs.100)) directive or in the section of the configuration file. - - + The enumeration provides values for specifying whether the view-state information in a object is encrypted. The value can be set only in the [@ Page](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ydy4x04a(v=vs.100)) directive or in the `pages` section of the configuration file. ## Examples The following code example demonstrates setting the view-state encryption mode for a object and requesting encryption of the view-state information through the method. In this example, the view-state information will be encrypted when customer information is retrieved from a database. diff --git a/xml/System.Web/HttpCacheVaryByContentEncodings.xml b/xml/System.Web/HttpCacheVaryByContentEncodings.xml index c0bd2a3778d..a5080a2daa1 100644 --- a/xml/System.Web/HttpCacheVaryByContentEncodings.xml +++ b/xml/System.Web/HttpCacheVaryByContentEncodings.xml @@ -34,12 +34,10 @@ For more information about the property, see RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1, available on the [World Wide Web Consortium (W3C) Web site](https://go.microsoft.com/fwlink/?linkid=37125). See section 14, "Header Field Definitions", for complete details. - You can set the property by using the directive or by adding a profile to the element in the Web.config file. - - + You can set the property by using the `@ OutputCache` directive or by adding a profile to the `outputCacheProfile` element in the Web.config file. ## Examples - The following example shows how to enable a dynamically compressed response that can be served from the output cache. The encoding that is acceptable is "gzip" and is set by using the `VaryByContentEncodings` attribute of the directive. If the Web server that hosts the page does not have dynamic compression enabled, the output cache will not have a cached response for the specified content encoding. + The following example shows how to enable a dynamically compressed response that can be served from the output cache. The encoding that is acceptable is "gzip" and is set by using the `VaryByContentEncodings` attribute of the `@ OutputCache` directive. If the Web server that hosts the page does not have dynamic compression enabled, the output cache will not have a cached response for the specified content encoding. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.HttpCachePolicy.VaryByContentEncodings/CS/default.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.HttpCachePolicy.VaryByContentEncodings/VB/default.aspx" id="Snippet1"::: diff --git a/xml/System.Web/HttpRequestValidationException.xml b/xml/System.Web/HttpRequestValidationException.xml index e481a630df1..4eea7323c08 100644 --- a/xml/System.Web/HttpRequestValidationException.xml +++ b/xml/System.Web/HttpRequestValidationException.xml @@ -30,13 +30,13 @@ ## Remarks Constraining and validating user input is essential in a Web application to prevent hacker attacks that rely on malicious input strings. Cross-site scripting attacks are one example of such hacks. Other types of malicious or undesired data can be passed in a request through various forms of input. By limiting the kinds of data that is passed at a low level in an application, you can prevent undesirable events, even when programmers who are using your code do not put the proper validation techniques in place. - Request validation detects potentially malicious client input and throws this exception to abort processing of the request. A request abort can indicate an attempt to compromise the security of your application, such as a cross-site scripting attack. It is strongly recommended that your application explicitly check all input regarding request aborts. However, you can disable request validation by setting the `validateRequest` attribute in the directive to `false`, as shown in the following example: + Request validation detects potentially malicious client input and throws this exception to abort processing of the request. A request abort can indicate an attempt to compromise the security of your application, such as a cross-site scripting attack. It is strongly recommended that your application explicitly check all input regarding request aborts. However, you can disable request validation by setting the `validateRequest` attribute in the `@ Page` directive to `false`, as shown in the following example: `<%@ Page validateRequest="false" %>` To disable request validation for your application, you must modify or create a Web.config file for your application and set the `validateRequest` attribute of the `pages` section to `false`, as shown in the following example: -``` +```xml diff --git a/xml/System.Web/SiteMapNodeCollection.xml b/xml/System.Web/SiteMapNodeCollection.xml index ebf022bbc7a..718d8673dd8 100644 --- a/xml/System.Web/SiteMapNodeCollection.xml +++ b/xml/System.Web/SiteMapNodeCollection.xml @@ -283,7 +283,7 @@ The to add to the . - Adds a single object to the collection. + Adds a single object to the collection. The index of the where the was inserted. collection that is passed to the method can contain `null` objects; however, this leads to unexpected exceptions when the is manipulated. + The collection that is passed to the method can contain `null` objects; however, this leads to unexpected exceptions when the is manipulated. You cannot add a object to a read-only or fixed-size . You can test whether a is read-only by checking the property. @@ -1054,13 +1054,13 @@ The zero-based index of the element to remove. - Removes the object at the specified index of the collection. + Removes the object at the specified index of the collection. collection is read-only by checking the property. - + To remove an element from the by specifying a object to remove, use the method. ]]> @@ -1098,7 +1098,7 @@ System.Object - Gets an object that can be used to synchronize access to the collection. + Gets an object that can be used to synchronize access to the collection. An object that can be used to synchronize access to the . property depends on the settings in the subsection of the `system.web` configuration section and the value of the `trace` attribute of the directive. The tracing option set in the page directive takes precedence over the option set in the configuration file. Setting the value programmatically takes precedence over both the page directive attribute and the configuration setting. + The value of the property depends on the settings in the `trace` subsection of the `system.web` configuration section and the value of the `trace` attribute of the `@ Page` directive. The tracing option set in the page directive takes precedence over the option set in the configuration file. Setting the value programmatically takes precedence over both the page directive attribute and the configuration setting. > [!NOTE] > If you set the property to `true` for an entire application, you must explicitly set this property to `false` for any page in the application for which you do not want tracing information displayed.