diff --git a/xml/System.Web.ApplicationServices/AuthenticatingEventArgs.xml b/xml/System.Web.ApplicationServices/AuthenticatingEventArgs.xml index 80d9a671ada..4ffc26293f5 100644 --- a/xml/System.Web.ApplicationServices/AuthenticatingEventArgs.xml +++ b/xml/System.Web.ApplicationServices/AuthenticatingEventArgs.xml @@ -24,14 +24,14 @@ The class raises the event before validating the user credentials. The class constructs an instance of the object and passes it to any event handler. - You can use the , and properties to retrieve the user credentials. The property can contain additional values that are required for authentication, such as an identification number. + You can use the , and properties to retrieve the user credentials. The property can contain additional values that are required for authentication, such as an identification number. The property indicates whether the user credentials are valid. You set the property to the result of your customized authentication. In addition, you set the property to `true` if you have checked the user credentials and do not want the class to check user credentials through the default membership provider. ## Examples - The following example shows an event handler that passes the and values to a custom membership provider to validate the user credentials. The event handler sets to the return value of the method and sets to `true` so that the class does not validate the credentials. + The following example shows an event handler that passes the and values to a custom membership provider to validate the user credentials. The event handler sets to the return value of the method and sets to `true` so that the class does not validate the credentials. [!code-csharp[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/cs/Global.asax#2)] [!code-vb[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/vb/Global.asax#2)] @@ -75,12 +75,12 @@ event, set the property to indicate whether the user credentials are valid. If the user credentials are valid and no additional validation is needed, set to `true` and to `true`. You set the property to indicate that the authentication service should bypass the default steps for authenticating a user. The value in is used by the class only if is set to `true`. If is `false`, the class calls the default membership provider to validate user credentials, and then overwrites the value in . + If you authenticate user credentials in an event handler for the event, set the property to indicate whether the user credentials are valid. If the user credentials are valid and no additional validation is needed, set to `true` and to `true`. You set the property to indicate that the authentication service should bypass the default steps for authenticating a user. The value in is used by the class only if is set to `true`. If is `false`, the class calls the default membership provider to validate user credentials, and then overwrites the value in . ## Examples - The following example shows an event handler that passes and values to a custom membership provider to validate the user credentials. The event handler sets to the return value of the method and sets to `true` so that the class does not validate the credentials. + The following example shows an event handler that passes and values to a custom membership provider to validate the user credentials. The event handler sets to the return value of the method and sets to `true` so that the class does not validate the credentials. [!code-csharp[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/cs/Global.asax#2)] [!code-vb[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/vb/Global.asax#2)] @@ -124,14 +124,14 @@ property to indicate whether the class must authenticate the user credentials. If is `true`, the class does not validate the user credentials through the default membership provider. Instead, it uses the value in to determine whether to create an authentication cookie. + You can set the property to indicate whether the class must authenticate the user credentials. If is `true`, the class does not validate the user credentials through the default membership provider. Instead, it uses the value in to determine whether to create an authentication cookie. - If is `false`, the class validates the user credentials through the default membership provider and overwrites the value in the property. + If is `false`, the class validates the user credentials through the default membership provider and overwrites the value in the property. ## Examples - The following example shows an event handler that passes and values to a custom membership provider to validate the user credentials. The event handler sets to the return value of the method and sets to `true` so that the class does not validate the credentials. + The following example shows an event handler that passes and values to a custom membership provider to validate the user credentials. The event handler sets to the return value of the method and sets to `true` so that the class does not validate the credentials. [!code-csharp[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/cs/Global.asax#2)] [!code-vb[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/vb/Global.asax#2)] @@ -170,9 +170,9 @@ property to retrieve authentication values other than user name and password during the event. For example, an application might be configured to validate an identification number together with the user name and password. In that case, the identification number will be passed in the `CustomCredential` parameter of the method. You can then retrieve the custom value through the property. + You can use the property to retrieve authentication values other than user name and password during the event. For example, an application might be configured to validate an identification number together with the user name and password. In that case, the identification number will be passed in the `CustomCredential` parameter of the method. You can then retrieve the custom value through the property. - The property contains the customized values in the same format as they are passed to the method. In the event handler, if more than one value is stored in the property, you must parse the value of the property to retrieve the values. + The property contains the customized values in the same format as they are passed to the method. In the event handler, if more than one value is stored in the property, you must parse the value of the property to retrieve the values. @@ -221,7 +221,7 @@ ## Examples - The following example shows an event handler that passes and values to a custom membership provider to validate the user credentials. The event handler sets to the return value of the method and sets to `true` so that the class does not validate the credentials. + The following example shows an event handler that passes and values to a custom membership provider to validate the user credentials. The event handler sets to the return value of the method and sets to `true` so that the class does not validate the credentials. [!code-csharp[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/cs/Global.asax#2)] [!code-vb[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/vb/Global.asax#2)] @@ -265,7 +265,7 @@ ## Examples - The following example shows an event handler that selects a membership provider to use based on the value of the property. The handler passes and values to the custom membership provider to validate the user credentials. It sets to the return value of the method and sets to `true` so that the class does not validate the credentials. + The following example shows an event handler that selects a membership provider to use based on the value of the property. The handler passes and values to the custom membership provider to validate the user credentials. It sets to the return value of the method and sets to `true` so that the class does not validate the credentials. [!code-csharp[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/cs/Global.asax#2)] [!code-vb[System.Web.Security.LoginService_NonDefaultProvider#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.LoginService_NonDefaultProvider/vb/Global.asax#2)] diff --git a/xml/System.Web.ApplicationServices/AuthenticationService.xml b/xml/System.Web.ApplicationServices/AuthenticationService.xml index 250ec8bde80..dd2db0e308d 100644 --- a/xml/System.Web.ApplicationServices/AuthenticationService.xml +++ b/xml/System.Web.ApplicationServices/AuthenticationService.xml @@ -36,13 +36,13 @@ ## Remarks The object enables you to authenticate users through a Windows Communication Foundation (WCF) service. You use the WCF authentication service when you must authenticate users through ASP.NET membership from an application that is outside the Web application that stores the user credentials. The application must be able to send and consume message in the SOAP format. Through the class, you can log users in, log users out, validate credentials, check authentication status, customize authentication, and set the authentication cookie. - The class contains four methods that you should access only through a WCF service: the , , , and methods. To call these methods, you enable the authentication service on a Web server and then connect a WCF-compatible client application to the Web service. For information about how to configure the authentication service, see [How to: Enable the WCF Authentication Service](https://learn.microsoft.com/previous-versions/aspnet/bb398990(v=vs.100)). + The class contains four methods that you should access only through a WCF service: the , , , and methods. To call these methods, you enable the authentication service on a Web server and then connect a WCF-compatible client application to the Web service. For information about how to configure the authentication service, see [How to: Enable the WCF Authentication Service](https://learn.microsoft.com/previous-versions/aspnet/bb398990(v=vs.100)). - To log users on, you pass the user credentials to the method. If the credentials are valid, the class creates an authentication cookie. If the authentication cookie has not expired, you know that the user's credentials have been authenticated and you do not have to validate the credentials again. (Cookie-less authentication is not available through the class.) + To log users on, you pass the user credentials to the method. If the credentials are valid, the class creates an authentication cookie. If the authentication cookie has not expired, you know that the user's credentials have been authenticated and you do not have to validate the credentials again. (Cookie-less authentication is not available through the class.) The can raise two events: and . The event occurs when the user credentials are being validated. Create an event handler for the event to customize how user credentials are validated. The event occurs when the authentication cookie is being set after user credentials have been validated. Create an event handler for the event to customize the authentication cookie. - The method checks user credentials for authentication, but it does not return an authentication ticket. Use when a user has previously logged in and you must check that the credentials are still valid at the start of a new application session. + The method checks user credentials for authentication, but it does not return an authentication ticket. Use when a user has previously logged in and you must check that the credentials are still valid at the start of a new application session. For an example of using the WCF authentication service from a console application, see [Walkthrough: Using ASP.NET Application Services](https://learn.microsoft.com/previous-versions/aspnet/bb515342(v=vs.100)). @@ -185,10 +185,10 @@ method checks whether the current user is authenticated by checking the .property. + The method checks whether the current user is authenticated by checking the .property. > [!NOTE] -> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. +> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. ]]> @@ -235,15 +235,15 @@ method validates user credentials through a membership provider. You can use the default membership provider or specify a custom membership provider at run time. The class passes `userName` and `password` to the membership provider's method, but does not pass `customCredential`. If returns `true`, creates an authentication ticket as a cookie. Set the `isPersistent` parameter to `true` to create an authentication ticket that lasts beyond the current session. + The method validates user credentials through a membership provider. You can use the default membership provider or specify a custom membership provider at run time. The class passes `userName` and `password` to the membership provider's method, but does not pass `customCredential`. If returns `true`, creates an authentication ticket as a cookie. Set the `isPersistent` parameter to `true` to create an authentication ticket that lasts beyond the current session. > [!NOTE] > Always use the authentication service together with the secure sockets layer (SSL, by using HTTPS) to protect sensitive data. - The method raises the event and the event. Create an event handler for to customize authentication, such as checking the values in `customCredential` or validating credentials through a non-default membership provider. The values in `customCredential` are not validated by the default membership provider. To customize the authentication cookie, create an event handler for . + The method raises the event and the event. Create an event handler for to customize authentication, such as checking the values in `customCredential` or validating credentials through a non-default membership provider. The values in `customCredential` are not validated by the default membership provider. To customize the authentication cookie, create an event handler for . > [!NOTE] -> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). +> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). ]]> @@ -281,12 +281,12 @@ method clears the authentication cookie from the browser's cookie collection. The user must log in again to be authenticated. + The method clears the authentication cookie from the browser's cookie collection. The user must log in again to be authenticated. The class does not store information on the server about which authentication tickets have been cleared. > [!NOTE] -> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). +> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). ]]> @@ -332,14 +332,14 @@ method authenticates the user credentials but does not set an authentication cookie. Without an authentication cookie, the user will not be logged in even if the credentials are valid. + The method authenticates the user credentials but does not set an authentication cookie. Without an authentication cookie, the user will not be logged in even if the credentials are valid. - Use the method when you must check whether a user's credentials are valid without receiving an authentication cookie. For example, you might do this if the authentication cookie is already stored in a client application but you want to verify that the user's credentials are still valid when a new session starts. + Use the method when you must check whether a user's credentials are valid without receiving an authentication cookie. For example, you might do this if the authentication cookie is already stored in a client application but you want to verify that the user's credentials are still valid when a new session starts. - The method raises the event, but does not raise the event. + The method raises the event, but does not raise the event. > [!NOTE] -> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). +> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). ]]> diff --git a/xml/System.Web.ApplicationServices/CreatingCookieEventArgs.xml b/xml/System.Web.ApplicationServices/CreatingCookieEventArgs.xml index 518aac58d2d..f40fe626c67 100644 --- a/xml/System.Web.ApplicationServices/CreatingCookieEventArgs.xml +++ b/xml/System.Web.ApplicationServices/CreatingCookieEventArgs.xml @@ -24,7 +24,7 @@ The class raises the event when it sets the authentication cookie, after the user credentials have been authenticated. The class constructs a object and passes it to any event handler. - You retrieve the user credentials through the , and properties. The property can contain any custom values that you need in order to authenticate, such as an identification number. The property indicates whether the authentication cookie should be retained past the current session. Set the property to `true` if you create the authentication cookie, so that the class does not create the cookie. + You retrieve the user credentials through the , and properties. The property can contain any custom values that you need in order to authenticate, such as an identification number. The property indicates whether the authentication cookie should be retained past the current session. Set the property to `true` if you create the authentication cookie, so that the class does not create the cookie. @@ -73,7 +73,7 @@ class checks the property to determine whether the authentication cookie has been created. You set this value to `true` if you create an authentication cookie in an event handler for the event. If is set to `false` (the default value), the class creates an authentication cookie, This overwrites any cookie that you have created in the handler for the event. + The class checks the property to determine whether the authentication cookie has been created. You set this value to `true` if you create an authentication cookie in an event handler for the event. If is set to `false` (the default value), the class creates an authentication cookie, This overwrites any cookie that you have created in the handler for the event. @@ -117,7 +117,7 @@ property to retrieve custom values in the authentication ticket. The property contains the value passed to the method. Typically, this property is used to pass custom values that must be validated with the user name and password, such as an identification number. If more than one value is stored in the property, you must parse the property in order to retrieve values. + You use the property to retrieve custom values in the authentication ticket. The property contains the value passed to the method. Typically, this property is used to pass custom values that must be validated with the user name and password, such as an identification number. If more than one value is stored in the property, you must parse the property in order to retrieve values. @@ -245,7 +245,7 @@ property to retrieve the authentication name when you set custom values in the authentication ticket. Typically, you set the property of the object to the value. + You use the property to retrieve the authentication name when you set custom values in the authentication ticket. Typically, you set the property of the object to the value. diff --git a/xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml b/xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml index 550cd1bc34d..b28ad63fda4 100644 --- a/xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml +++ b/xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml @@ -37,7 +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'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. + 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. ]]> diff --git a/xml/System.Web.ApplicationServices/ProfileService.xml b/xml/System.Web.ApplicationServices/ProfileService.xml index fa4a64ed4a2..987f754fc7c 100644 --- a/xml/System.Web.ApplicationServices/ProfileService.xml +++ b/xml/System.Web.ApplicationServices/ProfileService.xml @@ -42,13 +42,13 @@ The class contains the following methods that should be accessed only through a WCF service: -- +- -- +- -- +- -- +- To call these methods, you must enable the profile service on the Web server and then connect a WCF-compatible client application to the Web service. For information about how to configure the profile service, see [How to: Enable the WCF Profile Service](https://learn.microsoft.com/previous-versions/aspnet/bb514968(v=vs.100)). @@ -110,7 +110,7 @@ method to retrieve all the user's profile properties through one Web service call. For example, you can call this method and then store the profile properties in the client application and retrieve values as needed. The method returns values only for the profile properties that have been configured to be accessed through a Web service. You set whether a profile property can be accessed through a Web service by setting either the property or the property to `true`. + Use the method to retrieve all the user's profile properties through one Web service call. For example, you can call this method and then store the profile properties in the client application and retrieve values as needed. The method returns values only for the profile properties that have been configured to be accessed through a Web service. You set whether a profile property can be accessed through a Web service by setting either the property or the property to `true`. ]]> @@ -151,7 +151,7 @@ method to specify which profile properties are retrieved. The method returns values only for profile properties that are configured for access through a Web service. You configure a profile property for access through a Web service by setting the property or property to `true`. + To get specific profile property values for the current users, you use the method to specify which profile properties are retrieved. The method returns values only for profile properties that are configured for access through a Web service. You configure a profile property for access through a Web service by setting the property or property to `true`. ]]> @@ -188,7 +188,7 @@ method to retrieve information about profile properties from a client application that is compatible with the Windows Communication Framework (WCF). You can retrieve information such as the following: + Use the method to retrieve information about profile properties from a client application that is compatible with the Windows Communication Framework (WCF). You can retrieve information such as the following: - The name and type of the properties. @@ -198,7 +198,7 @@ - The default values for the properties. - After retrieving these values, a client application can take appropriate actions such as not trying to set a read-only property. The current user does not have to be authenticated in order to call the method, because the properties apply to all users. + After retrieving these values, a client application can take appropriate actions such as not trying to set a read-only property. The current user does not have to be authenticated in order to call the method, because the properties apply to all users. ]]> @@ -239,7 +239,7 @@ method to set a user's profile properties from an application that is compatible with the Windows Communication Foundation (WCF). The method returns any values that are not set, which might be for any one of the following reasons: + You use the method to set a user's profile properties from an application that is compatible with the Windows Communication Foundation (WCF). The method returns any values that are not set, which might be for any one of the following reasons: - The specified profile property is read only (the property for a specified profile property is not set to `true`). @@ -273,14 +273,14 @@ event to validate property values or to dynamically change their values. The event is raised when the method is called. If the value for a property fails validation, add that property to the collection of the class. Any properties that are in the collection will not be saved to the user profile. + You can create an event handler for the event to validate property values or to dynamically change their values. The event is raised when the method is called. If the value for a property fails validation, add that property to the collection of the class. Any properties that are in the collection will not be saved to the user profile. You can add and register the event handler in the Global.asax file. ## Examples - The following example shows an event handler for the event. When the value passed for `FirstName` property is empty or `null`, the `FirstName` property is added to the collection. + The following example shows an event handler for the event. When the value passed for `FirstName` property is empty or `null`, the `FirstName` property is added to the collection. [!code-csharp[System.Web.ApplicationServices.ProfileService#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.ApplicationServices.ProfileService/cs/Global.asax#1)] [!code-vb[System.Web.ApplicationServices.ProfileService#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.ApplicationServices.ProfileService/vb/Global.asax#1)] diff --git a/xml/System.Web.ApplicationServices/RoleService.xml b/xml/System.Web.ApplicationServices/RoleService.xml index 95e3eae92a9..762e1f7946b 100644 --- a/xml/System.Web.ApplicationServices/RoleService.xml +++ b/xml/System.Web.ApplicationServices/RoleService.xml @@ -31,19 +31,19 @@ Enables access to the ASP.NET role provider as a WCF Web service. - object enables you to read a user's roles through a Windows Communication Foundation (WCF) service. To use the role service, you must enable the role service on a Web server and then connect a WCF-compatible client application to the Web service. For information about how to configure the role service, see [How to: Enable the WCF Role Service](https://learn.microsoft.com/previous-versions/aspnet/bb398911(v=vs.100)). - - The user must be authenticated to read the user's roles. The role service works with any kind of ASP.NET authentication. For information about how to log users in through a WCF service, see [Windows Communication Foundation Authentication Service Overview](https://learn.microsoft.com/previous-versions/aspnet/bb386582(v=vs.100)). - - The class exposes two methods that should be accessed only through a WCF service: the method and the method. The method returns all the roles for the logged-in user. The method determines whether the user is in a specified role. - - The object raises the event. You create an event handler for the event to select which role provider to use at run time. - - For an example of how to use the WCF role service from a console application, see [Walkthrough: Using ASP.NET Application Services](https://learn.microsoft.com/previous-versions/aspnet/bb515342(v=vs.100)). - + object enables you to read a user's roles through a Windows Communication Foundation (WCF) service. To use the role service, you must enable the role service on a Web server and then connect a WCF-compatible client application to the Web service. For information about how to configure the role service, see [How to: Enable the WCF Role Service](https://learn.microsoft.com/previous-versions/aspnet/bb398911(v=vs.100)). + + The user must be authenticated to read the user's roles. The role service works with any kind of ASP.NET authentication. For information about how to log users in through a WCF service, see [Windows Communication Foundation Authentication Service Overview](https://learn.microsoft.com/previous-versions/aspnet/bb386582(v=vs.100)). + + The class exposes two methods that should be accessed only through a WCF service: the method and the method. The method returns all the roles for the logged-in user. The method determines whether the user is in a specified role. + + The object raises the event. You create an event handler for the event to select which role provider to use at run time. + + For an example of how to use the WCF role service from a console application, see [Walkthrough: Using ASP.NET Application Services](https://learn.microsoft.com/previous-versions/aspnet/bb515342(v=vs.100)). + ]]> Windows Communication Foundation Role Service Overview @@ -93,16 +93,16 @@ Returns all the roles for the logged-in user. An array of the names of the roles that the user belongs to. - method returns all the roles for the user. You use the method when you must check or retain all the user's roles to determine which resources are available to the user. You can use this method to avoid multiple calls to the method. - - Calling the method raises the event. - + method returns all the roles for the user. You use the method when you must check or retain all the user's roles to determine which resources are available to the user. You can use this method to avoid multiple calls to the method. + + Calling the method raises the event. + > [!NOTE] -> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information about how to read a user's roles in code that is executing on the Web server, see the method. - +> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information about how to read a user's roles in code that is executing on the Web server, see the method. + ]]> Role management is not enabled. @@ -140,14 +140,14 @@ if the user is in the specified role; otherwise, . - method checks whether the logged-in user belongs to the specified role. The method raises the event. - + method checks whether the logged-in user belongs to the specified role. The method raises the event. + > [!NOTE] -> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information about how to check whether a user belongs to the specified group from code executing on the Web server, see the method. - +> Do not call the method from code that is executing on the Web server. You call the method only as part of a WCF service. For more information about how to check whether a user belongs to the specified group from code executing on the Web server, see the method. + ]]> @@ -175,19 +175,19 @@ Occurs when a instance determines which role provider to use for checking the user's roles. - class raises the event when it determines which role provider to use in order to retrieve the user's roles. You can create an event handler for the event to select at run time which role provider to use. - - - -## Examples - The following example shows how to bind an event handler to the event in the Global.asax file. The event handler determines at run time which role provider to use, based on the user name. - + class raises the event when it determines which role provider to use in order to retrieve the user's roles. You can create an event handler for the event to select at run time which role provider to use. + + + +## Examples + The following example shows how to bind an event handler to the event in the Global.asax file. The event handler determines at run time which role provider to use, based on the user name. + [!code-csharp[System.Web.Security.SelectingProviderEventHandler#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SelectingProviderEventHandler/cs/Global.asax#1)] - [!code-vb[System.Web.Security.SelectingProviderEventHandler#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SelectingProviderEventHandler/vb/Global.asax#1)] - + [!code-vb[System.Web.Security.SelectingProviderEventHandler#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SelectingProviderEventHandler/vb/Global.asax#1)] + ]]> diff --git a/xml/System.Web.ApplicationServices/SelectingProviderEventArgs.xml b/xml/System.Web.ApplicationServices/SelectingProviderEventArgs.xml index 67c04246dc4..8564bdf4c2f 100644 --- a/xml/System.Web.ApplicationServices/SelectingProviderEventArgs.xml +++ b/xml/System.Web.ApplicationServices/SelectingProviderEventArgs.xml @@ -22,7 +22,7 @@ ## Remarks The class supplies values to the event handler. You create a event handler to select the role provider at run time. - The class raises the event when either the method or the method of the class is called. + The class raises the event when either the method or the method of the class is called. You use the property to retrieve information about the logged-in user. To retrieve role information through a non-default role provider, set the property to the name of the role provider that you want the object to use. diff --git a/xml/System.Web.ApplicationServices/ValidatingPropertiesEventArgs.xml b/xml/System.Web.ApplicationServices/ValidatingPropertiesEventArgs.xml index dea4d05eb0a..9661a8a99b1 100644 --- a/xml/System.Web.ApplicationServices/ValidatingPropertiesEventArgs.xml +++ b/xml/System.Web.ApplicationServices/ValidatingPropertiesEventArgs.xml @@ -20,12 +20,12 @@ event to customize how profile property values are validated. The event is raised when profile properties are set for a user. If any property values fail validation, add them to the collection in the property. The method returns the collection in the property so that you can determine which properties failed validation. + You create an event handler for the event to customize how profile property values are validated. The event is raised when profile properties are set for a user. If any property values fail validation, add them to the collection in the property. The method returns the collection in the property so that you can determine which properties failed validation. ## Examples - The following example shows an event handler for the event. When the value passed for `FirstName` property is empty or `null`, the `FirstName` property is added to the collection. + The following example shows an event handler for the event. When the value passed for `FirstName` property is empty or `null`, the `FirstName` property is added to the collection. [!code-csharp[System.Web.ApplicationServices.ProfileService#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.ApplicationServices.ProfileService/cs/Global.asax#1)] [!code-vb[System.Web.ApplicationServices.ProfileService#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.ApplicationServices.ProfileService/vb/Global.asax#1)] @@ -63,12 +63,12 @@ property contains a collection of the names of the properties that have failed validation. If you create an event handler for the event, you add the names of the properties that fail validation to the collection in the property. The method returns the collection in the property so that you can determine which properties failed validation. + The property contains a collection of the names of the properties that have failed validation. If you create an event handler for the event, you add the names of the properties that fail validation to the collection in the property. The method returns the collection in the property so that you can determine which properties failed validation. ## Examples - The following example shows an event handler for the event. When the value passed for `FirstName` property is empty or `null`, the `FirstName` property is added to the collection. + The following example shows an event handler for the event. When the value passed for `FirstName` property is empty or `null`, the `FirstName` property is added to the collection. [!code-csharp[System.Web.ApplicationServices.ProfileService#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.ApplicationServices.ProfileService/cs/Global.asax#1)] [!code-vb[System.Web.ApplicationServices.ProfileService#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.ApplicationServices.ProfileService/vb/Global.asax#1)] @@ -106,12 +106,12 @@ property returns an object that contains the names and values of the profile properties to set for the user. If you create an event handler for the event, you can retrieve the properties to validate from the property. If any values fail validation, add them to the property. The method returns the collection in the property so that you can determine which properties failed validation. + The property returns an object that contains the names and values of the profile properties to set for the user. If you create an event handler for the event, you can retrieve the properties to validate from the property. If any values fail validation, add them to the property. The method returns the collection in the property so that you can determine which properties failed validation. ## Examples - The following example shows an event handler for the event. When the value passed for `FirstName` property is empty or `null`, the `FirstName` property is added to the collection. + The following example shows an event handler for the event. When the value passed for `FirstName` property is empty or `null`, the `FirstName` property is added to the collection. [!code-csharp[System.Web.ApplicationServices.ProfileService#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.ApplicationServices.ProfileService/cs/Global.asax#1)] [!code-vb[System.Web.ApplicationServices.ProfileService#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.ApplicationServices.ProfileService/vb/Global.asax#1)] diff --git a/xml/System.Web.Caching/AggregateCacheDependency.xml b/xml/System.Web.Caching/AggregateCacheDependency.xml index c8d2e4b446d..22f56449fd7 100644 --- a/xml/System.Web.Caching/AggregateCacheDependency.xml +++ b/xml/System.Web.Caching/AggregateCacheDependency.xml @@ -17,20 +17,20 @@ Combines multiple dependencies between an item stored in an ASP.NET application's object and an array of objects. This class cannot be inherited. - class monitors a collection of dependency objects so that when any of them change, the cached item is automatically removed. The objects in the array can be objects, objects, custom objects derived from , or any combination of these. - - The class differs from the class in that it allows you to associate multiple dependencies of different types with a single cached item. For example, if you create a page that imports data from a SQL Server database table and an XML file, you can create a object to represent a dependency on the database table and a to represent the dependency on the XML file. Rather than making an method call for each dependency, you can create an instance of the class with each dependency added to it. You can then use a single call to make the page dependent on the instance. - - - -## Examples - The following code example uses the class to add a , named `XMLDataSet`, to the cache that is dependent on a text file and an XML file. - - [!code-vb[CachingSamples_AggregateCacheDependency1#1](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#1)] - + class monitors a collection of dependency objects so that when any of them change, the cached item is automatically removed. The objects in the array can be objects, objects, custom objects derived from , or any combination of these. + + The class differs from the class in that it allows you to associate multiple dependencies of different types with a single cached item. For example, if you create a page that imports data from a SQL Server database table and an XML file, you can create a object to represent a dependency on the database table and a to represent the dependency on the XML file. Rather than making an method call for each dependency, you can create an instance of the class with each dependency added to it. You can then use a single call to make the page dependent on the instance. + + + +## Examples + The following code example uses the class to add a , named `XMLDataSet`, to the cache that is dependent on a text file and an XML file. + + [!code-vb[CachingSamples_AggregateCacheDependency1#1](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#1)] + ]]> @@ -51,18 +51,18 @@ Initializes a new instance of the class. - class. - - - -## Examples - The following code example creates an instance of the class, using the constructor that takes no arguments. Two objects are created, then added to a array, `myDepArray`. This constructor is used in conjunction with the method to make the item stored in the dependent on both objects. - - [!code-vb[CachingSamples_AggregateCacheDependency1#3](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#3)] - + class. + + + +## Examples + The following code example creates an instance of the class, using the constructor that takes no arguments. Two objects are created, then added to a array, `myDepArray`. This constructor is used in conjunction with the method to make the item stored in the dependent on both objects. + + [!code-vb[CachingSamples_AggregateCacheDependency1#3](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#3)] + ]]> @@ -97,20 +97,20 @@ The array of objects to add. Adds an array of objects to the object. - method in conjunction with the constructor to create two objects, add them to a array named `myDepArray`, and then make the item in the cache dependent on those two objects. - - [!code-vb[CachingSamples_AggregateCacheDependency1#3](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#3)] - + method in conjunction with the constructor to create two objects, add them to a array named `myDepArray`, and then make the item in the cache dependent on those two objects. + + [!code-vb[CachingSamples_AggregateCacheDependency1#3](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#3)] + ]]> - is . - + is . + -or- - + A object in is . A object is referenced from more than one entry. @@ -180,18 +180,18 @@ Retrieves a unique identifier for the object. The unique identifier for the object. If one of the associated dependency objects does not have a unique identifier, the method returns . - method to create and display an identifier for an instance of the class, named `aggDep`, once it is created and populated. - - [!code-vb[CachingSamples_AggregateCacheDependency1#3](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#3)] - + method to create and display an identifier for an instance of the class, named `aggDep`, once it is created and populated. + + [!code-vb[CachingSamples_AggregateCacheDependency1#3](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#3)] + ]]> diff --git a/xml/System.Web.Caching/Cache.xml b/xml/System.Web.Caching/Cache.xml index 35505cf7c4c..b4731d02f78 100644 --- a/xml/System.Web.Caching/Cache.xml +++ b/xml/System.Web.Caching/Cache.xml @@ -33,7 +33,7 @@ ## Examples - The following example is a page that shows users the value assigned to an item in the cache, and then notifies them when the item is removed from the cache. It creates a `RemovedCallback` method, which has the signature of the `CacheItemRemovedCallback` delegate, to notify users when the cache item is removed, and it uses the enumeration to tell them why it was removed. In addition, it uses the property to add objects to the cache and retrieve the value of those objects. In the `AddItemToCache` method, it uses the method to add an item to the cache. To use the `CacheItemRemovedCallback` delegate, you must add an item to the cache with this method or the method, so that ASP.NET can automatically make the proper method calls when the item is removed. The custom `RemoveItemFromCache` method uses the method to explicitly delete the item from the cache, causing the `RemovedCallback` method to be invoked. + The following example is a page that shows users the value assigned to an item in the cache, and then notifies them when the item is removed from the cache. It creates a `RemovedCallback` method, which has the signature of the `CacheItemRemovedCallback` delegate, to notify users when the cache item is removed, and it uses the enumeration to tell them why it was removed. In addition, it uses the property to add objects to the cache and retrieve the value of those objects. In the `AddItemToCache` method, it uses the method to add an item to the cache. To use the `CacheItemRemovedCallback` delegate, you must add an item to the cache with this method or the method, so that ASP.NET can automatically make the proper method calls when the item is removed. The custom `RemoveItemFromCache` method uses the method to explicitly delete the item from the cache, causing the `RemovedCallback` method to be invoked. > [!NOTE] > The instance of Cache that is accessed by the snippet below is a member of the object that this sample inherits. @@ -115,7 +115,7 @@ method. + Calls to this method will fail silently if an item with the same `key` parameter is already stored in the `Cache`. To overwrite an existing `Cache` item using the same `key` parameter, use the method. You cannot set both the `absoluteExpiration` and `slidingExpiration` parameters. If you intend the cache item to expire at a specific time, you set the `absoluteExpiration` parameter to the specific time, and the `slidingExpiration` parameter to . @@ -208,7 +208,7 @@ The property can be set with the `percentagePhysicalMemoryUsedLimit` attribute of the [cache Element for caching (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ms228248(v=vs.100)) element in the application's configuration file. If the `percentagePhysicalMemoryUsedLimit` attribute is not set, the cache algorithm determines the maximum size of the cache, and the property is calculated. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -245,7 +245,7 @@ ## Examples - + ]]> @@ -466,7 +466,7 @@ ## Remarks This method will overwrite an existing `Cache` item with the same `key` parameter. - If the `slidingExpiration` parameter is set to , sliding expiration is disabled. If you set the `slidingExpiration` parameter to greater than , the `absoluteExpiration` parameter is set to plus the value contained in the `slidingExpiration` parameter. If the item is requested from the cache before the amount of time specified by the `absoluteExpiration` parameter, the item will be placed in the cache again, and `absoluteExpiration` will again be set to `DateTime.Now` plus the value contained in the `slidingExpiration` parameter. If the item is not requested from the cache before the date in the `absoluteExpiration` parameter, the item is removed from the cache. The item added to the cache using this overload of the insert method is inserted with a priority of . + If the `slidingExpiration` parameter is set to , sliding expiration is disabled. If you set the `slidingExpiration` parameter to greater than , the `absoluteExpiration` parameter is set to plus the value contained in the `slidingExpiration` parameter. If the item is requested from the cache before the amount of time specified by the `absoluteExpiration` parameter, the item will be placed in the cache again, and `absoluteExpiration` will again be set to `DateTime.Now` plus the value contained in the `slidingExpiration` parameter. If the item is not requested from the cache before the date in the `absoluteExpiration` parameter, the item is removed from the cache. The item added to the cache using this overload of the insert method is inserted with a priority of . @@ -530,7 +530,7 @@ method enables you to insert a new item in the cache and provide a delegate that is called before the item is removed from the cache. In the delegate, you can update the cached item and thereby prevent it from being removed from the cache. + The method enables you to insert a new item in the cache and provide a delegate that is called before the item is removed from the cache. In the delegate, you can update the cached item and thereby prevent it from being removed from the cache. This method will overwrite an existing `Cache` item with the same `key` parameter. @@ -656,12 +656,12 @@ property is equivalent to calling the method. + You can use this property to retrieve the value of a specified cache item, or to add an item and a key for it to the cache. Adding a cache item using the property is equivalent to calling the method. ## Examples - The following example uses the `Item` property to retrieve the value of a cached object associated with the `Key1` key. It then uses the method to write the value and introductory text and the B HTML element to a Web Forms page. + The following example uses the `Item` property to retrieve the value of a cached object associated with the `Key1` key. It then uses the method to write the value and introductory text and the B HTML element to a Web Forms page. [!code-csharp[System.Web.Caching Examples#5](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Caching Examples/CS/cachecs.aspx#5)] [!code-vb[System.Web.Caching Examples#5](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching Examples/VB/cachevb.aspx#5)] diff --git a/xml/System.Web.Caching/CacheDependency.xml b/xml/System.Web.Caching/CacheDependency.xml index 76708c0b426..f769f074c63 100644 --- a/xml/System.Web.Caching/CacheDependency.xml +++ b/xml/System.Web.Caching/CacheDependency.xml @@ -31,14 +31,14 @@ ## Remarks If you add an item to the cache that is dependent on another object, such as a file or array of files, the dependent item is automatically removed from the cache when the object changes. For example, suppose you create a object based on data in an XML file. You can add the to the cache with a object that makes the dependent on the XML file. If the XML file changes, the is removed from the cache. - You can add items with dependencies to your application's cache with the and methods. You cannot use the property to add items to the cache with dependencies. + You can add items with dependencies to your application's cache with the and methods. You cannot use the property to add items to the cache with dependencies. - To set up a dependency, you create an instance of the class, specifying the files, keys, or directories on which the item is dependent, and then pass the dependency to the or method. The instance can represent a single file or directory, an array of files or directories, or an array of files or directories along with an array of cache keys (these represent other items stored in the object). + To set up a dependency, you create an instance of the class, specifying the files, keys, or directories on which the item is dependent, and then pass the dependency to the or method. The instance can represent a single file or directory, an array of files or directories, or an array of files or directories along with an array of cache keys (these represent other items stored in the object). ## Examples - The following code example demonstrates using the property to determine whether a changed since the previous request for an item in the . The `dt` value passed in the `start` parameter is set to . + The following code example demonstrates using the property to determine whether a changed since the previous request for an item in the . The `dt` value passed in the `start` parameter is set to . [!code-csharp[System.Web.Caching.CacheDependency_HasChanged#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Caching.CacheDependency_HasChanged/CS/t.cs.aspx#1)] [!code-vb[System.Web.Caching.CacheDependency_HasChanged#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching.CacheDependency_HasChanged/VB/t.vb.aspx#1)] @@ -81,7 +81,7 @@ , implement this version of the constructor. + If you want to derive your own class from , implement this version of the constructor. @@ -128,7 +128,7 @@ ## Examples - The following code example creates an instance of the class with a dependency on an XML file. The method then adds an item to the that is dependent upon that file. + The following code example creates an instance of the class with a dependency on an XML file. The method then adds an item to the that is dependent upon that file. [!code-csharp[Classic CacheDependency.CacheDependency Example#1](~/snippets/csharp/VS_Snippets_WebNet/Classic CacheDependency.CacheDependency Example/CS/source.cs#1)] [!code-vb[Classic CacheDependency.CacheDependency Example#1](~/snippets/visualbasic/VS_Snippets_WebNet/Classic CacheDependency.CacheDependency Example/VB/source.vb#1)] @@ -180,7 +180,7 @@ ## Examples - The following code example demonstrates how to use the method to add an item to the with dependencies on an array of files. You can also make the item dependent on an array of directories. + The following code example demonstrates how to use the method to add an item to the with dependencies on an array of files. You can also make the item dependent on an array of directories. [!code-csharp[Multiple file based dependency#1](~/snippets/csharp/VS_Snippets_WebNet/Multiple file based dependency/CS/DependencyMultiFilecs.aspx#1)] [!code-vb[Multiple file based dependency#1](~/snippets/visualbasic/VS_Snippets_WebNet/Multiple file based dependency/VB/DependencyMultiFilevb.aspx#1)] @@ -227,7 +227,7 @@ ## Examples - The following code example uses this constructor to instantiate a object, then inserts an item into the with that dependency. The `dt` value passed in the `start` parameter is set to . + The following code example uses this constructor to instantiate a object, then inserts an item into the with that dependency. The `dt` value passed in the `start` parameter is set to . [!code-csharp[System.Web.Caching.CacheDependency_HasChanged#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Caching.CacheDependency_HasChanged/CS/t.cs.aspx#1)] [!code-vb[System.Web.Caching.CacheDependency_HasChanged#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching.CacheDependency_HasChanged/VB/t.vb.aspx#1)] @@ -275,7 +275,7 @@ ## Examples - The following code example creates a object that passes two XML files and a value when the object is included as a parameter argument in an method call. + The following code example creates a object that passes two XML files and a value when the object is included as a parameter argument in an method call. [!code-csharp[CacheDependency Constructor4#1](~/snippets/csharp/VS_Snippets_WebNet/CacheDependency Constructor4/CS/depmultifilestimecs.aspx#1)] [!code-vb[CacheDependency Constructor4#1](~/snippets/visualbasic/VS_Snippets_WebNet/CacheDependency Constructor4/VB/depmultifilestimevb.aspx#1)] @@ -370,7 +370,7 @@ ## Examples - The following code example creates a `CreateDependency` method. When this method is called, it creates a object and the property is used to add an item to the cache with a `key` parameter of `key1` and a value of `Value 1`. An array of strings, `dependencyKey`, is then created with the value of `key1` as well. This constructor then instantiates a object that passes `dependencyKey` and the object as parameter arguments. The method is called next, using the object as a parameter. This makes the object added to the cache using the method dependent on the `key1` key. + The following code example creates a `CreateDependency` method. When this method is called, it creates a object and the property is used to add an item to the cache with a `key` parameter of `key1` and a value of `Value 1`. An array of strings, `dependencyKey`, is then created with the value of `key1` as well. This constructor then instantiates a object that passes `dependencyKey` and the object as parameter arguments. The method is called next, using the object as a parameter. This makes the object added to the cache using the method dependent on the `key1` key. [!code-csharp[CacheDependency Constructor6#1](~/snippets/csharp/VS_Snippets_WebNet/CacheDependency Constructor6/CS/depkeytimecs.aspx#1)] [!code-vb[CacheDependency Constructor6#1](~/snippets/visualbasic/VS_Snippets_WebNet/CacheDependency Constructor6/VB/depkeytimevb.aspx#1)] @@ -417,7 +417,7 @@ However, the `cachekeys` dependency does not work the same way. If at least one value in the `cachekeys` parameter does not exist at the time of an insert, the insert fails. Note that there is no exception thrown for this scenario. ## Examples - The following code example creates a `CreateDependency` method. When this method is called, it uses the property to add an item to the cache with a `key` parameter of `key1` and a value of `Value 1`. An array of strings, `dependencyKey`, is then created with the value of `key1` as well. The constructor is used to create a object, `dep1`, which passes `dependencyKey` as a parameter argument. A second object, `dep2`, is created using this constructor, with `dep1` passed as the third parameter argument. This second dependency is dependent on the first. The method is called next, using the second object as a parameter. If the first dependency changes in any way, the cached item will be invalidated. + The following code example creates a `CreateDependency` method. When this method is called, it uses the property to add an item to the cache with a `key` parameter of `key1` and a value of `Value 1`. An array of strings, `dependencyKey`, is then created with the value of `key1` as well. The constructor is used to create a object, `dep1`, which passes `dependencyKey` as a parameter argument. A second object, `dep2`, is created using this constructor, with `dep1` passed as the third parameter argument. This second dependency is dependent on the first. The method is called next, using the second object as a parameter. If the first dependency changes in any way, the cached item will be invalidated. [!code-csharp[CacheDependency Constructor7#1](~/snippets/csharp/VS_Snippets_WebNet/CacheDependency Constructor7/CS/dependencycs.aspx#1)] [!code-vb[CacheDependency Constructor7#1](~/snippets/visualbasic/VS_Snippets_WebNet/CacheDependency Constructor7/VB/dependencyvb.aspx#1)] @@ -468,7 +468,7 @@ ## Examples - The following code example shows a `CreateDependency` method. When this method is called, it creates a object and the property is used to add an item to the cache with a key parameter of `key1` and a value of `Value 1`. An array of strings, `dependencyKey`, is then created with the value at its first (and only) index set to the value of `key1` as well. The constructor is then used to create a object, `dep1`, which passes `dependencyKey` as a parameter argument. A second object, `dep2`, is then created using this constructor, with `dep1` and the object passed as parameter arguments. This second dependency is dependent on the first, and dependency monitoring will begin 10 seconds after the `CreateDependency` method is called. The method is called next, using the second object as a parameter. If the first dependency changes in any way, the cached item will be invalidated. + The following code example shows a `CreateDependency` method. When this method is called, it creates a object and the property is used to add an item to the cache with a key parameter of `key1` and a value of `Value 1`. An array of strings, `dependencyKey`, is then created with the value at its first (and only) index set to the value of `key1` as well. The constructor is then used to create a object, `dep1`, which passes `dependencyKey` as a parameter argument. A second object, `dep2`, is then created using this constructor, with `dep1` and the object passed as parameter arguments. This second dependency is dependent on the first, and dependency monitoring will begin 10 seconds after the `CreateDependency` method is called. The method is called next, using the second object as a parameter. If the first dependency changes in any way, the cached item will be invalidated. [!code-csharp[CacheDependency Constructor8#1](~/snippets/csharp/VS_Snippets_WebNet/CacheDependency Constructor8/CS/dependencytimecs.aspx#1)] [!code-vb[CacheDependency Constructor8#1](~/snippets/visualbasic/VS_Snippets_WebNet/CacheDependency Constructor8/VB/dependencytimevb.aspx#1)] @@ -508,7 +508,7 @@ ## Examples - The following code example shows a class that inherits from the class and overrides the method. When this method is called, it sets a custom Boolean property named `Disposed` to `true`. + The following code example shows a class that inherits from the class and overrides the method. When this method is called, it sets a custom Boolean property named `Disposed` to `true`. [!code-vb[CacheDependency_Whidbey_Example1#1](~/snippets/visualbasic/VS_Snippets_WebNet/CacheDependency_Whidbey_Example1/VB/cachedependencysample.vb#1)] @@ -568,7 +568,7 @@ method completes the initialization of the object. This method is called by all constructors. + The method completes the initialization of the object. This method is called by all constructors. ]]> @@ -633,7 +633,7 @@ ## Examples - The following code example creates an object, named `aggDep`, with two objects in its array. Once `aggDep` is instantiated, the code calls the method to generate a unique identifier for both dependencies that `aggDep` contains and displays the identifiers to the containing page. An item is then added to the , using the method, with `aggDep` as a dependency. + The following code example creates an object, named `aggDep`, with two objects in its array. Once `aggDep` is instantiated, the code calls the method to generate a unique identifier for both dependencies that `aggDep` contains and displays the identifiers to the containing page. An item is then added to the , using the method, with `aggDep` as a dependency. [!code-vb[CachingSamples_AggregateCacheDependency1#3](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_AggregateCacheDependency1/VB/aggregatecachedependencysamplevb.aspx#3)] @@ -672,7 +672,7 @@ ## Examples - The following code example demonstrates using the property to determine whether a changed since the previous request for an item in the . The `dt` value passed in the `start` parameter is set to . + The following code example demonstrates using the property to determine whether a changed since the previous request for an item in the . The `dt` value passed in the `start` parameter is set to . [!code-csharp[System.Web.Caching.CacheDependency_HasChanged#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Caching.CacheDependency_HasChanged/CS/t.cs.aspx#1)] [!code-vb[System.Web.Caching.CacheDependency_HasChanged#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching.CacheDependency_HasChanged/VB/t.vb.aspx#1)] @@ -756,12 +756,12 @@ ## Remarks Any class that derives from the class must implement this method. - When you derive from the class, you use the base functionality of any method or property that you have not overridden. When you create an instance of the derived class, it represents the files, cache keys, database tables, or other arbitrary objects that you want to make a cached item dependent upon. When a dependency item changes, this method notifies the base functionality of the class that the item has changed, so that the values of the and properties can be updated. + When you derive from the class, you use the base functionality of any method or property that you have not overridden. When you create an instance of the derived class, it represents the files, cache keys, database tables, or other arbitrary objects that you want to make a cached item dependent upon. When a dependency item changes, this method notifies the base functionality of the class that the item has changed, so that the values of the and properties can be updated. ## Examples - The following code example shows a class that inherits from the class. It creates a public method, `ResetDependency`, that uses the method to change the time at which the dependency was modified, and then calls the method. + The following code example shows a class that inherits from the class. It creates a public method, `ResetDependency`, that uses the method to change the time at which the dependency was modified, and then calls the method. [!code-vb[CacheDependency_Whidbey_Example1#1](~/snippets/visualbasic/VS_Snippets_WebNet/CacheDependency_Whidbey_Example1/VB/cachedependencysample.vb#1)] @@ -822,7 +822,7 @@ class. It creates a public method, `ResetDependency`, that uses the method to change the time at which the dependency was modified, and then calls the method. + The following code example shows a class that inherits from the class. It creates a public method, `ResetDependency`, that uses the method to change the time at which the dependency was modified, and then calls the method. [!code-vb[CacheDependency_Whidbey_Example1#1](~/snippets/visualbasic/VS_Snippets_WebNet/CacheDependency_Whidbey_Example1/VB/cachedependencysample.vb#1)] diff --git a/xml/System.Web.Caching/CacheItemPriority.xml b/xml/System.Web.Caching/CacheItemPriority.xml index 596f933af8d..df3748b79bf 100644 --- a/xml/System.Web.Caching/CacheItemPriority.xml +++ b/xml/System.Web.Caching/CacheItemPriority.xml @@ -17,20 +17,20 @@ Specifies the relative priority of items stored in the object. - object selectively purges items to free system memory. When an item is added to the cache, you can assign it a relative priority compared to the other items stored in the cache. Items to which you assign higher priority values are less likely to be deleted from the cache when the server is processing a large number of requests, whereas items to which you assign lower priority values are more likely to be deleted. The default is `Normal`. - + object selectively purges items to free system memory. When an item is added to the cache, you can assign it a relative priority compared to the other items stored in the cache. Items to which you assign higher priority values are less likely to be deleted from the cache when the server is processing a large number of requests, whereas items to which you assign lower priority values are more likely to be deleted. The default is `Normal`. + > [!NOTE] > Items can always be removed from the cache programmatically, regardless of their cache priority. - -## Examples - The following example uses the method to add an item to the object with its `priority` parameter set to `High`: - + +## Examples + The following example uses the method to add an item to the object with its `priority` parameter set to `High`: + :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CacheItemPriority Syntax/CS/CacheItemPrioritycs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CacheItemPriority Syntax/VB/CacheItemPriorityvb.aspx" id="Snippet1"::: - + ]]> diff --git a/xml/System.Web.Caching/CacheItemRemovedCallback.xml b/xml/System.Web.Caching/CacheItemRemovedCallback.xml index df7868f0230..a171b5ec632 100644 --- a/xml/System.Web.Caching/CacheItemRemovedCallback.xml +++ b/xml/System.Web.Caching/CacheItemRemovedCallback.xml @@ -31,7 +31,7 @@ delegate, to notify users when the cache item is removed and uses the enumeration to tell them why it was removed. In addition, it uses the property to add objects to the cache and retrieve the value of those objects. In the `AddItemToCache` method, it uses the method to add an item to the cache. To use the delegate, you must add an item to the cache with this method or the method so that ASP.NET can automatically make the proper method calls when the item is removed. The custom `RemoveItemFromCache` method uses the method to explicitly delete the item from the cache, causing the `RemovedCallback` method to be invoked. + The following code example demonstrates a page that shows users the value assigned to an item in the cache and then notifies them when the item is removed from the cache. It creates a `RemovedCallback` method, which uses the signature of the delegate, to notify users when the cache item is removed and uses the enumeration to tell them why it was removed. In addition, it uses the property to add objects to the cache and retrieve the value of those objects. In the `AddItemToCache` method, it uses the method to add an item to the cache. To use the delegate, you must add an item to the cache with this method or the method so that ASP.NET can automatically make the proper method calls when the item is removed. The custom `RemoveItemFromCache` method uses the method to explicitly delete the item from the cache, causing the `RemovedCallback` method to be invoked. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Caching Examples/CS/cachecs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching Examples/VB/cachevb.aspx" id="Snippet1"::: diff --git a/xml/System.Web.Caching/CacheItemRemovedReason.xml b/xml/System.Web.Caching/CacheItemRemovedReason.xml index 5e0283f9b25..494c1afb304 100644 --- a/xml/System.Web.Caching/CacheItemRemovedReason.xml +++ b/xml/System.Web.Caching/CacheItemRemovedReason.xml @@ -17,19 +17,19 @@ Specifies the reason an item was removed from the . - delegate to notify your ASP.NET applications when and why an object was removed from the . - - - -## Examples - The following code example demonstrates a shared Boolean property, `itemRemoved`, a shared enumeration object, `reason`, and a delegate, `onRemove`. The latter can be included in an or method call. It also defines a method, `RemovedCallback`, with a signature that matches the delegate. When the `RemovedCallback` method is called, it changes the `itemRemoved` property value to `true` and assigns the `reason` property value to the reason provided by the enumeration. - + delegate to notify your ASP.NET applications when and why an object was removed from the . + + + +## Examples + The following code example demonstrates a shared Boolean property, `itemRemoved`, a shared enumeration object, `reason`, and a delegate, `onRemove`. The latter can be included in an or method call. It also defines a method, `RemovedCallback`, with a signature that matches the delegate. When the `RemovedCallback` method is called, it changes the `itemRemoved` property value to `true` and assigns the `reason` property value to the reason provided by the enumeration. + [!code-csharp[System.Web.Caching Examples#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Caching Examples/CS/cachecs.aspx#2)] - [!code-vb[System.Web.Caching Examples#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching Examples/VB/cachevb.aspx#2)] - + [!code-vb[System.Web.Caching Examples#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching Examples/VB/cachevb.aspx#2)] + ]]> diff --git a/xml/System.Web.Caching/CacheItemUpdateCallback.xml b/xml/System.Web.Caching/CacheItemUpdateCallback.xml index cf588ca736f..672171bd91e 100644 --- a/xml/System.Web.Caching/CacheItemUpdateCallback.xml +++ b/xml/System.Web.Caching/CacheItemUpdateCallback.xml @@ -33,17 +33,17 @@ When this method returns, contains the interval between the time that the object was last accessed and the time at which the object expired. Defines a callback method for notifying applications before a cached item is removed from the cache. - method with the key for the cache item and the reason you might want to update the item. The remaining parameters of this method are out parameters. You supply the new cached item and optional expiration and dependency values to use when refreshing the cached item. - - The update callback is not called if the cached item is explicitly removed by using a call to . - - If you want the cached item to be removed from the cache, you must return `null` in the `expensiveObject` parameter. Otherwise, you return a reference to the new cached data by using the `expensiveObject` parameter. If you do not specify expiration or dependency values, the item will be removed from the cache only when memory is needed. - - If the callback method throws an exception, ASP.NET suppresses the exception and removes the cached value. - + method with the key for the cache item and the reason you might want to update the item. The remaining parameters of this method are out parameters. You supply the new cached item and optional expiration and dependency values to use when refreshing the cached item. + + The update callback is not called if the cached item is explicitly removed by using a call to . + + If you want the cached item to be removed from the cache, you must return `null` in the `expensiveObject` parameter. Otherwise, you return a reference to the new cached data by using the `expensiveObject` parameter. If you do not specify expiration or dependency values, the item will be removed from the cache only when memory is needed. + + If the callback method throws an exception, ASP.NET suppresses the exception and removes the cached value. + ]]> diff --git a/xml/System.Web.Caching/DatabaseNotEnabledForNotificationException.xml b/xml/System.Web.Caching/DatabaseNotEnabledForNotificationException.xml index 25233c7c157..e0c3f19623b 100644 --- a/xml/System.Web.Caching/DatabaseNotEnabledForNotificationException.xml +++ b/xml/System.Web.Caching/DatabaseNotEnabledForNotificationException.xml @@ -23,16 +23,16 @@ The exception that is thrown when a SQL Server database is not enabled to support dependencies associated with the class. This class cannot be inherited. - class overview topic. - + class overview topic. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Caching.SqlCacheDependencyAdmin/CS/cacheDependencyAdmincs.aspx.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching.SqlCacheDependencyAdmin/VB/cacheDependencyAdminvb.aspx.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Caching.SqlCacheDependencyAdmin/VB/cacheDependencyAdminvb.aspx.vb" id="Snippet8"::: + ]]> @@ -68,11 +68,11 @@ Initializes a new instance of the class. - creates a new instance of the class with all fields set to their default values. - + creates a new instance of the class with all fields set to their default values. + ]]> diff --git a/xml/System.Web.Caching/HeaderElement.xml b/xml/System.Web.Caching/HeaderElement.xml index f2ea2b256ee..f522fce77ed 100644 --- a/xml/System.Web.Caching/HeaderElement.xml +++ b/xml/System.Web.Caching/HeaderElement.xml @@ -22,11 +22,11 @@ Represents a single HTTP header that is included in a response from the output cache. - class represents the content of an HTTP header in the output cache as a name/value pair. Both the name and the value must be non-null. The collection of all instances for an entry in the output cache is contained in the collection. - + class represents the content of an HTTP header in the output cache as a name/value pair. Both the name and the value must be non-null. The collection of all instances for an entry in the output cache is contained in the collection. + ]]> @@ -52,11 +52,11 @@ The value of the HTTP header. Initializes a new instance of the class. - class, the value of `name` must always be a non-null, non-empty string. The `value` parameter can be an empty string. - + class, the value of `name` must always be a non-null, non-empty string. The `value` parameter can be an empty string. + ]]> @@ -88,11 +88,11 @@ Gets the name of an HTTP header that is in the output cache. The name of the HTTP header. - class, the value of `name` must always be a non-null, non-empty string. - + class, the value of `name` must always be a non-null, non-empty string. + ]]> @@ -122,11 +122,11 @@ Gets the value of an HTTP header that is in the output cache. The value of the HTTP header. - class, the `value` parameter can be an empty string. - + class, the `value` parameter can be an empty string. + ]]> diff --git a/xml/System.Web.Caching/MemoryResponseElement.xml b/xml/System.Web.Caching/MemoryResponseElement.xml index 64b572f51e2..3692fec9571 100644 --- a/xml/System.Web.Caching/MemoryResponseElement.xml +++ b/xml/System.Web.Caching/MemoryResponseElement.xml @@ -127,7 +127,7 @@ object that is created by ASP.NET is a fixed-size memory buffer that is created from a pool of memory buffers. As a result, the contents of a object often do not completely fill the array. Typically only a part of the array will contain response data. Therefore, providers that serialize the array directly (instead of serializing the complete type that is being stored in the output cache) must use the property to determine how much of the array must be stored. + A object that is created by ASP.NET is a fixed-size memory buffer that is created from a pool of memory buffers. As a result, the contents of a object often do not completely fill the array. Typically only a part of the array will contain response data. Therefore, providers that serialize the array directly (instead of serializing the complete type that is being stored in the output cache) must use the property to determine how much of the array must be stored. ]]> diff --git a/xml/System.Web.Caching/OutputCacheProvider.xml b/xml/System.Web.Caching/OutputCacheProvider.xml index f57fd548fd4..ee6bcb87466 100644 --- a/xml/System.Web.Caching/OutputCacheProvider.xml +++ b/xml/System.Web.Caching/OutputCacheProvider.xml @@ -16,22 +16,22 @@ Serves as a base class that contains abstract methods for implementing an output-cache provider. - class. - + class. + ]]> - When you inherit from , you must override the following members: - -- - -- - -- - + When you inherit from , you must override the following members: + +- + +- + +- + - @@ -86,11 +86,11 @@ Inserts the specified entry into the output cache. A reference to the specified provider. - method parameters. The method stores the data if it is not already in the cache. If the data is in the cache, the method returns it. - + method parameters. The method stores the data if it is not already in the cache. If the data is in the cache, the method returns it. + ]]> @@ -170,11 +170,11 @@ The time and date on which the cached expires. Inserts the specified entry into the output cache, overwriting the entry if it is already cached. - diff --git a/xml/System.Web.Caching/OutputCacheProviderCollection.xml b/xml/System.Web.Caching/OutputCacheProviderCollection.xml index 1d595a0607b..d0b062affe7 100644 --- a/xml/System.Web.Caching/OutputCacheProviderCollection.xml +++ b/xml/System.Web.Caching/OutputCacheProviderCollection.xml @@ -16,11 +16,11 @@ Represents the collection of output-cache providers that are configured for a Web site. - @@ -46,11 +46,11 @@ Initializes a new instance of the class. - constructor initializes the hash-table object that is used by the output cache provider to store the items. - + constructor initializes the hash-table object that is used by the output cache provider to store the items. + ]]> @@ -77,13 +77,13 @@ An output cache provider. Inserts a provider into the collection of output-cache providers. - method adds only providers that are specified in the configuration for a Web site. Therefore, it does not add the ASP.NET default provider for the in-memory output cache. - - This collection is read-only. It is populated one time based on the providers that are specified in configuration. After the collection is populated, you cannot modify the set of available providers. - + method adds only providers that are specified in the configuration for a Web site. Therefore, it does not add the ASP.NET default provider for the in-memory output cache. + + This collection is read-only. It is populated one time based on the providers that are specified in configuration. After the collection is populated, you cannot modify the set of available providers. + ]]> @@ -116,11 +116,11 @@ The point in the array where the copying starts. Copies the output-cache providers to a compatible one-dimensional array at the specified index. - diff --git a/xml/System.Web.Caching/SqlCacheDependency.xml b/xml/System.Web.Caching/SqlCacheDependency.xml index af31f17fc49..b5ab5ff28b0 100644 --- a/xml/System.Web.Caching/SqlCacheDependency.xml +++ b/xml/System.Web.Caching/SqlCacheDependency.xml @@ -165,7 +165,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 `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. + 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.Caching/SqlCacheDependencyAdmin.xml b/xml/System.Web.Caching/SqlCacheDependencyAdmin.xml index 683a5ab74af..e1b4b412f19 100644 --- a/xml/System.Web.Caching/SqlCacheDependencyAdmin.xml +++ b/xml/System.Web.Caching/SqlCacheDependencyAdmin.xml @@ -20,7 +20,7 @@ object change notifications. In addition, this class obtains information about which tables in a database are enabled for change notifications using the method. However, you can also use the Aspnet_regsql command-line tool to manage change notifications for a SQL Server database and its tables. + You can use the methods of this class to programmatically enable and disable a SQL Server database and its tables for object change notifications. In addition, this class obtains information about which tables in a database are enabled for change notifications using the method. However, you can also use the Aspnet_regsql command-line tool to manage change notifications for a SQL Server database and its tables. > [!NOTE] > To call any of the methods in this class, the account you use to access the SQL Server database must have permissions to create tables and stored procedures. To enable notifications on a specific table, you must have permissions to create a SQL Server trigger on that table. For more information on how to set permissions on a database, see the SQL Server documentation. For more information about the account used by the ASP.NET process, see [ASP.NET Impersonation](https://learn.microsoft.com/previous-versions/aspnet/xh507fc5(v=vs.100)). @@ -81,12 +81,12 @@ method removes support for change notifications from the database specified in the `connectionString` parameter. Once you have run the method, you must run the method if you wish to re-enable change notifications for a database. + The method removes support for change notifications from the database specified in the `connectionString` parameter. Once you have run the method, you must run the method if you wish to re-enable change notifications for a database. ## Examples - The following code example uses the method to disable change notifications for the database specified by the connection string `MyConnectionString`. + The following code example uses the method to disable change notifications for the database specified by the connection string `MyConnectionString`. For the full code required to run the example, see the Example section of the class overview topic. @@ -148,9 +148,9 @@ method disables change notifications for the table specified in the `table` parameter, which must be in the database specified in the `connectionString` parameter. + The method disables change notifications for the table specified in the `table` parameter, which must be in the database specified in the `connectionString` parameter. - Once you have used the method to disable change notifications for a table, you must use one of the overloads if you wish to re-enable change notifications. + Once you have used the method to disable change notifications for a table, you must use one of the overloads if you wish to re-enable change notifications. @@ -208,9 +208,9 @@ method removes change notifications from the tables specified in the `tables` parameter. These tables must be in the database specified in the `connectionString` parameter. + The method removes change notifications from the tables specified in the `tables` parameter. These tables must be in the database specified in the `connectionString` parameter. - Once you have used the method to disable change notifications for a list of tables, you must use one of the overloads if you wish to re-enable change notifications. + Once you have used the method to disable change notifications for a list of tables, you must use one of the overloads if you wish to re-enable change notifications. ]]> @@ -265,12 +265,12 @@ method adds support for change notifications from the database specified in the `connectionString` parameter. Once you have run the method, you must run the method if you wish to disable change notifications for a database. + The method adds support for change notifications from the database specified in the `connectionString` parameter. Once you have run the method, you must run the method if you wish to disable change notifications for a database. ## Examples - The following code example uses the method to enable change notifications for the database specified by the connection string `MyConnectionString`. + The following code example uses the method to enable change notifications for the database specified by the connection string `MyConnectionString`. For the full code required to run the example, see the Example section of the class overview topic. @@ -333,14 +333,14 @@ method adds change notifications for the table specified in the `table` parameter, which must be in the database specified in the `connectionString` parameter. + The method adds change notifications for the table specified in the `table` parameter, which must be in the database specified in the `connectionString` parameter. - Once you have used the method to add change notifications to a table, you must use one of the overloads if you wish to disable change notifications. + Once you have used the method to add change notifications to a table, you must use one of the overloads if you wish to disable change notifications. ## Examples - The following code example uses the method to enable change notifications on the specified table in the database specified in the connection string `MyConnectionString`. + The following code example uses the method to enable change notifications on the specified table in the database specified in the connection string `MyConnectionString`. For the full code required to run the example, see the Example section of the class overview topic. @@ -391,14 +391,14 @@ method adds change notifications for the tables specified in the `tables` parameter. These tables must be in the database specified in the `connectionString` parameter. + The method adds change notifications for the tables specified in the `tables` parameter. These tables must be in the database specified in the `connectionString` parameter. - Once you have used the method to add change notifications to a group of tables, you must use one of the overloads if you wish to disable change notifications. + Once you have used the method to add change notifications to a group of tables, you must use one of the overloads if you wish to disable change notifications. ## Examples - The following code example uses the method to enable change notifications on the tables specified in a semicolon-delimited list in the database specified in the connection string `MyConnectionString`. + The following code example uses the method to enable change notifications on the tables specified in a semicolon-delimited list in the database specified in the connection string `MyConnectionString`. For the full code required to run the example, see the Example section of the class overview topic. @@ -459,7 +459,7 @@ method returns a string array containing the names of all tables in the database specified in the `connectionString` parameter that are enabled for change notifications. + The method returns a string array containing the names of all tables in the database specified in the `connectionString` parameter that are enabled for change notifications. diff --git a/xml/System.Web.Caching/TableNotEnabledForNotificationException.xml b/xml/System.Web.Caching/TableNotEnabledForNotificationException.xml index 73ef904c07d..c0237059638 100644 --- a/xml/System.Web.Caching/TableNotEnabledForNotificationException.xml +++ b/xml/System.Web.Caching/TableNotEnabledForNotificationException.xml @@ -23,14 +23,14 @@ The exception that is thrown when a class is used against a database table that is not enabled for change notifications. - object and add an item to the with a dependency on the object. If the SQL Server database table is not enabled for dependency notifications, the is thrown and handled by calling the method. - + object and add an item to the with a dependency on the object. If the SQL Server database table is not enabled for dependency notifications, the is thrown and handled by calling the method. + [!code-csharp[CachingSamples_SqlCacheDependency#2](~/snippets/csharp/VS_Snippets_WebNet/CachingSamples_SqlCacheDependency/CS/sqlcachedepsamplecs.aspx#2)] - [!code-vb[CachingSamples_SqlCacheDependency#2](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_SqlCacheDependency/VB/sqlcachedepsamplevb.aspx#2)] - + [!code-vb[CachingSamples_SqlCacheDependency#2](~/snippets/visualbasic/VS_Snippets_WebNet/CachingSamples_SqlCacheDependency/VB/sqlcachedepsamplevb.aspx#2)] + ]]> diff --git a/xml/System.Web.ClientServices.Providers/ClientFormsAuthenticationCredentials.xml b/xml/System.Web.ClientServices.Providers/ClientFormsAuthenticationCredentials.xml index 2b4e2dfbc08..7e3513f12ee 100644 --- a/xml/System.Web.ClientServices.Providers/ClientFormsAuthenticationCredentials.xml +++ b/xml/System.Web.ClientServices.Providers/ClientFormsAuthenticationCredentials.xml @@ -17,19 +17,19 @@ Represents user login information for forms authentication by using client application services. - class is used by the interface. When you implement this interface, you must return a populated instance of this class in your implementation. - - - -## Examples - The following example code demonstrates how to implement the method, which returns an instance of this class. In this example, the method is part of a login dialog box class. The method displays the dialog box, and then returns a instance initialized with the user-specified values. - + class is used by the interface. When you implement this interface, you must return a populated instance of this class in your implementation. + + + +## Examples + The following example code demonstrates how to implement the method, which returns an instance of this class. In this example, the method is part of a login dialog box class. The method displays the dialog box, and then returns a instance initialized with the user-specified values. + :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.cs" id="Snippet210"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.vb" id="Snippet210"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.vb" id="Snippet210"::: + ]]> @@ -67,19 +67,19 @@ A value indicating whether the user credentials should be saved and reused for subsequent login attempts. Initializes a new instance of the class. - method, which returns an instance of this class. In this example, the method is part of a login dialog box class. The method displays the dialog box, and then returns a instance initialized with the user-specified values. - + method, which returns an instance of this class. In this example, the method is part of a login dialog box class. The method displays the dialog box, and then returns a instance initialized with the user-specified values. + :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.cs" id="Snippet210"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.vb" id="Snippet210"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.vb" id="Snippet210"::: + ]]> @@ -119,11 +119,11 @@ Gets or sets the user password. The user password. - class uses this property to retrieve the user password during authentication. You will not typically use this property in your application code. Instead, you will use the class constructor to set the user password. - + class uses this property to retrieve the user password during authentication. You will not typically use this property in your application code. Instead, you will use the class constructor to set the user password. + ]]> @@ -161,11 +161,11 @@ if the credentials should be saved and reused; otherwise, . - class uses this property during authentication. You will not typically use this property in your application code. Instead, you will specify a `rememberMe` parameter value in the class constructor. - + class uses this property during authentication. You will not typically use this property in your application code. Instead, you will specify a `rememberMe` parameter value in the class constructor. + ]]> @@ -202,11 +202,11 @@ Gets or sets the user name. The user name. - class uses this property to retrieve the user name during authentication. You will not typically use this property in your application code. Instead, you will use the class constructor to set the user name. - + class uses this property to retrieve the user name during authentication. You will not typically use this property in your application code. Instead, you will use the class constructor to set the user name. + ]]> diff --git a/xml/System.Web.ClientServices.Providers/ClientFormsAuthenticationMembershipProvider.xml b/xml/System.Web.ClientServices.Providers/ClientFormsAuthenticationMembershipProvider.xml index c1e3d193584..197626534ad 100644 --- a/xml/System.Web.ClientServices.Providers/ClientFormsAuthenticationMembershipProvider.xml +++ b/xml/System.Web.ClientServices.Providers/ClientFormsAuthenticationMembershipProvider.xml @@ -22,15 +22,15 @@ ## Remarks You can use client application services to validate users by using forms authentication. To enable forms authentication, you configure your application to use the class. - After configuration, you can validate users by calling the `static` method, which internally calls the method. + After configuration, you can validate users by calling the `static` method, which internally calls the method. - Forms authentication requires that the user specify their credentials through login controls provided by your application. You can retrieve the credentials and pass them to the method. You can also pass in empty strings or `null` to use a credentials provider. A credentials provider is an implementation specified in your application configuration file. You will typically implement the method to display a login dialog box and return a populated object. Using a credentials provider enables you to share a single login dialog box among multiple applications. + Forms authentication requires that the user specify their credentials through login controls provided by your application. You can retrieve the credentials and pass them to the method. You can also pass in empty strings or `null` to use a credentials provider. A credentials provider is an implementation specified in your application configuration file. You will typically implement the method to display a login dialog box and return a populated object. Using a credentials provider enables you to share a single login dialog box among multiple applications. - The method authenticates users through the login service indicated by the property. The value of the property is typically retrieved from the application configuration file along with other configuration values. + The method authenticates users through the login service indicated by the property. The value of the property is typically retrieved from the application configuration file along with other configuration values. If the user is successfully authenticated, the service provider sets the `static` property to a new object that contains a new object that contains the user information. If a is configured for your application, you can use the object to retrieve user role information from the roles service. - You can retrieve a reference to the current instance through the `static` property. You can use the membership provider reference to call the method directly. Additionally, you will need the membership provider reference to call the method, which is not available in the base class. + You can retrieve a reference to the current instance through the `static` property. You can use the membership provider reference to call the method directly. Additionally, you will need the membership provider reference to call the method, which is not available in the base class. You cannot use the class to create, delete, or modify membership information. To create, delete, or modify users, you must change the configuration of the login service on the server. @@ -605,7 +605,7 @@ method to initialize the using information in your application configuration file. This method recognizes the following authentication service configuration attributes: + The ASP.NET extensibility model calls the method to initialize the using information in your application configuration file. This method recognizes the following authentication service configuration attributes: - `name` - `description` @@ -656,11 +656,11 @@ method clears all authentication cookies from the cookie cache and resets the `static` property to a object that contains the current . + The method clears all authentication cookies from the cookie cache and resets the `static` property to a object that contains the current . After you call this method, the current user is no longer authenticated for client application services. This means that you cannot retrieve roles through the class and settings through the class. However, because the user might have a valid Windows identity, you might still receive a `true` value from code such as the following: `Thread.CurrentPrincipal.Identity.IsAuthenticated`. To determine whether the user is authenticated for client application services, confirm that the property value of the retrieved through the `static` property is a reference. Then, check the property. - To reauthenticate the current user, call the method or the `static` method. + To reauthenticate the current user, call the method or the `static` method. @@ -1097,7 +1097,7 @@ ## Remarks This event occurs only after the user is successfully validated. You can use this event to update your application to reflect the current user. For example, you can use the property to display the user name in your application user interface (UI). - You can silently revalidate users by calling the method. Therefore, you should avoid using the event to display intrusive UI. For example, you should not use the event to display a welcome dialog box. + You can silently revalidate users by calling the method. Therefore, you should avoid using the event to display intrusive UI. For example, you should not use the event to display a welcome dialog box. @@ -1162,9 +1162,9 @@ method, which internally calls the method. Alternatively, you can call this method directly, as shown in the Example section. + You can use client application services to validate users by using forms authentication. To validate users, you will typically call the `static` method, which internally calls the method. Alternatively, you can call this method directly, as shown in the Example section. - Forms authentication requires that the user specify their credentials through login controls provided by your application. You can retrieve the credentials and pass them to the method. You can also pass in empty strings or `null` to use a credentials provider. + Forms authentication requires that the user specify their credentials through login controls provided by your application. You can retrieve the credentials and pass them to the method. You can also pass in empty strings or `null` to use a credentials provider. ## Examples The following example code demonstrates how to use this method to validate the user by using an implementation. This example requires that you to configure your application to use a credentials provider. @@ -1215,7 +1215,7 @@ method, which internally calls the method. Alternatively, you can call the method directly. You can call this overload to pass in a `rememberMe` value in addition to the `username` and `password` values. + You can use client application services to validate users by using forms authentication. To validate users, you will typically call the `static` method, which internally calls the method. Alternatively, you can call the method directly. You can call this overload to pass in a `rememberMe` value in addition to the `username` and `password` values. @@ -1266,7 +1266,7 @@ method, which internally calls the method. Alternatively, you can call the method directly. You can call this overload to access an authentication service at the location specified by the `serviceUri` parameter. Using this overload is an alternative to setting the property and calling the overload. + You can use client application services to validate users by using forms authentication. To validate users, you will typically call the `static` method, which internally calls the method. Alternatively, you can call the method directly. You can call this overload to access an authentication service at the location specified by the `serviceUri` parameter. Using this overload is an alternative to setting the property and calling the overload. diff --git a/xml/System.Web.ClientServices.Providers/ClientRoleProvider.xml b/xml/System.Web.ClientServices.Providers/ClientRoleProvider.xml index ffcddf1390d..3932b4214b9 100644 --- a/xml/System.Web.ClientServices.Providers/ClientRoleProvider.xml +++ b/xml/System.Web.ClientServices.Providers/ClientRoleProvider.xml @@ -20,15 +20,15 @@ class. After configuration, you can determine whether an authenticated user is in a particular role by calling the method of the returned by the `static` property. For applications configured to use client application services, this property returns a . Because this class implements the interface, you do not need to reference it explicitly. The method internally calls the method. + You can use client application services to retrieve role information from an existing roles service by configuring your application to use the class. After configuration, you can determine whether an authenticated user is in a particular role by calling the method of the returned by the `static` property. For applications configured to use client application services, this property returns a . Because this class implements the interface, you do not need to reference it explicitly. The method internally calls the method. The class is a read-only role membership provider that retrieves role information for authenticated users from the roles service indicated by the property. The value of the property is typically retrieved from the application configuration file along with other configuration values. You can retrieve the current instance through the `static` property. - The class supports only the and methods of the abstract class. When you call one of these methods for a particular user, the service provider first checks the local data cache for role information. If the cache does not contain any role information or the cache has expired, the service provider retrieves the role information from the roles service and adds it to the cache. + The class supports only the and methods of the abstract class. When you call one of these methods for a particular user, the service provider first checks the local data cache for role information. If the cache does not contain any role information or the cache has expired, the service provider retrieves the role information from the roles service and adds it to the cache. - You can specify the time-out period for the roles cache when you configure client application services. To force the method to retrieve role data from the service instead of the local cache, call the method first. + You can specify the time-out period for the roles cache when you configure client application services. To force the method to retrieve role data from the service instead of the local cache, call the method first. You cannot use the class to create or delete roles, or to modify the role membership of users. To create or modify role information, you must change the configuration of the role service on the server. @@ -270,14 +270,14 @@ method retrieves role information for the current, authenticated user, which you must specify in the `username` parameter. You can get the user name through the `static` property as follows: `Thread.CurrentPrincipal.Identity.Name`. + The method retrieves role information for the current, authenticated user, which you must specify in the `username` parameter. You can get the user name through the `static` property as follows: `Thread.CurrentPrincipal.Identity.Name`. The service provider caches role information about the local file system to avoid unnecessary service calls. For more information, see the class overview. ## Examples - The following example code demonstrates how to use this method to determine whether the user login has expired before testing role membership. This code assumes that all valid users are associated with one or more roles. In this case, the method will not return any roles for a previously-authenticated user whose login has expired. If the user login has expired, this code displays the login dialog box. Otherwise, it calls the method to determine whether the user is in the "manager" role. The restricted code is in a `PerformManagerTask` method, which is not provided. + The following example code demonstrates how to use this method to determine whether the user login has expired before testing role membership. This code assumes that all valid users are associated with one or more roles. In this case, the method will not return any roles for a previously-authenticated user whose login has expired. If the user login has expired, this code displays the login dialog box. Otherwise, it calls the method to determine whether the user is in the "manager" role. The restricted code is in a `PerformManagerTask` method, which is not provided. :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Class1.cs" id="Snippet321"::: :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Class1.vb" id="Snippet321"::: @@ -352,7 +352,7 @@ method to initialize the using information in your application configuration file. This method recognizes the following role service configuration attributes: + The ASP.NET extensibility model calls the method to initialize the using information in your application configuration file. This method recognizes the following role service configuration attributes: - `name` - `description` @@ -414,14 +414,14 @@ method of the returned by the `static` property. For applications configured to use client application services, this property returns a . Because this class implements the interface, you do not need to reference it explicitly. The method internally calls the method. The method uses the method to determine whether the user indicated by `username` is in the role indicated by `roleName`. + You can determine whether an authenticated user is in a particular role by calling the method of the returned by the `static` property. For applications configured to use client application services, this property returns a . Because this class implements the interface, you do not need to reference it explicitly. The method internally calls the method. The method uses the method to determine whether the user indicated by `username` is in the role indicated by `roleName`. The service provider caches role information about the local file system to avoid unnecessary service calls. For more information, see the class overview. ## Examples - The following example code demonstrates how to access this method directly to determine whether the user is in a particular role. This code first tests whether the user login has expired. An explicit reference is required to call the method, so the same reference is used to call the method. If the user is in the "manager" role, this code calls a `PerformManagerTask` method, which is not provided. + The following example code demonstrates how to access this method directly to determine whether the user is in a particular role. This code first tests whether the user login has expired. An explicit reference is required to call the method, so the same reference is used to call the method. If the user is in the "manager" role, this code calls a `PerformManagerTask` method, which is not provided. :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Class1.cs" id="Snippet321"::: :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Class1.vb" id="Snippet321"::: @@ -498,7 +498,7 @@ method removes all role information from the local cache and causes the cache to expire. After you call this method, your next call to the or method will retrieve role information from the configured role service instead of the local cache. + The method removes all role information from the local cache and causes the cache to expire. After you call this method, your next call to the or method will retrieve role information from the configured role service instead of the local cache. You can use this method to enable users to refresh the roles cache when their role has changed but the cache has not yet expired. diff --git a/xml/System.Web.ClientServices.Providers/ClientSettingsProvider.xml b/xml/System.Web.ClientServices.Providers/ClientSettingsProvider.xml index 909004f4e1e..c03cfdb5669 100644 --- a/xml/System.Web.ClientServices.Providers/ClientSettingsProvider.xml +++ b/xml/System.Web.ClientServices.Providers/ClientSettingsProvider.xml @@ -271,7 +271,7 @@ ## Remarks This method is used internally by the application settings system and it not meant to be used by your application code. - The ASP.NET extensibility model calls the method to initialize the by using information in your application configuration file. This method recognizes the following Web settings service configuration attributes: + The ASP.NET extensibility model calls the method to initialize the by using information in your application configuration file. This method recognizes the following Web settings service configuration attributes: - name - description @@ -327,7 +327,7 @@ method of your project's `Settings` class (typically accessed as `Properties.Settings.Default` in C# and `My.Settings` in Visual Basic). You can also revert Web settings to the previously cached values by calling the method. + This method is used internally by the application settings system and it not meant to be used by your application code. To reset Web settings to their default values, you will typically use the method of your project's `Settings` class (typically accessed as `Properties.Settings.Default` in C# and `My.Settings` in Visual Basic). You can also revert Web settings to the previously cached values by calling the method. ]]> diff --git a/xml/System.Web.ClientServices.Providers/ClientWindowsAuthenticationMembershipProvider.xml b/xml/System.Web.ClientServices.Providers/ClientWindowsAuthenticationMembershipProvider.xml index de21d4d9cd8..736200a83b9 100644 --- a/xml/System.Web.ClientServices.Providers/ClientWindowsAuthenticationMembershipProvider.xml +++ b/xml/System.Web.ClientServices.Providers/ClientWindowsAuthenticationMembershipProvider.xml @@ -22,11 +22,11 @@ ## Remarks You can use client application services to validate users by using Windows authentication. To enable Windows authentication, you configure your application to use the class. - After configuration, you can validate users by calling the `static` method. The method internally calls the method. + After configuration, you can validate users by calling the `static` method. The method internally calls the method. - The method automatically authenticates the current user and sets the `static` property to a object that contains the current . If a is configured for your application, you can use the object to retrieve user role information from the roles service. + The method automatically authenticates the current user and sets the `static` property to a object that contains the current . If a is configured for your application, you can use the object to retrieve user role information from the roles service. - You can retrieve a reference to the current instance through the `static` property. You can use the membership provider reference to call the method directly. Additionally, you will need the membership provider reference to call the method, which is not available in the base class. + You can retrieve a reference to the current instance through the `static` property. You can use the membership provider reference to call the method directly. Additionally, you will need the membership provider reference to call the method, which is not available in the base class. @@ -579,7 +579,7 @@ property is set to a object that enables access to the configured role service. The method resets the property to a object that contains the current . After you call this method, you can no longer retrieve roles for the user through the class. To reauthenticate the current user, call the method. + For users authenticated through client application services, the `static` property is set to a object that enables access to the configured role service. The method resets the property to a object that contains the current . After you call this method, you can no longer retrieve roles for the user through the class. To reauthenticate the current user, call the method. @@ -949,7 +949,7 @@ class, the `static` method will use this method for its implementation. The method automatically authenticates the current user and sets the `static` property to a object that contains the current . If a is configured for your application, you can use the object to retrieve user role information from the roles service. + When you configure your application to use the class, the `static` method will use this method for its implementation. The method automatically authenticates the current user and sets the `static` property to a object that contains the current . If a is configured for your application, you can use the object to retrieve user role information from the roles service. diff --git a/xml/System.Web.ClientServices.Providers/IClientFormsAuthenticationCredentialsProvider.xml b/xml/System.Web.ClientServices.Providers/IClientFormsAuthenticationCredentialsProvider.xml index 9868ebf64b5..ae70d5e0abc 100644 --- a/xml/System.Web.ClientServices.Providers/IClientFormsAuthenticationCredentialsProvider.xml +++ b/xml/System.Web.ClientServices.Providers/IClientFormsAuthenticationCredentialsProvider.xml @@ -14,17 +14,17 @@ Defines a method that the class calls to retrieve user credentials. - method. You can also pass empty strings or `null` as the parameters to use a credentials provider. A credentials provider is a class that you provide and specify in your application configuration. A credentials provider class must implement the interface, which has a single method named . A typical method implementation will display a dialog box to retrieve user input. Using a credentials provider enables you to share a single login dialog box among multiple applications. + method. You can also pass empty strings or `null` as the parameters to use a credentials provider. A credentials provider is a class that you provide and specify in your application configuration. A credentials provider class must implement the interface, which has a single method named . A typical method implementation will display a dialog box to retrieve user input. Using a credentials provider enables you to share a single login dialog box among multiple applications. + +## Examples + The following example code demonstrates how to implement the method, which is the only member in this interface. In this example, the method is part of a login dialog box class. This method displays the dialog box, and then returns a instance initialized with the user-specified values. -## Examples - The following example code demonstrates how to implement the method, which is the only member in this interface. In this example, the method is part of a login dialog box class. This method displays the dialog box, and then returns a instance initialized with the user-specified values. - :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.cs" id="Snippet210"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.vb" id="Snippet210"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.vb" id="Snippet210"::: + ]]> @@ -56,17 +56,17 @@ Retrieves user credentials. The user login information. - method. You can also pass empty strings or `null` as the parameters to use a credentials provider. A credentials provider is a class that you provide and specify in your application configuration. A credentials provider class must implement the interface, which has a single method called . A typical method implementation will display a dialog box to retrieve user input. Using a credentials provider enables you to share a single login dialog box among multiple applications. + method. You can also pass empty strings or `null` as the parameters to use a credentials provider. A credentials provider is a class that you provide and specify in your application configuration. A credentials provider class must implement the interface, which has a single method called . A typical method implementation will display a dialog box to retrieve user input. Using a credentials provider enables you to share a single login dialog box among multiple applications. + +## Examples + The following example code demonstrates how to implement the method. In this example, the method is part of a login dialog box class. This method displays the dialog box, and then returns a instance initialized with the user-specified values. -## Examples - The following example code demonstrates how to implement the method. In this example, the method is part of a login dialog box class. This method displays the dialog box, and then returns a instance initialized with the user-specified values. - :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.cs" id="Snippet210"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.vb" id="Snippet210"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Login.vb" id="Snippet210"::: + ]]> diff --git a/xml/System.Web.ClientServices/ClientFormsIdentity.xml b/xml/System.Web.ClientServices/ClientFormsIdentity.xml index 8c136028c95..2639e0c1261 100644 --- a/xml/System.Web.ClientServices/ClientFormsIdentity.xml +++ b/xml/System.Web.ClientServices/ClientFormsIdentity.xml @@ -27,19 +27,19 @@ method. After authentication, you can retrieve a reference to the current instance through the property of the retrieved through the `static` property. For more information, see [Client Application Services](/dotnet/framework/common-client-technologies/client-application-services). + The client application services feature uses this class to represent an authenticated user. When you configure your application to use client application services and forms authentication, you can authenticate a user by calling the `static` method. After authentication, you can retrieve a reference to the current instance through the property of the retrieved through the `static` property. For more information, see [Client Application Services](/dotnet/framework/common-client-technologies/client-application-services). You will typically access a object as an reference to avoid a direct dependency on this class. You can determine whether a user is authenticated by checking the property of the identity. However, the user may be authenticated for Windows, but not for client application services. To determine whether the user is authenticated for client application services, you should also confirm that the property value is "ClientForms". - You must use an explicit reference to call the method, which is not defined by the interface. + You must use an explicit reference to call the method, which is not defined by the interface. ## Examples - The following example code demonstrates how to use this class to silently revalidate a user when the application leaves the offline state. In this example, a event handler updates the offline status to match the check box value. If the user sets the application to the online state, the event handler attempts to revalidate the user by calling the method. However, if the authentication server is unavailable, the event handler returns the application to the offline state. + The following example code demonstrates how to use this class to silently revalidate a user when the application leaves the offline state. In this example, a event handler updates the offline status to match the check box value. If the user sets the application to the online state, the event handler attempts to revalidate the user by calling the method. However, if the authentication server is unavailable, the event handler returns the application to the offline state. > [!NOTE] -> The method is for convenience only. Because it does not have a return value, it cannot indicate whether revalidation has failed. Revalidation can fail, for example, if the user credentials have changed on the server. In this case, you might want to include code that explicitly validates users after a service call fails. For more information, see the Accessing Web Settings section in [Walkthrough: Using Client Application Services](/dotnet/framework/common-client-technologies/walkthrough-using-client-application-services). +> The method is for convenience only. Because it does not have a return value, it cannot indicate whether revalidation has failed. Revalidation can fail, for example, if the user credentials have changed on the server. In this case, you might want to include code that explicitly validates users after a service call fails. For more information, see the Accessing Web Settings section in [Walkthrough: Using Client Application Services](/dotnet/framework/common-client-technologies/walkthrough-using-client-application-services). :::code language="csharp" source="~/snippets/csharp/System.Web.ClientServices/ClientFormsIdentity/Overview/Class1.cs" id="Snippet315"::: :::code language="vb" source="~/snippets/visualbasic/System.Web.ClientServices/ClientFormsIdentity/Overview/Class1.vb" id="Snippet315"::: @@ -216,10 +216,10 @@ when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + Call when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). > [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. +> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. ]]> @@ -406,10 +406,10 @@ class stores the user credentials as long as the application is running. However, the user is only authenticated until the authentication cookie expires. After the cookie expires, the user must be revalidated to access the remote roles or Web settings services. You can use the **Advanced Settings for Services** dialog box to configure your application to automatically revalidate the user. However, if you configure your application to honor the cookie expiration, you can programmatically revalidate the user by calling the method. This method is also useful when switching from offline mode to online mode, because the application may have been shut down while offline. + When you use forms authentication to validate the current user, the class stores the user credentials as long as the application is running. However, the user is only authenticated until the authentication cookie expires. After the cookie expires, the user must be revalidated to access the remote roles or Web settings services. You can use the **Advanced Settings for Services** dialog box to configure your application to automatically revalidate the user. However, if you configure your application to honor the cookie expiration, you can programmatically revalidate the user by calling the method. This method is also useful when switching from offline mode to online mode, because the application may have been shut down while offline. > [!NOTE] -> The method is for convenience only. Because it does not have a return value, it cannot indicate whether revalidation has failed. Revalidation can fail, for example, if the user credentials have changed on the server. In this case, you might want to include code that explicitly validates users after a service call fails. For more information, see the Accessing Web Settings section in [Walkthrough: Using Client Application Services](/dotnet/framework/common-client-technologies/walkthrough-using-client-application-services). +> The method is for convenience only. Because it does not have a return value, it cannot indicate whether revalidation has failed. Revalidation can fail, for example, if the user credentials have changed on the server. In this case, you might want to include code that explicitly validates users after a service call fails. For more information, see the Accessing Web Settings section in [Walkthrough: Using Client Application Services](/dotnet/framework/common-client-technologies/walkthrough-using-client-application-services). ## Examples The following example code demonstrates how to use this method to silently revalidate a user when the application leaves the offline state. In this example, a event handler updates the offline status to match the check box value. If the user sets the application to the online state, the event handler attempts to revalidate the user. However, if the authentication server is unavailable, the event handler returns the application to the offline state. diff --git a/xml/System.Web.ClientServices/ClientRolePrincipal.xml b/xml/System.Web.ClientServices/ClientRolePrincipal.xml index 920ae39fe21..daa9d82387d 100644 --- a/xml/System.Web.ClientServices/ClientRolePrincipal.xml +++ b/xml/System.Web.ClientServices/ClientRolePrincipal.xml @@ -26,7 +26,7 @@ ## Remarks When you validate a user in client application services, the or the sets the `static` property to an instance of this class. The initializes the property to a new instance of the class. The initializes the property to the object returned by the `static` method. - You will not typically access this class directly. Normally, you will call the method of the returned by the `static` property. However, you can cast the property value to a reference to call the method explicitly, as demonstrated in the Example section. + You will not typically access this class directly. Normally, you will call the method of the returned by the `static` property. However, you can cast the property value to a reference to call the method explicitly, as demonstrated in the Example section. @@ -170,9 +170,9 @@ method of the returned by the `static` property. However, you can cast the property value to a reference to call this method explicitly, as demonstrated in the Example section. + Normally, you will call the method of the returned by the `static` property. However, you can cast the property value to a reference to call this method explicitly, as demonstrated in the Example section. - The method will always return `false` if the user login has expired. This will not occur if your application calls the method one time shortly after authentication. If your application must retrieve user roles at other times, you might want to add code to revalidate users whose login has expired. If all valid users are assigned to roles, you can determine whether the login has expired by calling the method. If no roles are returned, the login has expired. For an example of this functionality, see the method. This functionality is only necessary if you have selected **Require users to log on again whenever the server cookie expires** in your application configuration. + The method will always return `false` if the user login has expired. This will not occur if your application calls the method one time shortly after authentication. If your application must retrieve user roles at other times, you might want to add code to revalidate users whose login has expired. If all valid users are assigned to roles, you can determine whether the login has expired by calling the method. If no roles are returned, the login has expired. For an example of this functionality, see the method. This functionality is only necessary if you have selected **Require users to log on again whenever the server cookie expires** in your application configuration. ## Examples The following example code demonstrates how to use this method to display a button only when the user is in the "manager" role. This example requires a named `managerOnlyButton` with an initial property value of `false`. diff --git a/xml/System.Web.Compilation/AppSettingsExpressionBuilder.xml b/xml/System.Web.Compilation/AppSettingsExpressionBuilder.xml index 49182e88d50..e9e5a65d4f0 100644 --- a/xml/System.Web.Compilation/AppSettingsExpressionBuilder.xml +++ b/xml/System.Web.Compilation/AppSettingsExpressionBuilder.xml @@ -139,7 +139,7 @@ ` is encountered in a no-compile page. It retrieves the appropriate value from the key/value pairs in the `` section of the Web.config file. This method overrides by calling the method with the property as the `key` parameter, the property on the property as the `propertyName` parameter, and the of the `target` parameter as the `targetType` parameter. + This method is called when an expression of the form `<%$ AppSettings: someApplicationSetting %>` is encountered in a no-compile page. It retrieves the appropriate value from the key/value pairs in the `` section of the Web.config file. This method overrides by calling the method with the property as the `key` parameter, the property on the property as the `propertyName` parameter, and the of the `target` parameter as the `targetType` parameter. ]]> @@ -300,7 +300,7 @@ property indicates whether the method has been implemented in the class and can return a value for the expression. must be implemented within an expression builder for an expression to be evaluated in a page that is not compiled. The class supports evaluation of an application setting in a page that is not compiled, so it always returns `true`. + The property indicates whether the method has been implemented in the class and can return a value for the expression. must be implemented within an expression builder for an expression to be evaluated in a page that is not compiled. The class supports evaluation of an application setting in a page that is not compiled, so it always returns `true`. ]]> diff --git a/xml/System.Web.Compilation/AssemblyBuilder.xml b/xml/System.Web.Compilation/AssemblyBuilder.xml index a6eee47d503..60b019d0a20 100644 --- a/xml/System.Web.Compilation/AssemblyBuilder.xml +++ b/xml/System.Web.Compilation/AssemblyBuilder.xml @@ -28,16 +28,16 @@ The property indicates the implementation that the ASP.NET build environment uses to compile an assembly from the source code contributed by each implementation. - A object contributes source code in the form of a CodeDOM graph using the method. A object contributes source code stored in a physical file using the method. + A object contributes source code in the form of a CodeDOM graph using the method. A object contributes source code stored in a physical file using the method. After each object contributes source code using the appropriate methods, the ASP.NET build environment uses the class to compile the collected source code into an assembly. ## Examples - The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. + The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. - In the method implementation, the build provider adds the generated code for the assembly compilation using the method. The example does not include the implementation of the `SampleClassGenerator` class. For more information, see . + In the method implementation, the build provider adds the generated code for the assembly compilation using the method. The example does not include the implementation of the `SampleClassGenerator` class. For more information, see . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation_SampleBuildProvider/CS/samplebuildprovider.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation_SampleBuildProvider/VB/samplebuildprovider.vb" id="Snippet2"::: @@ -75,13 +75,13 @@ implementation uses the method when generating source code that references types within the input assembly. + A implementation uses the method when generating source code that references types within the input assembly. - The ASP.NET build environment initializes the default collection of assemblies available for reference through the build provider in the property. If the build provider generates source code that references additional assemblies, the build provider adds the additional assemblies using the 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. + The ASP.NET build environment initializes the default collection of assemblies available for reference through the build provider in the property. If the build provider generates source code that references additional assemblies, the build provider adds the additional assemblies using the 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. - Typically, a object adds source code to the object in the method. If a build provider generates source code that uses an external type, the build provider adds the type's assembly using the method. + Typically, a object adds source code to the object in the method. If a build provider generates source code that uses an external type, the build provider adds the type's assembly using the method. - Use the method to add a referenced assembly required in source code generated by a instance for a specific file type. Use the [assemblies Element for compilation (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/3811c448-af1c-498d-be2b-6ed2634c51e9) configuration element to configure an assembly for reference across multiple file types in a project. + Use the method to add a referenced assembly required in source code generated by a instance for a specific file type. Use the [assemblies Element for compilation (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/3811c448-af1c-498d-be2b-6ed2634c51e9) configuration element to configure an assembly for reference across multiple file types in a project. ]]> @@ -116,9 +116,9 @@ implementation calls the method when generating a CodeDOM graph for a virtual path. Source code added with is included in the assembly compilation. + A implementation calls the method when generating a CodeDOM graph for a virtual path. Source code added with is included in the assembly compilation. - Typically, a build provider's method implementation reads the property, parses the contents, and then adds the generated source code to the specified object. The build provider uses the method to add source code as a CodeDOM graph to the assembly. Alternately, the build provider can use the method to add source code as a physical file to the assembly. + Typically, a build provider's method implementation reads the property, parses the contents, and then adds the generated source code to the specified object. The build provider uses the method to add source code as a CodeDOM graph to the assembly. Alternately, the build provider can use the method to add source code as a physical file to the assembly. ]]> @@ -197,18 +197,18 @@ implementation calls the method when generating a source file for a virtual path. Source code added with is included in the assembly compilation. + A implementation calls the method when generating a source file for a virtual path. Source code added with is included in the assembly compilation. - Typically, a build provider method implementation reads the property, parses the contents, and then adds the generated source code to the specified object. The build provider uses the method to add source code as a physical file to the assembly. Alternately, the build provider can use the method to add source code as a CodeDOM graph to the assembly. + Typically, a build provider method implementation reads the property, parses the contents, and then adds the generated source code to the specified object. The build provider uses the method to add source code as a physical file to the assembly. Alternately, the build provider can use the method to add source code as a CodeDOM graph to the assembly. - After calling , the build provider writes the source file contents using the returned object. After writing the source file, the object must use the method to close the object and free associated system resources. + After calling , the build provider writes the source file contents using the returned object. After writing the source file, the object must use the method to close the object and free associated system resources. ## Examples - The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. + The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. - In the method implementation, the build provider adds the generated code for the assembly compilation using the method. The example does not include the implementation of the `SampleClassGenerator` class. For more information, see . + In the method implementation, the build provider adds the generated code for the assembly compilation using the method. The example does not include the implementation of the `SampleClassGenerator` class. For more information, see . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation_SampleBuildProvider/CS/samplebuildprovider.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation_SampleBuildProvider/VB/samplebuildprovider.vb" id="Snippet2"::: @@ -250,7 +250,7 @@ method, a object writes the resource file contents using the returned object. For example, the build provider can write the resources using a object. After writing the resource file, the build provider must use the method to close the object and free associated system resources. + After calling the method, a object writes the resource file contents using the returned object. For example, the build provider can write the resources using a object. After writing the resource file, the build provider must use the method to close the object and free associated system resources. ]]> @@ -286,7 +286,7 @@ implementation calls the method to optimize performance for frequent creations of type instances. + A implementation calls the method to optimize performance for frequent creations of type instances. ]]> @@ -321,9 +321,9 @@ implementation calls the method to get a temporary file path that is deleted automatically after the assembly is compiled. + A implementation calls the method to get a temporary file path that is deleted automatically after the assembly is compiled. - The method generates a unique temporary file path, but does not create the file. + The method generates a unique temporary file path, but does not create the file. ]]> diff --git a/xml/System.Web.Compilation/BuildDependencySet.xml b/xml/System.Web.Compilation/BuildDependencySet.xml index 6b960fecdbb..a7524341812 100644 --- a/xml/System.Web.Compilation/BuildDependencySet.xml +++ b/xml/System.Web.Compilation/BuildDependencySet.xml @@ -17,11 +17,11 @@ Represents dependencies returned by the build manager. - object for an application can be retrieved through the method. It contains the properties that represent the list of dependencies. - + object for an application can be retrieved through the method. It contains the properties that represent the list of dependencies. + ]]> diff --git a/xml/System.Web.Compilation/BuildManager.xml b/xml/System.Web.Compilation/BuildManager.xml index e95133b024e..961efd25720 100644 --- a/xml/System.Web.Compilation/BuildManager.xml +++ b/xml/System.Web.Compilation/BuildManager.xml @@ -91,7 +91,7 @@ ## Remarks Calling this method is equivalent to adding the assembly to the application-level Web.config file. The method must be called during the `Application_PreStartInit` stage of the application. - The method will return the set of assemblies that are determined from configuration files and any assemblies that were added by using this method. + The method will return the set of assemblies that are determined from configuration files and any assemblies that were added by using this method. If an attempt is made to add an assembly that has already been added, the duplicate entry is ignored. @@ -189,7 +189,7 @@ method enable you to perform caching that persists across application domain restarts in partial-trust environments. It is used by the MVC framework to cache results of the controller lookup. + This method and the method enable you to perform caching that persists across application domain restarts in partial-trust environments. It is used by the MVC framework to cache results of the controller lookup. To cache data, you write to the object that is returned by this method. @@ -226,7 +226,7 @@ method works for compiled and non-compile pages. + The method works for compiled and non-compile pages. ]]> @@ -302,9 +302,9 @@ method overload behaves like the method overload. Both overloads return a current build dependency set if one exists, otherwise they return `null`. + If the `ensureIsUpToDate` parameter value is set to `true`, the method overload behaves like the method overload. Both overloads return a current build dependency set if one exists, otherwise they return `null`. - However, the method overload includes the option to return any build dependency set that is available, even an outdated one. If the `ensureIsUpToDate` parameter value is set to `false`, the method will return any available build dependency set. + However, the method overload includes the option to return any build dependency set that is available, even an outdated one. If the `ensureIsUpToDate` parameter value is set to `false`, the method will return any available build dependency set. ]]> @@ -501,9 +501,9 @@ method includes assemblies specified in the [assemblies](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/bfyb45k1(v=vs.100)) element of the Web.config file, assemblies built from custom code in the App_Code directory, and assemblies in other top-level folders. + The collection of assemblies that is returned from the method includes assemblies specified in the [assemblies](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/bfyb45k1(v=vs.100)) element of the Web.config file, assemblies built from custom code in the App_Code directory, and assemblies in other top-level folders. - is introduced in the .NET Framework version 3.5. For more information, see [.NET Framework Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [.NET Framework Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -723,7 +723,7 @@ method enable you to perform caching that persists across application domain restarts in partial-trust environments. It is used by the MVC framework to cache results of the controller lookup. + This method and the method enable you to perform caching that persists across application domain restarts in partial-trust environments. It is used by the MVC framework to cache results of the controller lookup. To retrieve cached data, you read from the object that is returned by this method. diff --git a/xml/System.Web.Compilation/BuildProvider.xml b/xml/System.Web.Compilation/BuildProvider.xml index 74d9981962a..5791b597777 100644 --- a/xml/System.Web.Compilation/BuildProvider.xml +++ b/xml/System.Web.Compilation/BuildProvider.xml @@ -32,9 +32,9 @@ 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#. + 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#. - To implement a build provider that generates source code for Web content, derive a class from and override the method to return the for the class generated by . Override the method to generate source code for the type provided by the supported file. + To implement a build provider that generates source code for Web content, derive a class from and override the method to return the for the class generated by . Override the method to generate source code for the type provided by the supported file. > [!NOTE] > Adding a customized class to the Web.config file works in an ASP.NET Web site but does not work in an ASP.NET Web application project. In a Web application project, the code that is generated by the class cannot be included in the application. For more information, see [ASP.NET Web Application Project Precompilation Overview](https://msdn.microsoft.com/library/b940abbd-178d-4570-b441-52914fa7b887). @@ -42,7 +42,7 @@ ## Examples - The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. The example does not include the implementation of the `SampleClassGenerator` class. For more information, see the class overview. + The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. The example does not include the implementation of the `SampleClassGenerator` class. For more information, see the class overview. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.SampleBuildProvider_2/CS/Class1.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.SampleBuildProvider_2/VB/Class1.vb" id="Snippet2"::: @@ -113,14 +113,14 @@ ## Remarks Use the property to provide the settings for compiling source code for an implementation of . The property is `null` if the build provider does not require a specific code language for generating and compiling source code. - To set the value for a object within a build provider implementation, use the or method. + To set the value for a object within a build provider implementation, use the or method. The property specifies the implementation that is used to generate and compile source code for a build provider. The property defines the settings that are used to compile the source code into an assembly. ## Examples - The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. + The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.SampleBuildProvider_2/CS/Class1.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.SampleBuildProvider_2/VB/Class1.vb" id="Snippet2"::: @@ -156,16 +156,16 @@ class, and override the method to generate source code for the supported file type. + To implement a build provider that generates source code for a custom file type, derive a class from the class, and override the method to generate source code for the supported file type. - Typically, a build provider's implementation reads the property, parses the contents, and adds the generated source code to the specified object. You can contribute source code to the assembly in the form of a object or a CodeDOM graph. To add source code to the assembly through a object, use the method. To add source code in a CodeDOM graph to the assembly, use the method. + Typically, a build provider's implementation reads the property, parses the contents, and adds the generated source code to the specified object. You can contribute source code to the assembly in the form of a object or a CodeDOM graph. To add source code to the assembly through a object, use the method. To add source code in a CodeDOM graph to the assembly, use the method. If the build provider generates source code in a specific programming language, you must override the property to return a object for the supported programming language. ## Examples - The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. + The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.SampleBuildProvider_2/CS/Class1.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.SampleBuildProvider_2/VB/Class1.vb" id="Snippet2"::: @@ -238,11 +238,11 @@ method of a object creates an instance of a build provider for an input virtual path, and calls the method on the object. + The method of a object creates an instance of a build provider for an input virtual path, and calls the method on the object. - The base class returns `null` for the method, indicating that is not implemented. + The base class returns `null` for the method, indicating that is not implemented. - Certain build provider implementations can implement in place of the method. A object typically uses to return a object for a virtual path. However, the method can be used to indicate that a object can generate multiple types from a virtual path. + Certain build provider implementations can implement in place of the method. A object typically uses to return a object for a virtual path. However, the method can be used to indicate that a object can generate multiple types from a virtual path. ]]> @@ -274,11 +274,11 @@ 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. + 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 `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. + When deriving from the class, you can use to set the property within your implementation. ]]> @@ -313,11 +313,11 @@ 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. + 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 `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. + When you derive from the class, you can use to set the property value for the language supported by your implementation. ]]> @@ -358,9 +358,9 @@ class and override the method to return the type generated by the build provider. + To implement a build provider that generates source code for Web content such as .aspx files, derive a class from the class and override the method to return the type generated by the build provider. - The ASP.NET build system compiles files for each build provider, and generates a object, which is passed to the method. Typically, a build provider's implementation uses the method on the property of the input `results` object to return the provided type. + The ASP.NET build system compiles files for each build provider, and generates a object, which is passed to the method. Typically, a build provider's implementation uses the method on the property of the input `results` object to return the provided type. ]]> @@ -394,11 +394,11 @@ method is used by the ASP.NET build environment when using instances of the class to build files and load the compiled assemblies. + The method is used by the ASP.NET build environment when using instances of the class to build files and load the compiled assemblies. The base class method returns the field value, indicating that no special action is required when the virtual path is built. - When deriving from the class, you can implement the method to return a different value for your custom file type or virtual path. For example, if a rebuild of your virtual path requires the containing object to be reloaded, you can return the enumeration value from your method. + When deriving from the class, you can implement the method to return a different value for your custom file type or virtual path. For example, if a rebuild of your virtual path requires the containing object to be reloaded, you can return the enumeration value from your method. ]]> @@ -439,9 +439,9 @@ method on the returned object to read the contents of the property for a object. + Use the method on the returned object to read the contents of the property for a object. - After calling the method, you must use the method to close the object and free associated system resources. + After calling the method, you must use the method to close the object and free associated system resources. ]]> @@ -476,9 +476,9 @@ method on the returned object to read the contents of the virtual path. + Use the method on the returned object to read the contents of the virtual path. - After calling the method, you must use the method to close the object and free associated system resources. + After calling the method, you must use the method to close the object and free associated system resources. ]]> @@ -518,9 +518,9 @@ method on the returned object to read the contents of the virtual path for the object. + Use the method on the returned object to read the contents of the virtual path for the object. - After calling the method, you must use the method to close the object and free associated system resources. + After calling the method, you must use the method to close the object and free associated system resources. ]]> @@ -555,9 +555,9 @@ method on the returned object to read the contents of the virtual path. + Use the method on the returned object to read the contents of the virtual path. - After calling the method, you must use the method to close the object and free associated system resources. + After calling the method, you must use the method to close the object and free associated system resources. ]]> @@ -628,9 +628,9 @@ ## Remarks The ASP.NET build environment initializes the collection of assemblies that are available for reference by the build provider. The source code generated by a build provider can use public types in the referenced assemblies. The referenced assembly collection consists of other assemblies built in the ASP.NET application, and assemblies listed in the `assemblies` element in the configuration file. - If the build provider generates source code that references additional assemblies, the build provider adds the additional assemblies using the 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. + If the build provider generates source code that references additional assemblies, the build provider adds the additional assemblies using the 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. - The collection does not include assemblies that are added for reference by other build providers through the method. + The collection does not include assemblies that are added for reference by other build providers through the method. ]]> @@ -729,7 +729,7 @@ property is a collection of virtual paths that must be compiled before the instance generates source code. The assemblies from the virtual paths in are added as references to the compilation for the instance. + The property is a collection of virtual paths that must be compiled before the instance generates source code. The assemblies from the virtual paths in are added as references to the compilation for the instance. ]]> diff --git a/xml/System.Web.Compilation/BuildProviderResultFlags.xml b/xml/System.Web.Compilation/BuildProviderResultFlags.xml index ab2f881e14c..f3d85a96eea 100644 --- a/xml/System.Web.Compilation/BuildProviderResultFlags.xml +++ b/xml/System.Web.Compilation/BuildProviderResultFlags.xml @@ -22,11 +22,11 @@ Indicates the required behavior when a virtual path is built. - values are used to indicate the results from the method. The enumeration values indicate actions that are required after a virtual path is built within the ASP.NET build environment. The values are used by the ASP.NET build environment when using instances of the class to build files and load the compiled assemblies. - + values are used to indicate the results from the method. The enumeration values indicate actions that are required after a virtual path is built within the ASP.NET build environment. The values are used by the ASP.NET build environment when using instances of the class to build files and load the compiled assemblies. + ]]> diff --git a/xml/System.Web.Compilation/ClientBuildManager.xml b/xml/System.Web.Compilation/ClientBuildManager.xml index b77bff1c0a9..9cb00baf933 100644 --- a/xml/System.Web.Compilation/ClientBuildManager.xml +++ b/xml/System.Web.Compilation/ClientBuildManager.xml @@ -21,13 +21,13 @@ Provides compilation services for ASP.NET applications. - class offers methods and properties for compiling ASP.NET Web applications, and retrieving the generated assemblies or generated source code. Instances of the class are established in the client's application domain and provide access to the ASP.NET build system outside of Microsoft Internet Information Services (IIS). The class can be used to develop customized tools for compiling Web applications. - - The command-line tool `aspnet_compiler` uses the class. - + class offers methods and properties for compiling ASP.NET Web applications, and retrieving the generated assemblies or generated source code. Instances of the class are established in the client's application domain and provide access to the ASP.NET build system outside of Microsoft Internet Information Services (IIS). The class can be used to develop customized tools for compiling Web applications. + + The command-line tool `aspnet_compiler` uses the class. + ]]> @@ -113,11 +113,11 @@ The target directory for precompilation. Initializes a new instance of the class with the specified target directory. - @@ -158,11 +158,11 @@ Values that determine the precompilation behavior. Initializes a new instance of the class with the specified target directory and compilation parameter. - @@ -299,11 +299,11 @@ Gets the physical path to the directory used for code generation. A containing the directory path used for code generation. - @@ -332,11 +332,11 @@ Compiles application-dependent files, such as files in the App_Code directory, the Global.asax file, resource files, and Web references. - method ensures that resources, Web references, files in the App_Code directory, .browser files in the App_Browsers directory, and the Global.asax file are compiled. - + method ensures that resources, Web references, files in the App_Code directory, .browser files in the App_Browsers directory, and the Global.asax file are compiled. + ]]> @@ -543,11 +543,11 @@ Returns the codeDOM tree, compiler type, and compiler parameters for a file represented by a virtual path. A for the given file. - method retrieves information needed to compile a file. In addition to a object as a return value, it returns three `out` parameters. The `codeDomProviderType` parameter returns the provider type for generating and compiling the file. The `compilerParameters` parameter contains properties that determine compilation behavior. The `linePragmasTable` parameter contains a dictionary of line pragmas. - + method retrieves information needed to compile a file. In addition to a object as a return value, it returns three `out` parameters. The `codeDomProviderType` parameter returns the provider type for generating and compiling the file. The `compilerParameters` parameter contains properties that determine compilation behavior. The `linePragmasTable` parameter contains a dictionary of line pragmas. + ]]> @@ -589,11 +589,11 @@ Returns the contents, codeDOM tree, compiler type, and compiler parameters for a file represented by a virtual path. A for the given file. - method retrieves information needed to compile a file. In addition to a object as a return value, it returns three `out` parameters. The `codeDomProviderType` parameter returns the provider type for generating and compiling the file. The `compilerParameters` parameter contains properties that determine compilation behavior. The `linePragmasTable` parameter contains a dictionary of line pragmas. - + method retrieves information needed to compile a file. In addition to a object as a return value, it returns three `out` parameters. The `codeDomProviderType` parameter returns the provider type for generating and compiling the file. The `compilerParameters` parameter contains properties that determine compilation behavior. The `linePragmasTable` parameter contains a dictionary of line pragmas. + ]]> @@ -626,11 +626,11 @@ Gets the directories with files that, when changed, cause the application domain to shut down. A array containing the top-level directory names. - @@ -659,11 +659,11 @@ Gets a collection of browser elements. An containing browser elements. - object contains browser names for the keys and objects for the values. The objects each contain the name of the parent browser element, a description, and the depth of the browser element in the tree. - + object contains browser names for the keys and objects for the values. The objects each contain the name of the parent browser element, a description, and the depth of the browser element in the tree. + ]]> @@ -701,11 +701,11 @@ When this method returns, contains the directory for files generated from non-code files. Gets information about the compiler type, compiler parameters, and the directory in which to store code files generated from non-code files such as .wsdl files. - method retrieves information needed to build a code directory. It returns this information through three `out` parameters. The `codeDomProviderType` parameter returns the provider type for generating and compiling the files in the code directory. The `compilerParameters` parameter contains properties that determine compilation behavior. The `generatedFilesDir` parameter stores the directory path containing all the code files generated from non-code files in the code directory, such as .wsdl files. - + method retrieves information needed to build a code directory. It returns this information through three `out` parameters. The `codeDomProviderType` parameter returns the provider type for generating and compiling the files in the code directory. The `compilerParameters` parameter contains properties that determine compilation behavior. The `generatedFilesDir` parameter stores the directory path containing all the code files generated from non-code files in the code directory, such as .wsdl files. + ]]> @@ -925,11 +925,11 @@ Gives the application domain an infinite lifetime by preventing a lease from being created. Always . - method in its base class. It always returns `null` and thereby prevents a lease from being created that would limit the application domain's lifetime. - + method in its base class. It always returns `null` and thereby prevents a lease from being created that would limit the application domain's lifetime. + ]]> @@ -1005,17 +1005,17 @@ Precompiles an ASP.NET application. - constructor. The object of the constructor defines which of the three forms of precompilation to perform. - - A developer can precompile a Web site with the `aspnet_compiler` command-line tool or by calling the method. - + constructor. The object of the constructor defines which of the three forms of precompilation to perform. + + A developer can precompile a Web site with the `aspnet_compiler` command-line tool or by calling the method. + ]]> @@ -1048,17 +1048,17 @@ Precompiles an ASP.NET application. - constructor. The object of the constructor defines which of the three forms of precompilation to perform. - - A developer can precompile a Web site with the `aspnet_compiler` command-line tool or by calling the method. - + constructor. The object of the constructor defines which of the three forms of precompilation to perform. + + A developer can precompile a Web site with the `aspnet_compiler` command-line tool or by calling the method. + ]]> @@ -1094,17 +1094,17 @@ A containing the method to call when reporting the result of compilation. Precompiles an ASP.NET application and provides a callback method to receive status information about the build. - constructor. The object of the constructor defines which of the three forms of precompilation to perform. - - A developer can precompile a Web site with the `aspnet_compiler` command-line tool or by calling the method. - + constructor. The object of the constructor defines which of the three forms of precompilation to perform. + + A developer can precompile a Web site with the `aspnet_compiler` command-line tool or by calling the method. + ]]> @@ -1138,17 +1138,17 @@ to perform a clean build, which will first delete all object and intermediate files; to rebuild only those files that have changed. Set to true if there is a chance that a dependency might not be picked up by the build environment. Precompiles an ASP.NET application, provides a callback method to receive status information about the build, and indicates whether to create a clean build. - constructor. The object of the constructor defines which of the three forms of precompilation to perform. - - A developer can precompile a Web site with the `aspnet_compiler` command-line tool or by calling the method. - + constructor. The object of the constructor defines which of the three forms of precompilation to perform. + + A developer can precompile a Web site with the `aspnet_compiler` command-line tool or by calling the method. + ]]> diff --git a/xml/System.Web.Compilation/ClientBuildManagerCallback.xml b/xml/System.Web.Compilation/ClientBuildManagerCallback.xml index 60db0751164..f8aaa9427a1 100644 --- a/xml/System.Web.Compilation/ClientBuildManagerCallback.xml +++ b/xml/System.Web.Compilation/ClientBuildManagerCallback.xml @@ -17,11 +17,11 @@ Receives status information about a build from the object. - object can be passed to the object through the method. When an error is encountered during an application build, the error is passed as an argument to either the or the method, depending on the type of error. When you create a class that derives from the class, you can implement these methods and retrieve the error. - + object can be passed to the object through the method. When an error is encountered during an application build, the error is passed as an argument to either the or the method, depending on the type of error. When you create a class that derives from the class, you can implement these methods and retrieve the error. + ]]> diff --git a/xml/System.Web.Compilation/ClientBuildManagerParameter.xml b/xml/System.Web.Compilation/ClientBuildManagerParameter.xml index fe266b99814..3c51d97c447 100644 --- a/xml/System.Web.Compilation/ClientBuildManagerParameter.xml +++ b/xml/System.Web.Compilation/ClientBuildManagerParameter.xml @@ -28,11 +28,11 @@ ## Remarks ASP.NET Web pages and code files can be precompiled to facilitate a faster response for users and allow for the deployment of the site without deploying the source code. For more information on precompiling an ASP.NET Web site, see [ASP.NET Web Site Project Precompilation Overview](https://learn.microsoft.com/previous-versions/aspnet/bb398860(v=vs.100)). - The class stores values that are used during precompilation. The property determines how the assembly will be built. For example, you can set to to recompile any previously compiled components, or set it to to permit the resulting assembly to overwrite any components in the target directory. The enumerator has a attribute that allows a bitwise combination of its member values. The property can contain more than one value from the enumeration to specify a combination of precompilation behaviors. + The class stores values that are used during precompilation. The property determines how the assembly will be built. For example, you can set to to recompile any previously compiled components, or set it to to permit the resulting assembly to overwrite any components in the target directory. The enumerator has a attribute that allows a bitwise combination of its member values. The property can contain more than one value from the enumeration to specify a combination of precompilation behaviors. Either the property or the property is assigned a value to create a strong-named assembly. Both values do not need to be set to create a strong-named assembly. - A object is passed to the object through the constructor. + A object is passed to the object through the constructor. @@ -74,7 +74,7 @@ , , and properties after the object has been created. + This constructor does not initialize any property values. Those values must be set through the , , and properties after the object has been created. @@ -142,7 +142,7 @@ property determines how the assembly will be built. For example, you can set to to recompile any previously compiled components, or set it to to permit the resulting assembly to overwrite any components in the target directory. The enumerator has a attribute that allows a bitwise combination of its member values. The property can contain more than one value from the enumeration to specify a combination of precompilation behaviors. + The property determines how the assembly will be built. For example, you can set to to recompile any previously compiled components, or set it to to permit the resulting assembly to overwrite any components in the target directory. The enumerator has a attribute that allows a bitwise combination of its member values. The property can contain more than one value from the enumeration to specify a combination of precompilation behaviors. diff --git a/xml/System.Web.Compilation/CompilerType.xml b/xml/System.Web.Compilation/CompilerType.xml index 15728db9bad..5eb7eb41d3d 100644 --- a/xml/System.Web.Compilation/CompilerType.xml +++ b/xml/System.Web.Compilation/CompilerType.xml @@ -22,16 +22,16 @@ ## Remarks Use the property of a implementation to examine the settings used to generate and compile source code from a virtual path for that build provider. - The ASP.NET build environment uses objects to generate source code for custom file types within the project. Classes derived from provide build details for source files, Web pages, resources, and other custom items. When the build provider requires a specific programming language, it overrides the property and calls the method to return a object for the supported programming language. + The ASP.NET build environment uses objects to generate source code for custom file types within the project. Classes derived from provide build details for source files, Web pages, resources, and other custom items. When the build provider requires a specific programming language, it overrides the property and calls the method to return a object for the supported programming language. - To set the object within a build provider implementation, use the method or the method. + To set the object within a build provider implementation, use the method or the method. The property specifies the implementation used to generate and compile source code for a build provider. The property defines the settings used to compile the source code into an assembly. ## Examples - The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. + The following code example illustrates a simple build provider implementation, inheriting from the abstract base class. The build provider overrides the , , and members of the base class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation_SampleBuildProvider/CS/samplebuildprovider.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation_SampleBuildProvider/VB/samplebuildprovider.vb" id="Snippet2"::: @@ -74,7 +74,7 @@ ## Remarks The property specifies the implementation used to generate and compile source code for a build provider. - For example, if the build provider is configured to use the Visual Basic code provider in the .NET Framework, returns a for the class. + For example, if the build provider is configured to use the Visual Basic code provider in the .NET Framework, returns a for the class. ]]> @@ -146,9 +146,9 @@ method overrides the method. + The method overrides the method. - compares two instances based on their , , , and properties. + compares two instances based on their , , , and properties. ]]> @@ -180,9 +180,9 @@ method overrides the method. + The method overrides the method. - generates the same hash code for two objects that are equal according to the method. + generates the same hash code for two objects that are equal according to the method. ]]> diff --git a/xml/System.Web.Compilation/ConnectionStringsExpressionBuilder.xml b/xml/System.Web.Compilation/ConnectionStringsExpressionBuilder.xml index 75a7df43ddf..eec89ab6b22 100644 --- a/xml/System.Web.Compilation/ConnectionStringsExpressionBuilder.xml +++ b/xml/System.Web.Compilation/ConnectionStringsExpressionBuilder.xml @@ -147,7 +147,7 @@ ` is encountered in a page that is not compiled. It retrieves the appropriate value from the `` section of the Web.config file. This method overrides the method by calling the method if a connection string is included in the `parsedData` parameter, or by calling the method if a connection string is not included in the `parsedData` parameter. + This method is called when an expression of the form `<%$ ConnectionStrings: secureConnectionString %>` is encountered in a page that is not compiled. It retrieves the appropriate value from the `` section of the Web.config file. This method overrides the method by calling the method if a connection string is included in the `parsedData` parameter, or by calling the method if a connection string is not included in the `parsedData` parameter. ]]> @@ -223,7 +223,7 @@ property returns a collection of connection string values. The method returns the value from this collection that is associated with the connection string name. + The property returns a collection of connection string values. The method returns the value from this collection that is associated with the connection string name. ]]> @@ -260,7 +260,7 @@ property returns a collection of connection string values. The method returns the provider for the value from this collection that is associated with the connection string name. + The property returns a collection of connection string values. The method returns the provider for the value from this collection that is associated with the connection string name. ]]> @@ -301,7 +301,7 @@ is of the type . This object can be passed to both the method and the method as `parsedData`. The object contains the name and value of the connection string. + The returned is of the type . This object can be passed to both the method and the method as `parsedData`. The object contains the name and value of the connection string. ]]> @@ -333,7 +333,7 @@ property indicates whether the method has been implemented in the class. must be implemented within an expression builder for an expression to be evaluated in a page that is not compiled. supports no-compile evaluation of connection strings, so `true` is always returned. + The property indicates whether the method has been implemented in the class. must be implemented within an expression builder for an expression to be evaluated in a page that is not compiled. supports no-compile evaluation of connection strings, so `true` is always returned. ]]> diff --git a/xml/System.Web.Compilation/ExpressionBuilder.xml b/xml/System.Web.Compilation/ExpressionBuilder.xml index 9af763b5b26..c1415ff0336 100644 --- a/xml/System.Web.Compilation/ExpressionBuilder.xml +++ b/xml/System.Web.Compilation/ExpressionBuilder.xml @@ -24,11 +24,11 @@ Expression builders parse declarative expressions and create code to retrieve values bound to a control property. In no-compile scenarios, an expression builder that supports a no-compile feature evaluates the expression during run time. - When the page parser encounters an expression that is delimited with the string `<%$ %>`, it creates an expression builder for the expression based on the prefix in the string. The prefix is the portion of the string that is to the left of the colon (:). For example, when the parser encounters the string `<%$ ConnectionStrings:MessageDB %>`, it creates a object. Prefixes are associated with expression builders in the Web.config file in the section. + When the page parser encounters an expression that is delimited with the string `<%$ %>`, it creates an expression builder for the expression based on the prefix in the string. The prefix is the portion of the string that is to the left of the colon (:). For example, when the parser encounters the string `<%$ ConnectionStrings:MessageDB %>`, it creates a object. Prefixes are associated with expression builders in the Web.config file in the section. - The right side of the declarative expression is passed to the expression builder for evaluation. Override the method to generate code that will be compiled with the page. + The right side of the declarative expression is passed to the expression builder for evaluation. Override the method to generate code that will be compiled with the page. - If you want the custom expression builder to be active on pages that are not compiled, you must also override the method to return an object that represents the results of the expression. You also must override the property to indicate that the custom expression builder does support no-compile pages. + If you want the custom expression builder to be active on pages that are not compiled, you must also override the method to return an object that represents the results of the expression. You also must override the property to indicate that the custom expression builder does support no-compile pages. You can define a set of properties and methods for selecting and evaluating an expression that is associated with a control property at design time by implementing an expression editor. The editor is marked on the expression builder through class-level metadata. For more information, see . @@ -99,7 +99,7 @@ Text="<%$ MyCustomExpression:Hello, world! %>" /> class is abstract, you cannot create an instance of directly by using the constructor. + Because the class is abstract, you cannot create an instance of directly by using the constructor. ]]> @@ -146,12 +146,12 @@ Text="<%$ MyCustomExpression:Hello, world! %>" /> object to be active on a page that supports the no-compile feature, you can override the method and the property. The method should return the evaluation of the current expression. + If you want your object to be active on a page that supports the no-compile feature, you can override the method and the property. The method should return the evaluation of the current expression. ## Examples - The following code example demonstrates how to use the overridden method to return an evaluated expression. + The following code example demonstrates how to use the overridden method to return an evaluated expression. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.ExpressionBuilder/CS/MyExpressionBuilder.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ExpressionBuilder/VB/MyExpressionBuilder.vb" id="Snippet3"::: @@ -194,12 +194,12 @@ Text="<%$ MyCustomExpression:Hello, world! %>" /> class must implement the abstract method. + Classes that inherit from the class must implement the abstract method. ## Examples - The following code example demonstrates how to return a object by overriding the method. + The following code example demonstrates how to return a object by overriding the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.ExpressionBuilder/CS/MyExpressionBuilder.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ExpressionBuilder/VB/MyExpressionBuilder.vb" id="Snippet4"::: @@ -242,7 +242,7 @@ Text="<%$ MyCustomExpression:Hello, world! %>" /> or method. + When overridden in a derived class, this method parses the expression and returns it as an object that can be used as the `parsedData` parameter in a or method. ]]> @@ -272,7 +272,7 @@ Text="<%$ MyCustomExpression:Hello, world! %>" /> property is `false`. To support no-compile pages, you must override both the method and the property. + The default value for the property is `false`. To support no-compile pages, you must override both the method and the property. diff --git a/xml/System.Web.Compilation/ExpressionEditorAttribute.xml b/xml/System.Web.Compilation/ExpressionEditorAttribute.xml index ce096ed67ef..12ce3dfbf83 100644 --- a/xml/System.Web.Compilation/ExpressionEditorAttribute.xml +++ b/xml/System.Web.Compilation/ExpressionEditorAttribute.xml @@ -51,7 +51,7 @@ constructor to initialize an empty instance of the class. To initialize the class using a type object, use the constructor. To initialize the class using a type name, use the constructor. + Use the constructor to initialize an empty instance of the class. To initialize the class using a type object, use the constructor. To initialize the class using a type name, use the constructor. ]]> @@ -80,7 +80,7 @@ constructor to initialize an instance of the class using a type name. To initialize the class using a type object, use the constructor. + Use the constructor to initialize an instance of the class using a type name. To initialize the class using a type object, use the constructor. ]]> @@ -111,7 +111,7 @@ constructor to initialize an instance of the class using a type object. To initialize the class using a type name, use the constructor. + Use the constructor to initialize an instance of the class using a type object. To initialize the class using a type name, use the constructor. ]]> diff --git a/xml/System.Web.Compilation/ExpressionPrefixAttribute.xml b/xml/System.Web.Compilation/ExpressionPrefixAttribute.xml index 4a79409b39b..62299a24ea7 100644 --- a/xml/System.Web.Compilation/ExpressionPrefixAttribute.xml +++ b/xml/System.Web.Compilation/ExpressionPrefixAttribute.xml @@ -94,7 +94,7 @@ Text="<%$ MyCustomExpression:Hello, world! %>" /> constructor to initialize an instance of the class using a prefix identifier. The is the parameterless constructor for the class. + Use the constructor to initialize an instance of the class using a prefix identifier. The is the parameterless constructor for the class. ]]> diff --git a/xml/System.Web.Compilation/IAssemblyPostProcessor.xml b/xml/System.Web.Compilation/IAssemblyPostProcessor.xml index 36ec5a52b46..e47178d71a2 100644 --- a/xml/System.Web.Compilation/IAssemblyPostProcessor.xml +++ b/xml/System.Web.Compilation/IAssemblyPostProcessor.xml @@ -18,31 +18,31 @@ Defines the method a class implements to process an assembly after the assembly has been built. - class compiles assemblies and then checks to see whether an interface has been registered in the Web configuration file. If so, the instance calls the method for the interface to perform any action after the compilation and before loading the assembly. For example, a profiler tool could implement this interface to establish probes in the assembly. - - When an interface is registered, the ASP.NET application and its assemblies will always be compiled in debug mode. - - - -## Examples - The following code example demonstrates how to create an implementation of the interface, and register it in the Web.config file of a Web application. - - The first part of the code example creates a class named `Samples.Process.postProcessTest` that implements the interface. This class performs the simple action of writing a file when the method is called. - + class compiles assemblies and then checks to see whether an interface has been registered in the Web configuration file. If so, the instance calls the method for the interface to perform any action after the compilation and before loading the assembly. For example, a profiler tool could implement this interface to establish probes in the assembly. + + When an interface is registered, the ASP.NET application and its assemblies will always be compiled in debug mode. + + + +## Examples + The following code example demonstrates how to create an implementation of the interface, and register it in the Web.config file of a Web application. + + The first part of the code example creates a class named `Samples.Process.postProcessTest` that implements the interface. This class performs the simple action of writing a file when the method is called. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.IAssemblyPostProcessor/CS/postProcessTest.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.IAssemblyPostProcessor/VB/postProcessTest.vb" id="Snippet1"::: - - Compile the class into a .dll file with the command `csc /target:library postProcessTest.cs`. Add the resulting .dll file to the Bin folder of an ASP.NET application and register the .dll in the Web.config file, as shown in the following code. - -``` - -``` - - When a user visits the Web site, the Web application is dynamically compiled and the file MyTest.txt will be written to C:\compile. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.IAssemblyPostProcessor/VB/postProcessTest.vb" id="Snippet1"::: + + Compile the class into a .dll file with the command `csc /target:library postProcessTest.cs`. Add the resulting .dll file to the Bin folder of an ASP.NET application and register the .dll in the Web.config file, as shown in the following code. + +``` + +``` + + When a user visits the Web site, the Web application is dynamically compiled and the file MyTest.txt will be written to C:\compile. + ]]> @@ -70,29 +70,29 @@ The path to the assembly. Called before the assembly is loaded to allow the implementing class to modify the assembly. - class calls this method after the assembly has been compiled. Any actions to be taken before loading the assembly should be included in this method. - - - -## Examples - The following code example demonstrates how to create an implementation of the interface, and register it in the Web.config file of a Web application. - - The first part of the code example creates a class named `Samples.Process.postProcessTest` that implements the interface. This class performs the simple action of writing a file when the method is called. - + class calls this method after the assembly has been compiled. Any actions to be taken before loading the assembly should be included in this method. + + + +## Examples + The following code example demonstrates how to create an implementation of the interface, and register it in the Web.config file of a Web application. + + The first part of the code example creates a class named `Samples.Process.postProcessTest` that implements the interface. This class performs the simple action of writing a file when the method is called. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.IAssemblyPostProcessor/CS/postProcessTest.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.IAssemblyPostProcessor/VB/postProcessTest.vb" id="Snippet1"::: - - Compile the class into a .dll file with the command `csc /target:library postProcessTest.cs`. Add the resulting .dll file to the Bin folder of an ASP.NET application and register the .dll in the Web.config file, as shown in the following code. - -``` - -``` - - When a user visits the Web site, the Web application is dynamically compiled and the file MyTest.txt will be written to C:\compile. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.IAssemblyPostProcessor/VB/postProcessTest.vb" id="Snippet1"::: + + Compile the class into a .dll file with the command `csc /target:library postProcessTest.cs`. Add the resulting .dll file to the Bin folder of an ASP.NET application and register the .dll in the Web.config file, as shown in the following code. + +``` + +``` + + When a user visits the Web site, the Web application is dynamically compiled and the file MyTest.txt will be written to C:\compile. + ]]> diff --git a/xml/System.Web.Compilation/IImplicitResourceProvider.xml b/xml/System.Web.Compilation/IImplicitResourceProvider.xml index 2e786eacee3..ee520ec3f9b 100644 --- a/xml/System.Web.Compilation/IImplicitResourceProvider.xml +++ b/xml/System.Web.Compilation/IImplicitResourceProvider.xml @@ -14,15 +14,15 @@ Defines methods a class implements to act as an implicit resource provider. - interface defines the methods a resource provider implements to access implicit resources. You can obtain a particular value using the method. - - If you create a custom resource provider, you do not need to provide customized support for implicit resource localization. Implicit localization will work with your resource provider. - + interface defines the methods a resource provider implements to access implicit resources. You can obtain a particular value using the method. + + If you create a custom resource provider, you do not need to provide customized support for implicit resource localization. Implicit localization will work with your resource provider. + ]]> @@ -54,11 +54,11 @@ Gets a collection of implicit resource keys as specified by the prefix. An of implicit resource keys. - @@ -92,11 +92,11 @@ Gets an object representing the value of the specified resource key. An representing the localized value of an implicit resource key. - diff --git a/xml/System.Web.Compilation/IResourceProvider.xml b/xml/System.Web.Compilation/IResourceProvider.xml index 2b5f6a40b5e..90a6b0f7364 100644 --- a/xml/System.Web.Compilation/IResourceProvider.xml +++ b/xml/System.Web.Compilation/IResourceProvider.xml @@ -60,12 +60,12 @@ method returns the localized value for a resource key based on the current culture. The implementing class could retrieve the property if a value for the `culture` parameter is not passed in. + When implemented, the method returns the localized value for a resource key based on the current culture. The implementing class could retrieve the property if a value for the `culture` parameter is not passed in. ## Examples - The following code example shows a customized resource provider factory that retrieves cached values. The resource provider factory creates an instance of a customized resource provider that implements . The resource provider includes a customized method. + The following code example shows a customized resource provider factory that retrieves cached values. The resource provider factory creates an instance of a customized resource provider that implements . The resource provider includes a customized method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/CS/source.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/VB/source.vb" id="Snippet2"::: diff --git a/xml/System.Web.Compilation/ImplicitResourceKey.xml b/xml/System.Web.Compilation/ImplicitResourceKey.xml index a1567a90acd..c0e7d0c0aed 100644 --- a/xml/System.Web.Compilation/ImplicitResourceKey.xml +++ b/xml/System.Web.Compilation/ImplicitResourceKey.xml @@ -158,7 +158,7 @@ forecolor="blue"/> ``` - This resource contains three keys that potentially have localized resource values to retrieve from the resource file or source code. One of these keys is `Ie:Welcome.Text`, in which "Ie" is the value. + This resource contains three keys that potentially have localized resource values to retrieve from the resource file or source code. One of these keys is `Ie:Welcome.Text`, in which "Ie" is the value. ]]> @@ -208,7 +208,7 @@ forecolor="blue"/> ``` - This resource contains three keys, `Welcome.Text`, `Ie:Welcome.Text`, and `Welcome.Forecolor`, that potentially have localized resource values to retrieve from the resource file or source code. Each key has `"Welcome"` as the value. + This resource contains three keys, `Welcome.Text`, `Ie:Welcome.Text`, and `Welcome.Forecolor`, that potentially have localized resource values to retrieve from the resource file or source code. Each key has `"Welcome"` as the value. ]]> @@ -258,7 +258,7 @@ forecolor="blue"/> ``` - This resource contains three keys, `Welcome.Text`, `Ie:Welcome.Text`, and `Welcome.Forecolor`, that potentially have localized resource values to retrieve from the resource file or source code. Those keys have values of `"Text"`, `"Text"`, and `"Forecolor"`, respectively. + This resource contains three keys, `Welcome.Text`, `Ie:Welcome.Text`, and `Welcome.Forecolor`, that potentially have localized resource values to retrieve from the resource file or source code. Those keys have values of `"Text"`, `"Text"`, and `"Forecolor"`, respectively. ]]> diff --git a/xml/System.Web.Compilation/ResourceExpressionBuilder.xml b/xml/System.Web.Compilation/ResourceExpressionBuilder.xml index 006a07044be..f67db458ba0 100644 --- a/xml/System.Web.Compilation/ResourceExpressionBuilder.xml +++ b/xml/System.Web.Compilation/ResourceExpressionBuilder.xml @@ -214,7 +214,7 @@ and a property value in the returned object, if these properties are provided in the expression. + This method parses the expression and returns a and a property value in the returned object, if these properties are provided in the expression. ]]> @@ -252,7 +252,7 @@ is of type . This method parses the expression and returns a and a property value in the returned object, if those properties are provided in the expression. + The returned is of type . This method parses the expression and returns a and a property value in the returned object, if those properties are provided in the expression. ]]> @@ -284,7 +284,7 @@ property indicates whether the method has been implemented in the class. must be implemented within an expression builder for an expression to be evaluated in a page that uses the no-compile feature. supports evaluation of resource values in non-compiled pages, so this property always returns `true`. + The property indicates whether the method has been implemented in the class. must be implemented within an expression builder for an expression to be evaluated in a page that uses the no-compile feature. supports evaluation of resource values in non-compiled pages, so this property always returns `true`. ]]> diff --git a/xml/System.Web.Compilation/ResourceExpressionFields.xml b/xml/System.Web.Compilation/ResourceExpressionFields.xml index e3cf66b27af..040c22227ab 100644 --- a/xml/System.Web.Compilation/ResourceExpressionFields.xml +++ b/xml/System.Web.Compilation/ResourceExpressionFields.xml @@ -20,13 +20,13 @@ class. This object contains two fields, and . These fields are drawn from the values of a resource expression in either the explicit (`<%$ Resources: ClassKey, ResourceKey %>`) or implicit (`meta:resourcekey="ResourceKey"`) form. + When a page is parsed, the values contained in a resource expression are parsed and stored in an instance of the class. This object contains two fields, and . These fields are drawn from the values of a resource expression in either the explicit (`<%$ Resources: ClassKey, ResourceKey %>`) or implicit (`meta:resourcekey="ResourceKey"`) form. The property identifies the class name of a resource that is mapped to a resource file. For example, to reference a resource file named Financial.resx, or a localized version such as Financial.en-GB.resx, the resource expression would appear as `<%$ Resources: Financial, ResourceKey %>`. After parsing, the property would return "Financial" as its value. The property identifies the particular key/value pair to be retrieved from the file. If the Financial.resx file contains a key called `Currency`, that value could be specified with the resource expression `<%$ Resources: Financial, Currency %>`. After parsing, the property would return "Currency" as its value. - The resource expression is parsed through the method. + The resource expression is parsed through the method. > [!CAUTION] > Sensitive information should not be stored in a resource file. diff --git a/xml/System.Web.Compilation/ResourceProviderFactory.xml b/xml/System.Web.Compilation/ResourceProviderFactory.xml index 486598b149c..edee5a40c1a 100644 --- a/xml/System.Web.Compilation/ResourceProviderFactory.xml +++ b/xml/System.Web.Compilation/ResourceProviderFactory.xml @@ -17,19 +17,19 @@ Serves as the base class for classes that create resource providers. - is an abstract class that serves as the base class for objects that return global and local resource providers. Classes must derive from to implement its functionality. - - - -## Examples - The following code example shows a customized resource provider factory that retrieves cached values. - + is an abstract class that serves as the base class for objects that return global and local resource providers. Classes must derive from to implement its functionality. + + + +## Examples + The following code example shows a customized resource provider factory that retrieves cached values. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/CS/source.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/VB/source.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/VB/source.vb" id="Snippet2"::: + ]]> @@ -57,11 +57,11 @@ When implemented in a derived class, initializes a new instance of the derived class. - can implement a constructor to set any default values. - + can implement a constructor to set any default values. + ]]> @@ -90,19 +90,19 @@ When overridden in a derived class, creates a global resource provider. A global resource provider. - object for the given `classKey` parameter. The method could be implemented such that `classKey` is the name of a .resx file in the App_GlobalResources folder. - - - -## Examples - The following code example shows a customized resource provider factory that implements the method and retrieves cached values. - + object for the given `classKey` parameter. The method could be implemented such that `classKey` is the name of a .resx file in the App_GlobalResources folder. + + + +## Examples + The following code example shows a customized resource provider factory that implements the method and retrieves cached values. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/CS/source.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/VB/source.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/VB/source.vb" id="Snippet2"::: + ]]> @@ -132,19 +132,19 @@ When overridden in a derived class, creates a local resource provider. A local resource provider. - object for the given `virtualPath` parameter. The method could be implemented such that `virtualPath` maps to a resource file. - - - -## Examples - The following code example shows a customized resource provider factory that implements the method and retrieves cached values. - + object for the given `virtualPath` parameter. The method could be implemented such that `virtualPath` maps to a resource file. + + + +## Examples + The following code example shows a customized resource provider factory that implements the method and retrieves cached values. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/CS/source.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/VB/source.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Compilation.ResourceProviderFactory/VB/source.vb" id="Snippet2"::: + ]]> diff --git a/xml/System.Web.Compilation/RouteUrlExpressionBuilder.xml b/xml/System.Web.Compilation/RouteUrlExpressionBuilder.xml index 406720dab25..fd0e7981b8f 100644 --- a/xml/System.Web.Compilation/RouteUrlExpressionBuilder.xml +++ b/xml/System.Web.Compilation/RouteUrlExpressionBuilder.xml @@ -124,7 +124,7 @@ `<%$ RouteUrl: urlparameter=value %>` - This method generates the appropriate URL for the specified route-key values for the current object. This method overrides the method. It gets from the `entry` parameter a reference to the control to which the expression is bound, it gets from the `context` parameter the expression to be evaluated, and it calls the method to generate the URL. + This method generates the appropriate URL for the specified route-key values for the current object. This method overrides the method. It gets from the `entry` parameter a reference to the control to which the expression is bound, it gets from the `context` parameter the expression to be evaluated, and it calls the method to generate the URL. ]]> @@ -201,7 +201,7 @@ method of the object. It gets the object from the `control` parameter, and it parses the route name and route parameters from the `expression` parameter. + This method generates the appropriate value for the URL by calling the method of the object. It gets the object from the `control` parameter, and it parses the route name and route parameters from the `expression` parameter. ]]> @@ -234,7 +234,7 @@ property indicates whether the method has been implemented in the class and can return a value for the expression in a page that is not compiled. The class can evaluate an expression in a page that is not compiled. Therefore, the property always returns `true`. + The property indicates whether the method has been implemented in the class and can return a value for the expression in a page that is not compiled. The class can evaluate an expression in a page that is not compiled. Therefore, the property always returns `true`. ]]> @@ -274,9 +274,9 @@ method strips leading and trailing spaces from the expression, and then splits it into key/value pairs by using commas as delimiters. If the route key named `RouteName` is found, that value is passed back in the `routeName` parameter and not in `routeValues`. Otherwise, `null` is returned for `routeName`. Leading and trailing spaces are also stripped from individual keys and values. + The method strips leading and trailing spaces from the expression, and then splits it into key/value pairs by using commas as delimiters. If the route key named `RouteName` is found, that value is passed back in the `routeName` parameter and not in `routeValues`. Otherwise, `null` is returned for `routeName`. Leading and trailing spaces are also stripped from individual keys and values. - The method returns `false` if the expression is not composed of at least one key/value pair that is in the format *key*`=`*value*, and that uses commas to separate multiple pairs. + The method returns `false` if the expression is not composed of at least one key/value pair that is in the format *key*`=`*value*, and that uses commas to separate multiple pairs. ]]> diff --git a/xml/System.Web.Compilation/RouteValueExpressionBuilder.xml b/xml/System.Web.Compilation/RouteValueExpressionBuilder.xml index f5c58014b4d..1daf939de9f 100644 --- a/xml/System.Web.Compilation/RouteValueExpressionBuilder.xml +++ b/xml/System.Web.Compilation/RouteValueExpressionBuilder.xml @@ -109,7 +109,7 @@ ` is encountered in a no-compile page. This method overrides the method by calling the method. It gets the object from the `context` parameter, and it gets the expression, the control type, and the property name from the `entry` parameter. + ASP.NET calls this method when an expression of the form `<%$ RouteValue:urlparameter %>` is encountered in a no-compile page. This method overrides the method by calling the method. It gets the object from the `context` parameter, and it gets the expression, the control type, and the property name from the `entry` parameter. ]]> @@ -220,7 +220,7 @@ property indicates whether the method has been implemented in the class in order to return a value for the expression in a page that is not compiled. The class can evaluate an expression in a page that is not compiled. Therefore, it always returns `true`. + The property indicates whether the method has been implemented in the class in order to return a value for the expression in a page that is not compiled. The class can evaluate an expression in a page that is not compiled. Therefore, it always returns `true`. ]]> diff --git a/xml/System.Web.Configuration/AnonymousIdentificationSection.xml b/xml/System.Web.Configuration/AnonymousIdentificationSection.xml index 6821415d58f..252fb06fe2b 100644 --- a/xml/System.Web.Configuration/AnonymousIdentificationSection.xml +++ b/xml/System.Web.Configuration/AnonymousIdentificationSection.xml @@ -68,7 +68,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -286,10 +286,10 @@ is `true`, a compliant browser does not return the cookie unless the connection is over SSL. + If is `true`, a compliant browser does not return the cookie unless the connection is over SSL. > [!NOTE] -> When the anonymous identifier is stored within the URI path, rather than in a cookie, the setting does not affect the behavior of the anonymous identification module. This is consistent with the behavior in forms authentication. +> When the anonymous identifier is stored within the URI path, rather than in a cookie, the setting does not affect the behavior of the anonymous identification module. This is consistent with the behavior in forms authentication. @@ -386,7 +386,7 @@ When value is limited to a maximum value of two years. + This property can be set to an arbitrarily large value, but internally the value is limited to a maximum value of two years. @@ -481,7 +481,7 @@ When is set to `true`, a cookie is used to manage the user's state information. + If is set to `true`, a cookie is used to manage the user's state information. diff --git a/xml/System.Web.Configuration/AssemblyCollection.xml b/xml/System.Web.Configuration/AssemblyCollection.xml index ca7da4ae58f..7d0770c6edf 100644 --- a/xml/System.Web.Configuration/AssemblyCollection.xml +++ b/xml/System.Web.Configuration/AssemblyCollection.xml @@ -23,55 +23,55 @@ Represents a collection of objects. This class cannot be inherited. - class does not refer to any actual element in the underlying configuration file. It is a construct that allows access to the assembly information it contains. - - - -## Examples - This section provides two code examples. The first demonstrates how to declaratively specify values for several properties of the class. The second demonstrates how to use members of the class. - - The following configuration file example shows how to declaratively specify values for several properties of the class. - -``` - - - - - - - - - - - - - - - - - - -``` - - The following code example demonstrates how to use members of the class. - + class does not refer to any actual element in the underlying configuration file. It is a construct that allows access to the assembly information it contains. + + + +## Examples + This section provides two code examples. The first demonstrates how to declaratively specify values for several properties of the class. The second demonstrates how to use members of the class. + + The following configuration file example shows how to declaratively specify values for several properties of the class. + +``` + + + + + + + + + + + + + + + + + + +``` + + The following code example demonstrates how to use members of the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/CS/AssemblyCollection.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/VB/AssemblyCollection.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/VB/AssemblyCollection.vb" id="Snippet1"::: + ]]> @@ -126,19 +126,19 @@ A string value specifying the assembly reference. Adds an object to the collection. - object to the collection. If the assembly object is not initialized with assembly information, an exception is thrown. If the assembly object already exists in the collection, the statement is ignored. - - - -## Examples - The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. - + object to the collection. If the assembly object is not initialized with assembly information, an exception is thrown. If the assembly object already exists in the collection, the statement is ignored. + + + +## Examples + The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/CS/AssemblyCollection.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/VB/AssemblyCollection.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/VB/AssemblyCollection.vb" id="Snippet4"::: + ]]> @@ -317,19 +317,19 @@ A string value specifying the assembly reference. Removes a object from the collection. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/CS/AssemblyCollection.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/VB/AssemblyCollection.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/VB/AssemblyCollection.vb" id="Snippet5"::: + ]]> @@ -357,19 +357,19 @@ An integer value specifying an object within the collection. Removes an object from the collection. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/CS/AssemblyCollection.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/VB/AssemblyCollection.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AssemblyCollection/VB/AssemblyCollection.vb" id="Snippet6"::: + ]]> diff --git a/xml/System.Web.Configuration/AuthenticationSection.xml b/xml/System.Web.Configuration/AuthenticationSection.xml index 8273ff6a2dc..8f9a7c08c13 100644 --- a/xml/System.Web.Configuration/AuthenticationSection.xml +++ b/xml/System.Web.Configuration/AuthenticationSection.xml @@ -23,7 +23,7 @@ The class provides a way to programmatically access and modify the `authentication` section of a configuration file. > [!NOTE] -> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. For safety and scalability, it's recommended that you use an external repository, such as a database, to keep the users' credentials. +> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. For safety and scalability, it's recommended that you use an external repository, such as a database, to keep the users' credentials. ## Examples @@ -66,7 +66,7 @@ This example demonstrates how to use the constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. @@ -109,7 +109,7 @@ This example demonstrates how to use the element property. + The following code example shows how to use the element property. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.AuthenticationSection/CS/authenticationsection.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.AuthenticationSection/VB/authenticationsection.vb" id="Snippet5"::: diff --git a/xml/System.Web.Configuration/AuthorizationRule.xml b/xml/System.Web.Configuration/AuthorizationRule.xml index f040cff0cb9..c9f00042798 100644 --- a/xml/System.Web.Configuration/AuthorizationRule.xml +++ b/xml/System.Web.Configuration/AuthorizationRule.xml @@ -71,7 +71,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. ]]> diff --git a/xml/System.Web.Configuration/AuthorizationRuleCollection.xml b/xml/System.Web.Configuration/AuthorizationRuleCollection.xml index c8c6e86702f..8975c64e002 100644 --- a/xml/System.Web.Configuration/AuthorizationRuleCollection.xml +++ b/xml/System.Web.Configuration/AuthorizationRuleCollection.xml @@ -23,32 +23,32 @@ Represents a collection of objects. This class cannot be inherited. - type allows access to the elements of the `authorization` section collection. - - - -## Examples - The following code example shows how to obtain the object from the configuration file of an existing Web application. You use this object to access its members as shown in the following topics. The configuration file will contain a setup similar to the following. - -``` - - - - -``` - + type allows access to the elements of the `authorization` section collection. + + + +## Examples + The following code example shows how to obtain the object from the configuration file of an existing Web application. You use this object to access its members as shown in the following topics. The configuration file will contain a setup similar to the following. + +``` + + + + +``` + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet1"::: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet2"::: + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet3"::: + ]]> @@ -101,19 +101,19 @@ The object to add to the collection. Adds a object to the collection. - object you are adding. - - - -## Examples - The following code example shows how to use the method. - + object you are adding. + + + +## Examples + The following code example shows how to use the method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet6"::: + ]]> The object already exists in the collection, or the collection is read-only. @@ -140,19 +140,19 @@ Removes all objects from the collection. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet7"::: + ]]> @@ -281,14 +281,14 @@ Gets the at the specified index. The at the specified index. - method. Refer to the code example in the class topic to learn how to get the collection. - + method. Refer to the code example in the class topic to learn how to get the collection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet13"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet13"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet13"::: + ]]> @@ -343,14 +343,14 @@ Gets the collection index of the specified object. The index of the specified object. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet9"::: + ]]> @@ -459,19 +459,19 @@ The object to remove. Removes a object from the collection. - method. Refer to the code example in the class topic to learn how to get the collection. - + method. Refer to the code example in the class topic to learn how to get the collection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet10"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet10"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet10"::: + ]]> The passed object does not exist in the collection, the element has already been removed, or the collection is read-only. @@ -500,19 +500,19 @@ The index location of the to remove. Removes a object from the collection at the specified index. - method. Refer to the code example in the class topic to learn how to get the collection. - + method. Refer to the code example in the class topic to learn how to get the collection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet8"::: + ]]> There is no object with the specified index in the collection, the element has already been removed, or the collection is read-only. @@ -543,14 +543,14 @@ The object to be added. Adds the specified object to the collection at the specified index. - method. - + method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet11"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet11"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet11"::: + ]]> diff --git a/xml/System.Web.Configuration/AuthorizationSection.xml b/xml/System.Web.Configuration/AuthorizationSection.xml index db1d930e0b0..acef4dcf387 100644 --- a/xml/System.Web.Configuration/AuthorizationSection.xml +++ b/xml/System.Web.Configuration/AuthorizationSection.xml @@ -25,7 +25,7 @@ This type is part of a group that includes the , the , and the types. > [!NOTE] -> The can read and write information from and to the related section of the configuration file according to the section property whose value is . +> The can read and write information from and to the related section of the configuration file according to the section property whose value is . @@ -80,7 +80,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -165,12 +165,12 @@ collection returned by this method does not refer to any actual element in the underlying configuration file. It is a construct that allows easy access to the rules it contains. This is a common pattern for handling the elements of a configuration file. + The collection returned by this method does not refer to any actual element in the underlying configuration file. It is a construct that allows easy access to the rules it contains. This is a common pattern for handling the elements of a configuration file. ## Examples - The following code example shows how to use the . + The following code example shows how to use the . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.Authorization/CS/authorization.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.Authorization/VB/authorization.vb" id="Snippet6"::: diff --git a/xml/System.Web.Configuration/BrowserCapabilitiesCodeGenerator.xml b/xml/System.Web.Configuration/BrowserCapabilitiesCodeGenerator.xml index ab73b6eb9be..04a2f3ac651 100644 --- a/xml/System.Web.Configuration/BrowserCapabilitiesCodeGenerator.xml +++ b/xml/System.Web.Configuration/BrowserCapabilitiesCodeGenerator.xml @@ -17,11 +17,11 @@ The class is used internally by the tool to parse .browser browser definition files and add browsers to the run-time collection of known browsers contained in the object. - class, which, at run time, produces request-specific objects to be publicly accessed through the ASP.NET intrinsic `Request.Browser` property. - + class, which, at run time, produces request-specific objects to be publicly accessed through the ASP.NET intrinsic `Request.Browser` property. + ]]> @@ -66,11 +66,11 @@ Used internally to coordinate the behavior of this class. - , which loads and parses the XML contained in a collection of browser-definition files and inserts the information contained therein into an internal collection of browsers. Then it calls an internal method which generates the source code compiles it, and registers it as an assembly in the global assembly cache for the object. If necessary, this method then calls an internal method that restarts the Web server. - + , which loads and parses the XML contained in a collection of browser-definition files and inserts the information contained therein into an internal collection of browsers. Then it calls an internal method which generates the source code compiles it, and registers it as an assembly in the global assembly cache for the object. If necessary, this method then calls an internal method that restarts the Web server. + ]]> @@ -102,10 +102,10 @@ The path to the virtual directory that contains the browser-definition files. The default is . Loads and parses the XML contained in a collection of browser-definition files and inserts the information contained therein into an internal collection of browsers. To be added. - One of the browser-definition files does not have a root element named "browsers". - + One of the browser-definition files does not have a root element named "browsers". + -or- - + One of the browser-definition files fails to load. @@ -132,11 +132,11 @@ if the browser capabilities factory was uninstalled from the global assembly cache; otherwise, . - diff --git a/xml/System.Web.Configuration/BrowserCapabilitiesFactoryBase.xml b/xml/System.Web.Configuration/BrowserCapabilitiesFactoryBase.xml index 00bf610edcd..8bcba5150ea 100644 --- a/xml/System.Web.Configuration/BrowserCapabilitiesFactoryBase.xml +++ b/xml/System.Web.Configuration/BrowserCapabilitiesFactoryBase.xml @@ -17,11 +17,11 @@ The class is the base class from which is derived. It is used internally at run time by the configuration system to create request-specific instances of the class, publicly accessed through the ASP.NET intrinsic property. - @@ -130,11 +130,11 @@ An object that specifies the capabilities of the browser. Used internally at run time to configure custom hierarchies of browser capabilities. - method processes a custom hierarchy. The custom hierarchy must contain a `parentID` value in the `browser` element. - + method processes a custom hierarchy. The custom hierarchy must contain a `parentID` value in the `browser` element. + ]]> diff --git a/xml/System.Web.Configuration/BufferModeSettings.xml b/xml/System.Web.Configuration/BufferModeSettings.xml index e47b7e1d0b5..19efc787890 100644 --- a/xml/System.Web.Configuration/BufferModeSettings.xml +++ b/xml/System.Web.Configuration/BufferModeSettings.xml @@ -20,7 +20,7 @@ class is used to define roles for event providers, such as Critical, Notification, Analysis, and Logging. Each role would buffer events differently, as appropriate for that role. For example a Critical role would keep the , , and properties small, whereas an Analysis role would set those properties to higher values. + The class is used to define roles for event providers, such as Critical, Notification, Analysis, and Logging. Each role would buffer events differently, as appropriate for that role. For example a Critical role would keep the , , and properties small, whereas an Analysis role would set those properties to higher values. This class corresponds to the `bufferModes` configuration-file element. @@ -108,7 +108,7 @@ constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet10"::: @@ -185,7 +185,7 @@ ## Remarks This property must have a value greater than zero. Invalid values may cause an exception to be thrown when the configuration section is saved. - The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. + The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. @@ -291,7 +291,7 @@ ## Remarks This property must have a value greater than zero. Invalid values may cause an exception to be thrown when the configuration section is saved. - The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. + The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. @@ -421,7 +421,7 @@ ## Remarks This property must have a value greater than zero. The value can be made infinite by setting it to ticks. Invalid values may cause an exception when the configuration section is saved. - The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. + The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. @@ -471,7 +471,7 @@ ## Remarks This property must have a value greater than zero and less than or equal to the value of the property. Invalid values may cause an exception to be thrown when the configuration section is saved. - The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. + The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. @@ -526,7 +526,7 @@ ## Remarks This property must have a value greater than zero and less than or equal to the value of the property. Invalid values may cause an exception when the configuration section is saved. - The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. + The default value varies based on the provider. The objects in the collection are referred to by name by the providers in the collection. diff --git a/xml/System.Web.Configuration/BufferModesCollection.xml b/xml/System.Web.Configuration/BufferModesCollection.xml index 2233f14d994..12545a76ed7 100644 --- a/xml/System.Web.Configuration/BufferModesCollection.xml +++ b/xml/System.Web.Configuration/BufferModesCollection.xml @@ -26,7 +26,7 @@ object is used to define roles for event providers such as Critical, Notification, Analysis, and Logging. Each role sets buffer mode events differently. For example, a Critical role keeps the , and properties small, whereas an Analysis role sets those properties to higher values. + The object is used to define roles for event providers such as Critical, Notification, Analysis, and Logging. Each role sets buffer mode events differently. For example, a Critical role keeps the , and properties small, whereas an Analysis role sets those properties to higher values. @@ -106,7 +106,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet9"::: @@ -146,7 +146,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet14"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet14"::: @@ -244,7 +244,7 @@ method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet22"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet22"::: @@ -340,7 +340,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet13"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet13"::: diff --git a/xml/System.Web.Configuration/BuildProviderCollection.xml b/xml/System.Web.Configuration/BuildProviderCollection.xml index 1e386913698..4978526232b 100644 --- a/xml/System.Web.Configuration/BuildProviderCollection.xml +++ b/xml/System.Web.Configuration/BuildProviderCollection.xml @@ -23,66 +23,66 @@ Represents a collection of objects. This class cannot be inherited. - is used to compile custom resource files. You can have any number of build providers. The does not refer to any actual element in the underlying configuration file. It is a construct that allows easy access to the compilation information it contains. - - - -## Examples - This section provides two code examples. The first demonstrates how to declaratively specify values for several properties of the class. The second demonstrates how to use members of the class. - - The following configuration file example shows how to declaratively specify values for several properties of the class. - -``` - - - - - - - - - - - - - - - - - - -``` - - The following code example demonstrates how to use members of the class. - + is used to compile custom resource files. You can have any number of build providers. The does not refer to any actual element in the underlying configuration file. It is a construct that allows easy access to the compilation information it contains. + + + +## Examples + This section provides two code examples. The first demonstrates how to declaratively specify values for several properties of the class. The second demonstrates how to use members of the class. + + The following configuration file example shows how to declaratively specify values for several properties of the class. + +``` + + + + + + + + + + + + + + + + + + +``` + + The following code example demonstrates how to use members of the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/CS/BuildProviderCollection.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/VB/BuildProviderCollection.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/VB/BuildProviderCollection.vb" id="Snippet1"::: + ]]> @@ -129,19 +129,19 @@ A object. Adds a object to the . - object already exists in the collection, the build provider is ignored. - - - -## Examples - The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. - + object already exists in the collection, the build provider is ignored. + + + +## Examples + The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/CS/BuildProviderCollection.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/VB/BuildProviderCollection.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/VB/BuildProviderCollection.vb" id="Snippet4"::: + ]]> @@ -329,19 +329,19 @@ A string value specifying the reference. Removes a object from the . - does not exist in the collection, the build provider is ignored. - - - -## Examples - The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. - + does not exist in the collection, the build provider is ignored. + + + +## Examples + The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/CS/BuildProviderCollection.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/VB/BuildProviderCollection.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/VB/BuildProviderCollection.vb" id="Snippet5"::: + ]]> @@ -369,19 +369,19 @@ An integer value specifying the location of a specific object within the . Removes the object at the specified index from the . - in the collection, an out-of-range exception is thrown. - - - -## Examples - The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. - + in the collection, an out-of-range exception is thrown. + + + +## Examples + The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/CS/BuildProviderCollection.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/VB/BuildProviderCollection.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.BuildProviderCollection/VB/BuildProviderCollection.vb" id="Snippet6"::: + ]]> diff --git a/xml/System.Web.Configuration/CacheSection.xml b/xml/System.Web.Configuration/CacheSection.xml index 14c04225903..da4f6183fc7 100644 --- a/xml/System.Web.Configuration/CacheSection.xml +++ b/xml/System.Web.Configuration/CacheSection.xml @@ -25,7 +25,7 @@ The ASP.NET caching feature is implemented by the class. For more information, see [Caching](https://learn.microsoft.com/previous-versions/aspnet/xsbfdd8c(v=vs.100)). > [!NOTE] -> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. +> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. A cache is an application-specific hash table used to store frequently accessed data. Application and session state are similar to the cache, the application state being the most similar, due to its application-wide scope. One of the biggest differences between the cache and the application-state mechanism is that the cache supports dependencies These dependencies make it possible to build applications that automatically remove cached items when certain events occur. @@ -75,7 +75,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. @@ -151,7 +151,7 @@ If the property is set to `true`, the cached items never expire. This setting is intended to help debug cache behavior in application code. Use caution when disabling cache expiration, as this might result in items being cached longer than they are valid. > [!NOTE] -> To add a page to the output cache, you must establish an expiration policy for that page. You can do this declaratively with the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)) directive or programmatically using the method. For more information, see [How to: Set Expiration Values for ASP.NET Page Caching](https://learn.microsoft.com/previous-versions/aspnet/y18he7cw(v=vs.100)). +> To add a page to the output cache, you must establish an expiration policy for that page. You can do this declaratively with the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)) directive or programmatically using the method. For more information, see [How to: Set Expiration Values for ASP.NET Page Caching](https://learn.microsoft.com/previous-versions/aspnet/y18he7cw(v=vs.100)). diff --git a/xml/System.Web.Configuration/ClientTarget.xml b/xml/System.Web.Configuration/ClientTarget.xml index f7e05d7d19f..f9f77fb42cf 100644 --- a/xml/System.Web.Configuration/ClientTarget.xml +++ b/xml/System.Web.Configuration/ClientTarget.xml @@ -127,7 +127,7 @@ ## Examples - The following code example shows how to get the from the configuration file of an existing Web application. + The following code example shows how to get the from the configuration file of an existing Web application. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ClientTarget/CS/clienttarget.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ClientTarget/VB/clienttarget.vb" id="Snippet3"::: @@ -208,7 +208,7 @@ ## Examples - The following code example shows how to get the from the configuration file of an existing Web application. + The following code example shows how to get the from the configuration file of an existing Web application. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ClientTarget/CS/clienttarget.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ClientTarget/VB/clienttarget.vb" id="Snippet4"::: diff --git a/xml/System.Web.Configuration/ClientTargetCollection.xml b/xml/System.Web.Configuration/ClientTargetCollection.xml index c095103e518..668c85f348e 100644 --- a/xml/System.Web.Configuration/ClientTargetCollection.xml +++ b/xml/System.Web.Configuration/ClientTargetCollection.xml @@ -76,7 +76,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. ]]> @@ -108,7 +108,7 @@ object and initialize its and properties. + Before adding a client target to the collection, you must create a object and initialize its and properties. @@ -171,22 +171,22 @@ method is dependent upon the value chosen. To update the configuration file you use one of these two methods: or . + The result of updating the configuration file after calling the method is dependent upon the value chosen. To update the configuration file you use one of these two methods: or . > [!NOTE] -> Calling is equivalent to calling when the value is modified. +> Calling is equivalent to calling when the value is modified. - If you use the method, the following conditions apply: + If you use the method, the following conditions apply: - If you pass the or parameter value, then a `clear` element is inserted into the `clientTarget` section of the configuration file at the current hierarchy level. -- If you pass the parameter value, a series of `remove` elements are added to the `clientTarget` section of the configuration file at the current hierarchy level. This removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. With the enumeration value, one additional property on the collection affects what gets serialized to the configuration file. The property is and is `false` by default. One of the following conditions applies: +- If you pass the parameter value, a series of `remove` elements are added to the `clientTarget` section of the configuration file at the current hierarchy level. This removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. With the enumeration value, one additional property on the collection affects what gets serialized to the configuration file. The property is and is `false` by default. One of the following conditions applies: - - When is set to `true`, a `clear` element is inserted into the `clientTarget` section of the configuration file at the current hierarchy level. This removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. + - When is set to `true`, a `clear` element is inserted into the `clientTarget` section of the configuration file at the current hierarchy level. This removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. - - When is set to `false`, the `clear` element is removed from the `clientTarget` section of the configuration file at the current hierarchy level, if it exists. + - When is set to `false`, the `clear` element is removed from the `clientTarget` section of the configuration file at the current hierarchy level, if it exists. - The method actually deletes the `add` elements defined in the `clientTarget` section of the configuration file at the current hierarchy level. It also removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. + The method actually deletes the `add` elements defined in the `clientTarget` section of the configuration file at the current hierarchy level. It also removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. > [!NOTE] > The `add` elements are not deleted from the `clientTarget` section of the parent configuration files. @@ -406,7 +406,7 @@ method deletes the `add` element in the `clientTarget` section at the current hierarchy level and inserts a `remove` element. The `remove` element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. + The method deletes the `add` element in the `clientTarget` section at the current hierarchy level and inserts a `remove` element. The `remove` element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. @@ -450,7 +450,7 @@ method deletes the `add` element in the `clientTarget` section at the current hierarchy level and inserts a `remove` element. The `remove` element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. + The method deletes the `add` element in the `clientTarget` section at the current hierarchy level and inserts a `remove` element. The `remove` element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. @@ -494,7 +494,7 @@ method deletes the `add` element in the `clientTarget` section at the current hierarchy level and inserts a `remove` element. The `remove` element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. + The method deletes the `add` element in the `clientTarget` section at the current hierarchy level and inserts a `remove` element. The `remove` element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. diff --git a/xml/System.Web.Configuration/ClientTargetSection.xml b/xml/System.Web.Configuration/ClientTargetSection.xml index fa2571284fa..38dc7091bcc 100644 --- a/xml/System.Web.Configuration/ClientTargetSection.xml +++ b/xml/System.Web.Configuration/ClientTargetSection.xml @@ -77,7 +77,7 @@ class by using the method. + This constructor is called by the ASP.NET configuration system and is not intended to be used directly from your code. You can obtain an instance of the class by using the method. ]]> @@ -117,7 +117,7 @@ ## Examples - The following code example shows how to get the collection. + The following code example shows how to get the collection. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ClientTarget/CS/clienttarget.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ClientTarget/VB/clienttarget.vb" id="Snippet2"::: diff --git a/xml/System.Web.Configuration/CompilationSection.xml b/xml/System.Web.Configuration/CompilationSection.xml index ebbba307d78..9300bf7ce6d 100644 --- a/xml/System.Web.Configuration/CompilationSection.xml +++ b/xml/System.Web.Configuration/CompilationSection.xml @@ -89,7 +89,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You can obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You can obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/CustomError.xml b/xml/System.Web.Configuration/CustomError.xml index 06209d7da75..e19bd4bf07f 100644 --- a/xml/System.Web.Configuration/CustomError.xml +++ b/xml/System.Web.Configuration/CustomError.xml @@ -75,7 +75,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -109,7 +109,7 @@ method compares all errors against objects that are passed to the method. + The method compares all errors against objects that are passed to the method. ]]> diff --git a/xml/System.Web.Configuration/CustomErrorCollection.xml b/xml/System.Web.Configuration/CustomErrorCollection.xml index 4922c4cdd4b..b288d82322c 100644 --- a/xml/System.Web.Configuration/CustomErrorCollection.xml +++ b/xml/System.Web.Configuration/CustomErrorCollection.xml @@ -81,7 +81,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. ]]> @@ -113,7 +113,7 @@ error object and initialize the and properties. + Before adding a custom error to the collection, you must create a error object and initialize the and properties. @@ -174,22 +174,22 @@ method is dependent upon the chosen. To update the configuration file, you use one of these two overloads: and . + The result of updating the configuration file after calling the method is dependent upon the chosen. To update the configuration file, you use one of these two overloads: and . > [!NOTE] -> Calling is equivalent to calling . +> Calling is equivalent to calling . - If you use the .method, the following conditions apply. + If you use the .method, the following conditions apply. - If you pass a or parameter value, then a `clear` element is inserted into the `clientTarget` section of the configuration file at the current hierarchy level. -- If you pass the parameter value, a series of `remove` elements are added to the [clientTarget Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/6379d90d(v=vs.100)) of the configuration file at the current hierarchy level. Each removes all references to an `add` element defined in a parent configuration file at a higher level in the hierarchy. When you use , there is one additional property on the collection that affects what gets serialized to the configuration file: , which is `false` by default. The following conditions apply. +- If you pass the parameter value, a series of `remove` elements are added to the [clientTarget Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/6379d90d(v=vs.100)) of the configuration file at the current hierarchy level. Each removes all references to an `add` element defined in a parent configuration file at a higher level in the hierarchy. When you use , there is one additional property on the collection that affects what gets serialized to the configuration file: , which is `false` by default. The following conditions apply. - - If the set to `true`, `clear` element is inserted into the `clientTarget` section of the configuration file at the current hierarchy level. This removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. + - If the set to `true`, `clear` element is inserted into the `clientTarget` section of the configuration file at the current hierarchy level. This removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. - - If the flag is set to `false`, the `clear` element is removed from the `clientTarget` section of the configuration file at the current hierarchy level, if it exists. + - If the flag is set to `false`, the `clear` element is removed from the `clientTarget` section of the configuration file at the current hierarchy level, if it exists. - The method actually deletes the `add` elements defined in the `clientTarget` section of the configuration file at the current hierarchy level. It also removes all references to the add elements defined in the parent configuration files at higher levels in the hierarchy. + The method actually deletes the `add` elements defined in the `clientTarget` section of the configuration file at the current hierarchy level. It also removes all references to the add elements defined in the parent configuration files at higher levels in the hierarchy. > [!NOTE] > The `add` elements are not deleted from the `clientTarget` section of the parent configuration files. @@ -525,10 +525,10 @@ method inserts a `remove` element into the `customErrors` section of the configuration file at the current hierarchy level. This removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy. + The method inserts a `remove` element into the `customErrors` section of the configuration file at the current hierarchy level. This removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy. > [!NOTE] -> The `add` elements are not deleted from the parent configuration files. The `remove` element merely deactivates them. However, the method does actually delete them at the current hierarchy level. +> The `add` elements are not deleted from the parent configuration files. The `remove` element merely deactivates them. However, the method does actually delete them at the current hierarchy level. @@ -568,9 +568,9 @@ method inserts a `remove` element into the `customErrors` section of the configuration file at the current hierarchy level. This is to remove the reference to the `add` element defined in the parent configuration files at higher-level in the hierarchy. + The method inserts a `remove` element into the `customErrors` section of the configuration file at the current hierarchy level. This is to remove the reference to the `add` element defined in the parent configuration files at higher-level in the hierarchy. - **Note** The `add` elements are not deleted from the parent configuration files. They are merely deactivated. However, the method does actually delete them at the current hierarchy level. + **Note** The `add` elements are not deleted from the parent configuration files. They are merely deactivated. However, the method does actually delete them at the current hierarchy level. diff --git a/xml/System.Web.Configuration/CustomErrorsSection.xml b/xml/System.Web.Configuration/CustomErrorsSection.xml index 783bb8156e3..3867ef6cdcd 100644 --- a/xml/System.Web.Configuration/CustomErrorsSection.xml +++ b/xml/System.Web.Configuration/CustomErrorsSection.xml @@ -23,7 +23,7 @@ The class provides a way to programmatically access and modify the `customErrors` section of a configuration file. This type is part of a group that includes the , , and types. > [!NOTE] -> The can read and write information from and to the related section of the configuration file according to the section property whose value is . +> The can read and write information from and to the related section of the configuration file according to the section property whose value is . @@ -76,7 +76,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -139,10 +139,10 @@ is not specified, a standard error is displayed instead. The specifies the generic error page to activate in case no error custom page exists. + If the is not specified, a standard error is displayed instead. The specifies the generic error page to activate in case no error custom page exists. > [!NOTE] -> The URL might be an absolute or a relative value. A relative URL is relative to the Web.config file that specified the , not to the Web page in which the error occurred. A relative URL starting with a tilde (~) is relative to the root path of the application. +> The URL might be an absolute or a relative value. A relative URL is relative to the Web.config file that specified the , not to the Web page in which the error occurred. A relative URL starting with a tilde (~) is relative to the root path of the application. @@ -218,7 +218,7 @@ ## Examples - The following code example shows how to use the collection. + The following code example shows how to use the collection. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.CustomErrorsSection/CS/customerrorssection.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.CustomErrorsSection/VB/customerrorssection.vb" id="Snippet1"::: diff --git a/xml/System.Web.Configuration/DeploymentSection.xml b/xml/System.Web.Configuration/DeploymentSection.xml index 29166dbc1ab..9e4a26b7e68 100644 --- a/xml/System.Web.Configuration/DeploymentSection.xml +++ b/xml/System.Web.Configuration/DeploymentSection.xml @@ -42,11 +42,11 @@ Initializes a new instance of the class. - class by using the method. - + class by using the method. + ]]> @@ -106,28 +106,28 @@ if Web applications are deployed in mode; otherwise, . The default is . - is `true`, ASP.NET disables trace output, disables debug capabilities, and disables detailed system-generated error messages for remote users. For applications that have a `customErrors` element in the application Web.config file, the `mode` attribute is forced to `On`. These settings override any settings that are made in application Web.config files. - + is `true`, ASP.NET disables trace output, disables debug capabilities, and disables detailed system-generated error messages for remote users. For applications that have a `customErrors` element in the application Web.config file, the `mode` attribute is forced to `On`. These settings override any settings that are made in application Web.config files. + > [!NOTE] -> When you use the `retail` setting, you should continue to set the `debug` attribute to `false` in application Web.config files that are deployed to the server. The `debug` setting disables request execution timeout, and this is not overridden by the `retail` setting. For more information, see. [Most Common ASP.NET Support issues - Reporting from deep inside Microsoft Developer Support](https://www.hanselman.com/blog/MostCommonASPNETSupportIssuesReportingFromDeepInsideMicrosoftDeveloperSupport.aspx) on Scott Hanselman's blog. - - - -## Examples - The following configuration file example shows how to set this property to `true` in the machine.config file. The machine.config file is located in this folder: - - `%windir%\Microsoft.NET\Framework\\Config` - -``` - - - -``` - +> When you use the `retail` setting, you should continue to set the `debug` attribute to `false` in application Web.config files that are deployed to the server. The `debug` setting disables request execution timeout, and this is not overridden by the `retail` setting. For more information, see. [Most Common ASP.NET Support issues - Reporting from deep inside Microsoft Developer Support](https://www.hanselman.com/blog/MostCommonASPNETSupportIssuesReportingFromDeepInsideMicrosoftDeveloperSupport.aspx) on Scott Hanselman's blog. + + + +## Examples + The following configuration file example shows how to set this property to `true` in the machine.config file. The machine.config file is located in this folder: + + `%windir%\Microsoft.NET\Framework\\Config` + +``` + + + +``` + ]]> diff --git a/xml/System.Web.Configuration/EventMappingSettings.xml b/xml/System.Web.Configuration/EventMappingSettings.xml index 0a0301020f4..b32e47c6552 100644 --- a/xml/System.Web.Configuration/EventMappingSettings.xml +++ b/xml/System.Web.Configuration/EventMappingSettings.xml @@ -22,7 +22,7 @@ ## Remarks This class corresponds to the `eventMappings` configuration-file element. The `eventMappings` element allows you to assign friendly names to event sources. These names are then used to associate event sources with the related event consumers, called providers, in the `rules` subsection of the `healthMonitoring` section of the configuration file. - Event codes are mapped to events defined by the constants in the object. The mapping uses a range specified with the and properties. + Event codes are mapped to events defined by the constants in the object. The mapping uses a range specified with the and properties. @@ -115,13 +115,13 @@ |Setting|Default Value| |-------------|-------------------| -||0.| -||.| +||0.| +||.| ## Examples - The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet31"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet31"::: @@ -160,7 +160,7 @@ constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet32"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet32"::: @@ -203,7 +203,7 @@ object. The mapping uses a range specified with the and properties. + Event codes are mapped to events defined by the constants in the object. The mapping uses a range specified with the and properties. @@ -324,7 +324,7 @@ object. The mapping uses a range specified with the and properties. + Event codes are mapped to events defined by the constants in the object. The mapping uses a range specified with the and properties. diff --git a/xml/System.Web.Configuration/EventMappingSettingsCollection.xml b/xml/System.Web.Configuration/EventMappingSettingsCollection.xml index 026e4b443ff..32b47b2fb1f 100644 --- a/xml/System.Web.Configuration/EventMappingSettingsCollection.xml +++ b/xml/System.Web.Configuration/EventMappingSettingsCollection.xml @@ -107,7 +107,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet30"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet30"::: @@ -147,7 +147,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet40"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet40"::: @@ -191,7 +191,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet35"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet35"::: @@ -278,7 +278,7 @@ method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet36"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet36"::: @@ -322,7 +322,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet33"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet33"::: @@ -372,7 +372,7 @@ method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet45"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet45"::: @@ -468,7 +468,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet38"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet38"::: @@ -511,7 +511,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet39"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet39"::: diff --git a/xml/System.Web.Configuration/ExpressionBuilder.xml b/xml/System.Web.Configuration/ExpressionBuilder.xml index f124c9af40b..da313e3f998 100644 --- a/xml/System.Web.Configuration/ExpressionBuilder.xml +++ b/xml/System.Web.Configuration/ExpressionBuilder.xml @@ -17,19 +17,19 @@ Retrieves a dynamic resource during compilation. - class. The collection, which is made up of the `expressionBuilders` elements contained in the `compilation` section of the configuration. The contains specific values in key/value pairs. - - A value is retrieved by including an expression of the form - - `<%$ ExpressionPrefix: ExpressionKey %>` - - within the page. The `ExpressionPrefix` maps the type of expression to be retrieved as either a common expression-builder type (that is, ) or a custom expression builder type. The `ExpressionKey` specifies the key used to reference the returned value. - - If you choose to implement a common expression-builder type, you must map the expression builder to the associated section name in the configuration. If you choose to implement a custom expression-builder type, you must map your expression builder to your custom expression-builder class, which must derive from the class. - + class. The collection, which is made up of the `expressionBuilders` elements contained in the `compilation` section of the configuration. The contains specific values in key/value pairs. + + A value is retrieved by including an expression of the form + + `<%$ ExpressionPrefix: ExpressionKey %>` + + within the page. The `ExpressionPrefix` maps the type of expression to be retrieved as either a common expression-builder type (that is, ) or a custom expression builder type. The `ExpressionKey` specifies the key used to reference the returned value. + + If you choose to implement a common expression-builder type, you must map the expression builder to the associated section name in the configuration. If you choose to implement a custom expression-builder type, you must map your expression builder to your custom expression-builder class, which must derive from the class. + ]]> @@ -58,14 +58,14 @@ A string that specifies the expression type. Initializes a new instance of the class. - object. This code example is part of a larger example provided for the class. - + object. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/CS/ExpressionBuilderCollection.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet2"::: + ]]> @@ -100,11 +100,11 @@ Gets or sets a string that identifies the type of expression to retrieve. A string that identifies the type of expression to retrieve. - maps the expression to the associated section name in the configuration for common expression types, or maps the expression to the custom expression class. - + maps the expression to the associated section name in the configuration for common expression types, or maps the expression to the custom expression class. + ]]> @@ -167,11 +167,11 @@ Gets or sets a string that specifies the expression type. A string that specifies the expression type. - specifies the type of object used to determine the value of the expression. The type can specify either a section within the configuration, or a custom class. - + specifies the type of object used to determine the value of the expression. The type can specify either a section within the configuration, or a custom class. + ]]> diff --git a/xml/System.Web.Configuration/ExpressionBuilderCollection.xml b/xml/System.Web.Configuration/ExpressionBuilderCollection.xml index 3face7e8ce0..f3e77ce0ca2 100644 --- a/xml/System.Web.Configuration/ExpressionBuilderCollection.xml +++ b/xml/System.Web.Configuration/ExpressionBuilderCollection.xml @@ -23,41 +23,41 @@ Represents a collection of objects. This class cannot be inherited. - class does not refer to any actual element in the underlying configuration file. It is a construct that allows easy access to the compilation information it contains. - - - -## Examples - This section provides two code examples. The first demonstrates how to declaratively specify values for several properties of the class. The second demonstrates how to use members of the class. - - The following configuration file example shows how to declaratively specify values for several properties of the class. - -``` - - - - - - - - - -``` - - The following code example demonstrates how to use members of the class. - + class does not refer to any actual element in the underlying configuration file. It is a construct that allows easy access to the compilation information it contains. + + + +## Examples + This section provides two code examples. The first demonstrates how to declaratively specify values for several properties of the class. The second demonstrates how to use members of the class. + + The following configuration file example shows how to declaratively specify values for several properties of the class. + +``` + + + + + + + + + +``` + + The following code example demonstrates how to use members of the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/CS/ExpressionBuilderCollection.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet1"::: + ]]> @@ -105,19 +105,19 @@ A string value specifying the reference. Adds an object to the . - object to the collection. If the assembly object is not initialized with assembly information, an exception is thrown. If the assembly object already exists in the collection, the statement is ignored. - - - -## Examples - The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. - + object to the collection. If the assembly object is not initialized with assembly information, an exception is thrown. If the assembly object already exists in the collection, the statement is ignored. + + + +## Examples + The following code example demonstrates how to use the method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/CS/ExpressionBuilderCollection.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet4"::: + ]]> The object to add already exists in the collection, or the collection is read-only. @@ -202,11 +202,11 @@ Gets or sets the specified object. - - + + ]]> @@ -314,19 +314,19 @@ A string value specifying the reference. Removes an object from the collection. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/CS/ExpressionBuilderCollection.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet5"::: + ]]> @@ -354,19 +354,19 @@ An integer value specifying a specific object within the collection. Removes an object from the collection. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/CS/ExpressionBuilderCollection.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ExpressionBuilderCollection/VB/ExpressionBuilderCollection.vb" id="Snippet6"::: + ]]> diff --git a/xml/System.Web.Configuration/FolderLevelBuildProvider.xml b/xml/System.Web.Configuration/FolderLevelBuildProvider.xml index a0a5efcb5f8..014da516ddb 100644 --- a/xml/System.Web.Configuration/FolderLevelBuildProvider.xml +++ b/xml/System.Web.Configuration/FolderLevelBuildProvider.xml @@ -16,29 +16,29 @@ Represents configuration settings that enable use of the class for specific folders. - objects to generate source code for different file types and subfolders in an application. Classes that are derived from the class generate source code for folders such as Bin, App_GlobalResources, App_LocalResources, App_WebReferences, App_Browsers, Theme, and for other custom folders. Typically, you do not create an instance of the class directly. Instead, you implement a class that derives from and apply the class to it, and then configure the derived class for use in the ASP.NET build environment. The class targets folders instead of files. - - You use instances of the class together with objects to build one or more files into a compiled assembly. The instance generates source code in the appropriate language for individual files, and the object builds the source code contributed by each instance into a single assembly. - - The class is specified in the `configuration` section of the Web.config file. - - - -## Examples - The following example shows how to add a build provider named `BuildProvider1` to the Web.config file. - -``` - - - - - -``` - + objects to generate source code for different file types and subfolders in an application. Classes that are derived from the class generate source code for folders such as Bin, App_GlobalResources, App_LocalResources, App_WebReferences, App_Browsers, Theme, and for other custom folders. Typically, you do not create an instance of the class directly. Instead, you implement a class that derives from and apply the class to it, and then configure the derived class for use in the ASP.NET build environment. The class targets folders instead of files. + + You use instances of the class together with objects to build one or more files into a compiled assembly. The instance generates source code in the appropriate language for individual files, and the object builds the source code contributed by each instance into a single assembly. + + The class is specified in the `configuration` section of the Web.config file. + + + +## Examples + The following example shows how to add a build provider named `BuildProvider1` to the Web.config file. + +``` + + + + + +``` + ]]> @@ -112,11 +112,11 @@ Generates a hash code for the object. The hash code for the object. - method. The method is suitable for hashing algorithms and data structures such as a hash table. - + method. The method is suitable for hashing algorithms and data structures such as a hash table. + ]]> diff --git a/xml/System.Web.Configuration/FormsAuthenticationConfiguration.xml b/xml/System.Web.Configuration/FormsAuthenticationConfiguration.xml index dc320ee3f7a..2ed8cf06ddf 100644 --- a/xml/System.Web.Configuration/FormsAuthenticationConfiguration.xml +++ b/xml/System.Web.Configuration/FormsAuthenticationConfiguration.xml @@ -27,7 +27,7 @@ [!INCLUDE[Forms authentication warning](~/includes/forms-auth-warning.md)] > [!NOTE] -> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. For safety and scalability, it is recommended that you use [Azure Key Vault](/azure/key-vault/general/overview) to store user credentials. +> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. For safety and scalability, it is recommended that you use [Azure Key Vault](/azure/key-vault/general/overview) to store user credentials. ## Examples @@ -217,12 +217,12 @@ is used if the user accesses the login page directly or if a return URL is not provided. + The is used if the user accesses the login page directly or if a return URL is not provided. ## Examples - The following code example shows how to access the . Refer to the code example in the class topic to learn how to get the section. + The following code example shows how to access the . Refer to the code example in the class topic to learn how to get the section. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.FormsAuthenticationConfiguration/CS/formsauthenticationconfiguration.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.FormsAuthenticationConfiguration/VB/formsauthenticationconfiguration.vb" id="Snippet4"::: @@ -260,9 +260,9 @@ is used for the authentication cookies. + The is used for the authentication cookies. - This property corresponds to the value of . + This property corresponds to the value of . This setting will take precedence over the `domain` attribute of the `forms` section for forms authentication cookies. @@ -335,7 +335,7 @@ ## Remarks The property value sets the enableCrossAppRedirects attribute of the `forms` section in the authentication section of a configuration. - The property is checked by the method when the redirection is to a URL that is not in the current application. If is true, then the redirect is performed; otherwise the browser is redirected to the page defined in the property. + The property is checked by the method when the redirection is to a URL that is not in the current application. If is true, then the redirect is performed; otherwise the browser is redirected to the page defined in the property. > [!NOTE] > When performing redirects across applications, you must ensure that several of the attributes in the `form` configuration section are duplicated across the authenticated applications. For more information and an example, see [Forms Authentication Across Applications](https://learn.microsoft.com/previous-versions/aspnet/eb0zx8fc(v=vs.100)). @@ -391,7 +391,7 @@ ## Examples - The following code example shows how to access the . Refer to the code example in the class topic to learn how to get the section. + The following code example shows how to access the . Refer to the code example in the class topic to learn how to get the section. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.FormsAuthenticationConfiguration/CS/formsauthenticationconfiguration.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.FormsAuthenticationConfiguration/VB/formsauthenticationconfiguration.vb" id="Snippet3"::: @@ -593,7 +593,7 @@ is `true`, a Web application rejects all the forms authentication requests that do not use an SSL connection. + If is `true`, a Web application rejects all the forms authentication requests that do not use an SSL connection. @@ -638,7 +638,7 @@ is set to `true`, the time interval during which the authentication cookie is valid is reset to the expiration property value. This happens if the user browses after half of the timeout has expired. For example, if you set an expiration of 20 minutes by using sliding expiration, a user can visit the site at 2:00 PM and receive a cookie that is set to expire at 2:20 PM. The expiration is only updated if the user visits the site after 2:10 PM. If the user visits the site at 2:09 PM, the cookie is not updated because half of the expiration time has not passed. If the user then waits 12 minutes, visiting the site at 2:21 PM, the cookie will be expired. + When the is set to `true`, the time interval during which the authentication cookie is valid is reset to the expiration property value. This happens if the user browses after half of the timeout has expired. For example, if you set an expiration of 20 minutes by using sliding expiration, a user can visit the site at 2:00 PM and receive a cookie that is set to expire at 2:20 PM. The expiration is only updated if the user visits the site after 2:10 PM. If the user visits the site at 2:09 PM, the cookie is not updated because half of the expiration time has not passed. If the user then waits 12 minutes, visiting the site at 2:21 PM, the cookie will be expired. diff --git a/xml/System.Web.Configuration/GlobalizationSection.xml b/xml/System.Web.Configuration/GlobalizationSection.xml index 3d5f66deaed..07e3f8e5f83 100644 --- a/xml/System.Web.Configuration/GlobalizationSection.xml +++ b/xml/System.Web.Configuration/GlobalizationSection.xml @@ -73,7 +73,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -182,7 +182,7 @@ property is enabled, the and properties are based on the header field value that is sent by the client browser. If the header value cannot be mapped to a specific culture, the and values are used. The default value is `false`. + When the property is enabled, the and properties are based on the header field value that is sent by the client browser. If the header value cannot be mapped to a specific culture, the and values are used. The default value is `false`. @@ -226,9 +226,9 @@ property specifies the default encoding that is used to interpret the data that is included in the .aspx, .asmx, and .asax file types. If the file encoding is specified in the Web.config file, the actual file must be saved in the same encoding. Unicode files and UTF-8 files that are saved with the byte order mark prefix property are automatically recognized regardless of the value of the . + The property specifies the default encoding that is used to interpret the data that is included in the .aspx, .asmx, and .asax file types. If the file encoding is specified in the Web.config file, the actual file must be saved in the same encoding. Unicode files and UTF-8 files that are saved with the byte order mark prefix property are automatically recognized regardless of the value of the . - If the property setting for the server or application is configured to use UTF-16, and if UTF-16 is not the encoding that is used for an .aspx page in the scope of the configuration file, the output that is sent to the client browser is corrupted. For this reason, ensure that the configured value matches the encoding that is used in the .aspx page. + If the property setting for the server or application is configured to use UTF-16, and if UTF-16 is not the encoding that is used for an .aspx page in the scope of the configuration file, the output that is sent to the client browser is corrupted. For this reason, ensure that the configured value matches the encoding that is used in the .aspx page. @@ -347,9 +347,9 @@ property specifies the assumed encoding of each incoming HTTP request, including posted data and query-string data. If the request comes with a request header containing a field, the field of the request header overrides the of the configuration. + The property specifies the assumed encoding of each incoming HTTP request, including posted data and query-string data. If the request comes with a request header containing a field, the field of the request header overrides the of the configuration. - The default encoding is UTF-8, specified in the `globalization` section of the Machine.config file that was created when the .NET Framework was installed. If the property is not specified in the Machine.config or Web.config file, encoding defaults to the `Regional Options` locale setting on the computer. For single-server applications, the and properties should be the same. When using multiple server applications where the default server encodings are different, you can use local Web.config files to vary the and properties. + The default encoding is UTF-8, specified in the `globalization` section of the Machine.config file that was created when the .NET Framework was installed. If the property is not specified in the Machine.config or Web.config file, encoding defaults to the `Regional Options` locale setting on the computer. For single-server applications, the and properties should be the same. When using multiple server applications where the default server encodings are different, you can use local Web.config files to vary the and properties. diff --git a/xml/System.Web.Configuration/HealthMonitoringSection.xml b/xml/System.Web.Configuration/HealthMonitoringSection.xml index 45067bf7041..1978184d2d5 100644 --- a/xml/System.Web.Configuration/HealthMonitoringSection.xml +++ b/xml/System.Web.Configuration/HealthMonitoringSection.xml @@ -222,7 +222,7 @@ |Setting|Default value| |-------------|-------------------| -||`true`| +||`true`| ]]> diff --git a/xml/System.Web.Configuration/HostingEnvironmentSection.xml b/xml/System.Web.Configuration/HostingEnvironmentSection.xml index 705c9c55ed0..030ea3c95bc 100644 --- a/xml/System.Web.Configuration/HostingEnvironmentSection.xml +++ b/xml/System.Web.Configuration/HostingEnvironmentSection.xml @@ -20,7 +20,7 @@ class provides a way to programmatically access and modify the values of the section in the configuration file.When an ASP.NET application is unused for a specified amount of time, it can be unloaded from memory based on the and properties. + The class provides a way to programmatically access and modify the values of the section in the configuration file.When an ASP.NET application is unused for a specified amount of time, it can be unloaded from memory based on the and properties. @@ -76,7 +76,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/HttpCapabilitiesBase.xml b/xml/System.Web.Configuration/HttpCapabilitiesBase.xml index 2d57acd0461..636cb183c00 100644 --- a/xml/System.Web.Configuration/HttpCapabilitiesBase.xml +++ b/xml/System.Web.Configuration/HttpCapabilitiesBase.xml @@ -938,7 +938,7 @@ ## Remarks The property primarily represents the number of soft keys that are available on a WML-compatible mobile device. - Web Forms pages for mobile devices can contain a object and more than one control. The allows you to choose which of the controls should be assigned to a soft key on devices that have multiple soft keys. + Web Forms pages for mobile devices can contain a object and more than one control. The allows you to choose which of the controls should be assigned to a soft key on devices that have multiple soft keys. ]]> @@ -1134,7 +1134,7 @@ method is supported only when the browser is Internet Explorer version 5.0 or later. If the common language runtime is not installed on the client, the property returns an array containing a single object with the values 0, 0,-1,-1. + The method is supported only when the browser is Internet Explorer version 5.0 or later. If the common language runtime is not installed on the client, the property returns an array containing a single object with the values 0, 0,-1,-1. ]]> @@ -1388,7 +1388,7 @@ method also returns `true` if the client browser definition inherits from the specified browser. + The method also returns `true` if the client browser definition inherits from the specified browser. ]]> @@ -1666,7 +1666,7 @@ ## Remarks Processing by an intermediate gateway can change the number of bytes that reach the browser. ASP.NET does not enforce this limit on page size. - is primarily useful when working with mobile-client browsers. + is primarily useful when working with mobile-client browsers. ]]> @@ -3776,9 +3776,9 @@ CACHE-CONTROL: NO-CACHE method behaves as if the value of the property of the object is `false`, unless the property in the section of Web.config has been explicitly set to `true`. + With UP.Browser 4.1 or UP.Browser 3.2, the method behaves as if the value of the property of the object is `false`, unless the property in the section of Web.config has been explicitly set to `true`. - In ASP.NET 1.1, the options for this setting were `true` or `false`, but with ASP.NET 2.0, the choices are expanded, and is now the default setting. If your Web application has the `cookieless` attribute of the `` section in the Web.config file set to a Boolean value, should work as expected for these browsers. + In ASP.NET 1.1, the options for this setting were `true` or `false`, but with ASP.NET 2.0, the choices are expanded, and is now the default setting. If your Web application has the `cookieless` attribute of the `` section in the Web.config file set to a Boolean value, should work as expected for these browsers. @@ -4136,12 +4136,12 @@ CACHE-CONTROL: NO-CACHE property returns a string. In some scenarios, the property might contain letter characters, as in the case of a browser or client device that is a beta version such as "7.0b." To correctly get the version as a data type that can be used in a numeric comparison, concatenate the and property values. + The property returns a string. In some scenarios, the property might contain letter characters, as in the case of a browser or client device that is a beta version such as "7.0b." To correctly get the version as a data type that can be used in a numeric comparison, concatenate the and property values. ## Examples - The following code example shows how to determine the of the browser. The property and property are concatenated and the result is used to determine whether the browser version is greater than 5.01. + The following code example shows how to determine the of the browser. The property and property are concatenated and the result is used to determine whether the browser version is greater than 5.01. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/HttpCapabilitiesBase.Version/CS/sample_cs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/HttpCapabilitiesBase.Version/VB/sample_vb.aspx" id="Snippet1"::: diff --git a/xml/System.Web.Configuration/HttpCookiesSection.xml b/xml/System.Web.Configuration/HttpCookiesSection.xml index 1c077325296..0a7f440d2fb 100644 --- a/xml/System.Web.Configuration/HttpCookiesSection.xml +++ b/xml/System.Web.Configuration/HttpCookiesSection.xml @@ -27,7 +27,7 @@ One objective of the `httpCookies` element is to support the use of `HttpOnly` cookies. `HttpOnly` cookies (cookies with the `HttpOnly` attribute) were introduced in Internet Explorer 6 to help mitigate the risk of cross-site scripting. The `HttpOnly` attribute prevents cookies from being accessed through client-side script. Any information contained in an `HttpOnly` cookie is less likely to be disclosed to a hacker or a malicious Web site. For more information, search MSDN (msdn.microsoft.com) for "HttpOnly." > [!NOTE] -> The can read and write information from and to the related section of the configuration file according to the section property whose value is . +> The can read and write information from and to the related section of the configuration file according to the section property whose value is . @@ -70,7 +70,7 @@ class by using the method. + This constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/HttpHandlerAction.xml b/xml/System.Web.Configuration/HttpHandlerAction.xml index 171caa66b06..34d220324c3 100644 --- a/xml/System.Web.Configuration/HttpHandlerAction.xml +++ b/xml/System.Web.Configuration/HttpHandlerAction.xml @@ -25,7 +25,7 @@ This type is part of a group that includes the and the types. > [!NOTE] -> The can read and write information from and to the related section of the configuration file according to the section property whose value is . +> The can read and write information from and to the related section of the configuration file according to the section property whose value is . ASP.NET searches for the handler assembly DLL in the application's private \bin directory first, and then it searches in the system assembly cache. @@ -96,7 +96,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. ]]> @@ -132,7 +132,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. diff --git a/xml/System.Web.Configuration/HttpHandlerActionCollection.xml b/xml/System.Web.Configuration/HttpHandlerActionCollection.xml index 06acfc0f128..1a7f1e48b2f 100644 --- a/xml/System.Web.Configuration/HttpHandlerActionCollection.xml +++ b/xml/System.Web.Configuration/HttpHandlerActionCollection.xml @@ -71,7 +71,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. ]]> @@ -108,7 +108,7 @@ > [!NOTE] > ASP.NET searches for the handler assembly DLL in the application's private Bin directory first, and then it searches in the system assembly cache. - The collection must not already contain an object with the same and properties. + The collection must not already contain an object with the same and properties. diff --git a/xml/System.Web.Configuration/HttpHandlersSection.xml b/xml/System.Web.Configuration/HttpHandlersSection.xml index a27a47d4116..bd5edbfa095 100644 --- a/xml/System.Web.Configuration/HttpHandlersSection.xml +++ b/xml/System.Web.Configuration/HttpHandlersSection.xml @@ -23,7 +23,7 @@ The class provides a way to programmatically access and modify the `httpHandlers` section of a configuration file. This type is part of a group that includes the and the types. > [!NOTE] -> The can read and write information from and to the related section of the configuration file according to the section property whose value is . +> The can read and write information from and to the related section of the configuration file according to the section property whose value is . @@ -75,7 +75,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/HttpModuleAction.xml b/xml/System.Web.Configuration/HttpModuleAction.xml index 29b5897a280..c5d190121c0 100644 --- a/xml/System.Web.Configuration/HttpModuleAction.xml +++ b/xml/System.Web.Configuration/HttpModuleAction.xml @@ -224,7 +224,7 @@ , ASP.NET searches for the assembly DLL first in the application's private \bin directory, and then in the system assembly cache. + To find the assembly defined by the , ASP.NET searches for the assembly DLL first in the application's private \bin directory, and then in the system assembly cache. diff --git a/xml/System.Web.Configuration/HttpModulesSection.xml b/xml/System.Web.Configuration/HttpModulesSection.xml index 74a9d12f48f..4215ccd86db 100644 --- a/xml/System.Web.Configuration/HttpModulesSection.xml +++ b/xml/System.Web.Configuration/HttpModulesSection.xml @@ -25,7 +25,7 @@ This type is part of a group that includes the and the types. > [!NOTE] -> The can read and write information from and to the related section of the configuration file according to the section property whose value is . +> The can read and write information from and to the related section of the configuration file according to the section property whose value is . @@ -79,7 +79,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/HttpRuntimeSection.xml b/xml/System.Web.Configuration/HttpRuntimeSection.xml index 3b7692636aa..924539888ed 100644 --- a/xml/System.Web.Configuration/HttpRuntimeSection.xml +++ b/xml/System.Web.Configuration/HttpRuntimeSection.xml @@ -536,7 +536,7 @@ ## Remarks ASP.NET uses the type as the default handler for HTML and URL encoding tasks. - To customize encoding behavior, you can create a class that inherits from the type. In the configuration file for an application, you then set the attribute of the `httpRuntime` element to the fully qualified string name of the custom type. For more information, see [httpRuntime Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/e1f13641(v=vs.100)). + To customize encoding behavior, you can create a class that inherits from the type. In the configuration file for an application, you then set the attribute of the `httpRuntime` element to the fully qualified string name of the custom type. For more information, see [httpRuntime Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/e1f13641(v=vs.100)). ]]> @@ -758,7 +758,7 @@ If the length of the request URL (which is the value of the property) exceeds the configured size limit, ASP.NET returns an HTTP 400 (Bad Request) status code - You can set this value in a configuration file by setting the attribute of the `httpRuntime` element. For more information, see [httpRuntime Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/e1f13641(v=vs.100)). + You can set this value in a configuration file by setting the attribute of the `httpRuntime` element. For more information, see [httpRuntime Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/e1f13641(v=vs.100)). ]]> @@ -975,7 +975,7 @@ ## Remarks The property determines how the URL in an incoming HTTP request will be validated. If this property is `false`, the URL is validated by using the same rules that determine whether a Windows file system path is valid. - You can set this value in a configuration file by setting the attribute of the `httpRuntime` element. For more information, see [httpRuntime Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/e1f13641(v=vs.100)). + You can set this value in a configuration file by setting the attribute of the `httpRuntime` element. For more information, see [httpRuntime Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/e1f13641(v=vs.100)). ]]> @@ -1416,7 +1416,7 @@ would exceed the length of time to complete a copy during the deployment process. + A suggested value for would exceed the length of time to complete a copy during the deployment process. > [!NOTE] > The content might appear cached if you view it immediately after a copy and deploy process. This is typical behavior. The changes take effect when the wait period that you specified has elapsed. diff --git a/xml/System.Web.Configuration/IConfigMapPath.xml b/xml/System.Web.Configuration/IConfigMapPath.xml index bb3a9f5ef60..74ae2ed7e9a 100644 --- a/xml/System.Web.Configuration/IConfigMapPath.xml +++ b/xml/System.Web.Configuration/IConfigMapPath.xml @@ -14,11 +14,11 @@ Provides access to the mapping between configuration-file virtual and physical paths. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -50,11 +50,11 @@ Gets the virtual-directory name associated with a specific site. The must be unique. No two sites share the same id. The distinguishes sites that have the same name. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -85,11 +85,11 @@ A unique identifier for the site. Populates the default site name and the site ID. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -116,11 +116,11 @@ Gets the machine-configuration file name. The machine-configuration file name. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -155,11 +155,11 @@ The name of the configuration file. Populates the directory and name of the configuration file based on the site ID and site path. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -186,11 +186,11 @@ Gets the name of the configuration file at the Web root. The name of the configuration file at the Web root. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -222,11 +222,11 @@ Gets the physical directory path based on the site ID and URL associated with the site. The physical directory path. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -259,13 +259,13 @@ A unique identifier for the site. Populates the site name and site ID based on a site argument value. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Web.Configuration/IConfigMapPathFactory.xml b/xml/System.Web.Configuration/IConfigMapPathFactory.xml index d12e277ad02..b5f2cf54925 100644 --- a/xml/System.Web.Configuration/IConfigMapPathFactory.xml +++ b/xml/System.Web.Configuration/IConfigMapPathFactory.xml @@ -14,11 +14,11 @@ Maps the configuration file virtual and physical paths. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -50,11 +50,11 @@ Creates the interface for the mapping between configuration-file virtual and physical paths. The object associated with the specified configuration-file path mapping. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Web.Configuration/IdentitySection.xml b/xml/System.Web.Configuration/IdentitySection.xml index 7cca72f5595..c1da5f4f1fb 100644 --- a/xml/System.Web.Configuration/IdentitySection.xml +++ b/xml/System.Web.Configuration/IdentitySection.xml @@ -23,7 +23,7 @@ The provides a way to programmatically access and modify the `identity` section of a configuration file. > [!NOTE] -> The can read and write information from and to the related section of the configuration file according to the section property whose value is . +> The can read and write information from and to the related section of the configuration file according to the section property whose value is . @@ -126,10 +126,10 @@ property is set to `true`, each request is served by a Web application impersonating its client. That is, either the user currently logged on or the user specified by the and properties. When the property is set to `false`, the application does not impersonate any client user. + If the property is set to `true`, each request is served by a Web application impersonating its client. That is, either the user currently logged on or the user specified by the and properties. When the property is set to `false`, the application does not impersonate any client user. > [!NOTE] -> For security reasons, the identity section supports storage of the encrypted and . +> For security reasons, the identity section supports storage of the encrypted and . @@ -177,7 +177,7 @@ Because the password is stored in clear text, an authenticated user with proper credentials on the domain where the server resides can read it. > [!NOTE] -> For security reasons, the identity section supports storage of the encrypted and . +> For security reasons, the identity section supports storage of the encrypted and . @@ -305,7 +305,7 @@ Because the user name is stored in clear text, an authenticated user with proper credentials on the domain where the server resides can read it. > [!NOTE] -> For security reasons, the identity section supports storage of the encrypted and . +> For security reasons, the identity section supports storage of the encrypted and . diff --git a/xml/System.Web.Configuration/LowerCaseStringConverter.xml b/xml/System.Web.Configuration/LowerCaseStringConverter.xml index 55671130f68..f67beb33b52 100644 --- a/xml/System.Web.Configuration/LowerCaseStringConverter.xml +++ b/xml/System.Web.Configuration/LowerCaseStringConverter.xml @@ -17,13 +17,13 @@ Provides support to convert an object to a lowercase string. This class cannot be inherited. - class allows an object to be converted to a lowercase string. This class also provides support to verify that an object type can be converted to a lowercase string before the conversion is made. - - The methods of take as a parameter an object that implements the interface. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. - + class allows an object to be converted to a lowercase string. This class also provides support to verify that an object type can be converted to a lowercase string before the conversion is made. + + The methods of take as a parameter an object that implements the interface. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. + ]]> @@ -53,14 +53,14 @@ Initializes an instance of the class. - constructor. - + constructor. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/CS/LowerCaseStringConverter.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet2"::: + ]]> @@ -92,19 +92,19 @@ if the parameters describe an object that can be converted to a lowercase string object; otherwise, . - interface as the `ctx` parameter. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. Override this method in a derived class if custom behavior is required. - - - -## Examples - The following example demonstrates how to use this method. - + interface as the `ctx` parameter. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. Override this method in a derived class if custom behavior is required. + + + +## Examples + The following example demonstrates how to use this method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/CS/LowerCaseStringConverter.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet3"::: + ]]> @@ -137,19 +137,19 @@ if the parameters describe an object that can be converted to a lowercase string object; otherwise, . - interface as the `ctx` parameter. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. Override this method in a derived class if custom behavior is required. - - - -## Examples - The following example demonstrates how to use this method. - + interface as the `ctx` parameter. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. Override this method in a derived class if custom behavior is required. + + + +## Examples + The following example demonstrates how to use this method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/CS/LowerCaseStringConverter.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet4"::: + ]]> @@ -183,19 +183,19 @@ Converts an object from its original value to a lowercase string based on the specified parameters. A lowercase string object. - interface as the `ctx` parameter. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. The `ci` parameter object provides the culture-related information. The `data` parameter object acts as both the object to convert and the resulting object once the method is complete. Override this method in a derived class if custom behavior is required. - - - -## Examples - The following example demonstrates how to use this method. - + interface as the `ctx` parameter. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. The `ci` parameter object provides the culture-related information. The `data` parameter object acts as both the object to convert and the resulting object once the method is complete. Override this method in a derived class if custom behavior is required. + + + +## Examples + The following example demonstrates how to use this method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/CS/LowerCaseStringConverter.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet5"::: + ]]> @@ -232,19 +232,19 @@ Converts an object to a lowercase string based on the specified parameters. A lowercase string object. - interface as the `ctx` parameter. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. The `ci` parameter object provides the culture-related information. The `value` object acts as both the object to convert and the resulting object once the method is complete. Override this method in a derived class if custom behavior is required. - - - -## Examples - The following example demonstrates how to use this method. - + interface as the `ctx` parameter. This interface provides contextual information about a component. Typically, this interface is used at design time to provide information about a design-time container. The is commonly used in type conversion. The `ci` parameter object provides the culture-related information. The `value` object acts as both the object to convert and the resulting object once the method is complete. Override this method in a derived class if custom behavior is required. + + + +## Examples + The following example demonstrates how to use this method. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/CS/LowerCaseStringConverter.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.LowerCaseStringConverter/VB/LowerCaseStringConverter.vb" id="Snippet6"::: + ]]> diff --git a/xml/System.Web.Configuration/MachineKeySection.xml b/xml/System.Web.Configuration/MachineKeySection.xml index 7359e95e2dc..5aab8e88838 100644 --- a/xml/System.Web.Configuration/MachineKeySection.xml +++ b/xml/System.Web.Configuration/MachineKeySection.xml @@ -78,7 +78,7 @@ class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -116,7 +116,7 @@ property. The property value is passed to the factory method. + This property must be set if you set the property. The property value is passed to the factory method. ]]> @@ -153,7 +153,7 @@ ## Remarks The upgraded encryption methods in later versions of the .NET Framework reduce the risk that an attacker can successfully reverse-engineer the `DecryptionKey` value. The older encryption methods are available in order to maintain backward compatibility. - All servers in a Web farm should have the property set to the same value. If the server that reads a forms authentication ticket has a different setting than the server that created the ticket, the ticket won't be recognized. + All servers in a Web farm should have the property set to the same value. If the server that reads a forms authentication ticket has a different setting than the server that created the ticket, the ticket won't be recognized. The following values can be specified for the property: @@ -167,7 +167,7 @@ - If the property has a value, the property must also have a value. The class mandates that a non-empty application name be provided. -- The attribute must be an actual validation algorithm (for example, MD5, SHA1, HMACSHA256, HMACSHA384, HMACSHA512) or a custom algorithm that subclasses the type. The values AES and 3DES are forbidden. +- The attribute must be an actual validation algorithm (for example, MD5, SHA1, HMACSHA256, HMACSHA384, HMACSHA512) or a custom algorithm that subclasses the type. The values AES and 3DES are forbidden. - The framework will not produce signed-only payloads. Forms authentication tickets will always be both encrypted and signed, regardless of how the `protection` attribute of the `forms` element is set in the Web.config file. View state will always be both encrypted and signed if either `EnableViewStateMac` or `RequireViewStateEncryption` is set for a given page. @@ -209,7 +209,7 @@ property to and set this property to a string that represents a class that derives from the class. This string corresponds to the `providerClass` parameter that is passed to the static factory method. The class you specify is used by the and methods even if you do not specify the option. + To specify custom data protection algorithms for ASP.NET, set the property to and set this property to a string that represents a class that derives from the class. This string corresponds to the `providerClass` parameter that is passed to the static factory method. The class you specify is used by the and methods even if you do not specify the option. If you set this property, you must also set the property. @@ -313,9 +313,9 @@ Use the "AutoGenerate" option to specify that ASP.NET generates a random key and stores it in the Local Security Authority. The "AutoGenerate" option is part of the default value. - If you add the "IsolateApps" modifier to the "AutoGenerate" value, ASP.NET generates a unique encrypted key for each application by using each application's . This is the default setting. + If you add the "IsolateApps" modifier to the "AutoGenerate" value, ASP.NET generates a unique encrypted key for each application by using each application's . This is the default setting. - If you add the "IsolateByAppId" modifier to the "AutoGenerate" value, ASP.NET generates a unique encrypted key for each application by using each application's . If two distinct applications share a virtual path (perhaps because those applications are running on different ports), this flag can be used to further distinguish them from one another. The "IsolateByAppId" flag is understood only by ASP.NET 4.5, but it can be used regardless of the setting. + If you add the "IsolateByAppId" modifier to the "AutoGenerate" value, ASP.NET generates a unique encrypted key for each application by using each application's . If two distinct applications share a virtual path (perhaps because those applications are running on different ports), this flag can be used to further distinguish them from one another. The "IsolateByAppId" flag is understood only by ASP.NET 4.5, but it can be used regardless of the setting. If you need to support configuration across a network of Web servers (a Web farm), set the property manually to ensure consistent configuration. For information about how to manually generate values for the `DecryptionKey` attribute, see [How To: Configure MachineKey in ASP.NET 2.0](https://go.microsoft.com/fwlink/?linkid=155113). @@ -545,9 +545,9 @@ Use the "AutoGenerate" option to specify that ASP.NET generates a random key and stores it in the Local Security Authority. The "AutoGenerate" option is part of the default value. - If you add the "IsolateApps" modifier to the "AutoGenerate" value, ASP.NET generates a unique encrypted key for each application by using each application's . This is the default setting. + If you add the "IsolateApps" modifier to the "AutoGenerate" value, ASP.NET generates a unique encrypted key for each application by using each application's . This is the default setting. - If you add the "IsolateByAppId" modifier to the "AutoGenerate" value, ASP.NET generates a unique encrypted key for each application by using each application's . If two distinct applications share a virtual path (perhaps because those applications are running on different ports), this flag can be used to further distinguish them from one another. The "IsolateByAppId" flag is understood only by ASP.NET 4.5, but it can be used regardless of the setting. + If you add the "IsolateByAppId" modifier to the "AutoGenerate" value, ASP.NET generates a unique encrypted key for each application by using each application's . If two distinct applications share a virtual path (perhaps because those applications are running on different ports), this flag can be used to further distinguish them from one another. The "IsolateByAppId" flag is understood only by ASP.NET 4.5, but it can be used regardless of the setting. If you need to support configuration across a network of Web servers (a Web farm), set the property manually to ensure consistent configuration. For information about how to manually generate values for the `DecryptionKey` attribute, see [How To: Configure MachineKey in ASP.NET 2.0](https://go.microsoft.com/fwlink/?linkid=155113). diff --git a/xml/System.Web.Configuration/MachineKeyValidation.xml b/xml/System.Web.Configuration/MachineKeyValidation.xml index 92d9391d0bb..02d9fdabee0 100644 --- a/xml/System.Web.Configuration/MachineKeyValidation.xml +++ b/xml/System.Web.Configuration/MachineKeyValidation.xml @@ -19,7 +19,7 @@ and . + ASP.NET uses a hash-based message authentication code (HMAC) to help detect whether data that is used for forms authentication or view state has been tampered with. The HMAC is generated when view state content is created, and the HMAC is checked on subsequent requests. The HMAC helps ASP.NET determine whether someone has changed data that is sent between the server and the client, but the data can be read by anyone as it travels through the Internet unless it is also encrypted. By default, view state is validated but not encrypted. For more information, see and . The `MachineKeyValidation` enumeration lets you specify the algorithm that ASP.NET uses to create the HMAC. The default value is `HMACSHA256`. ASP.NET uses the value of the property with the selected algorithm to generate the HMAC. diff --git a/xml/System.Web.Configuration/MembershipSection.xml b/xml/System.Web.Configuration/MembershipSection.xml index 1631dada81c..b830c1e728b 100644 --- a/xml/System.Web.Configuration/MembershipSection.xml +++ b/xml/System.Web.Configuration/MembershipSection.xml @@ -92,7 +92,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -131,7 +131,7 @@ must match a named value in the `providers` subsection of the `membership` section of the configuration file. An empty string (`""`) is not a valid value for the property. + The must match a named value in the `providers` subsection of the `membership` section of the configuration file. An empty string (`""`) is not a valid value for the property. @@ -298,7 +298,7 @@ property is calculated by comparing the current time minus the property with the value for the user. + The value for the property is calculated by comparing the current time minus the property with the value for the user. diff --git a/xml/System.Web.Configuration/NamespaceCollection.xml b/xml/System.Web.Configuration/NamespaceCollection.xml index 993fd0d572e..730ebfb21f8 100644 --- a/xml/System.Web.Configuration/NamespaceCollection.xml +++ b/xml/System.Web.Configuration/NamespaceCollection.xml @@ -114,7 +114,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet23"::: @@ -199,7 +199,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet24"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet24"::: @@ -360,7 +360,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet26"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet26"::: @@ -410,7 +410,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet25"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet25"::: diff --git a/xml/System.Web.Configuration/NamespaceInfo.xml b/xml/System.Web.Configuration/NamespaceInfo.xml index 56c8b59eee7..90af7797b39 100644 --- a/xml/System.Web.Configuration/NamespaceInfo.xml +++ b/xml/System.Web.Configuration/NamespaceInfo.xml @@ -85,7 +85,7 @@ ## Examples - The following code example shows how to use constructor. It is part of a larger example for the type. + The following code example shows how to use constructor. It is part of a larger example for the type. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet23"::: diff --git a/xml/System.Web.Configuration/OutputCacheProfile.xml b/xml/System.Web.Configuration/OutputCacheProfile.xml index f3c999277f1..7c11174b344 100644 --- a/xml/System.Web.Configuration/OutputCacheProfile.xml +++ b/xml/System.Web.Configuration/OutputCacheProfile.xml @@ -27,14 +27,14 @@ The can be applied to a page using the `CacheProfile` attribute of the `@ OutputCache` directive. > [!NOTE] -> 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 `@ 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. ## Examples - The following code example shows how to use the collection to access its objects. + The following code example shows how to use the collection to access its objects. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet1"::: @@ -99,10 +99,10 @@ 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. + 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 `@ OutputCache` 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. @@ -192,7 +192,7 @@ is set to `Any`, the output cache can be located on the browser client, where the request originated; on a proxy server, or any other server, participating in the request; or on the server where the request was processed. + If is set to `Any`, the output cache can be located on the browser client, where the request originated; on a proxy server, or any other server, participating in the request; or on the server where the request was processed. @@ -245,7 +245,7 @@ to assign a value to the `CacheProfile` attribute of the `@ OutputCache` 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. @@ -291,7 +291,7 @@ ## Remarks The page that has the property set to `true` issues a response specifying in its header to prevent secondary storage of sensitive information. - Setting this attribute to `true` is equivalent to invoking the method during a Web request. + Setting this attribute to `true` is equivalent to invoking the method during a Web request. @@ -363,7 +363,7 @@ defines a relationship between a Web application and an instance of SQL Server, allowing the detection of changes in the data at the server. The ensures that output cached pages are removed from the cache whenever the SQL table on which they depend changes. + The defines a relationship between a Web application and an instance of SQL Server, allowing the detection of changes in the data at the server. The ensures that output cached pages are removed from the cache whenever the SQL table on which they depend changes. > [!NOTE] > The class monitors the table so that when the table changes, the item will be automatically removed from the Cache. This class cannot be inherited. @@ -410,9 +410,9 @@ settings are the same ones used by the `VaryByContentEncoding` attribute of the `@ OutputCache` 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). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -448,12 +448,12 @@ is a semicolon-delimited set of IDs of controls to be cached. + The is a semicolon-delimited set of IDs of controls to be cached. 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 `VaryByControl` attribute of the `@ OutputCache` directive. +> The settings are the same ones used by the `VaryByControl` attribute of the `@ OutputCache` directive. @@ -498,10 +498,10 @@ 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. + 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 `@ OutputCache` directive. +> The settings are the same ones used by the `VaryByCustom` attribute of the `@ OutputCache` directive. @@ -548,10 +548,10 @@ is a semicolon-delimited set of headers used to vary the cached output. These are HTTP headers associated with the request. For more information, see [Caching Multiple Versions of a Page](https://learn.microsoft.com/previous-versions/aspnet/xadzbzd6(v=vs.100)). + The is a semicolon-delimited set of headers used to vary the cached output. These are HTTP headers associated with the request. For more information, see [Caching Multiple Versions of a Page](https://learn.microsoft.com/previous-versions/aspnet/xadzbzd6(v=vs.100)). > [!NOTE] -> The settings are the same ones used by the `VaryByHeader` attribute of the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)). Varying by all headers by setting the value of "\*" is not recommended. It can result in cache overflow or a denial of service attack on the Web server. +> The settings are the same ones used by the `VaryByHeader` attribute of the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)). Varying by all headers by setting the value of "\*" is not recommended. It can result in cache overflow or a denial of service attack on the Web server. @@ -596,12 +596,12 @@ 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 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 `@ OutputCache` 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://learn.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. +> The settings are the same ones used by the `VaryByParam` attribute of the [@ OutputCache](https://learn.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/OutputCacheProfileCollection.xml b/xml/System.Web.Configuration/OutputCacheProfileCollection.xml index 844782eb956..3d348bcc78b 100644 --- a/xml/System.Web.Configuration/OutputCacheProfileCollection.xml +++ b/xml/System.Web.Configuration/OutputCacheProfileCollection.xml @@ -99,7 +99,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/CS/OutputCacheProfileCollection.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/VB/OutputCacheProfileCollection.vb" id="Snippet2"::: @@ -170,7 +170,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/CS/OutputCacheProfileCollection.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/VB/OutputCacheProfileCollection.vb" id="Snippet3"::: @@ -240,7 +240,7 @@ method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/CS/OutputCacheProfileCollection.cs" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/VB/OutputCacheProfileCollection.vb" id="Snippet11"::: @@ -277,7 +277,7 @@ method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/CS/OutputCacheProfileCollection.cs" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/VB/OutputCacheProfileCollection.vb" id="Snippet11"::: @@ -340,7 +340,7 @@ method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/CS/OutputCacheProfileCollection.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/VB/OutputCacheProfileCollection.vb" id="Snippet6"::: @@ -487,12 +487,12 @@ method inserts a `remove` element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection. + The method inserts a `remove` element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection. ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/CS/OutputCacheProfileCollection.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/VB/OutputCacheProfileCollection.vb" id="Snippet8"::: @@ -529,12 +529,12 @@ method inserts a `remove` element into the corresponding section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the corresponding section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection. + The method inserts a `remove` element into the corresponding section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the corresponding section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection. ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/CS/OutputCacheProfileCollection.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfileCollection/VB/OutputCacheProfileCollection.vb" id="Snippet7"::: @@ -571,7 +571,7 @@ method modifies an existing element. + The method modifies an existing element. ]]> diff --git a/xml/System.Web.Configuration/OutputCacheSection.xml b/xml/System.Web.Configuration/OutputCacheSection.xml index 751b8445f4e..266d7296ca1 100644 --- a/xml/System.Web.Configuration/OutputCacheSection.xml +++ b/xml/System.Web.Configuration/OutputCacheSection.xml @@ -56,7 +56,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -182,7 +182,7 @@ Setting the property to `true` doesn't ensure kernel caching of responses. Modules in the processing pipeline must set the kernel cache policy. - is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + is introduced in the .NET Framework version 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). ]]> @@ -268,7 +268,7 @@ property is `false`. By default, ASP.NET sends the `vary` header in all `POST` requests, as well as in all GET-request query strings. If the is `true`, ASP.NET omits the `vary` header when returning the response for cached pages, provided that the `GET` request to a response is cached with no `VaryByCustom` property and the `POST` request to a response is cached with no `VaryByParam` property and no `VaryByCustom` property. + The `vary` header indicates the request-header fields that the server uses to determine which of multiple cached responses are sent in response to a client request. The default for the property is `false`. By default, ASP.NET sends the `vary` header in all `POST` requests, as well as in all GET-request query strings. If the is `true`, ASP.NET omits the `vary` header when returning the response for cached pages, provided that the `GET` request to a response is cached with no `VaryByCustom` property and the `POST` request to a response is cached with no `VaryByParam` property and no `VaryByCustom` property. @@ -371,7 +371,7 @@ applies to content with no output caching specified. When it is set to `false`, the `cache-control:private` header is not sent by default. + The applies to content with no output caching specified. When it is set to `false`, the `cache-control:private` header is not sent by default. > [!NOTE] > This setting enables the content to be cached on the client by default. diff --git a/xml/System.Web.Configuration/OutputCacheSettingsSection.xml b/xml/System.Web.Configuration/OutputCacheSettingsSection.xml index a55b48e86ea..6e03488488d 100644 --- a/xml/System.Web.Configuration/OutputCacheSettingsSection.xml +++ b/xml/System.Web.Configuration/OutputCacheSettingsSection.xml @@ -23,7 +23,7 @@ The class allows you to programmatically access and modify the `outputCacheSettings` element of the `caching` section in a configuration file. The output cache settings define the dependencies (the relationships between items stored in the cache and files, cache keys, or objects) that are used in output caching, for instance, by the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)) directive or by the . > [!NOTE] -> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. +> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. @@ -67,7 +67,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/PagesSection.xml b/xml/System.Web.Configuration/PagesSection.xml index 8f37977d97e..1c04d179306 100644 --- a/xml/System.Web.Configuration/PagesSection.xml +++ b/xml/System.Web.Configuration/PagesSection.xml @@ -20,7 +20,7 @@ class provides a way to programmatically access and modify the content of the configuration file [pages](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/950xf363(v=vs.100)) section. This configuration section supports setting certain ASP.NET page and control directives globally for all pages and controls in the scope of the configuration file. This includes the `@ Page` directive, the `@ Import` directive through the collection property, and the `@ Register` directive through the collection property. It also provides support for mapping tag types to other tag types at run time through the collection property. + The class provides a way to programmatically access and modify the content of the configuration file [pages](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/950xf363(v=vs.100)) section. This configuration section supports setting certain ASP.NET page and control directives globally for all pages and controls in the scope of the configuration file. This includes the `@ Page` directive, the `@ Import` directive through the collection property, and the `@ Register` directive through the collection property. It also provides support for mapping tag types to other tag types at run time through the collection property. Directives specify settings used by the page and user-control compilers when they process ASP.NET Web Forms page (.aspx) and user control (.ascx) files. @@ -113,7 +113,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -193,9 +193,9 @@ is `true`, ASP.NET does not require that you explicitly bind event handlers to a page event such as . + When is `true`, ASP.NET does not require that you explicitly bind event handlers to a page event such as . - When is `false`, you must explicitly bind the event to a method. For example, if you have a `Page_Load` method in the code for a page, the method will be called in response to the event only if you write code like that in the following example (notice the `Handles` statement in Visual Basic and the event handler code in C#): + When is `false`, you must explicitly bind the event to a method. For example, if you have a `Page_Load` method in the code for a page, the method will be called in response to the event only if you write code like that in the following example (notice the `Handles` statement in Visual Basic and the event handler code in C#): ```vb Partial Class AutoEventWireupExample @@ -221,17 +221,17 @@ public partial class AutoEventWireupExample : System.Web.UI.Page } ``` - When is `true`, handlers are automatically bound to events at run time based on their name and signature. For each event, ASP.NET searches for a method that is named according to the pattern `Page_`*eventname*, such as `Page_Load` or `Page_Init`. ASP.NET checks first for an overload that has the typical event-handler signature (that is, it specifies and parameters). If an event handler with this signature is not found, ASP.NET checks for an overload that has no parameters. + When is `true`, handlers are automatically bound to events at run time based on their name and signature. For each event, ASP.NET searches for a method that is named according to the pattern `Page_`*eventname*, such as `Page_Load` or `Page_Init`. ASP.NET checks first for an overload that has the typical event-handler signature (that is, it specifies and parameters). If an event handler with this signature is not found, ASP.NET checks for an overload that has no parameters. - When is `false`, you must explicitly bind event handlers to events, as shown in the preceding example. In that case, the method names do not have to follow a pattern. + When is `false`, you must explicitly bind event handlers to events, as shown in the preceding example. In that case, the method names do not have to follow a pattern. - The default value is `true` if is not specified in the `@ Page` directive. Visual Studio automatically includes the attribute when it creates code-behind files. For ASP.NET pages written in C#, Visual Studio sets the value to `true`. For Visual Basic, Visual Studio sets the value to `false` because handlers are bound to events by using the [Handles](/dotnet/visual-basic/language-reference/statements/handles-clause) keyword, which is inserted automatically by Visual Studio when it generates an event handler. If you set to `true`, you can omit (or remove) the [Handles](/dotnet/visual-basic/language-reference/statements/handles-clause) keyword. + The default value is `true` if is not specified in the `@ Page` directive. Visual Studio automatically includes the attribute when it creates code-behind files. For ASP.NET pages written in C#, Visual Studio sets the value to `true`. For Visual Basic, Visual Studio sets the value to `false` because handlers are bound to events by using the [Handles](/dotnet/visual-basic/language-reference/statements/handles-clause) keyword, which is inserted automatically by Visual Studio when it generates an event handler. If you set to `true`, you can omit (or remove) the [Handles](/dotnet/visual-basic/language-reference/statements/handles-clause) keyword. - Do not set to `true` if performance is a key consideration. When automatic event wireup is enabled, ASP.NET must make between 15 and 30 tries to match events with methods. + Do not set to `true` if performance is a key consideration. When automatic event wireup is enabled, ASP.NET must make between 15 and 30 tries to match events with methods. Note the following about binding event handlers to events: -- If you set to `true`, make sure that you do not also manually attach page event handlers to events. If you do, handlers might be called more than one time. +- If you set to `true`, make sure that you do not also manually attach page event handlers to events. If you do, handlers might be called more than one time. - Automatic binding is performed only for page events, not for events for controls on the page. @@ -245,14 +245,14 @@ public partial class AutoEventWireupExample : System.Web.UI.Page :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet9"::: - The following example shows the two forms of method signatures that are automatically attached to page events when is `true`. + The following example shows the two forms of method signatures that are automatically attached to page events when is `true`. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/Default.aspx" id="Snippet50"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/Default2.aspx.cs" id="Snippet50"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/Default.aspx" id="Snippet50"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/Default2.aspx.vb" id="Snippet50"::: - The following example shows how to explicitly wire up events when is `false`. + The following example shows how to explicitly wire up events when is `false`. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/Default.aspx.cs" id="Snippet51"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/Default.aspx.vb" id="Snippet51"::: @@ -291,7 +291,7 @@ public partial class AutoEventWireupExample : System.Web.UI.Page to `true` if performance is a key consideration. + When response buffering is turned on, the page or control output is buffered until after the entire page or control is processed. Do not set to `true` if performance is a key consideration. @@ -530,9 +530,9 @@ public partial class AutoEventWireupExample : System.Web.UI.Page attribute indicates whether event validation should be performed. The default value is `true`. A Web application can optionally disable event validation to revert to .NET Framework version 1.0 behavior. + The attribute indicates whether event validation should be performed. The default value is `true`. A Web application can optionally disable event validation to revert to .NET Framework version 1.0 behavior. - The base control checks this attribute to determine whether it should validate events. A derived control does not inherit this base control attribute, and so it is exempt from event validation by default. You still instruct ASP.NET to perform event validation on the derived control by adding the attribute to the derived control itself and setting it to `true`. + The base control checks this attribute to determine whether it should validate events. A derived control does not inherit this base control attribute, and so it is exempt from event validation by default. You still instruct ASP.NET to perform event validation on the derived control by adding the attribute to the derived control itself and setting it to `true`. > [!NOTE] > Event validation reduces the risk of unauthorized postback requests and callbacks. It instructs ASP.NET to validate only those events that can be raised in the control during a postback request or callback. With this model, a control registers its events during rendering and then validates the events during the post-back or callback handling. All event-driven controls in ASP.NET use this feature by default. @@ -806,7 +806,7 @@ public partial class AutoEventWireupExample : System.Web.UI.Page value, then the data is split between multiple view-state fields. + Page and control view state is stored in hidden view-state fields when the page or control is rendered. If the length of the data stored exceeds the value, then the data is split between multiple view-state fields. @@ -1008,7 +1008,7 @@ public partial class AutoEventWireupExample : System.Web.UI.Page ## Remarks You can use the property to specify that some system-generated hidden fields are rendered at the end of the form. - In versions of ASP.NET earlier than the .NET Framework 3.5 SP1, ASP.NET renders some hidden fields (for example, `__VIEWSTATE`) at the top of the form. Other hidden fields (for example, `__EVENTVALIDATION`) are rendered near the bottom of the form, just before the closing `` tag. By default, in ASP.NET 3.5 SP1, all system-generated hidden fields are rendered at the top of the page. This makes sure that the information in these fields is sent to the server even if a postback is performed before the page has finished loading. If is set to `false`, performing a postback before the page has finished loading can cause an "Invalid postback or callback argument" error. + In versions of ASP.NET earlier than the .NET Framework 3.5 SP1, ASP.NET renders some hidden fields (for example, `__VIEWSTATE`) at the top of the form. Other hidden fields (for example, `__EVENTVALIDATION`) are rendered near the bottom of the form, just before the closing `` tag. By default, in ASP.NET 3.5 SP1, all system-generated hidden fields are rendered at the top of the page. This makes sure that the information in these fields is sent to the server even if a postback is performed before the page has finished loading. If is set to `false`, performing a postback before the page has finished loading can cause an "Invalid postback or callback argument" error. > [!NOTE] > Although the property name indicates "all hidden fields," user-created hidden fields are not affected by settings for this property. @@ -1321,7 +1321,7 @@ public partial class AutoEventWireupExample : System.Web.UI.Page enumeration values are `Always`, `Auto`, and `Never`. The default value is `Auto`. If property is set to `Auto`, `ViewState` will be encrypted when a control requests it. + The possible enumeration values are `Always`, `Auto`, and `Never`. The default value is `Auto`. If property is set to `Auto`, `ViewState` will be encrypted when a control requests it. ]]> diff --git a/xml/System.Web.Configuration/PassportAuthentication.xml b/xml/System.Web.Configuration/PassportAuthentication.xml index aa8754593f7..46c424d5366 100644 --- a/xml/System.Web.Configuration/PassportAuthentication.xml +++ b/xml/System.Web.Configuration/PassportAuthentication.xml @@ -154,7 +154,7 @@ specifies the URL of the page to which the request must be redirected if Passport authentication is required and the user has not signed on using Passport authentication. + The specifies the URL of the page to which the request must be redirected if Passport authentication is required and the user has not signed on using Passport authentication. ]]> diff --git a/xml/System.Web.Configuration/ProcessModelSection.xml b/xml/System.Web.Configuration/ProcessModelSection.xml index 57be777224c..de8b7453299 100644 --- a/xml/System.Web.Configuration/ProcessModelSection.xml +++ b/xml/System.Web.Configuration/ProcessModelSection.xml @@ -24,7 +24,7 @@ The class controls various aspects of the ASP.NET worker process, including its lifetime, the number of instances created at a time, what security identity it runs under, and the size of the CLR thread pool to service requests. - When ASP.NET is running under IIS 6 in native mode, ASP.NET uses the IIS 6 process model and ignores most settings in this section. Use the IIS administration user interface (UI) to configure those properties. ASP.NET still uses the following properties, which can be configured through the configuration file: , , , , , and . + When ASP.NET is running under IIS 6 in native mode, ASP.NET uses the IIS 6 process model and ignores most settings in this section. Use the IIS administration user interface (UI) to configure those properties. ASP.NET still uses the following properties, which can be configured through the configuration file: , , , , , and . The `processModel` section cannot be encrypted using the protected-configuration feature or tools because it is consumed by the ASP.NET ISAPI extension. @@ -89,7 +89,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -126,9 +126,9 @@ value is set to `false`, explicit Web.config values are used to determine performance configuration for the ASP.NET application. If the value is set to `true`, the performance settings are automatically configured for the ASP.NET application. + If the value is set to `false`, explicit Web.config values are used to determine performance configuration for the ASP.NET application. If the value is set to `true`, the performance settings are automatically configured for the ASP.NET application. - The value is explicitly set to `true` in the Machine.config file. The default code value is set to `false`. If the value is removed from Machine.config, the explicit settings are used instead of the auto-configured settings. + The value is explicitly set to `true` in the Machine.config file. The default code value is set to `false`. If the value is removed from Machine.config, the explicit settings are used instead of the auto-configured settings. ]]> @@ -304,7 +304,7 @@ value specifies a bit pattern that indicates the CPUs eligible to run ASP.NET threads. If the property is set to `true`, the limits worker processes to the number of eligible CPUs. The maximum allowed number of worker processes is equal to the number of CPUs. By default, all CPUs are enabled and ASP.NET launches one process for each CPU. If the property is set to `false`, the attribute is ignored and only one worker process will run. + The value specifies a bit pattern that indicates the CPUs eligible to run ASP.NET threads. If the property is set to `true`, the limits worker processes to the number of eligible CPUs. The maximum allowed number of worker processes is equal to the number of CPUs. By default, all CPUs are enabled and ASP.NET launches one process for each CPU. If the property is set to `false`, the attribute is ignored and only one worker process will run. @@ -376,7 +376,7 @@ property specifies whether ASP.NET is hosted in an external worker process. If is `true`, ASP.NET is hosted in an external worker process; otherwise, it runs directly in Inetinfo.exe. + The property specifies whether ASP.NET is hosted in an external worker process. If is `true`, ASP.NET is hosted in an external worker process; otherwise, it runs directly in Inetinfo.exe. > [!NOTE] > Running ASP.NET in Inetinfo.exe is not recommended, because this involves running the application in the Local System security context. When ASP.NET runs in Internet Information Services (IIS) 6 native mode, this setting is ignored, so there is usually no reason to set it to `false`. @@ -517,7 +517,7 @@ threshold is exceeded, the least-used application domain is shut down if a new application domain must start. + If the threshold is exceeded, the least-used application domain is shut down if a new application domain must start. @@ -564,7 +564,7 @@ must be equal to or greater than the setting in the `httpRuntime` configuration section. + The value of must be equal to or greater than the setting in the `httpRuntime` configuration section. You can have some control over the CPU utilization by setting the number of worker threads and I/O threads, using the property and the property respectively. @@ -621,7 +621,7 @@ must be equal to or greater than the setting in the `httpRuntime` configuration section. + The value of must be equal to or greater than the setting in the `httpRuntime` configuration section. You can have some control over the CPU utilization by setting the number of worker threads and I/O threads, using the property and, the property, respectively. @@ -851,7 +851,7 @@ interval has expired. + The worker process is restarted (bounced) if it is not running after the interval has expired. @@ -898,7 +898,7 @@ interval. If the worker process does not respond within the interval, the process is restarted. + The ISAPI extensions ping the worker process at the interval. If the worker process does not respond within the interval, the process is restarted. @@ -1079,7 +1079,7 @@ . + The process is restarted if there are queued requests and if there has not been a response during the time interval that is defined by . @@ -1363,9 +1363,9 @@ defines a Windows identity different from that of the default process. This identity is used to run the ASP.NET worker process. + If present, the defines a Windows identity different from that of the default process. This identity is used to run the ASP.NET worker process. - By default, is set to the special value Machine, and the process runs under a user account named ASPNET that is created automatically when ASP.NET is installed. + By default, is set to the special value Machine, and the process runs under a user account named ASPNET that is created automatically when ASP.NET is installed. The property must be used with the property. @@ -1418,7 +1418,7 @@ ## Remarks The property must be used with the property. - If the property is set to `false`, the attribute is ignored and only one worker process runs. + If the property is set to `false`, the attribute is ignored and only one worker process runs. > [!NOTE] > A multiprocessor Web server is called a Web garden. diff --git a/xml/System.Web.Configuration/ProfileGroupSettings.xml b/xml/System.Web.Configuration/ProfileGroupSettings.xml index eaa3dd09ce5..d24e73fd106 100644 --- a/xml/System.Web.Configuration/ProfileGroupSettings.xml +++ b/xml/System.Web.Configuration/ProfileGroupSettings.xml @@ -64,7 +64,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/ProfileGroupSettingsCollection.xml b/xml/System.Web.Configuration/ProfileGroupSettingsCollection.xml index 3a3c3e4aaf3..20681a18279 100644 --- a/xml/System.Web.Configuration/ProfileGroupSettingsCollection.xml +++ b/xml/System.Web.Configuration/ProfileGroupSettingsCollection.xml @@ -23,51 +23,51 @@ Contains a set of objects. - class contains a collection of objects, which each contain a collection of objects. - - The class provides a way to programmatically create, access, and modify the definition of an individual property added to the `` subsection of the `` section of a configuration file. - - The `` section of the configuration file specifies a schema for user profiles. At run time, the ASP.NET compilation system uses the information specified in the `` section to generate a class called `ProfileCommon`, which is derived from . The `ProfileCommon` class definition is based on the properties defined in the `` subsection of the `` section of the configuration file. - - For more information about profile properties, see [ASP.NET Profile Properties Overview](https://learn.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)). For more information about the profile features added to ASP.NET version 2.0, see [ASP.NET Profile Properties Overview](https://learn.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)). - - - -## Examples - The following configuration file excerpt shows how to declaratively specify values for several properties of the as `` elements of the `` element of the `` configuration file section. - -``` - - - - - - - - - - - - - - - - - - - - - -``` - + class contains a collection of objects, which each contain a collection of objects. + + The class provides a way to programmatically create, access, and modify the definition of an individual property added to the `` subsection of the `` section of a configuration file. + + The `` section of the configuration file specifies a schema for user profiles. At run time, the ASP.NET compilation system uses the information specified in the `` section to generate a class called `ProfileCommon`, which is derived from . The `ProfileCommon` class definition is based on the properties defined in the `` subsection of the `` section of the configuration file. + + For more information about profile properties, see [ASP.NET Profile Properties Overview](https://learn.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)). For more information about the profile features added to ASP.NET version 2.0, see [ASP.NET Profile Properties Overview](https://learn.microsoft.com/previous-versions/aspnet/2y3fs9xs(v=vs.100)). + + + +## Examples + The following configuration file excerpt shows how to declaratively specify values for several properties of the as `` elements of the `` element of the `` configuration file section. + +``` + + + + + + + + + + + + + + + + + + + + + +``` + ]]> @@ -119,19 +119,19 @@ A object to add to the collection. Adds a object to the collection. - object with the same name. - - - -## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. - + object with the same name. + + + +## Examples + The following code example shows how to use the method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/CS/profilesection.cs" id="Snippet13"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet13"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet13"::: + ]]> The object to add already exists in the collection, or the collection is read-only. @@ -182,19 +182,19 @@ Removes all objects from the collection. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/CS/profilesection.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet2"::: + ]]> @@ -514,19 +514,19 @@ The name of the object to remove from the collection. Removes a object from the collection. - ` element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection. - - - -## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. - + ` element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection. + + + +## Examples + The following code example shows how to use the method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/CS/profilesection.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet1"::: + ]]> There is no object at the specified index in the collection, the element has already been removed, or the collection is read-only. @@ -557,11 +557,11 @@ The index of the object to remove from the collection. Removes a object from the collection. - ` element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection. - + ` element into the appropriate section of the configuration file for any element defined in a higher-level configuration file. If the element is defined in the appropriate section of the current configuration file, its entry is removed from the configuration file. The object to remove must exist in the collection. + ]]> There is no object at the specified index in the collection, the element has already been removed, or the collection is read-only. @@ -614,11 +614,11 @@ A object. Adds the specified object to the collection. - method. - + method. + ]]> The object to add already exists in the collection, or the collection is read-only. diff --git a/xml/System.Web.Configuration/ProfilePropertySettings.xml b/xml/System.Web.Configuration/ProfilePropertySettings.xml index ff490de8e39..dc2956fc7ec 100644 --- a/xml/System.Web.Configuration/ProfilePropertySettings.xml +++ b/xml/System.Web.Configuration/ProfilePropertySettings.xml @@ -77,11 +77,11 @@ |Setting|Default Value| |-------------|-------------------| -||`false`.| -||An empty string ("").| -||`false`.| -||.| -||An empty string ("").| +||`false`.| +||An empty string ("").| +||`false`.| +||.| +||An empty string ("").| ]]> diff --git a/xml/System.Web.Configuration/ProfilePropertySettingsCollection.xml b/xml/System.Web.Configuration/ProfilePropertySettingsCollection.xml index ede85bb9f4b..0f21a852957 100644 --- a/xml/System.Web.Configuration/ProfilePropertySettingsCollection.xml +++ b/xml/System.Web.Configuration/ProfilePropertySettingsCollection.xml @@ -99,7 +99,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/CS/profilesection.cs" id="Snippet22"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet22"::: @@ -186,7 +186,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/CS/profilesection.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet2"::: @@ -475,7 +475,7 @@ throws specialized errors if the element name is either "clear" or "group". After checking for these conditions, the method then explicitly calls its base implementation, the method. + This implementation of throws specialized errors if the element name is either "clear" or "group". After checking for these conditions, the method then explicitly calls its base implementation, the method. ]]> @@ -546,7 +546,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/CS/profilesection.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet1"::: @@ -597,7 +597,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/CS/profilesection.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.ProfileSection/VB/profilesection.vb" id="Snippet1"::: @@ -643,7 +643,7 @@ method. + Calling this method has the same effect as calling the method. ]]> diff --git a/xml/System.Web.Configuration/ProfileSection.xml b/xml/System.Web.Configuration/ProfileSection.xml index d10a537a00e..afeb44f067c 100644 --- a/xml/System.Web.Configuration/ProfileSection.xml +++ b/xml/System.Web.Configuration/ProfileSection.xml @@ -104,11 +104,11 @@ local Microsoft SQL Server database" /> |Setting|Default Value| |-------------|-------------------| -||"AspNetSqlProfileProvider".| -||`true`.| -||An empty string ("").| -||An empty .| -||An empty .| +||"AspNetSqlProfileProvider".| +||`true`.| +||An empty string ("").| +||An empty .| +||An empty .| ]]> @@ -145,7 +145,7 @@ local Microsoft SQL Server database" /> property is `false`, changes to individual profiles are not saved unless the method of the `ProfileCommon` class is called in code. When the property is `true`, the event also allows code to override the automatic save behavior. + When the property is `false`, changes to individual profiles are not saved unless the method of the `ProfileCommon` class is called in code. When the property is `true`, the event also allows code to override the automatic save behavior. diff --git a/xml/System.Web.Configuration/ProfileSettings.xml b/xml/System.Web.Configuration/ProfileSettings.xml index 8593729ed46..afc0c47c170 100644 --- a/xml/System.Web.Configuration/ProfileSettings.xml +++ b/xml/System.Web.Configuration/ProfileSettings.xml @@ -91,15 +91,15 @@ |Property|Default value| |--------------|-------------------| -||An empty string ("").| -||.| -||1.| -||.| +||An empty string ("").| +||.| +||1.| +||.| ## Examples - The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet51"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet51"::: @@ -143,12 +143,12 @@ |Property|Default value| |--------------|-------------------| -||An empty string ("").| +||An empty string ("").| ## Examples - The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet52"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet52"::: @@ -190,7 +190,7 @@ constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet53"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet53"::: diff --git a/xml/System.Web.Configuration/ProfileSettingsCollection.xml b/xml/System.Web.Configuration/ProfileSettingsCollection.xml index ab8546657f4..4ce63f7bb04 100644 --- a/xml/System.Web.Configuration/ProfileSettingsCollection.xml +++ b/xml/System.Web.Configuration/ProfileSettingsCollection.xml @@ -106,7 +106,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet2"::: @@ -146,7 +146,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet61"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet61"::: @@ -185,7 +185,7 @@ method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet56"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet56"::: @@ -272,7 +272,7 @@ method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet57"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet57"::: @@ -316,7 +316,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet54"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet54"::: @@ -364,7 +364,7 @@ method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet67"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet67"::: @@ -460,7 +460,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet59"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet59"::: @@ -503,7 +503,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet60"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet60"::: diff --git a/xml/System.Web.Configuration/ProtocolCollection.xml b/xml/System.Web.Configuration/ProtocolCollection.xml index 335c05a1a2a..a6767540cf7 100644 --- a/xml/System.Web.Configuration/ProtocolCollection.xml +++ b/xml/System.Web.Configuration/ProtocolCollection.xml @@ -23,11 +23,11 @@ Represents a configuration element that contains a collection of protocols. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -55,11 +55,11 @@ Initializes a new instance of the class. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -88,11 +88,11 @@ The element to add. Adds a configuration element to the instance. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -118,11 +118,11 @@ Gets all the keys of the instance. The array that contains the collection keys. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -148,11 +148,11 @@ Removes all configuration element objects from the collection. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -215,11 +215,11 @@ Gets the specified collection item. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -248,11 +248,11 @@ Gets the object at the specified index of the collection. A object. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -282,11 +282,11 @@ Gets the value of the first entry with the specified key. A object that represents the value of the first entry with the specified key, if found; otherwise, . - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -328,11 +328,11 @@ Removes a object from the collection. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -360,11 +360,11 @@ The key of the object to remove. Removes the object that has the specified key from the collection. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -393,11 +393,11 @@ The element to remove. Removes the specified object from the collection. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> @@ -426,11 +426,11 @@ The index location of the element to remove. Removes the object at the specified index location. - is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). - + is introduced in the .NET Framework 3.5. For more information, see [Versions and Dependencies](/dotnet/framework/migration-guide/versions-and-dependencies). + ]]> diff --git a/xml/System.Web.Configuration/ProvidersHelper.xml b/xml/System.Web.Configuration/ProvidersHelper.xml index 3b4d9e6cff4..66b4e2fcfa7 100644 --- a/xml/System.Web.Configuration/ProvidersHelper.xml +++ b/xml/System.Web.Configuration/ProvidersHelper.xml @@ -45,15 +45,15 @@ Initializes and returns a single provider of the given type using the supplied settings. A new provider of the given type using the supplied settings. To be added. - The provider type defined in configuration was or an empty string (""). - + The provider type defined in configuration was or an empty string (""). + -or- - + The provider type defined in configuration is not compatible with the type used by the feature that is attempting to create a new instance of the provider. - The provider threw an exception while it was being initialized. - + The provider threw an exception while it was being initialized. + -or- - + An error occurred while attempting to resolve a instance for the provider specified in . @@ -84,11 +84,11 @@ The of the providers to be initialized. Initializes a collection of providers of the given type using the supplied settings. - method, and any exceptions thrown by that method will bubble up through the method. - + method, and any exceptions thrown by that method will bubble up through the method. + ]]> diff --git a/xml/System.Web.Configuration/RoleManagerSection.xml b/xml/System.Web.Configuration/RoleManagerSection.xml index a09ab35cce2..680add02218 100644 --- a/xml/System.Web.Configuration/RoleManagerSection.xml +++ b/xml/System.Web.Configuration/RoleManagerSection.xml @@ -97,24 +97,24 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. - The following table shows the default settings that are used for the constructor. + The following table shows the default settings that are used for the constructor. |Property|Default value| |--------------|-------------------| -||`false`| -||`false`| -||".ASPXROLES"| -||"/"| -||`All`| -||`false`| -||`true`| -||30, in minutes| -||`false`| -||"AspNetSqlRoleProvider"| -||An empty string ("")| -||25| +||`false`| +||`false`| +||".ASPXROLES"| +||"/"| +||`All`| +||`false`| +||`true`| +||30, in minutes| +||`false`| +||"AspNetSqlRoleProvider"| +||An empty string ("")| +||25| ]]> @@ -389,7 +389,7 @@ property, in minutes. While the user continues to actively use the ASP.NET application, the expiration date and time of the cookie is automatically refreshed, if there is less than half of the remaining. The default is `true`. + You can specify whether the cookie that is used to cache role names is periodically reset or expired at a fixed point in time by using the `cookieSlidingExpiration` attribute in the Web.config file for your ASP.NET application. If `true`, the cookie expiration is initially set to the current date and time plus the property, in minutes. While the user continues to actively use the ASP.NET application, the expiration date and time of the cookie is automatically refreshed, if there is less than half of the remaining. The default is `true`. diff --git a/xml/System.Web.Configuration/RootProfilePropertySettingsCollection.xml b/xml/System.Web.Configuration/RootProfilePropertySettingsCollection.xml index 2fc2c15ff62..52df58016ad 100644 --- a/xml/System.Web.Configuration/RootProfilePropertySettingsCollection.xml +++ b/xml/System.Web.Configuration/RootProfilePropertySettingsCollection.xml @@ -70,8 +70,8 @@ |Setting|Default Value| |-------------|-------------------| -||`True`.| -||An empty .| +||`True`.| +||An empty .| ]]> diff --git a/xml/System.Web.Configuration/RuleSettings.xml b/xml/System.Web.Configuration/RuleSettings.xml index 832fe8540e8..b3cc579a3fa 100644 --- a/xml/System.Web.Configuration/RuleSettings.xml +++ b/xml/System.Web.Configuration/RuleSettings.xml @@ -119,16 +119,16 @@ |Property|Default value| |--------------|-------------------| -||An empty string ("").| -||.| -||1.| -||0 ticks.| -||An empty string ("").| +||An empty string ("").| +||.| +||1.| +||0 ticks.| +||An empty string ("").| ## Examples - The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet74"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet74"::: @@ -177,12 +177,12 @@ |Property|Default value| |--------------|-------------------| -||An empty string ("").| +||An empty string ("").| ## Examples - The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet75"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet75"::: @@ -234,7 +234,7 @@ ## Examples - The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet76"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet76"::: diff --git a/xml/System.Web.Configuration/RuleSettingsCollection.xml b/xml/System.Web.Configuration/RuleSettingsCollection.xml index f6da21f9af8..b6aa519006a 100644 --- a/xml/System.Web.Configuration/RuleSettingsCollection.xml +++ b/xml/System.Web.Configuration/RuleSettingsCollection.xml @@ -106,7 +106,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet73"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet73"::: @@ -146,7 +146,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet84"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet84"::: @@ -190,7 +190,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet79"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet79"::: @@ -282,7 +282,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet80"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet80"::: @@ -326,7 +326,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet77"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet77"::: @@ -381,7 +381,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet93"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet93"::: @@ -478,7 +478,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet82"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet82"::: @@ -521,7 +521,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/CS/healthmonitoringsection.cs" id="Snippet83"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HealthMonitoringSection/VB/healthmonitoringsection.vb" id="Snippet83"::: diff --git a/xml/System.Web.Configuration/ScriptingJsonSerializationSection.xml b/xml/System.Web.Configuration/ScriptingJsonSerializationSection.xml index e16ca3557bd..ea100d9c4a2 100644 --- a/xml/System.Web.Configuration/ScriptingJsonSerializationSection.xml +++ b/xml/System.Web.Configuration/ScriptingJsonSerializationSection.xml @@ -197,7 +197,7 @@ ## Remarks The property refers to the maximum level of an object hierarchy that will process when deserializing a JavaScript Object Notation (JSON) string or when serializing an object. - The value of applies only to the internal instance that is used by the asynchronous communication layer to invoke Web services methods. + The value of applies only to the internal instance that is used by the asynchronous communication layer to invoke Web services methods. ]]> diff --git a/xml/System.Web.Configuration/ScriptingProfileServiceSection.xml b/xml/System.Web.Configuration/ScriptingProfileServiceSection.xml index d67eebf71f9..e8518efd9db 100644 --- a/xml/System.Web.Configuration/ScriptingProfileServiceSection.xml +++ b/xml/System.Web.Configuration/ScriptingProfileServiceSection.xml @@ -167,7 +167,7 @@ ## Remarks In order to use read-access profile properties in AJAX-enabled applications, add one or more profile property names to the property. - You can set to an empty string array. This means that no profile properties are allowed to be read from client script. + You can set to an empty string array. This means that no profile properties are allowed to be read from client script. ]]> @@ -204,7 +204,7 @@ ## Remarks In order to use write-access profile properties in AJAX-enabled applications, add one or more profile property names to the property. - You can set to an empty string array. This means that no profile properties are allowed to be set from client script. + You can set to an empty string array. This means that no profile properties are allowed to be set from client script. ]]> diff --git a/xml/System.Web.Configuration/ScriptingSectionGroup.xml b/xml/System.Web.Configuration/ScriptingSectionGroup.xml index 513f2bbfc6b..a0e28e3e88e 100644 --- a/xml/System.Web.Configuration/ScriptingSectionGroup.xml +++ b/xml/System.Web.Configuration/ScriptingSectionGroup.xml @@ -17,11 +17,11 @@ Represents the configuration section for scripting settings. This class cannot be inherited. - class to programmatically set and retrieve the values of the `scripting` section of the configuration file. - + class to programmatically set and retrieve the values of the `scripting` section of the configuration file. + ]]> @@ -78,11 +78,11 @@ Gets a object that is derived from the current system configuration. A object. - and properties. - + and properties. + ]]> diff --git a/xml/System.Web.Configuration/SecurityPolicySection.xml b/xml/System.Web.Configuration/SecurityPolicySection.xml index 369f432178d..185e27f6359 100644 --- a/xml/System.Web.Configuration/SecurityPolicySection.xml +++ b/xml/System.Web.Configuration/SecurityPolicySection.xml @@ -76,7 +76,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -139,7 +139,7 @@ property are `Full`, `High`, `Medium`, `Low`, and `Minimal`. The items of the collection each specify a security-level name and an associated policy file. You can extend the security system by providing your own named trust-level element mapped to a file specified by the `policyFile` attribute. For information about creating trust-level elements, see [trustLevel Element for securityPolicy (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/729ab04c-03da-4ee5-86b1-be9d08a09369). + The default values for the property are `Full`, `High`, `Medium`, `Low`, and `Minimal`. The items of the collection each specify a security-level name and an associated policy file. You can extend the security system by providing your own named trust-level element mapped to a file specified by the `policyFile` attribute. For information about creating trust-level elements, see [trustLevel Element for securityPolicy (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/729ab04c-03da-4ee5-86b1-be9d08a09369). diff --git a/xml/System.Web.Configuration/SessionPageStateSection.xml b/xml/System.Web.Configuration/SessionPageStateSection.xml index cf9dd30d078..6776f4c2b26 100644 --- a/xml/System.Web.Configuration/SessionPageStateSection.xml +++ b/xml/System.Web.Configuration/SessionPageStateSection.xml @@ -23,7 +23,7 @@ The refers to the `sessionPageState` section of the configuration file. > [!NOTE] -> The can read and write information from and to the related section of the configuration file according to the section property whose value is . +> The can read and write information from and to the related section of the configuration file according to the section property whose value is . @@ -66,7 +66,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/SessionStateSection.xml b/xml/System.Web.Configuration/SessionStateSection.xml index 0f65bad84fe..0d8345baa89 100644 --- a/xml/System.Web.Configuration/SessionStateSection.xml +++ b/xml/System.Web.Configuration/SessionStateSection.xml @@ -91,7 +91,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> @@ -165,7 +165,7 @@ value is set to `true`, ASP.NET uses the class to compress and expand session-state data. + When the value is set to `true`, ASP.NET uses the class to compress and expand session-state data. ]]> @@ -210,9 +210,9 @@ Session state also supports two additional options: and . The former enables the session-state module to determine what mode (cookie or cookieless) is used on a per-client basis based on the browser capabilities. The option performs a handshake with the browser to verify whether a cookie may be stored, and therefore requires an additional request to make the determination. If you need to support cookieless clients, strongly consider using to generate cookieless URLs only for clients that require them. > [!NOTE] -> With UP.Browser 4.1 or UP.Browser 3.2, always behaves as if the value of the property of the object is `false`, unless the property in the section of Web.config has been explicitly set to `true`. +> With UP.Browser 4.1 or UP.Browser 3.2, always behaves as if the value of the property of the object is `false`, unless the property in the section of Web.config has been explicitly set to `true`. > -> In ASP.NET version 1.1, the options for this setting were `true` or `false`, but with ASP.NET 2.0, the choices are expanded, and is now the default setting. If your Web application has the property set to a Boolean value, then should work as expected for these browsers. +> In ASP.NET version 1.1, the options for this setting were `true` or `false`, but with ASP.NET 2.0, the choices are expanded, and is now the default setting. If your Web application has the property set to a Boolean value, then should work as expected for these browsers. @@ -445,7 +445,7 @@ property is specified, the property and property are ignored. The can be locked via the property like other properties within the [sessionState Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v=vs.100)) element. The connection string returned by the will be used on every request to connect to the appropriate server location for the remainder of the request. If the connection string is invalid, ASP.NET will throw the same exception that is thrown when the configured connection string to the server is invalid. + If the property is specified, the property and property are ignored. The can be locked via the property like other properties within the [sessionState Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v=vs.100)) element. The connection string returned by the will be used on every request to connect to the appropriate server location for the remainder of the request. If the connection string is invalid, ASP.NET will throw the same exception that is thrown when the configured connection string to the server is invalid. This property is used to partition session-state data across multiple backend nodes when in SQL or state-server mode. @@ -576,7 +576,7 @@ is enabled. + By default, only cookieless URLs are reissued when is enabled. @@ -619,7 +619,7 @@ overrides session ID generation and management for custom session ID management schemes. The default value is an empty string (""). + The overrides session ID generation and management for custom session ID management schemes. The default value is an empty string (""). ]]> @@ -699,7 +699,7 @@ specifies the time interval in seconds before reconnecting to the database when a connection error has occurred. + The specifies the time interval in seconds before reconnecting to the database when a connection error has occurred. ]]> @@ -734,7 +734,7 @@ is set to . + This `sqlConnectionString` attribute is required when is set to . > [!NOTE] > To use the session state mode, you must run the InstallSqlState.sql SQL script (which is installed in [*drive*:]\WINDOWS\Microsoft.NET\Framework\\*VersionNumber* as part of the default .NET Framework installation) on the computer running SQL Server that will store the session state. This creates a database called ASPState with new stored procedures and creates new ASPStateTempApplications and ASPStateTempSessions tables in the TempDB database. @@ -780,7 +780,7 @@ is set to . + This property specifies the server name and the port when the session state is stored remotely. The `stateConnectionString` attribute is required when the is set to . > [!NOTE] > Make sure the ASP.NET state service is running on the remote server that stores the session-state information. This service is installed with ASP.NET and is located by default at [*drive*:]\WINDOWS\Microsoft.NET\Framework\\*VersionNumber*\aspnet_state.exe. diff --git a/xml/System.Web.Configuration/SiteMapSection.xml b/xml/System.Web.Configuration/SiteMapSection.xml index e37dec3b4b6..8fdae4bbadd 100644 --- a/xml/System.Web.Configuration/SiteMapSection.xml +++ b/xml/System.Web.Configuration/SiteMapSection.xml @@ -82,7 +82,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/SqlCacheDependencyDatabase.xml b/xml/System.Web.Configuration/SqlCacheDependencyDatabase.xml index b98ae80aca5..8eda7934545 100644 --- a/xml/System.Web.Configuration/SqlCacheDependencyDatabase.xml +++ b/xml/System.Web.Configuration/SqlCacheDependencyDatabase.xml @@ -277,7 +277,7 @@ ## Remarks The property allows you to programmatically access and modify the `pollTime` attribute of an `add` element of the `databases` node in a configuration file. - After you configure the relationship between an item stored in an ASP.NET application's cache and a specific SQL Server database table, an instance of the class monitors the table so that when an item in the table changes, the item is automatically updated in or removed from the cache. The monitoring happens at the frequency specified by the . + After you configure the relationship between an item stored in an ASP.NET application's cache and a specific SQL Server database table, an instance of the class monitors the table so that when an item in the table changes, the item is automatically updated in or removed from the cache. The monitoring happens at the frequency specified by the . diff --git a/xml/System.Web.Configuration/SqlCacheDependencyDatabaseCollection.xml b/xml/System.Web.Configuration/SqlCacheDependencyDatabaseCollection.xml index ef029f19fa0..267935d9d8c 100644 --- a/xml/System.Web.Configuration/SqlCacheDependencyDatabaseCollection.xml +++ b/xml/System.Web.Configuration/SqlCacheDependencyDatabaseCollection.xml @@ -70,7 +70,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the property. ]]> @@ -107,7 +107,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/CS/sqlcachedependencydatabasecollection.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/VB/sqlcachedependencydatabasecollection.vb" id="Snippet3"::: @@ -178,7 +178,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/CS/sqlcachedependencydatabasecollection.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/VB/sqlcachedependencydatabasecollection.vb" id="Snippet4"::: @@ -252,7 +252,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/CS/sqlcachedependencydatabasecollection.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/VB/sqlcachedependencydatabasecollection.vb" id="Snippet5"::: @@ -294,7 +294,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/CS/sqlcachedependencydatabasecollection.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/VB/sqlcachedependencydatabasecollection.vb" id="Snippet6"::: @@ -362,7 +362,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/CS/sqlcachedependencydatabasecollection.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/VB/sqlcachedependencydatabasecollection.vb" id="Snippet7"::: @@ -459,7 +459,7 @@ method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/CS/sqlcachedependencydatabasecollection.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/VB/sqlcachedependencydatabasecollection.vb" id="Snippet8"::: @@ -495,7 +495,7 @@ method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/CS/sqlcachedependencydatabasecollection.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/VB/sqlcachedependencydatabasecollection.vb" id="Snippet9"::: @@ -538,7 +538,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/CS/sqlcachedependencydatabasecollection.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SqlCacheDependencyDatabaseCollection/VB/sqlcachedependencydatabasecollection.vb" id="Snippet10"::: diff --git a/xml/System.Web.Configuration/SqlCacheDependencySection.xml b/xml/System.Web.Configuration/SqlCacheDependencySection.xml index eaf386a03be..fb14e0e57af 100644 --- a/xml/System.Web.Configuration/SqlCacheDependencySection.xml +++ b/xml/System.Web.Configuration/SqlCacheDependencySection.xml @@ -27,7 +27,7 @@ The settings in this element only affect the table-based version of the object. The row-level objects used with SQL Server 2005 and above are not affected by these settings. > [!NOTE] -> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. +> The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. @@ -70,7 +70,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/SystemWebCachingSectionGroup.xml b/xml/System.Web.Configuration/SystemWebCachingSectionGroup.xml index 800cbc9baf8..719f74915a8 100644 --- a/xml/System.Web.Configuration/SystemWebCachingSectionGroup.xml +++ b/xml/System.Web.Configuration/SystemWebCachingSectionGroup.xml @@ -28,7 +28,7 @@ The following list describes the two types of caching ASP.NET provides. -- The first is called output caching, which allows you to store dynamic page and user control responses. On subsequent requests, the page or user control code is not executed; the cached output is used to satisfy the request. You can access output caching settings using the and properties. +- The first is called output caching, which allows you to store dynamic page and user control responses. On subsequent requests, the page or user control code is not executed; the cached output is used to satisfy the request. You can access output caching settings using the and properties. - The second type of caching is traditional application data caching, which you can use to programmatically store arbitrary objects to server memory so your application can save the time and resources it takes to recreate them. You can access these cache settings using the property. @@ -74,7 +74,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/SystemWebSectionGroup.xml b/xml/System.Web.Configuration/SystemWebSectionGroup.xml index 3cf2a723046..49b4c65cb3d 100644 --- a/xml/System.Web.Configuration/SystemWebSectionGroup.xml +++ b/xml/System.Web.Configuration/SystemWebSectionGroup.xml @@ -59,7 +59,7 @@ class by using the method. + This constructor is called by the ASP.NET configuration system and is not intended to be used directly from your code. You can obtain an instance of the class by using the method. ]]> diff --git a/xml/System.Web.Configuration/TagMapCollection.xml b/xml/System.Web.Configuration/TagMapCollection.xml index 2184bfa046a..86cbabda32e 100644 --- a/xml/System.Web.Configuration/TagMapCollection.xml +++ b/xml/System.Web.Configuration/TagMapCollection.xml @@ -130,7 +130,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet42"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet42"::: diff --git a/xml/System.Web.Configuration/TagMapInfo.xml b/xml/System.Web.Configuration/TagMapInfo.xml index 64242341804..c23108e0f45 100644 --- a/xml/System.Web.Configuration/TagMapInfo.xml +++ b/xml/System.Web.Configuration/TagMapInfo.xml @@ -84,7 +84,7 @@ constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet42"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet42"::: diff --git a/xml/System.Web.Configuration/TagPrefixCollection.xml b/xml/System.Web.Configuration/TagPrefixCollection.xml index 27710aa860b..ec0cd4440ac 100644 --- a/xml/System.Web.Configuration/TagPrefixCollection.xml +++ b/xml/System.Web.Configuration/TagPrefixCollection.xml @@ -83,7 +83,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. The property of the class always contains an instance of the type. Use this instance, rather than creating your own. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. The property of the class always contains an instance of the type. Use this instance, rather than creating your own. ]]> @@ -121,7 +121,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet32"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet32"::: diff --git a/xml/System.Web.Configuration/TagPrefixInfo.xml b/xml/System.Web.Configuration/TagPrefixInfo.xml index 20c1c03d02e..7fc78acff9e 100644 --- a/xml/System.Web.Configuration/TagPrefixInfo.xml +++ b/xml/System.Web.Configuration/TagPrefixInfo.xml @@ -24,9 +24,9 @@ objects are added to the collection using the `add` element and specifying a value for the `tagPrefix` attribute along with values for other relevant attributes. The other required information varies based on the kind of control you will use with the specified tag prefix: -- If it is a user control, you must define the , , and properties. +- If it is a user control, you must define the , , and properties. -- If it is a custom control, you must define the , , and properties. The property is not required if the control is in the application code directory. +- If it is a custom control, you must define the , , and properties. The property is not required if the control is in the application code directory. The same `tagPrefix` value can be used to map to multiple assemblies or namespaces. @@ -106,7 +106,7 @@ ## Examples - The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/CS/usingpagessection.cs" id="Snippet32"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PagesSection/VB/usingpagessection.vb" id="Snippet32"::: diff --git a/xml/System.Web.Configuration/TraceSection.xml b/xml/System.Web.Configuration/TraceSection.xml index fb982b738bc..ee66b5c4991 100644 --- a/xml/System.Web.Configuration/TraceSection.xml +++ b/xml/System.Web.Configuration/TraceSection.xml @@ -171,7 +171,7 @@ property. When the request limit is reached and is `true`, older requests are automatically discarded and new requests continue to be added to the log. When the request limit is reached and is `false`, new requests are discarded until earlier requests are removed from the log or the request limit is increased. + Requests are stored in the trace log in the order they arrive, up to the number of requests specified in the property. When the request limit is reached and is `true`, older requests are automatically discarded and new requests continue to be added to the log. When the request limit is reached and is `false`, new requests are discarded until earlier requests are removed from the log or the request limit is increased. @@ -290,7 +290,7 @@ The property gets or sets a value that determines whether the requests stored on the server are the most recent requests or the first requests to arrive. - **Note** When the number of requests exceeds the limit imposed by this setting and is `false`, no more requests are stored in the trace log. If is `true`, the most recent requests are stored up to the limit imposed by this setting and older requests are discarded. + **Note** When the number of requests exceeds the limit imposed by this setting and is `false`, no more requests are stored in the trace log. If is `true`, the most recent requests are stored up to the limit imposed by this setting and older requests are discarded. diff --git a/xml/System.Web.Configuration/TransformerInfo.xml b/xml/System.Web.Configuration/TransformerInfo.xml index 2e24a1bd767..f20589a4110 100644 --- a/xml/System.Web.Configuration/TransformerInfo.xml +++ b/xml/System.Web.Configuration/TransformerInfo.xml @@ -85,7 +85,7 @@ ## Examples - The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. + The following code example shows how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet5"::: diff --git a/xml/System.Web.Configuration/TransformerInfoCollection.xml b/xml/System.Web.Configuration/TransformerInfoCollection.xml index 49ed0144d87..90f21bbd552 100644 --- a/xml/System.Web.Configuration/TransformerInfoCollection.xml +++ b/xml/System.Web.Configuration/TransformerInfoCollection.xml @@ -89,7 +89,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. The property of the class always contains an instance of the type. Use this instance, rather than creating your own. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. The property of the class always contains an instance of the type. Use this instance, rather than creating your own. ]]> @@ -127,7 +127,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet5"::: @@ -171,7 +171,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet9"::: @@ -257,7 +257,7 @@ property overwrites the object if it already exists; otherwise, a new object is created and added to the collection. + The property overwrites the object if it already exists; otherwise, a new object is created and added to the collection. @@ -331,7 +331,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet7"::: @@ -372,7 +372,7 @@ ## Examples - The following code example shows how to use the method. This code example is part of a larger example provided for the class. + The following code example shows how to use the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/CS/usingwebpartssection.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebPartsSection/VB/usingwebpartssection.vb" id="Snippet8"::: diff --git a/xml/System.Web.Configuration/TrustLevel.xml b/xml/System.Web.Configuration/TrustLevel.xml index bea1c538466..7f2b9a845c8 100644 --- a/xml/System.Web.Configuration/TrustLevel.xml +++ b/xml/System.Web.Configuration/TrustLevel.xml @@ -62,12 +62,12 @@ constructor creates a object by using the supplied parameters. + The constructor creates a object by using the supplied parameters. ## Examples - The following code example demonstrates how to use the constructor. This code example is part of a larger example provided for the class. + The following code example demonstrates how to use the constructor. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.TrustLevel/CS/trustlevel.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevel/VB/trustlevel.vb" id="Snippet4"::: diff --git a/xml/System.Web.Configuration/TrustLevelCollection.xml b/xml/System.Web.Configuration/TrustLevelCollection.xml index 8db88c00590..b8b5902d026 100644 --- a/xml/System.Web.Configuration/TrustLevelCollection.xml +++ b/xml/System.Web.Configuration/TrustLevelCollection.xml @@ -23,19 +23,19 @@ Contains a collection of objects. This class cannot be inherited. - objects are used to map specific security levels to named policy files. - - - -## Examples - The following code example demonstrates how to use the class. - + objects are used to map specific security levels to named policy files. + + + +## Examples + The following code example demonstrates how to use the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/CS/trustlevelcollection.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/VB/trustlevelcollection.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/VB/trustlevelcollection.vb" id="Snippet1"::: + ]]> @@ -88,14 +88,14 @@ The to add to the collection. Adds a object to the collection. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/CS/trustlevelcollection.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/VB/trustlevelcollection.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/VB/trustlevelcollection.vb" id="Snippet2"::: + ]]> @@ -120,11 +120,11 @@ Removes all objects from the collection. - entries exist in the local node collection, all entries are deleted. - + entries exist in the local node collection, all entries are deleted. + ]]> @@ -220,14 +220,14 @@ Gets the object at the specified index. The at the specified index. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/CS/trustlevelcollection.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/VB/trustlevelcollection.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/VB/trustlevelcollection.vb" id="Snippet4"::: + ]]> @@ -317,11 +317,11 @@ Gets or sets the item at the specified index within the object. A at the specified index. - object exists at the specified index, the object is removed and a new one is added. If no object exists at the index, a new one is added. - + object exists at the specified index, the object is removed and a new one is added. If no object exists at the index, a new one is added. + ]]> @@ -350,11 +350,11 @@ Gets the object at the specified index. A that exists at the specified index of the . - object must exist at the specified index within the object. - + object must exist at the specified index within the object. + ]]> @@ -410,11 +410,11 @@ The to remove from the . Removes a object from the object. - object does not exist in the local node collection, no error is raised. - + object does not exist in the local node collection, no error is raised. + ]]> @@ -469,14 +469,14 @@ The to be set within the . Adds the specified object to the object at the specified index. - method. This code example is part of a larger example provided for the class. - + method. This code example is part of a larger example provided for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/CS/trustlevelcollection.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/VB/trustlevelcollection.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.TrustLevelCollection/VB/trustlevelcollection.vb" id="Snippet3"::: + ]]> diff --git a/xml/System.Web.Configuration/TrustSection.xml b/xml/System.Web.Configuration/TrustSection.xml index 5cc8081dbda..7449f71ca5c 100644 --- a/xml/System.Web.Configuration/TrustSection.xml +++ b/xml/System.Web.Configuration/TrustSection.xml @@ -71,14 +71,14 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. - The following table shows the default settings that are used for the constructor. + The following table shows the default settings that are used for the constructor. |Setting|Default value| |-------------|-------------------| -||`Full`| -||`""`| +||`Full`| +||`""`| ]]> @@ -112,7 +112,7 @@ is an empty string, the application uses ASP.NET default policy to determine an assembly's permissions. The default policy for evaluating permissions grants full trust to the Global Assembly Cache (GAC) assemblies and partial trust to the other assemblies. + If is an empty string, the application uses ASP.NET default policy to determine an assembly's permissions. The default policy for evaluating permissions grants full trust to the Global Assembly Cache (GAC) assemblies and partial trust to the other assemblies. This attribute cannot be set to a `null` value. diff --git a/xml/System.Web.Configuration/UrlMapping.xml b/xml/System.Web.Configuration/UrlMapping.xml index e3b4634e17a..8721cb697d1 100644 --- a/xml/System.Web.Configuration/UrlMapping.xml +++ b/xml/System.Web.Configuration/UrlMapping.xml @@ -22,10 +22,10 @@ ## Remarks The class allows you to map a URL that is displayed to users to a URL that exists in your Web application. Adding a object to a is the programmatic equivalent to including an `add` element in the `urlMappings` section of a configuration file. - Each object contains two properties identifying a URL. One property specifies the URL shown to the user; the other specifies a URL in your Web application. Trailing white-space characters are ignored in both the and properties. + Each object contains two properties identifying a URL. One property specifies the URL shown to the user; the other specifies a URL in your Web application. Trailing white-space characters are ignored in both the and properties. > [!NOTE] -> The property can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. +> The property can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. @@ -67,7 +67,7 @@ constructor is intended primarily for internal use by ASP.NET. You do not need to derive from this class, and because it can be used to modify the Web.config file, you will probably never need to use it in code. + The constructor is intended primarily for internal use by ASP.NET. You do not need to derive from this class, and because it can be used to modify the Web.config file, you will probably never need to use it in code. diff --git a/xml/System.Web.Configuration/UrlMappingCollection.xml b/xml/System.Web.Configuration/UrlMappingCollection.xml index 3f607ff8818..033266a102d 100644 --- a/xml/System.Web.Configuration/UrlMappingCollection.xml +++ b/xml/System.Web.Configuration/UrlMappingCollection.xml @@ -26,7 +26,7 @@ type allows access to the elements of the section element collection. + The type allows access to the elements of the section element collection. @@ -70,7 +70,7 @@ constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using property. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using property. ]]> @@ -160,19 +160,19 @@ method, the result will be dependent upon the chosen . + If you save the configuration file after calling the method, the result will be dependent upon the chosen . - The following list describes the conditions that apply if you use the method to save the file: + The following list describes the conditions that apply if you use the method to save the file: - If you pass or as the parameter value, a `clear` element is inserted into the `urlMappings` section of the configuration file at the current hierarchy level. -- If you pass as the parameter value, a series of `remove` elements are added to the `urlMappings` of the configuration file at the current hierarchy level. These `remove` elements remove all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. With the enumeration value, there is one additional property on the collection that affects what gets serialized to the configuration file. The property is and is `false` by default. One of the following conditions applies: +- If you pass as the parameter value, a series of `remove` elements are added to the `urlMappings` of the configuration file at the current hierarchy level. These `remove` elements remove all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. With the enumeration value, there is one additional property on the collection that affects what gets serialized to the configuration file. The property is and is `false` by default. One of the following conditions applies: - - set to `true`. A `clear` element is inserted into the `urlMappings` section of the configuration file at the current hierarchy level. This removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. + - set to `true`. A `clear` element is inserted into the `urlMappings` section of the configuration file at the current hierarchy level. This removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy. - - flag is set to `false`. This has the effect of removing the `clear` element from the `urlMappings` section of the configuration file at the current hierarchy level, if it exists. + - flag is set to `false`. This has the effect of removing the `clear` element from the `urlMappings` section of the configuration file at the current hierarchy level, if it exists. - The method actually deletes the `add` elements defined in the `urlMappings` section of the configuration file at the current hierarchy level. It also removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy but does not delete them. + The method actually deletes the `add` elements defined in the `urlMappings` section of the configuration file at the current hierarchy level. It also removes all references to the `add` elements defined in the parent configuration files at higher levels in the hierarchy but does not delete them. @@ -389,7 +389,7 @@ method deletes the `add` element in the `urlMappings` section at the current hierarchy level and inserts a `remove` element. The remove element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. + The method deletes the `add` element in the `urlMappings` section at the current hierarchy level and inserts a `remove` element. The remove element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. @@ -433,7 +433,7 @@ method deletes the `add` element in the `urlMappings` section at the current hierarchy level and inserts a `remove` element. The remove element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. + The method deletes the `add` element in the `urlMappings` section at the current hierarchy level and inserts a `remove` element. The remove element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. @@ -477,7 +477,7 @@ method deletes the `add` element in the `urlMappings` section at the current hierarchy level and inserts a `remove` element. The remove element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. + The method deletes the `add` element in the `urlMappings` section at the current hierarchy level and inserts a `remove` element. The remove element effectively removes the reference to the `add` element defined in the parent configuration files at higher levels in the hierarchy but does not delete it. diff --git a/xml/System.Web.Configuration/UrlMappingsSection.xml b/xml/System.Web.Configuration/UrlMappingsSection.xml index 8bf059df7c0..fce4a0570d3 100644 --- a/xml/System.Web.Configuration/UrlMappingsSection.xml +++ b/xml/System.Web.Configuration/UrlMappingsSection.xml @@ -17,31 +17,31 @@ Provides programmatic access to the configuration section. This class cannot be inherited. - class provides a way to programmatically access and modify the `urlMappings` section of a configuration file. - + class provides a way to programmatically access and modify the `urlMappings` section of a configuration file. + > [!NOTE] -> The `urlMappings` section contains objects that map URLs that are displayed to users to URLs that exist in your Web application. The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. - - - -## Examples - The following code example shows how to obtain the object from the configuration file of an existing Web application. Also shown is an excerpt of the configuration file. - +> The `urlMappings` section contains objects that map URLs that are displayed to users to URLs that exist in your Web application. The can write information into the related section of the configuration file according to the restrictions defined by the section property whose value is . Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy. + + + +## Examples + The following code example shows how to obtain the object from the configuration file of an existing Web application. Also shown is an excerpt of the configuration file. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.UrlMapping/CS/urlmapping.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.UrlMapping/VB/urlmapping.vb" id="Snippet1"::: - -``` - - - - -``` - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.UrlMapping/VB/urlmapping.vb" id="Snippet1"::: + +``` + + + + +``` + ]]> @@ -70,11 +70,11 @@ Initializes a new instance of the class. - constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. - + constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + ]]> @@ -162,19 +162,19 @@ Gets a collection of objects. A that contains objects. - object contains two properties identifying a URL. One property specifies the URL shown to the user; the other specifies a URL in your Web application. - - - -## Examples - The following code example shows how to obtain the `urlMappings` section. - + object contains two properties identifying a URL. One property specifies the URL shown to the user; the other specifies a URL in your Web application. + + + +## Examples + The following code example shows how to obtain the `urlMappings` section. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.UrlMapping/CS/urlmapping.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.UrlMapping/VB/urlmapping.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.UrlMapping/VB/urlmapping.vb" id="Snippet2"::: + ]]> diff --git a/xml/System.Web.Configuration/WebConfigurationManager.xml b/xml/System.Web.Configuration/WebConfigurationManager.xml index 32e2d5dcd4f..a2bd7ce7a22 100644 --- a/xml/System.Web.Configuration/WebConfigurationManager.xml +++ b/xml/System.Web.Configuration/WebConfigurationManager.xml @@ -28,7 +28,7 @@ - `Handling configuration`. To handle configuration information using the standard types, you use one of the following approaches: - - `Accessing a section`. To access configuration information for your application, you must use one of the `GetSection` methods provided by . For `` and ``, you use the and properties. These methods perform read-only operations, use a single cached instance of the configuration, and are multithread aware. + - `Accessing a section`. To access configuration information for your application, you must use one of the `GetSection` methods provided by . For `` and ``, you use the and properties. These methods perform read-only operations, use a single cached instance of the configuration, and are multithread aware. - `Accessing configuration files`. Your application can read and write configuration settings at any level, for itself or for other applications or computers, locally or remotely. You use one of the `open` methods provided by . These methods will return a object, which in turn provides the required methods and properties to handle the underlying configuration files. These methods perform read or write operations and recreate the configuration data every time a file is opened. @@ -41,7 +41,7 @@ ## Examples The following example shows how to access configuration information with the - method. + method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet2"::: @@ -100,7 +100,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet8"::: @@ -186,25 +186,25 @@ Note: If you use a static method that takes a is called from within a Web application, it gets the section from the configuration file selected by the system according to the Web-application configuration hierarchy. + If is called from within a Web application, it gets the section from the configuration file selected by the system according to the Web-application configuration hierarchy. > [!CAUTION] -> If your application uses a different protocol than HTTP, the overload that takes both a section name and a path in its parameter list is the one to use. You must specify the configuration file path because the system cannot make any assumptions about the configuration hierarchy level. If you use the overload that takes only a section name, the system will always attempt to return the configuration settings at the application level. Note, though, that if its specified path is outside of the current application, the overload that takes a path will also return the application-level configuration settings for the currently running application. +> If your application uses a different protocol than HTTP, the overload that takes both a section name and a path in its parameter list is the one to use. You must specify the configuration file path because the system cannot make any assumptions about the configuration hierarchy level. If you use the overload that takes only a section name, the system will always attempt to return the configuration settings at the application level. Note, though, that if its specified path is outside of the current application, the overload that takes a path will also return the application-level configuration settings for the currently running application. - You could call from within a client application. In this case, it gets the default section from the configuration file selected by the system according to the client configuration hierarchy. Usually, this is the Machine.config file, unless you have a mapped configuration in place. For mapping configuration files, refer to the mapping methods described next. + You could call from within a client application. In this case, it gets the default section from the configuration file selected by the system according to the client configuration hierarchy. Usually, this is the Machine.config file, unless you have a mapped configuration in place. For mapping configuration files, refer to the mapping methods described next. > [!NOTE] -> The method is a run-time method that operates on the section of a configuration file at the hierarchy level in which the application runs. For a non-run-time operation, use instead. This method operates on the specified section of a configuration file that you obtain using one of the overloaded methods for opening a configuration file, . +> The method is a run-time method that operates on the section of a configuration file at the hierarchy level in which the application runs. For a non-run-time operation, use instead. This method operates on the specified section of a configuration file that you obtain using one of the overloaded methods for opening a configuration file, . ## Examples - The examples in this section show how to access configuration information with the method. + The examples in this section show how to access configuration information with the method. The following example shows a section that can be accessed from either a Web application or a console application. > [!NOTE] -> This example demonstrates how to use the method to get a object from a configuration file. +> This example demonstrates how to use the method to get a object from a configuration file. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet2"::: @@ -247,25 +247,25 @@ Note: If you use a static method that takes a is called from within a Web application, it gets the section from the configuration file defined by the specified path in the configuration hierarchy. + If is called from within a Web application, it gets the section from the configuration file defined by the specified path in the configuration hierarchy. > [!CAUTION] -> If your application uses a different protocol than HTTP, the overload that takes both a section name and a path in its parameter list is the one to use. You must specify the configuration file path because the system cannot make any assumptions about the configuration hierarchy level. If you use the overload that takes only a section name, the system will always attempt to return the configuration settings at the application level. Note, though, that if its specified path is outside of the current application, the overload that takes a path will also return the application-level configuration settings for the currently running application. +> If your application uses a different protocol than HTTP, the overload that takes both a section name and a path in its parameter list is the one to use. You must specify the configuration file path because the system cannot make any assumptions about the configuration hierarchy level. If you use the overload that takes only a section name, the system will always attempt to return the configuration settings at the application level. Note, though, that if its specified path is outside of the current application, the overload that takes a path will also return the application-level configuration settings for the currently running application. This method cannot be called from within a client application. - If you want to retrieve the configuration section from the configuration file located at the current Web application directory level, use the method. + If you want to retrieve the configuration section from the configuration file located at the current Web application directory level, use the method. > [!NOTE] -> The method is a run-time method operating on the section of a configuration file at the hierarchy level in which the application runs. For a non-run-time operation, use instead. This method operates on the specified section of a configuration file that you obtain using one of the `open` configuration file methods. +> The method is a run-time method operating on the section of a configuration file at the hierarchy level in which the application runs. For a non-run-time operation, use instead. This method operates on the specified section of a configuration file that you obtain using one of the `open` configuration file methods. ## Examples - The following example shows how to access configuration information with the method. + The following example shows how to access configuration information with the method. > [!NOTE] -> This example demonstrates how to use the method to get a object from a specified configuration file. +> This example demonstrates how to use the method to get a object from a specified configuration file. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet5"::: @@ -307,20 +307,20 @@ Note: If you use a static method that takes a is called from within a Web application, it gets the section from the configuration file selected by the system according to the Web-application configuration hierarchy. + If is called from within a Web application, it gets the section from the configuration file selected by the system according to the Web-application configuration hierarchy. - You could call from within a client application. In this case, it gets the default section from the configuration file selected by the system according to the client configuration hierarchy. Usually, this is the Machine.config file, unless you have a mapped configuration in place. For mapping configuration files, refer to the mapping methods described next. + You could call from within a client application. In this case, it gets the default section from the configuration file selected by the system according to the client configuration hierarchy. Usually, this is the Machine.config file, unless you have a mapped configuration in place. For mapping configuration files, refer to the mapping methods described next. > [!NOTE] -> The method is a run-time operation that acts on the section of the application configuration file located at the current level. The method, however, is not a run-time operation but acts on the specified section obtained through one of the methods for opening the configuration files. +> The method is a run-time operation that acts on the section of the application configuration file located at the current level. The method, however, is not a run-time operation but acts on the specified section obtained through one of the methods for opening the configuration files. ## Examples - The following example shows how to access configuration information with the method. + The following example shows how to access configuration information with the method. > [!NOTE] -> This example demonstrates how to use the method to get a object from the default configuration file. +> This example demonstrates how to use the method to get a object from the default configuration file. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet6"::: @@ -368,12 +368,12 @@ Note: If you use a static method that takes a method opens the machine-configuration file on the computer where the application runs. This file is located in the standard build directory %windir%\Microsoft.NET\Framework\version\config. + The method opens the machine-configuration file on the computer where the application runs. This file is located in the standard build directory %windir%\Microsoft.NET\Framework\version\config. ## Examples - The following example shows how to access configuration information with the method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet9"::: @@ -416,7 +416,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet10"::: @@ -461,7 +461,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet11"::: @@ -517,7 +517,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet12"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet12"::: @@ -569,7 +569,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet13"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet13"::: @@ -712,7 +712,7 @@ Note: If you use a static method that takes a method. + The following example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet21"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet21"::: @@ -722,7 +722,7 @@ Note: If you use a static method that takes a for an example that shows how to map a virtual directory hierarchy to a physical one. + Refer to for an example that shows how to map a virtual directory hierarchy to a physical one. ]]> @@ -767,12 +767,12 @@ Note: If you use a static method that takes a method. + The following example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet22"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet22"::: - Refer to for an example that shows how to map a virtual directory hierarchy to a physical one. + Refer to for an example that shows how to map a virtual directory hierarchy to a physical one. ]]> @@ -819,12 +819,12 @@ Note: If you use a static method that takes a method. + The following example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet23"::: - Refer to for an example that shows how to map a virtual directory hierarchy to a physical one. + Refer to for an example that shows how to map a virtual directory hierarchy to a physical one. ]]> @@ -876,7 +876,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet14"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet14"::: @@ -921,7 +921,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet15"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet15"::: @@ -968,7 +968,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet16"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet16"::: @@ -1017,7 +1017,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet17"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet17"::: @@ -1080,7 +1080,7 @@ Note: If you use a static method that takes a method to access configuration information. + The following example shows how to use the method to access configuration information. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet19"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet19"::: @@ -1140,7 +1140,7 @@ Note: If you use a static method that takes a method. + The following example shows how to access configuration information with the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/CS/WebConfigurationManager.cs" id="Snippet18"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebConfigurationManager/VB/WebConfigurationManager.vb" id="Snippet18"::: diff --git a/xml/System.Web.Configuration/WebControlsSection.xml b/xml/System.Web.Configuration/WebControlsSection.xml index 33b263c34e4..dc766ab9744 100644 --- a/xml/System.Web.Configuration/WebControlsSection.xml +++ b/xml/System.Web.Configuration/WebControlsSection.xml @@ -17,22 +17,22 @@ Configures the section. This class cannot be inherited. - class provides a way to programmatically access and modify the `webControls` section of a configuration file. - + class provides a way to programmatically access and modify the `webControls` section of a configuration file. + > [!NOTE] -> ASP.NET provides a shared location for the client script files, where they can be accessed from multiple pages and across applications. The can read and write information from and to the related section of the configuration file according to the section property whose value is . - - - -## Examples - The following code example shows how to obtain the object from the configuration file associated with an existing Web application. - +> ASP.NET provides a shared location for the client script files, where they can be accessed from multiple pages and across applications. The can read and write information from and to the related section of the configuration file according to the section property whose value is . + + + +## Examples + The following code example shows how to obtain the object from the configuration file associated with an existing Web application. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebControlsSection/CS/webcontrolssection.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebControlsSection/VB/vb_webcontrolssection.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebControlsSection/VB/vb_webcontrolssection.vb" id="Snippet1"::: + ]]> Client Script in ASP.NET Web Pages @@ -60,11 +60,11 @@ Creates a new instance of . - constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. - + constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + ]]> @@ -99,19 +99,19 @@ Gets the client scripts location. The location of the client scripts. - . - + . + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.WebControlsSection/CS/webcontrolssection.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebControlsSection/VB/vb_webcontrolssection.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.WebControlsSection/VB/vb_webcontrolssection.vb" id="Snippet1"::: + ]]> Client Script in ASP.NET Web Pages diff --git a/xml/System.Web.Configuration/WebPartsSection.xml b/xml/System.Web.Configuration/WebPartsSection.xml index 69b32988236..27fc146c85f 100644 --- a/xml/System.Web.Configuration/WebPartsSection.xml +++ b/xml/System.Web.Configuration/WebPartsSection.xml @@ -98,7 +98,7 @@ type="System.Web.UI.WebControls.WebParts.RowToParametersTransformer" /> constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + The constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. This constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. @@ -106,8 +106,8 @@ type="System.Web.UI.WebControls.WebParts.RowToParametersTransformer" /> |Setting|Default Value| |-------------|-------------------| -||An empty object.| -||A collection containing a default object.| +||An empty object.| +||A collection containing a default object.| ]]> diff --git a/xml/System.Web.Configuration/XhtmlConformanceSection.xml b/xml/System.Web.Configuration/XhtmlConformanceSection.xml index a6ea39b697b..7b7feab5046 100644 --- a/xml/System.Web.Configuration/XhtmlConformanceSection.xml +++ b/xml/System.Web.Configuration/XhtmlConformanceSection.xml @@ -17,14 +17,14 @@ Configures the section. This class cannot be inherited. - class provides a way to programmatically access and modify the `xhtmlConformance` section of a configuration file. - + class provides a way to programmatically access and modify the `xhtmlConformance` section of a configuration file. + > [!NOTE] -> ASP.NET allows you to create Web pages that are compliant with XHTML 1.1 standards. For more information about the XHTML 1.1 standard, see the W3C site. By default, when you are working with browsers that support HTML 4.0 or later, ASP.NET pages and controls render markup that is compatible with the XHTML 1.0 Transitional standard. However, under some circumstances, you might not want ASP.NET to render XHTML markup. This is typically true when you have existing pages that rely on tags or attributes that would ordinarily be prohibited by XHTML. - +> ASP.NET allows you to create Web pages that are compliant with XHTML 1.1 standards. For more information about the XHTML 1.1 standard, see the W3C site. By default, when you are working with browsers that support HTML 4.0 or later, ASP.NET pages and controls render markup that is compatible with the XHTML 1.0 Transitional standard. However, under some circumstances, you might not want ASP.NET to render XHTML markup. This is typically true when you have existing pages that rely on tags or attributes that would ordinarily be prohibited by XHTML. + ]]> @@ -54,11 +54,11 @@ Initializes a new instance of the class using default parameters. - constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. - + constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the class by using the method. + ]]> @@ -89,11 +89,11 @@ Gets or sets the property. One of the values. The default is . - diff --git a/xml/System.Web.DynamicData.Design/DataControlReferenceIDConverter.xml b/xml/System.Web.DynamicData.Design/DataControlReferenceIDConverter.xml index 9fc63ed8b04..0713ebc5ee6 100644 --- a/xml/System.Web.DynamicData.Design/DataControlReferenceIDConverter.xml +++ b/xml/System.Web.DynamicData.Design/DataControlReferenceIDConverter.xml @@ -16,11 +16,11 @@ Creates a user-selectable collection of data controls. - class performs type conversion of the controls in the collection. This class is typically referenced by the attribute. - + class performs type conversion of the controls in the collection. This class is typically referenced by the attribute. + ]]> @@ -48,11 +48,11 @@ Initializes a new instance of the class. - class is created when the converter class is called by a attribute. - + class is created when the converter class is called by a attribute. + ]]> @@ -82,11 +82,11 @@ Returns a collection of available control values. A collection that contains the names of the available controls. - method gets the set of controls that can be converted. It creates a instance that contains objects that are valid data types in `context`. - + method gets the set of controls that can be converted. It creates a instance that contains objects that are valid data types in `context`. + ]]> diff --git a/xml/System.Web.DynamicData.Design/DynamicDataManagerDesigner.xml b/xml/System.Web.DynamicData.Design/DynamicDataManagerDesigner.xml index ad1d5b6fa36..ca61b9a6695 100644 --- a/xml/System.Web.DynamicData.Design/DynamicDataManagerDesigner.xml +++ b/xml/System.Web.DynamicData.Design/DynamicDataManagerDesigner.xml @@ -87,11 +87,11 @@ Generates the HTML markup that is used to render the associated control at design time. The HTML markup that is used to render the associated control at design time. - method calls the method to generate a simple rectangular placeholder representation that displays the type and ID of the control. - + method calls the method to generate a simple rectangular placeholder representation that displays the type and ID of the control. + ]]> diff --git a/xml/System.Web.DynamicData.Design/DynamicFieldDesigner.xml b/xml/System.Web.DynamicData.Design/DynamicFieldDesigner.xml index 68854ba9bd2..0cc58b2229a 100644 --- a/xml/System.Web.DynamicData.Design/DynamicFieldDesigner.xml +++ b/xml/System.Web.DynamicData.Design/DynamicFieldDesigner.xml @@ -73,11 +73,11 @@ Creates an empty object. An empty field object. - method is called when the designer does not have schema information about the field. - + method is called when the designer does not have schema information about the field. + ]]> @@ -134,11 +134,11 @@ Creates a field for the specified data field. The new template field. - method is invoked by the designer when it converts a data control field into a object. - + method is invoked by the designer when it converts a data control field into a object. + ]]> @@ -244,11 +244,11 @@ if the data field is enabled in the fields editor; if the data field will not be displayed in the fields editor. - method returns `false`, the data field will not be displayed in the fields editor. This occurs when the data-bound control does not contain the field yet - + method returns `false`, the data field will not be displayed in the fields editor. This occurs when the data-bound control does not contain the field yet + ]]> diff --git a/xml/System.Web.DynamicData/ContextConfiguration.xml b/xml/System.Web.DynamicData/ContextConfiguration.xml index ac72e9b6e75..75916c9a441 100644 --- a/xml/System.Web.DynamicData/ContextConfiguration.xml +++ b/xml/System.Web.DynamicData/ContextConfiguration.xml @@ -17,19 +17,19 @@ Provides information for a data-context instance in order to allow customization. - class enables you to customize data access. For example, you can use this class to enable scaffolding for a Web application, or to define a custom metadata provider. - - - -## Examples - The following example shows how to use the class when you call the method in order to register a data context with scaffolding enabled. - + class enables you to customize data access. For example, you can use this class to enable scaffolding for a Web application, or to define a custom metadata provider. + + + +## Examples + The following example shows how to use the class when you call the method in order to register a data context with scaffolding enabled. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/CS/global.asax.cs" id="Snippet99"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/VB/global.asax.vb" id="Snippet99"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/VB/global.asax.vb" id="Snippet99"::: + ]]> @@ -82,11 +82,11 @@ Gets or sets the metadata provider. The type of the metadata provider. - diff --git a/xml/System.Web.DynamicData/ControlFilterExpression.xml b/xml/System.Web.DynamicData/ControlFilterExpression.xml index a4291cbe7bd..5db02ce1c89 100644 --- a/xml/System.Web.DynamicData/ControlFilterExpression.xml +++ b/xml/System.Web.DynamicData/ControlFilterExpression.xml @@ -202,7 +202,7 @@ method modifies the query based on the selected data key of the source data-bound control. + The method modifies the query based on the selected data key of the source data-bound control. ]]> diff --git a/xml/System.Web.DynamicData/DefaultAutoFieldGenerator.xml b/xml/System.Web.DynamicData/DefaultAutoFieldGenerator.xml index 3a025f29949..ae075e4a04f 100644 --- a/xml/System.Web.DynamicData/DefaultAutoFieldGenerator.xml +++ b/xml/System.Web.DynamicData/DefaultAutoFieldGenerator.xml @@ -20,11 +20,11 @@ Generates dynamic data fields (columns) for data-bound controls automatically. - class to customize how Dynamic Data generates data fields. - + class to customize how Dynamic Data generates data fields. + ]]> @@ -55,11 +55,11 @@ The metadata for the table to generate dynamic fields for. Initializes a new instance of the class. - constructor calls the method to generate fields dynamically. - + constructor calls the method to generate fields dynamically. + ]]> The table is . @@ -92,11 +92,11 @@ Generates a dynamic data field. The dynamic field to create. - mode specifies the data-entry modes for a data field, such as `ReadOnly`, `Edit`, and `Insert`. - + mode specifies the data-entry modes for a data field, such as `ReadOnly`, `Edit`, and `Insert`. + ]]> diff --git a/xml/System.Web.DynamicData/DynamicControl.xml b/xml/System.Web.DynamicData/DynamicControl.xml index 0adb3d6a370..307b0b20871 100644 --- a/xml/System.Web.DynamicData/DynamicControl.xml +++ b/xml/System.Web.DynamicData/DynamicControl.xml @@ -296,7 +296,7 @@ object of the data source control also has a property named . This property performs the same function. Make sure that both properties are set appropriately. + The object of the data source control also has a property named . This property performs the same function. Make sure that both properties are set appropriately. ]]> @@ -430,7 +430,7 @@ By default, the formatting string is applied to the field value only when the property is set to . To apply the formatting string to the field value while in edit mode, set the property to `true`. - The display format that you specify using the property is specific to this instance of the control. You can also change the display format for a data field across the entire application by applying the to your data model and setting the named parameter in the constructor. For more information, see [ASP.NET Dynamic Data](https://msdn.microsoft.com/library/78c7fcd7-5f38-46a0-a4bc-48eff3c8a512). + The display format that you specify using the property is specific to this instance of the control. You can also change the display format for a data field across the entire application by applying the to your data model and setting the named parameter in the constructor. For more information, see [ASP.NET Dynamic Data](https://msdn.microsoft.com/library/78c7fcd7-5f38-46a0-a4bc-48eff3c8a512). ]]> @@ -668,7 +668,7 @@ ## Remarks Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. ]]> @@ -704,7 +704,7 @@ method is primarily used by control developers to extend the control. + The method is primarily used by control developers to extend the control. ]]> diff --git a/xml/System.Web.DynamicData/DynamicDataExtensions.xml b/xml/System.Web.DynamicData/DynamicDataExtensions.xml index 6031716762b..52ace4a496e 100644 --- a/xml/System.Web.DynamicData/DynamicDataExtensions.xml +++ b/xml/System.Web.DynamicData/DynamicDataExtensions.xml @@ -48,18 +48,18 @@ if is or an empty string and the property of is ; if is not or an empty string and matches the property of ; otherwise, the unchanged value of . - type overview. - - - -## Examples - The following example shows how to use the method. The example gets user input from a field template that is configured to accept date-time data. In the DynamicData\FieldTemplates\DateTime_Edit.ascx.cs or DynamicData\FieldTemplates\DateTime_Edit.ascx.vb file, the method converts empty strings to `null`. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/DateTime_Edit.ascx.cs" id="Snippet3"::: - + type overview. + + + +## Examples + The following example shows how to use the method. The example gets user input from a field template that is configured to accept date-time data. In the DynamicData\FieldTemplates\DateTime_Edit.ascx.cs or DynamicData\FieldTemplates\DateTime_Edit.ascx.vb file, the method converts empty strings to `null`. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/DateTime_Edit.ascx.cs" id="Snippet3"::: + ]]> @@ -97,13 +97,13 @@ The data bound control. Enables selection to be persisted in data controls that support selection and paging. - and that support selection, paging, and sorting, calling this method enables the control to persist selection even when the selected row is not visible. For example, if the user selects a row and then pages to another page, or if the user sorts the data, the selected row remains selected. If this method is not called, selection is lost when the user pages or sorts. - - The method calls . - + and that support selection, paging, and sorting, calling this method enables the control to persist selection even when the selected row is not visible. For example, if the user selects a row and then pages to another page, or if the user sorts the data, the selected row remains selected. If this method is not called, selection is lost when the user pages or sorts. + + The method calls . + ]]> @@ -131,11 +131,11 @@ The data source object. Expands dynamic filters into parameters that are usable by the data source. - and controls into `Where` parameters that are usable in queries by the data source. - + and controls into `Where` parameters that are usable in queries by the data source. + ]]> @@ -164,14 +164,14 @@ Returns the data source that is associated with the data control for the specified control. The data source that is associated with the data control for the specified control. - method is called to find the data source control. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx.cs" id="Snippet1"::: - :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx" id="Snippet2"::: - + method is called to find the data source control. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx.cs" id="Snippet1"::: + :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx" id="Snippet2"::: + ]]> @@ -202,14 +202,14 @@ Returns the field template for the specified column in the specified control's naming container. The field template for the specified column in the specified control's naming container. - method is called to find a text box control. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx.cs" id="Snippet1"::: -:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx" id="Snippet2"::: - + method is called to find a text box control. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx.cs" id="Snippet1"::: +:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx" id="Snippet2"::: + ]]> @@ -238,14 +238,14 @@ Returns the metatable object for the containing data control. The metatable object for the containing data control. - object for a control. In the example, the Dynamic Data page templates are copied to the \DynamicData\CustomPages\ProductDescriptions folder to provide a custom display for the ProductDescription table of the AdventureWorksLT database. The Insert.aspx file markup is changed to add an `OnDataBound` event handler named `DetailsView1_DataBound`, in which the method is called to find the object. - - :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx.cs" id="Snippet1"::: -:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx" id="Snippet2"::: - + object for a control. In the example, the Dynamic Data page templates are copied to the \DynamicData\CustomPages\ProductDescriptions folder to provide a custom display for the ProductDescription table of the AdventureWorksLT database. The Insert.aspx file markup is changed to add an `OnDataBound` event handler named `DetailsView1_DataBound`, in which the method is called to find the object. + + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx.cs" id="Snippet1"::: +:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx" id="Snippet2"::: + ]]> @@ -276,11 +276,11 @@ Formats the specified field value by using the specified formatting options. The field value that has been formatted by using the specified formatting options. - method is like the method, but it is used when the field is in edit mode. - + method is like the method, but it is used when the field is in edit mode. + ]]> @@ -345,11 +345,11 @@ Gets the collection of the default values for the specified data source. The collection of default values that are associated with the object. - or methods. - + or methods. + ]]> @@ -377,11 +377,11 @@ Gets the collection of the default values for the specified data control. The collection of default values that are associated with the object. - or methods. - + or methods. + ]]> @@ -415,11 +415,11 @@ Gets the type of the enumeration that represents the column. The type of the enumeration that represents the column if the underlying type is an enumeration; otherwise, . - attribute. - + attribute. + ]]> @@ -456,11 +456,11 @@ Gets the metadata for a table in the specified data source object. The table metadata associated with the object. - or method. - + or method. + ]]> @@ -488,11 +488,11 @@ Gets the table metadata for the specified data control. The table metadata that is associated with the object. - or method. - + or method. + ]]> @@ -521,10 +521,10 @@ Returns the object that is associated with the specified data source control. The table that is associated with the specified data source control. To be added. - The property of is . - - -or- - + The property of is . + + -or- + The property of is . @@ -581,11 +581,11 @@ The type of the entities that are returned by the data source. Sets the value of a LINQ-to-SQL data source to force all the foreign-key entities to be loaded. - class overview. - + class overview. + ]]> diff --git a/xml/System.Web.DynamicData/DynamicDataManager.xml b/xml/System.Web.DynamicData/DynamicDataManager.xml index 92e8e678583..d9d36340029 100644 --- a/xml/System.Web.DynamicData/DynamicDataManager.xml +++ b/xml/System.Web.DynamicData/DynamicDataManager.xml @@ -64,11 +64,11 @@ ## Introduction The control provides the glue between the data-bound control, the data source control, and Dynamic Data in the following ways: -- Sets a field generator for the data-bound control to create the correct column set when is set to `true`. The data-bound control can be a control, a control, or a control. +- Sets a field generator for the data-bound control to create the correct column set when is set to `true`. The data-bound control can be a control, a control, or a control. - Sets the context type and table name for the data source control. The data source control for LINQ-to-SQL is . The data source control for the ADO Entity Framework is . -- Sets the to `true` for the data source if there is no Where clause. +- Sets the to `true` for the data source if there is no Where clause. - Expands the special dynamic parameters such as into parameters that the data source can consume. @@ -213,7 +213,7 @@ + ]]> diff --git a/xml/System.Web.DynamicData/DynamicDataRoute.xml b/xml/System.Web.DynamicData/DynamicDataRoute.xml index 75973d06292..3c6bea42bf9 100644 --- a/xml/System.Web.DynamicData/DynamicDataRoute.xml +++ b/xml/System.Web.DynamicData/DynamicDataRoute.xml @@ -24,9 +24,9 @@ The static property of the type holds a collection of routes. For Dynamic Data, one or more routes are typically registered (added to the property) in the `Application_Start` event in the Global.asax file. For example, routes determine whether the details for a row of data should be shown on the same page as the list of rows. They can also determine whether details should appear on the same page as the list of rows for some tables but not others. - You set the , , , and properties and provide a pattern for the URL in the constructor. + You set the , , , and properties and provide a pattern for the URL in the constructor. - Dynamic Data uses the URL pattern that you provide to match URL patterns for requests and to create URLs. For more information, see . + Dynamic Data uses the URL pattern that you provide to match URL patterns for requests and to create URLs. For more information, see . ]]> @@ -315,7 +315,7 @@ , the route will apply to all tables in the data model that are indicated by . + If you do not set this property when you create an instance of , the route will apply to all tables in the data model that are indicated by . ]]> diff --git a/xml/System.Web.DynamicData/DynamicDataRouteHandler.xml b/xml/System.Web.DynamicData/DynamicDataRouteHandler.xml index 9e7c0210f2c..19045fae015 100644 --- a/xml/System.Web.DynamicData/DynamicDataRouteHandler.xml +++ b/xml/System.Web.DynamicData/DynamicDataRouteHandler.xml @@ -69,11 +69,11 @@ Creates a handler to process a request. The handler that can process a request. - @@ -130,11 +130,11 @@ Returns the instance for the current Web request. The request context for the Web request. - @@ -254,11 +254,11 @@ The metatable that is associated with the current request. Sets the object that is associated with the current object. - object can be `null` for non-Dynamic Data requests. - + object can be `null` for non-Dynamic Data requests. + ]]> @@ -290,11 +290,11 @@ Returns the handler that processes ASP.NET Dynamic Data route patterns. The handler that processes ASP.NET Dynamic Data route patterns. - interface method. - + interface method. + ]]> diff --git a/xml/System.Web.DynamicData/DynamicField.xml b/xml/System.Web.DynamicData/DynamicField.xml index 9109d5a5a23..f3c1a5b0c63 100644 --- a/xml/System.Web.DynamicData/DynamicField.xml +++ b/xml/System.Web.DynamicData/DynamicField.xml @@ -202,7 +202,7 @@ ## Remarks Use this constructor to initialize a new instance of the 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. + 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. @@ -341,7 +341,7 @@ By default, a object displays null values as empty strings. To display a different value, set the property. > [!NOTE] -> The object of the data source control that the parent control of object is bound to also has a property named . This property performs the same function. Make sure that both properties are set appropriately. +> The object of the data source control that the parent control of object is bound to also has a property named . This property performs the same function. Make sure that both properties are set appropriately. ]]> @@ -376,7 +376,7 @@ method is a helper method. It is used by the method to copy the properties of the current object to the object that is passed in the `newField` parameter. + The method is a helper method. It is used by the method to copy the properties of the current object to the object that is passed in the `newField` parameter. ]]> @@ -433,7 +433,7 @@ method is a helper method. It is used by the method to create an empty object. + The method is a helper method. It is used by the method to create an empty object. ]]> @@ -487,7 +487,7 @@ **Note** If you want to change the display and behavior of a data field globally, you must apply attributes to your data model instead of setting this in a particular instance of the object. For more information, see [ASP.NET Dynamic Data](https://msdn.microsoft.com/library/78c7fcd7-5f38-46a0-a4bc-48eff3c8a512). - The method is called to raise a state change event when the property is set. + The method is called to raise a state change event when the property is set. The value of the property is stored in view state. @@ -536,7 +536,7 @@ 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 the field value while in edit mode, set the property to `true`. - The display format that you specify using the property is specific to this instance of the class. You can also change the display format for a data field across the entire application by applying the to your data model and setting the named parameter in the constructor. For more information, see [ASP.NET Dynamic Data](https://msdn.microsoft.com/library/78c7fcd7-5f38-46a0-a4bc-48eff3c8a512). + The display format that you specify using the property is specific to this instance of the class. You can also change the display format for a data field across the entire application by applying the to your data model and setting the named parameter in the constructor. For more information, see [ASP.NET Dynamic Data](https://msdn.microsoft.com/library/78c7fcd7-5f38-46a0-a4bc-48eff3c8a512). ]]> @@ -860,7 +860,7 @@ ## Remarks The property tries to use the value of the property of the column object that is associated with the object by setting the property. - The method is called to raise a state change event when the property is set. + The method is called to raise a state change event when the property is set. The value of the property is stored in view state. @@ -911,7 +911,7 @@ The field template that you specify using the property is specific to this instance of the class. You can also change the field template used by a data field across the entire application by applying the to your data model. Setting the property overrides the metadata applied to the data model. For more information about metadata attributes, see [ASP.NET Dynamic Data](https://msdn.microsoft.com/library/78c7fcd7-5f38-46a0-a4bc-48eff3c8a512). - The method is called to raise a state change event when the property is set. + The method is called to raise a state change event when the property is set. The value of the property is stored in view state. diff --git a/xml/System.Web.DynamicData/DynamicFilter.xml b/xml/System.Web.DynamicData/DynamicFilter.xml index 0d6ea358837..17d18d51a3f 100644 --- a/xml/System.Web.DynamicData/DynamicFilter.xml +++ b/xml/System.Web.DynamicData/DynamicFilter.xml @@ -42,8 +42,8 @@ |Scenario|Description| |--------------|-----------------| -|Specify the column to use for table row filtering.|Use the property to specify the column to use for table row filtering.| -|Specify the name of the filter template to use to create the UI.|Use the property to specify the name of the filter template to use to create the UI.| +|Specify the column to use for table row filtering.|Use the property to specify the column to use for table row filtering.| +|Specify the name of the filter template to use to create the UI.|Use the property to specify the name of the filter template to use to create the UI.| |Perform custom operations before the UI is rendered.|Use the to perform custom operations before the UI is rendered.| You can specify the filter template to use in the following ways: @@ -127,7 +127,7 @@ constructor directly. Instead, you use the class in page markup and the class is initialized when the page is loaded. + Typically you do not call the constructor directly. Instead, you use the class in page markup and the class is initialized when the page is loaded. ]]> diff --git a/xml/System.Web.DynamicData/DynamicFilterExpression.xml b/xml/System.Web.DynamicData/DynamicFilterExpression.xml index 000bf80561f..76f82aa1a12 100644 --- a/xml/System.Web.DynamicData/DynamicFilterExpression.xml +++ b/xml/System.Web.DynamicData/DynamicFilterExpression.xml @@ -157,7 +157,7 @@ method delegates the task of building of the query to the filter template referenced by the filter control that is specified by the property. + The method delegates the task of building of the query to the filter template referenced by the filter control that is specified by the property. ]]> diff --git a/xml/System.Web.DynamicData/DynamicQueryStringParameter.xml b/xml/System.Web.DynamicData/DynamicQueryStringParameter.xml index 157645fe625..fddae527b19 100644 --- a/xml/System.Web.DynamicData/DynamicQueryStringParameter.xml +++ b/xml/System.Web.DynamicData/DynamicQueryStringParameter.xml @@ -28,7 +28,7 @@ For primary keys, you can simply add a object without supplying any other parameters. Dynamic Data will generate the parameters for the primary key or keys. For foreign keys or Boolean columns, you must set the property to the name of the column you want to filter. - In order to use the class, you must add a control to the page and you must register the data-bound control with the control by using the method. + In order to use the class, you must add a control to the page and you must register the data-bound control with the control by using the method. ## Examples The following example shows how to use the object as filter when displaying data in a control. The control contains a object that creates a link that sets the query string value by using the foreign key value. @@ -99,7 +99,7 @@ method is invoked by ASP.NET, it throws an T:System.InvalidOperationException exception in all cases. This happens because one of the following conditions are met: + If the method is invoked by ASP.NET, it throws an T:System.InvalidOperationException exception in all cases. This happens because one of the following conditions are met: - The page does not contain a control. diff --git a/xml/System.Web.DynamicData/DynamicRouteExpression.xml b/xml/System.Web.DynamicData/DynamicRouteExpression.xml index a109751e54a..f1241bef7f2 100644 --- a/xml/System.Web.DynamicData/DynamicRouteExpression.xml +++ b/xml/System.Web.DynamicData/DynamicRouteExpression.xml @@ -70,7 +70,7 @@ constructor. Instead, you use the class in page markup and the class is initialized when the page is loaded. + You typically do not call the constructor. Instead, you use the class in page markup and the class is initialized when the page is loaded. ]]> diff --git a/xml/System.Web.DynamicData/DynamicValidator.xml b/xml/System.Web.DynamicData/DynamicValidator.xml index 49a846f7cf7..5db03daeae6 100644 --- a/xml/System.Web.DynamicData/DynamicValidator.xml +++ b/xml/System.Web.DynamicData/DynamicValidator.xml @@ -27,101 +27,101 @@ Enforces and catches exceptions that are thrown in a data model and displays the error. - control can be used with data fields or data entities. It catches exceptions that are thrown in LINQ-to-SQL classes or entity in extensibility methods in the data model. The control is associated with the controls that accept user input. For example, a control that is associated with a text box that accepts user input for a UnitsInStock field in a Products table catches and displays the exception that is thrown if the input is greater or less than the allowable units in the data model. - - By default, ASP.NET Dynamic Data does not display all exceptions from the data model in the page, because some database exceptions might contain confidential information. Dynamic Data displays values only. If you want your application to display other exceptions, you can create a control, provide the exceptions that you want to display, and attach the exceptions to the control. The exceptions that are thrown in the data model will be displayed in all pages in the application. - - - -## Examples - The following example shows how to create a control class that displays other exceptions in all pages. - -```vb -''' -''' Display other exceptions in all pages. -''' -Public Class MyDynamicValidator - Inherits DynamicValidator - - Protected Overloads Overrides Sub ValidateException(ByVal exception As Exception) - ' If it's not an exception that DynamicValidator displays find - ' the innermost exception. - If Not (TypeOf exception Is IDynamicValidatorException) AndAlso _ - Not (TypeOf exception Is ValidationException) Then - While exception.InnerException IsNot Nothing - exception = exception.InnerException - End While - - ' Wrap it in a ValidationException so that the base code - ' does not ignore it. - If ExceptionShouldBeDisplayedInPage(exception) Then - exception = New ValidationException(Nothing, exception) - End If - End If - - ' Call the base class for the exception that is modified. - MyBase.ValidateException(exception) - End Sub - - Private Function ExceptionShouldBeDisplayedInPage(ByVal e As Exception) _ - As Boolean - ' Add code to find the exception and - ' decide whether it should be shown in the page. - - Return True - End Function -End Class -``` - -```csharp -/// -/// Display other exceptions in all pages. -/// -public class MyDynamicValidator : DynamicValidator { - - protected override void ValidateException(Exception exception) { - // If it's not an exception that DynamicValidator displays find - // the innermost exception. - if (!(exception is IDynamicValidatorException) && !(exception - is ValidationException)) { - while (exception.InnerException != null) { - exception = exception.InnerException; - } - - // Wrap it in a ValidationException so that the base code - // does not ignore it. - if (ExceptionShouldBeDisplayedInPage(exception)) { - exception = new ValidationException(null, exception); - } - } - - // Call the base class on the exception that is modified. - base.ValidateException(exception); - } - - private bool ExceptionShouldBeDisplayedInPage(Exception e) { - // Add your code to find the exception and - // decides whether it should be shown in the page. - - return true; - } -} -``` - - The following example shows how to use tag remapping in the web.config file to display the exception in all the Web pages. - -```xml - - - - - -``` - + control can be used with data fields or data entities. It catches exceptions that are thrown in LINQ-to-SQL classes or entity in extensibility methods in the data model. The control is associated with the controls that accept user input. For example, a control that is associated with a text box that accepts user input for a UnitsInStock field in a Products table catches and displays the exception that is thrown if the input is greater or less than the allowable units in the data model. + + By default, ASP.NET Dynamic Data does not display all exceptions from the data model in the page, because some database exceptions might contain confidential information. Dynamic Data displays values only. If you want your application to display other exceptions, you can create a control, provide the exceptions that you want to display, and attach the exceptions to the control. The exceptions that are thrown in the data model will be displayed in all pages in the application. + + + +## Examples + The following example shows how to create a control class that displays other exceptions in all pages. + +```vb +''' +''' Display other exceptions in all pages. +''' +Public Class MyDynamicValidator + Inherits DynamicValidator + + Protected Overloads Overrides Sub ValidateException(ByVal exception As Exception) + ' If it's not an exception that DynamicValidator displays find + ' the innermost exception. + If Not (TypeOf exception Is IDynamicValidatorException) AndAlso _ + Not (TypeOf exception Is ValidationException) Then + While exception.InnerException IsNot Nothing + exception = exception.InnerException + End While + + ' Wrap it in a ValidationException so that the base code + ' does not ignore it. + If ExceptionShouldBeDisplayedInPage(exception) Then + exception = New ValidationException(Nothing, exception) + End If + End If + + ' Call the base class for the exception that is modified. + MyBase.ValidateException(exception) + End Sub + + Private Function ExceptionShouldBeDisplayedInPage(ByVal e As Exception) _ + As Boolean + ' Add code to find the exception and + ' decide whether it should be shown in the page. + + Return True + End Function +End Class +``` + +```csharp +/// +/// Display other exceptions in all pages. +/// +public class MyDynamicValidator : DynamicValidator { + + protected override void ValidateException(Exception exception) { + // If it's not an exception that DynamicValidator displays find + // the innermost exception. + if (!(exception is IDynamicValidatorException) && !(exception + is ValidationException)) { + while (exception.InnerException != null) { + exception = exception.InnerException; + } + + // Wrap it in a ValidationException so that the base code + // does not ignore it. + if (ExceptionShouldBeDisplayedInPage(exception)) { + exception = new ValidationException(null, exception); + } + } + + // Call the base class on the exception that is modified. + base.ValidateException(exception); + } + + private bool ExceptionShouldBeDisplayedInPage(Exception e) { + // Add your code to find the exception and + // decides whether it should be shown in the page. + + return true; + } +} +``` + + The following example shows how to use tag remapping in the web.config file to display the exception in all the Web pages. + +```xml + + + + + +``` + ]]> @@ -244,11 +244,11 @@ public class MyDynamicValidator : DynamicValidator { , if the properties of the specified validation control are valid; otherwise, . - , the base class will fail. - + , the base class will fail. + ]]> @@ -325,14 +325,14 @@ public class MyDynamicValidator : DynamicValidator { The exception that is thrown. Sets up a validation exception if an exception occurs in the data model. - [!NOTE] -> Only use this method if the exception is a . If the exception is caused by a database error, using this method can display a sensitive database error - +> Only use this method if the exception is a . If the exception is caused by a database error, using this method can display a sensitive database error + ]]> @@ -367,11 +367,11 @@ public class MyDynamicValidator : DynamicValidator { Gets or sets validation exception that occurs during validation. The validation exception that is thrown. - diff --git a/xml/System.Web.DynamicData/DynamicValidatorEventArgs.xml b/xml/System.Web.DynamicData/DynamicValidatorEventArgs.xml index de81823e860..92f22c4b473 100644 --- a/xml/System.Web.DynamicData/DynamicValidatorEventArgs.xml +++ b/xml/System.Web.DynamicData/DynamicValidatorEventArgs.xml @@ -17,11 +17,11 @@ Base class for classes that contain event data. - class catches exceptions thrown from LINQ to SQL classes or from Entity Framework methods in a data model. This class does not contain event data. It is used by events that do not pass state information to an event handler when an event is raised. If the event handler requires state information, you must create a derived class from this class to hold the data. - + class catches exceptions thrown from LINQ to SQL classes or from Entity Framework methods in a data model. This class does not contain event data. It is used by events that do not pass state information to an event handler when an event is raised. If the event handler requires state information, you must create a derived class from this class to hold the data. + ]]> @@ -54,13 +54,13 @@ The data source operation that caused the exception. Initializes a new instance of the class, using the exception that occurred and the data source operation that caused the exception. - and respectively. - - This constructor initializes a new instance of the class using these properties. - + and respectively. + + This constructor initializes a new instance of the class using these properties. + ]]> @@ -91,11 +91,11 @@ Gets the exception that occurs during a data source operation event. The exception that occurred during the data source operation event. - class uses this property to get the type of exception that is triggered during a data source operation. - + class uses this property to get the type of exception that is triggered during a data source operation. + ]]> @@ -126,11 +126,11 @@ Gets the data source operation that caused an exception in the class. The data source operation that caused the exception. - class uses this property to retrieve the operation that triggered that exception. - + class uses this property to retrieve the operation that triggered that exception. + ]]> diff --git a/xml/System.Web.DynamicData/EntityTemplateUserControl.xml b/xml/System.Web.DynamicData/EntityTemplateUserControl.xml index b9cb3a4f02e..a71fdf5d691 100644 --- a/xml/System.Web.DynamicData/EntityTemplateUserControl.xml +++ b/xml/System.Web.DynamicData/EntityTemplateUserControl.xml @@ -16,11 +16,11 @@ Defines the base class for entity templates. - controls for rendering data fields. - + controls for rendering data fields. + ]]> @@ -67,13 +67,13 @@ Gets the type of the data-bound control that contains this entity template. The type that contains the template. - class provides information about the context (the control type) in which the class is contained. This type can be a list control, such as a or control. It can also be a single-item control, such as a or control. - - You can customize the behavior of an application depending on the value, such as conditionally displaying or hiding specific UI elements. - + class provides information about the context (the control type) in which the class is contained. This type can be a list control, such as a or control. It can also be a single-item control, such as a or control. + + You can customize the behavior of an application depending on the value, such as conditionally displaying or hiding specific UI elements. + ]]> diff --git a/xml/System.Web.DynamicData/FieldTemplateUserControl.xml b/xml/System.Web.DynamicData/FieldTemplateUserControl.xml index fa2538b7889..ce9a7455c15 100644 --- a/xml/System.Web.DynamicData/FieldTemplateUserControl.xml +++ b/xml/System.Web.DynamicData/FieldTemplateUserControl.xml @@ -150,7 +150,7 @@ public partial class ForeignKeyField : , except that it allows the path part of the URL to be overridden. This method is used if the pages are not located in the DynamicData\CustomPages folder of the Dynamic Data project. This method applies to Children columns only. + This method is similar to , except that it allows the path part of the URL to be overridden. This method is used if the pages are not located in the DynamicData\CustomPages folder of the Dynamic Data project. This method applies to Children columns only. ]]> @@ -183,7 +183,7 @@ public partial class ForeignKeyField : except that it allows the path of the URL to be overridden. This property is used if the page is not located in the DynamicData\CustomPages folder your the Dynamic Data project. + This method is similar to except that it allows the path of the URL to be overridden. This property is used if the page is not located in the DynamicData\CustomPages folder your the Dynamic Data project. ]]> @@ -432,7 +432,7 @@ public partial class ForeignKeyField : method. + This method implements the method. ]]> @@ -731,7 +731,7 @@ public partial class ForeignKeyField : method is used to return a string representation of foreign-key or enumeration column types. + The method is used to return a string representation of foreign-key or enumeration column types. ]]> @@ -925,7 +925,7 @@ public partial class ForeignKeyField : method are equivalent. This property uses the `Page.GetDataItem` method to return the data row object. + The object returned by this the property and the method are equivalent. This property uses the `Page.GetDataItem` method to return the data row object. ]]> @@ -966,7 +966,7 @@ public partial class ForeignKeyField : and sets up a on all validation controls. + This method performs additional logic for specific validation control such as the and sets up a on all validation controls. ]]> @@ -1000,7 +1000,7 @@ public partial class ForeignKeyField : on all validators. + This method used to set up on all validators. It performs additional logic for specific validator types in this method. For example, if range values exit in the data model this method sets up . @@ -1037,7 +1037,7 @@ public partial class ForeignKeyField : interface. + This method implements the interface. ]]> diff --git a/xml/System.Web.DynamicData/FilterRepeater.xml b/xml/System.Web.DynamicData/FilterRepeater.xml index cf5de72713c..b537191ad3e 100644 --- a/xml/System.Web.DynamicData/FilterRepeater.xml +++ b/xml/System.Web.DynamicData/FilterRepeater.xml @@ -31,69 +31,69 @@ Represents a control that enumerates table columns that can be filtered. - , instead. - - In this topic: - -- [Introduction](#introduction) - -- [Declarative Syntax](#declarative_syntax) - - -## Introduction - The control is a control in the ASP.NET Dynamic Data framework. It automatically renders controls that can be used to filter data rows that are displayed for a table. The filters work by providing a list of `Where` parameters to the data source for each supported column type. By default, Dynamic Data filters foreign-key and Boolean columns and renders them by using a `DropDownList` list control. - - The control is a specialized control that automatically binds to a collection of filterable columns for the table that is displayed in the current page. For example, if a request is made for /Products/List.aspx, the control binds to the columns in the Products table. The table is chosen based on the route that matches the request. It can also be overridden by setting the and properties of the control. - - To display the filter UI, the `ItemTemplate` template of the control must contain a control with a known ID. By default, the known ID is "DynamicFilter". The control in the item template must derive from . When data binding occurs, the control initializes an instance of the filter control with information about the column to filter. - - -## Declarative Syntax - -``` - -         - -         -         - -         -         - -         -         - -         -         - -         - -``` - + , instead. + + In this topic: + +- [Introduction](#introduction) + +- [Declarative Syntax](#declarative_syntax) + + +## Introduction + The control is a control in the ASP.NET Dynamic Data framework. It automatically renders controls that can be used to filter data rows that are displayed for a table. The filters work by providing a list of `Where` parameters to the data source for each supported column type. By default, Dynamic Data filters foreign-key and Boolean columns and renders them by using a `DropDownList` list control. + + The control is a specialized control that automatically binds to a collection of filterable columns for the table that is displayed in the current page. For example, if a request is made for /Products/List.aspx, the control binds to the columns in the Products table. The table is chosen based on the route that matches the request. It can also be overridden by setting the and properties of the control. + + To display the filter UI, the `ItemTemplate` template of the control must contain a control with a known ID. By default, the known ID is "DynamicFilter". The control in the item template must derive from . When data binding occurs, the control initializes an instance of the filter control with information about the column to filter. + + +## Declarative Syntax + +``` + +         + +         +         + +         +         + +         +         + +         +         + +         + +``` + ]]> @@ -239,11 +239,11 @@ Returns an enumeration of the sortable columns that belong to the table that is associated with the current control. An enumeration of the sortable columns that belong to the table that is associated with the current control. - @@ -300,11 +300,11 @@ The contents of the item template. Called for every item and alternating item template that is being instantiated by this control during data binding. - @@ -357,11 +357,11 @@ The event data. Raises the event. - event is raised when an item is created in the control. - + event is raised when an item is created in the control. + ]]> diff --git a/xml/System.Web.DynamicData/MetaChildrenColumn.xml b/xml/System.Web.DynamicData/MetaChildrenColumn.xml index 41134b776f9..17a8792f2a1 100644 --- a/xml/System.Web.DynamicData/MetaChildrenColumn.xml +++ b/xml/System.Web.DynamicData/MetaChildrenColumn.xml @@ -164,9 +164,9 @@ method when you want to retrieve the list-action page for the child table using the specified row as a parent. The path is obtained by appending a query-string value to the URL that contains the foreign-key field value specified in the `row` parameter. + Use the method when you want to retrieve the list-action page for the child table using the specified row as a parent. The path is obtained by appending a query-string value to the URL that contains the foreign-key field value specified in the `row` parameter. - Using the method is the same as invoking the method and passing the action as the first parameter. + Using the method is the same as invoking the method and passing the action as the first parameter. ]]> @@ -215,7 +215,7 @@ method returns the path of the specified action page for the child table. The path returned is based on the routes that are defined for the ASP.NET Dynamic Data application and has the specified row as a parent. The path is obtained by appending a query-string value to the URL that contains the foreign-key field value specified in the `row` parameter. + The method returns the path of the specified action page for the child table. The path returned is based on the routes that are defined for the ASP.NET Dynamic Data application and has the specified row as a parent. The path is obtained by appending a query-string value to the URL that contains the foreign-key field value specified in the `row` parameter. If `row` is `null`, this method returns an empty string. @@ -260,9 +260,9 @@ method returns the path of the specified action page for the child table. The path is based on the specified path with the specified row as a parent. The path is obtained by appending a query-string value to the URL that contains the foreign-key field value specified in the `row` parameter. + The method returns the path of the specified action page for the child table. The path is based on the specified path with the specified row as a parent. The path is obtained by appending a query-string value to the URL that contains the foreign-key field value specified in the `row` parameter. - If `row` is `null`, this method returns an empty string. If `path` is `null`, the method returns the path based on the routes defined for the ASP.NET Dynamic Data application. + If `row` is `null`, this method returns an empty string. If `path` is `null`, the method returns the path based on the routes defined for the ASP.NET Dynamic Data application. You can use the values defined in the class for the `action` parameter. diff --git a/xml/System.Web.DynamicData/MetaColumn.xml b/xml/System.Web.DynamicData/MetaColumn.xml index def824f8dd6..a78ac72144c 100644 --- a/xml/System.Web.DynamicData/MetaColumn.xml +++ b/xml/System.Web.DynamicData/MetaColumn.xml @@ -169,7 +169,7 @@ method before you access the property. + You must call the method before you access the property. ]]> diff --git a/xml/System.Web.DynamicData/MetaForeignKeyColumn.xml b/xml/System.Web.DynamicData/MetaForeignKeyColumn.xml index d5cce25d64a..2d13c619f75 100644 --- a/xml/System.Web.DynamicData/MetaForeignKeyColumn.xml +++ b/xml/System.Web.DynamicData/MetaForeignKeyColumn.xml @@ -92,7 +92,7 @@ method is used to save the value of a foreign key in the dictionary that contains all the new values for a data field. Typically, the method is used when a new value is selected from a control for the foreign key field. + The method is used to save the value of a foreign key in the dictionary that contains all the new values for a data field. Typically, the method is used when a new value is selected from a control for the foreign key field. ]]> @@ -182,9 +182,9 @@ method returns the path for the details action page based on the routes defined for the ASP.NET Dynamic Data application. This method returns an empty string, if `row` is `null`. + The method returns the path for the details action page based on the routes defined for the ASP.NET Dynamic Data application. This method returns an empty string, if `row` is `null`. - Using the method is the same as invoking the method passing the action as the first parameter. + Using the method is the same as invoking the method passing the action as the first parameter. ]]> @@ -238,7 +238,7 @@ method returns the path for the specified action page based on the routes defined for the ASP.NET Dynamic Data application. This method returns an empty string, if `row` is `null`. + The method returns the path for the specified action page based on the routes defined for the ASP.NET Dynamic Data application. This method returns an empty string, if `row` is `null`. You can use the values defined in the class for the `action` parameter. @@ -281,7 +281,7 @@ method returns the path for the specified action page based on the specified `path`. This method returns an empty string, if `row` is `null`. + The method returns the path for the specified action page based on the specified `path`. This method returns an empty string, if `row` is `null`. You can use the values defined in the class for the `action` parameter. @@ -320,7 +320,7 @@ method returns the same values that are returned by the method, but in a different format. + The method returns the same values that are returned by the method, but in a different format. ]]> @@ -357,7 +357,7 @@ method returns the same values that are returned by the method, but in a different format. + The method returns the same values that are returned by the method, but in a different format. ]]> @@ -386,7 +386,7 @@ method. If you override this method, call the base control's `Initialize` method. + This method cannot be called directly. To customize initialization, you can derive from this class and override the method. If you override this method, call the base control's `Initialize` method. ]]> diff --git a/xml/System.Web.DynamicData/MetaModel.xml b/xml/System.Web.DynamicData/MetaModel.xml index 23689b5fc30..2e7c9c6dd66 100644 --- a/xml/System.Web.DynamicData/MetaModel.xml +++ b/xml/System.Web.DynamicData/MetaModel.xml @@ -91,12 +91,12 @@ constructor in the `Application_Start` method of the Global.asax file. + You typically call the constructor in the `Application_Start` method of the Global.asax file. ## Examples - The following example shows how to use the constructor to perform the following tasks: + The following example shows how to use the constructor to perform the following tasks: - Instantiate the class. @@ -132,9 +132,9 @@ method. It enables you to create multiple models and use the same entity types while avoiding type conflicts. + This constructor determines whether the data model is registered globally so that it can be retrieved using the method. It enables you to create multiple models and use the same entity types while avoiding type conflicts. - You typically call the constructor in the `Application_Start` method of the Global.asax file. + You typically call the constructor in the `Application_Start` method of the Global.asax file. ]]> @@ -166,7 +166,7 @@ method can be overridden to instantiate a derived type. + The method can be overridden to instantiate a derived type. ]]> @@ -203,12 +203,12 @@ method. + This property provides a simple way to reference the default data-model instance. If the application uses multiple models, you must provide your own way to store references to the additional data models. To find a specific data model, call the method. ## Examples - The following example shows how to use the property in the method to get the default data model. + The following example shows how to use the property in the method to get the default data model. For a complete example, see the class overview. @@ -356,7 +356,7 @@ The route is determined by the combination of the table name and action. ## Examples - The following example shows how to use the method to evaluate the routing path (determine the URL) for a specified table. For a complete example, see . + The following example shows how to use the method to evaluate the routing path (determine the URL) for a specified table. For a complete example, see . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/CS/PathModel.aspx.cs" id="Snippet23"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/VB/PathModel.aspx.vb" id="Snippet23"::: @@ -392,7 +392,7 @@ method to perform the following tasks: + The following example shows how to use the method to perform the following tasks: - Getting the default data model. @@ -422,7 +422,7 @@ The object that is returned by the overloaded methods contains the metadata information that is associated with the specified table. ## Examples - The following example shows how to use the overloaded methods to perform the following tasks: + The following example shows how to use the overloaded methods to perform the following tasks: - Get the object for the specified table. - Access the metadata information that is contained by the object. @@ -470,7 +470,7 @@ The name uniquely identifies a table in the data model and is used to generate the related URL for routing. ## Examples - The following example shows how to use the method to obtain the metadata for the specified table. For a complete example, see . + The following example shows how to use the method to obtain the metadata for the specified table. For a complete example, see . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/CS/GetTable.aspx.cs" id="Snippet42"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/VB/gettable.aspx.vb" id="Snippet42"::: @@ -508,7 +508,7 @@ method to obtain the metadata for the specified table. For a complete example, see . + The following example shows how to use the method to obtain the metadata for the specified table. For a complete example, see . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/CS/GetTable.aspx.cs" id="Snippet41"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/VB/gettable.aspx.vb" id="Snippet41"::: @@ -548,7 +548,7 @@ method to obtain the metadata for the specified table. For a complete example, see . + The following example shows how to use the method to obtain the metadata for the specified table. For a complete example, see . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/CS/GetTable.aspx.cs" id="Snippet43"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/VB/gettable.aspx.vb" id="Snippet43"::: @@ -747,7 +747,7 @@ method to register a data context with scaffolding enabled, as specified by the `configuration` parameter. + The following example shows how to use the method to register a data context with scaffolding enabled, as specified by the `configuration` parameter. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/CS/global.asax.cs" id="Snippet99"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.DynamicData.MetaModel/VB/global.asax.vb" id="Snippet99"::: @@ -849,7 +849,7 @@ The collection contains all the tables in the data model, which includes the tables that are not visible (are not part of Dynamic Data scaffolding). ## Examples - The following example shows how to use the and properties to perform the following tasks: + The following example shows how to use the and properties to perform the following tasks: - Get a collection of all the tables in a data model and show them in a `GridView` control. - Get a collection of the visible tables in a data model and show them in a `GridView` control. @@ -905,7 +905,7 @@ method, which throws an exception if the table is not found. + This method gets the metadata that is associated with the specified table. If the table is not found, this method returns `false`. This differs from the method, which throws an exception if the table is not found. ]]> @@ -942,7 +942,7 @@ method, which throws an exception if the table is not found. + This method gets the metadata that is associated with the specified table. If the table is not found, this method returns `false`. This differs from the method, which throws an exception if the table is not found. ]]> diff --git a/xml/System.Web.DynamicData/MetaTable.xml b/xml/System.Web.DynamicData/MetaTable.xml index 17e040b3677..fa4cf97884f 100644 --- a/xml/System.Web.DynamicData/MetaTable.xml +++ b/xml/System.Web.DynamicData/MetaTable.xml @@ -290,7 +290,7 @@ End Class property. In the example, the Dynamic Data page templates have been copied to the \DynamicData\CustomPages\ProductDescriptions folder to provide a custom display for the ProductDescription table of the AdventureWorksLT database. The markup of the Insert.aspx file is changed to add an `OnDataBound` event handler named `DetailsView1_DataBound`. In the event handler, the method is used to find the meta table. The property is used to display the number of columns in the table. + The following example shows how to use the property. In the example, the Dynamic Data page templates have been copied to the \DynamicData\CustomPages\ProductDescriptions folder to provide a custom display for the ProductDescription table of the AdventureWorksLT database. The markup of the Insert.aspx file is changed to add an `OnDataBound` event handler named `DetailsView1_DataBound`. In the event handler, the method is used to find the meta table. The property is used to display the number of columns in the table. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx.cs" id="Snippet1"::: :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.DynamicData.DynamicDataExtensions/cs/Insert.aspx" id="Snippet2"::: @@ -392,7 +392,7 @@ End Class method. For more information, see the class overview. + The data context is retrieved from a new context that is instantiated by calling the method. For more information, see the class overview. ]]> @@ -512,7 +512,7 @@ End Class object that the table belongs to. + The name comes from the object that the table belongs to. ]]> @@ -1035,7 +1035,7 @@ End Class method, the overridden value is returned. Otherwise, the method returns the `ToString` representation of the value of the property for the specified row. + If the row is `null`, an empty string is returned. If the entity class includes an override of the method, the overridden value is returned. Otherwise, the method returns the `ToString` representation of the value of the property for the specified row. ]]> @@ -1292,7 +1292,7 @@ End Function method. + If the `context` parameter is `null`, this method creates a new context by calling the method. ]]> @@ -1362,7 +1362,7 @@ End Function . If returns `false`, an exception is thrown. + This method calls . If returns `false`, an exception is thrown. ]]> @@ -1414,12 +1414,12 @@ End Function method for each column in the instance. This method cannot be called directly. To customize initialization, you can derive from this class and override the method. If you override this method, call the base control's `Initialize` method. + This method calls the method for each column in the instance. This method cannot be called directly. To customize initialization, you can derive from this class and override the method. If you override this method, call the base control's `Initialize` method. ## Examples - The following example shows how to override the method in order to customize the initialization process. + The following example shows how to override the method in order to customize the initialization process. ```csharp protected override void Initialize() { diff --git a/xml/System.Web.DynamicData/QueryableFilterRepeater.xml b/xml/System.Web.DynamicData/QueryableFilterRepeater.xml index 1405f2992a5..4a826545174 100644 --- a/xml/System.Web.DynamicData/QueryableFilterRepeater.xml +++ b/xml/System.Web.DynamicData/QueryableFilterRepeater.xml @@ -55,7 +55,7 @@ |Task|Description| |----------|-----------------| |Create the UI for filtering table rows.|Add controls to create UI using the property.| -|Verify whether the control contains data field filters.|Perform the check in the method.| +|Verify whether the control contains data field filters.|Perform the check in the method.| ## Class Context diff --git a/xml/System.Web.DynamicData/QueryableFilterUserControl.xml b/xml/System.Web.DynamicData/QueryableFilterUserControl.xml index 0518b06ba38..e68f918e4ad 100644 --- a/xml/System.Web.DynamicData/QueryableFilterUserControl.xml +++ b/xml/System.Web.DynamicData/QueryableFilterUserControl.xml @@ -21,7 +21,7 @@ ## Remarks The class is the base class for user controls that render filters that can be plugged into the Dynamic Data filtering framework that is based on the class. - Implementers must override the control, which can return a modified object that reflects the filter's state. The base class contains helper methods for building LINQ expression trees. + Implementers must override the control, which can return a modified object that reflects the filter's state. The base class contains helper methods for building LINQ expression trees. ]]> @@ -238,7 +238,7 @@ ## Examples This method is implemented to transform the source object into the target object. Examples of expressions that you might want to implement include order by, range, or search. - The following example shows how to implement the method for a Boolean filter that is derived from . + The following example shows how to implement the method for a Boolean filter that is derived from . ```csharp public override IQueryable GetQueryable(IQueryable source) { diff --git a/xml/System.Web.Handlers/AssemblyResourceLoader.xml b/xml/System.Web.Handlers/AssemblyResourceLoader.xml index c64864eeaca..37031f7420d 100644 --- a/xml/System.Web.Handlers/AssemblyResourceLoader.xml +++ b/xml/System.Web.Handlers/AssemblyResourceLoader.xml @@ -21,23 +21,23 @@ Provides an HTTP handler used to load embedded resources from assemblies. This class cannot be inherited. - class is an HTTP handler that enables an ASP.NET page or control to load embedded resources, such as client script, images, and data files, from a compiled .NET assembly. For more information on how to embed resources in a .NET assembly, see the documentation for the compiler that you use. - - The handler responds to requests made to URLs generated by the method. Before responding to the request, the handler ensures that the resource should be available directly over the Web. - - The handler responds to requests of the form - -``` -WebResource.axd?d=&t= @@ -92,11 +92,11 @@ WebResource.axd?d=&t= @@ -127,21 +127,21 @@ WebResource.axd?d=&t= @@ -852,10 +852,10 @@ MarkAsSafe( | Input | Output | |-------|--------| -|`alert('XSS Attack!');`|`alert%28%27XSS%20Attack%21%27%29%3b`| -|``|`%3cscript%3ealert%28%27XSS%20Attack%21%27%29%3b%3c%2fscript%3e`| -|`alert('XSSあAttack!');`|`alert%28%27XSS%e3%81%82Attack%21%27%29%3b`| -|`user@contoso.com`|`user%40contoso.com`| +|`alert('XSS Attack!');`|`alert(%27XSS%20Attack%21%27)%3b`| +|``|`%3cscript%3ealert(%27XSS%20Attack%21%27)%3b%3c%2fscript%3e`| +|`alert('XSSあAttack!');`|`alert(%27XSS%e3%81%82Attack%21%27)%3b`| +|`user@contoso.com`|`user@contoso.com`| |`"Anti-Cross Site Scripting Namespace"`|`%22Anti-Cross%20Site%20Scripting%20Namespace%22`| ]]> @@ -917,7 +917,7 @@ The following table lists the default safe characters. All characters are from t |`alert('XSS Attack!');`|`alert(%27XSS%20Attack%21%27)%3b`| |``|`%3cscript%3ealert(%27XSS%20Attack%21%27)%3b%3c/script%3e`| |`alert('XSSあAttack!');`|`alert(%27XSS%e3%81%82Attack%21%27)%3b`| -|`user@contoso.com`|`user%40contoso.com`| +|`user@contoso.com`|`user@contoso.com`| |`"Anti-Cross Site Scripting Namespace"`|`%22Anti-Cross%20Site%20Scripting%20Namespace%22`| This method encodes only the path of a URL. This method will not encode the scheme (for example, `http:`, `ftp:`, or `file:`), the authority (for example, `www.northwind.com` or `www.contoso.com:8080`), or the query or fragment (for example, `?v=s978dfs9#x=103`). If there is no scheme or authority in the string, the string is assumed to be a relative path, and the path is encoded. In the following URL, only the substring `/default.htm` is encoded: @@ -1009,7 +1009,7 @@ The following table lists the default safe characters. All characters are from t |`user@contoso.com`|`user@contoso.com`| |`"Anti-Cross Site Scripting Namespace"`|`"Anti-Cross Site Scripting Namespace"`| - To customize the safe list, call the method. + To customize the safe list, call the method. ]]> @@ -1096,7 +1096,7 @@ The following table lists the default safe characters. All characters are from t |`user@contoso.com`|`user@contoso.com`| |`"Anti-Cross Site Scripting Namespace"`|`"Anti-Cross Site Scripting Namespace"`| - To customize the safe list, call the method. + To customize the safe list, call the method. ]]> diff --git a/xml/System.Web.Security/ActiveDirectoryMembershipProvider.xml b/xml/System.Web.Security/ActiveDirectoryMembershipProvider.xml index 6071d37aa2a..eb5463fb822 100644 --- a/xml/System.Web.Security/ActiveDirectoryMembershipProvider.xml +++ b/xml/System.Web.Security/ActiveDirectoryMembershipProvider.xml @@ -36,7 +36,7 @@ |Connection string|Scope| |-----------------------|-----------| -|LDAP://\:[port]

Port number is optional for ADAM and not needed for Active Directory.|The provider runs against the specified domain or server. With AD, user creation and deletion is done in the default users container. All other operations, including any search methods, will be rooted at the default naming context for the domain.

If the connection string specifies an Active Directory domain rather than a specific server and the property is `true`, the instance will always connect to the server with the PDC role for the domain to ensure that password changes take effect and are available when the method is called.

This connection string is not allowed when using ADAM, and will throw a .| +|LDAP://\:[port]

Port number is optional for ADAM and not needed for Active Directory.|The provider runs against the specified domain or server. With AD, user creation and deletion is done in the default users container. All other operations, including any search methods, will be rooted at the default naming context for the domain.

If the connection string specifies an Active Directory domain rather than a specific server and the property is `true`, the instance will always connect to the server with the PDC role for the domain to ensure that password changes take effect and are available when the method is called.

This connection string is not allowed when using ADAM, and will throw a .| |LDAP://\:[port]/\

Port number is optional for ADAM and not needed for Active Directory.|The provider runs against the specified domain or server. User creation and deletion is only done in the specified container. All other operations, including any search methods, perform subtree searches rooted at the container.

For ADAM servers, the container specifies the root of an application partition, or a container within an application partition.

We recommend that the connection string define a specific container to improve performance.| The instance maps directory attributes to properties. Default attributes are used if no attribute mapping is done in the Web.config file. For more information on attribute mappings, see the individual properties in the class documentation. @@ -48,20 +48,20 @@ |Property|Default directory attribute|Can be mapped?| |--------------|---------------------------------|--------------------| -||securityIdentifier|No| -||userPrincipalName|Yes, but must be either userPrincipalName or sAMAccountName| -||comment|No| -||whenCreated|No| -||mail|Yes, but must be a single-valued attribute of type Unicode String.| -||n/a|Not supported by .| -||n/a|Not supported by .| -||pwdLastSet|No| -||none|Yes, but must be a single-valued attribute of type Unicode String.| -||User-Account-Control (AD)

mDS-UserAccountDisabled (ADAM)|No| -||computed from lockoutTime and the AD lockout duration (AD on Windows 2000)

msDS-User-Account-Control-Computed (AD on Windows Server 2003)

msDS-User-Account-Control-Computed (ADAM)|No| -||If user is locked out due to too many bad password attempts, the lockout time attribute is returned.

If user is locked out due to too many bad password answer attempts, the value stored in the attribute defined by `attributeMapFailedPasswordAnswerLockoutTime` is returned.

If user is locked out due to both a bad password and too many bad password attempts, the most recent date/time value is returned.

If the account is not locked out, return 1/1/1754 for SQL compatibility.|No| - - When both the and properties are `true`, the class supports password-reset security by requiring the user to answer a predetermined question. To support the question and answer, you must set the following configuration attributes using the [add Element for providers for membership (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/whae3t94(v=vs.100)) in the application configuration file. +||securityIdentifier|No| +||userPrincipalName|Yes, but must be either userPrincipalName or sAMAccountName| +||comment|No| +||whenCreated|No| +||mail|Yes, but must be a single-valued attribute of type Unicode String.| +||n/a|Not supported by .| +||n/a|Not supported by .| +||pwdLastSet|No| +||none|Yes, but must be a single-valued attribute of type Unicode String.| +||User-Account-Control (AD)

mDS-UserAccountDisabled (ADAM)|No| +||computed from lockoutTime and the AD lockout duration (AD on Windows 2000)

msDS-User-Account-Control-Computed (AD on Windows Server 2003)

msDS-User-Account-Control-Computed (ADAM)|No| +||If user is locked out due to too many bad password attempts, the lockout time attribute is returned.

If user is locked out due to too many bad password answer attempts, the value stored in the attribute defined by `attributeMapFailedPasswordAnswerLockoutTime` is returned.

If user is locked out due to both a bad password and too many bad password attempts, the most recent date/time value is returned.

If the account is not locked out, return 1/1/1754 for SQL compatibility.|No| + + When both the and properties are `true`, the class supports password-reset security by requiring the user to answer a predetermined question. To support the question and answer, you must set the following configuration attributes using the [add Element for providers for membership (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/whae3t94(v=vs.100)) in the application configuration file. |Configuration attribute|Attribute type| |-----------------------------|--------------------| @@ -219,7 +219,7 @@ The following example shows the Web.config file for an ASP.NET application confi method is used to update the user's password in the Active Directory data store. Regardless of the credentials that the instance is configured to use, the provider connects to the Active Directory server using the `username` and `oldPassword` parameters as the connection credentials. + The method is used to update the user's password in the Active Directory data store. Regardless of the credentials that the instance is configured to use, the provider connects to the Active Directory server using the `username` and `oldPassword` parameters as the connection credentials. If the property is `true`, the user cannot change their password if the account was previously locked because the user made too many attempts to answer the password question. The user will need to wait the number of minutes specified in the property before changing the password. @@ -317,9 +317,9 @@ The following example shows the Web.config file for an ASP.NET application confi ## Remarks The method is called by the class to update the password question and answer for a user in the Active Directory membership store. - Requiring a password question and answer provides an additional layer of security when resetting a user's password. When creating a user name, a user can supply a question and answer that can later be used to reset a forgotten password. The method updates the password question and answer for a membership user to new values. + Requiring a password question and answer provides an additional layer of security when resetting a user's password. When creating a user name, a user can supply a question and answer that can later be used to reset a forgotten password. The method updates the password question and answer for a membership user to new values. - In order to use the method, you must set these additional attributes in your application's configuration file: + In order to use the method, you must set these additional attributes in your application's configuration file: - `requiresQuestionAndAnswer` must be `true`. @@ -329,11 +329,11 @@ The following example shows the Web.config file for an ASP.NET application confi The instance connects to the Active Directory data store with the credentials provided in the `username` and `password` parameters to validate the user name/password combination. The actual update of the question and answer is performed with the configured connection credentials of the provider. - If an incorrect password is supplied to the method, the directory server will increment the counters that track invalid password attempts. This can result in the user being locked and unable to log on until either the lock status is cleared by a call to the method or the locked duration specified in the directory passes. + If an incorrect password is supplied to the method, the directory server will increment the counters that track invalid password attempts. This can result in the user being locked and unable to log on until either the lock status is cleared by a call to the method or the locked duration specified in the directory passes. If the update to the question and answer succeeds and the property is `true`, the user's bad password answer tracking counters are reset. - The password answer is encrypted using the method before it is stored in the Active Directory data store. The encryption key and algorithm are specified by the [machineKey Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/w8h3skw9(v=vs.100)) configuration element. The decryption attribute on the [machineKey Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/w8h3skw9(v=vs.100)) element must be specified, the class does not support auto-generated encryption keys. + The password answer is encrypted using the method before it is stored in the Active Directory data store. The encryption key and algorithm are specified by the [machineKey Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/w8h3skw9(v=vs.100)) configuration element. The decryption attribute on the [machineKey Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/w8h3skw9(v=vs.100)) element must be specified, the class does not support auto-generated encryption keys. The maximum length for the password question is 256 characters. The maximum length for the password answer is 128 characters. @@ -434,7 +434,7 @@ The following example shows the Web.config file for an ASP.NET application confi method is called by the class to create a new user in the Active Directory data store. + The method is called by the class to create a new user in the Active Directory data store. For both Active Directory and Active Directory Application Mode (ADAM) servers, the class requires that the instance class in the directory be `user`. Alternative user classes such as `inetOrgPerson` are not supported. @@ -576,7 +576,7 @@ The following example shows the Web.config file for an ASP.NET application confi method immediately removes the user identified by the `username` parameter. Since the Active Directory data store does not store user information in separate areas of the directory, the `deleteAllRelatedData` parameter is ignored, although it must be set to either `true` or `false` when calling the method. + The method immediately removes the user identified by the `username` parameter. Since the Active Directory data store does not store user information in separate areas of the directory, the `deleteAllRelatedData` parameter is ignored, although it must be set to either `true` or `false` when calling the method. The class finds the user instance to delete by performing a single-level search for the user name in the users container determined by the connection string. See the class topic for more information about connection strings. @@ -628,7 +628,7 @@ The following example shows the Web.config file for an ASP.NET application confi property indicates whether you can use the method to reset a user's password. The property is set in your application's configuration file using the `enablePasswordReset` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. + The property indicates whether you can use the method to reset a user's password. The property is set in your application's configuration file using the `enablePasswordReset` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. You can only set the property to `true` when the following [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element settings have been made: @@ -638,7 +638,7 @@ The following example shows the Web.config file for an ASP.NET application confi If the above criteria are not met, a is thrown at initialization. - When the connection string in the application configuration file specifies an Active Directory domain rather than a specific server, the instance will always connect to the domain controller that has the PDC role for the domain to ensure that password changes take effect and are available when the method is called. + When the connection string in the application configuration file specifies an Active Directory domain rather than a specific server, the instance will always connect to the domain controller that has the PDC role for the domain to ensure that password changes take effect and are available when the method is called. > [!NOTE] > Even if the property is `true`, you cannot reset user passwords unless the credentials used to connect to the Active Directory server have either Domain Administrator rights (not recommended) or the "reset password" access right. @@ -711,11 +711,11 @@ The following example shows the Web.config file for an ASP.NET application confi When the property is `false`, the following methods are not available: -- +- -- +- -- +- The provider uses a subtree search starting at the search point specified in the connection string. See the class topic for more information about connection strings. @@ -784,17 +784,17 @@ The following example shows the Web.config file for an ASP.NET application confi method gets a containing the user records from the Active Directory store that match the `emailToMatch` parameters. The user records are returned sorted in ascending order by email address. + The method gets a containing the user records from the Active Directory store that match the `emailToMatch` parameters. The user records are returned sorted in ascending order by email address. The `emailToMatch` parameter is limited to 256 characters. The class will issue the search using both the `clientSearchTimeout` and `serverSearchTimeout` configuration values. Since the class performs searches against the directory server using pages with 512 rows per page, the time-outs apply to each page of results fetched by the class. For example, if a search query results in 1,000 rows of data, the class will fetch this information as two pages of data. This means that the client and search time-outs will start counting from zero when the class requests the second page of data. - The results returned by the method are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter specifies the maximum number of instances to return in the . The `pageIndex` parameter specifies which page of results to return, where 0 (zero) indicates the first page. + The results returned by the method are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter specifies the maximum number of instances to return in the . The `pageIndex` parameter specifies which page of results to return, where 0 (zero) indicates the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of matching membership users found in the Active Directory data store. For example, if there are 13 users for the configured data store, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users. The `totalRecords` parameter would be set to 13. - You can control whether to allow searching for users, by setting the property in the application's configuration file using the `enableSearchMethods` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. Setting the property to `false` causes the method to throw a exception. + You can control whether to allow searching for users, by setting the property in the application's configuration file using the `enableSearchMethods` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. Setting the property to `false` causes the method to throw a exception. The provider uses a subtree search starting at the search point specified in the connection string. See the class topic for more information about connection strings. @@ -858,13 +858,13 @@ The following example shows the Web.config file for an ASP.NET application confi method returns a instance containing the user records from the Active Directory data store for all user names that match the `userNameToMatch` parameters. The records are returned sorted alphabetically by user name. + The method returns a instance containing the user records from the Active Directory data store for all user names that match the `userNameToMatch` parameters. The records are returned sorted alphabetically by user name. - The results returned by the method are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter specifies the maximum number of instances to return in the . The `pageIndex` parameter specifies which page of results to return, where 0 (zero) indicates the first page. + The results returned by the method are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter specifies the maximum number of instances to return in the . The `pageIndex` parameter specifies which page of results to return, where 0 (zero) indicates the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of matching membership users found in the Active Directory data store. For example, if there are 13 users for the configured data store, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users. The `totalRecords` parameter would be set to 13. - You can control whether to allow searching for users, by setting the property in the application's configuration file using the `enableSearchMethods` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. Setting the property value to `false` causes the method to throw a exception. + You can control whether to allow searching for users, by setting the property in the application's configuration file using the `enableSearchMethods` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. Setting the property value to `false` causes the method to throw a exception. The provider uses a subtree search starting at the search point specified in the connection string. See the class topic for more information about connection strings. @@ -921,9 +921,9 @@ The following example shows the Web.config file for an ASP.NET application confi method of the class calls the method of the class to retrieve a random password. The password length is set to the value of the property. The password length can never be less than 14. + The method of the class calls the method of the class to retrieve a random password. The password length is set to the value of the property. The password length can never be less than 14. - You can specifically call the method by referencing the class directly from the Provider property of the class. + You can specifically call the method by referencing the class directly from the Provider property of the class. The generated password only contains alphanumeric characters and the following punctuation marks: !@#$%^&*()_-+=[{]};:<>|./?. No hidden or non-printable control characters are included in the generated password. @@ -970,11 +970,11 @@ The following example shows the Web.config file for an ASP.NET application confi ## Remarks This method is called by the class to retrieve user information from the Active Directory data store specified in the ASP.NET application's configuration file. - The results returned by the method are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter specifies the maximum number of instances to return in the collection. The `pageIndex` parameter specifies which page of results to return, where 0 (zero) indicates the first page. + The results returned by the method are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter specifies the maximum number of instances to return in the collection. The `pageIndex` parameter specifies which page of results to return, where 0 (zero) indicates the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of matching membership users found in the Active Directory data store. For example, if there are 13 users for the configured data store, and the `pageIndex` value was 1 with la `pageSize` of 5, the returned would contain the sixth through the tenth users. The `totalRecords` parameter would be set to 13. - You can control whether to allow searching for users by setting the property in the application's configuration file using the `enableSearchMethods` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. Setting the property to `false` causes the method to throw a exception. + You can control whether to allow searching for users by setting the property in the application's configuration file using the `enableSearchMethods` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. Setting the property to `false` causes the method to throw a exception. The provider uses a subtree search starting at the search point specified in the connection string. See the class topic for more information about connection strings. @@ -1104,7 +1104,7 @@ The following example shows the Web.config file for an ASP.NET application confi method is called by the class to retrieve information on the specified user from the Active Directory data store. + The method is called by the class to retrieve information on the specified user from the Active Directory data store. The search looks for a user instance where the `objectSID` attribute matches the `providerUserKey` parameter. @@ -1148,7 +1148,7 @@ The following example shows the Web.config file for an ASP.NET application confi method is called by the class to retrieve information on the specified user from the Active Directory data store. + The method is called by the class to retrieve information on the specified user from the Active Directory data store. The provider uses a subtree search starting at the search point specified in the connection string. See the class topic for more information about connection strings. @@ -1208,7 +1208,7 @@ The following example shows the Web.config file for an ASP.NET application confi We recommend that you do not enable searching on production systems until you have confirmed that the search queries issued by the class do not adversely impact your directory server's performance. > [!IMPORTANT] -> The method will run even when the property is `false`. +> The method will run even when the property is `false`. Since the class is designed for a stateless Web environment, it is unable to use the paging optimizations exposed by the underlying APIs. This means that paging operations during searches against large directories are very expensive and should be avoided. Search operations are always issued against the directory server configured in the connection string, or an automatically selected server in the case of a connection string pointing at a domain. The provider does not use a global catalog for its search methods. @@ -1526,7 +1526,7 @@ The following example shows the Web.config file for an ASP.NET application confi The property value is set in the application configuration using the `minRequiredNonalphanumericCharacters` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) configuration element. - A non-alphanumeric character is a character for which the method returns `false`. + A non-alphanumeric character is a character for which the method returns `false`. @@ -1794,7 +1794,7 @@ The following example shows the Web.config file for an ASP.NET application confi ## Remarks The property gets the regular expression used to evaluate password complexity. - The property is not used to validate auto-generated passwords in the method. + The property is not used to validate auto-generated passwords in the method. The property is set in the application configuration using the `passwordStrengthRegularExpression` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) configuration element. @@ -1901,7 +1901,7 @@ The following example shows the Web.config file for an ASP.NET application confi property is `true`, the instance ensures that the email address is not used by any other user within the current scope when either the or method is called. + When the property is `true`, the instance ensures that the email address is not used by any other user within the current scope when either the or method is called. The property is set in your application's configuration file using the `requiresUniqueEmail` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) element. If the property is not set in the application's configuration file, the property is set to the default value of `false`. @@ -1967,13 +1967,13 @@ The following example shows the Web.config file for an ASP.NET application confi The method is called by the class to reset the password for a user in the Active Directory data store to a new randomly generated value. The new password is returned. > [!NOTE] -> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the and properties. +> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the and properties. - If an incorrect answer is supplied to the method, the internal counter that tracks invalid password-answer attempts is incremented by one. This can result in the user being unable to log on until the lock status is cleared by a call to the method. If the correct password answer is supplied and the user is not currently locked out, then the internal counter that tracks invalid password attempts is reset to zero. For more information, see the and properties. + If an incorrect answer is supplied to the method, the internal counter that tracks invalid password-answer attempts is incremented by one. This can result in the user being unable to log on until the lock status is cleared by a call to the method. If the correct password answer is supplied and the user is not currently locked out, then the internal counter that tracks invalid password attempts is reset to zero. For more information, see the and properties. Leading and trailing spaces are trimmed from all parameter values. - You can call the method directly by first obtaining a reference to the instance from the property. + You can call the method directly by first obtaining a reference to the instance from the property. The provider uses a subtree search starting at the search point specified in the connection string. See the class topic for more information about connection strings. @@ -1997,7 +1997,7 @@ The following example shows the Web.config file for an ASP.NET application confi - The security context for connecting to the Active Directory data store (either the process account or the explicit credentials) must have sufficient privileges to change passwords. The credentials used to connect to the Active Directory server have either Domain Administrator rights (not recommended) or the "reset password" access right. > [!NOTE] -> Security policies set on the Active Directory server may make it impossible for the method to generate a password that satisfies the policies. The default implementation of the method will generate passwords that satisfy the default password policies on domain controllers running Windows Server 2003 SP1. If the password cannot be reset due to security policies on the Active Directory server, a is thrown. +> Security policies set on the Active Directory server may make it impossible for the method to generate a password that satisfies the policies. The default implementation of the method will generate passwords that satisfy the default password policies on domain controllers running Windows Server 2003 SP1. If the password cannot be reset due to security policies on the Active Directory server, a is thrown. ]]> @@ -2077,7 +2077,7 @@ The following example shows the Web.config file for an ASP.NET application confi method when the property is exceeded within the time specified in the property or when too many attempts have been made to log on using the wrong password. + Users are most commonly locked out and cannot be validated by the method when the property is exceeded within the time specified in the property or when too many attempts have been made to log on using the wrong password. If the property is `true`, when a user is unlocked the counters for bad passwords are reset. @@ -2129,11 +2129,11 @@ The following example shows the Web.config file for an ASP.NET application confi class to update user information in the Active Directory data store. The , , and property values are updated for the specified membership user. All other properties are ignored. + This method is called by the class to update user information in the Active Directory data store. The , , and property values are updated for the specified membership user. All other properties are ignored. The maximum length for the `username` parameter is 256 characters. The maximum length for the property is 256 characters. - The password for a membership user cannot be updated using the method. To update the password for a membership user, use the method. + The password for a membership user cannot be updated using the method. To update the password for a membership user, use the method. The provider uses a subtree search starting at the search point specified in the connection string. See the class topic for more information about connection strings. @@ -2213,7 +2213,7 @@ The following example shows the Web.config file for an ASP.NET application confi If the property is `true` and the supplied credentials are valid, the user's tracking counters for bad password answers are reset. - The method may return `false` when the correct credentials are supplied, under the following circumstances: + The method may return `false` when the correct credentials are supplied, under the following circumstances: 1. The user account was locked out by the directory server because of too many failed logon attempts. The user will not be able to log on until the directory's lockout duration passes. diff --git a/xml/System.Web.Security/ActiveDirectoryMembershipUser.xml b/xml/System.Web.Security/ActiveDirectoryMembershipUser.xml index 0f9fb8e112f..2a768caa8e2 100644 --- a/xml/System.Web.Security/ActiveDirectoryMembershipUser.xml +++ b/xml/System.Web.Security/ActiveDirectoryMembershipUser.xml @@ -28,35 +28,35 @@ ## Remarks The object is used to represent a single membership user in the Active Directory membership data store. It exposes information about the membership user such as the email address, and provides functionality for the membership user such as the ability to change or reset their password. - An object is returned by the application's membership provider whenever the application is configured to use an Active Directory data store. In an application that can be configured to use different data stores, or in an application that uses multiple data stores, you can refer to the base class, . Because the object does not implement the and properties, you must be prepared to handle the that is thrown when these members are accessed on an object. + An object is returned by the application's membership provider whenever the application is configured to use an Active Directory data store. In an application that can be configured to use different data stores, or in an application that uses multiple data stores, you can refer to the base class, . Because the object does not implement the and properties, you must be prepared to handle the that is thrown when these members are accessed on an object. - The class implements internal optimizations used by the class to minimize the number of attribute updates that occur when calling the method. It also serializes the representation (available in the property) so that an object can be serialized and deserialized without throwing exceptions. + The class implements internal optimizations used by the class to minimize the number of attribute updates that occur when calling the method. It also serializes the representation (available in the property) so that an object can be serialized and deserialized without throwing exceptions. - A object is returned by the and methods or as part of a returned by the , , and methods. + A object is returned by the and methods or as part of a returned by the , , and methods. - An object is required by the method when you want to update the information for an existing membership user. + An object is required by the method when you want to update the information for an existing membership user. properties are mapped to Active Directory attributes. The following table lists the properties and their default attribute mappings. |Property|Default directory attribute|Can be mapped?| |--------------|---------------------------------|--------------------| -||`securityIdentifier`|No| -||`userPrincipalName`|Yes, but must be either userPrincipalName or sAMAccountName| -||`comment`|No| -||`whenCreated`|No| -||`mail`|Yes, but must be a single-valued attribute of type Unicode String.| -||n/a|Not supported by .| -||n/a|Not supported by .| -||`pwdLastSet`|No| -||none, but must be mapped to an attribute if using question-and-answer security for password reset or retrieval.|Yes, but must be a single-valued attribute of type Unicode String.| -||`User-Account-Control` (AD)

`mDS-UserAccountDisabled` (ADAM)|No| -||computed from `lockoutTime` and the AD lockout duration (AD on Windows 2000)

`msDS-User-Account-Control-Computed` (AD on Windows Server 2003)

`msDS-User-Account-Control-Computed` (ADAM)|No| -||If locked out due to too many bad password attempts, the lockout time attribute is returned.

If locked out due to too many bad password answer attempts, the value stored in the attribute defined by `attributeMapFailedPasswordAnswerLockoutTime` is returned.

If locked out due to both a bad password and too many bad password attempts, the most recent date/time value is returned.

If the account is not locked out, return 1/1/1753 for SQL compatibility.|No| +||`securityIdentifier`|No| +||`userPrincipalName`|Yes, but must be either userPrincipalName or sAMAccountName| +||`comment`|No| +||`whenCreated`|No| +||`mail`|Yes, but must be a single-valued attribute of type Unicode String.| +||n/a|Not supported by .| +||n/a|Not supported by .| +||`pwdLastSet`|No| +||none, but must be mapped to an attribute if using question-and-answer security for password reset or retrieval.|Yes, but must be a single-valued attribute of type Unicode String.| +||`User-Account-Control` (AD)

`mDS-UserAccountDisabled` (ADAM)|No| +||computed from `lockoutTime` and the AD lockout duration (AD on Windows 2000)

`msDS-User-Account-Control-Computed` (AD on Windows Server 2003)

`msDS-User-Account-Control-Computed` (ADAM)|No| +||If locked out due to too many bad password attempts, the lockout time attribute is returned.

If locked out due to too many bad password answer attempts, the value stored in the attribute defined by `attributeMapFailedPasswordAnswerLockoutTime` is returned.

If locked out due to both a bad password and too many bad password attempts, the most recent date/time value is returned.

If the account is not locked out, return 1/1/1753 for SQL compatibility.|No| ## Examples - The following code example demonstrates using properties on the object on a Web page that may return user information from multiple membership data stores. Because the object that underlies the object returned by the membership provider does not implement the and properties, the code first checks the type of the user object returned from the membership provider before displaying the contents of those properties. + The following code example demonstrates using properties on the object on a Web page that may return user information from multiple membership data stores. Because the object that underlies the object returned by the membership provider does not implement the and properties, the code first checks the type of the user object returned from the membership provider before displaying the contents of those properties. [!code-aspx-csharp[System.Web.Security.ActiveDirectoryMembershipUser#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.ActiveDirectoryMembershipUser/CS/admuClassExamplecs.aspx#1)] [!code-aspx-vb[System.Web.Security.ActiveDirectoryMembershipUser#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.ActiveDirectoryMembershipUser/VB/admuClassExamplevb.aspx#1)] @@ -94,7 +94,7 @@ constructor is not intended to be used from your code. + The constructor is not intended to be used from your code. ]]> @@ -147,11 +147,11 @@ object does not add a new membership user object to the membership data store. To add a new membership user to the membership data store, use the method. Note that the method returns an object for the membership user added to the data store. + Creating a new object does not add a new membership user object to the membership data store. To add a new membership user to the membership data store, use the method. Note that the method returns an object for the membership user added to the data store. - objects are commonly constructed in application code for use with the method, although you can also pass an object returned from the , , , , or method to the method as well. + objects are commonly constructed in application code for use with the method, although you can also pass an object returned from the , , , , or method to the method as well. - objects are also commonly constructed by membership provider implementations for the , , , , , and methods. + objects are also commonly constructed by membership provider implementations for the , , , , , and methods. ]]> @@ -247,7 +247,7 @@ value for a membership user is checked during the call to by the . If the property returns `false`, the method returns `false` even if the supplied user name and password are correct. + The value for a membership user is checked during the call to by the . If the property returns `false`, the method returns `false` even if the supplied user name and password are correct. The property is mapped to one of the following Active Directory attributes. @@ -361,7 +361,7 @@ property exposes the identifier from the membership data source generically typed as an `object`. The class can be cast as a object. + The property exposes the identifier from the membership data source generically typed as an `object`. The class can be cast as a object. diff --git a/xml/System.Web.Security/AnonymousIdentificationEventArgs.xml b/xml/System.Web.Security/AnonymousIdentificationEventArgs.xml index 52dc40ed571..4ebbe4570e6 100644 --- a/xml/System.Web.Security/AnonymousIdentificationEventArgs.xml +++ b/xml/System.Web.Security/AnonymousIdentificationEventArgs.xml @@ -26,7 +26,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 the anonymous identification is . + The **AnonymousIdentification_Creating** event is only raised when the anonymous identification is . @@ -110,7 +110,7 @@ ## Remarks You can use the property to set the anonymous identifier to a custom value during the **AnonymousIdentification_Creating** event. 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 the anonymous identification is . + The **AnonymousIdentification_Creating** event is only raised when the anonymous identification is . @@ -153,7 +153,7 @@ provides access to , , and objects for the current request. + The provides access to , , and objects for the current request. ]]> diff --git a/xml/System.Web.Security/AnonymousIdentificationEventHandler.xml b/xml/System.Web.Security/AnonymousIdentificationEventHandler.xml index c2c70a068ae..8d0078208e5 100644 --- a/xml/System.Web.Security/AnonymousIdentificationEventHandler.xml +++ b/xml/System.Web.Security/AnonymousIdentificationEventHandler.xml @@ -34,7 +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/AnonymousIdentificationModule.xml b/xml/System.Web.Security/AnonymousIdentificationModule.xml index 4f33c6bab12..8e385eb97ac 100644 --- a/xml/System.Web.Security/AnonymousIdentificationModule.xml +++ b/xml/System.Web.Security/AnonymousIdentificationModule.xml @@ -30,7 +30,7 @@ The event is accessed by specifying a subroutine named **AnonymousIdentification_Creating** in the Global.asax file for your ASP.NET application. - The is only used when anonymous identification is by setting the enabled attribute of the [anonymousIdentification](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/91ka2e6a(v%3dvs.100)) configuration element to `true`. + The is only used when anonymous identification is by setting the enabled attribute of the [anonymousIdentification](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/91ka2e6a(v%3dvs.100)) configuration element to `true`. > [!NOTE] > Anonymous identification is independent of any type of ASP.NET authentication. @@ -92,7 +92,7 @@ ## Remarks This constructor is not intended to be called from application code. - ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. + ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. ]]> @@ -121,11 +121,11 @@ method removes the anonymous identifier associated with a session on a Web site. Use the method to remove the anonymous identifier associated with a session when the user switches to an authenticated session associated with a user ID, for example when the event occurs. + The method removes the anonymous identifier associated with a session on a Web site. Use the method to remove the anonymous identifier associated with a session when the user switches to an authenticated session associated with a user ID, for example when the event occurs. - Since a new anonymous identifier will be issued immediately if the current anonymous identifier is removed, the method will throw a if it is called while the session is identified by an anonymous identifier. + Since a new anonymous identifier will be issued immediately if the current anonymous identifier is removed, the method will throw a if it is called while the session is identified by an anonymous identifier. - If the site is using cookies, the method issues a clear cookie to remove the anonymous identifier from the browser. The clear cookie is issued even if an anonymous cookie was not sent on the previous request. + If the site is using cookies, the method issues a clear cookie to remove the anonymous identifier from the browser. The clear cookie is issued even if an anonymous cookie was not sent on the previous request. The clear cookie is constructed as follows: @@ -174,7 +174,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 the anonymous identification is . + The **AnonymousIdentification_Creating** event is only raised when the anonymous identification is . @@ -302,7 +302,7 @@ ## Remarks This method is not intended to be called from application code. - The method ensures that the is included in the processing of the event. + The method ensures that the is included in the processing of the event. ]]> diff --git a/xml/System.Web.Security/AuthorizationStoreRoleProvider.xml b/xml/System.Web.Security/AuthorizationStoreRoleProvider.xml index e80d552ac1f..73790d263fa 100644 --- a/xml/System.Web.Security/AuthorizationStoreRoleProvider.xml +++ b/xml/System.Web.Security/AuthorizationStoreRoleProvider.xml @@ -123,7 +123,7 @@ msxml:// constructor is called by ASP.NET to create an instance of the class as specified in the configuration for the application. This constructor is not intended to be used from your code. + The constructor is called by ASP.NET to create an instance of the class as specified in the configuration for the application. This constructor is not intended to be used from your code. ]]> @@ -158,7 +158,7 @@ msxml:// method is called by the class to associate one or more users with one or more roles in the authorization-manager data store specified in the ASP.NET application's configuration file (Web.config). This method is called by the , , , and methods of the class. + The method is called by the class to associate one or more users with one or more roles in the authorization-manager data store specified in the ASP.NET application's configuration file (Web.config). This method is called by the , , , and methods of the class. @@ -239,9 +239,9 @@ msxml:// is used by the to associate users and roles with different authorization-manager applications, which enables multiple ASP.NET applications to use the same authorization-manager policy store to store role information without running into conflicts between duplicate role names. Alternatively, multiple ASP.NET applications can use the same policy store by specifying the same value in the property. The property can be set programmatically, or it can be set declaratively in the application's Web.config file by using the `applicationName` attribute. + The is used by the to associate users and roles with different authorization-manager applications, which enables multiple ASP.NET applications to use the same authorization-manager policy store to store role information without running into conflicts between duplicate role names. Alternatively, multiple ASP.NET applications can use the same policy store by specifying the same value in the property. The property can be set programmatically, or it can be set declaratively in the application's Web.config file by using the `applicationName` attribute. - If a value is not specified for the `applicationName` attribute in the Web.config file, then the property value for the current object is used. + If a value is not specified for the `applicationName` attribute in the Web.config file, then the property value for the current object is used. > [!NOTE] > Authorization-manager application names cannot contain the "/" character that is included in the property. As a result, the default value for the property cannot be used as an authorization-manager application name, and in the application's Web.config file, you must always specify an `applicationName` attribute in the `provider` element to configure your instance. @@ -336,7 +336,7 @@ msxml:// method is called by the class to create a role in the authorization-manager data store specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to create a role in the authorization-manager data store specified in the ASP.NET application's configuration file (Web.config). Role names are not case sensitive. @@ -402,7 +402,7 @@ msxml:// method is called by the class to delete a role from the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). When a role is deleted, the list of users associated with that role is also deleted from the policy store. The user information in the database is not affected. + The method is called by the class to delete a role from the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). When a role is deleted, the list of users associated with that role is also deleted from the policy store. The user information in the database is not affected. If `throwOnPopulatedRole` is `true`, then an exception will be thrown and the role will not be deleted if the role identified by the `roleName` parameter has one or more members. If `throwOnPopulatedRole` is `false`, then the role will be deleted whether it is empty or not. @@ -497,12 +497,12 @@ msxml:// method is called by the class to retrieve a list of all the roles in the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to retrieve a list of all the roles in the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). ## Examples - The following code example uses the method to get the list of roles for an application and bind the results to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to get the list of roles for an application and bind the results to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/CS/createrolecs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/VB/createrolevb.aspx" id="Snippet1"::: @@ -550,12 +550,12 @@ msxml:// method is called by the class to retrieve a list of a specified user's roles from the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to retrieve a list of a specified user's roles from the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). ## Examples - The following code example uses the method to retrieve a list of roles for a specified user and binds them to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to retrieve a list of roles for a specified user and binds them to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/CS/ViewRolescs.aspx" id="Snippet4"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/VB/ViewRolesvb.aspx" id="Snippet4"::: @@ -607,14 +607,14 @@ msxml:// method is called by the class to retrieve the list of users associated with the specified role in the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to retrieve the list of users associated with the specified role in the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). - The method only returns user names that are directly contained in the authorization-manager role specified by the `roleName` parameter. The underlying authorization-manager API called by the method does not support group expansion, so users contained in nested NT groups, nested authorization-manager groups, and LDAP query groups will not be returned. + The method only returns user names that are directly contained in the authorization-manager role specified by the `roleName` parameter. The underlying authorization-manager API called by the method does not support group expansion, so users contained in nested NT groups, nested authorization-manager groups, and LDAP query groups will not be returned. ## Examples - The following code example uses the method to get a list of the users in a particular role and bind the results to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to get a list of the users in a particular role and bind the results to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/CS/adduserstorolecs.aspx" id="Snippet3"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/VB/adduserstorolevb.aspx" id="Snippet3"::: @@ -671,7 +671,7 @@ msxml:// method initializes the with the property values specified in the ASP.NET application configuration file (Web.config) and is not intended to be used directly from your code. + The method initializes the with the property values specified in the ASP.NET application configuration file (Web.config) and is not intended to be used directly from your code. ]]> @@ -720,7 +720,7 @@ msxml:// method is called by the class and the method of the property to determine whether a user is associated with a role in the authorization-manager data store specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class and the method of the property to determine whether a user is associated with a role in the authorization-manager data store specified in the ASP.NET application's configuration file (Web.config). @@ -790,7 +790,7 @@ msxml:// method is called by the class to remove one or more users from one or more roles in the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). This method is called by the , , , and methods of the class. + The method is called by the class to remove one or more users from one or more roles in the authorization-manager policy store specified in the ASP.NET application's configuration file (Web.config). This method is called by the , , , and methods of the class. @@ -870,12 +870,12 @@ msxml:// method is called by the class to determine whether a role name exists in the authorization-manager data store specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to determine whether a role name exists in the authorization-manager data store specified in the ASP.NET application's configuration file (Web.config). ## Examples - The following code example uses the method to determine whether a role name already exists before creating the role. For an example of a Web.config file that enables role management, see . + The following code example uses the method to determine whether a role name already exists before creating the role. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/CS/createrolecs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/VB/createrolevb.aspx" id="Snippet1"::: diff --git a/xml/System.Web.Security/DefaultAuthenticationEventArgs.xml b/xml/System.Web.Security/DefaultAuthenticationEventArgs.xml index 7fc93af9c08..d70729b145f 100644 --- a/xml/System.Web.Security/DefaultAuthenticationEventArgs.xml +++ b/xml/System.Web.Security/DefaultAuthenticationEventArgs.xml @@ -112,7 +112,7 @@ provides access to , , and objects for the current request. + The provides access to , , and objects for the current request. ]]> diff --git a/xml/System.Web.Security/DefaultAuthenticationEventHandler.xml b/xml/System.Web.Security/DefaultAuthenticationEventHandler.xml index ef6b636e7bf..c0ba37863d3 100644 --- a/xml/System.Web.Security/DefaultAuthenticationEventHandler.xml +++ b/xml/System.Web.Security/DefaultAuthenticationEventHandler.xml @@ -38,7 +38,7 @@ ## Examples - 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". + 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 `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. diff --git a/xml/System.Web.Security/DefaultAuthenticationModule.xml b/xml/System.Web.Security/DefaultAuthenticationModule.xml index 2519095dc5d..e5f27309910 100644 --- a/xml/System.Web.Security/DefaultAuthenticationModule.xml +++ b/xml/System.Web.Security/DefaultAuthenticationModule.xml @@ -34,7 +34,7 @@ ## Examples - The following example uses the **DefaultAuthentication_OnAuthenticate** event to test whether the property of the current instance is `null`. If the property is `null`, then the sample sets the property of the current instance to a object where the of the object is a with a value of "default." + The following example uses the **DefaultAuthentication_OnAuthenticate** event to test whether the property of the current instance is `null`. If the property is `null`, then the sample sets the property of the current instance 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 instance to a custom identity, it can affect the behavior of your application. For example, if you are using the class and you specify `` in the [authorization](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/8d82143t(v%3dvs.100)) configuration section to ensure that only authenticated users have access to your site, this sample will cause the [deny](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/8aeskccd(v%3dvs.100)) 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. @@ -75,7 +75,7 @@ ## Remarks This constructor is not intended to be called from application code. - ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. + ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. ]]> @@ -119,7 +119,7 @@ ## Examples - The following code example uses the **DefaultAuthentication_OnAuthenticate** event to test whether the property of the current instance is `null`. If the property is `null`, then the sample sets the property of the current instance to a object where the of the object is a with a value of "default." + The following code example uses the **DefaultAuthentication_OnAuthenticate** event to test whether the property of the current instance is `null`. If the property is `null`, then the sample sets the property of the current instance 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 instance to a custom identity, it can affect the behavior of your application. For example, if you are using the class and you specify `` in the [authorization](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/8d82143t(v%3dvs.100)) configuration section to ensure that only authenticated users have access to your site, this sample will cause the [deny](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/8aeskccd(v%3dvs.100)) 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. @@ -198,7 +198,7 @@ ## Remarks This method is not intended to be called from application code. - The method ensures that the is included in the processing of events. + The method ensures that the is included in the processing of events. ]]> diff --git a/xml/System.Web.Security/FileAuthorizationModule.xml b/xml/System.Web.Security/FileAuthorizationModule.xml index 069f20c1155..be34ef3be8e 100644 --- a/xml/System.Web.Security/FileAuthorizationModule.xml +++ b/xml/System.Web.Security/FileAuthorizationModule.xml @@ -22,11 +22,11 @@ Verifies that the user has permission to access the file requested. This class cannot be inherited. - is being used for the application, the module ensures that the requesting user is allowed read or write access to the resource, depending on the request verb, before executing the request. For more information, see the method. - + is being used for the application, the module ensures that the requesting user is allowed read or write access to the resource, depending on the request verb, before executing the request. For more information, see the method. + ]]> ASP.NET Authorization @@ -55,13 +55,13 @@ Creates an instance of the class. - class. After calling the constructor, it calls the method to initialize the new object. - + class. After calling the constructor, it calls the method to initialize the new object. + ]]> ASP.NET Authorization @@ -96,26 +96,26 @@ if the current Windows user represented by has access to the file using the specified HTTP verb or if the module is not defined in the application's configuration file; otherwise, . - method checks to see whether the current user, represented by a Windows access token, is granted access to the requested file in the file-system access-control lists (ACLs). The virtual path is mapped to the physical file-system path before the check is made. - - If the HTTP verb used to make the request is `GET`, `POST`, or `HEAD`, the method checks for read access to the file. If any other verb is used, the method checks for read/write permission to the file. - - **Security Note** If the module is not defined in the `httpModules` configuration section for the application, the module always returns `true`. - + method checks to see whether the current user, represented by a Windows access token, is granted access to the requested file in the file-system access-control lists (ACLs). The virtual path is mapped to the physical file-system path before the check is made. + + If the HTTP verb used to make the request is `GET`, `POST`, or `HEAD`, the method checks for read access to the file. If any other verb is used, the method checks for read/write permission to the file. + + **Security Note** If the module is not defined in the `httpModules` configuration section for the application, the module always returns `true`. + ]]> - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . is not in the application directory structure of the Web application. @@ -146,11 +146,11 @@ Releases all resources, other than memory, used by the . - ASP.NET Authorization @@ -183,13 +183,13 @@ The current instance. Initializes the object. - method ensures that the is included in the processing of the event. - + method ensures that the is included in the processing of the event. + ]]> ASP.NET Authorization diff --git a/xml/System.Web.Security/FormsAuthentication.xml b/xml/System.Web.Security/FormsAuthentication.xml index 3aae872eb87..0cbbd36b67b 100644 --- a/xml/System.Web.Security/FormsAuthentication.xml +++ b/xml/System.Web.Security/FormsAuthentication.xml @@ -36,9 +36,9 @@ ``` - In the previous example, any request for an ASP.NET page that is part of the application requires a valid user name that is supplied by forms authentication. If no user name exists, then the request is redirected to the configured . + In the previous example, any request for an ASP.NET page that is part of the application requires a valid user name that is supplied by forms authentication. If no user name exists, then the request is redirected to the configured . - The class provides access to methods and properties that you can use in an application that authenticates users. The method redirects a browser to the configured for users to log into an application. The method redirects an authenticated user back to the original protected URL that was requested or to the . There are also methods that enable you to manage forms-authentication tickets, if needed. + The class provides access to methods and properties that you can use in an application that authenticates users. The method redirects a browser to the configured for users to log into an application. The method redirects an authenticated user back to the original protected URL that was requested or to the . There are also methods that enable you to manage forms-authentication tickets, if needed. ## Examples The following code example shows the Web.config file for an ASP.NET application that uses the ASP.NET membership provider for forms authentication and requires all users to be authenticated. @@ -176,7 +176,7 @@ This method is obsolete. The recommended alternative is to use the Membership AP property value is set in the configuration file for an ASP.NET application by using the `domain` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The property value determines the that the cookie will be used for. + The property value is set in the configuration file for an ASP.NET application by using the `domain` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The property value determines the that the cookie will be used for. @@ -222,7 +222,7 @@ This method is obsolete. The recommended alternative is to use the Membership AP The property reflects the value for the `cookieless` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The property determines whether the value will be stored in a session cookie in the browser or stored in the property. > [!NOTE] -> When the value is stored in the URI, the length of the generated URI may be longer than the maximum length allowed. This is most likely to occur when the property is set to the application name and the application name is long (40 or more characters), when user names in the application are long, or when long strings are stored in the value. If the generated URI is too long, the Web server will return a `400 - Bad Request` error. +> When the value is stored in the URI, the length of the generated URI may be longer than the maximum length allowed. This is most likely to occur when the property is set to the application name and the application name is long (40 or more characters), when user names in the application are long, or when long strings are stored in the value. If the generated URI is too long, the Web server will return a `400 - Bad Request` error. @@ -286,7 +286,7 @@ This method is obsolete. The recommended alternative is to use the Membership AP property returns a value based on the value and the capabilities of the browser. + The property returns a value based on the value and the capabilities of the browser. - If the property is set to , the property will return `true`. @@ -294,7 +294,7 @@ This method is obsolete. The recommended alternative is to use the Membership AP - If the property is set to , the property will return `true` if the browser supports cookies and cookies are enabled; otherwise, the property will return `false`. -- If the property is set to , the property will return `true` if the for the current supports both cookies and redirecting with cookies; otherwise, the property will return `false`. +- If the property is set to , the property will return `true` if the for the current supports both cookies and redirecting with cookies; otherwise, the property will return `false`. @@ -378,7 +378,7 @@ This method is obsolete. The recommended alternative is to use the Membership AP property value is set in the configuration file for an ASP.NET application by using the `defaultUrl` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The property is used by the method if no return URL is included in the request. Similarly, the method will return the if no return URL is included in the request. + The property value is set in the configuration file for an ASP.NET application by using the `defaultUrl` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The property is used by the method if no return URL is included in the request. Similarly, the method will return the if no return URL is included in the request. @@ -423,13 +423,13 @@ This method is obsolete. The recommended alternative is to use the Membership AP ## Remarks The property value is set using the `enableCrossAppRedirects` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. - The property is checked within the method when the redirect URL does not point to a page in the current application. If is `true`, then the redirect is performed; if is `false`, the browser is redirected to the page defined in the property. + The property is checked within the method when the redirect URL does not point to a page in the current application. If is `true`, then the redirect is performed; if is `false`, the browser is redirected to the page defined in the property. > [!NOTE] > When you redirect pages across applications, you must make sure that specific attributes in the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element are duplicated across the authenticated applications. For more information and an example, see [Forms Authentication Across Applications](https://learn.microsoft.com/previous-versions/aspnet/eb0zx8fc(v=vs.100)). > [!IMPORTANT] -> When cross-application redirects are allowed, your site is vulnerable to an exploit that directs users to a malicious Web site but uses the login page for your site. Always verify that the redirect URL that is returned by the method is a URL that you expect so that you can make sure that you allow redirects only to approved Web sites. You must also verify that the redirect URL uses the appropriate protocol (HTTP or HTTPS). To perform these verifications, you can add a postback event handler to your login page, or you can add a handler for the event of the control. +> When cross-application redirects are allowed, your site is vulnerable to an exploit that directs users to a malicious Web site but uses the login page for your site. Always verify that the redirect URL that is returned by the method is a URL that you expect so that you can make sure that you allow redirects only to approved Web sites. You must also verify that the redirect URL uses the appropriate protocol (HTTP or HTTPS). To perform these verifications, you can add a postback event handler to your login page, or you can add a handler for the event of the control. @@ -516,7 +516,7 @@ This method is obsolete. The recommended alternative is to use the Membership AP method in a cookie by using the property and redirects the user to the URL returned from the method. + The following code example stores the result of the method in a cookie by using the property and redirects the user to the URL returned from the method. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -555,7 +555,7 @@ This method is obsolete. The recommended alternative is to use the Membership AP property value is set in the configuration file for an ASP.NET application by using the `name` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The is used to reference the cookie that stores the information. + The property value is set in the configuration file for an ASP.NET application by using the `name` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The is used to reference the cookie that stores the information. @@ -599,7 +599,7 @@ This method is obsolete. The recommended alternative is to use the Membership AP property value is set in the configuration file for an ASP.NET application using the `path` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The specifies the for the cookie that stores the information. + The property value is set in the configuration file for an ASP.NET application using the `path` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The specifies the for the cookie that stores the information. @@ -736,13 +736,13 @@ This method is obsolete. The recommended alternative is to use the Membership AP method. + You can use this method when you want to perform the redirect in your application code instead of using the method. - The method returns the URL specified in the query string using the `ReturnURL` variable name. For example, in the URL `http://www.contoso.com/login.aspx?ReturnUrl=caller.aspx`, the method returns the return URL `caller.aspx`. If the `ReturnURL` variable does not exist, the method returns the URL in the property. + The method returns the URL specified in the query string using the `ReturnURL` variable name. For example, in the URL `http://www.contoso.com/login.aspx?ReturnUrl=caller.aspx`, the method returns the return URL `caller.aspx`. If the `ReturnURL` variable does not exist, the method returns the URL in the property. ASP.NET automatically adds the return URL when the browser is redirected to the login page. - By default, the `ReturnUrl` variable must refer to a page within the current application. If `ReturnUrl` refers to a page in a different application or on a different server, the methods returns the URL in the property. If you want to allow the return URL to refer to a page outside the current application, you must set the property to `true` using the `enableCrossAppRedirects` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. + By default, the `ReturnUrl` variable must refer to a page within the current application. If `ReturnUrl` refers to a page in a different application or on a different server, the methods returns the URL in the property. If you want to allow the return URL to refer to a page outside the current application, you must set the property to `true` using the `enableCrossAppRedirects` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. This method does not create a cookie. @@ -752,7 +752,7 @@ This method does not create a cookie. ## Examples - The following code example redirects authenticated users to the URL returned from the method. + The following code example redirects authenticated users to the URL returned from the method. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -840,7 +840,7 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method is called when the creates an instance of the class. This method is not intended to be called from your code. + The method is called when the creates an instance of the class. This method is not intended to be called from your code. ]]> @@ -892,7 +892,7 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store property value is set in the configuration file for an ASP.NET application by using the `loginUrl` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The is used by the method. + The property value is set in the configuration file for an ASP.NET application by using the `loginUrl` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. The is used by the method. @@ -951,23 +951,23 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method redirects to the URL specified in the query string using the `ReturnURL` variable name. For example, in the URL `http://www.contoso.com/login.aspx?ReturnUrl=caller.aspx`, the method redirects to the return URL `caller.aspx`. If the `ReturnURL` variable does not exist, the method redirects to the URL in the property. + The method redirects to the URL specified in the query string using the `ReturnURL` variable name. For example, in the URL `http://www.contoso.com/login.aspx?ReturnUrl=caller.aspx`, the method redirects to the return URL `caller.aspx`. If the `ReturnURL` variable does not exist, the method redirects to the URL in the property. ASP.NET automatically adds the return URL when the browser is redirected to the login page. - By default, the `ReturnUrl` variable must refer to a page within the current application. If `ReturnUrl` refers to a page in a different application or on a different server, the methods redirects to the URL in the property. If you want to allow redirects to a page outside the current application, you must set the property to `true` using the `enableCrossAppRedirects` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. + By default, the `ReturnUrl` variable must refer to a page within the current application. If `ReturnUrl` refers to a page in a different application or on a different server, the methods redirects to the URL in the property. If you want to allow redirects to a page outside the current application, you must set the property to `true` using the `enableCrossAppRedirects` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. > [!IMPORTANT] > Setting the property to `true` to allow cross-application redirects is a potential security threat. For more information, see the property. - If the property is `true`, and either the `ReturnUrl` variable is within the current application or the property is `true`, then the method issues an authentication ticket and places it in the default cookie using the method. + If the property is `true`, and either the `ReturnUrl` variable is within the current application or the property is `true`, then the method issues an authentication ticket and places it in the default cookie using the method. - If is `false` and the redirect path is to a URL in the current application, the ticket is issued as part of the redirect URL. If is `false`, is `true`, and the redirect URL does not refer to a page within the current application, the method issues an authentication ticket and places it in the property. + If is `false` and the redirect path is to a URL in the current application, the ticket is issued as part of the redirect URL. If is `false`, is `true`, and the redirect URL does not refer to a page within the current application, the method issues an authentication ticket and places it in the property. ## Examples - The following code example redirects validated users to either the originally requested URL or the . The code example uses ASP.NET membership to validate users. For more information about ASP.NET membership, see [Managing Users by Using Membership](https://learn.microsoft.com/previous-versions/aspnet/tw292whz(v=vs.100)). + The following code example redirects validated users to either the originally requested URL or the . The code example uses ASP.NET membership to validate users. For more information about ASP.NET membership, see [Managing Users by Using Membership](https://learn.microsoft.com/previous-versions/aspnet/tw292whz(v=vs.100)). > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -1013,18 +1013,18 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method redirects to the return URL specified in the query string using the `ReturnURL` variable name. For example, in the URL `http://www.contoso.com/login.aspx?ReturnUrl=caller.aspx`, the method redirects to the return URL `caller.aspx`. If the `ReturnURL` variable does not exist, the method redirects to the URL in the property. + The method redirects to the return URL specified in the query string using the `ReturnURL` variable name. For example, in the URL `http://www.contoso.com/login.aspx?ReturnUrl=caller.aspx`, the method redirects to the return URL `caller.aspx`. If the `ReturnURL` variable does not exist, the method redirects to the URL in the property. ASP.NET automatically adds the return URL when the browser is redirected to the login page. - By default, the `ReturnUrl` variable must refer to a page within the current application. If `ReturnUrl` refers to a page in a different application or on a different server, the method redirects to the URL in the property. If you want to allow redirects to a page outside the current application, you must set the property to `true` using the `enableCrossAppRedirects` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. + By default, the `ReturnUrl` variable must refer to a page within the current application. If `ReturnUrl` refers to a page in a different application or on a different server, the method redirects to the URL in the property. If you want to allow redirects to a page outside the current application, you must set the property to `true` using the `enableCrossAppRedirects` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. > [!IMPORTANT] > Setting the property to `true` to allow cross-application redirects is a potential security threat. For more information, see the property. - If the property is `true`, and either the `ReturnUrl` variable is within the current application or the property is `true`, then the method issues an authentication ticket and places it in the cookie specified by the `strCookiePath` parameter using the method. + If the property is `true`, and either the `ReturnUrl` variable is within the current application or the property is `true`, then the method issues an authentication ticket and places it in the cookie specified by the `strCookiePath` parameter using the method. - If is `false` and the redirect path is to a URL in the current application, the ticket is issued as part of the redirect URL. If is `false`, is `true`, and the redirect URL does not refer to a page within the current application, the method issues an authentication ticket and places it in the property. + If is `false` and the redirect path is to a URL in the current application, the ticket is issued as part of the redirect URL. If is `false`, is `true`, and the redirect URL does not refer to a page within the current application, the method issues an authentication ticket and places it in the property. ]]> @@ -1043,16 +1043,16 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method redirects the browser to the . + The method redirects the browser to the . - The method does not clear the forms-authentication cookie. You can use the method in conjunction with the method to log one user out and allow a different user to log in. + The method does not clear the forms-authentication cookie. You can use the method in conjunction with the method to log one user out and allow a different user to log in. - Unlike the method, this method does not end the request by calling . This means that code that follows the method call will run. + Unlike the method, this method does not end the request by calling . This means that code that follows the method call will run. ## Examples - The following code example clears the forms-authentication cookie using the method and redirects the user to the login page using the method. + The following code example clears the forms-authentication cookie using the method and redirects the user to the login page using the method. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.FormsAuthentication/CS/signoutcs.aspx" id="Snippet2"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.FormsAuthentication/VB/signoutvb.aspx" id="Snippet2"::: @@ -1091,14 +1091,14 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method redirects the browser to the . + The method redirects the browser to the . - The method does not clear the forms-authentication cookie. You can use the method in conjunction with the method to log one user out and allow a different user to log in. + The method does not clear the forms-authentication cookie. You can use the method in conjunction with the method to log one user out and allow a different user to log in. ## Examples - The following code example clears the forms-authentication cookie using the method and redirects the user to the login page using the method. + The following code example clears the forms-authentication cookie using the method and redirects the user to the login page using the method. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.FormsAuthentication/CS/signoutcs.aspx" id="Snippet2"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.FormsAuthentication/VB/signoutvb.aspx" id="Snippet2"::: @@ -1134,14 +1134,14 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method redirects the browser to the and includes the `extraQueryString` value as the for the redirected URL. + The method redirects the browser to the and includes the `extraQueryString` value as the for the redirected URL. - The method does not clear the forms-authentication cookie. You can use the method in conjunction with the method to log one user out and allow a different user to log in. + The method does not clear the forms-authentication cookie. You can use the method in conjunction with the method to log one user out and allow a different user to log in. ## Examples - The following code example clears the forms-authentication cookie using the method and redirects the user to the login page using the method. + The following code example clears the forms-authentication cookie using the method and redirects the user to the login page using the method. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.FormsAuthentication/CS/signout2cs.aspx" id="Snippet3"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.FormsAuthentication/VB/signout2vb.aspx" id="Snippet3"::: @@ -1179,9 +1179,9 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method updates the expiration date and time of the supplied if the current date and time minus the value is greater than the value minus the current date and time. + The method updates the expiration date and time of the supplied if the current date and time minus the value is greater than the value minus the current date and time. - The ticket is updated with the property set to the current date and time and the property set to the current date and time plus the original value minus the original value. + The ticket is updated with the property set to the current date and time and the property set to the current date and time plus the original value minus the original value. ]]> @@ -1213,7 +1213,7 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store property value is set in the configuration file for an ASP.NET application by using the `requireSSL` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. You can specify in the Web.config file for your ASP.NET application whether SSL (Secure Sockets Layer) is required to return the forms-authentication cookie to the server by setting the `requireSSL` attribute . For more information, see . + The property value is set in the configuration file for an ASP.NET application by using the `requireSSL` attribute of the [forms](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1d3t3c61(v%3dvs.100)) configuration element. You can specify in the Web.config file for your ASP.NET application whether SSL (Secure Sockets Layer) is required to return the forms-authentication cookie to the server by setting the `requireSSL` attribute . For more information, see . It is recommended that if you configure `requireSSL` as `false`, you also configure `slidingExpiration` as `false`, to reduce the amount of time for which a ticket is valid. @@ -1247,7 +1247,7 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method adds a forms-authentication ticket to either the cookies collection or the URL if is `false`. The forms-authentication ticket supplies forms-authentication information to the next request made by the browser. With forms authentication, you can use the method when you want to authenticate a user but still retain control of the navigation with redirects. + The method adds a forms-authentication ticket to either the cookies collection or the URL if is `false`. The forms-authentication ticket supplies forms-authentication information to the next request made by the browser. With forms authentication, you can use the method when you want to authenticate a user but still retain control of the navigation with redirects. ]]> @@ -1286,7 +1286,7 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method adds a forms-authentication ticket to either the cookies collection, or to the URL if is `false`. The forms-authentication ticket supplies forms-authentication information to the next request made by the browser. With forms authentication, you can use the method when you want to authenticate a user but still retain control of the navigation with redirects. + The method adds a forms-authentication ticket to either the cookies collection, or to the URL if is `false`. The forms-authentication ticket supplies forms-authentication information to the next request made by the browser. With forms authentication, you can use the method when you want to authenticate a user but still retain control of the navigation with redirects. ]]> @@ -1327,7 +1327,7 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method adds a forms-authentication ticket to either the cookies collection or the URL if is `false`. The forms-authentication ticket supplies forms-authentication information to the next request made by the browser. With forms authentication, you can use the method when you want to authenticate a user but still retain control of the navigation with redirects. + The method adds a forms-authentication ticket to either the cookies collection or the URL if is `false`. The forms-authentication ticket supplies forms-authentication information to the next request made by the browser. With forms authentication, you can use the method when you want to authenticate a user but still retain control of the navigation with redirects. ]]> @@ -1362,13 +1362,13 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store method removes the forms-authentication ticket information from the cookie or the URL if is `false`. You can use the method in conjunction with the method to log one user out and allow a different user to log in. + The method removes the forms-authentication ticket information from the cookie or the URL if is `false`. You can use the method in conjunction with the method to log one user out and allow a different user to log in. If you run exclusively in cookieless mode, or if you support both authenticated and anonymous users, you should explicitly control the redirect to the login page if you require special business logic to execute as a result of removing the anonymous identifier. - When the method is called, a redirect to the application's login page is made by calling the method with the `endResponse` parameter set to `false`. The redirect does not take place until the current page has finished executing, so additional code can be run. If the code does not contain an explicit redirect to another page, the user is redirected to the login page configured in the application's configuration file. + When the method is called, a redirect to the application's login page is made by calling the method with the `endResponse` parameter set to `false`. The redirect does not take place until the current page has finished executing, so additional code can be run. If the code does not contain an explicit redirect to another page, the user is redirected to the login page configured in the application's configuration file. - Calling the method only removes the forms authentication cookie. The Web server does not store valid and expired authentication tickets for later comparison. This makes your site vulnerable to a replay attack if a malicious user obtains a valid forms authentication cookie. To improve security when using a forms authentication cookie, you should do the following: + Calling the method only removes the forms authentication cookie. The Web server does not store valid and expired authentication tickets for later comparison. This makes your site vulnerable to a replay attack if a malicious user obtains a valid forms authentication cookie. To improve security when using a forms authentication cookie, you should do the following: - Use absolute expiration for forms authentication cookies by setting the property to `false`. This limits the window in which a hijacked cookie can be replayed. @@ -1379,7 +1379,7 @@ This method is obsolete. Alternatively, you can use ASP.NET membership to store ## Examples - The following code example clears the forms-authentication cookie using the method and redirects the user to the login page using the method. + The following code example clears the forms-authentication cookie using the method and redirects the user to the login page using the method. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.FormsAuthentication/CS/signoutcs.aspx" id="Snippet2"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.FormsAuthentication/VB/signoutvb.aspx" id="Snippet2"::: diff --git a/xml/System.Web.Security/FormsAuthenticationEventArgs.xml b/xml/System.Web.Security/FormsAuthenticationEventArgs.xml index 1ff7d56216d..0fbec91d097 100644 --- a/xml/System.Web.Security/FormsAuthenticationEventArgs.xml +++ b/xml/System.Web.Security/FormsAuthenticationEventArgs.xml @@ -29,12 +29,12 @@ If you do not specify a value for the property during the **FormsAuthentication_OnAuthenticate** event, the identity supplied by the forms authentication ticket in the cookie or URL is used. - The **FormsAuthentication_OnAuthenticate** event is only raised when the authentication is set to and the is an active HTTP module for the application. + The **FormsAuthentication_OnAuthenticate** event is only raised when the authentication is set to and the is an active HTTP module for the application. ## Examples - The following code example uses the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a object with a custom . + The following code example uses the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a object with a custom . [!code-csharp[System.Web.Security.FormsAuthenticationModule#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.FormsAuthenticationModule/CS/global.asax#1)] [!code-vb[System.Web.Security.FormsAuthenticationModule#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.FormsAuthenticationModule/VB/global.asax#1)] @@ -111,7 +111,7 @@ provides access to , , and objects for the current request. + The provides access to , , and objects for the current request. ]]> @@ -159,7 +159,7 @@ ## Examples - The following example uses the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a object with a custom . + The following example uses the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a object with a custom . [!code-csharp[System.Web.Security.FormsAuthenticationModule#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.FormsAuthenticationModule/CS/global.asax#1)] [!code-vb[System.Web.Security.FormsAuthenticationModule#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.FormsAuthenticationModule/VB/global.asax#1)] diff --git a/xml/System.Web.Security/FormsAuthenticationEventHandler.xml b/xml/System.Web.Security/FormsAuthenticationEventHandler.xml index 60185c38fc3..c59d7172ede 100644 --- a/xml/System.Web.Security/FormsAuthenticationEventHandler.xml +++ b/xml/System.Web.Security/FormsAuthenticationEventHandler.xml @@ -35,12 +35,12 @@ You can use the property of the object supplied to the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property during the **FormsAuthentication_OnAuthenticate** event, the identity supplied by the forms authentication ticket in the cookie or URL is used. - The **FormsAuthentication_OnAuthenticate** event is only raised when the authentication is set to and the is an active HTTP module for the application. + The **FormsAuthentication_OnAuthenticate** event is only raised when the authentication is set to and the is an active HTTP module for the application. ## Examples - The following code example uses the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a object with a custom . + The following code example uses the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a object with a custom . [!code-csharp[System.Web.Security.FormsAuthenticationModule#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.FormsAuthenticationModule/CS/global.asax#1)] [!code-vb[System.Web.Security.FormsAuthenticationModule#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.FormsAuthenticationModule/VB/global.asax#1)] diff --git a/xml/System.Web.Security/FormsAuthenticationModule.xml b/xml/System.Web.Security/FormsAuthenticationModule.xml index f0c698e81d3..f06e032687e 100644 --- a/xml/System.Web.Security/FormsAuthenticationModule.xml +++ b/xml/System.Web.Security/FormsAuthenticationModule.xml @@ -25,7 +25,7 @@ sets the current property to an object that represents the user identity for the current request when the authentication is set to in the [authentication Element (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/27bc0ba9-f23a-45f3-ae42-dbe7916e3ee2) element of the application's configuration file. + The sets the current property to an object that represents the user identity for the current request when the authentication is set to in the [authentication Element (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/27bc0ba9-f23a-45f3-ae42-dbe7916e3ee2) element of the application's configuration file. The exposes an event that enables you to provide a custom object for the property of the current . The event is accessed by specifying a subroutine named **FormsAuthentication_OnAuthenticate** in the Global.asax file for your ASP.NET application. @@ -73,7 +73,7 @@ ## Remarks This constructor is not intended to be called from application code. - ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. + ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. ]]> @@ -114,7 +114,7 @@ ## Examples - The following code example uses the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a object that has a custom . + The following code example uses the **FormsAuthentication_OnAuthenticate** event to set the property of the current to a object that has a custom . [!code-csharp[System.Web.Security.FormsAuthenticationModule#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.FormsAuthenticationModule/CS/global.asax#1)] [!code-vb[System.Web.Security.FormsAuthenticationModule#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.FormsAuthenticationModule/VB/global.asax#1)] @@ -190,7 +190,7 @@ ## Remarks This method is not intended to be called from application code. - The method ensures that the is included in the processing of the and events. + The method ensures that the is included in the processing of the and events. ]]> diff --git a/xml/System.Web.Security/FormsAuthenticationTicket.xml b/xml/System.Web.Security/FormsAuthenticationTicket.xml index b204d4eb001..610581dd629 100644 --- a/xml/System.Web.Security/FormsAuthenticationTicket.xml +++ b/xml/System.Web.Security/FormsAuthenticationTicket.xml @@ -29,14 +29,14 @@ ## Remarks The class is used to create an object that represents the authentication ticket that is used by forms authentication to identify an authenticated user. The properties and values of a forms-authentication ticket are converted to and from an encrypted string that is stored in a cookie or in the URL. - The class provides an method to create a string value that can be stored in a cookie or in the URL from a . The class also provides a method to create a object from the encrypted authentication ticket retrieved from the forms-authentication cookie or the URL. + The class provides an method to create a string value that can be stored in a cookie or in the URL from a . The class also provides a method to create a object from the encrypted authentication ticket retrieved from the forms-authentication cookie or the URL. - The for the current authenticated user can be accessed using the property of the class. You can access the current object by casting the property of the current as type . + The for the current authenticated user can be accessed using the property of the class. You can access the current object by casting the property of the current as type . ## Examples - The following code example stores the result of the method in a cookie using the and redirects the user to the URL returned from the method. + The following code example stores the result of the method in a cookie using the and redirects the user to the URL returned from the method. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -88,7 +88,7 @@ object created by this constructor will have a value set to the value of the property, a value of 2, an value of the current local date and time, a value of an empty string (""), and an value that is set to the current local date and time plus the value of the `timeout` parameter. + The object created by this constructor will have a value set to the value of the property, a value of 2, an value of the current local date and time, a value of an empty string (""), and an value that is set to the current local date and time plus the value of the `timeout` parameter. ]]> @@ -130,7 +130,7 @@ object created by this constructor will have a value set to the value of the . + The object created by this constructor will have a value set to the value of the . > [!NOTE] > The `userData` parameter cannot be `null`. @@ -190,7 +190,7 @@ ## Examples - The following code example stores the result of the method in a cookie using the property and redirects the user to the URL returned from the method. + The following code example stores the result of the method in a cookie using the property and redirects the user to the URL returned from the method. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -281,7 +281,7 @@ is created using the constructor that does not supply a parameter for an expiration date and time, the property returns a value based on the current local date and time plus the value of the `timeout` parameter supplied to the constructor. + If the is created using the constructor that does not supply a parameter for an expiration date and time, the property returns a value based on the current local date and time plus the value of the `timeout` parameter supplied to the constructor. If the was created using a constructor that takes an `expiration` parameter, the property returns the value supplied to the `expiration` parameter. @@ -326,7 +326,7 @@ property returns `true` if the date and time is less than the current local date and time; otherwise, the property returns `false`. + The property returns `true` if the date and time is less than the current local date and time; otherwise, the property returns `false`. @@ -418,7 +418,7 @@ property represents the local date and time when the forms-authentication ticket was issued. The method uses the property value to determine whether the date and time of a forms-authentication ticket needs to be renewed and also uses the property value to determine the new date and time. When a ticket is renewed, the property is updated to the local date and time. + The property represents the local date and time when the forms-authentication ticket was issued. The method uses the property value to determine whether the date and time of a forms-authentication ticket needs to be renewed and also uses the property value to determine the new date and time. When a ticket is renewed, the property is updated to the local date and time. diff --git a/xml/System.Web.Security/MachineKey.xml b/xml/System.Web.Security/MachineKey.xml index fccfb3f6a5f..993763e1a2f 100644 --- a/xml/System.Web.Security/MachineKey.xml +++ b/xml/System.Web.Security/MachineKey.xml @@ -154,9 +154,9 @@ method, which requires the caller to specify whether the plaintext data should be encrypted, signed, or both. The method performs the appropriate operation and securely protects the data. Ciphertext data produced by this method can only be deciphered by the method. + This method supersedes the method, which requires the caller to specify whether the plaintext data should be encrypted, signed, or both. The method performs the appropriate operation and securely protects the data. Ciphertext data produced by this method can only be deciphered by the method. - The `purposes` parameter is an optional list of reasons that can lock the ciphertext to a specific purpose. This parameter lets you isolate cryptographic operations performed by different subsystems within an application. A malicious client should not be able to get the result of one subsystem's method and feed it as input to another subsystem's method, which could compromise application security. The `purposes` parameter helps ensure that protected data can only be used by the component that originally generated it. Applications should make sure that each subsystem uses a unique `purposes` list. + The `purposes` parameter is an optional list of reasons that can lock the ciphertext to a specific purpose. This parameter lets you isolate cryptographic operations performed by different subsystems within an application. A malicious client should not be able to get the result of one subsystem's method and feed it as input to another subsystem's method, which could compromise application security. The `purposes` parameter helps ensure that protected data can only be used by the component that originally generated it. Applications should make sure that each subsystem uses a unique `purposes` list. For example, to protect or unprotect an authentication token, you could call the method using code like the following example: @@ -182,7 +182,7 @@ MachineKey.Protect(..., "Private message", "Recipient: " + username) MachineKey.Unprotect(..., "Private message", "Recipient: " + username) ``` - When the method is called, the value that is provided for the `purposes` parameter must be the same value that was provided to the method. Otherwise the operation will fail with a exception. + When the method is called, the value that is provided for the `purposes` parameter must be the same value that was provided to the method. Otherwise the operation will fail with a exception. The configuration settings that are required for the option are required for this method even if the property is not set to the option. @@ -227,7 +227,7 @@ MachineKey.Unprotect(..., "Private message", "Recipient: " + username) method. + For information about this method, see the method. ]]> diff --git a/xml/System.Web.Security/Membership.xml b/xml/System.Web.Security/Membership.xml index 5465e6d84b6..7abf281b55f 100644 --- a/xml/System.Web.Security/Membership.xml +++ b/xml/System.Web.Security/Membership.xml @@ -69,7 +69,7 @@ ## Examples - The following code example shows the login page for an ASP.NET application configured to use forms authentication and ASP.NET membership. If the supplied user credentials are invalid, a message is displayed to the user. Otherwise, the user is redirected to the originally requested URL using the method. + The following code example shows the login page for an ASP.NET application configured to use forms authentication and ASP.NET membership. If the supplied user credentials are invalid, a message is displayed to the user. Otherwise, the user is redirected to the originally requested URL using the method. > [!NOTE] > The ASP.NET login controls (, , , , and ) encapsulate virtually all of the logic required to prompt users for credentials and validate the credentials in the membership system and can be used in place of programmatic checking using the class. @@ -108,7 +108,7 @@ is used to identify users specific to an application. That is, the same user name can exist in the database for multiple ASP.NET applications that specify a different . This enables multiple applications to use the same database to store user information without running into duplicate user name conflicts. Alternatively, multiple ASP.NET applications can use the same user database by specifying the same . The can be set programmatically or declaratively in the configuration for the Web application. + The is used to identify users specific to an application. That is, the same user name can exist in the database for multiple ASP.NET applications that specify a different . This enables multiple applications to use the same database to store user information without running into duplicate user name conflicts. Alternatively, multiple ASP.NET applications can use the same user database by specifying the same . The can be set programmatically or declaratively in the configuration for the Web application. > [!CAUTION] > Because a single default membership 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 for 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 membership data for multiple applications. Such an application should be a single-user application and not a Web application. @@ -116,7 +116,7 @@ ## Examples - The following code example shows the [membership](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v%3dvs.100)) element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies that the application use a instance and sets the to `MyApplication`. + The following code example shows the [membership](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v%3dvs.100)) element in the `system.web` section of the Web.config file for an ASP.NET application. It specifies that the application use a instance and sets the to `MyApplication`. ``` @@ -183,13 +183,13 @@ adds a new user to the data store and returns a object for the newly created user. If the user creation fails, a is thrown. You can retrieve a value from the property of the that indicates why user creation failed. + adds a new user to the data store and returns a object for the newly created user. If the user creation fails, a is thrown. You can retrieve a value from the property of the that indicates why user creation failed. - Once a membership user has been created and you have a reference to a object for that user, you can modify the settings for that user with the public methods, such as for applications where is `true`, or by setting the property values of the object and passing them to the method. + Once a membership user has been created and you have a reference to a object for that user, you can modify the settings for that user with the public methods, such as for applications where is `true`, or by setting the property values of the object and passing them to the method. - If a user already exists in the data source for the application, you can obtain a object for the existing user with the method. + If a user already exists in the data source for the application, you can obtain a object for the existing user with the method. - The provides an option to require a unique email address for each user. If the property is `true`, you will need to use one of the overloads that allows you to specify an email address for the user being created. Otherwise, a will be thrown. + The provides an option to require a unique email address for each user. If the property is `true`, you will need to use one of the overloads that allows you to specify an email address for the user being created. Otherwise, a will be thrown. Leading and trailing spaces are trimmed from all parameter values. @@ -241,11 +241,11 @@ adds a new user to the data store and returns a object for the newly created user. If the user creation fails, a is thrown. You can retrieve a value from the property of the that indicates why user creation failed. + adds a new user to the data store and returns a object for the newly created user. If the user creation fails, a is thrown. You can retrieve a value from the property of the that indicates why user creation failed. - Once a membership user has been created and you have a reference to a object for that user, you can modify the settings for that user with the public methods, such as for applications where is `true`, or by setting the property values of the object and passing them to the method. + Once a membership user has been created and you have a reference to a object for that user, you can modify the settings for that user with the public methods, such as for applications where is `true`, or by setting the property values of the object and passing them to the method. - If a user already exists in the data source for the application, you can obtain a object for the existing user with the method. + If a user already exists in the data source for the application, you can obtain a object for the existing user with the method. Leading and trailing spaces are trimmed from all parameter values. @@ -311,13 +311,13 @@ adds a new user to the data store and returns a object for the newly created user. If the user creation fails, you can retrieve a value from the `status` output parameter that indicates why user creation failed. + adds a new user to the data store and returns a object for the newly created user. If the user creation fails, you can retrieve a value from the `status` output parameter that indicates why user creation failed. - The method will return `null` if `password` is an empty string or `null`, `username` is an empty string or `null` or contains a comma (,), `passwordQuestion` is not `null` and is an empty string, or `passwordAnswer` is not `null` and contains an empty string. + The method will return `null` if `password` is an empty string or `null`, `username` is an empty string or `null` or contains a comma (,), `passwordQuestion` is not `null` and is an empty string, or `passwordAnswer` is not `null` and contains an empty string. - Once a membership user has been created and you have a reference to a object for that user, you can modify the settings for that user with the public methods and by setting the property values of the object and then passing the object to the method. + Once a membership user has been created and you have a reference to a object for that user, you can modify the settings for that user with the public methods and by setting the property values of the object and then passing the object to the method. - If a user already exists in the data source for the application, you can obtain a object for the existing user with the method. + If a user already exists in the data source for the application, you can obtain a object for the existing user with the method. Leading and trailing spaces are trimmed from all string parameter values. @@ -378,13 +378,13 @@ adds a new user to the data store and returns a object for the newly created user. If the user creation fails, you can retrieve a value from the `status` output parameter that indicates why user creation failed. You can specify a unique identifier for the user, such as a primary key value for a database, by using the `providerUserKey` parameter. + adds a new user to the data store and returns a object for the newly created user. If the user creation fails, you can retrieve a value from the `status` output parameter that indicates why user creation failed. You can specify a unique identifier for the user, such as a primary key value for a database, by using the `providerUserKey` parameter. - The method will return `null` if `password` is an empty string or `null`, `username` is an empty string or `null` or contains a comma (,), `passwordQuestion` is not `null` and contains an empty string, or `passwordAnswer` is not `null` and contains an empty string. + The method will return `null` if `password` is an empty string or `null`, `username` is an empty string or `null` or contains a comma (,), `passwordQuestion` is not `null` and contains an empty string, or `passwordAnswer` is not `null` and contains an empty string. - Once a membership user has been created and you have a reference to a object for that user, you can modify the settings for that user with the public methods and by setting the property values of the object and then passing the object to the method. + Once a membership user has been created and you have a reference to a object for that user, you can modify the settings for that user with the public methods and by setting the property values of the object and then passing the object to the method. - If a user already exists in the data source for the application, you can obtain a object for the existing user with the method. + If a user already exists in the data source for the application, you can obtain a object for the existing user with the method. Leading and trailing spaces are trimmed from all string parameter values. @@ -431,7 +431,7 @@ , , or personalization is also deleted when you are using the , , and objects for data storage. + User data stored in the database for the , , or personalization is also deleted when you are using the , , and objects for data storage. @@ -483,7 +483,7 @@ ## Remarks Users deleted from the database are only deleted from the configured `applicationName`. - If `deleteAllRelatedData` is `true`, user data stored in the database for the , , or personalization is also deleted when you are using the , , and objects for data storage. + If `deleteAllRelatedData` is `true`, user data stored in the database for the , , or personalization is also deleted when you are using the , , and objects for data storage. @@ -548,7 +548,7 @@ ``` - The following code example first verifies that is `true`, then resets a user's password and returns the new, automatically generated password. + The following code example first verifies that is `true`, then resets a user's password and returns the new, automatically generated password. [!code-aspx-csharp[System.Web.Security.SqlMembershipProvider#8](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlMembershipProvider/CS/ResetPasswordcs.aspx#8)] [!code-aspx-vb[System.Web.Security.SqlMembershipProvider#8](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlMembershipProvider/VB/ResetPasswordvb.aspx#8)] @@ -582,7 +582,7 @@ is `false`, the underlying membership provider may throw a . + If is `false`, the underlying membership provider may throw a . The providers that are included with the .NET Framework support multiple password formats to enhance password security. If the password format is set to , then users will not be able to retrieve their existing password from the database. The password format provides one-way encoding of password values. Passwords are "hashed" and compared to values stored in the database for authentication. "Hashed" values cannot be un-encoded to retrieve the original password value. For more information, see . @@ -606,7 +606,7 @@ ``` - The following code example first verifies that is `true`, then retrieves the password for a specified user name and sends it to the email address for the specified user. + The following code example first verifies that is `true`, then retrieves the password for a specified user name and sends it to the email address for the specified user. > [!IMPORTANT] > Returning a password in clear text using email is not recommended for sites that require a high level of security. For high-security sites, we recommend that you return passwords using encryption, such as SSL. @@ -660,14 +660,14 @@ returns a list of membership users where the email address matches the supplied `emailToMatch` for the configured `applicationName`. + returns a list of membership users where the email address matches the supplied `emailToMatch` for the configured `applicationName`. The performs its search using a LIKE clause against the `emailToMatch` parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the `emailToMatch` parameter value. ## Examples - The following code example uses the method to retrieve membership user information from the membership database based on user input and displays the results in pages of data. + The following code example uses the method to retrieve membership user information from the membership database based on user input and displays the results in pages of data. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -713,18 +713,18 @@ returns a list of membership users where the email address matches the supplied `emailToMatch` for the configured `applicationName`. + returns a list of membership users where the email address matches the supplied `emailToMatch` for the configured `applicationName`. The performs its search using a LIKE clause against the `emailToMatch` parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the `emailToMatch` parameter value. - The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users that matched the `emailToMatch` value. For example, if 13 users were found where `emailToMatch` matched part of or the entire email address, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users that matched the `emailToMatch` value. For example, if 13 users were found where `emailToMatch` matched part of or the entire email address, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. Leading and trailing spaces are trimmed from the `emailToMatch` parameter value. ## Examples - The following code example uses the method to retrieve membership user information from the membership database based on user input and displays the results in pages of data. + The following code example uses the method to retrieve membership user information from the membership database based on user input and displays the results in pages of data. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -782,7 +782,7 @@ returns a list of membership users where the user name matches the supplied `usernameToMatch` for the configured `applicationName`. + returns a list of membership users where the user name matches the supplied `usernameToMatch` for the configured `applicationName`. The performs its search using a LIKE clause against the `usernameToMatch` parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the `usernameToMatch` parameter value. @@ -791,7 +791,7 @@ ## Examples - The following code example uses the method to retrieve membership user information from the membership database based on user input and displays the results in pages of data. + The following code example uses the method to retrieve membership user information from the membership database based on user input and displays the results in pages of data. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -843,16 +843,16 @@ returns a list of membership users where the user name matches the supplied `usernameToMatch` for the configured `applicationName`. + returns a list of membership users where the user name matches the supplied `usernameToMatch` for the configured `applicationName`. The performs its search using a LIKE clause against the `usernameToMatch` parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the `usernameToMatch` parameter value. - The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users that matched the `usernameToMatch` value. For example, if 13 users were found where `usernameToMatch` matched part of or the entire user name, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users that matched the `usernameToMatch` value. For example, if 13 users were found where `usernameToMatch` matched part of or the entire user name, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. ## Examples - The following code example uses the method to retrieve membership user information from the membership database based on user input and displays the results in pages of data. + The following code example uses the method to retrieve membership user information from the membership database based on user input and displays the results in pages of data. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -906,17 +906,17 @@ method is used to generate a random password and is most commonly used by the method implemented by a membership provider to reset the password for a user to a new, temporary password. + The method is used to generate a random password and is most commonly used by the method implemented by a membership provider to reset the password for a user to a new, temporary password. The generated password only contains alphanumeric characters and the following punctuation marks: `!@#$%^&*()_-+=[{]};:<>|./?`. No hidden or non-printable control characters are included in the generated password. > [!NOTE] -> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the property and the `numberOfNonAlphanumericCharacters` parameter. +> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the property and the `numberOfNonAlphanumericCharacters` parameter. ## Examples - The following code example creates a new membership user and uses the method to initialize the password for the new user to a random value, which is displayed to the user. + The following code example creates a new membership user and uses the method to initialize the password for the new user to a random value, which is displayed to the user. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -967,7 +967,7 @@ returns the information for all membership users for an application as a collection of objects. Be careful when using the method with very large user databases, as the resulting in your ASP.NET page may degrade the performance of your application. + returns the information for all membership users for an application as a collection of objects. Be careful when using the method with very large user databases, as the resulting in your ASP.NET page may degrade the performance of your application. @@ -1013,7 +1013,7 @@ are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users for the configured `applicationName`. For example, if there are 13 users for the configured `applicationName`, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users for the configured `applicationName`. For example, if there are 13 users for the configured `applicationName`, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. @@ -1058,7 +1058,7 @@ returns the number of users for the current where the last-activity date is greater than the current time less the . The last-activity date/time stamp is updated to the current date and time when user credentials are validated by way of the or method or when a call to a overload that takes no parameters or one that uses the `userIsOnline` parameter to specify that the date/time stamp should be updated. + returns the number of users for the current where the last-activity date is greater than the current time less the . The last-activity date/time stamp is updated to the current date and time when user credentials are validated by way of the or method or when a call to a overload that takes no parameters or one that uses the `userIsOnline` parameter to specify that the date/time stamp should be updated. @@ -1106,9 +1106,9 @@ retrieves the user information from the data source and creates a object populated with the returned data. If you use one of the overloads that does not take a `username` parameter, returns the information for the current logged-on membership user. The current logged-on membership user is identified by the of the user in the current . + retrieves the user information from the data source and creates a object populated with the returned data. If you use one of the overloads that does not take a `username` parameter, returns the information for the current logged-on membership user. The current logged-on membership user is identified by the of the user in the current . - You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved using the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, `GetUser()` implicitly updates the last-activity date/time stamp for the user. `GetUser(System.String)` and `GetUser(System.Object)` do not. + You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved using the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, `GetUser()` implicitly updates the last-activity date/time stamp for the user. `GetUser(System.String)` and `GetUser(System.Object)` do not. @@ -1151,9 +1151,9 @@ method retrieves the user information from the data source and creates a object populated with the returned data. If you use one of the overloads that does not take a `username` parameter, returns the information for the current logged-on membership user. The current logged-on membership user is identified by the of the user in the current . + The method retrieves the user information from the data source and creates a object populated with the returned data. If you use one of the overloads that does not take a `username` parameter, returns the information for the current logged-on membership user. The current logged-on membership user is identified by the of the user in the current . - You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved using the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, `GetUser()` implicitly updates the last-activity date/time stamp for the user. `GetUser(System.String)` and `GetUser(System.Object)` do not. + You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved using the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, `GetUser()` implicitly updates the last-activity date/time stamp for the user. `GetUser(System.String)` and `GetUser(System.Object)` do not. @@ -1202,9 +1202,9 @@ method retrieves the user information from the data source and creates a object populated with the returned data. The user is identified using the unique identifier from the data source specified using the `providerUserKey` parameter. + The method retrieves the user information from the data source and creates a object populated with the returned data. The user is identified using the unique identifier from the data source specified using the `providerUserKey` parameter. - You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved with the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, `GetUser()` implicitly updates the last-activity date/time stamp for the user. `GetUser(System.String)` and `GetUser(System.Object)` do not + You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved with the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, `GetUser()` implicitly updates the last-activity date/time stamp for the user. `GetUser(System.String)` and `GetUser(System.Object)` do not ]]> @@ -1246,14 +1246,14 @@ method retrieves the user information from the data source and creates a object populated with the returned data. If you use one of the overloads that does not take a `username` parameter, returns the information for the current logged-on membership user. The current logged-on membership user is identified by the of the user in the current . + The method retrieves the user information from the data source and creates a object populated with the returned data. If you use one of the overloads that does not take a `username` parameter, returns the information for the current logged-on membership user. The current logged-on membership user is identified by the of the user in the current . - You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved with the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, implicitly updates the last-activity date/time stamp for the user. and do not. + You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved with the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, implicitly updates the last-activity date/time stamp for the user. and do not. ## Examples - The following code example uses the method to return a object for the current logged-on user and updates the email address for the user. + The following code example uses the method to return a object for the current logged-on user and updates the email address for the user. [!code-aspx-csharp[System.Web.Security.SqlMembershipProvider#11](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlMembershipProvider/CS/UpdateEmailcs.aspx#11)] [!code-aspx-vb[System.Web.Security.SqlMembershipProvider#11](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlMembershipProvider/VB/UpdateEmailvb.aspx#11)] @@ -1296,7 +1296,7 @@ method retrieves the user information from the data source and creates a object populated with the returned data. The user is identified with the unique identifier from the data source specified in the `providerUserKey` parameter. + The method retrieves the user information from the data source and creates a object populated with the returned data. The user is identified with the unique identifier from the data source specified in the `providerUserKey` parameter. ]]> @@ -1334,16 +1334,16 @@ method retrieves the user information from the data source and creates a object populated with the returned data. + The method retrieves the user information from the data source and creates a object populated with the returned data. - If you use one of the overloads that does not take a `username` parameter, returns the information for the current logged-on membership user. The current logged-on membership user is identified by the of the user in the current . + If you use one of the overloads that does not take a `username` parameter, returns the information for the current logged-on membership user. The current logged-on membership user is identified by the of the user in the current . - You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved with the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, implicitly updates the last-activity date/time stamp for the user. and do not. + You can also specify whether you want to update the last-activity date/time stamp for the user being retrieved with the `userIsOnline` parameter. Of the overloads that do not take a `userIsOnline` parameter, implicitly updates the last-activity date/time stamp for the user. and do not. ## Examples - The following code example retrieves the password for a specified user name and sends it to the email address for the specified user. The call to specifies that the last-activity date/time stamp for the user not be updated. + The following code example retrieves the password for a specified user name and sends it to the email address for the specified user. The call to specifies that the last-activity date/time stamp for the user not be updated. [!code-aspx-csharp[System.Web.Security.SqlMembershipProvider#4](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlMembershipProvider/CS/RetrievePasswordcs.aspx#4)] [!code-aspx-vb[System.Web.Security.SqlMembershipProvider#4](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlMembershipProvider/VB/RetrievePasswordvb.aspx#4)] @@ -1384,7 +1384,7 @@ can be used to retrieve the user name for a membership user in the case where a user does not know their user name, but does know their email address. If more than one user in the data store has the same email address, the first user name encountered is returned. + can be used to retrieve the user name for a membership user in the case where a user does not know their user name, but does know their email address. If more than one user in the data store has the same email address, the first user name encountered is returned. Leading and trailing spaces are trimmed from all parameter values. @@ -1463,7 +1463,7 @@ ## Remarks The property works in conjunction with the property to guard against an unwanted source using repeated attempts to guess the password or password answer of a membership user. - If the number of invalid passwords or password answers entered for a membership user is greater than or equal to the value of the property within the number of minutes specified by the property, then the user is locked out of the Web site by setting the property to `true` until the user is unlocked by a call to the method. + If the number of invalid passwords or password answers entered for a membership user is greater than or equal to the value of the property within the number of minutes specified by the property, then the user is locked out of the Web site by setting the property to `true` until the user is unlocked by a call to the method. If a valid password or password answer is supplied before the value of the property is reached, the counter that tracks the number of invalid attempts is set to zero. @@ -1526,7 +1526,7 @@ The property value is set in the application configuration using the `minRequiredNonAlphanumericCharacters` attribute of the [membership](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v%3dvs.100)) configuration element. - A non-alphanumeric character is a character for which the method returns `false`. + A non-alphanumeric character is a character for which the method returns `false`. @@ -1630,11 +1630,11 @@ ## Remarks The property works in conjunction with the property to help guard against an unwanted source guessing the password or password answer of a membership user through repeated attempts. When a user attempts to log in with, change, or reset their password, only a certain number of consecutive attempts are allowed within a specified time window. The length of this time window is specified in the property, which identifies the number of minutes allowed between invalid attempts. - If the number of consecutive failed attempts that a user makes to reset their password equals the value stored in the property, and the time elapsed since the last invalid attempt is less than the number of minutes specified in the property, then the membership user is locked out. The user is locked out by setting the property to `true` until the user is unlocked by a call to the method. + If the number of consecutive failed attempts that a user makes to reset their password equals the value stored in the property, and the time elapsed since the last invalid attempt is less than the number of minutes specified in the property, then the membership user is locked out. The user is locked out by setting the property to `true` until the user is unlocked by a call to the method. If the interval between the current failed attempt and the last failed attempt is greater than the property setting, the current invalid attempt is counted as the first. If a valid password answer is supplied before the maximum number of allowed invalid attempts is reached, the count of invalid password-answer attempts is set to 0 (zero). If a valid password is supplied before the maximum number of allowed invalid attempts is reached, the count of invalid password attempts and the count of invalid password-answer attempts are set to 0 (zero). - Invalid password and password-answer attempts accumulate independently of one another. For example, if the is set to 5, and three invalid password attempts are made followed by two invalid password-answer attempts, two more invalid password attempts (or three more invalid password-answer attempts) must be made within for the membership user to be locked out. + Invalid password and password-answer attempts accumulate independently of one another. For example, if the is set to 5, and three invalid password attempts are made followed by two invalid password-answer attempts, two more invalid password attempts (or three more invalid password-answer attempts) must be made within for the membership user to be locked out. The property value is set in the application configuration by using the `passwordAttemptWindow` attribute of the [membership](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v%3dvs.100)) configuration-element section. @@ -1819,7 +1819,7 @@ When specifying the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) section, you must specify the `defaultProvider` attribute. If you do not specify a [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) section in your Web.config, the values from the machine configuration are used and the instance named `AspNetSqlProvider` is established as the `defaultProvider`. - You can obtain a strongly typed reference to a provider from the collection by indexing the membership provider by name and casting it as the desired type. + You can obtain a strongly typed reference to a provider from the collection by indexing the membership provider by name and casting it as the desired type. @@ -1860,11 +1860,11 @@ ## Remarks Requiring a password question and answer provides an additional layer of security when retrieving or resetting a user's password. Users can supply a question and answer when their user name is created that they can later use to retrieve or reset a forgotten password. - is checked when or is called. The provider provided with the .NET Framework throws a if is `true` and the supplied password answer is `null`. + is checked when or is called. The provider provided with the .NET Framework throws a if is `true` and the supplied password answer is `null`. - If and are both `false`, can still be used to enforce the creation of questions and answers when new users are created; however, the question and answer will not be used. You will be able to retrieve the question by using the class. + If and are both `false`, can still be used to enforce the creation of questions and answers when new users are created; however, the question and answer will not be used. You will be able to retrieve the question by using the class. - For more information, see and . + For more information, see and . @@ -1886,7 +1886,7 @@ ``` - The following code sample checks the value of and adds the necessary controls for a password question and answer to be supplied when creating a user. + The following code sample checks the value of and adds the necessary controls for a password question and answer to be supplied when creating a user. > [!IMPORTANT] > This example includes a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -1925,7 +1925,7 @@ takes, as input, a object populated with current information for the membership user and updates the data source with the property values of the object. You can construct a new , or retrieve a object populated with current values at the data source using the , , , or methods. + takes, as input, a object populated with current information for the membership user and updates the data source with the property values of the object. You can construct a new , or retrieve a object populated with current values at the data source using the , , , or methods. @@ -1968,9 +1968,9 @@ property value is checked during the call to . If the for a user is greater than the current date and time minus the value in minutes, then the user is considered online. You can determine whether a membership user is considered online with the property of the class. + The property value is checked during the call to . If the for a user is greater than the current date and time minus the value in minutes, then the user is considered online. You can determine whether a membership user is considered online with the property of the class. - The for a user is updated when a user's credentials are successfully validated by the method. You can also update the for a membership user when you call one of the overloads. If you call a overload that takes a `userIsOnline` parameter, specify a value of `true` to update the for the user. + The for a user is updated when a user's credentials are successfully validated by the method. You can also update the for a membership user when you call one of the overloads. If you call a overload that takes a `userIsOnline` parameter, specify a value of `true` to update the for the user. @@ -2028,12 +2028,12 @@ provides an easy way to verify a user name and password from the data source. Note that, if the `username` parameter is empty or `null`, an is thrown. + provides an easy way to verify a user name and password from the data source. Note that, if the `username` parameter is empty or `null`, an is thrown. ## Examples - The following code example shows the login page for an ASP.NET application configured to use forms authentication and the class. If the supplied user credentials are invalid, a message is displayed to the user. Otherwise, the user is redirected to the originally requested URL by the method. + The following code example shows the login page for an ASP.NET application configured to use forms authentication and the class. If the supplied user credentials are invalid, a message is displayed to the user. Otherwise, the user is redirected to the originally requested URL by the method. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -2068,11 +2068,11 @@ event is raised when the method, the method, or the method of a membership provider is called. + The event is raised when the method, the method, or the method of a membership provider is called. You can use the event to validate password formats and values for membership users. - You can cancel the current , , or action by setting the property of the supplied to `true` during the event. + You can cancel the current , , or action by setting the property of the supplied to `true` during the event. If you cancel the current action by setting the property to `true`, you can set the property of the supplied to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the property is set to. If the property is `null`, the caller will throw a generic password-validation-failure exception. diff --git a/xml/System.Web.Security/MembershipCreateStatus.xml b/xml/System.Web.Security/MembershipCreateStatus.xml index 61c132d490b..103bf87e611 100644 --- a/xml/System.Web.Security/MembershipCreateStatus.xml +++ b/xml/System.Web.Security/MembershipCreateStatus.xml @@ -31,12 +31,12 @@ enumeration indicates the success or failure of an attempt to create a new user. If the operation fails, the enumeration describes the cause of the failure. + The enumeration indicates the success or failure of an attempt to create a new user. If the operation fails, the enumeration describes the cause of the failure. > [!NOTE] > If you are not familiar with the membership features of ASP.NET, see [Introduction to Membership](https://learn.microsoft.com/previous-versions/aspnet/yh26yfzy(v=vs.100)) before continuing. For a list of other topics related to membership, see [Managing Users by Using Membership](https://learn.microsoft.com/previous-versions/aspnet/tw292whz(v=vs.100)). - If you use a method overload that does not specify an output parameter of type , an unsuccessful attempt to create a new user throws a with the property set to one of the enumeration values. + If you use a method overload that does not specify an output parameter of type , an unsuccessful attempt to create a new user throws a with the property set to one of the enumeration values. diff --git a/xml/System.Web.Security/MembershipCreateUserException.xml b/xml/System.Web.Security/MembershipCreateUserException.xml index 441989cec6f..5bf6c414cc7 100644 --- a/xml/System.Web.Security/MembershipCreateUserException.xml +++ b/xml/System.Web.Security/MembershipCreateUserException.xml @@ -36,7 +36,7 @@ class is thrown when a operation fails. + An instance of the class is thrown when a operation fails. > [!NOTE] > If you are not familiar with the membership features of ASP.NET, see [Introduction to Membership](https://learn.microsoft.com/previous-versions/aspnet/yh26yfzy(v=vs.100)) before continuing. For a list of other topics related to membership, see [Managing Users by Using Membership](https://learn.microsoft.com/previous-versions/aspnet/tw292whz(v=vs.100)). @@ -92,12 +92,12 @@ class is thrown by the method when the user is not created. + An instance of the class is thrown by the method when the user is not created. ## Examples - The following code example calls the method to create a new membership user. If the user creation fails, a is thrown. + The following code example calls the method to create a new membership user. If the user creation fails, a is thrown. [!code-csharp[System.Web.Security.MembershipCreateUserException#3](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.MembershipCreateUserException/CS/createuser3cs.aspx#3)] [!code-vb[System.Web.Security.MembershipCreateUserException#3](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.MembershipCreateUserException/VB/createuser3vb.aspx#3)] @@ -133,14 +133,14 @@ class is thrown by the method when the user is not created. + The class is thrown by the method when the user is not created. You can use the `message` parameter to set the property of the exception to a meaningful description of the reason for the exception. ## Examples - The following code example calls the method to create a new membership user. If the user creation fails, a is thrown with a message based on the returned by the method. + The following code example calls the method to create a new membership user. If the user creation fails, a is thrown with a message based on the returned by the method. [!code-csharp[System.Web.Security.MembershipCreateUserException#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.MembershipCreateUserException/CS/createuser2cs.aspx#2)] [!code-vb[System.Web.Security.MembershipCreateUserException#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.MembershipCreateUserException/VB/createuser2vb.aspx#2)] @@ -176,14 +176,14 @@ class is thrown by the method when the user is not created. + The class is thrown by the method when the user is not created. The `statusCode` parameter enables you to indicate why the was thrown. The `statusCode` parameter value is exposed by the property. ## Examples - The following code example calls the method to create a new membership user. If the user creation fails, a is thrown with the returned by the method. + The following code example calls the method to create a new membership user. If the user creation fails, a is thrown with the returned by the method. [!code-csharp[System.Web.Security.MembershipCreateUserException#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.MembershipCreateUserException/CS/createuser1cs.aspx#1)] [!code-vb[System.Web.Security.MembershipCreateUserException#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.MembershipCreateUserException/VB/createuser1vb.aspx#1)] @@ -264,14 +264,14 @@ class is thrown by the method when the user is not created. + An instance of the class is thrown by the method when the user is not created. You can use this overload of the constructor to supply information regarding a caught exception that occurred while the user was being created. ## Examples - The following code example calls the method to create a new membership user. If the user creation fails, a is thrown. If the exception is not a , the caught exception is supplied as the of the that is thrown. + The following code example calls the method to create a new membership user. If the user creation fails, a is thrown. If the exception is not a , the caught exception is supplied as the of the that is thrown. [!code-csharp[System.Web.Security.MembershipCreateUserException#4](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.MembershipCreateUserException/CS/createuser4cs.aspx#4)] [!code-vb[System.Web.Security.MembershipCreateUserException#4](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.MembershipCreateUserException/VB/createuser4vb.aspx#4)] diff --git a/xml/System.Web.Security/MembershipProvider.xml b/xml/System.Web.Security/MembershipProvider.xml index b63834af539..199b1655453 100644 --- a/xml/System.Web.Security/MembershipProvider.xml +++ b/xml/System.Web.Security/MembershipProvider.xml @@ -85,7 +85,7 @@ ASP.NET membership is designed to enable you to easily use a number of different abstract class. Initialization values for a implementation are passed to the method implementation. + You are not required to implement a constructor for a class that inherits the abstract class. Initialization values for a implementation are passed to the method implementation. ]]> @@ -121,9 +121,9 @@ ASP.NET membership is designed to enable you to easily use a number of different ## Remarks The property value is stored in the data source with related user information to associate a user with a particular application. This property is read/write and defaults to the property value if not specified explicitly. - Because membership providers store user information uniquely for each application, multiple ASP.NET applications can use the same data source without running into a conflict if duplicate user names are created. Alternatively, multiple ASP.NET applications can use the same user data source by specifying the same . + Because membership providers store user information uniquely for each application, multiple ASP.NET applications can use the same data source without running into a conflict if duplicate user names are created. Alternatively, multiple ASP.NET applications can use the same user data source by specifying the same . - In your membership provider implementation, you will need to ensure that your data schema includes the and that data source queries and updates also include the . + In your membership provider implementation, you will need to ensure that your data schema includes the and that data source queries and updates also include the . @@ -280,9 +280,9 @@ ASP.NET membership is designed to enable you to easily use a number of different method returns a object populated with the information for the newly created user. The method also defines an `out` parameter (in Visual Basic, you can use `ByRef`) that returns a value that indicates that the user was successfully created, or a reason that user creation failed. + Takes, as input, the name of a new user, a password, and an email address and inserts a new user for the application into the data source. The method returns a object populated with the information for the newly created user. The method also defines an `out` parameter (in Visual Basic, you can use `ByRef`) that returns a value that indicates that the user was successfully created, or a reason that user creation failed. - The method raises the event, if a event handler has been specified, and continues or cancels the create-user action based on the results of the event. You can use the virtual method to execute the specified event handler. + The method raises the event, if a event handler has been specified, and continues or cancels the create-user action based on the results of the event. You can use the virtual method to execute the specified event handler. @@ -325,7 +325,7 @@ ASP.NET membership is designed to enable you to easily use a number of different method is a virtual method that is provided for membership provider implementations to use when supporting encrypted password formats. + The method is a virtual method that is provided for membership provider implementations to use when supporting encrypted password formats. @@ -374,7 +374,7 @@ ASP.NET membership is designed to enable you to easily use a number of different , , and personalization is also deleted. + Takes, as input, the name of a user and deletes that user's information from the data source. If `deleteAllRelatedData` is `true`, then all user data stored in the database for the , , and personalization is also deleted. @@ -414,7 +414,7 @@ ASP.NET membership is designed to enable you to easily use a number of different contains a Boolean value specified in the configuration file (Web.config) using the `enablePasswordReset` attribute. The value indicates whether users can use the method to overwrite their current password with a new, randomly generated password. This property is read-only. + contains a Boolean value specified in the configuration file (Web.config) using the `enablePasswordReset` attribute. The value indicates whether users can use the method to overwrite their current password with a new, randomly generated password. This property is read-only. @@ -454,9 +454,9 @@ ASP.NET membership is designed to enable you to easily use a number of different property contains a Boolean value specified in the configuration file (Web.config) using the `enablePasswordRetrieval` attribute. The value indicates whether users can use the method to retrieve their current password from the data source. This property is read-only. + The property contains a Boolean value specified in the configuration file (Web.config) using the `enablePasswordRetrieval` attribute. The value indicates whether users can use the method to retrieve their current password from the data source. This property is read-only. - If your custom membership provider supports hashed passwords, your method implementation should throw an exception if is set to `true` and the password format is set to `Hashed`. Hashed passwords cannot be retrieved. + If your custom membership provider supports hashed passwords, your method implementation should throw an exception if is set to `true` and the password format is set to `Hashed`. Hashed passwords cannot be retrieved. @@ -522,7 +522,7 @@ ASP.NET membership is designed to enable you to easily use a number of different method is a virtual method that is provided for membership provider implementations to use when supporting encrypted password formats. + The method is a virtual method that is provided for membership provider implementations to use when supporting encrypted password formats. @@ -605,9 +605,9 @@ ASP.NET membership is designed to enable you to easily use a number of different returns a list of membership users where the user's email address matches the supplied `emailToMatch` for the configured property. If your data source supports additional search capabilities, such as wildcard characters, you can provide more extensive search capabilities for email addresses. + returns a list of membership users where the user's email address matches the supplied `emailToMatch` for the configured property. If your data source supports additional search capabilities, such as wildcard characters, you can provide more extensive search capabilities for email addresses. - The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the number of objects to return in the collection. The `pageIndex` parameter identifies which page of results to return where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users that matched the `emailToMatch` value. For example, if 13 users were found where `emailToMatch` matched part of or the entire email address, and the `pageIndex` value was 1 with a `pageSize` of 5, then the would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the number of objects to return in the collection. The `pageIndex` parameter identifies which page of results to return where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users that matched the `emailToMatch` value. For example, if 13 users were found where `emailToMatch` matched part of or the entire email address, and the `pageIndex` value was 1 with a `pageSize` of 5, then the would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. @@ -656,9 +656,9 @@ ASP.NET membership is designed to enable you to easily use a number of different returns a list of membership users where the user name matches the supplied `usernameToMatch` for the configured property. If your data source supports additional search capabilities, such as wildcard characters, you can provide more extensive search capabilities for user names. + returns a list of membership users where the user name matches the supplied `usernameToMatch` for the configured property. If your data source supports additional search capabilities, such as wildcard characters, you can provide more extensive search capabilities for user names. - The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the number of objects to return in the collection. The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users that matched the `usernameToMatch` value. For example, if 13 users were found where `usernameToMatch` matched part of or the entire user name, and the `pageIndex` value was 1 with a `pageSize` of 5, then the would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the number of objects to return in the collection. The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users that matched the `usernameToMatch` value. For example, if 13 users were found where `usernameToMatch` matched part of or the entire user name, and the `pageIndex` value was 1 with a `pageSize` of 5, then the would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. @@ -705,9 +705,9 @@ ASP.NET membership is designed to enable you to easily use a number of different returns a list of all of the users from the data source for the configured property. Users are returned in alphabetical order by user name. + returns a list of all of the users from the data source for the configured property. Users are returned in alphabetical order by user name. - The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the number of objects to return in the collection. The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users in the database. For example, if there are 13 users in the database, and the `pageIndex` value was 1 with a `pageSize` of 5, then the would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the number of objects to return in the collection. The `pageIndex` parameter identifies which page of results to return, where 0 identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users in the database. For example, if there are 13 users in the database, and the `pageIndex` value was 1 with a `pageSize` of 5, then the would contain the sixth through the tenth users returned. `totalRecords` would be set to 13. @@ -747,7 +747,7 @@ ASP.NET membership is designed to enable you to easily use a number of different is greater than the current date and time minus the . The is a positive integer value specifying the number of minutes to use when determining whether a user is online. + Returns an integer value that is the count of all the users in the data source where the is greater than the current date and time minus the . The is a positive integer value specifying the number of minutes to use when determining whether a user is online. @@ -794,11 +794,11 @@ ASP.NET membership is designed to enable you to easily use a number of different ## Remarks Takes, as input, a user name and a password answer and retrieves the password for that user from the data source and returns the password as a string. - The method ensures that the flag is set to `true` before performing any action. If is `false`, a exception is thrown. + The method ensures that the flag is set to `true` before performing any action. If is `false`, a exception is thrown. - also checks the value of the property. If is `true`, checks the value of the supplied answer parameter against the stored password answer in the data source. If they do not match, a exception is thrown. + also checks the value of the property. If is `true`, checks the value of the supplied answer parameter against the stored password answer in the data source. If they do not match, a exception is thrown. - If your custom membership provider supports hashed passwords, the method should throw an exception if the property is set to `true` and the password format is set to `Hashed`. Hashed passwords cannot be retrieved. + If your custom membership provider supports hashed passwords, the method should throw an exception if the property is set to `true` and the password format is set to `Hashed`. Hashed passwords cannot be retrieved. @@ -855,7 +855,7 @@ ASP.NET membership is designed to enable you to easily use a number of different value for the user to show that the user is currently online. The method returns a object populated with current values from the data source for the specified user. If the user name is not found in the data source, returns `null`. + Takes, as input, a unique identifier for a user record and a Boolean value indicating whether to update the value for the user to show that the user is currently online. The method returns a object populated with current values from the data source for the specified user. If the user name is not found in the data source, returns `null`. @@ -901,7 +901,7 @@ ASP.NET membership is designed to enable you to easily use a number of different property value for the user to show that the user is currently online. returns a object populated with current values from the data source for the specified user. If the user name is not found in the data source, returns `null`. + Takes, as input, a user name and a Boolean value indicating whether to update the property value for the user to show that the user is currently online. returns a object populated with current values from the data source for the specified user. If the user name is not found in the data source, returns `null`. @@ -987,13 +987,13 @@ ASP.NET membership is designed to enable you to easily use a number of different property works in conjunction with the property to guard against an unwanted source guessing the password or password answer of a membership user through repeated attempts. If the number of invalid passwords or password questions supplied for a membership user is greater than or equal to the property value within the number of minutes identified by the , then the membership user is locked out by setting the property to `true` until the user is unlocked by a call to the method. If a valid password or password answer is supplied before the value is reached, the counter that tracks the number of invalid attempts is reset to zero. + The property works in conjunction with the property to guard against an unwanted source guessing the password or password answer of a membership user through repeated attempts. If the number of invalid passwords or password questions supplied for a membership user is greater than or equal to the property value within the number of minutes identified by the , then the membership user is locked out by setting the property to `true` until the user is unlocked by a call to the method. If a valid password or password answer is supplied before the value is reached, the counter that tracks the number of invalid attempts is reset to zero. - Invalid password and password-answer attempts accumulate independently of one another. For example, if the property is set to 5, and three invalid password attempts are made followed by two invalid password-answer attempts, two more invalid password attempts (or three more invalid password-answer attempts) must be made within the for the membership user to be locked out. + Invalid password and password-answer attempts accumulate independently of one another. For example, if the property is set to 5, and three invalid password attempts are made followed by two invalid password-answer attempts, two more invalid password attempts (or three more invalid password-answer attempts) must be made within the for the membership user to be locked out. If the property is set to `false`, invalid password-answer attempts are not tracked. - Invalid password and password-answer attempts are tracked in the , , , , and methods. + Invalid password and password-answer attempts are tracked in the , , , , and methods. @@ -1036,7 +1036,7 @@ ASP.NET membership is designed to enable you to easily use a number of different The property value is set in the application configuration using the `minRequiredNonalphanumericCharacters` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) configuration element. - A non-alphanumeric character is a character for which the method returns `false`. + A non-alphanumeric character is a character for which the method returns `false`. @@ -1152,7 +1152,7 @@ ASP.NET membership is designed to enable you to easily use a number of different virtual method is used during the , , and methods to raise the event if a has been specified. The `e` parameter is used to pass a object to the event handler. When the event has completed, the properties of the object supplied as the `e` parameter can be examined to determine whether the current action should be canceled and if a particular , stored in the property, should be thrown. + The virtual method is used during the , , and methods to raise the event if a has been specified. The `e` parameter is used to pass a object to the event handler. When the event has completed, the properties of the object supplied as the `e` parameter can be examined to determine whether the current action should be canceled and if a particular , stored in the property, should be thrown. @@ -1191,13 +1191,13 @@ ASP.NET membership is designed to enable you to easily use a number of different property works in conjunction with the property to guard against an unwanted source guessing the password or password answer of a membership user through repeated attempts. If the number of invalid passwords or password questions supplied for a membership user exceeds the within the number of minutes identified by the , then the membership user is locked out by setting the property to `true` until the user is unlocked by a call to the method. If a valid password or password answer is supplied before the is reached, the counter that tracks the number of invalid attempts is reset to zero. + The property works in conjunction with the property to guard against an unwanted source guessing the password or password answer of a membership user through repeated attempts. If the number of invalid passwords or password questions supplied for a membership user exceeds the within the number of minutes identified by the , then the membership user is locked out by setting the property to `true` until the user is unlocked by a call to the method. If a valid password or password answer is supplied before the is reached, the counter that tracks the number of invalid attempts is reset to zero. - Invalid password and password-answer attempts accumulate independently of one another. For example, if the property is set to 5, and three invalid password attempts are made followed by two invalid password-answer attempts, two more invalid password attempts (or three more invalid password-answer attempts) must be made within the value for the membership user to be locked out. + Invalid password and password-answer attempts accumulate independently of one another. For example, if the property is set to 5, and three invalid password attempts are made followed by two invalid password-answer attempts, two more invalid password attempts (or three more invalid password-answer attempts) must be made within the value for the membership user to be locked out. If the property is set to `false`, invalid password-answer attempts are not tracked. - Invalid password and password-answer attempts are tracked in the , , , , and methods. + Invalid password and password-answer attempts are tracked in the , , , , and methods. @@ -1238,7 +1238,7 @@ ASP.NET membership is designed to enable you to easily use a number of different ## Remarks The property indicates the format that passwords are stored in. Use `Hashed` only, `Clear` and `Encrypted` are not secure. `Hashed` passwords are hashed using a one-way hash algorithm and a randomly generated salt value when stored in the database. When a password is validated, it is hashed with the salt value in the database for verification. Hashed passwords cannot be retrieved. `Encrypted` passwords are not considered safe, as a breach that reveals your database contents can also expose the encryption key. This means your encrypted passwords could be decrypted and exposed. - You can use the and virtual methods of the class to encrypt and decrypt password values, or you can supply your own encryption code. If you use the and virtual methods of the class, `Encrypted` passwords are encrypted using the key information supplied in the [machineKey Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/w8h3skw9(v=vs.100)) element in your configuration. + You can use the and virtual methods of the class to encrypt and decrypt password values, or you can supply your own encryption code. If you use the and virtual methods of the class, `Encrypted` passwords are encrypted using the key information supplied in the [machineKey Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/w8h3skw9(v=vs.100)) element in your configuration. @@ -1341,7 +1341,7 @@ ASP.NET membership is designed to enable you to easily use a number of different property indicates whether users must supply a password answer in order to retrieve their password using the method, or reset their password using the method. + A Boolean value specified in the configuration file (Web.config). The property indicates whether users must supply a password answer in order to retrieve their password using the method, or reset their password using the method. This property is read-only. @@ -1383,7 +1383,7 @@ ASP.NET membership is designed to enable you to easily use a number of different property indicates whether users must supply a unique email address value when creating a user. If a user already exists in the data source for the current , then the method returns `null` and a status value of . + The property indicates whether users must supply a unique email address value when creating a user. If a user already exists in the data source for the current , then the method returns `null` and a status value of . @@ -1431,13 +1431,13 @@ ASP.NET membership is designed to enable you to easily use a number of different Takes, as input, a user name and a password answer and generates a new, random password for the specified user. > [!NOTE] -> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the and properties +> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the and properties - The method updates the user information in the data source with the new password value and returns the new password as a string. A convenient mechanism for generating a random password is the method. + The method updates the user information in the data source with the new password value and returns the new password as a string. A convenient mechanism for generating a random password is the method. - ensures that the flag is set to `true` before performing any action. If is `false`, a exception is thrown. + ensures that the flag is set to `true` before performing any action. If is `false`, a exception is thrown. - also checks the value of the property. If is `true`, checks the value of the supplied answer parameter against the stored password answer in the data source. If they do not match, a exception is thrown. + also checks the value of the property. If is `true`, checks the value of the supplied answer parameter against the stored password answer in the data source. If they do not match, a exception is thrown. @@ -1481,7 +1481,7 @@ ASP.NET membership is designed to enable you to easily use a number of different property to `false`. The method returns `true` if the record for the membership user is updated successfully; otherwise, `false`. + Takes, as input, a user name, and updates the field in the data source that stores the property to `false`. The method returns `true` if the record for the membership user is updated successfully; otherwise, `false`. @@ -1569,9 +1569,9 @@ ASP.NET membership is designed to enable you to easily use a number of different returns `true` for a successful user name and password match; otherwise, `false`. + Takes, as input, a user name and a password and verifies that the values match those in the data source. returns `true` for a successful user name and password match; otherwise, `false`. - For successful validations, updates the for the specified user. + For successful validations, updates the for the specified user. @@ -1609,11 +1609,11 @@ ASP.NET membership is designed to enable you to easily use a number of different event is raised during the , , and methods. + The event is raised during the , , and methods. The event occurs before the action requested and enables the user to continue or cancel the requested action. If the action is canceled, the user can specify an exception to be thrown. - Users use a event handler to specify a handler for the event. Provider implementers can use the virtual method to raise the event. + Users use a event handler to specify a handler for the event. Provider implementers can use the virtual method to raise the event. diff --git a/xml/System.Web.Security/MembershipProviderCollection.xml b/xml/System.Web.Security/MembershipProviderCollection.xml index 5e7ca3ff0d4..03909949670 100644 --- a/xml/System.Web.Security/MembershipProviderCollection.xml +++ b/xml/System.Web.Security/MembershipProviderCollection.xml @@ -156,12 +156,12 @@ to copy role provider objects to the specified array. + This method uses to copy role provider objects to the specified array. ## Examples - The following code example uses the method to copy the contents of a to an array of objects. + The following code example uses the method to copy the contents of a to an array of objects. [!code-csharp[System.Web.Security.MembershipProviderCollection#3](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.MembershipProviderCollection/CS/snippetscs.aspx#3)] [!code-vb[System.Web.Security.MembershipProviderCollection#3](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.MembershipProviderCollection/VB/snippetsvb.aspx#3)] diff --git a/xml/System.Web.Security/MembershipUser.xml b/xml/System.Web.Security/MembershipUser.xml index f17bcfbe341..bdfe60ffcf2 100644 --- a/xml/System.Web.Security/MembershipUser.xml +++ b/xml/System.Web.Security/MembershipUser.xml @@ -41,9 +41,9 @@ > [!NOTE] > If you are not familiar with the membership features of ASP.NET, see [Introduction to Membership](https://learn.microsoft.com/previous-versions/aspnet/yh26yfzy(v=vs.100)) before continuing. For a list of other topics related to membership, see [Managing Users by Using Membership](https://learn.microsoft.com/previous-versions/aspnet/tw292whz(v=vs.100)). - A object is returned by the and methods or as part of a returned by the , , and methods. + A object is returned by the and methods or as part of a returned by the , , and methods. - A object is required by the method when you want to update the information for an existing membership user. + A object is required by the method when you want to update the information for an existing membership user. @@ -157,11 +157,11 @@ object does not add a new membership user object to the membership data store. To add a new membership user to the membership data store, use the method. Note that the method returns a object for the membership user added to the data store. + Creating a new object does not add a new membership user object to the membership data store. To add a new membership user to the membership data store, use the method. Note that the method returns a object for the membership user added to the data store. - objects can be constructed in application code for use with the method. Alternatively, you can also pass a object returned from the , , , , or method to the method as well. + objects can be constructed in application code for use with the method. Alternatively, you can also pass a object returned from the , , , , or method to the method as well. - objects are also commonly constructed by membership-provider implementations for the , , , , and methods. + objects are also commonly constructed by membership-provider implementations for the , , , , and methods. The `name`, `email`, and `passwordQuestion` parameters are all trimmed before being used. @@ -210,7 +210,7 @@ calls the method of the membership provider referenced by the property to update the password for the membership user in the membership data store. + calls the method of the membership provider referenced by the property to update the password for the membership user in the membership data store. The membership provider may have restrictions on the size of the password. For size limitations, see the documentation for the membership provider. @@ -279,7 +279,7 @@ calls the method of the membership provider referenced by the property to update the password question and answer for the membership user in the membership data store. + calls the method of the membership provider referenced by the property to update the password question and answer for the membership user in the membership data store. The membership provider may have restrictions on the size of the password question and answer. For size limitations, see the documentation for the membership provider. @@ -383,7 +383,7 @@ sets the , , , and date to the same date and time when a membership user is created by the method. + The sets the , , , and date to the same date and time when a membership user is created by the method. @@ -481,19 +481,19 @@ calls the method of the membership provider referenced by the property to retrieve the password for the membership from the membership data store. + calls the method of the membership provider referenced by the property to retrieve the password for the membership from the membership data store. - If is `false`, the membership provider will return an exception. If the provider supports passwords with a of , you will be unable to retrieve the password for the membership user and should consider making use of the method when a user has forgotten their password. + If is `false`, the membership provider will return an exception. If the provider supports passwords with a of , you will be unable to retrieve the password for the membership user and should consider making use of the method when a user has forgotten their password. > [!NOTE] > A will be thrown if `enablePasswordRetrieval` is set to `true` and `passwordFormat` is set to `Hashed` in the Web.config file for the ASP.NET application. - If is `true`, you must use the overload that takes a password answer as a parameter and supply the password answer for the membership user. If a password answer is required and an incorrect password answer is supplied, a is thrown by the membership provider. + If is `true`, you must use the overload that takes a password answer as a parameter and supply the password answer for the membership user. If a password answer is required and an incorrect password answer is supplied, a is thrown by the membership provider. ## Examples - The following code example calls the method to retrieve the password for a specified user name. The password is sent to the user's email address. Note that is assumed to be `false`. + The following code example calls the method to retrieve the password for a specified user name. The password is sent to the user's email address. Note that is assumed to be `false`. > [!NOTE] > Returning a password in clear text using email is not recommended for sites that require a high level of security. For high-security sites, it is recommended that you return passwords using encryption, such as SSL. @@ -540,19 +540,19 @@ calls the method of the membership provider referenced by the property to retrieve the password for the membership user from the membership data store. If a password answer is required and an incorrect password answer is supplied, a is thrown by the membership provider. + calls the method of the membership provider referenced by the property to retrieve the password for the membership user from the membership data store. If a password answer is required and an incorrect password answer is supplied, a is thrown by the membership provider. - If is `false`, the membership provider will return an exception. If the provider supports passwords with a of , you will be unable to retrieve the password for the membership user and should consider making use of the method when a user has forgotten their password. + If is `false`, the membership provider will return an exception. If the provider supports passwords with a of , you will be unable to retrieve the password for the membership user and should consider making use of the method when a user has forgotten their password. > [!NOTE] > A will be thrown if `enablePasswordRetrieval` is set to `true` and `passwordFormat` is set to `Hashed` in the Web.config file for the ASP.NET application. - If is `false`, you can supply `null` for the `answer` parameter, or use the overload that does not take any parameters. + If is `false`, you can supply `null` for the `answer` parameter, or use the overload that does not take any parameters. ## Examples - The following code example calls the method to retrieve the password for a specified user name if the correct password answer is supplied. The password is sent to the user's email address. + The following code example calls the method to retrieve the password for a specified user name if the correct password answer is supplied. The password is sent to the user's email address. > [!NOTE] > Returning a password in clear text using email is not recommended for sites that require a high level of security. For high-security sites, it is recommended that you return passwords using encryption, such as SSL. @@ -606,7 +606,7 @@ value for a membership user is checked during the call to by the . If the property is set to `false`, the method returns `false` even if the supplied user name and password are correct. + The value for a membership user is checked during the call to by the . If the property is set to `false`, the method returns `false` even if the supplied user name and password are correct. ]]> @@ -647,11 +647,11 @@ method when the is reached within the . + Users are most commonly locked out and cannot be validated by the method when the is reached within the . - Users can also be locked out if you use the or overload that accepts a password answer and the number of bad answers entered by the user reaches the within the . + Users can also be locked out if you use the or overload that accepts a password answer and the number of bad answers entered by the user reaches the within the . - To set this property to `false` and let the user try to log in again, you can use the method. + To set this property to `false` and let the user try to log in again, you can use the method. ]]> @@ -689,12 +689,12 @@ property value is earlier than the for the user. + A user is considered online if the current date and time minus the property value is earlier than the for the user. - The for a user is updated to the current date and time by the , and methods, and can be updated by some of the overloads of the method. + The for a user is updated to the current date and time by the , and methods, and can be updated by some of the overloads of the method. > [!NOTE] -> The property value for a user is updated by the classes in the and the namespaces whenever user data is retrieved from or set at the data source. If your application uses the same data source to store user information, and your and are configured with the same `applicationName` as your , then the and properties of the user will reflect this behavior. +> The property value for a user is updated by the classes in the and the namespaces whenever user data is retrieved from or set at the data source. If your application uses the same data source to store user information, and your and are configured with the same `applicationName` as your , then the and properties of the user will reflect this behavior. @@ -736,14 +736,14 @@ for a user is updated to the current date and time by the and methods, and can be updated by some overloads of the method. You can use the method to set the property to a specific date and time. + The for a user is updated to the current date and time by the and methods, and can be updated by some overloads of the method. You can use the method to set the property to a specific date and time. - The is used to determine whether a user is online. A user is considered online if the current date and time minus the property value is earlier than the for the user. + The is used to determine whether a user is online. A user is considered online if the current date and time minus the property value is earlier than the for the user. - The sets the , , , and date to the same date and time when a membership user is created by the method. + The sets the , , , and date to the same date and time when a membership user is created by the method. > [!NOTE] -> The for a user is updated by the classes in the and the namespaces whenever user data is retrieved from or set at the data source. If your application uses the same data source to store user information, and your and are configured with the same `applicationName` as your , then the and properties of the user will reflect this behavior. +> The for a user is updated by the classes in the and the namespaces whenever user data is retrieved from or set at the data source. If your application uses the same data source to store user information, and your and are configured with the same `applicationName` as your , then the and properties of the user will reflect this behavior. @@ -784,9 +784,9 @@ is reached within the . + Users are most commonly locked out when the is reached within the . - Users can also be locked out if you use the or overload that accepts a password answer and the number of bad answers entered by the user reaches the within the . + Users can also be locked out if you use the or overload that accepts a password answer and the number of bad answers entered by the user reaches the within the . The default value for the property is determined by the membership provider. For example, when a membership user is created using the provider, the property for the user is initially set to 01/01/1754. @@ -821,11 +821,11 @@ is equal to the if the user has not yet logged on. The is updated to the current date and time if a call to the method is successful. + For new users, the is equal to the if the user has not yet logged on. The is updated to the current date and time if a call to the method is successful. - You can also modify the last login date by setting the property of a and passing the modified object to the method. + You can also modify the last login date by setting the property of a and passing the modified object to the method. - The sets the , , , and date to the same date and time when a membership user is created by the method. + The sets the , , , and date to the same date and time when a membership user is created by the method. @@ -866,12 +866,12 @@ sets the , , , and date to the same date and time when a membership user is created by the method. + The sets the , , , and date to the same date and time when a membership user is created by the method. ## Examples - The following code example shows a login page that indicates a password has expired after a specified number of days. If the is earlier than the current date and time minus the number of days specified for the expiration of a password, then the user is directed to change their password. + The following code example shows a login page that indicates a password has expired after a specified number of days. If the is earlier than the current date and time minus the number of days specified for the expiration of a password, then the user is directed to change their password. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -916,10 +916,10 @@ is `true`, then the password answer for a membership user must be supplied to the and methods. The serves as a reminder to the membership user of what their password answer is. Once the membership user has supplied a password answer, the answer value can be supplied to the or method. + If is `true`, then the password answer for a membership user must be supplied to the and methods. The serves as a reminder to the membership user of what their password answer is. Once the membership user has supplied a password answer, the answer value can be supplied to the or method. ## Examples - The following code example resets a user's password if they supply the appropriate password answer. The for the user is displayed as a reminder to the user of the password answer. + The following code example resets a user's password if they supply the appropriate password answer. The for the user is displayed as a reminder to the user of the password answer. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -964,7 +964,7 @@ property exposes the name of the membership provider that manages the information for the . You can access the specific membership provider instance for a membership user by using the property of the class, whether or not the provider is the default provider for the application. For example, you may create a method that takes a object as input and updates the based on your business logic. You can ensure that the appropriate membership provider is used to update the by calling the method of the membership provider from the collection that is indexed by the property value. + The property exposes the name of the membership provider that manages the information for the . You can access the specific membership provider instance for a membership user by using the property of the class, whether or not the provider is the default provider for the application. For example, you may create a method that takes a object as input and updates the based on your business logic. You can ensure that the appropriate membership provider is used to update the by calling the method of the membership provider from the collection that is indexed by the property value. ]]> @@ -1003,7 +1003,7 @@ property exposes the identifier from the membership data source typed as `object`. The type of the identifier depends on the or the . In the case of the , the can be cast as a , since the stores the user identifier as a . + The property exposes the identifier from the membership data source typed as `object`. The type of the identifier depends on the or the . In the case of the , the can be cast as a , since the stores the user identifier as a . ]]> @@ -1053,16 +1053,16 @@ calls the method of the membership provider referenced by the property to reset the password for the membership user to a new, automatically generated password. The new password is then returned to the caller. + calls the method of the membership provider referenced by the property to reset the password for the membership user to a new, automatically generated password. The new password is then returned to the caller. - If is `false`, the membership provider will return an exception. + If is `false`, the membership provider will return an exception. - If is `true`, you must use the overload that takes a password answer as a parameter and supply the password answer for the membership user. If a password answer is required and an incorrect password answer is supplied, a is thrown by the membership provider. + If is `true`, you must use the overload that takes a password answer as a parameter and supply the password answer for the membership user. If a password answer is required and an incorrect password answer is supplied, a is thrown by the membership provider. ## Examples - The following code example resets a user's password and returns the new, automatically generated password. Note that is assumed to be `false`. + The following code example resets a user's password and returns the new, automatically generated password. Note that is assumed to be `false`. > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -1106,11 +1106,11 @@ calls the method of the membership provider referenced by the property to reset the password for the membership user to a new, automatically generated password. The new password is then returned to the caller. + calls the method of the membership provider referenced by the property to reset the password for the membership user to a new, automatically generated password. The new password is then returned to the caller. - If is `false`, the membership provider will return an exception. + If is `false`, the membership provider will return an exception. - If is `false`, you can supply `null` for the `answer` parameter, or use the overload that does not take any parameters. + If is `false`, you can supply `null` for the `answer` parameter, or use the overload that does not take any parameters. If a password answer is required and an incorrect password answer is supplied, a is thrown by the membership provider. @@ -1192,9 +1192,9 @@ method when the is reached within the . + Users are most commonly locked out and cannot be validated by the method when the is reached within the . - Users can also be locked out if you use the or overload that accepts a password answer and the number of bad answers entered by the user reaches the value of within the . + Users can also be locked out if you use the or overload that accepts a password answer and the number of bad answers entered by the user reaches the value of within the . Your implementation of this method should set the property to `false`, set the property to the current date, and reset any counters that you use to track the number of failed log in attempts and so forth. @@ -1236,13 +1236,13 @@ is used in conjunction with the membership user's password to authenticate the membership user. + A membership user's is used in conjunction with the membership user's password to authenticate the membership user. - The of a identifies a unique user for each application that uses for authentication. An application is identified by the membership . The same user name can be used in multiple applications for different users. Alternatively, a single user name can be used to identify a user for multiple applications, provided the applications are configured with the same . + The of a identifies a unique user for each application that uses for authentication. An application is identified by the membership . The same user name can be used in multiple applications for different users. Alternatively, a single user name can be used to identify a user for multiple applications, provided the applications are configured with the same . - You can retrieve a object for a membership user by passing the user name to one of the overloads of the method, or as a member of a returned from the , , or method. + You can retrieve a object for a membership user by passing the user name to one of the overloads of the method, or as a member of a returned from the , , or method. - You can retrieve the user name for a membership user if the email address for the user is known, by using the method. + You can retrieve the user name for a membership user if the email address for the user is known, by using the method. diff --git a/xml/System.Web.Security/MembershipUserCollection.xml b/xml/System.Web.Security/MembershipUserCollection.xml index 315e9fe6115..d8052812773 100644 --- a/xml/System.Web.Security/MembershipUserCollection.xml +++ b/xml/System.Web.Security/MembershipUserCollection.xml @@ -44,7 +44,7 @@ is returned from the , , and methods of the class. The objects returned by the , , and methods contain a snapshot of user information in the membership data store. That is, changes to the membership user information in a are not reflected in the membership data store. To modify membership user information in the membership data store, use the , and methods of the class. + A is returned from the , , and methods of the class. The objects returned by the , , and methods contain a snapshot of user information in the membership data store. That is, changes to the membership user information in a are not reflected in the membership data store. To modify membership user information in the membership data store, use the , and methods of the class. > [!NOTE] > If you are not familiar with the membership features of ASP.NET, see [Introduction to Membership](https://learn.microsoft.com/previous-versions/aspnet/yh26yfzy(v=vs.100)) before continuing. For a list of other topics related to membership, see [Managing Users by Using Membership](https://learn.microsoft.com/previous-versions/aspnet/tw292whz(v=vs.100)). @@ -84,7 +84,7 @@ is constructed by membership provider implementers and returned from the and methods of the abstract class. + A is constructed by membership provider implementers and returned from the and methods of the abstract class. ]]> @@ -120,7 +120,7 @@ method is commonly used by membership provider implementations of the , , and methods of the abstract class. + The method is commonly used by membership provider implementations of the , , and methods of the abstract class. ]]> @@ -156,7 +156,7 @@ before replacing it with the results of the method. + The following code example clears a before replacing it with the results of the method. [!code-csharp[System.Web.Security.MembershipUserCollection#4](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.MembershipUserCollection/CS/snippetscs.aspx#4)] [!code-vb[System.Web.Security.MembershipUserCollection#4](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.MembershipUserCollection/VB/snippetsvb.aspx#4)] @@ -271,7 +271,7 @@ ## Examples - The following code example uses the returned from the method to iterate through a . + The following code example uses the returned from the method to iterate through a . [!code-csharp[System.Web.Security.MembershipUserCollection#7](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.MembershipUserCollection/CS/snippetscs.aspx#7)] [!code-vb[System.Web.Security.MembershipUserCollection#7](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.MembershipUserCollection/VB/snippetsvb.aspx#7)] @@ -347,7 +347,7 @@ object returned by property contains a snapshot of user information in the membership data store. That is, changes to the membership user information in the are not reflected in the membership data store. To modify membership user information in the membership data store, use the , , and methods. + The object returned by property contains a snapshot of user information in the membership data store. That is, changes to the membership user information in the are not reflected in the membership data store. To modify membership user information in the membership data store, use the , , and methods. @@ -418,7 +418,7 @@ are considered read-only, as they are a snapshot of the membership user information in the membership data store. Membership user information is modified using the , and methods. The method marks the as read-only so that objects cannot be added to or removed from the collection. Property values for the objects are not marked as read-only. That is, you can modify the property values of a in the regardless of whether the collection has been marked as read-only by the method. + The contents of a are considered read-only, as they are a snapshot of the membership user information in the membership data store. Membership user information is modified using the , and methods. The method marks the as read-only so that objects cannot be added to or removed from the collection. Property values for the objects are not marked as read-only. That is, you can modify the property values of a in the regardless of whether the collection has been marked as read-only by the method. diff --git a/xml/System.Web.Security/MembershipValidatePasswordEventHandler.xml b/xml/System.Web.Security/MembershipValidatePasswordEventHandler.xml index 5c8d31cf92d..543475bb66b 100644 --- a/xml/System.Web.Security/MembershipValidatePasswordEventHandler.xml +++ b/xml/System.Web.Security/MembershipValidatePasswordEventHandler.xml @@ -40,11 +40,11 @@ delegate is defined for the event for a membership provider. The event is raised when the method, the method, or the method of a membership provider is called. + The delegate is defined for the event for a membership provider. The event is raised when the method, the method, or the method of a membership provider is called. You can use the event to validate password formats and values for membership users. - You can cancel the current , , or action by setting the property of the supplied to `true` during the event. + You can cancel the current , , or action by setting the property of the supplied to `true` during the event. If you cancel the current action by setting the property to `true`, you can set the property of the supplied to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the property is set to. If the property is `null`, the caller will throw a generic password-validation failure exception. diff --git a/xml/System.Web.Security/RoleManagerModule.xml b/xml/System.Web.Security/RoleManagerModule.xml index 04a694640a6..be3e9c88abd 100644 --- a/xml/System.Web.Security/RoleManagerModule.xml +++ b/xml/System.Web.Security/RoleManagerModule.xml @@ -24,7 +24,7 @@ class is used to assign a to the property of the . + The class is used to assign a to the property of the . When a request completes, the refreshes the roles cookie that contains cached role information. If the property is of type , and that indicates that its cached role list has been modified by setting the property to `true`, the will update the roles cookie that contains cached role information. @@ -60,7 +60,7 @@ class is used to place a in the property of the and is not intended to be used directly from your code. + The class is used to place a in the property of the and is not intended to be used directly from your code. ]]> @@ -93,7 +93,7 @@ when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the memory it occupied can be reclaimed by garbage collection. + Call when you are finished using the . The method leaves the in an unusable state. After calling , you must release all references to the so the memory it occupied can be reclaimed by garbage collection. This method is not intended to be used directly from your code. @@ -124,11 +124,11 @@ event is raised before the creates a object and assigns it to the property of the . You can use this event to audit when role information is applied or to replace the creation of a by the with your own code. + The event is raised before the creates a object and assigns it to the property of the . You can use this event to audit when role information is applied or to replace the creation of a by the with your own code. You can cancel the application of role information by the by setting the property of the to `true` in the event. - If you set to `true` in your event handler, then the property of the current is not set to a object by the . + If you set to `true` in your event handler, then the property of the current is not set to a object by the . diff --git a/xml/System.Web.Security/RolePrincipal.xml b/xml/System.Web.Security/RolePrincipal.xml index 677bb000b98..5c4cbc03fb1 100644 --- a/xml/System.Web.Security/RolePrincipal.xml +++ b/xml/System.Web.Security/RolePrincipal.xml @@ -41,11 +41,11 @@ ## Remarks The object implements the interface and represents the current security context for the HTTP request. - When role management is enabled (see ), the assigns a object to the property of the . + When role management is enabled (see ), the assigns a object to the property of the . - The class exposes the security identity for the current HTTP request and additionally performs checks for role membership. If is `true`, then the object manages the cached list of roles and looks up role membership for the current user in the cached list first, then the role . If is `false`, the object always looks up role membership using the role provider. + The class exposes the security identity for the current HTTP request and additionally performs checks for role membership. If is `true`, then the object manages the cached list of roles and looks up role membership for the current user in the cached list first, then the role . If is `false`, the object always looks up role membership using the role provider. - The object encrypts and decrypts role information cached in the cookie identified by the based on the . + The object encrypts and decrypts role information cached in the cookie identified by the based on the . ]]> @@ -85,14 +85,14 @@ constructor creates a new object and initializes its property values. Cached role information is not read from the cookie identified by the property. The property is set to the of the default role provider. + This overload of the constructor creates a new object and initializes its property values. Cached role information is not read from the cookie identified by the property. The property is set to the of the default role provider. For information on enabling role management, see the class. ## Examples - The following code example creates a new object. If is `true`, the example creates the with cookie information from the cookie identified by the property. + The following code example creates a new object. If is `true`, the example creates the with cookie information from the cookie identified by the property. [!code-csharp[System.Web.Security.RolePrincipal#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.RolePrincipal/CS/snippetscs.aspx#2)] [!code-vb[System.Web.Security.RolePrincipal#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.RolePrincipal/VB/snippetsvb.aspx#2)] @@ -155,14 +155,14 @@ [!INCLUDE [untrusted-data-instance-note](~/includes/untrusted-data-instance-note.md)] - This overload of the constructor creates a new object and initializes its property values. Role information for the current user is read from the supplied `encryptedTicket` and cached with the object. The property is set to the of the default role provider. + This overload of the constructor creates a new object and initializes its property values. Role information for the current user is read from the supplied `encryptedTicket` and cached with the object. The property is set to the of the default role provider. For information on enabling role management, see the class. ## Examples - The following code example creates a new object. If is `true`, the example creates the with cookie information from the cookie identified by the property. + The following code example creates a new object. If is `true`, the example creates the with cookie information from the cookie identified by the property. [!code-csharp[System.Web.Security.RolePrincipal#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.RolePrincipal/CS/snippetscs.aspx#2)] [!code-vb[System.Web.Security.RolePrincipal#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.RolePrincipal/VB/snippetsvb.aspx#2)] @@ -203,7 +203,7 @@ constructor creates a new object and initializes its property values. The property is set to the value specified in the `providerName` parameter. + This overload of the constructor creates a new object and initializes its property values. The property is set to the value specified in the `providerName` parameter. For information on enabling role management, see the class. @@ -250,7 +250,7 @@ [!INCLUDE [untrusted-data-instance-note](~/includes/untrusted-data-instance-note.md)] - This overload of the constructor creates a new object and initializes its property values. Role information for the current user is read from the supplied `encryptedTicket` and cached with the object. The property is set to the value specified in the `providerName` parameter. + This overload of the constructor creates a new object and initializes its property values. Role information for the current user is read from the supplied `encryptedTicket` and cached with the object. The property is set to the value specified in the `providerName` parameter. For information on enabling role management, see the class. @@ -301,9 +301,9 @@ property will return `true` after role names have been retrieved from the default role and added to the cache by the method, or when the method calls the method of the default role provider and then receives a response of `true`, resulting in the role name passed to the method being added to the cache. + The property will return `true` after role names have been retrieved from the default role and added to the cache by the method, or when the method calls the method of the default role provider and then receives a response of `true`, resulting in the role name passed to the method being added to the cache. - The property will also return true if is set to `true` and the has passed, resulting in a new being set. + The property will also return true if is set to `true` and the has passed, resulting in a new being set. @@ -341,7 +341,7 @@ property returns the value of the `cookiePath` attribute from the Web.config file for your ASP.NET application. For more information on cookie paths, see . + The property returns the value of the `cookiePath` attribute from the Web.config file for your ASP.NET application. For more information on cookie paths, see . @@ -380,7 +380,7 @@ property returns a `Boolean` value indicating whether the roles cookie has expired based on the and the current date and time. + The property returns a `Boolean` value indicating whether the roles cookie has expired based on the and the current date and time. @@ -460,7 +460,7 @@ method. + For more information, see the method. ]]> @@ -490,7 +490,7 @@ is `true` and role names have been cached for the user represented by the , then the method will return the list of role names in the cache that the user is a member of. If role names have not been cached, then the method returns the list of role names that the user is a member of from the default role . Only role names for the current are returned. To determine whether role names have been cached in the object, check the property. + If is `true` and role names have been cached for the user represented by the , then the method will return the list of role names in the cache that the user is a member of. If role names have not been cached, then the method returns the list of role names that the user is a member of from the default role . Only role names for the current are returned. To determine whether role names have been cached in the object, check the property. @@ -541,7 +541,7 @@ of a object is set when the constructor is called. + The of a object is set when the constructor is called. @@ -592,9 +592,9 @@ first checks the property to determine whether a cached list of role names for the current user is available. If the property is `true`, the cached list is checked for the specified role. If the method finds the specified role in the cached list, it returns `true`. + first checks the property to determine whether a cached list of role names for the current user is available. If the property is `true`, the cached list is checked for the specified role. If the method finds the specified role in the cached list, it returns `true`. - If does not find the specified role, it calls the method of the default instance to determine whether the user name is associated with a role from the data source for the configured value. + If does not find the specified role, it calls the method of the default instance to determine whether the user name is associated with a role from the data source for the configured value. @@ -640,7 +640,7 @@ property indicates whether role names have been written to the cookie. Note that, even though the `cacheRolesInCookie` configuration attribute may be `true`, the property does not return `true` until after role information has been written to the cookie. If no role checks are performed for a user, will return `false`. + If the `cacheRolesInCookie` attribute in the Web.config file for the application is set to `true`, then a list of role names for the current user is written to a cookie when user membership in a particular role is checked. The property indicates whether role names have been written to the cookie. Note that, even though the `cacheRolesInCookie` configuration attribute may be `true`, the property does not return `true` until after role information has been written to the cookie. If no role checks are performed for a user, will return `false`. @@ -717,7 +717,7 @@ property exposes the name of the role provider that manages the role information for the user represented by the object. This enables you to access the specific role-provider instance for a user by using the property of the class regardless of whether the provider is the default provider for the application. For example, you may create a method that takes a as input and returns the list of roles for the represented user. You can ensure that the appropriate role provider is used to return the list of roles for the by calling the method of the role provider from the collection that is indexed by the property value. + The property exposes the name of the role provider that manages the role information for the user represented by the object. This enables you to access the specific role-provider instance for a user by using the property of the class regardless of whether the provider is the default provider for the application. For example, you may create a method that takes a as input and returns the list of roles for the represented user. You can ensure that the appropriate role provider is used to return the list of roles for the by calling the method of the role provider from the collection that is indexed by the property value. To populate the object for each request, you must use a event handler defined in the Global.asax file for the application. @@ -749,7 +749,7 @@ method marks the cached role list as having been changed by setting to `true` and to `false`. + The method marks the cached role list as having been changed by setting to `true` and to `false`. ]]> @@ -823,12 +823,12 @@ method is stored in the roles cookie when is `true`. + The value returned by the method is stored in the roles cookie when is `true`. ## Examples - The following code example writes the results of the method to the roles cookie. + The following code example writes the results of the method to the roles cookie. [!code-csharp[System.Web.Security.RolePrincipal#6](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.RolePrincipal/CS/snippetscs.aspx#6)] [!code-vb[System.Web.Security.RolePrincipal#6](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.RolePrincipal/VB/snippetsvb.aspx#6)] diff --git a/xml/System.Web.Security/RoleProvider.xml b/xml/System.Web.Security/RoleProvider.xml index f207d2f019a..e0ec9da0b2b 100644 --- a/xml/System.Web.Security/RoleProvider.xml +++ b/xml/System.Web.Security/RoleProvider.xml @@ -75,7 +75,7 @@ abstract class. Initialization values for a implementation are passed to the method implementation. + You are not required to implement a constructor for a class that inherits the abstract class. Initialization values for a implementation are passed to the method implementation. ]]> @@ -113,7 +113,7 @@ is called by the class to associate the specified users with the specified roles at the data source. Roles are added to the configured . + is called by the class to associate the specified users with the specified roles at the data source. Roles are added to the configured . If any of the specified role names are not found for the configured `applicationName`, we recommend that your provider throw a . @@ -128,7 +128,7 @@ ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet2"::: @@ -164,7 +164,7 @@ is used by the class to associate users and roles with different applications. This enables multiple applications to use the same database to store user and role information without running into conflicts between duplicate user names or role names. Multiple ASP.NET applications can use the same database by specifying the same value in the property. The property can be set programmatically, or it can be set declaratively in the configuration file for the Web application using the `applicationName` attribute. + The is used by the class to associate users and roles with different applications. This enables multiple applications to use the same database to store user and role information without running into conflicts between duplicate user names or role names. Multiple ASP.NET applications can use the same database by specifying the same value in the property. The property can be set programmatically, or it can be set declaratively in the configuration file for the Web application using the `applicationName` attribute. If no property is specified, we recommend that the property value be used. @@ -210,7 +210,7 @@ is called by the method of the class to add the specified role to the data source for the configured . + is called by the method of the class to add the specified role to the data source for the configured . If the specified role name already exists for the configured `applicationName`, is `null`, or is an empty string, we recommend that your provider throw an exception. @@ -221,7 +221,7 @@ ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet3"::: @@ -264,7 +264,7 @@ is called by the and the methods of the class to delete the specified role from the data source for the configured . + is called by the and the methods of the class to delete the specified role from the data source for the configured . When you delete a role from the data source, ensure that you also delete any associations between a user name and the deleted role for the configured `applicationName`. @@ -275,7 +275,7 @@ ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet4"::: @@ -317,14 +317,14 @@ method is called by the class and returns a list of users in a role where the user name contains a match of the supplied `usernameToMatch` for the configured `applicationName`. Wildcard support is included based on the data source. Users are returned in alphabetical order by user name. + The method is called by the class and returns a list of users in a role where the user name contains a match of the supplied `usernameToMatch` for the configured `applicationName`. Wildcard support is included based on the data source. Users are returned in alphabetical order by user name. We recommend that you throw a if `roleName` does not exist in the data source. ## Examples - The following code example shows a sample implementation. + The following code example shows a sample implementation. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet11"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet11"::: @@ -361,14 +361,14 @@ is called by the method of the class to retrieve a list of role names from the data source. Only the roles for the specified are retrieved. + is called by the method of the class to retrieve a list of role names from the data source. Only the roles for the specified are retrieved. If no roles exist for the configured `applicationName`, we recommend that your provider return a string array with no elements. ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet5"::: @@ -408,7 +408,7 @@ is called by the method of the class to retrieve the role names that the specified user is associated with from the data source. Only the roles for the configured are retrieved. + is called by the method of the class to retrieve the role names that the specified user is associated with from the data source. Only the roles for the configured are retrieved. If no roles exist for the specified user for the configured `applicationName`, we recommend that your provider return a string array with no elements. @@ -417,7 +417,7 @@ ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet6"::: @@ -457,7 +457,7 @@ is called by the method of the class to retrieve the user names associated with a role from the data source. Only the roles for the configured are retrieved. + is called by the method of the class to retrieve the user names associated with a role from the data source. Only the roles for the configured are retrieved. If the specified role name does not exist for the configured `applicationName` or if it is `null` or an empty string, we recommend that your provider throw an exception. @@ -466,7 +466,7 @@ ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet7"::: @@ -509,7 +509,7 @@ method is called by the method of the class to determine whether the current logged-on user is associated with a role from the data source for the configured . + The method is called by the method of the class to determine whether the current logged-on user is associated with a role from the data source for the configured . If the specified user name is `null` or is an empty string, we recommend that your provider throw an exception. @@ -518,7 +518,7 @@ ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet8"::: @@ -559,7 +559,7 @@ is called by , , , and methods of the class to remove the specified users from the specified roles at the data source. Only roles for the configured are modified. + is called by , , , and methods of the class to remove the specified users from the specified roles at the data source. Only roles for the configured are modified. If any of the specified role names are not found for the configured `applicationName`, we recommend that your provider throw a . @@ -574,7 +574,7 @@ ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet9"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet9"::: @@ -615,14 +615,14 @@ is called by the method of the class to determine whether a role name exists in the data source for the configured . + is called by the method of the class to determine whether a role name exists in the data source for the configured . If the specified role name is `null` or is an empty string, we recommend that your provider throw an exception. ## Examples - The following code example shows a sample implementation of the method. + The following code example shows a sample implementation of the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/CS/odbcroleprovidersnippets.cs" id="Snippet10"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.IRoleProvider/VB/odbcroleprovidersnippets.vb" id="Snippet10"::: diff --git a/xml/System.Web.Security/RoleProviderCollection.xml b/xml/System.Web.Security/RoleProviderCollection.xml index 82b36d07615..abbf4b396fe 100644 --- a/xml/System.Web.Security/RoleProviderCollection.xml +++ b/xml/System.Web.Security/RoleProviderCollection.xml @@ -132,12 +132,12 @@ to copy role provider objects to the specified array. + This method uses to copy role provider objects to the specified array. ## Examples - The following code example uses the method to copy the contents of a to an array of objects. + The following code example uses the method to copy the contents of a to an array of objects. [!code-csharp[System.Web.Security.RoleProviderCollection#3](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.RoleProviderCollection/CS/snippetscs.aspx#3)] [!code-vb[System.Web.Security.RoleProviderCollection#3](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.RoleProviderCollection/VB/snippetsvb.aspx#3)] diff --git a/xml/System.Web.Security/Roles.xml b/xml/System.Web.Security/Roles.xml index 40d9ac97a7c..a2c2001ab7c 100644 --- a/xml/System.Web.Security/Roles.xml +++ b/xml/System.Web.Security/Roles.xml @@ -71,7 +71,7 @@ If you use the `authorization` section in your application's Web.config file to specify authorization based on roles, users of your application must supply an authenticated user identity. You can authenticate users by using either Windows or Forms authentication. Anonymous users cannot be assigned to a role. Roles can be used independently of, or in conjunction with, the ASP.NET classes. - To verify role membership programmatically, you can use the class or the property with the method, or you can use the property with the method. For sample code that programmatically checks role membership, see the Example section in this topic. + To verify role membership programmatically, you can use the class or the property with the method, or you can use the property with the method. For sample code that programmatically checks role membership, see the Example section in this topic. The class also enables you to create and delete roles and to add users to or remove users from roles. @@ -88,7 +88,7 @@ If a user's browser accepts cookies, you can store role information for that user in a cookie on the user's computer. On each page request, ASP.NET reads the role information for that user from the cookie. This can improve application performance by reducing the amount of communication required with the data source to retrieve role information. If the role information for a user is too long to store in a cookie, ASP.NET stores just the most recently used role information in the cookie and then looks up additional role information in the data source as required. If the user's browser does not support cookies or cookies are disabled, role information is not cached in a cookie. - You can improve the reliability of the role names cached in a cookie by specifying a property when you configure ASP.NET roles. The default is `All`, which encrypts role names in the cookie and validates that the cookie contents have not been altered. + You can improve the reliability of the role names cached in a cookie by specifying a property when you configure ASP.NET roles. The default is `All`, which encrypts role names in the cookie and validates that the cookie contents have not been altered. @@ -177,9 +177,9 @@ method calls the default role provider to associate the specified users with the specified role at the data source. + The method calls the default role provider to associate the specified users with the specified role at the data source. - If your application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed. + If your application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed. > [!NOTE] > User names and role names cannot contain commas. @@ -242,9 +242,9 @@ method calls the default role provider to associate the specified users with the specified roles at the data source. + The method calls the default role provider to associate the specified users with the specified roles at the data source. - If your application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed. + If your application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed. > [!NOTE] > User names and role names cannot contain commas. @@ -309,7 +309,7 @@ method calls the default role provider to associate the specified user with the specified role at the data source. + The method calls the default role provider to associate the specified user with the specified role at the data source. > [!NOTE] > User names and role names cannot contain commas. @@ -372,9 +372,9 @@ method calls the default role provider to associate the specified user with the specified roles at the data source. + The method calls the default role provider to associate the specified user with the specified roles at the data source. - If your application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed. + If your application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed. > [!NOTE] > User names and role names cannot contain commas. @@ -493,7 +493,7 @@ ## Remarks When the property is set to `true` in the Web.config file, role information for each user is stored in a cookie. When role management checks to see whether a user is in a particular role, the roles cookie is checked before the role provider is called to check the list of roles at the data source. The cookie is dynamically updated to cache the most recently validated role names. - You can improve the reliability of the role names cached in a cookie by specifying a property when you configure ASP.NET roles. The default is `All`, which encrypts role names in the cookie and validates that the cookie contents have not been altered. + You can improve the reliability of the role names cached in a cookie by specifying a property when you configure ASP.NET roles. The default is `All`, which encrypts role names in the cookie and validates that the cookie contents have not been altered. > [!NOTE] > Because role names can be cached apart from the data source, it is possible that changes to role management at the data source would not be reflected in the cached values. In this case, the user must close and re-open their browser to clear the cached cookie value. @@ -606,7 +606,7 @@ . + You can specify the path of the cookie where roles are cached for your application by setting the `cookiePath` attribute in the Web.config file for your ASP.NET application. For more information on cookie paths, see . @@ -717,7 +717,7 @@ . + You can specify whether SSL (Secure Sockets Layer) is required to return the role names cookie to the server in your application by setting the `cookieRequireSSL` attribute in the Web.config file for your ASP.NET application. For more information, see . @@ -773,7 +773,7 @@ in minutes. While the user continues to actively use the ASP.NET application, the expiration date and time of the cookie will be automatically refreshed if there is less than half of the remaining. For more information, see the property. + You can specify whether role names cookie expiration date and time will be reset with each response by using the `cookieSlidingExpiration` attribute in the Web.config file for your ASP.NET application. If `true`, the cookie expiration will initially be set to the current date and time plus the in minutes. While the user continues to actively use the ASP.NET application, the expiration date and time of the cookie will be automatically refreshed if there is less than half of the remaining. For more information, see the property. @@ -828,9 +828,9 @@ property is used when the property is `true` and specifies the time-to-live in minutes for the roles cookie. To set the value, add the `cookieTimeout` attribute to the [roleManager](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ms164660(v%3dvs.100)) element in the Web.config file for the ASP.NET application and specify an integer value. + The property is used when the property is `true` and specifies the time-to-live in minutes for the roles cookie. To set the value, add the `cookieTimeout` attribute to the [roleManager](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ms164660(v%3dvs.100)) element in the Web.config file for the ASP.NET application and specify an integer value. - If is `false`, this property is ignored. + If is `false`, this property is ignored. @@ -888,7 +888,7 @@ ## Remarks The property value is set in the configuration for an ASP.NET application using the `createPersistentCookie` attribute of the [roleManager](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ms164660(v%3dvs.100)) configuration element. - When `false`, the role-names cookie is a session cookie, that is, the cookie is lost when the browser is closed. When `true`, the role-names cookie is a persistent cookie that is available across multiple browser sessions. The persistent cookie expiration date and time are set to the current date and time plus the value in minutes. + When `false`, the role-names cookie is a session cookie, that is, the cookie is lost when the browser is closed. When `true`, the role-names cookie is a persistent cookie that is available across multiple browser sessions. The persistent cookie expiration date and time are set to the current date and time plus the value in minutes. ]]> @@ -921,7 +921,7 @@ method adds a role name to the data source. calls the method of the default role provider to add the specified role to the data source. + The method adds a role name to the data source. calls the method of the default role provider to add the specified role to the data source. > [!NOTE] > Role names cannot contain commas. @@ -974,12 +974,12 @@ method clears the contents of the cookie that is used to cache role names. For more information on caching role names, see . + The method clears the contents of the cookie that is used to cache role names. For more information on caching role names, see . ## Examples - The following code example calls the method to clear any cached role names when a user logs in. For an example of a Web.config file that enables role management, see . + The following code example calls the method to clear any cached role names when a user logs in. For an example of a Web.config file that enables role management, see . > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -1037,7 +1037,7 @@ method removes a role name from the data source. calls the method of the default role provider to remove the specified role from the data source. + The method removes a role name from the data source. calls the method of the default role provider to remove the specified role from the data source. If the role identified by the `roleName` parameter has one or more members, then an exception will be thrown and the role will not be deleted. @@ -1094,7 +1094,7 @@ method removes a role name from the data source. calls the method of the default role provider to remove the specified role from the data source. + The method removes a role name from the data source. calls the method of the default role provider to remove the specified role from the data source. If `throwOnPopulatedRole` is `true`, then an exception will be thrown and the role will not be deleted if the role identified by the `roleName` parameter has one or more members. If `throwOnPopulatedRole` is `false`, then the role will be deleted whether it is empty or not. @@ -1237,14 +1237,14 @@ returns a list of users in a role where the user name contains a match of the supplied `usernameToMatch` for the configured `applicationName`. For example, if the `usernameToMatch` parameter is set to "user," then the users "user1," "user2," "user3," and so on are returned. Users are returned in alphabetical order by user name. + returns a list of users in a role where the user name contains a match of the supplied `usernameToMatch` for the configured `applicationName`. For example, if the `usernameToMatch` parameter is set to "user," then the users "user1," "user2," "user3," and so on are returned. Users are returned in alphabetical order by user name. The performs its search using a LIKE clause against the `usernameToMatch` parameter. Any wildcards that are supported by SQL Server in LIKE clauses can be used in the `usernameToMatch` parameter value. ## Examples - The following code example uses the method to display role membership based on user input. For an example of a Web.config file that enables role management, see . + The following code example uses the method to display role membership based on user input. For an example of a Web.config file that enables role management, see . > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -1293,12 +1293,12 @@ method calls the method of the default role provider to get a list of all the roles from the data source for an application. Only the roles for the application that is specified in the property are retrieved. + The method calls the method of the default role provider to get a list of all the roles from the data source for an application. Only the roles for the application that is specified in the property are retrieved. ## Examples - The following code example uses the method to get the list of roles for an application and bind the results to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to get the list of roles for an application and bind the results to a control. For an example of a Web.config file that enables role management, see . > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -1346,14 +1346,14 @@ method calls the method of the default role provider to retrieve from the data source the roles that the currently logged-on user is in. The currently logged-on user is identified by the property of the current , or by for non-HTTP hosting environments. If no user is logged on, an exception will be thrown. Only the roles for the application that is specified in the property are retrieved. + The method calls the method of the default role provider to retrieve from the data source the roles that the currently logged-on user is in. The currently logged-on user is identified by the property of the current , or by for non-HTTP hosting environments. If no user is logged on, an exception will be thrown. Only the roles for the application that is specified in the property are retrieved. - If is `true`, then the results of the method may be returned from the role cache rather than the specified role provider. + If is `true`, then the results of the method may be returned from the role cache rather than the specified role provider. ## Examples - The following code example uses the method to retrieve a list of roles for a specified user and bind the returned roles to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to retrieve a list of roles for a specified user and bind the returned roles to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.Roles/CS/ViewRolescs.aspx" id="Snippet4"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.Roles/VB/ViewRolesvb.aspx" id="Snippet4"::: @@ -1392,14 +1392,14 @@ method calls the method of the default role provider to retrieve from the data source the roles that the user is in. Only the roles for the application that is specified in the property are retrieved. + The method calls the method of the default role provider to retrieve from the data source the roles that the user is in. Only the roles for the application that is specified in the property are retrieved. - If `username` is equal to the current logged-on user and is `true`, the results of the method may be returned from the role cache rather than the specified . + If `username` is equal to the current logged-on user and is `true`, the results of the method may be returned from the role cache rather than the specified . ## Examples - The following code example uses the method to retrieve a list of roles for a specified user and bind the returned roles to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to retrieve a list of roles for a specified user and bind the returned roles to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.Roles/CS/ViewRolescs.aspx" id="Snippet4"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.Roles/VB/ViewRolesvb.aspx" id="Snippet4"::: @@ -1441,12 +1441,12 @@ method calls the method of the default role provider to retrieve the user names associated with a role from the data source. Only the roles for the application that is specified in the property are retrieved. + The method calls the method of the default role provider to retrieve the user names associated with a role from the data source. Only the roles for the application that is specified in the property are retrieved. ## Examples - The following code example uses the method to get a list of the users in a particular role and binds the results to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to get a list of the users in a particular role and binds the results to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/CS/adduserstorolecs.aspx" id="Snippet3"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/VB/adduserstorolevb.aspx" id="Snippet3"::: @@ -1499,9 +1499,9 @@ method calls the method of the default role provider to determine whether the currently logged-on user is associated with a role from the data source for the application that is specified in the property. The currently logged-on user is identified by the property of the current , or by for non-HTTP hosting environments. If no user is logged on, an exception will be thrown. Only the roles for the application that is specified in the property are retrieved. + The method calls the method of the default role provider to determine whether the currently logged-on user is associated with a role from the data source for the application that is specified in the property. The currently logged-on user is identified by the property of the current , or by for non-HTTP hosting environments. If no user is logged on, an exception will be thrown. Only the roles for the application that is specified in the property are retrieved. - If is `true`, then `roleName` may be checked against the roles cache rather than the specified role provider. + If is `true`, then `roleName` may be checked against the roles cache rather than the specified role provider. @@ -1555,9 +1555,9 @@ method calls the method of the default role provider to determine whether a user name is associated with a role from the data source for the application that is specified in the property. + The method calls the method of the default role provider to determine whether a user name is associated with a role from the data source for the application that is specified in the property. - If `username` is equal to the current logged-on user and the property value is `true`, `roleName` may be checked against the role cache rather than the specified . + If `username` is equal to the current logged-on user and the property value is `true`, `roleName` may be checked against the role cache rather than the specified . @@ -1658,9 +1658,9 @@ ## Remarks The property enables you to directly reference the default role provider for an application. This is commonly used to access custom members of the role provider that are not part of the abstract class. - For example, the class includes an overload of the method that enables you to determine whether a user is in a common Windows role by using a enumeration value. A reference to the class for an application can be obtained by using the property and can be cast as a in order to refer to the overload. + For example, the class includes an overload of the method that enables you to determine whether a user is in a common Windows role by using a enumeration value. A reference to the class for an application can be obtained by using the property and can be cast as a in order to refer to the overload. - If multiple role providers are configured for an application, you can access different role providers using the collection. + If multiple role providers are configured for an application, you can access different role providers using the collection. @@ -1734,7 +1734,7 @@ ``` - You can obtain a strongly typed reference to a provider from the collection by indexing the role provider by name and casting it as the desired type. + You can obtain a strongly typed reference to a provider from the collection by indexing the role provider by name and casting it as the desired type. You can obtain a reference to the default provider for an application using the property. @@ -1780,7 +1780,7 @@ method calls the default role provider to remove the specified user from the specified role at the data source. + The method calls the default role provider to remove the specified user from the specified role at the data source. @@ -1834,14 +1834,14 @@ method calls the default role provider to remove the specified user from the specified roles at the data source. + The method calls the default role provider to remove the specified user from the specified roles at the data source. - If the application is configured to use the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed. + If the application is configured to use the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed. ## Examples - The following code example uses the method to remove a user from one or more roles. For an example of a Web.config file that enables role management, see . + The following code example uses the method to remove a user from one or more roles. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.Roles/CS/RemoveUserFromRolescs.aspx" id="Snippet10"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.Roles/VB/RemoveUserFromRolesvb.aspx" id="Snippet10"::: @@ -1894,14 +1894,14 @@ method calls the default role provider to remove the specified users from the specified role at the data source. + The method calls the default role provider to remove the specified users from the specified role at the data source. - If the application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed. + If the application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed. ## Examples - The following code example uses the method to remove one or more users from a role. For an example of a Web.config file that enables role management, see . + The following code example uses the method to remove one or more users from a role. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.Roles/CS/RemoveUsersFromRolecs.aspx" id="Snippet9"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.Roles/VB/RemoveUsersFromRolevb.aspx" id="Snippet9"::: @@ -1956,14 +1956,14 @@ method calls the default role provider to remove the specified users from the specified roles at the data source. + The method calls the default role provider to remove the specified users from the specified roles at the data source. - If the application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed. + If the application uses the class, the database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is not in a specified role, the transaction is rolled back and no updates are performed. ## Examples - The following code example uses the method to remove one or more users from one or more roles based on user input. For an example of a Web.config file that enables role management, see . + The following code example uses the method to remove one or more users from one or more roles based on user input. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.Roles/CS/RemoveUsersFromRolescs.aspx" id="Snippet8"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.Roles/VB/RemoveUsersFromRolesvb.aspx" id="Snippet8"::: @@ -2020,12 +2020,12 @@ method calls the `RoleExists` method of the default role provider to determine whether a role name exists in the data source for the application that is specified in the property. + The method calls the `RoleExists` method of the default role provider to determine whether a role name exists in the data source for the application that is specified in the property. ## Examples - The following code example uses the method to determine whether a role name already exists before creating the role. For an example of a Web.config file that enables role management, see . + The following code example uses the method to determine whether a role name already exists before creating the role. For an example of a Web.config file that enables role management, see . > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). diff --git a/xml/System.Web.Security/SqlMembershipProvider.xml b/xml/System.Web.Security/SqlMembershipProvider.xml index da688a80f8f..a5414e1f057 100644 --- a/xml/System.Web.Security/SqlMembershipProvider.xml +++ b/xml/System.Web.Security/SqlMembershipProvider.xml @@ -101,7 +101,7 @@ This class is used by the and constructor is called by ASP.NET to create an instance of the class as specified in the configuration for the application. This constructor is not intended to be used from your code. + The constructor is called by ASP.NET to create an instance of the class as specified in the configuration for the application. This constructor is not intended to be used from your code. ]]> @@ -137,7 +137,7 @@ This class is used by the and is used by the to group user information. By qualifying user information with an application name, you can store information for multiple applications in a single database without running into conflicts between duplicate user names. Also, multiple ASP.NET applications can use the same user database by specifying the same value in the property. The property can be set programmatically, or it can be set declaratively in the configuration file for the Web application with the `applicationName` attribute. + The is used by the to group user information. By qualifying user information with an application name, you can store information for multiple applications in a single database without running into conflicts between duplicate user names. Also, multiple ASP.NET applications can use the same user database by specifying the same value in the property. The property can be set programmatically, or it can be set declaratively in the configuration file for the Web application with the `applicationName` attribute. If a value is not specified for the `applicationName` attribute in the configuration file for the Web application, then the property value for the first request made to the application is used. @@ -147,7 +147,7 @@ This class is used by the and instance and sets the to `MyApplication`. + The following code example shows the [membership](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v%3dvs.100)) 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 to `MyApplication`. ``` @@ -207,11 +207,11 @@ This class is used by the and method, the internal counter that tracks invalid password attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by a call to the method. If the correct password is supplied and the user is not currently locked out, then the internal counters that track invalid password and password-answer attempts are reset to zero. For more information, see the and properties. + If an incorrect password is supplied to the method, the internal counter that tracks invalid password attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by a call to the method. If the correct password is supplied and the user is not currently locked out, then the internal counters that track invalid password and password-answer attempts are reset to zero. For more information, see the and properties. - You can call the method directly by first obtaining a reference to the instance through the property of the class. The property exposes the `defaultProvider` specified in the Web.config file for the application. Configured providers that are not the default provider referenced using the property. + You can call the method directly by first obtaining a reference to the instance through the property of the class. The property exposes the `defaultProvider` specified in the Web.config file for the application. Configured providers that are not the default provider referenced using the property. - You can also change user passwords by using the method. + You can also change user passwords by using the method. Leading and trailing spaces are trimmed from all parameter values. @@ -311,13 +311,13 @@ This class is used by the and class to update the password question and answer for a user in the SQL Server database that is specified in the ASP.NET application's configuration file (Web.config). The password answer is encrypted using the format that is specified in the property. - Requiring a password question and answer provides an additional layer of security when retrieving or resetting a user's password. When creating a user name, a user can supply a question and answer that can later be used to retrieve or reset a forgotten password. The method updates the password question and answer for a membership user. + Requiring a password question and answer provides an additional layer of security when retrieving or resetting a user's password. When creating a user name, a user can supply a question and answer that can later be used to retrieve or reset a forgotten password. The method updates the password question and answer for a membership user. - If an incorrect password is supplied to the method, the internal counters that track invalid password attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by calling the method. If the correct password is supplied and the user is not currently locked out, then the internal counters that track invalid password and password-answer attempts are reset to zero. For more information, see the and properties. + If an incorrect password is supplied to the method, the internal counters that track invalid password attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by calling the method. If the correct password is supplied and the user is not currently locked out, then the internal counters that track invalid password and password-answer attempts are reset to zero. For more information, see the and properties. The maximum length for the password question is 256 characters. The maximum length for the password answer is 128 characters. - For more information, see , , and . + For more information, see , , and . Leading and trailing spaces are trimmed from all parameter values. @@ -413,9 +413,9 @@ This class is used by the and class to create a new user in the SQL Server database specified in the ASP.NET application's configuration file. - New users are identified with the configured . + New users are identified with the configured . - If the property is set to `true`, and `null` or an empty string ("") is specified for the `email` parameter, the user creation will fail. The user creation will also fail if the property is set to `true` and the value specified for the `email` parameter is a duplicate of the email address for an existing user in the database for the configured . + If the property is set to `true`, and `null` or an empty string ("") is specified for the `email` parameter, the user creation will fail. The user creation will also fail if the property is set to `true` and the value specified for the `email` parameter is a duplicate of the email address for an existing user in the database for the configured . The maximum length for the user name is 256 characters. The maximum length for the email address is 256 characters. The maximum length for the password in clear text or after it has been hashed or encrypted is 128 characters. @@ -500,11 +500,11 @@ This class is used by the and class to remove a user from the SQL Server database specified in the ASP.NET application's configuration file. - Deleted users are only deleted from the configured . + Deleted users are only deleted from the configured . - If `deleteAllRelatedData` is set to `true`, then all user data stored in the database for the , , or personalization features is also deleted for the configured . + If `deleteAllRelatedData` is set to `true`, then all user data stored in the database for the , , or personalization features is also deleted for the configured . - If the membership user does not exist in the database, and `deleteAllRelatedData` is `true`, then the related data and the user information stored for the , , or personalization features will still be deleted for the application specified in the property. As a result, the method can be used for quickly deleting information related to a user, even when the object is not used for storing authenticated user information. + If the membership user does not exist in the database, and `deleteAllRelatedData` is `true`, then the related data and the user information stored for the , , or personalization features will still be deleted for the application specified in the property. As a result, the method can be used for quickly deleting information related to a user, even when the object is not used for storing authenticated user information. Leading and trailing spaces are trimmed from the `username` parameter value. @@ -617,7 +617,7 @@ This class is used by the and property is set to , a user will not be able to retrieve their existing password from the database. The password format provides one-way encoding of password values. Passwords are hashed with a randomly generated salt value and compared to values stored in the database for authentication. Hashed values cannot be unencoded to retrieve the original password value. - If the property is set to , and is set to `true`, a is thrown when the provider is initialized. + If the property is set to , and is set to `true`, a is thrown when the provider is initialized. @@ -677,18 +677,18 @@ This class is used by the and returns a list of membership users in which the email address contains a match with the supplied `emailToMatch` for the configured . + returns a list of membership users in which the email address contains a match with the supplied `emailToMatch` for the configured . The searches for a user name that matches the `emailToMatch` parameter value, using the LIKE clause. SQL Server wildcard characters can be included in the parameter value. For example, if the `emailToMatch` parameter is set to "address@example.com", then information for users with the email address "address@example.com" is returned, if it exists. If the `emailToMatch` parameter is set to "%@example.com", then information for users with the email address "address@example.com", "address2@example.com", "admin@example.com", and so on is returned. - The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where zero identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users for the configured `applicationName`. For example, if there are 13 users for the configured `applicationName`, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through tenth users returned. The `totalRecords` parameter would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where zero identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users for the configured `applicationName`. For example, if there are 13 users for the configured `applicationName`, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through tenth users returned. The `totalRecords` parameter would be set to 13. Leading and trailing spaces are trimmed from the `emailToMatch` parameter value. ## Examples - The following code example uses the method to retrieve membership user information and displays the results in pages of data. + The following code example uses the method to retrieve membership user information and displays the results in pages of data. > [!NOTE] > This example uses the class to call the specified as the `defaultProvider` in the Web.config file. If you need to access the default provider as the type , you can cast the property of the class. To access other configured providers as a specific provider type, you can access them by their configured name with the property of the class and cast them as the specific provider type. @@ -748,18 +748,18 @@ This class is used by the and returns a list of membership users for which the user name contains a match with the supplied `usernameToMatch` for the configured . + returns a list of membership users for which the user name contains a match with the supplied `usernameToMatch` for the configured . The searches for a user name that matches the `usernameToMatch` parameter value, using the LIKE clause. SQL Server wildcard characters can be included with the parameter value. For example, if the `usernameToMatch` parameter is set to "user1", then user information for the user with the user name of "user1" is returned, if it exists. If the `usernameToMatch` parameter is set to "user%", then user information for users with the user name of "user1", "user2", "user_admin", and so on are returned. - The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where zero identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users for the configured `applicationName`. For example, if there are 13 users for the configured `applicationName`, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. The `totalRecords` parameter would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where zero identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users for the configured `applicationName`. For example, if there are 13 users for the configured `applicationName`, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. The `totalRecords` parameter would be set to 13. Leading and trailing spaces are trimmed from the `usernameToMatch` parameter value. ## Examples - The following code example uses the method to retrieve membership user information and displays the results in pages of data. + The following code example uses the method to retrieve membership user information and displays the results in pages of data. > [!NOTE] > This example uses System.Web.Security.SqlMembershipProvider to call the specified as the `defaultProvider` in the Web.config file. If you need to access the default provider as the type , you can cast the property of the class. To access other configured providers as a specific provider type, you can access them by their configured name with the property of the class and cast them as the specific provider type. @@ -812,14 +812,14 @@ This class is used by the and class provides a method, which generates a password of a specified size with at least the specified number of non-alphabetic characters. The method of the calls the method of the class to retrieve a random password that is at least 14 characters long. If the property is greater than 14, the password returned will be the length specified in the property. + The class provides a method, which generates a password of a specified size with at least the specified number of non-alphabetic characters. The method of the calls the method of the class to retrieve a random password that is at least 14 characters long. If the property is greater than 14, the password returned will be the length specified in the property. - You can specifically call the method by referencing the class directly from the property of the class. + You can specifically call the method by referencing the class directly from the property of the class. The generated password only contains alphanumeric characters and the following punctuation marks: `!@#$%^&*()_-+=[{]};:<>|./?`. No hidden or non-printable control characters are included in the generated password. > [!NOTE] -> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the and properties. +> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the and properties. @@ -867,7 +867,7 @@ This class is used by the and class to retrieve user information from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). - The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where zero identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users for the configured `applicationName`. For example, if there are 13 users for the configured `applicationName`, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. The `totalRecords` parameter would be set to 13. + The results returned by are constrained by the `pageIndex` and `pageSize` parameters. The `pageSize` parameter identifies the maximum number of objects to return in the . The `pageIndex` parameter identifies which page of results to return, where zero identifies the first page. The `totalRecords` parameter is an `out` parameter that is set to the total number of membership users for the configured `applicationName`. For example, if there are 13 users for the configured `applicationName`, and the `pageIndex` value was 1 with a `pageSize` of 5, the returned would contain the sixth through the tenth users returned. The `totalRecords` parameter would be set to 13. @@ -921,9 +921,9 @@ This class is used by the and class to retrieve the number of users considered online from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). - returns the number of users of the current application whose last activity date and time is greater than the current date and time less the value of the property in minutes. + returns the number of users of the current application whose last activity date and time is greater than the current date and time less the value of the property in minutes. - Only users associated with the configured are included in the count. + Only users associated with the configured are included in the count. @@ -972,11 +972,11 @@ This class is used by the and class to retrieve the password for a user from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). - If an incorrect password answer is supplied to the method, the internal counter that tracks invalid password-answer attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by a call to the method. If the correct password answer is supplied and the user is not currently locked out, then the internal counter that tracks invalid password-answer attempts is reset to zero. For more information, see the and properties. + If an incorrect password answer is supplied to the method, the internal counter that tracks invalid password-answer attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by a call to the method. If the correct password answer is supplied and the user is not currently locked out, then the internal counter that tracks invalid password-answer attempts is reset to zero. For more information, see the and properties. - You can call the method directly by first obtaining a reference to the instance through the property of the class. + You can call the method directly by first obtaining a reference to the instance through the property of the class. - If the property is set to , the method cannot retrieve the password. Hashed passwords are encrypted one-way and cannot be decrypted. If the property is set to , and is set to `true`, a is thrown when the provider is initialized. + If the property is set to , the method cannot retrieve the password. Hashed passwords are encrypted one-way and cannot be decrypted. If the property is set to , and is set to `true`, a is thrown when the provider is initialized. Leading and trailing spaces are trimmed from all parameter values. @@ -1076,7 +1076,7 @@ This class is used by the and retrieves the user information from the data source and creates a object populated with the returned data. The user is identified using the unique identifier specified with the `providerUserKey` parameter. + retrieves the user information from the data source and creates a object populated with the returned data. The user is identified using the unique identifier specified with the `providerUserKey` parameter. ]]> @@ -1119,14 +1119,14 @@ This class is used by the and class to retrieve user information from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). - If `userIsOnline` is `true`, the last activity date/time stamp for the user is updated to the current date and time. This is reflected in the and properties and in the value returned by . + If `userIsOnline` is `true`, the last activity date/time stamp for the user is updated to the current date and time. This is reflected in the and properties and in the value returned by . Leading and trailing spaces are trimmed from the `username` parameter value. ## Examples - The following code example uses the method to determine whether a user exists before retrieving the password for the user. + The following code example uses the method to determine whether a user exists before retrieving the password for the user. > [!NOTE] > This example uses the class to call the specified as the `defaultProvider` in the Web.config file. If you need to access the default provider as the type , you can cast the property of the class. To access other configured providers as a specific provider type, you can access them by their configured name with the property of the class and cast them as the specific provider type. @@ -1316,7 +1316,7 @@ This class is used by the and works in conjunction with the to guard against an unwanted source guessing the password or password answer of a membership user through repeated attempts. If the number of invalid passwords or password questions supplied for a membership user is greater than or equal to the value of the property within the number of minutes identified by the value of the property, then the membership user is locked out by setting the property to `true` until the user is unlocked with the method. If a valid password is supplied before the value is reached, the counters that track the number of invalid password and password-answer attempts are reset to zero. If a valid password answer is supplied before the value is reached, only the counter that tracks the number of invalid password-answer attempts is reset to zero. + The works in conjunction with the to guard against an unwanted source guessing the password or password answer of a membership user through repeated attempts. If the number of invalid passwords or password questions supplied for a membership user is greater than or equal to the value of the property within the number of minutes identified by the value of the property, then the membership user is locked out by setting the property to `true` until the user is unlocked with the method. If a valid password is supplied before the value is reached, the counters that track the number of invalid password and password-answer attempts are reset to zero. If a valid password answer is supplied before the value is reached, only the counter that tracks the number of invalid password-answer attempts is reset to zero. The keeps counts of invalid password attempts and invalid password-answer attempts separately. Invalid password attempts result in only the password-attempt counter being incremented. Invalid password-answer attempts result in only the password-answer counter being incremented. @@ -1382,7 +1382,7 @@ This class is used by the and property value is set in the application configuration using the `minRequiredNonalphanumericCharacters` attribute of the [membership Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/1b9hw62f(v=vs.100)) configuration element. - A non-alphanumeric character is a character for which the method returns `false`. + A non-alphanumeric character is a character for which the method returns `false`. @@ -1496,7 +1496,7 @@ This class is used by the and property works in conjunction with the property to help guard against an unwanted source guessing the password or the password answer of a membership user through repeated attempts. When users are attempting to log in, change their password, or reset their password, only a certain number of consecutive attempts are allowed within a specified time window. The length of the time window is specified by the property, which identifies the number of minutes allowed between invalid attempts. If the number of consecutive failed attempts that a user makes to reset their password equals the value stored in the property, and the time elapsed since the last invalid attempt is less than the number of minutes specified for the property, then the membership user is locked out by setting the property to `true`. The user can be unlocked by calling the method. If the interval between the current failed attempt and the last failed attempt is greater than the property setting, the current invalid attempt is counted as the first. If a valid password answer is supplied before the maximum number of allowed invalid attempts is reached, the count of invalid password-answer attempts is set to zero. If a valid password is supplied before the maximum number of allowed invalid attempts is reached, the count of invalid password attempts and the count of invalid password-answer attempts are set to zero. + The property works in conjunction with the property to help guard against an unwanted source guessing the password or the password answer of a membership user through repeated attempts. When users are attempting to log in, change their password, or reset their password, only a certain number of consecutive attempts are allowed within a specified time window. The length of the time window is specified by the property, which identifies the number of minutes allowed between invalid attempts. If the number of consecutive failed attempts that a user makes to reset their password equals the value stored in the property, and the time elapsed since the last invalid attempt is less than the number of minutes specified for the property, then the membership user is locked out by setting the property to `true`. The user can be unlocked by calling the method. If the interval between the current failed attempt and the last failed attempt is greater than the property setting, the current invalid attempt is counted as the first. If a valid password answer is supplied before the maximum number of allowed invalid attempts is reached, the count of invalid password-answer attempts is set to zero. If a valid password is supplied before the maximum number of allowed invalid attempts is reached, the count of invalid password attempts and the count of invalid password-answer attempts are set to zero. The keeps count of invalid password attempts and invalid password-answer attempts separately. Invalid password attempts result in only the password-attempt counter being incremented. Invalid password-answer attempts result in only the password-answer counter being incremented. @@ -1560,7 +1560,7 @@ This class is used by the and value is specified in the [providers](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/6d4936ht(v%3dvs.100)) section of the Web.config file for the ASP.NET application. + The value is specified in the [providers](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/6d4936ht(v%3dvs.100)) section of the Web.config file for the ASP.NET application. `Encrypted` and `Hashed` passwords are encrypted or hashed by default based on information supplied in the [machineKey](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/w8h3skw9(v%3dvs.100)) element in your configuration. Note that if you specify a value of `3DES` for the `validation` attribute, or if no value is specified, hashed passwords will be hashed using the algorithm. @@ -1689,7 +1689,7 @@ This class is used by the and property and the property are both `false`, the value of the property is irrelevant. - For more information, see and . + For more information, see and . @@ -1801,13 +1801,13 @@ This class is used by the and class to reset the password for a user in the SQL Server database specified in the ASP.NET application's configuration file (Web.config) to a new, randomly generated value. The new password is returned. > [!NOTE] -> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the and properties. +> The random password created by the method is not guaranteed to pass the regular expression in the property. However, the random password will meet the criteria established by the and properties. - The method is most commonly used when the property is set to `Hashed`. If a user forgets a password that is hashed, the password cannot be retrieved. However, the provider can reset the password to a new, automatically generated password if the user supplies the correct password answer. + The method is most commonly used when the property is set to `Hashed`. If a user forgets a password that is hashed, the password cannot be retrieved. However, the provider can reset the password to a new, automatically generated password if the user supplies the correct password answer. - If an incorrect password answer is supplied to the method, the internal counter that tracks invalid password attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by a call to the method. If the correct password answer is supplied and the user is not currently locked out, then the internal counter that tracks invalid password-answer attempts is reset to zero. For more information, see the and properties. + If an incorrect password answer is supplied to the method, the internal counter that tracks invalid password attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by a call to the method. If the correct password answer is supplied and the user is not currently locked out, then the internal counter that tracks invalid password-answer attempts is reset to zero. For more information, see the and properties. - You can call the method directly by first obtaining a reference to the instance from the property of the class. The generated password will be at least 14 characters long, or the length specified in the property, and will contain the number of non-alphanumeric characters specified in the property. The password is not guaranteed to pass the regular expression contained in the property, if one is specified. + You can call the method directly by first obtaining a reference to the instance from the property of the class. The generated password will be at least 14 characters long, or the length specified in the property, and will contain the number of non-alphanumeric characters specified in the property. The password is not guaranteed to pass the regular expression contained in the property, if one is specified. Leading and trailing spaces are trimmed from all parameter values. @@ -1890,7 +1890,7 @@ This class is used by the and method when the is exceeded within the . + Users are most commonly locked out and cannot be validated by the method when the is exceeded within the . Leading and trailing spaces are trimmed from the `username` parameter value. @@ -1929,11 +1929,11 @@ This class is used by the and class to update user information for a user in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). The , , , , and property values are updated for the specified membership user. + This method is called by the class to update user information for a user in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). The , , , , and property values are updated for the specified membership user. The maximum length for the property is 256 characters. The maximum length for the property is 256 characters. - The password for a membership user cannot be updated using the method. To update the password for a membership user, use the method of the class. + The password for a membership user cannot be updated using the method. To update the password for a membership user, use the method of the class. @@ -2013,14 +2013,14 @@ This class is used by the and method, the internal counter that tracks invalid password attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by a call to the method. If the correct password is supplied and the user is not currently locked out, then the internal counters that track invalid password and password-answer attempts are reset to zero. For more information, see the and properties. + If an incorrect password is supplied to the method, the internal counter that tracks invalid password attempts is incremented by one. This can result in the user being locked out and unable to log on until the lock status is cleared by a call to the method. If the correct password is supplied and the user is not currently locked out, then the internal counters that track invalid password and password-answer attempts are reset to zero. For more information, see the and properties. Leading and trailing spaces are trimmed from all parameter values. ## Examples - The following code example shows the sign-in page for an ASP.NET application configured to use forms authentication and the . If the supplied user credentials are invalid, a message is displayed to the user. Otherwise, the user is redirected to the originally requested URL using the method. + The following code example shows the sign-in page for an ASP.NET application configured to use forms authentication and the . If the supplied user credentials are invalid, a message is displayed to the user. Otherwise, the user is redirected to the originally requested URL using the method. > [!NOTE] > This example uses the class to call the specified as the `defaultProvider` in the Web.config file. If you need to access the default provider as the type , you can cast the property of the class. To access other configured providers as a specific provider type, you can access them by their configured name with the property of the class and cast them as the specific provider type. diff --git a/xml/System.Web.Security/SqlRoleProvider.xml b/xml/System.Web.Security/SqlRoleProvider.xml index fb3ab3d9cec..5821a61a671 100644 --- a/xml/System.Web.Security/SqlRoleProvider.xml +++ b/xml/System.Web.Security/SqlRoleProvider.xml @@ -28,7 +28,7 @@ The Machine.config file is configured with a instance named AspNetSqlProvider that connects to the SQL Server on the local machine. You can use this instance of the provider, or specify your own in the Web.config file for your ASP.NET application. To use the AspNetSqlProvider instance, specify AspNetSqlProvider as the `defaultProvider` in your configuration. - You can configure the to use the same database and user information as the in order to use a single database for authentication and authorization information. To use the same database for membership and role information, run the aspnet_regsql.exe executable and install the membership feature. Then, specify the same connection string in your configuration for both your and instances. Also ensure that both provider instances are configured with the same . + You can configure the to use the same database and user information as the in order to use a single database for authentication and authorization information. To use the same database for membership and role information, run the aspnet_regsql.exe executable and install the membership feature. Then, specify the same connection string in your configuration for both your and instances. Also ensure that both provider instances are configured with the same . @@ -114,7 +114,7 @@ constructor is called by ASP.NET to create an instance of the class as specified in the configuration for the application. This constructor is not intended to be used from your code. + The constructor is called by ASP.NET to create an instance of the class as specified in the configuration for the application. This constructor is not intended to be used from your code. ]]> @@ -149,9 +149,9 @@ method is called by the class to associate one or more users with one or more roles in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). This method is called by the , , , and methods of the class. + The method is called by the class to associate one or more users with one or more roles in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). This method is called by the , , , and methods of the class. - The database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed. + The database updates that are performed during the call to the method are made within a transaction. If an error is encountered, such as a user name that is already in a specified role, the transaction is rolled back and no updates are performed. If the is being used with the , and one of the specified user names does not exist in the database, the user name will be automatically added to the database. @@ -238,9 +238,9 @@ is used by the to associate users and roles with different applications. This enables multiple applications to use the same database to store user and role information without running into conflicts between duplicate user names or role names. Multiple ASP.NET applications can use the same database by specifying the same value in the property. The property can be set programmatically, or it can be set declaratively in the configuration file for the Web application using the `applicationName` attribute. + The is used by the to associate users and roles with different applications. This enables multiple applications to use the same database to store user and role information without running into conflicts between duplicate user names or role names. Multiple ASP.NET applications can use the same database by specifying the same value in the property. The property can be set programmatically, or it can be set declaratively in the configuration file for the Web application using the `applicationName` attribute. - If a value is not specified for the `applicationName` attribute in the configuration file for the Web application, then the property value for the current object is used. + If a value is not specified for the `applicationName` attribute in the configuration file for the Web application, then the property value for the current object is used. > [!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 for multiple users of an application. It is recommended 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. @@ -303,7 +303,7 @@ method is called by the class to create a role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to create a role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). The maximum length for the role name is 256 characters. Role names are not case-sensitive. Commas are not allowed in role names. @@ -367,7 +367,7 @@ method is called by the class to delete a role from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). When a role is deleted, the list of users associated with that role is also deleted from the database. The user information in the database is not affected. + The method is called by the class to delete a role from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). When a role is deleted, the list of users associated with that role is also deleted from the database. The user information in the database is not affected. If `throwOnPopulatedRole` is `true`, then an exception will be thrown and the role will not be deleted if the role identified by the `roleName` parameter has one or more members. If `throwOnPopulatedRole` is `false`, then the role will be deleted whether it is empty or not. @@ -427,12 +427,12 @@ method is called by the class and returns a list of users in a role where the user name contains a match of the supplied `usernameToMatch` for the configured `applicationName`. The searches for a user name that matches the `usernameToMatch` parameter value using the LIKE keyword and supports SQL Server wildcard characters. For example, if the `usernameToMatch` parameter is set to "user1", then membership information for the user with the user name of "user1" is returned, if it exists. If the `usernameToMatch` parameter is set to "user%", then membership information for users with the user name of "user1", "user2", "user_admin", and so on are returned. + The method is called by the class and returns a list of users in a role where the user name contains a match of the supplied `usernameToMatch` for the configured `applicationName`. The searches for a user name that matches the `usernameToMatch` parameter value using the LIKE keyword and supports SQL Server wildcard characters. For example, if the `usernameToMatch` parameter is set to "user1", then membership information for the user with the user name of "user1" is returned, if it exists. If the `usernameToMatch` parameter is set to "user%", then membership information for users with the user name of "user1", "user2", "user_admin", and so on are returned. ## Examples - The following code example uses the method to display role membership based on user input. For an example of a Web.config file that enables role management, see . + The following code example uses the method to display role membership based on user input. For an example of a Web.config file that enables role management, see . > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -495,12 +495,12 @@ method is called by the class to retrieve a list of all the roles in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to retrieve a list of all the roles in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). ## Examples - The following code example uses the method to get the list of roles for an application and bind the results to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to get the list of roles for an application and bind the results to a control. For an example of a Web.config file that enables role management, see . > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -541,12 +541,12 @@ method is called by the class to retrieve a list of a specified user's roles from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to retrieve a list of a specified user's roles from the SQL Server database specified in the ASP.NET application's configuration file (Web.config). ## Examples - The following code example uses the method to retrieve a list of roles for a specified user and binds them to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to retrieve a list of roles for a specified user and binds them to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/CS/ViewRolescs.aspx" id="Snippet4"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/VB/ViewRolesvb.aspx" id="Snippet4"::: @@ -592,12 +592,12 @@ method is called by the class to retrieve the list of users associated with the specified role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to retrieve the list of users associated with the specified role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). ## Examples - The following code example uses the method to get a list of the users in a particular role and bind the results to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to get a list of the users in a particular role and bind the results to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/CS/adduserstorolecs.aspx" id="Snippet3"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.SqlRoleProvider/VB/adduserstorolevb.aspx" id="Snippet3"::: @@ -698,7 +698,7 @@ method is called by the class and the method of the property to determine whether a user is associated with a role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class and the method of the property to determine whether a user is associated with a role in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). @@ -762,9 +762,9 @@ method is called by the class to remove one or more users from one or more roles in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). This method is called by the , , , and methods of the class. + The method is called by the class to remove one or more users from one or more roles in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). This method is called by the , , , and methods of the class. - The database updates that are performed during the call to are made within a transaction. If an error is encountered, such as a user name that does not exist or a user name that is already in a specified role, the transaction is rolled back and no updates are performed. + The database updates that are performed during the call to are made within a transaction. If an error is encountered, such as a user name that does not exist or a user name that is already in a specified role, the transaction is rolled back and no updates are performed. User names and role names cannot contain commas. @@ -848,12 +848,12 @@ method is called by the class to determine whether a role name exists in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). + The method is called by the class to determine whether a role name exists in the SQL Server database specified in the ASP.NET application's configuration file (Web.config). ## Examples - The following code example uses the method to determine whether a role name already exists before creating the role. For an example of a Web.config file that enables role management, see . + The following code example uses the method to determine whether a role name already exists before creating the role. For an example of a Web.config file that enables role management, see . > [!IMPORTANT] > This example contains a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). diff --git a/xml/System.Web.Security/UrlAuthorizationModule.xml b/xml/System.Web.Security/UrlAuthorizationModule.xml index be7a263528f..a9609c5fa04 100644 --- a/xml/System.Web.Security/UrlAuthorizationModule.xml +++ b/xml/System.Web.Security/UrlAuthorizationModule.xml @@ -25,7 +25,7 @@ determines whether the current user is permitted access to the requested URL, based on the user or the list of roles that a user is a member of. For information about how the user name is determined, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). For information about how to manage user roles, see [Managing Authorization Using Roles](https://learn.microsoft.com/previous-versions/aspnet/9ab2fxh0(v=vs.100)). + The determines whether the current user is permitted access to the requested URL, based on the user or the list of roles that a user is a member of. For information about how the user name is determined, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). For information about how to manage user roles, see [Managing Authorization Using Roles](https://learn.microsoft.com/previous-versions/aspnet/9ab2fxh0(v=vs.100)). Authorization for a user or a role is managed using the [authorization](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/8d82143t(v%3dvs.100)) configuration element. You can allow or deny a user or a role using the `allow` or `deny` subelements, respectively. The `allow` and `deny` subelements are interpreted in the order they appear in the configuration. Once an element specifies that access is allowed or denied, the completes its authorization check. For example, the following section from a Web.config file requires users to log on (by denying anonymous users), and then allows only users in the Administrators role to have access. Users not in the Administrators role are denied. @@ -86,7 +86,7 @@ ## Remarks This constructor is not intended to be called from application code. - ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. + ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. ]]> @@ -125,9 +125,9 @@ method checks to see whether the current user is granted access to the requested file in the Web.config file for the application. + The method checks to see whether the current user is granted access to the requested file in the Web.config file for the application. - If the HTTP verb used to make the request is `GET`, `POST`, or `HEAD`, the method checks for read access to the file. If any other verb is used, the checks for read/write access to the file. + If the HTTP verb used to make the request is `GET`, `POST`, or `HEAD`, the method checks for read access to the file. If any other verb is used, the checks for read/write access to the file. For more information and an example Web.config file, see the class documentation. @@ -213,7 +213,7 @@ ## Remarks This method is not intended to be called from application code. - The method ensures that the is included in the processing of the event. + The method ensures that the is included in the processing of the event. ]]> diff --git a/xml/System.Web.Security/ValidatePasswordEventArgs.xml b/xml/System.Web.Security/ValidatePasswordEventArgs.xml index b5348bcd9b7..3b20d5bb6e0 100644 --- a/xml/System.Web.Security/ValidatePasswordEventArgs.xml +++ b/xml/System.Web.Security/ValidatePasswordEventArgs.xml @@ -32,11 +32,11 @@ event is raised when the , , or method of a membership provider is called. + The event is raised when the , , or method of a membership provider is called. You can handle the event to validate password formats and values for membership users. - You can cancel the current , , or action by setting the property to `true` during the event. + You can cancel the current , , or action by setting the property to `true` during the event. If you cancel the current action by setting the property to `true`, you can set the property to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the property is set to. If the property is `null`, the caller will throw a generic password-validation failure exception. @@ -83,7 +83,7 @@ constructor is used by a membership provider implementation in the , , and method implementations. +The constructor is used by a membership provider implementation in the , , and method implementations. ]]> @@ -128,7 +128,7 @@ The constructor property is used to cancel the current , , or action. You can cancel the current action by setting the property to `true` during the event. + The property is used to cancel the current , , or action. You can cancel the current action by setting the property to `true` during the event. If you cancel the current action by setting the property to `true`, you can set the property to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the property is set to. If the property is `null`, the caller will throw a generic password-validation failure exception. @@ -181,7 +181,7 @@ The constructor property is used when the current , , or action has been canceled by setting the property to `true`. + The property is used when the current , , or action has been canceled by setting the property to `true`. The property is set to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the property is set to. If the property is `null`, the caller will throw a generic password-validation failure exception. @@ -263,11 +263,11 @@ The constructor event is raised when the , , or method of a membership provider is called. + The event is raised when the , , or method of a membership provider is called. You can handle the event to validate password formats and values for membership users. - You can cancel the current , , or action by setting the property to `true` during the event. + You can cancel the current , , or action by setting the property to `true` during the event. If you cancel the current action by setting the property to `true`, you can set the property to an exception that describes the reason for the password-validation failure. The calling method will throw the exception that the property is set to. If the property is `null`, the caller will throw a generic password-validation failure exception. diff --git a/xml/System.Web.Security/WindowsAuthenticationEventArgs.xml b/xml/System.Web.Security/WindowsAuthenticationEventArgs.xml index 26bff71e0b9..9ee1ecead1c 100644 --- a/xml/System.Web.Security/WindowsAuthenticationEventArgs.xml +++ b/xml/System.Web.Security/WindowsAuthenticationEventArgs.xml @@ -25,9 +25,9 @@ The constructs a object using the Windows identity supplied by IIS and the current and passes it to the **WindowsAuthentication_OnAuthenticate** event. - You can use the property of the object supplied to the **WindowsAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property during the **WindowsAuthentication_OnAuthenticate** event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the property is set to the identity returned by the method. + You can use the property of the object supplied to the **WindowsAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property during the **WindowsAuthentication_OnAuthenticate** event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the property is set to the identity returned by the method. - The **WindowsAuthentication_OnAuthenticate** event is raised only when the authentication is set to and the is an active HTTP module for the application. + The **WindowsAuthentication_OnAuthenticate** event is raised only when the authentication is set to and the is an active HTTP module for the application. @@ -111,7 +111,7 @@ provides access to , , and objects for the current request. + The provides access to , , and objects for the current request. ]]> @@ -150,7 +150,7 @@ ## Remarks The constructs a object using the Windows identity supplied by IIS and the current and passes it to the **WindowsAuthentication_OnAuthenticate** event. - If IIS uses anonymous authentication, the property is set to the identity returned by the method. + If IIS uses anonymous authentication, the property is set to the identity returned by the method. @@ -201,7 +201,7 @@ ## Remarks You can use the property to set the property of the current to a custom object. - If you do not specify a value for the property during the **WindowsAuthentication_OnAuthenticate** event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the property is set to the identity returned by the method. + If you do not specify a value for the property during the **WindowsAuthentication_OnAuthenticate** event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the property is set to the identity returned by the method. diff --git a/xml/System.Web.Security/WindowsAuthenticationEventHandler.xml b/xml/System.Web.Security/WindowsAuthenticationEventHandler.xml index 426c73e32be..68ccbd45f09 100644 --- a/xml/System.Web.Security/WindowsAuthenticationEventHandler.xml +++ b/xml/System.Web.Security/WindowsAuthenticationEventHandler.xml @@ -33,9 +33,9 @@ The constructs a object using the Windows identity supplied by IIS and the current and passes it to the **WindowsAuthentication_OnAuthenticate** event. - You can use the property of the object supplied to the **WindowsAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property during the **WindowsAuthentication_OnAuthenticate** event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the property of the object is set to the identity returned by the method. + You can use the property of the object supplied to the **WindowsAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property during the **WindowsAuthentication_OnAuthenticate** event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the property of the object is set to the identity returned by the method. - The **WindowsAuthentication_OnAuthenticate** event is only raised when the authentication is set to and the is an active HTTP module for the application. + The **WindowsAuthentication_OnAuthenticate** event is only raised when the authentication is set to and the is an active HTTP module for the application. diff --git a/xml/System.Web.Security/WindowsAuthenticationModule.xml b/xml/System.Web.Security/WindowsAuthenticationModule.xml index eeeec5a43c1..5344e30c1ce 100644 --- a/xml/System.Web.Security/WindowsAuthenticationModule.xml +++ b/xml/System.Web.Security/WindowsAuthenticationModule.xml @@ -25,7 +25,7 @@ is set to , the sets the property of the current to an object that represents the Windows identity supplied by IIS for the current request. If IIS uses anonymous authentication, then the uses the identity returned by the method. + When the authentication is set to , the sets the property of the current to an object that represents the Windows identity supplied by IIS for the current request. If IIS uses anonymous authentication, then the uses the identity returned by the method. The exposes an event that enables you to provide a custom object for the property of the current . The event is accessed by specifying a subroutine named **WindowsAuthentication_OnAuthenticate** in the Global.asax file for your ASP.NET application. @@ -73,7 +73,7 @@ ## Remarks This constructor is not intended to be called from application code. - ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. + ASP.NET calls this constructor to create an instance of the class. After calling the constructor, it calls the method to initialize the new object. ]]> @@ -107,9 +107,9 @@ You can access the event of the class by specifying a subroutine named **WindowsAuthentication_OnAuthenticate** in the Global.asax file for your ASP.NET application. - You can use the property of the object supplied to the **WindowsAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property during the **WindowsAuthentication_OnAuthenticate** event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the property is set to the identity returned by the method. + You can use the property of the object supplied to the **WindowsAuthentication_OnAuthenticate** event to set the property of the current to a custom object. If you do not specify a value for the property during the **WindowsAuthentication_OnAuthenticate** event, the Windows identity supplied by IIS is used as the identity for the current request. If IIS uses anonymous authentication, then the property is set to the identity returned by the method. - The **WindowsAuthentication_OnAuthenticate** event is raised only when the authentication is set to and the is an active HTTP module for the application. + The **WindowsAuthentication_OnAuthenticate** event is raised only when the authentication is set to and the is an active HTTP module for the application. > [!NOTE] > In IIS 7.0 running in Integrated Mode, the event of the is not raised when both the ASP.NET and the IIS `AnonymousAuthenticationModule` modules are enabled. In this scenario, to receive authentication notification, subscribe to the event of the instance. For more information about compatibility issues in Integrated modes, see [Moving an ASP.NET Application from IIS 6.0 to IIS 7.0](https://msdn.microsoft.com/library/76f9cc78-f978-4837-b1c8-51d642ec4847). @@ -193,7 +193,7 @@ ## Remarks This method is not intended to be called from application code. - The method ensures that the is included in the processing of the event. + The method ensures that the is included in the processing of the event. ]]> diff --git a/xml/System.Web.Security/WindowsTokenRoleProvider.xml b/xml/System.Web.Security/WindowsTokenRoleProvider.xml index 384b7f1b677..dce6a1b036f 100644 --- a/xml/System.Web.Security/WindowsTokenRoleProvider.xml +++ b/xml/System.Web.Security/WindowsTokenRoleProvider.xml @@ -22,7 +22,7 @@ ## Remarks The class is a read-only role-membership provider that retrieves role information for a Windows user based on Windows security groups. It is most useful with ASP.NET applications that use Windows authentication mode where the IIS authentication settings disable anonymous authentication. You can configure ASP.NET applications to allow or deny access based on a user's membership in a particular Windows group. - You cannot use the class to create or delete roles or modify the membership of a role that is based on Windows group membership. This functionality is managed by the Windows operating system. The class supports only the and methods of the abstract class. + You cannot use the class to create or delete roles or modify the membership of a role that is based on Windows group membership. This functionality is managed by the Windows operating system. The class supports only the and methods of the abstract class. @@ -83,7 +83,7 @@ constructor is called by ASP.NET to create an instance of the class as specified in the configuration for the application. This constructor is not intended to be used from your code. + The constructor is called by ASP.NET to create an instance of the class as specified in the configuration for the application. This constructor is not intended to be used from your code. ]]> @@ -327,14 +327,14 @@ class to retrieve from the Windows operating system a list of the Windows groups that the specified user is in. The method can be called only for the currently logged-on user, as identified by the LOGON_USER server variable. If the value supplied in the `username` parameter is not the name of the currently logged-on user, a is thrown. + This method is called by the class to retrieve from the Windows operating system a list of the Windows groups that the specified user is in. The method can be called only for the currently logged-on user, as identified by the LOGON_USER server variable. If the value supplied in the `username` parameter is not the name of the currently logged-on user, a is thrown. For more information an ASP.NET and Windows authentication, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). ## Examples - The following code example uses the method to retrieve a list of roles for a specified user and binds the list of roles to a control. For an example of a Web.config file that enables role management, see . + The following code example uses the method to retrieve a list of roles for a specified user and binds the list of roles to a control. For an example of a Web.config file that enables role management, see . :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Security.WindowsTokenRoleProvider/CS/viewrolescs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Security.WindowsTokenRoleProvider/VB/viewrolesvb.aspx" id="Snippet1"::: @@ -412,7 +412,7 @@ method initializes the class with the property values specified in the ASP.NET application configuration file (Web.config) and is not intended to be used directly from your code. + The method initializes the class with the property values specified in the ASP.NET application configuration file (Web.config) and is not intended to be used directly from your code. ]]> @@ -466,11 +466,11 @@ method enables you to check whether a user is in one of the common Windows roles described by the enumeration. This method is useful for applications that are localized into multiple languages. This overload of the method is not part of the base class and can only be accessed by casting the property of the class as the type. + The method enables you to check whether a user is in one of the common Windows roles described by the enumeration. This method is useful for applications that are localized into multiple languages. This overload of the method is not part of the base class and can only be accessed by casting the property of the class as the type. - You can call the method only for the currently logged-on user, as identified by the LOGON_USER server variable. If the value supplied in the `username` parameter is not the name of the currently logged-on user, an is thrown. + You can call the method only for the currently logged-on user, as identified by the LOGON_USER server variable. If the value supplied in the `username` parameter is not the name of the currently logged-on user, an is thrown. - method can only be called for the currently logged-on user identified by the LOGON_USER server variable. The current logged on user must be a Windows authenticated user. For more information on ASP.NET and Windows authentication, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). + method can only be called for the currently logged-on user identified by the LOGON_USER server variable. The current logged on user must be a Windows authenticated user. For more information on ASP.NET and Windows authentication, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). @@ -522,7 +522,7 @@ method is called by the class and the method of the property to determine whether a user is in a Windows group. You can call the method only for the currently logged-on user, as identified by the LOGON_USER server variable. The current logged-on user must be a Windows authenticated user. For more information on ASP.NET and Windows authentication, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). + The method is called by the class and the method of the property to determine whether a user is in a Windows group. You can call the method only for the currently logged-on user, as identified by the LOGON_USER server variable. The current logged-on user must be a Windows authenticated user. For more information on ASP.NET and Windows authentication, see [ASP.NET Authentication](https://learn.microsoft.com/previous-versions/aspnet/eeyk640h(v=vs.100)). diff --git a/xml/System.Web.Services.Configuration/SoapEnvelopeProcessingElement.xml b/xml/System.Web.Services.Configuration/SoapEnvelopeProcessingElement.xml index 3ac4d43e2a1..72e20fd7ab5 100644 --- a/xml/System.Web.Services.Configuration/SoapEnvelopeProcessingElement.xml +++ b/xml/System.Web.Services.Configuration/SoapEnvelopeProcessingElement.xml @@ -20,7 +20,7 @@ and . + The timeout value is checked on every call to and . ]]> @@ -129,7 +129,7 @@ property to `true` in order to help debug interoperation scenarios. In general, when the class meets an element or attribute that it does not expect it raises an event and continues processing. (The same is true when the , , or properties are used but data is sent out of order.) Setting the property to `true` instructs the Web services run time to handle that event and throw a that contains a list of the expected elements and attributes. + Set the property to `true` in order to help debug interoperation scenarios. In general, when the class meets an element or attribute that it does not expect it raises an event and continues processing. (The same is true when the , , or properties are used but data is sent out of order.) Setting the property to `true` instructs the Web services run time to handle that event and throw a that contains a list of the expected elements and attributes. > [!NOTE] > Because exceptions are not thrown for all unexpected elements and attributes, the property should not be relied upon except as a debugging aid. For example, unexpected `xml:lang` and `xml:space` attributes may not cause an exception. diff --git a/xml/System.Web.Services.Description/BasicProfileViolationEnumerator.xml b/xml/System.Web.Services.Description/BasicProfileViolationEnumerator.xml index f327188ff53..7a3f571c105 100644 --- a/xml/System.Web.Services.Description/BasicProfileViolationEnumerator.xml +++ b/xml/System.Web.Services.Description/BasicProfileViolationEnumerator.xml @@ -49,11 +49,11 @@ The to be enumerated using this class. Initializes a new instance of the class. - is set to -1. - + is set to -1. + ]]> @@ -81,11 +81,11 @@ Gets the current element in the . A object representing the current element in the . - diff --git a/xml/System.Web.Services.Description/BindingCollection.xml b/xml/System.Web.Services.Description/BindingCollection.xml index 94b4bf1a998..c9e71d9f2d4 100644 --- a/xml/System.Web.Services.Description/BindingCollection.xml +++ b/xml/System.Web.Services.Description/BindingCollection.xml @@ -32,11 +32,11 @@ Represents a collection of instances of the class supported by the XML Web service. This class cannot be inherited. - class corresponds to the Web Services Description Language (WSDL) `` element enclosed by the root `` element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - + class corresponds to the Web Services Description Language (WSDL) `` element enclosed by the root `` element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + ]]> @@ -76,13 +76,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -123,13 +123,13 @@ if the parameter is a member of the ; otherwise, . - @@ -170,13 +170,13 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -253,13 +253,13 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -300,22 +300,22 @@ The to be added to the collection. Adds the specified to the at the specified zero-based index. - , the `binding` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples + , the `binding` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/BindingCollectionSample2/CPP/bindingcollectionsample2.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/Binding/Extensions/bindingcollectionsample2.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/Binding/Extensions/bindingcollectionsample2.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/Binding/Extensions/bindingcollectionsample2.vb" id="Snippet6"::: + ]]> @@ -365,19 +365,19 @@ Gets or sets the value of a at the specified zero-based index. A . - - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -416,15 +416,15 @@ Gets a specified by its name. A . - named "MathServiceHttpGet". - + named "MathServiceHttpGet". + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/BindingCollectionsample1/CPP/bindingcollectionsample1.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/Binding/Overview/bindingcollectionsample1.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/Binding/Overview/bindingcollectionsample1.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/Binding/Overview/bindingcollectionsample1.vb" id="Snippet3"::: + ]]> @@ -463,20 +463,20 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed `Binding` move up to occupy the vacated spot. - - - -## Examples + . + + The elements that follow the removed `Binding` move up to occupy the vacated spot. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/BindingCollectionsample3/CPP/bindingcollectionsample3.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/BindingCollection/Add/bindingcollectionsample3.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/BindingCollection/Add/bindingcollectionsample3.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/BindingCollection/Add/bindingcollectionsample3.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Web.Services.Description/FaultBindingCollection.xml b/xml/System.Web.Services.Description/FaultBindingCollection.xml index 40fc4ac92bb..50ffe4ac0e8 100644 --- a/xml/System.Web.Services.Description/FaultBindingCollection.xml +++ b/xml/System.Web.Services.Description/FaultBindingCollection.xml @@ -32,13 +32,13 @@ Represents a collection of instances of the class. This class cannot be inherited. - @@ -79,13 +79,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -126,15 +126,15 @@ if the parameter is a member of the ; otherwise, . - @@ -175,15 +175,15 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -260,15 +260,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -309,24 +309,24 @@ The to add to the collection. Adds the specified to the at the specified zero-based index. - , the `bindingOperationFault` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples - The following example demonstrates a typical use of the `Insert` method. - + , the `bindingOperationFault` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples + The following example demonstrates a typical use of the `Insert` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/FaultBindingCollection_Remove/CPP/faultbindingcollection_remove.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/FaultBindingCollection/Contains/faultbindingcollection_remove.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBindingCollection/Contains/faultbindingcollection_remove.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBindingCollection/Contains/faultbindingcollection_remove.vb" id="Snippet3"::: + ]]> @@ -376,21 +376,21 @@ Gets or sets the value of a at the specified zero-based index. A . - class. - + class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/FaultBindingCollection_Add/CPP/faultbindingcollection_add.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/FaultBinding/Overview/faultbindingcollection_add.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBinding/Overview/faultbindingcollection_add.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBinding/Overview/faultbindingcollection_add.vb" id="Snippet1"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -429,15 +429,15 @@ Gets a specified by its name. A . - @@ -476,22 +476,22 @@ The to remove from the collection. Removes the first occurrence the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples - The following example demonstrates a typical use of the `Remove` method. - + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples + The following example demonstrates a typical use of the `Remove` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/FaultBindingCollection_Remove/CPP/faultbindingcollection_remove.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/FaultBindingCollection/Contains/faultbindingcollection_remove.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBindingCollection/Contains/faultbindingcollection_remove.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBindingCollection/Contains/faultbindingcollection_remove.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Web.Services.Description/ImportCollection.xml b/xml/System.Web.Services.Description/ImportCollection.xml index de592361350..0d789c9833f 100644 --- a/xml/System.Web.Services.Description/ImportCollection.xml +++ b/xml/System.Web.Services.Description/ImportCollection.xml @@ -32,20 +32,20 @@ Provides a collection of instances of the class representing documents to be imported into the XML Web service. This class cannot be inherited. - class corresponds to the Web Services Description Language (WSDL) `` element that is enclosed by the root `` element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples - The following example demonstrates a typical use of the `ImportCollection` class. - + class corresponds to the Web Services Description Language (WSDL) `` element that is enclosed by the root `` element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples + The following example demonstrates a typical use of the `ImportCollection` class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ImportCollection_6/CPP/importcollection_6.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ImportCollection/Overview/importcollection_6.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ImportCollection/Overview/importcollection_6.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ImportCollection/Overview/importcollection_6.vb" id="Snippet1"::: + ]]> @@ -86,15 +86,15 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - class. - + class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Importsample/CPP/importsample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/FaultBindingCollection/Overview/importsample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBindingCollection/Overview/importsample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBindingCollection/Overview/importsample.vb" id="Snippet1"::: + ]]> @@ -135,15 +135,15 @@ if the parameter is a member of the ; otherwise, . - @@ -184,15 +184,15 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -232,15 +232,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -281,30 +281,30 @@ The to add to the collection. Adds the specified instance to the at the specified zero-based index. - , the `import` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples - The following example demonstrates the use of the `Insert` method. To view the source for the user-defined `CreateImport` method, see the example included with the class. - + , the `import` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples + The following example demonstrates the use of the `Insert` method. To view the source for the user-defined `CreateImport` method, see the example included with the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Importsample/CPP/importsample.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/FaultBindingCollection/Overview/importsample.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBindingCollection/Overview/importsample.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/FaultBindingCollection/Overview/importsample.vb" id="Snippet2"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -343,15 +343,15 @@ Gets or sets the value of an at the specified zero-based index. An . - @@ -390,22 +390,22 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples - The following example demonstrates the use of the `Remove` method. - + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples + The following example demonstrates the use of the `Remove` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ImportCollection_6/CPP/importcollection_6.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ImportCollection/Overview/importcollection_6.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ImportCollection/Overview/importcollection_6.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ImportCollection/Overview/importcollection_6.vb" id="Snippet6"::: + ]]> diff --git a/xml/System.Web.Services.Description/MessageCollection.xml b/xml/System.Web.Services.Description/MessageCollection.xml index fe1d29c12fd..25fdee1ecaa 100644 --- a/xml/System.Web.Services.Description/MessageCollection.xml +++ b/xml/System.Web.Services.Description/MessageCollection.xml @@ -32,13 +32,13 @@ Represents a collection of instances of the class. This class cannot be inherited. - @@ -78,13 +78,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -125,15 +125,15 @@ if the parameter is a member of the ; otherwise, . - @@ -174,15 +174,15 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -259,15 +259,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -308,28 +308,28 @@ The to add to the collection. Adds the specified to the at the specified zero-based index. - , the `message` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples + , the `message` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DescriptionNamespaceSample1/CPP/descriptionnamespacesample1.cpp" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/InputBinding/Overview/descriptionnamespacesample1.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/InputBinding/Overview/descriptionnamespacesample1.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/InputBinding/Overview/descriptionnamespacesample1.vb" id="Snippet8"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -378,15 +378,15 @@ Gets or sets the value of a at the specified zero-based index. A . - @@ -426,15 +426,15 @@ Gets a specified by its name. A . - @@ -473,22 +473,22 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples - The following example demonstrates the use of the `Remove` method. - + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples + The following example demonstrates the use of the `Remove` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MessageCollection/CPP/messagecollection.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/MessageCollection/Contains/messagecollection.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MessageCollection/Contains/messagecollection.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MessageCollection/Contains/messagecollection.vb" id="Snippet6"::: + ]]> diff --git a/xml/System.Web.Services.Description/MessagePartCollection.xml b/xml/System.Web.Services.Description/MessagePartCollection.xml index 4f57fd744cb..5b13a6cb2af 100644 --- a/xml/System.Web.Services.Description/MessagePartCollection.xml +++ b/xml/System.Web.Services.Description/MessagePartCollection.xml @@ -32,20 +32,20 @@ Represents a collection of instances of the class. This class cannot be inherited. - class corresponds to a Web Services Description Language (WSDL) `` element enclosed by the `` element, which is in turn enclosed by the `` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples - The following example demonstrates the use of the methods and properties exposed by the `MessagePartCollection` class. - + class corresponds to a Web Services Description Language (WSDL) `` element enclosed by the `` element, which is in turn enclosed by the `` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples + The following example demonstrates the use of the methods and properties exposed by the `MessagePartCollection` class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MessagePartCollection/CPP/messagepartcollection.cpp" id="Snippet8"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/MessagePart/Message/messagepartcollection.cs" id="Snippet8"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MessagePart/Message/messagepartcollection.vb" id="Snippet8"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MessagePart/Message/messagepartcollection.vb" id="Snippet8"::: + ]]> @@ -86,13 +86,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -133,15 +133,15 @@ if the parameter is a member of the ; otherwise, . - @@ -182,15 +182,15 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -267,15 +267,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -316,22 +316,22 @@ The to add to the collection. Adds the specified to the at the specified zero-based index. - , the `messagePart` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples + , the `messagePart` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DescriptionNamespaceSample1/CPP/descriptionnamespacesample1.cpp" id="Snippet15"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/InputBinding/Overview/descriptionnamespacesample1.cs" id="Snippet15"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/InputBinding/Overview/descriptionnamespacesample1.vb" id="Snippet15"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/InputBinding/Overview/descriptionnamespacesample1.vb" id="Snippet15"::: + ]]> @@ -381,15 +381,15 @@ Gets or sets the value of a at the specified zero-based index. A . - @@ -429,13 +429,13 @@ Gets a specified by its name. A . - @@ -474,22 +474,22 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples - The following example demonstrates the use of the `Remove` method. - + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples + The following example demonstrates the use of the `Remove` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MessagePartCollection/CPP/messagepartcollection.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/MessagePart/Message/messagepartcollection.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MessagePart/Message/messagepartcollection.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MessagePart/Message/messagepartcollection.vb" id="Snippet7"::: + ]]> diff --git a/xml/System.Web.Services.Description/MimePartCollection.xml b/xml/System.Web.Services.Description/MimePartCollection.xml index 56cd7d8fbd1..4f916501971 100644 --- a/xml/System.Web.Services.Description/MimePartCollection.xml +++ b/xml/System.Web.Services.Description/MimePartCollection.xml @@ -32,22 +32,22 @@ Represents a collection of instances of the class. This class cannot be inherited. - within the collection represents an extensibility element added to a , and specifies the MIME type for a corresponding . - - For more information about specifying protocols for XML Web services, see [XML Web Services Using ASP.NET](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ba0z6a33(v=vs.100)). For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples - The following example demonstrates the use of the properties and methods exposed by the `MimePartCollection` class. - + within the collection represents an extensibility element added to a , and specifies the MIME type for a corresponding . + + For more information about specifying protocols for XML Web services, see [XML Web Services Using ASP.NET](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ba0z6a33(v=vs.100)). For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples + The following example demonstrates the use of the properties and methods exposed by the `MimePartCollection` class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MimePartCollection_1/CPP/mimepartcollection_1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/MimePartCollection/Overview/mimepartcollection_1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MimePartCollection/Overview/mimepartcollection_1.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MimePartCollection/Overview/mimepartcollection_1.vb" id="Snippet1"::: + ]]> @@ -116,15 +116,15 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -165,15 +165,15 @@ if the parameter is a member of the ; otherwise, . - @@ -214,15 +214,15 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -262,15 +262,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -311,30 +311,30 @@ The to add to the collection. Adds the specified to the at the specified index. - , the `mimePart` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples - The following example demonstrates a typical use of the `Insert` method. - + , the `mimePart` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples + The following example demonstrates a typical use of the `Insert` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MimePartCollection_8/CPP/mimepartcollection_8.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/MimePartCollection/Add/mimepartcollection_8.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MimePartCollection/Add/mimepartcollection_8.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MimePartCollection/Add/mimepartcollection_8.vb" id="Snippet3"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -373,15 +373,15 @@ Gets or sets the value of a at the specified zero-based index. A . - @@ -420,20 +420,20 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed `MimePart` move up to occupy the vacated spot. - - - -## Examples - The following example demonstrates a typical use of the `Remove` method. - - MimePartCollection_8#8 - + . + + The elements that follow the removed `MimePart` move up to occupy the vacated spot. + + + +## Examples + The following example demonstrates a typical use of the `Remove` method. + + MimePartCollection_8#8 + ]]> diff --git a/xml/System.Web.Services.Description/MimeTextMatch.xml b/xml/System.Web.Services.Description/MimeTextMatch.xml index 739f3eb0439..d31bcaf9136 100644 --- a/xml/System.Web.Services.Description/MimeTextMatch.xml +++ b/xml/System.Web.Services.Description/MimeTextMatch.xml @@ -123,7 +123,7 @@ and properties. + For more information, see the and properties. diff --git a/xml/System.Web.Services.Description/MimeTextMatchCollection.xml b/xml/System.Web.Services.Description/MimeTextMatchCollection.xml index 56b353b72ae..a5cd6a0ce5d 100644 --- a/xml/System.Web.Services.Description/MimeTextMatchCollection.xml +++ b/xml/System.Web.Services.Description/MimeTextMatchCollection.xml @@ -32,20 +32,20 @@ Provides a collection of instances of the class. This class cannot be inherited. - represents a MIME text pattern for which an HTTP transmission will be searched. For more information about specifying protocols for XML Web services, see [XML Web Services Using ASP.NET](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ba0z6a33(v=vs.100)). For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples - The following example demonstrates the use of the properties and methods exposed by the `MimeTextMatchCollection` class. - + represents a MIME text pattern for which an HTTP transmission will be searched. For more information about specifying protocols for XML Web services, see [XML Web Services Using ASP.NET](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ba0z6a33(v=vs.100)). For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples + The following example demonstrates the use of the properties and methods exposed by the `MimeTextMatchCollection` class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MimeText_Match_MatchColl_9/CPP/mimetext_match_matchcoll_9.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/MimeTextMatchCollection/Overview/mimetext_match_matchcoll_9.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MimeTextMatchCollection/Overview/mimetext_match_matchcoll_9.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MimeTextMatchCollection/Overview/mimetext_match_matchcoll_9.vb" id="Snippet1"::: + ]]> @@ -114,15 +114,15 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -163,15 +163,15 @@ if the parameter is a member of the ; otherwise, . - @@ -212,15 +212,15 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -260,15 +260,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -309,30 +309,30 @@ The to add to the collection. Adds the specified to the at the specified index. - , the `match` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples - The following example demonstrates the use of the `Insert` method. - + , the `match` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples + The following example demonstrates the use of the `Insert` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MimeText_Match_MatchColl_9/CPP/mimetext_match_matchcoll_9.cpp" id="Snippet9"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/MimeTextMatchCollection/Overview/mimetext_match_matchcoll_9.cs" id="Snippet9"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MimeTextMatchCollection/Overview/mimetext_match_matchcoll_9.vb" id="Snippet9"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/MimeTextMatchCollection/Overview/mimetext_match_matchcoll_9.vb" id="Snippet9"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -371,15 +371,15 @@ Gets or sets the value of the member of the at the specified zero-based index. A . - @@ -418,20 +418,20 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed `MimeTextMatch` move up to occupy the vacated spot. - - - -## Examples - The following example demonstrates the use of the `Remove` method. - - MimeText_Match_MatchColl_9#6 - + . + + The elements that follow the removed `MimeTextMatch` move up to occupy the vacated spot. + + + +## Examples + The following example demonstrates the use of the `Remove` method. + + MimeText_Match_MatchColl_9#6 + ]]> diff --git a/xml/System.Web.Services.Description/Operation.xml b/xml/System.Web.Services.Description/Operation.xml index 0a75c83cdeb..0339c857bf2 100644 --- a/xml/System.Web.Services.Description/Operation.xml +++ b/xml/System.Web.Services.Description/Operation.xml @@ -217,7 +217,7 @@ method. + The following example demonstrates a typical use of the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Operation_IsBoundBy/CPP/operation_isboundby.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/Operation/IsBoundBy/operation_isboundby.cs" id="Snippet1"::: @@ -423,7 +423,7 @@ - If the name appears only in the output message, it is an `out` parameter. - Note that this parameter list is not required, even if the is to be used with an RPC-style . Do not call directly. This method is only used internally for XML serialization. To return the parameter list use . + Note that this parameter list is not required, even if the is to be used with an RPC-style . Do not call directly. This method is only used internally for XML serialization. To return the parameter list use . diff --git a/xml/System.Web.Services.Description/OperationBinding.xml b/xml/System.Web.Services.Description/OperationBinding.xml index 851425d1bf2..c160aeb45be 100644 --- a/xml/System.Web.Services.Description/OperationBinding.xml +++ b/xml/System.Web.Services.Description/OperationBinding.xml @@ -44,20 +44,20 @@ Provides specifications for protocols and data formats for the messages used in the action supported by the XML Web service. This class cannot be inherited. - ` element enclosed by the `` element, which in turn corresponds to the class. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples - The following example demonstrates the use of the properties and methods exposed by the `OperationBinding` class. It takes an existing and adds support for the SOAP protocol. - + ` element enclosed by the `` element, which in turn corresponds to the class. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples + The following example demonstrates the use of the properties and methods exposed by the `OperationBinding` class. It takes an existing and adds support for the SOAP protocol. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationBinding_OperationBinding/CPP/operationbinding_operationbinding.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationBinding/Overview/operationbinding_operationbinding.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBinding/Overview/operationbinding_operationbinding.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBinding/Overview/operationbinding_operationbinding.vb" id="Snippet1"::: + ]]> @@ -122,18 +122,18 @@ Gets the of which the current is a member. A binding of which the current is a member. - is a member of the collection. - - - -## Examples + is a member of the collection. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationBinding_OperationBinding/CPP/operationbinding_operationbinding.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationBinding/Overview/operationbinding_operationbinding.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBinding/Overview/operationbinding_operationbinding.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBinding/Overview/operationbinding_operationbinding.vb" id="Snippet5"::: + ]]> @@ -179,18 +179,18 @@ Gets the collection of extensibility elements specific to the current . A collection of extensibility elements. - @@ -232,13 +232,13 @@ Gets the associated with the instance. A fault binding collection. - @@ -280,18 +280,18 @@ Gets or sets the associated with the . An associated with the . - @@ -363,16 +363,16 @@ Gets or sets the associated with the . An associated with the . - diff --git a/xml/System.Web.Services.Description/OperationBindingCollection.xml b/xml/System.Web.Services.Description/OperationBindingCollection.xml index 83e14f0ed8e..6fa3a914fcb 100644 --- a/xml/System.Web.Services.Description/OperationBindingCollection.xml +++ b/xml/System.Web.Services.Description/OperationBindingCollection.xml @@ -32,18 +32,18 @@ Represents a collection of instances of the class. This class cannot be inherited. - class corresponds to the Web Services Description Language (WSDL) `` element enclosed by the `` element, which in turn corresponds to the class. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples + class corresponds to the Web Services Description Language (WSDL) `` element enclosed by the `` element, which in turn corresponds to the class. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationBindingCollection_OperationBindingCollection/CPP/operationbindingcollection_operationbindingcollection.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.vb" id="Snippet1"::: + ]]> @@ -83,15 +83,15 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -132,15 +132,15 @@ if the parameter is a member of the ; otherwise, . - @@ -181,15 +181,15 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -229,15 +229,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -278,24 +278,24 @@ The to add to the collection. Adds the specified instance to the at the specified zero-based index. - , the `bindingOperation` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples - The following example demonstrates the use of the `Insert` method. - + , the `bindingOperation` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples + The following example demonstrates the use of the `Insert` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationBindingCollection_OperationBindingCollection/CPP/operationbindingcollection_operationbindingcollection.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.vb" id="Snippet6"::: + ]]> @@ -335,15 +335,15 @@ Gets or sets the value of an at the specified zero-based index. An . - @@ -382,22 +382,22 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples - The following example demonstrates the use of the `Remove` method. - + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples + The following example demonstrates the use of the `Remove` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationBindingCollection_OperationBindingCollection/CPP/operationbindingcollection_operationbindingcollection.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationBindingCollection/Overview/operationbindingcollection_operationbindingcollection.vb" id="Snippet5"::: + ]]> diff --git a/xml/System.Web.Services.Description/OperationCollection.xml b/xml/System.Web.Services.Description/OperationCollection.xml index 49e212f3c32..193f75bb7d1 100644 --- a/xml/System.Web.Services.Description/OperationCollection.xml +++ b/xml/System.Web.Services.Description/OperationCollection.xml @@ -32,20 +32,20 @@ Represents a collection of instances of the class. This class cannot be inherited. - class corresponds to the Web Services Description Language (WSDL) `` element enclosed by the `` element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples - The following example demonstrates the use of the properties and methods exposed by the `OperationCollection` class. - + class corresponds to the Web Services Description Language (WSDL) `` element enclosed by the `` element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples + The following example demonstrates the use of the properties and methods exposed by the `OperationCollection` class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationCollection_Methods/CPP/operationcollection_methods.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.vb" id="Snippet1"::: + ]]> @@ -85,15 +85,15 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -134,15 +134,15 @@ if is a member of the ; otherwise, . - @@ -183,15 +183,15 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -231,15 +231,15 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -280,24 +280,24 @@ The to add to the collection. Adds the specified to the at the specified zero-based index. - , the `operation` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples - The following example demonstrates the use of the `Insert` method. - + , the `operation` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples + The following example demonstrates the use of the `Insert` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationCollection_Methods/CPP/operationcollection_methods.cpp" id="Snippet6"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.cs" id="Snippet6"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.vb" id="Snippet6"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.vb" id="Snippet6"::: + ]]> @@ -337,15 +337,15 @@ Gets or sets the value of an at the specified zero-based index. An . - @@ -384,22 +384,22 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples - The following example demonstrates the use of the `Remove` method. - + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples + The following example demonstrates the use of the `Remove` method. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationCollection_Methods/CPP/operationcollection_methods.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationCollection/Overview/operationcollection_methods.vb" id="Snippet5"::: + ]]> diff --git a/xml/System.Web.Services.Description/OperationFaultCollection.xml b/xml/System.Web.Services.Description/OperationFaultCollection.xml index 35b02592154..a897d2edbf0 100644 --- a/xml/System.Web.Services.Description/OperationFaultCollection.xml +++ b/xml/System.Web.Services.Description/OperationFaultCollection.xml @@ -32,18 +32,18 @@ Represents a collection of instances of the class. This class cannot be inherited. - class corresponds to the Web Services Description Language (WSDL) `` element enclosed by the `` element that is in turn enclosed by the `` element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples + class corresponds to the Web Services Description Language (WSDL) `` element enclosed by the `` element that is in turn enclosed by the `` element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationFaultCollection_7/CPP/operationfaultcollection_7.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.vb" id="Snippet1"::: + ]]> @@ -83,13 +83,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -130,13 +130,13 @@ if the parameter is a member of the ; otherwise, . - @@ -177,13 +177,13 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a compatible one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -260,13 +260,13 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -307,22 +307,22 @@ The to add to the collection. Adds the specified to the at the specified zero-based index. - , the `bindingOperationFault` parameter is added to the end of the collection. - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples + , the `bindingOperationFault` parameter is added to the end of the collection. + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationFaultCollection_7/CPP/operationfaultcollection_7.cpp" id="Snippet5"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.cs" id="Snippet5"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.vb" id="Snippet5"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.vb" id="Snippet5"::: + ]]> @@ -372,13 +372,13 @@ Gets or sets the value of an at the specified zero-based index. An . - @@ -418,13 +418,13 @@ Gets an by its name. An . - @@ -463,20 +463,20 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/OperationFaultCollection_7/CPP/operationfaultcollection_7.cpp" id="Snippet7"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.cs" id="Snippet7"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.vb" id="Snippet7"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/OperationFaultCollection/Overview/operationfaultcollection_7.vb" id="Snippet7"::: + ]]> diff --git a/xml/System.Web.Services.Description/OperationMessageCollection.xml b/xml/System.Web.Services.Description/OperationMessageCollection.xml index 2b06ce22504..3fc68d98e1e 100644 --- a/xml/System.Web.Services.Description/OperationMessageCollection.xml +++ b/xml/System.Web.Services.Description/OperationMessageCollection.xml @@ -359,7 +359,7 @@ ## Remarks If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. - If the `index` parameter is equal to , the `operationMessage` parameter is added to the end of the collection. + If the `index` parameter is equal to , the `operationMessage` parameter is added to the end of the collection. The elements after the insertion point move down to accommodate the new element. @@ -613,7 +613,7 @@ . + This method performs a linear search; therefore, the average execution time is proportional to . The elements that follow the removed move up to occupy the vacated spot. diff --git a/xml/System.Web.Services.Description/Port.xml b/xml/System.Web.Services.Description/Port.xml index c2c5d81edfc..c2af24128ed 100644 --- a/xml/System.Web.Services.Description/Port.xml +++ b/xml/System.Web.Services.Description/Port.xml @@ -54,7 +54,7 @@ ## Examples - The following examples creates a and adds it to the collection of an existing named `myDescription`. + The following examples creates a and adds it to the collection of an existing named `myDescription`. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/PortClass/CPP/portclass.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/Port/Overview/portclass.cs" id="Snippet1"::: diff --git a/xml/System.Web.Services.Description/PortCollection.xml b/xml/System.Web.Services.Description/PortCollection.xml index 396b45d054f..b0f927fc7c6 100644 --- a/xml/System.Web.Services.Description/PortCollection.xml +++ b/xml/System.Web.Services.Description/PortCollection.xml @@ -32,13 +32,13 @@ Represents a collection of instances of the class. This class cannot be inherited. - @@ -78,13 +78,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -125,13 +125,13 @@ if the specified is a member of the ; otherwise, . - @@ -172,13 +172,13 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -255,13 +255,13 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -302,28 +302,28 @@ The to add to the collection. Adds the specified instance to the at the specified index. - , the specified is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples + , the specified is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/PortCollection_CopyTo/CPP/portcollection_copyto.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/PortCollection/CopyTo/portcollection_copyto.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/PortCollection/CopyTo/portcollection_copyto.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/PortCollection/CopyTo/portcollection_copyto.vb" id="Snippet1"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -372,13 +372,13 @@ Gets or sets the value of a at the specified zero-based index. The value of a port at the specified index. - @@ -418,13 +418,13 @@ Gets a specified by its name. A port specified by its name. - @@ -463,20 +463,20 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/PortCollection_Item/CPP/portcollection_item.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/PortCollection/Overview/portcollection_item.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/PortCollection/Overview/portcollection_item.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/PortCollection/Overview/portcollection_item.vb" id="Snippet2"::: + ]]> diff --git a/xml/System.Web.Services.Description/PortTypeCollection.xml b/xml/System.Web.Services.Description/PortTypeCollection.xml index 1280eab9c6d..bde6866b492 100644 --- a/xml/System.Web.Services.Description/PortTypeCollection.xml +++ b/xml/System.Web.Services.Description/PortTypeCollection.xml @@ -32,13 +32,13 @@ Represents a collection of instances of the class; that is, a collection of sets of operations supported by the XML Web service. This class cannot be inherited. - @@ -78,13 +78,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -125,13 +125,13 @@ if the parameter is a member of the ; otherwise, . - @@ -172,13 +172,13 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -255,13 +255,13 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. A 32-bit signed integer. - @@ -302,28 +302,28 @@ The to add to the collection. Adds the specified to the at the specified zero-based index. - , the specified instance is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples + , the specified instance is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/PortTypeCollection_2/CPP/porttypecollection_2.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/PortTypeCollection/Contains/porttypecollection_2.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/PortTypeCollection/Contains/porttypecollection_2.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/PortTypeCollection/Contains/porttypecollection_2.vb" id="Snippet2"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -372,13 +372,13 @@ Gets or sets the value of a at the specified zero-based index. A . - @@ -418,13 +418,13 @@ Gets the specified by its name. The name of the parameter. - The parameter cannot be explicitly cast to type . @@ -464,20 +464,20 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/PortTypeCollection_1/CPP/porttypecollection_1.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/PortTypeCollection/Add/porttypecollection_1.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/PortTypeCollection/Add/porttypecollection_1.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/PortTypeCollection/Add/porttypecollection_1.vb" id="Snippet2"::: + ]]> diff --git a/xml/System.Web.Services.Description/ProtocolImporter.xml b/xml/System.Web.Services.Description/ProtocolImporter.xml index 28b30903b2c..970ed4cf1c3 100644 --- a/xml/System.Web.Services.Description/ProtocolImporter.xml +++ b/xml/System.Web.Services.Description/ProtocolImporter.xml @@ -129,7 +129,7 @@ class calls the method before generating methods that correspond to operations. + When generating a class for a given binding, the class calls the method before generating methods that correspond to operations. ]]> @@ -159,7 +159,7 @@ class calls the method before generating classes that represent bindings. + When generating code, the class calls the method before generating classes that represent bindings. ]]> @@ -327,7 +327,7 @@ class calls the method after generating methods that correspond to operations. + When generating a class for a given binding, the class calls the method after generating methods that correspond to operations. ]]> @@ -357,7 +357,7 @@ class calls the method after generating classes that represent bindings. + When generating code, the class calls the method after generating classes that represent bindings. ]]> @@ -388,7 +388,7 @@ class calls the method for each binding class method that represents an operation. + When generating code, the class calls the method for each binding class method that represents an operation. ]]> @@ -443,7 +443,7 @@ class calls the method to determine whether to generate a class for the current binding, as represented by the property. + When generating code, the class calls the method to determine whether to generate a class for the current binding, as represented by the property. ]]> @@ -478,7 +478,7 @@ class calls the method to determine whether to generate a method for the current operation, as represented by the property. This evaluation takes place for each operation in a binding for which a class is being generated. If a `false` value is returned, the class calls its method. + When generating code, the class calls the method to determine whether to generate a method for the current operation, as represented by the property. This evaluation takes place for each operation in a binding for which a class is being generated. If a `false` value is returned, the class calls its method. For more information, see the property. The property is of type . @@ -533,7 +533,7 @@ element in a WSDL document. The method is generated with a class. + The operation appears as a child of the element in a WSDL document. The method is generated with a class. ]]> diff --git a/xml/System.Web.Services.Description/ProtocolReflector.xml b/xml/System.Web.Services.Description/ProtocolReflector.xml index f3824a5f492..ca0ef752812 100644 --- a/xml/System.Web.Services.Description/ProtocolReflector.xml +++ b/xml/System.Web.Services.Description/ProtocolReflector.xml @@ -18,17 +18,17 @@ Provides common functionality across communication protocols for creating objects from classes that are identified as Web services. - class and its concrete derived classes create objects from classes that are identified as Web services with the attribute. Each concrete -derived class generates objects according to a specified communication protocol; provides common functionality regardless of the protocol. - - An output instance can be used to generate a Web Services Description Language (WSDL) document with the method or one of the available overloads. The instance can also be used by the class and related classes to generate client proxy code or abstract server code. - - The class uses the to create a for each binding it identifies in the Web service class. If that attribute is not present, the class creates a single binding for the entire class. For each Web service method (a method in the Web service class appearing with the ) belonging to a binding, a class derived from generates an operation and associated messages that are added to the object. - - Typically, a developer uses these classes indirectly through the class, instead of directly invoking classes derived from . - + class and its concrete derived classes create objects from classes that are identified as Web services with the attribute. Each concrete -derived class generates objects according to a specified communication protocol; provides common functionality regardless of the protocol. + + An output instance can be used to generate a Web Services Description Language (WSDL) document with the method or one of the available overloads. The instance can also be used by the class and related classes to generate client proxy code or abstract server code. + + The class uses the to create a for each binding it identifies in the Web service class. If that attribute is not present, the class creates a single binding for the entire class. For each Web service method (a method in the Web service class appearing with the ) belonging to a binding, a class derived from generates an operation and associated messages that are added to the object. + + Typically, a developer uses these classes indirectly through the class, instead of directly invoking classes derived from . + ]]> @@ -169,11 +169,11 @@ Gets a object for a given XML namespace and the applicable communication protocol. A object for a given XML namespace and the applicable communication protocol. - instance obtained subsequently gets populated with objects that correspond to WSDL entities that are reflected from the input Web service class. - + instance obtained subsequently gets populated with objects that correspond to WSDL entities that are reflected from the input Web service class. + ]]> @@ -291,11 +291,11 @@ Gets the Web service methods belonging to the Web service class, as identified by the associated object's property. The Web service methods belonging to the Web service class, as identified by the associated object's property. - . - + . + ]]> @@ -321,11 +321,11 @@ Gets the abstract Web Services Description Language (WSDL) operation that the protocol reflector is currently generating from a Web service method. The abstract Web Services Description Language (WSDL) operation that the protocol reflector is currently generating from a Web service method. - . - + . + ]]> @@ -351,11 +351,11 @@ Gets the Web Services Description Language (WSDL) operation binding that the protocol importer is currently generating from a Web service method. The Web Services Description Language (WSDL) operation binding that the protocol importer is currently generating from a Web service method. - . - + . + ]]> @@ -519,11 +519,11 @@ When overridden in a derived class, generates method-specific information that gets placed in a object corresponding to a binding. Method-specific information that gets placed in a object corresponding to a binding. - method should generate information such as operation binding, abstract operation, and messages. - + method should generate information such as operation binding, abstract operation, and messages. + ]]> @@ -665,11 +665,11 @@ Gets the objects that have so far been created and added to the corresponding to the obtained through the property of the associated instance. The objects that have so far been created and added to the corresponding to the obtained through the property of the associated instance. - class creates a object for each binding, with a distinct namespace, that it finds in a Web service class. - + class creates a object for each binding, with a distinct namespace, that it finds in a Web service class. + ]]> @@ -695,11 +695,11 @@ Gets the type of the Web service class being reflected to produce objects. The type of the Web service class being reflected to produce objects. - . - + . + ]]> diff --git a/xml/System.Web.Services.Description/ServiceCollection.xml b/xml/System.Web.Services.Description/ServiceCollection.xml index a6a33a41992..70ceb39c0c4 100644 --- a/xml/System.Web.Services.Description/ServiceCollection.xml +++ b/xml/System.Web.Services.Description/ServiceCollection.xml @@ -32,11 +32,11 @@ Represents a collection of instances of the class. This class cannot be inherited. - class corresponds to the Web Services Description Language (WSDL) < `service` > element enclosed by the < `definitions` > root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - + class corresponds to the Web Services Description Language (WSDL) < `service` > element enclosed by the < `definitions` > root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + ]]> @@ -76,13 +76,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -123,13 +123,13 @@ if the parameter is a member of the ; otherwise, . - @@ -170,13 +170,13 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -253,13 +253,13 @@ Searches for the specified and returns the zero-based index of the first occurrence within the . A 32-bit signed integer. - @@ -300,28 +300,28 @@ The to add to the collection. Adds the specified instance to the at the specified zero-based index. - , the `service` parameter is added to the end of the `ServiceCollection`. - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples + , the `service` parameter is added to the end of the `ServiceCollection`. + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceDescription_Read/CPP/servicedescription_read.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceCollection/Insert/servicedescription_read.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceCollection/Insert/servicedescription_read.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceCollection/Insert/servicedescription_read.vb" id="Snippet3"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -370,13 +370,13 @@ Gets or sets the value of a at the specified zero-based index. A . - @@ -416,13 +416,13 @@ Gets a specified by its name. A . - @@ -461,20 +461,20 @@ The to remove from the collection. Removes the first occurrence of the specified from the . - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceCollection_Item/CPP/servicecollection_item.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceCollection/Add/servicecollection_item.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceCollection/Add/servicecollection_item.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceCollection/Add/servicecollection_item.vb" id="Snippet2"::: + ]]> diff --git a/xml/System.Web.Services.Description/ServiceDescription.xml b/xml/System.Web.Services.Description/ServiceDescription.xml index 731eb043e2c..963f8944411 100644 --- a/xml/System.Web.Services.Description/ServiceDescription.xml +++ b/xml/System.Web.Services.Description/ServiceDescription.xml @@ -48,22 +48,22 @@ Provides a means of creating and formatting a valid Web Services Description Language (WSDL) document file, complete with appropriate namespaces, elements, and attributes, for describing an XML Web service. This class cannot be inherited. - method, which parses a WSDL file and assigns its values to appropriate members of the class. - - WSDL is an XML-based language for describing XML Web services. The class corresponds to the root element, `definitions`, of a WSDL file. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples - The following example shows how to create an instance of the class. - + method, which parses a WSDL file and assigns its values to appropriate members of the class. + + WSDL is an XML-based language for describing XML Web services. The class corresponds to the root element, `definitions`, of a WSDL file. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples + The following example shows how to create an instance of the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceDescription/CPP/servicedescription.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescription/Overview/servicedescription.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Overview/servicedescription.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Overview/servicedescription.vb" id="Snippet1"::: + ]]> @@ -134,18 +134,18 @@ Gets the collection of elements contained in the . A collection of binding elements contained in the service description. - returned by this property corresponds to the list of `binding` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples + returned by this property corresponds to the list of `binding` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceDescription_Bindings/CPP/servicedescription_bindings.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescription/Bindings/servicedescription_bindings.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Bindings/servicedescription_bindings.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Bindings/servicedescription_bindings.vb" id="Snippet1"::: + ]]> @@ -186,13 +186,13 @@ if the can recognize the node on which the is positioned; otherwise . - @@ -237,13 +237,13 @@ Gets the collection of extensibility elements contained in the . The collection of extensibility elements contained in the . - @@ -285,18 +285,18 @@ Gets the collection of elements contained in the . A collection of import elements contained in the service description. - returned by this property corresponds to the list of `import` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples + returned by this property corresponds to the list of `import` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceDescription_Imports_Service/CPP/servicedescription_imports.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescription/Imports/servicedescription_imports.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Imports/servicedescription_imports.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Imports/servicedescription_imports.vb" id="Snippet1"::: + ]]> @@ -338,18 +338,18 @@ Gets the collection of elements contained in the . A collection of message elements contained in the service description. - returned by this property corresponds to the list of `message` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples + returned by this property corresponds to the list of `message` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceDescription_Constructor_4/CPP/servicedescription_constructor_4.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescription/Messages/servicedescription_constructor_4.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Messages/servicedescription_constructor_4.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Messages/servicedescription_constructor_4.vb" id="Snippet3"::: + ]]> @@ -414,13 +414,13 @@ The XML namespace in which the class is defined ("http://schemas.xmlsoap.org/wsdl/"). This field is constant. - @@ -462,18 +462,18 @@ Gets the collection of elements contained in the . A collection of elements contained in the . - returned by this property corresponds to the list of `portType` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples + returned by this property corresponds to the list of `portType` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceDescription_PortTypes_2/CPP/servicedescription_porttypes_2.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescription/CanRead/servicedescription_porttypes_2.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/CanRead/servicedescription_porttypes_2.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/CanRead/servicedescription_porttypes_2.vb" id="Snippet1"::: + ]]> @@ -523,13 +523,13 @@ Initializes an instance of the class by directly loading the XML from a instance. An instance of the . - @@ -569,13 +569,13 @@ Initializes an instance of the class by directly loading the XML from a . An instance of the . - @@ -615,13 +615,13 @@ Initializes an instance of a object by directly loading the XML from the specified file. An instance of the . - @@ -661,13 +661,13 @@ Initializes an instance of the class by directly loading the XML from an . An instance of the . - @@ -861,13 +861,13 @@ Gets or sets the URL of the XML Web service to which the instance applies. The URL of the XML Web service. The default value is an empty string (""). - @@ -941,11 +941,11 @@ Gets the XML serializer used to serialize and deserialize between a object and a Web Services Description Language (WSDL) document. The XML serializer used to serialize and deserialize between a object and a Web Services Description Language (WSDL) document. - class. These classes are specified in a configuration file using the `serviceDescriptionFormatExtensionTypes` element and its child `add` element. The configuration can be applied to an ASP.NET Web application that publishes a Web service. - + class. These classes are specified in a configuration file using the `serviceDescriptionFormatExtensionTypes` element and its child `add` element. The configuration can be applied to an ASP.NET Web application that publishes a Web service. + ]]> @@ -1027,18 +1027,18 @@ Gets the collection of instances contained in the . A collection of service instances contained in the service description. - returned by this property corresponds to the list of `service` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples + returned by this property corresponds to the list of `service` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceCollection_Item/CPP/servicecollection_item.cpp" id="Snippet4"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceCollection/Add/servicecollection_item.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceCollection/Add/servicecollection_item.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceCollection/Add/servicecollection_item.vb" id="Snippet4"::: + ]]> @@ -1080,13 +1080,13 @@ Gets or sets the XML attribute of the tag enclosing a Web Services Description Language (WSDL) file. The URL of the XML Web service described by the . - @@ -1128,18 +1128,18 @@ Gets or sets the contained by the . A instance that represents the data types of both the parameters and return values of the methods exposed by the XML Web service. - instance returned by this property corresponds to the list of `types` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - - -## Examples + instance returned by this property corresponds to the list of `types` elements enclosed by the Web Services Description Language (WSDL) `definitions` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceDescription_Types/CPP/servicedescription_types.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescription/Types/servicedescription_types.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Types/servicedescription_types.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescription/Types/servicedescription_types.vb" id="Snippet1"::: + ]]> @@ -1226,13 +1226,13 @@ A , passed by reference, which contains the Web Services Description Language (WSDL) file produced. Writes out the to the specified . - @@ -1307,13 +1307,13 @@ The path to which the WSDL file is written. Writes out the as a Web Services Description Language (WSDL) file to the specified path. - @@ -1352,11 +1352,11 @@ An , passed by reference, which contains the WSDL file produced. Writes out the to the as a Web Services Description Language (WSDL) file. - diff --git a/xml/System.Web.Services.Description/ServiceDescriptionCollection.xml b/xml/System.Web.Services.Description/ServiceDescriptionCollection.xml index 1f91faeb482..0097938ea0f 100644 --- a/xml/System.Web.Services.Description/ServiceDescriptionCollection.xml +++ b/xml/System.Web.Services.Description/ServiceDescriptionCollection.xml @@ -32,13 +32,13 @@ Represents a collection of instances of the class. This class cannot be inherited. - @@ -70,13 +70,13 @@ Initializes a new instance of the class. - @@ -116,13 +116,13 @@ Adds the specified to the end of the . The zero-based index where the parameter has been added. - @@ -163,12 +163,12 @@ if the parameter is a member of the ; otherwise, . - @@ -209,13 +209,13 @@ The zero-based index at which to start placing the copied collection. Copies the entire to a one-dimensional array of type , starting at the specified zero-based index of the target array. - @@ -255,13 +255,13 @@ Searches the and returns the with the specified name that is a member of one of the instances contained in the collection. The binding with the specified name. - The specified is not a member of any instances within the collection. @@ -339,13 +339,13 @@ Searches the and returns the with the specified name that is a member of one of the instances contained in the collection. The message with the specified name. - The specified is not a member of any instances within the collection. @@ -386,13 +386,13 @@ Searches the and returns the with the specified name that is a member of one of the instances contained in the collection. The with the specified name. - The specified is not a member of any instances within the collection. @@ -433,13 +433,13 @@ Searches the and returns the with the specified name that is a member of one of the instances contained in the collection. The service with the specified name. - The specified is not a member of any instances within the collection. @@ -480,12 +480,12 @@ Searches for the specified and returns the zero-based index of the first occurrence within the collection. The zero-based index of the specified service description, or -1 if the element was not found in the collection. - @@ -526,28 +526,28 @@ The to add to the collection. Adds the specified instance to the at the specified zero-based index. - , the `serviceDescription` parameter is added to the end of the . - - The elements after the insertion point move down to accommodate the new element. - - - -## Examples + , the `serviceDescription` parameter is added to the end of the . + + The elements after the insertion point move down to accommodate the new element. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/ServiceDescriptionCollection_Insert_Item_CopyTo/CPP/sdcollection_insert_item_copyto.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescriptionCollection/CopyTo/servicedescriptioncollection_insert_item_copyto.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescriptionCollection/CopyTo/servicedescriptioncollection_insert_item_copyto.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescriptionCollection/CopyTo/servicedescriptioncollection_insert_item_copyto.vb" id="Snippet1"::: + ]]> - The parameter is less than zero. - + The parameter is less than zero. + -or- - + The parameter is greater than . @@ -596,13 +596,13 @@ Gets or sets the value of a at the specified zero-based index. The value of a at the specified index. - @@ -642,13 +642,13 @@ Gets a specified by its property. A specified by its namespace property. - @@ -724,19 +724,19 @@ The to remove from the collection. Removes the first occurrence of the specified from the collection. - . - - The elements that follow the removed move up to occupy the vacated spot. - - - -## Examples + . + + The elements that follow the removed move up to occupy the vacated spot. + + + +## Examples :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescriptionCollection/Contains/servicedescriptioncollection_contains_indexof_remove.cs" id="Snippet3"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescriptionCollection/Contains/servicedescriptioncollection_contains_indexof_remove.vb" id="Snippet3"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Description/ServiceDescriptionCollection/Contains/servicedescriptioncollection_contains_indexof_remove.vb" id="Snippet3"::: + ]]> diff --git a/xml/System.Web.Services.Description/ServiceDescriptionFormatExtension.xml b/xml/System.Web.Services.Description/ServiceDescriptionFormatExtension.xml index aa0ec9776f5..e3a789e1bae 100644 --- a/xml/System.Web.Services.Description/ServiceDescriptionFormatExtension.xml +++ b/xml/System.Web.Services.Description/ServiceDescriptionFormatExtension.xml @@ -32,11 +32,11 @@ Represents an extensibility element added to an XML Web service. - at any of several levels within the class hierarchy. Thus many classes derived from the class (including the class) have an `Extensions` property, which returns a . - + at any of several levels within the class hierarchy. Thus many classes derived from the class (including the class) have an `Extensions` property, which returns a . + ]]> @@ -108,11 +108,11 @@ if the is used by the import process; otherwise, . The default is . - by using the method (which is used by the wsdl.exe tool). You can also use a custom class derived from the class to extend the import process to handle custom extensibility elements. - + by using the method (which is used by the wsdl.exe tool). You can also use a custom class derived from the class to extend the import process to handle custom extensibility elements. + ]]> @@ -150,11 +150,11 @@ Gets the parent of the . The parent of the . - namespace rather than the base class. - + namespace rather than the base class. + ]]> diff --git a/xml/System.Web.Services.Description/ServiceDescriptionFormatExtensionCollection.xml b/xml/System.Web.Services.Description/ServiceDescriptionFormatExtensionCollection.xml index 34c67cc15f6..e225e1c2966 100644 --- a/xml/System.Web.Services.Description/ServiceDescriptionFormatExtensionCollection.xml +++ b/xml/System.Web.Services.Description/ServiceDescriptionFormatExtensionCollection.xml @@ -540,7 +540,7 @@ ## Remarks If the number of items in the collection already equals the collection's capacity, the capacity is doubled by automatically reallocating the internal array before the new element is inserted. - If the `index` parameter is equal to , the `extension` parameter is added to the end of the . + If the `index` parameter is equal to , the `extension` parameter is added to the end of the . The elements after the insertion point move down to accommodate the new element. diff --git a/xml/System.Web.Services.Description/ServiceDescriptionImporter.xml b/xml/System.Web.Services.Description/ServiceDescriptionImporter.xml index bf16a4dc5f2..42d731ccd91 100644 --- a/xml/System.Web.Services.Description/ServiceDescriptionImporter.xml +++ b/xml/System.Web.Services.Description/ServiceDescriptionImporter.xml @@ -24,7 +24,7 @@ ## Remarks The interface to an XML Web service is typically described by a Web Services Description Language (WSDL) file. For example, to obtain a WSDL description of a Web service using ASP.NET exposed at `http://localhost/service.asmx`, simply navigate to `http://localhost/service.asmx?WSDL`. - The class allows you to easily import the information contained in a WSDL description into a object. By adjusting the value of the parameter, you can instruct a instance either to generate a client proxy class that provides the functionality of the Web service by transparently calling it or to generate an abstract class that encapsulates the functionality of the Web service without implementing it. + The class allows you to easily import the information contained in a WSDL description into a object. By adjusting the value of the parameter, you can instruct a instance either to generate a client proxy class that provides the functionality of the Web service by transparently calling it or to generate an abstract class that encapsulates the functionality of the Web service without implementing it. The code in the resulting object can then either be called directly or exported in the language of your choice. @@ -103,16 +103,16 @@ instances to the collection that is to be imported when the method is called. + Use this method to add instances to the collection that is to be imported when the method is called. - The two string parameters, `appSettingUrlKey` and `appSettingBaseUrl`, specify how to construct the `Url` property of the XML Web service proxy that is to be generated from the imported value. The `appSettingUrlKey` parameter specifies that the `Url` property should be read out of the web.config file's `` section by using the parameter value as the configuration key. If the `appSettingUrlKey` parameter is `null` or an empty string, the initial value is determined by the `location` attribute in the Web Services Description Language (WSDL) document. If the value of is `Server`, an error is raised if you attempt to set the value of the `appSettingUrlKey` parameter. + The two string parameters, `appSettingUrlKey` and `appSettingBaseUrl`, specify how to construct the `Url` property of the XML Web service proxy that is to be generated from the imported value. The `appSettingUrlKey` parameter specifies that the `Url` property should be read out of the web.config file's `` section by using the parameter value as the configuration key. If the `appSettingUrlKey` parameter is `null` or an empty string, the initial value is determined by the `location` attribute in the Web Services Description Language (WSDL) document. If the value of is `Server`, an error is raised if you attempt to set the value of the `appSettingUrlKey` parameter. The `appSettingBaseUrl` parameter specifies that the initial value for the `Url` property should be constructed from a combination of this parameter value and the URL specified by the `location` attribute in the WSDL document. The `appSettingUrlKey` parameter must also be specified. The `Url` property is constructed by combining a relative URL (constructed from the `appSettingBaseUrl` parameter and the WSDL-specified URL) with the URL loaded from the web.config file. If this parameter is `null` or an empty string, the URL is constructed entirely from the value in the web.config file. ## Examples - The following example illustrates the use of the method when using the class. + The following example illustrates the use of the method when using the class. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/WebServices_Description_Importer/CPP/import.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/ServiceDescriptionImporter/Overview/import.cs" id="Snippet1"::: @@ -150,7 +150,7 @@ property allows you to specify various options used when the method is called to generate code. For example, you can specify whether simple types described in the WSDL are generated as value types or namespace types, and whether they are generated as properties or fields. + The property allows you to specify various options used when the method is called to generate code. For example, you can specify whether simple types described in the WSDL are generated as value types or namespace types, and whether they are generated as properties or fields. @@ -263,7 +263,7 @@ values to import and the property of the code to generate, call the method to initiate code generation. + After you have specified the values to import and the property of the code to generate, call the method to initiate code generation. @@ -384,7 +384,7 @@ method to add members to this collection. + As with any collection that forms a read-only property, members can be added to the collection, removed from the collection, or modified using the methods exposed by the collection. You can also use the method to add members to this collection. diff --git a/xml/System.Web.Services.Description/ServiceDescriptionReflector.xml b/xml/System.Web.Services.Description/ServiceDescriptionReflector.xml index 15668ebab8f..71700331218 100644 --- a/xml/System.Web.Services.Description/ServiceDescriptionReflector.xml +++ b/xml/System.Web.Services.Description/ServiceDescriptionReflector.xml @@ -65,13 +65,13 @@ The address (URL) of the XML Web service. Creates a including the specified for the XML Web service at the specified URL. - is not supported, it modifies the Web Services Description Language (WSDL) file corresponding to the describing the XML Web service, in order to include that type. - - For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - + is not supported, it modifies the Web Services Description Language (WSDL) file corresponding to the describing the XML Web service, in order to include that type. + + For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + ]]> @@ -97,13 +97,13 @@ Gets a reference to the associated with the XML Web service. An collection. - of zero. Any members must be explicitly added using the collection's method. - - For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - + of zero. Any members must be explicitly added using the collection's method. + + For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + ]]> @@ -129,13 +129,13 @@ Gets a reference to the associated with the XML Web service. A reference to the associated with the XML Web service. - of zero. Any members must be explicitly added using the collection's method. - - For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - + of zero. Any members must be explicitly added using the collection's method. + + For more information about Web Services Description Language (WSDL), see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + ]]> diff --git a/xml/System.Web.Services.Description/SoapBodyBinding.xml b/xml/System.Web.Services.Description/SoapBodyBinding.xml index d181aa80371..2bee4fbfbf7 100644 --- a/xml/System.Web.Services.Description/SoapBodyBinding.xml +++ b/xml/System.Web.Services.Description/SoapBodyBinding.xml @@ -357,7 +357,7 @@ and properties depend on the value of this property. Their values should be set only if the value of this property is `Encoded`. Otherwise the XML Web service will produce unexpected behavior. + The and properties depend on the value of this property. Their values should be set only if the value of this property is `Encoded`. Otherwise the XML Web service will produce unexpected behavior. diff --git a/xml/System.Web.Services.Description/SoapExtensionImporter.xml b/xml/System.Web.Services.Description/SoapExtensionImporter.xml index 403879255d7..12a4710f420 100644 --- a/xml/System.Web.Services.Description/SoapExtensionImporter.xml +++ b/xml/System.Web.Services.Description/SoapExtensionImporter.xml @@ -21,7 +21,7 @@ `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. @@ -79,7 +79,7 @@ object maintains references to instances of derived types, and then calls the on each of those instances. + A object maintains references to instances of derived types, and then calls the on each of those instances. ]]> @@ -112,7 +112,7 @@ method. The attributes are added to all Web methods in a binding class. + The method to which the attribute declarations are applied is not used directly by the method. The attributes are added to all Web methods in a binding class. ]]> diff --git a/xml/System.Web.Services.Description/SoapExtensionReflector.xml b/xml/System.Web.Services.Description/SoapExtensionReflector.xml index 5f161fd2a3a..a660a7ffef3 100644 --- a/xml/System.Web.Services.Description/SoapExtensionReflector.xml +++ b/xml/System.Web.Services.Description/SoapExtensionReflector.xml @@ -21,9 +21,9 @@ class exposes an abstract method, . This abstract method allows a derived class to add descriptions of SOAP extensions when reflecting a Web method into objects that are placed in a object. The method itself is not an input. The descriptions get added for all Web methods belonging to a specified binding that produces a . + The abstract class exposes an abstract method, . This abstract method allows a derived class to add descriptions of SOAP extensions when reflecting a Web method into objects that are placed in a object. The method itself is not an input. The descriptions get added for all Web methods belonging to a specified binding that produces a . - You can use a to generate a Web Services Description Language (WSDL) document via the method. The class and related classes can also use a to generate client proxy code or abstract server code. + You can use a to generate a Web Services Description Language (WSDL) document via the method. The class and related classes can also use a to generate client proxy code or abstract server code. Use a class derived from the class in conjunction with a class derived from the abstract class to extend run-time processing of SOAP messages on the client or service. @@ -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. ]]> @@ -131,9 +131,9 @@ method is called for each Web method that belongs to a binding that the represents. The method does not use the Web method directly. The SOAP extension information gets added for all Web methods in a binding reflected from a Web service class. + The method is called for each Web method that belongs to a binding that the represents. The method does not use the Web method directly. The SOAP extension information gets added for all Web methods in a binding reflected from a Web service class. - An implementation of the can generate information like operation binding, `abstract` operation, and messages. + An implementation of the can generate information like operation binding, `abstract` operation, and messages. ]]> diff --git a/xml/System.Web.Services.Description/SoapProtocolImporter.xml b/xml/System.Web.Services.Description/SoapProtocolImporter.xml index b89811a2906..f624dffd415 100644 --- a/xml/System.Web.Services.Description/SoapProtocolImporter.xml +++ b/xml/System.Web.Services.Description/SoapProtocolImporter.xml @@ -73,7 +73,7 @@ method executes before the class generates methods that correspond to operations. + During generation of a class for a given binding, the method executes before the class generates methods that correspond to operations. ]]> @@ -103,7 +103,7 @@ method executes before the class generates classes that represent bindings. + During code generation, the method executes before the class generates classes that represent bindings. ]]> @@ -133,7 +133,7 @@ method executes after the class generates methods that correspond to operations. + During generation of a class for a given binding, the method executes after the class generates methods that correspond to operations. ]]> @@ -163,7 +163,7 @@ method executes after the class generates classes that represent bindings. + During code generation, the method executes after the class generates classes that represent bindings. ]]> @@ -194,7 +194,7 @@ method executes for each binding class method that represents an operation. + During generation of a class for a given binding, the method executes for each binding class method that represents an operation. ]]> @@ -226,7 +226,7 @@ method determines whether to generate a class for the current binding, as represented by the property. The method checks whether the property's property contains a instance. In addition, the transport mechanism obtained through the property must be supported by the current Web services configuration. + The method determines whether to generate a class for the current binding, as represented by the property. The method checks whether the property's property contains a instance. In addition, the transport mechanism obtained through the property must be supported by the current Web services configuration. ]]> @@ -261,7 +261,7 @@ method determines whether to generate a method for the current operation, as represented by the property. This evaluation takes place for each operation in a binding for which a class is being generated. If a `false` value is returned, the method executes. A `true` value is returned only if the input value is or . + The method determines whether to generate a method for the current operation, as represented by the property. This evaluation takes place for each operation in a binding for which a class is being generated. If a `false` value is returned, the method executes. A `true` value is returned only if the input value is or . For more information, see the property. The property is of type . diff --git a/xml/System.Web.Services.Description/Types.xml b/xml/System.Web.Services.Description/Types.xml index 3be973ecc09..6f43ed32cba 100644 --- a/xml/System.Web.Services.Description/Types.xml +++ b/xml/System.Web.Services.Description/Types.xml @@ -38,13 +38,13 @@ Describes data type definitions relevant to exchanged messages. This class cannot be inherited. - class, as its name might imply. Instead, it corresponds to the Web Services Description Language (WSDL) `` element enclosed by the `` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. - - The `Types` class has two read-only properties, and , representing the collections of data type definitions available to an XML Web service. - + class, as its name might imply. Instead, it corresponds to the Web Services Description Language (WSDL) `` element enclosed by the `` root element. For more information about WSDL, see the [WSDL](https://www.w3.org/TR/wsdl/) specification. + + The `Types` class has two read-only properties, and , representing the collections of data type definitions available to an XML Web service. + ]]> @@ -118,11 +118,11 @@ Gets the collection of elements included in the XML Web service. This property is read-only. A collection of extension elements included in the XML Web service. - class, this property returns an empty collection. - + class, this property returns an empty collection. + ]]> @@ -164,11 +164,11 @@ Gets the collection of XML schemas included as data type definitions for the XML Web service. This property is read-only. An collection. - class, this property returns an empty collection. - + class, this property returns an empty collection. + ]]> diff --git a/xml/System.Web.Services.Description/WebReference.xml b/xml/System.Web.Services.Description/WebReference.xml index 7ae471f707e..44158c58303 100644 --- a/xml/System.Web.Services.Description/WebReference.xml +++ b/xml/System.Web.Services.Description/WebReference.xml @@ -21,7 +21,7 @@ object is used to pass information about a set of Web services to the static method of the class. + A object is used to pass information about a set of Web services to the static method of the class. @@ -68,7 +68,7 @@ and objects; the method is unable to interpret objects. + The `documents` collection should contain only and objects; the method is unable to interpret objects. @@ -110,7 +110,7 @@ and objects; the method is unable to interpret objects. + The `documents` collection should contain only and objects; the method is unable to interpret objects. ]]> @@ -147,7 +147,7 @@ and objects; the method is unable to interpret objects. + The `documents` collection should contain only and objects; the method is unable to interpret objects. @@ -245,7 +245,7 @@ and objects; the method is unable to interpret objects. + The description document collection associated with a Web reference should contain only and objects; the method is unable to interpret objects. @@ -281,7 +281,7 @@ collection. + Allowed protocol strings include "Soap" (indicating SOAP 1.0) and "Soap12" (indicating SOAP 1.2). The value of this property determines the protocol used by proxy clients when contacting any XML Web service in the collection. For more information on SOAP, see the [World Wide Web Consortium](https://www.w3.org) website. diff --git a/xml/System.Web.Services.Description/WebReferenceCollection.xml b/xml/System.Web.Services.Description/WebReferenceCollection.xml index 3bc5a0ee53e..51c63dc89eb 100644 --- a/xml/System.Web.Services.Description/WebReferenceCollection.xml +++ b/xml/System.Web.Services.Description/WebReferenceCollection.xml @@ -20,7 +20,7 @@ objects when invoking the static method of the class. + Use this class to pass a collection of objects when invoking the static method of the class. @@ -128,7 +128,7 @@ method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/WebReferenceCollection/Contains/webreference.cs" id="Snippet10"::: @@ -169,7 +169,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/WebReferenceCollection/Contains/webreference.cs" id="Snippet10"::: @@ -209,7 +209,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/WebReferenceCollection/Contains/webreference.cs" id="Snippet10"::: @@ -250,7 +250,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/WebReferenceCollection/Contains/webreference.cs" id="Snippet10"::: @@ -329,7 +329,7 @@ ## Examples - The following code example shows how to use the method. + The following code example shows how to use the method. :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Description/WebReferenceCollection/Contains/webreference.cs" id="Snippet10"::: diff --git a/xml/System.Web.Services.Discovery/ContractReference.xml b/xml/System.Web.Services.Discovery/ContractReference.xml index 2c9da5b9484..c54abb6c6ee 100644 --- a/xml/System.Web.Services.Discovery/ContractReference.xml +++ b/xml/System.Web.Services.Discovery/ContractReference.xml @@ -30,7 +30,7 @@ ## Remarks XML Web services discovery involves discovering the available Web Services given an URL. The URL usually points to a discovery document, which typically has a.disco file name extension. Within a discovery document are references to information about the existence of XML Web services. These references can refer to service descriptions, XML Schema Definition language (XSD) schemas or other discovery documents. This class represents a reference to a Service Description. - Within a discovery document, a reference to a Service Description is contained within a `contractRef` XML element. The `contractRef` XML element has two attributes: `ref` and `docRef`. The `contractRef` element must have an XML namespace matching the constant, whereas the `ref` and `docRef` attributes are placed in the and properties. + Within a discovery document, a reference to a Service Description is contained within a `contractRef` XML element. The `contractRef` XML element has two attributes: `ref` and `docRef`. The `contractRef` element must have an XML namespace matching the constant, whereas the `ref` and `docRef` attributes are placed in the and properties. @@ -472,7 +472,7 @@ and properties of . + If the MIME type is `text/xml` and the contents of `stream` is a Service Description, then the contents of `stream` are added to the and properties of . ]]> diff --git a/xml/System.Web.Services.Discovery/ContractSearchPattern.xml b/xml/System.Web.Services.Discovery/ContractSearchPattern.xml index 0f352955ba2..9d4d945b9fb 100644 --- a/xml/System.Web.Services.Discovery/ContractSearchPattern.xml +++ b/xml/System.Web.Services.Discovery/ContractSearchPattern.xml @@ -19,11 +19,11 @@ Obtains the file locations and descriptions of ASP.NET Web services. This class cannot be inherited. - class inherits from the abstract class and is employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. - + class inherits from the abstract class and is employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. + ]]> @@ -75,13 +75,13 @@ Creates the object for the specified .asmx file. A object with the specified file name for its .asmx file. - class inherits from the abstract class. - - A instance contains the location of the .asmx file and the corresponding Web Services Description Language (WSDL) document, which can be dynamically obtained by appending a wsdl query string to the .asmx file path. - + class inherits from the abstract class. + + A instance contains the location of the .asmx file and the corresponding Web Services Description Language (WSDL) document, which can be dynamically obtained by appending a wsdl query string to the .asmx file path. + ]]> @@ -107,11 +107,11 @@ Gets the file name pattern to use as a search target. The literal string "*.asmx". - diff --git a/xml/System.Web.Services.Discovery/DiscoveryClientDocumentCollection.xml b/xml/System.Web.Services.Discovery/DiscoveryClientDocumentCollection.xml index f7ca585c34d..ee970bb4f43 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryClientDocumentCollection.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryClientDocumentCollection.xml @@ -130,7 +130,7 @@ method to determine if the discovery document contains a member with the URL stored in the `StringUrl` variable. + The following code example calls the method to determine if the discovery document contains a member with the URL stored in the `StringUrl` variable. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryClientDocumentCollection_Keys/CPP/discoveryclientdocumentcollection_keys.cpp" id="Snippet3"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientDocumentCollection/Contains/discoveryclientdocumentcollection_keys.cs" id="Snippet3"::: diff --git a/xml/System.Web.Services.Discovery/DiscoveryClientProtocol+DiscoveryClientResultsFile.xml b/xml/System.Web.Services.Discovery/DiscoveryClientProtocol+DiscoveryClientResultsFile.xml index 0898352fc15..ab4cbae7bd6 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryClientProtocol+DiscoveryClientResultsFile.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryClientProtocol+DiscoveryClientResultsFile.xml @@ -19,18 +19,18 @@ Represents the root element of an XML document containing the results of all files written when the method is invoked. - method, all resolved discovery documents and a file containing a map of all those files are saved to a directory. The map file is described in XML with the root element being ; this class is passed to the class to serialize the results. - - - -## Examples + method, all resolved discovery documents and a file containing a map of all those files are saved to a directory. The map file is described in XML with the root element being ; this class is passed to the class to serialize the results. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryClientResultsFile_Results/CPP/discoveryclientresultsfile_results.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientProtocol+DiscoveryClientResultsFile/Overview/discoveryclientresultsfile_results.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryClientProtocol+DiscoveryClientResultsFile/Overview/discoveryclientresultsfile_results.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryClientProtocol+DiscoveryClientResultsFile/Overview/discoveryclientresultsfile_results.vb" id="Snippet1"::: + ]]> @@ -75,11 +75,11 @@ Gets a collection of objects. A containing the results from a or invocation. - diff --git a/xml/System.Web.Services.Discovery/DiscoveryClientProtocol.xml b/xml/System.Web.Services.Discovery/DiscoveryClientProtocol.xml index 9a36726dff2..7f219fc10c4 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryClientProtocol.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryClientProtocol.xml @@ -24,14 +24,14 @@ ## Remarks XML Web service discovery is the process of locating, or discovering, one or more related documents that describe available XML Web services. It is through XML Web services discovery that XML Web service clients learn about the available XML Web services at a given URL and how to use them. XML Web services discovery works from the premise that you have already obtained the URL to a discovery document, possibly through a directory service, however, you do not have the details about the XML Web services offered. Through XML Web services discovery, you can discover the details about the XML Web services listed in a at a specific URL. - An XML Web service client starts XML Web services discovery by supplying a URL to either the or methods. Typically, this URL refers to a discovery document, which in turn refers to documents that describe one or more XML Web services, which are added to the property. At that point, only that document is downloaded and verified to point to valid information about XML Web services. However, the references contained in that document are not verified at this stage. Instead they are added to the property. To verify that the references are valid, invoke the or methods, which add valid referenced documents to the property. Last, if a client wants to save the discovery results to disk, invoke the method. + An XML Web service client starts XML Web services discovery by supplying a URL to either the or methods. Typically, this URL refers to a discovery document, which in turn refers to documents that describe one or more XML Web services, which are added to the property. At that point, only that document is downloaded and verified to point to valid information about XML Web services. However, the references contained in that document are not verified at this stage. Instead they are added to the property. To verify that the references are valid, invoke the or methods, which add valid referenced documents to the property. Last, if a client wants to save the discovery results to disk, invoke the method. If programmatic access to XML Web services discovery is not needed, the Windows SDK ships the Web Services Discovery tool (Disco.exe) for discovering XML Web services within a command prompt. For more details, see [Web Services Discovery Tool (Disco.exe)](https://msdn.microsoft.com/library/acd88078-c581-42bc-94ca-6633e2851979). ## Examples - The following code example is a Web Form demonstrating how to use the class together with the other classes in the namespace to programmatically invoke XML Web services discovery. The code example demonstrates using the , , , , , and methods. + The following code example is a Web Form demonstrating how to use the class together with the other classes in the namespace to programmatically invoke XML Web services discovery. The code example demonstrates using the , , , , , and methods. > [!IMPORTANT] > This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -130,14 +130,14 @@ method expects that the supplied URL is a discovery document. If the URL refers to a service description or an XML schema an exception is thrown. To discover an XML schema or a service description invoke the method. + The method expects that the supplied URL is a discovery document. If the URL refers to a service description or an XML schema an exception is thrown. To discover an XML schema or a service description invoke the method. - If the supplied URL points to a valid discovery document, the discovery document at the supplied URL is added to the and collection. Additionally, references within the discovery document are added to the collection, but not verified to point to valid discovery documents. To verify the references, point to valid discovery documents to invoke the or methods. + If the supplied URL points to a valid discovery document, the discovery document at the supplied URL is added to the and collection. Additionally, references within the discovery document are added to the collection, but not verified to point to valid discovery documents. To verify the references, point to valid discovery documents to invoke the or methods. ## Examples - The following code example is a Web Form that populates a with the details about the documents in the property together with the references found in each document during XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . + The following code example is a Web Form that populates a with the details about the documents in the property together with the references found in each document during XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . [!code-csharp[DiscoveryClientProtocol.Discover#1](~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientProtocol/Discover/discocs.aspx#1)] [!code-vb[DiscoveryClientProtocol.Discover#1](~/snippets/visualbasic/VS_Snippets_Remoting/DiscoveryClientProtocol.Discover/VB/discovb.aspx#1)] @@ -176,14 +176,14 @@ method discovers whether the supplied URL is a discovery document, service description or XSD schema. If it is known that the URL only refers to a discovery document, the method might be invoked. + The method discovers whether the supplied URL is a discovery document, service description or XSD schema. If it is known that the URL only refers to a discovery document, the method might be invoked. - If the supplied URL points to a valid discovery document, XSD schema, or service description, the discovery document at the supplied URL is added to the and collections. When the supplied URL refers to an XSD schema or Service Description a is created in memory and added to the and collections. Additionally, references within the discovery document are added to the collection, but not verified to point to valid discovery documents. To verify that references point to valid discovery documents, invoke the or methods. + If the supplied URL points to a valid discovery document, XSD schema, or service description, the discovery document at the supplied URL is added to the and collections. When the supplied URL refers to an XSD schema or Service Description a is created in memory and added to the and collections. Additionally, references within the discovery document are added to the collection, but not verified to point to valid discovery documents. To verify that references point to valid discovery documents, invoke the or methods. ## Examples - The following code example is a Web Form that populates a with the details about the documents in the property together with the references found in each document during an XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . + The following code example is a Web Form that populates a with the details about the documents in the property together with the references found in each document during an XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . [!code-csharp[DiscoveryClientProtocol.DiscoverAny#1](~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientProtocol/DiscoverAny/discocs.aspx#1)] [!code-vb[DiscoveryClientProtocol.DiscoverAny#1](~/snippets/visualbasic/VS_Snippets_Remoting/DiscoveryClientProtocol.DiscoverAny/VB/discovb.aspx#1)] @@ -218,12 +218,12 @@ collection is populated during invocations to the , , and methods. During invocations to the and methods, if the supplied URL is a valid discovery document, that document is added to the collection. During invocations to the and methods, valid discovery document references in the collection are added to the collection. + The collection is populated during invocations to the , , and methods. During invocations to the and methods, if the supplied URL is a valid discovery document, that document is added to the collection. During invocations to the and methods, valid discovery document references in the collection are added to the collection. ## Examples - The following code example is a Web Form that populates a with the details about the documents in the property discovered during XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . + The following code example is a Web Form that populates a with the details about the documents in the property discovered during XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . > [!IMPORTANT] > This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -350,7 +350,7 @@ collection is populated with exceptions that occurred during invocations to the , , , and methods. The is cleared on invocation of these methods. + The collection is populated with exceptions that occurred during invocations to the , , , and methods. The is cleared on invocation of these methods. @@ -424,14 +424,14 @@ method or Disco.exe. + A file containing a map of saved discovery documents can be created by the method or Disco.exe. The `topLevelFilename` parameter must include the fully qualified path if the file does not exist in the current directory. ## Examples - The following code example is a Web Form that populates a with the details about the documents and references found in an existing discovery map document using the method. + The following code example is a Web Form that populates a with the details about the documents and references found in an existing discovery map document using the method. [!code-csharp[DiscoveryClientProtocol.ReadAll#1](~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientProtocol/ReadAll/discocs.aspx#1)] [!code-vb[DiscoveryClientProtocol.ReadAll#1](~/snippets/visualbasic/VS_Snippets_Remoting/DiscoveryClientProtocol.ReadAll/VB/discovb.aspx#1)] @@ -464,12 +464,12 @@ collection is populated during invocations to the , , and methods. During invocations to the and methods, if the supplied URL is a valid discovery document, that document is added to the collection together with references found in the discovery document. References added during invocations to the and methods are not necessarily valid discovery documents. During invocations to and references within the collection are verified as being valid discovery documents. If they are valid and contain references, they are also added to the collection. + The collection is populated during invocations to the , , and methods. During invocations to the and methods, if the supplied URL is a valid discovery document, that document is added to the collection together with references found in the discovery document. References added during invocations to the and methods are not necessarily valid discovery documents. During invocations to and references within the collection are verified as being valid discovery documents. If they are valid and contain references, they are also added to the collection. ## Examples - The following code example is a Web Form that populates a with the details about the references in the property discovered during an XML Web services discovery. The `PopulateGrid` method fills the with the references found in an invocation to . + The following code example is a Web Form that populates a with the details about the references in the property discovered during an XML Web services discovery. The `PopulateGrid` method fills the with the references found in an invocation to . > [!IMPORTANT] > This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -505,14 +505,14 @@ resolves all valid references it finds and places them in the property. Both and download and verify XSD schemas and service descriptions in the property. However, the two methods differ in how they handle discovery documents. resolves all references in discovery documents within the property; if a discovery document contains references to other discovery documents, resolves just those discovery documents. Discovery documents found in those discovery documents nested one level deep are not resolved by ; whereas resolves them all. continues to resolve references in nested discovery documents until there are no more references. + resolves all valid references it finds and places them in the property. Both and download and verify XSD schemas and service descriptions in the property. However, the two methods differ in how they handle discovery documents. resolves all references in discovery documents within the property; if a discovery document contains references to other discovery documents, resolves just those discovery documents. Discovery documents found in those discovery documents nested one level deep are not resolved by ; whereas resolves them all. continues to resolve references in nested discovery documents until there are no more references. - Errors occurring during the verification process done by are not thrown at the time of occurrence, but rather collected and added to the property. + Errors occurring during the verification process done by are not thrown at the time of occurrence, but rather collected and added to the property. ## Examples - The following code example is a Web Form that populates a with the details about the documents in the property together with the references found in each document during an XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . + The following code example is a Web Form that populates a with the details about the documents in the property together with the references found in each document during an XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . [!code-csharp[DiscoveryClientProtocol.ResolveAll#1](~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientProtocol/ResolveAll/discocs.aspx#1)] [!code-vb[DiscoveryClientProtocol.ResolveAll#1](~/snippets/visualbasic/VS_Snippets_Remoting/DiscoveryClientProtocol.ResolveAll/VB/discovb.aspx#1)] @@ -545,14 +545,14 @@ resolves all valid references it finds and places them in the property. Both and download and verify XSD schemas and service descriptions in the property. However, the two methods differ in how they handle discovery documents. resolves all references in discovery documents within the property. If a discovery document contains references to other discovery documents, resolves just those discovery documents. Discovery documents found in those discovery documents nested one level deep are not resolved by ; whereas resolve them all. continues to resolve references in nested discovery documents until there are no more references. + resolves all valid references it finds and places them in the property. Both and download and verify XSD schemas and service descriptions in the property. However, the two methods differ in how they handle discovery documents. resolves all references in discovery documents within the property. If a discovery document contains references to other discovery documents, resolves just those discovery documents. Discovery documents found in those discovery documents nested one level deep are not resolved by ; whereas resolve them all. continues to resolve references in nested discovery documents until there are no more references. - Errors occurring during the verification process done by are not thrown at the time of occurrence, but rather collected and added to the property. + Errors occurring during the verification process done by are not thrown at the time of occurrence, but rather collected and added to the property. ## Examples - The following code example is a Web Form that populates a with the details about the documents in the property together with the references found in each document during an XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . + The following code example is a Web Form that populates a with the details about the documents in the property together with the references found in each document during an XML Web services discovery. The `PopulateGrid` method fills the with the results from a invocation followed by a call to . [!code-csharp[DiscoveryClientProtocol.ResolveOneLevel#1](~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientProtocol/ResolveOneLevel/discocs.aspx#1)] [!code-vb[DiscoveryClientProtocol.ResolveOneLevel#1](~/snippets/visualbasic/VS_Snippets_Remoting/DiscoveryClientProtocol.ResolveOneLevel/VB/discovb.aspx#1)] @@ -591,14 +591,14 @@ method to populate the and properties. The format of the file is XML containing an serialized version of the class. + The file created with the name of the `topLevelFilename` parameter in the directory specified by the directory parameter contains a map of saved discovery documents, XML Schema Definition (XSD) schemas and service descriptions. This file can be read in using the method to populate the and properties. The format of the file is XML containing an serialized version of the class. - If a file exists with the same name as the `topLevelFilename` parameter in the `directory` parameter, that file is overwritten by the method. The `topLevelFilename` parameter must include the fully qualified path if the file does not exist in the current directory. + If a file exists with the same name as the `topLevelFilename` parameter in the `directory` parameter, that file is overwritten by the method. The `topLevelFilename` parameter must include the fully qualified path if the file does not exist in the current directory. ## Examples - The following code example is a Web Form that writes the results of a Web Services discovery to disk by invoking the method after calls to and . + The following code example is a Web Form that writes the results of a Web Services discovery to disk by invoking the method after calls to and . [!code-csharp[DiscoveryClientProtocol.WriteAll#1](~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientProtocol/WriteAll/discocs.aspx#1)] [!code-vb[DiscoveryClientProtocol.WriteAll#1](~/snippets/visualbasic/VS_Snippets_Remoting/DiscoveryClientProtocol.WriteAll/VB/discovb.aspx#1)] diff --git a/xml/System.Web.Services.Discovery/DiscoveryClientResult.xml b/xml/System.Web.Services.Discovery/DiscoveryClientResult.xml index a57293aabb5..25b54031c4e 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryClientResult.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryClientResult.xml @@ -19,20 +19,20 @@ Represents the details of a discovery reference without the contents of the referenced document. This class cannot be inherited. - method of , all valid referenced documents and a file containing a map of all save documents can be written to disk. The file containing a map of all saved documents contains the details of each document as summarized by the properties of . - - After the referenced documents and the map of the referenced documents have been written to disk using the method, you can invoke the method to read the discovery documents. - - - -## Examples + method of , all valid referenced documents and a file containing a map of all save documents can be written to disk. The file containing a map of all saved documents contains the details of each document as summarized by the properties of . + + After the referenced documents and the map of the referenced documents have been written to disk using the method, you can invoke the method to read the discovery documents. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryClientResult/CPP/discoveryclientresult.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientResult/Overview/discoveryclientresult.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryClientResult/Overview/discoveryclientresult.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryClientResult/Overview/discoveryclientresult.vb" id="Snippet1"::: + ]]> @@ -64,13 +64,13 @@ Initializes a new instance of the class. - @@ -100,13 +100,13 @@ Name of the file in which the reference was saved. Sets the property. Initializes a new instance of the class and sets the property to , the property to and the property to . - @@ -138,18 +138,18 @@ Gets or sets the name of the file in which the reference is saved. Name of the file in which the reference is saved. - @@ -181,18 +181,18 @@ Name of the class representing the type of reference in the discovery document. Name of the class representing the type of a reference. Default value is . - can have the following values: , , and . - - - -## Examples + can have the following values: , , and . + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryClientResult_Filename/CPP/discoveryclientresult_filename.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryClientResult/.ctor/discoveryclientresult_filename.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryClientResult/.ctor/discoveryclientresult_filename.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryClientResult/.ctor/discoveryclientresult_filename.vb" id="Snippet2"::: + ]]> @@ -224,18 +224,18 @@ Gets or sets the URL for the reference. The URL of the reference. - diff --git a/xml/System.Web.Services.Discovery/DiscoveryDocument.xml b/xml/System.Web.Services.Discovery/DiscoveryDocument.xml index 02db372a05b..d7e85174213 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryDocument.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryDocument.xml @@ -33,7 +33,7 @@ ## Examples - The following code example reads a discovery document from a file using the and writes it back out to file using the method. + The following code example reads a discovery document from a file using the and writes it back out to file using the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryDocument/CPP/discoverydocument.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryDocument/Overview/discoverydocument.cs" id="Snippet1"::: @@ -340,7 +340,7 @@ method. + The following code example writes a discovery document out to a file named `log.txt` using the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryDocument_Write1/CPP/discoverydocument_write1.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryDocument/Write/discoverydocument_write1.cs" id="Snippet1"::: diff --git a/xml/System.Web.Services.Discovery/DiscoveryDocumentLinksPattern.xml b/xml/System.Web.Services.Discovery/DiscoveryDocumentLinksPattern.xml index 669acae9cc9..d19efbbdd2d 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryDocumentLinksPattern.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryDocumentLinksPattern.xml @@ -19,11 +19,11 @@ Obtains the file locations of Web services discovery documents for use in populating another Web services discovery document. - class inherits from the abstract class and is employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. - + class inherits from the abstract class and is employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. + ]]> @@ -74,13 +74,13 @@ Returns the object for a given discovery document. A object that specifies the location of a .vsdisco file. - class inherits from the abstract class. - - A instance contains the location of the .vsdisco file, which is also the file system directory corresponding to the HTTP request passed to the method. - + class inherits from the abstract class. + + A instance contains the location of the .vsdisco file, which is also the file system directory corresponding to the HTTP request passed to the method. + ]]> @@ -106,11 +106,11 @@ Gets the file-name pattern to use as a search target. The literal string "*.disco". - class, on the other hand, indicates a .vsdisco extension. - + class, on the other hand, indicates a .vsdisco extension. + ]]> diff --git a/xml/System.Web.Services.Discovery/DiscoveryDocumentReference.xml b/xml/System.Web.Services.Discovery/DiscoveryDocumentReference.xml index d8182787a4b..c98e7424ee6 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryDocumentReference.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryDocumentReference.xml @@ -182,7 +182,7 @@ property of , an attempt to download and resolve the document is made. + If the discovery document has not been downloaded and added to the property of , an attempt to download and resolve the document is made. @@ -336,9 +336,9 @@ object, you should invoke the or methods of . + Unless you specifically need to resolve the individual references of a object, you should invoke the or methods of . - This method resolves all references to discovery documents, XSD schemas, and Service Descriptions in the property of and any references found in referring discovery documents. + This method resolves all references to discovery documents, XSD schemas, and Service Descriptions in the property of and any references found in referring discovery documents. diff --git a/xml/System.Web.Services.Discovery/DiscoveryDocumentSearchPattern.xml b/xml/System.Web.Services.Discovery/DiscoveryDocumentSearchPattern.xml index 6b5a7e48a8d..17ddc87ff55 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryDocumentSearchPattern.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryDocumentSearchPattern.xml @@ -19,11 +19,11 @@ Obtains the file locations of Web services discovery documents for use in populating another Web services discovery document. This class cannot be inherited. - class inherits from the abstract class and is employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. - + class inherits from the abstract class and is employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. + ]]> @@ -75,13 +75,13 @@ Returns the object for a given discovery document. A object that specifies the location of a .vsdisco file. - class inherits from the abstract class. - - A instance contains the location of the .vsdisco file, which is also the file system directory corresponding to the HTTP request passed to the method. - + class inherits from the abstract class. + + A instance contains the location of the .vsdisco file, which is also the file system directory corresponding to the HTTP request passed to the method. + ]]> @@ -107,11 +107,11 @@ Gets the file name pattern to use as a search target. The literal string "*.vsdisco". - class, on the other hand, indicates a .disco extension. - + class, on the other hand, indicates a .disco extension. + ]]> diff --git a/xml/System.Web.Services.Discovery/DiscoveryReference.xml b/xml/System.Web.Services.Discovery/DiscoveryReference.xml index 7d29ff984d1..ce58a7e4692 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryReference.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryReference.xml @@ -19,18 +19,18 @@ The base class for discoverable references using XML Web services discovery. - , , and all inherit from , and represent the three types of documents discoverable through XML Web services discovery: Service Descriptions, XML Schema Definition (XSD) schemas, and discovery documents, respectively. - - - -## Examples + , , and all inherit from , and represent the three types of documents discoverable through XML Web services discovery: Service Descriptions, XML Schema Definition (XSD) schemas, and discovery documents, respectively. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryReference1/CPP/discoveryreference.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryReference/Overview/discoveryreference.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryReference/Overview/discoveryreference.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryReference/Overview/discoveryreference.vb" id="Snippet1"::: + ]]> @@ -84,13 +84,13 @@ Gets or sets the instance of used in a discovery process. An instance of used in a discovery process. - @@ -122,13 +122,13 @@ Gets the name of the default file to use when saving the referenced discovery document, XSD schema, or Service Description. Name of the default file to use when saving the referenced document. - @@ -190,18 +190,18 @@ Reads the passed and returns an instance of the class representing the type of referenced document. An with an underlying type matching the type of referenced document. - . However, the underlying type varies, depending on the type of document referenced. For instance, a passed into returns an instance of . - - - -## Examples + . However, the underlying type varies, depending on the type of document referenced. For instance, a passed into returns an instance of . + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryReference/CPP/discoveryreference.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryReference/ClientProtocol/discoveryreference.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryReference/ClientProtocol/discoveryreference.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryReference/ClientProtocol/discoveryreference.vb" id="Snippet1"::: + ]]> @@ -237,18 +237,18 @@ Downloads the referenced document at to resolve whether the referenced document is valid. - member that takes a MIME type and a . If the MIME type and the contents of `stream` match those expected by the reference type, then the contents of `stream` are added to the and properties of . - - - -## Examples + member that takes a MIME type and a . If the MIME type and the contents of `stream` match those expected by the reference type, then the contents of `stream` are added to the and properties of . + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/DiscoveryReference/CPP/discoveryreference.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Discovery/DiscoveryReference/ClientProtocol/discoveryreference.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryReference/ClientProtocol/discoveryreference.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Discovery/DiscoveryReference/ClientProtocol/discoveryreference.vb" id="Snippet1"::: + ]]> The property is . @@ -280,11 +280,11 @@ The containing the referenced document. Resolves whether the referenced document is valid. - and properties of . - + and properties of . + ]]> @@ -316,13 +316,13 @@ Gets or sets the URL of the referenced document. The URL of the referenced document. - @@ -353,11 +353,11 @@ The into which the is written. When overridden in a derived class, writes the document to a . - diff --git a/xml/System.Web.Services.Discovery/DiscoveryRequestHandler.xml b/xml/System.Web.Services.Discovery/DiscoveryRequestHandler.xml index cc2c4d23c38..a16d041cd1f 100644 --- a/xml/System.Web.Services.Discovery/DiscoveryRequestHandler.xml +++ b/xml/System.Web.Services.Discovery/DiscoveryRequestHandler.xml @@ -25,7 +25,7 @@ class, via its method, processes an HTTP request for a discovery document. A discovery document is represented by the class and is usually serialized as a file using a .disco extension. Web services discovery provides a mechanism for determining the Web services that are available at a given location. + The class, via its method, processes an HTTP request for a discovery document. A discovery document is represented by the class and is usually serialized as a file using a .disco extension. Web services discovery provides a mechanism for determining the Web services that are available at a given location. The class normally does not need to be used directly by a developer. @@ -110,7 +110,7 @@ method searches for applicable files within the file system path corresponding to the HTTP request's Uniform Resource Locator (URL). The search may extend to subdirectories and switch target file extensions depending on what it finds in the root search directory. + The method searches for applicable files within the file system path corresponding to the HTTP request's Uniform Resource Locator (URL). The search may extend to subdirectories and switch target file extensions depending on what it finds in the root search directory. The search process populates the object's property with files that are found. diff --git a/xml/System.Web.Services.Discovery/DiscoverySearchPattern.xml b/xml/System.Web.Services.Discovery/DiscoverySearchPattern.xml index fc1289107a9..b0896b4e21d 100644 --- a/xml/System.Web.Services.Discovery/DiscoverySearchPattern.xml +++ b/xml/System.Web.Services.Discovery/DiscoverySearchPattern.xml @@ -24,7 +24,7 @@ ## Remarks You can use the property to add a discoverable file type to a Web services document. While a discovery document is usually serialized as a file using a .disco extension, you can add multiple files to the property, and those files can have other extensions, represented by implementations of . - The class and its concrete derived classes are employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. + The class and its concrete derived classes are employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. ]]> @@ -79,7 +79,7 @@ implements the method by returning its associated concrete class derived from . + A class derived from implements the method by returning its associated concrete class derived from . For example, the class returns a instance that contains the location of an .asmx Web service file and the corresponding dynamically generated Web Services Description Language (WSDL) document. diff --git a/xml/System.Web.Services.Discovery/DynamicDiscoveryDocument.xml b/xml/System.Web.Services.Discovery/DynamicDiscoveryDocument.xml index 9666b0013a5..42cd625cc8e 100644 --- a/xml/System.Web.Services.Discovery/DynamicDiscoveryDocument.xml +++ b/xml/System.Web.Services.Discovery/DynamicDiscoveryDocument.xml @@ -28,7 +28,7 @@ class is employed by the class's method, which handles an HTTP request for a discovery document. The request specifies another document, an XML dynamic discovery document containing a list of directories to exclude. The list corresponds to the class's property and contains directories at or below the directory containing the XML document. + The class is employed by the class's method, which handles an HTTP request for a discovery document. The request specifies another document, an XML dynamic discovery document containing a list of directories to exclude. The list corresponds to the class's property and contains directories at or below the directory containing the XML document. Normally, none of these classes need to be used directly by a developer. diff --git a/xml/System.Web.Services.Discovery/ExcludePathInfo.xml b/xml/System.Web.Services.Discovery/ExcludePathInfo.xml index dee8d335f8c..377099979ea 100644 --- a/xml/System.Web.Services.Discovery/ExcludePathInfo.xml +++ b/xml/System.Web.Services.Discovery/ExcludePathInfo.xml @@ -22,7 +22,7 @@ class is employed by the class's method, which handles an HTTP request for a discovery document. The class's property contains a collection of instances. + The class is employed by the class's method, which handles an HTTP request for a discovery document. The class's property contains a collection of instances. Normally, none of these classes need to be used directly by a developer. diff --git a/xml/System.Web.Services.Discovery/SchemaReference.xml b/xml/System.Web.Services.Discovery/SchemaReference.xml index 6e4f141bddc..c399ed01d47 100644 --- a/xml/System.Web.Services.Discovery/SchemaReference.xml +++ b/xml/System.Web.Services.Discovery/SchemaReference.xml @@ -333,7 +333,7 @@ property of , an attempt to download and resolve the document is made. + If the XSD schema has not been downloaded and added to the property of , an attempt to download and resolve the document is made. diff --git a/xml/System.Web.Services.Discovery/XmlSchemaSearchPattern.xml b/xml/System.Web.Services.Discovery/XmlSchemaSearchPattern.xml index 65a38906d71..c24415fbb7e 100644 --- a/xml/System.Web.Services.Discovery/XmlSchemaSearchPattern.xml +++ b/xml/System.Web.Services.Discovery/XmlSchemaSearchPattern.xml @@ -19,11 +19,11 @@ Obtains the file locations of XML Schema documents for use in populating a Web services discovery document. This class cannot be inherited. - class inherits from the abstract class and is employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. - + class inherits from the abstract class and is employed by the class's method, which handles an HTTP request for a discovery document. Normally, none of these classes need to be used directly by a developer. + ]]> @@ -75,13 +75,13 @@ Returns the object for a given discovery document. A object that specifies the file name for an XML Schema document. - class inherits from the abstract class. - - A instance contains the location of the .xsd file. - + class inherits from the abstract class. + + A instance contains the location of the .xsd file. + ]]> @@ -107,11 +107,11 @@ Gets the file name pattern to use as a search target. The literal string "*.xsd". - diff --git a/xml/System.Web.Services.Protocols/AnyReturnReader.xml b/xml/System.Web.Services.Protocols/AnyReturnReader.xml index eb857f07319..31f34c62151 100644 --- a/xml/System.Web.Services.Protocols/AnyReturnReader.xml +++ b/xml/System.Web.Services.Protocols/AnyReturnReader.xml @@ -78,9 +78,9 @@ method. For the class, the initializer is the instance referred to by the keyword `this`, unless the parameter value has a void return type, in which case the initializer is set to `null`. + An initializer is an object passed as a parameter to the method. For the class, the initializer is the instance referred to by the keyword `this`, unless the parameter value has a void return type, in which case the initializer is set to `null`. - The method is invoked during service initialization. Later, at the time a response is processed, the initializer object is passed to the method of another instance. The other instance takes the call to the method. + The method is invoked during service initialization. Later, at the time a response is processed, the initializer object is passed to the method of another instance. The other instance takes the call to the method. ]]> @@ -113,7 +113,7 @@ method does nothing. + The method does nothing. This method is invoked at the time a response is processed. The input parameter, `initializer`, is another instance of , obtained during client initialization. @@ -151,7 +151,7 @@ class's implementation of the method does no reading. Instead it simply returns the object passed as a parameter. + The class's implementation of the method does no reading. Instead it simply returns the object passed as a parameter. ]]> diff --git a/xml/System.Web.Services.Protocols/HtmlFormParameterReader.xml b/xml/System.Web.Services.Protocols/HtmlFormParameterReader.xml index af02eee8bb8..cff15d2ab97 100644 --- a/xml/System.Web.Services.Protocols/HtmlFormParameterReader.xml +++ b/xml/System.Web.Services.Protocols/HtmlFormParameterReader.xml @@ -21,7 +21,7 @@ and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. The service-side class provides a method to read parameter name-value pairs that are encoded into the body of an HTTP request with the MIME type `application/x-www-form-urlencoded`. + and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. The service-side class provides a method to read parameter name-value pairs that are encoded into the body of an HTTP request with the MIME type `application/x-www-form-urlencoded`. You typically will not need to use directly. HTTP-POST Web services are enabled when an ASP.NET configuration file's (Web.config) [\ Element](https://msdn.microsoft.com/library/f3b301dc-855c-4062-8bcf-5ccadb598fab) element contains an [\ Element for \](https://msdn.microsoft.com/library/abaa41b9-aa8b-469f-8ae5-e58c4d3a2921) element whose `name` attribute's value is "HttpPost". The class is automatically used when an HTTP-POST Web service is enabled and an applicable HTTP request is received. @@ -79,7 +79,7 @@ method uses the content of the object's property. + The method uses the content of the object's property. ]]> diff --git a/xml/System.Web.Services.Protocols/HtmlFormParameterWriter.xml b/xml/System.Web.Services.Protocols/HtmlFormParameterWriter.xml index de434cb6e64..df101046dd3 100644 --- a/xml/System.Web.Services.Protocols/HtmlFormParameterWriter.xml +++ b/xml/System.Web.Services.Protocols/HtmlFormParameterWriter.xml @@ -111,7 +111,7 @@ property determines whether the method is invoked. + The property determines whether the method is invoked. ]]> @@ -146,7 +146,7 @@ method calls the method. + The method calls the method. ]]> diff --git a/xml/System.Web.Services.Protocols/HttpGetClientProtocol.xml b/xml/System.Web.Services.Protocols/HttpGetClientProtocol.xml index cbfe52cc7b8..12b98de9967 100644 --- a/xml/System.Web.Services.Protocols/HttpGetClientProtocol.xml +++ b/xml/System.Web.Services.Protocols/HttpGetClientProtocol.xml @@ -107,7 +107,7 @@ to specify that the HTTP request to the XML Web service is made using HTTP-GET. By overriding this method, additional customizations can be made to the object before the XML Web service request is made. For example you could add a custom header to the request. + This method overrides the base version of to specify that the HTTP request to the XML Web service is made using HTTP-GET. By overriding this method, additional customizations can be made to the object before the XML Web service request is made. For example you could add a custom header to the request. ]]> diff --git a/xml/System.Web.Services.Protocols/HttpMethodAttribute.xml b/xml/System.Web.Services.Protocols/HttpMethodAttribute.xml index d94b4cfeffd..a448b592405 100644 --- a/xml/System.Web.Services.Protocols/HttpMethodAttribute.xml +++ b/xml/System.Web.Services.Protocols/HttpMethodAttribute.xml @@ -25,20 +25,20 @@ Applying this attribute to an XML Web service client using HTTP-GET or HTTP-POST, sets the types that serialize the parameters sent to an XML Web service method and read the response from the XML Web service method. This class cannot be inherited. - must be set to `XmlReturnReader` and set to `UrlParameterWriter`. XML Web service clients invoking a XML Web service using HTTP-POST must set to `XmlReturnReader` and to `HtmlFormParameterWriter`. - - - -## Examples - The following example is a proxy class generated by the Wsdl.exe utility for calling an XML Web service utility using HTTP-POST. The Wsdl.exe automatically supplies the correct types for and , along with specifying that the proxy class inherits from . - + must be set to `XmlReturnReader` and set to `UrlParameterWriter`. XML Web service clients invoking a XML Web service using HTTP-POST must set to `XmlReturnReader` and to `HtmlFormParameterWriter`. + + + +## Examples + The following example is a proxy class generated by the Wsdl.exe utility for calling an XML Web service utility using HTTP-POST. The Wsdl.exe automatically supplies the correct types for and , along with specifying that the proxy class inherits from . + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Classic HttpMethodAttribute Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/HttpMethodAttribute/Overview/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Protocols/HttpMethodAttribute/Overview/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Protocols/HttpMethodAttribute/Overview/source.vb" id="Snippet1"::: + ]]> @@ -120,20 +120,20 @@ Gets or sets a that serializes parameters sent from an XML Web service client to the XML Web service method. A that serializes parameters sent from an XML Web service client to an XML Web service method. There is no default. - must be `XMLReturnReader`. - - - -## Examples - The example is a proxy class generated by the Wsdl.exe utility for an XML Web service client using HTTP-GET, setting to the required value of `XMLReturnReader`. - + must be `XMLReturnReader`. + + + +## Examples + The example is a proxy class generated by the Wsdl.exe utility for an XML Web service client using HTTP-GET, setting to the required value of `XMLReturnReader`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Classic HttpMethodAttribute.ReturnFormatter Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/HttpMethodAttribute/ParameterFormatter/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Protocols/HttpMethodAttribute/ParameterFormatter/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Protocols/HttpMethodAttribute/ParameterFormatter/source.vb" id="Snippet1"::: + ]]> @@ -159,20 +159,20 @@ Gets or sets a that deserializes the response from an XML Web service method. A that deserializes the response from an XML Web service method. There is no default. - must be `UrlParameterWriter`, whereas a client using HTTP-POST must set to `HtmlFormParameterWriter`. - - - -## Examples - The example is a proxy class generated by the Wsdl.exe utility for an XML Web service client using HTTP-GET, setting to the required value of `UrlParameterWriter`. - + must be `UrlParameterWriter`, whereas a client using HTTP-POST must set to `HtmlFormParameterWriter`. + + + +## Examples + The example is a proxy class generated by the Wsdl.exe utility for an XML Web service client using HTTP-GET, setting to the required value of `UrlParameterWriter`. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Classic HttpMethodAttribute.ReturnFormatter Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/HttpMethodAttribute/ParameterFormatter/source.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Protocols/HttpMethodAttribute/ParameterFormatter/source.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Protocols/HttpMethodAttribute/ParameterFormatter/source.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Web.Services.Protocols/HttpPostClientProtocol.xml b/xml/System.Web.Services.Protocols/HttpPostClientProtocol.xml index 9f517011694..016c7a80117 100644 --- a/xml/System.Web.Services.Protocols/HttpPostClientProtocol.xml +++ b/xml/System.Web.Services.Protocols/HttpPostClientProtocol.xml @@ -107,7 +107,7 @@ to specify that the HTTP request to the XML Web service is made using HTTP-POST. By overriding this method, you can customize the object before the XML Web service request is made. For example, you can add a custom header to the request. + This method overrides the base version of to specify that the HTTP request to the XML Web service is made using HTTP-POST. By overriding this method, you can customize the object before the XML Web service request is made. For example, you can add a custom header to the request. ]]> diff --git a/xml/System.Web.Services.Protocols/HttpSimpleClientProtocol.xml b/xml/System.Web.Services.Protocols/HttpSimpleClientProtocol.xml index 5413c94bda3..3358e83fa54 100644 --- a/xml/System.Web.Services.Protocols/HttpSimpleClientProtocol.xml +++ b/xml/System.Web.Services.Protocols/HttpSimpleClientProtocol.xml @@ -29,7 +29,7 @@ ## Remarks This class specifies most of the implementation for communicating with an XML Web service over HTTP using encoders to encode the parameters and return values into common MIME formats. These encoders derive from the class. By default, a proxy class deriving from encodes parameters using the application/x-www-form-urlencoded MIME type and the response in plain XML. Custom mime formatters can be specified using the attribute, however, there is no support for integrating this into a service description and proxy generation. - `Notes to Inheritors:` When you override this class, you can introduce methods in the derived class that are specific to a particular type of an XML Web service. The methods simply capture the parameters, and call the base class to do the work of communicating with the site. If the introduced methods are asynchronous, call the and methods. If the introduced methods are synchronous, call the method. The overridden constructor typically sets the property to the URI of the XML Web service method. + `Notes to Inheritors:` When you override this class, you can introduce methods in the derived class that are specific to a particular type of an XML Web service. The methods simply capture the parameters, and call the base class to do the work of communicating with the site. If the introduced methods are asynchronous, call the and methods. If the introduced methods are synchronous, call the method. The overridden constructor typically sets the property to the URI of the XML Web service method. The Web Services Description Language tool (Wsdl.exe) generates derived classes of for a given Service Description. @@ -109,9 +109,9 @@ method. It is also used to find custom attributes that may have been added to the method. , , and provide additional information on the derived method that is required for the HTTP protocol. + The `methodName` parameter is used to find the types of the parameters and return values of the method that is invoking the method. It is also used to find custom attributes that may have been added to the method. , , and provide additional information on the derived method that is required for the HTTP protocol. - `asyncState` is passed into `callback` and is included in the that is returned from the method. It is useful for passing information from the context of the asynchronous call to the handling of the asynchronous result in `callback`. + `asyncState` is passed into `callback` and is included in the that is returned from the method. It is useful for passing information from the context of the asynchronous call to the handling of the asynchronous result in `callback`. @@ -121,7 +121,7 @@ [!code-aspx-csharp[Classic HttpSimpleClientProtocol.EndInvoke Example#1](~/snippets/csharp/System.Web.Services.Protocols/HttpSimpleClientProtocol/BeginInvoke/sourcecs.asmx#1)] [!code-aspx-vb[Classic HttpSimpleClientProtocol.EndInvoke Example#1](~/snippets/visualbasic/System.Web.Services.Protocols/HttpSimpleClientProtocol/BeginInvoke/sourcevb.aspx#1)] - The following code example is a proxy class generated by the Web Services Description Language tool (Wsdl.exe) for the `Math` XML Web service below. Within the `BeginAdd` method of the proxy class, the method starts an asynchronous invocation of the `Add` XML Web service method. + The following code example is a proxy class generated by the Web Services Description Language tool (Wsdl.exe) for the `Math` XML Web service below. Within the `BeginAdd` method of the proxy class, the method starts an asynchronous invocation of the `Add` XML Web service method. [!code-cpp[Classic HttpSimpleClientProtocol.EndInvoke Example#2](~/snippets/cpp/VS_Snippets_Remoting/Classic HttpSimpleClientProtocol.EndInvoke Example/CPP/source.cpp#2)] [!code-csharp[Classic HttpSimpleClientProtocol.EndInvoke Example#2](~/snippets/csharp/System.Web.Services.Protocols/HttpSimpleClientProtocol/BeginInvoke/source.cs#2)] @@ -171,7 +171,7 @@ [!code-aspx-csharp[Classic HttpSimpleClientProtocol.EndInvoke Example#1](~/snippets/csharp/System.Web.Services.Protocols/HttpSimpleClientProtocol/BeginInvoke/sourcecs.asmx#1)] [!code-aspx-vb[Classic HttpSimpleClientProtocol.EndInvoke Example#1](~/snippets/visualbasic/System.Web.Services.Protocols/HttpSimpleClientProtocol/BeginInvoke/sourcevb.aspx#1)] - The following code example is a proxy class generated by the Web Services Description Language tool (Wsdl.exe) for the `Math` XML Web service below. Within the `EndAdd` method of the proxy class, the method starts an asynchronous invocation of the `Add` XML Web service method. + The following code example is a proxy class generated by the Web Services Description Language tool (Wsdl.exe) for the `Math` XML Web service below. Within the `EndAdd` method of the proxy class, the method starts an asynchronous invocation of the `Add` XML Web service method. [!code-cpp[Classic HttpSimpleClientProtocol.EndInvoke Example#2](~/snippets/cpp/VS_Snippets_Remoting/Classic HttpSimpleClientProtocol.EndInvoke Example/CPP/source.cpp#2)] [!code-csharp[Classic HttpSimpleClientProtocol.EndInvoke Example#2](~/snippets/csharp/System.Web.Services.Protocols/HttpSimpleClientProtocol/BeginInvoke/source.cs#2)] @@ -220,7 +220,7 @@ method. It is also used to find custom attributes which may have been added to the method. and provide additional information on the derived method that is required for the SOAP protocol. + The `methodName` parameter is used to find the types of the parameters and return values of the method that is invoking the method. It is also used to find custom attributes which may have been added to the method. and provide additional information on the derived method that is required for the SOAP protocol. @@ -230,7 +230,7 @@ [!code-csharp[HttpSimpleClientProtocol.Invoke Example#2](~/snippets/csharp/System.Web.Services.Protocols/HttpSimpleClientProtocol/Invoke/sourcecs.asmx#2)] [!code-vb[HttpSimpleClientProtocol.Invoke Example#2](~/snippets/visualbasic/System.Web.Services.Protocols/HttpSimpleClientProtocol/Invoke/sourcevb.aspx#2)] - The following code example is a proxy class generated by the Web Services Description Language tool (Wsdl.exe) for the `Math` XML Web service below. Within the `Add` method of the proxy class, the method synchronously invokes the `Add` Web Service method. + The following code example is a proxy class generated by the Web Services Description Language tool (Wsdl.exe) for the `Math` XML Web service below. Within the `Add` method of the proxy class, the method synchronously invokes the `Add` Web Service method. [!code-cpp[HttpSimpleClientProtocol.Invoke Example#1](~/snippets/cpp/VS_Snippets_Remoting/HttpSimpleClientProtocol.Invoke Example/CPP/source.cpp#1)] [!code-csharp[HttpSimpleClientProtocol.Invoke Example#1](~/snippets/csharp/System.Web.Services.Protocols/HttpSimpleClientProtocol/Invoke/source.cs#1)] diff --git a/xml/System.Web.Services.Protocols/HttpWebClientProtocol.xml b/xml/System.Web.Services.Protocols/HttpWebClientProtocol.xml index 4c02e0afb54..f24cd180cd4 100644 --- a/xml/System.Web.Services.Protocols/HttpWebClientProtocol.xml +++ b/xml/System.Web.Services.Protocols/HttpWebClientProtocol.xml @@ -106,7 +106,7 @@ ## Remarks If a client sends authentication information, such as a user name and password, you do not want to enable the server to redirect, because this can compromise security. - A is thrown if the property is `false` and the Web server attempts to redirect the request. The property contains an object, where both the and properties reflect details regarding the attempted redirect. The property contains an equivalent to one of the HTTP redirect status codes (301, 302, and 307) and the `Location` header within the collection points to the URI that the request attempted to be redirected to. + A is thrown if the property is `false` and the Web server attempts to redirect the request. The property contains an object, where both the and properties reflect details regarding the attempted redirect. The property contains an equivalent to one of the HTTP redirect status codes (301, 302, and 307) and the `Location` header within the collection points to the URI that the request attempted to be redirected to. ]]> diff --git a/xml/System.Web.Services.Protocols/LogicalMethodInfo.xml b/xml/System.Web.Services.Protocols/LogicalMethodInfo.xml index 7c634c7115d..a9337803864 100644 --- a/xml/System.Web.Services.Protocols/LogicalMethodInfo.xml +++ b/xml/System.Web.Services.Protocols/LogicalMethodInfo.xml @@ -22,7 +22,7 @@ is used primarily by a SOAP extension to interrogate the details of the XML Web service method with which the SOAP extension is configured to run. Depending on how the SOAP extension is configured, it can find out details about the XML Web service method in the method of that takes a . The provides details such as the XML Web service method's parameters by accessing the property and any custom attributes applied to the XML Web service method using the method. + is used primarily by a SOAP extension to interrogate the details of the XML Web service method with which the SOAP extension is configured to run. Depending on how the SOAP extension is configured, it can find out details about the XML Web service method in the method of that takes a . The provides details such as the XML Web service method's parameters by accessing the property and any custom attributes applied to the XML Web service method using the method. For more details on SOAP extensions see the class or [SOAP Message Modification Using SOAP Extensions](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/esw638yk(v=vs.100)). @@ -613,7 +613,7 @@ ## Remarks Use an instance of to obtain information about the parameter's data type, default value, and so on. - returns an array of objects representing the parameters passed into a method, in order. + returns an array of objects representing the parameters passed into a method, in order. @@ -942,7 +942,7 @@ ## Remarks Use a to obtain information about the parameter's data type, default value, and so on. - returns an array of objects representing the parameters passed into a method, in order. + returns an array of objects representing the parameters passed into a method, in order. diff --git a/xml/System.Web.Services.Protocols/MimeFormatter.xml b/xml/System.Web.Services.Protocols/MimeFormatter.xml index 4d9e82ee216..a846a02b701 100644 --- a/xml/System.Web.Services.Protocols/MimeFormatter.xml +++ b/xml/System.Web.Services.Protocols/MimeFormatter.xml @@ -19,15 +19,15 @@ Provides an abstract base class for all readers and writers for Web services and clients implemented using HTTP but without SOAP. - class establishes a common interface and functionality for reader and writer classes, in both client and service-side . - - The class supports the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. In HTTP-GET operations request parameters are encoded in the HTTP request's Uniform Resource Locator (URL). In HTTP-POST operations, request parameters are encoded in the HTTP request body, as with an HTML form. With both implementations, the return value appears in the HTTP response body as a non-SOAP XML document. - - A developer typically does not need to directly use or its descendant classes. Instead, when the Wsdl.exe tool generates client proxy code according to the HTTP-GET or HTTP-POST implementations, it applies the to each Web method and sets the attribute's and properties to the appropriate type derived from the class. On the server, the appropriate derived types are used according to settings in an ASP.NET configuration file (Web.config). On the client the appropriate derived types are determined from the WSDL. - + class establishes a common interface and functionality for reader and writer classes, in both client and service-side . + + The class supports the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. In HTTP-GET operations request parameters are encoded in the HTTP request's Uniform Resource Locator (URL). In HTTP-POST operations, request parameters are encoded in the HTTP request body, as with an HTML form. With both implementations, the return value appears in the HTTP response body as a non-SOAP XML document. + + A developer typically does not need to directly use or its descendant classes. Instead, when the Wsdl.exe tool generates client proxy code according to the HTTP-GET or HTTP-POST implementations, it applies the to each Web method and sets the attribute's and properties to the appropriate type derived from the class. On the server, the appropriate derived types are used according to settings in an ASP.NET configuration file (Web.config). On the client the appropriate derived types are determined from the WSDL. + ]]> @@ -79,13 +79,13 @@ Creates and initializes an instance of a concrete class derived from . A object. - method creates an instance of the derived class and invokes the derived class's implementation of the abstract method. The method is invoked at the time a request or response is processed. - - An initializer is an object passed as a parameter to the method. The initializer passed as a parameter to the method is obtained from another instance of the derived class, by invoking the method during client or service initialization. - + method creates an instance of the derived class and invokes the derived class's implementation of the abstract method. The method is invoked at the time a request or response is processed. + + An initializer is an object passed as a parameter to the method. The initializer passed as a parameter to the method is obtained from another instance of the derived class, by invoking the method during client or service initialization. + ]]> @@ -125,13 +125,13 @@ When overridden in a derived class, returns an initializer for the specified method. An that contains the initializer for the specified method. - method. - - A derived class's implementation of the instance method is invoked during client or service initialization. Later, at the time a request or response is processed, the initializer object is passed to the static method, which creates an instance of another object of the derived class, and then to the method to initialize it. The other object performs the actual reading or writing. - + method. + + A derived class's implementation of the instance method is invoked during client or service initialization. Later, at the time a request or response is processed, the initializer object is passed to the static method, which creates an instance of another object of the derived class, and then to the method to initialize it. The other object performs the actual reading or writing. + ]]> @@ -163,13 +163,13 @@ Returns an initializer for the specified method. A object that contains the initializer for the specified method. - method. - - The static method invokes the derived class's method, implicitly creating an instance of the derived class. At the time a request or response is processed, the initializer object is passed to the method of another instance of the derived class. The latter object performs the actual reading or writing. - + method. + + The static method invokes the derived class's method, implicitly creating an instance of the derived class. At the time a request or response is processed, the initializer object is passed to the method of another instance of the derived class. The latter object performs the actual reading or writing. + ]]> @@ -209,13 +209,13 @@ When overridden in a derived class, returns an array of initializer objects corresponding to an input array of method definitions. An array of initializer objects corresponding to the input array of method definitions. - method. - - The instance method invokes the instance method for each input Web method. This means an instance of a class derived from has already been created. At the time a request or response is processed, the initializer is passed to the method of another instance of the derived class. The latter object performs the actual reading or writing. - + method. + + The instance method invokes the instance method for each input Web method. This means an instance of a class derived from has already been created. At the time a request or response is processed, the initializer is passed to the method of another instance of the derived class. The latter object performs the actual reading or writing. + ]]> @@ -247,13 +247,13 @@ Returns an array of initializer objects corresponding to an input array of method definitions for a specified class derived from . An array of initializer objects corresponding to the input array of method definitions for a specified class derived from . - method. - - The static method causes the invocation of the method belonging to the derived class specified by the `type` parameter. - + method. + + The static method causes the invocation of the method belonging to the derived class specified by the `type` parameter. + ]]> @@ -282,11 +282,11 @@ An object of a type appropriate to the particular class that is implementing the method. When overridden in a derived class, initializes an instance. - method is invoked at the time a request or response is processed; however, the initializer is obtained by calling the method on another instance during client or service initialization. - + method is invoked at the time a request or response is processed; however, the initializer is obtained by calling the method on another instance during client or service initialization. + ]]> diff --git a/xml/System.Web.Services.Protocols/MimeParameterReader.xml b/xml/System.Web.Services.Protocols/MimeParameterReader.xml index 9f86718b0bd..c1836065159 100644 --- a/xml/System.Web.Services.Protocols/MimeParameterReader.xml +++ b/xml/System.Web.Services.Protocols/MimeParameterReader.xml @@ -18,15 +18,15 @@ Provides a common base implementation for readers of request parameters for Web services implemented using HTTP but without SOAP. - and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. - - The class establishes a common format for all service-side readers of HTTP request streams into Web method parameters. - - You will typically not need to use or its descendant classes directly. The appropriate types are used according to settings in an ASP.NET configuration file (Web.config). - + and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. + + The class establishes a common format for all service-side readers of HTTP request streams into Web method parameters. + + You will typically not need to use or its descendant classes directly. The appropriate types are used according to settings in an ASP.NET configuration file (Web.config). + ]]> diff --git a/xml/System.Web.Services.Protocols/MimeParameterWriter.xml b/xml/System.Web.Services.Protocols/MimeParameterWriter.xml index 033f93754a3..3836206ead3 100644 --- a/xml/System.Web.Services.Protocols/MimeParameterWriter.xml +++ b/xml/System.Web.Services.Protocols/MimeParameterWriter.xml @@ -181,9 +181,9 @@ property determines whether the method is invoked. + The property determines whether the method is invoked. - The class's implementation of returns a value of `false`. The only derived class that overrides is , whose implementation returns a value of `true`. + The class's implementation of returns a value of `false`. The only derived class that overrides is , whose implementation returns a value of `true`. ]]> @@ -218,7 +218,7 @@ , only implements the method. + Of the classes derived from , only implements the method. ]]> diff --git a/xml/System.Web.Services.Protocols/MimeReturnReader.xml b/xml/System.Web.Services.Protocols/MimeReturnReader.xml index 018f058eb24..6eeeba68fd3 100644 --- a/xml/System.Web.Services.Protocols/MimeReturnReader.xml +++ b/xml/System.Web.Services.Protocols/MimeReturnReader.xml @@ -24,7 +24,7 @@ ## Remarks and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. - The class establishes a common interface for all client-side reading of HTTP response streams into Web method return values. + The class establishes a common interface for all client-side reading of HTTP response streams into Web method return values. You typically will not need to use or its descendant classes directly. Instead, when the Wsdl.exe tool generates client proxy code according to the HTTP-GET or HTTP-POST implementations, it applies the to each Web method and sets the attribute's property to the class, which is derived from . diff --git a/xml/System.Web.Services.Protocols/NopReturnReader.xml b/xml/System.Web.Services.Protocols/NopReturnReader.xml index 43eb630c902..d547ee0099f 100644 --- a/xml/System.Web.Services.Protocols/NopReturnReader.xml +++ b/xml/System.Web.Services.Protocols/NopReturnReader.xml @@ -81,7 +81,7 @@ method. For the class, the initializer is the instance referred to by the keyword `this`. + An initializer is an object passed as a parameter to the method. For the class, the initializer is the instance referred to by the keyword `this`. ]]> @@ -114,7 +114,7 @@ method does nothing. It is invoked at the time a response is processed. The input parameter, `initializer`, is another instance of the class that is obtained during client initialization. + The method does nothing. It is invoked at the time a response is processed. The input parameter, `initializer`, is another instance of the class that is obtained during client initialization. ]]> @@ -151,7 +151,7 @@ class's implementation of the method does no reading. Instead it returns `null`. It also closes the response stream. + The class's implementation of the method does no reading. Instead it returns `null`. It also closes the response stream. ]]> diff --git a/xml/System.Web.Services.Protocols/PatternMatcher.xml b/xml/System.Web.Services.Protocols/PatternMatcher.xml index 82835dfcd75..5325a7d8e45 100644 --- a/xml/System.Web.Services.Protocols/PatternMatcher.xml +++ b/xml/System.Web.Services.Protocols/PatternMatcher.xml @@ -18,17 +18,17 @@ Searches HTTP response text for return values for Web service clients. - class performs pattern matching using regular expressions to find Web method return values in text encoded in the body of an HTTP response. The class is called by the client-side class, which deserializes Web service return values. - - Text pattern matching provides a way for Web services to retrieve HTML content without converting it to XML documents that must be bound to XML Schema definitions. Regular expression search targets are specified in a Web Services Description Language (WSDL) document via `match` XML elements within `text` elements. Both elements belong to the namespace `http://microsoft.com/wsdl/mime/textMatching/`. - - When `match` elements are specified in a WSDL document, the Wsdl.exe tool applies attributes to the corresponding Web methods in the client proxy class that is generated. A attribute's properties establish the search criteria for a instance. - - A developer typically does not need to directly use . - + class performs pattern matching using regular expressions to find Web method return values in text encoded in the body of an HTTP response. The class is called by the client-side class, which deserializes Web service return values. + + Text pattern matching provides a way for Web services to retrieve HTML content without converting it to XML documents that must be bound to XML Schema definitions. Regular expression search targets are specified in a Web Services Description Language (WSDL) document via `match` XML elements within `text` elements. Both elements belong to the namespace `http://microsoft.com/wsdl/mime/textMatching/`. + + When `match` elements are specified in a WSDL document, the Wsdl.exe tool applies attributes to the corresponding Web methods in the client proxy class that is generated. A attribute's properties establish the search criteria for a instance. + + A developer typically does not need to directly use . + ]]> @@ -56,11 +56,11 @@ A that specifies the return type for a Web method. Creates a instance based on the input type. - instance's properties, such as the regular expression to make the search target, are populated based on attributes applied to fields of the return type. - + instance's properties, such as the regular expression to make the search target, are populated based on attributes applied to fields of the return type. + ]]> @@ -90,11 +90,11 @@ Searches a text input to deserialize an object representing a Web method return value. An object representing a Web method return value. - method's return value is the Web method return value deserialized from the input text. - + method's return value is the Web method return value deserialized from the input text. + ]]> diff --git a/xml/System.Web.Services.Protocols/Soap12FaultCodes.xml b/xml/System.Web.Services.Protocols/Soap12FaultCodes.xml index d62353074bb..7feddd01a83 100644 --- a/xml/System.Web.Services.Protocols/Soap12FaultCodes.xml +++ b/xml/System.Web.Services.Protocols/Soap12FaultCodes.xml @@ -136,7 +136,7 @@ The `Subcode` element allows the sender of the SOAP fault to provide an applicat ## Remarks Not all SOAP headers require processing by the recipient. However, if a SOAP header is marked with the `MustUnderstand` attribute equal to "true", processing is required. Failure to process the header when it resides within a SOAP 1.2 request generates a with the property set to . If the SOAP request resided within a SOAP 1.1 request, the property is set to . - Both SOAP 1.1 and 1.2 define `MustUnderstand` SOAP fault codes differing only by the version of the SOAP protocol used to send the SOAP message. This field represents the SOAP 1.2 version, and the SOAP 1.1 version is represented by . The two fields map to different qualified names, but you can check whether the property is either one of the fault codes by calling the method. + Both SOAP 1.1 and 1.2 define `MustUnderstand` SOAP fault codes differing only by the version of the SOAP protocol used to send the SOAP message. This field represents the SOAP 1.2 version, and the SOAP 1.1 version is represented by . The two fields map to different qualified names, but you can check whether the property is either one of the fault codes by calling the method. ]]> @@ -166,7 +166,7 @@ The `Subcode` element allows the sender of the SOAP fault to provide an applicat ## Remarks A is thrown with the property set to when a server is called and it could not respond to a request due to network problems. Typically, with this type of exception, the client call may succeed later. - The `Receiver` SOAP fault code is similar to the `Server` fault code, which is represented by the field, but the `Server` fault code is used when the SOAP request is sent using SOAP 1.1. To check whether the property is either the `Receiver` or `Server` SOAP fault codes, call the method. + The `Receiver` SOAP fault code is similar to the `Server` fault code, which is represented by the field, but the `Server` fault code is used when the SOAP request is sent using SOAP 1.1. To check whether the property is either the `Receiver` or `Server` SOAP fault codes, call the method. ]]> @@ -256,7 +256,7 @@ The `Subcode` element allows the sender of the SOAP fault to provide an applicat ## Remarks A is thrown with the property set to when a SOAP 1.2 request is malformed or a parameter is missing. - The `Sender` SOAP fault code is similar to the `Client` fault code, which is represented by the field, but the `Client` fault code is used when the SOAP request is sent using SOAP 1.1. To check whether the property is either the `Sender` or `Client` SOAP fault codes, call the method. + The `Sender` SOAP fault code is similar to the `Client` fault code, which is represented by the field, but the `Client` fault code is used when the SOAP request is sent using SOAP 1.1. To check whether the property is either the `Sender` or `Client` SOAP fault codes, call the method. ]]> @@ -286,7 +286,7 @@ The `Subcode` element allows the sender of the SOAP fault to provide an applicat ## Remarks A is thrown with the property set to when an XML Web service is configured to only accept SOAP 1.2 requests and it receives a SOAP 1.1 message. Likewise, if an XML Web service is configured to accept only SOAP 1.1 messages and it receives a SOAP 1.2 message, a is thrown with the property set to . For details on configuring XML Web services, see [Configuration Options for XML Web Services Created Using ASP.NET](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/b2c0ew36(v=vs.100)). - Both SOAP 1.1 and 1.2 define `VersionMismatch` SOAP fault codes that differ on the version of the SOAP protocol expected. This field represents the SOAP 1.2 version, whereas the SOAP 1.1 version is represented by . The two fields map to different qualified names, but you can check whether the property is either one of the fault codes by calling the method. + Both SOAP 1.1 and 1.2 define `VersionMismatch` SOAP fault codes that differ on the version of the SOAP protocol expected. This field represents the SOAP 1.2 version, whereas the SOAP 1.1 version is represented by . The two fields map to different qualified names, but you can check whether the property is either one of the fault codes by calling the method. ]]> diff --git a/xml/System.Web.Services.Protocols/SoapClientMessage.xml b/xml/System.Web.Services.Protocols/SoapClientMessage.xml index 9d25f4ab235..f9bfd8c1599 100644 --- a/xml/System.Web.Services.Protocols/SoapClientMessage.xml +++ b/xml/System.Web.Services.Protocols/SoapClientMessage.xml @@ -22,7 +22,7 @@ passed into the method of the SOAP extension by writing properties of the to the log file. + The following code fragment is part of a SOAP extension that logs the SOAP messages sent and received by an XML Web service client. This specific fragment processes the passed into the method of the SOAP extension by writing properties of the to the log file. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/SoapClientMessage/CPP/SoapClientMessage.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapClientMessage/Overview/soapclientmessage.cs" id="Snippet1"::: diff --git a/xml/System.Web.Services.Protocols/SoapDocumentMethodAttribute.xml b/xml/System.Web.Services.Protocols/SoapDocumentMethodAttribute.xml index 92dea5a9adb..7b27f69563c 100644 --- a/xml/System.Web.Services.Protocols/SoapDocumentMethodAttribute.xml +++ b/xml/System.Web.Services.Protocols/SoapDocumentMethodAttribute.xml @@ -28,7 +28,7 @@ and properties. The property determines whether parameters are formatted `Encoded` or `Literal`. The determines whether the parameters are encapsulated within a single message part following the `Body` element or whether each parameter is an individual message part. + Web Services Description Language (WSDL) defines two styles for how an XML Web service method, which it calls an operation, can be formatted in a SOAP message: `RPC` and `Document`. `Document` refers to formatting the XML Web service method according to an XSD schema. The `Document` style refers to formatting the `Body` element as a series of one or more message parts following the `Body` element. Exactly how the individual message parts is determined by the and properties. The property determines whether parameters are formatted `Encoded` or `Literal`. The determines whether the parameters are encapsulated within a single message part following the `Body` element or whether each parameter is an individual message part. For more details, see [Customizing SOAP Message Formatting](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/dkwy2d72(v=vs.100)). @@ -281,7 +281,7 @@ defines the XML element used to wrap the parameters beneath the `Body` element of the SOAP request when is . This is reflected in the XSD schema representing the SOAP request to the XML Web service method within the service description for an XML Web service. + The defines the XML element used to wrap the parameters beneath the `Body` element of the SOAP request when is . This is reflected in the XSD schema representing the SOAP request to the XML Web service method within the service description for an XML Web service. @@ -319,7 +319,7 @@ is used in the XSD schema for the XML Web service method within its service description. + is used in the XSD schema for the XML Web service method within its service description. @@ -357,7 +357,7 @@ defines the XML element used to wrap the parameters beneath the `Body` element of the SOAP response when is . This is reflected in the XSD schema representing the SOAP response to the XML Web service method within the XML Web service's service description. + The defines the XML element used to wrap the parameters beneath the `Body` element of the SOAP response when is . This is reflected in the XSD schema representing the SOAP response to the XML Web service method within the XML Web service's service description. diff --git a/xml/System.Web.Services.Protocols/SoapDocumentServiceAttribute.xml b/xml/System.Web.Services.Protocols/SoapDocumentServiceAttribute.xml index 4d02c3cdd84..9a1aa3a3cb1 100644 --- a/xml/System.Web.Services.Protocols/SoapDocumentServiceAttribute.xml +++ b/xml/System.Web.Services.Protocols/SoapDocumentServiceAttribute.xml @@ -30,7 +30,7 @@ ## Remarks The allows you to set the default formatting styles for XML Web service methods within an XML Web service. If an individual XML Web service method must change these defaults, apply a to that XML Web service method. - Web Services Description Language (WSDL) defines two styles for how an XML Web service method, which it calls an operation, can be formatted in a SOAP request or a SOAP response: `RPC` and `Document`. Exactly how the individual message parts is determined by the and properties. The property determines whether parameters are formatted `Encoded` or `Literal`. The determines whether the parameters are encapsulated within a single message part beneath the `Body` element, or whether each parameter is an individual message part. + Web Services Description Language (WSDL) defines two styles for how an XML Web service method, which it calls an operation, can be formatted in a SOAP request or a SOAP response: `RPC` and `Document`. Exactly how the individual message parts is determined by the and properties. The property determines whether parameters are formatted `Encoded` or `Literal`. The determines whether the parameters are encapsulated within a single message part beneath the `Body` element, or whether each parameter is an individual message part. To set the default method level formatting to `RPC`, apply a to the class implementing the XML Web service. diff --git a/xml/System.Web.Services.Protocols/SoapException.xml b/xml/System.Web.Services.Protocols/SoapException.xml index 9df76efcb4e..2669b8267c3 100644 --- a/xml/System.Web.Services.Protocols/SoapException.xml +++ b/xml/System.Web.Services.Protocols/SoapException.xml @@ -33,12 +33,12 @@ |Property|Value| |--------------|-----------| -||The property of the original exception.| -||.| -||The URL of the XML Web service method.| -||`null`, but an empty detail element is present in the fault element.| +||The property of the original exception.| +||.| +||The URL of the XML Web service method.| +||`null`, but an empty detail element is present in the fault element.| - An XML Web service method might throw a when clients call using SOAP. If an XML Web service throws the , other details can be added through the , and properties that cannot otherwise be set by an XML Web service method if another type of exception is thrown. + An XML Web service method might throw a when clients call using SOAP. If an XML Web service throws the , other details can be added through the , and properties that cannot otherwise be set by an XML Web service method if another type of exception is thrown. @@ -407,7 +407,7 @@ property can only be set using one of the constructors that accepts an argument. + The property can only be set using one of the constructors that accepts an argument. When a SOAP request is made, the message is sent to a recipient, which is specified in a SOAP actor attribute. If an exception occurs within an XML Web service, the value of the SOAP actor attribute is assigned to the property. For XML Web services created using ASP.NET, the URL to the XML Web service method is the value of the SOAP actor attribute and is returned in the property. @@ -416,7 +416,7 @@ ## Examples - The following Web Form example calls the `Math` XML Web service method, which throws an exception if a division by zero occurs. When the exception is thrown, the Web Form catches the exception and outputs the exception details, including the and properties, into an control. + The following Web Form example calls the `Math` XML Web service method, which throws an exception if a division by zero occurs. When the exception is thrown, the Web Form catches the exception and outputs the exception details, including the and properties, into an control. :::code language="aspx-csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapException/Actor/sourcecs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/Classic SoapException.Actor Example/VB/sourcevb.aspx" id="Snippet1"::: @@ -490,7 +490,7 @@ ## Remarks The property can only be set when creating a new instance of the class. - The class is for use by XML Web service clients that call XML Web service methods over SOAP. ASP.NET handles whether the client that calls uses SOAP. This is when an exception occurs in an XML Web service. If the client uses SOAP, ASP.NET wraps the specific exception into a and sets the and properties. + The class is for use by XML Web service clients that call XML Web service methods over SOAP. ASP.NET handles whether the client that calls uses SOAP. This is when an exception occurs in an XML Web service. If the client uses SOAP, ASP.NET wraps the specific exception into a and sets the and properties. The set of available codes, known as SOAP Fault Codes for SOAP protocol version 1.1, are the following: @@ -504,7 +504,7 @@ ## Examples - The following Web Form example calls the `Math` Web Service method, which throws an exception if a division by zero occurs. Once the exception is thrown, the Web Form catches the exception and outputs the exception details, including the and properties into a control. + The following Web Form example calls the `Math` Web Service method, which throws an exception if a division by zero occurs. Once the exception is thrown, the Web Form catches the exception and outputs the exception details, including the and properties into a control. :::code language="aspx-csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapException/Actor/sourcecs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/Classic SoapException.Actor Example/VB/sourcevb.aspx" id="Snippet1"::: @@ -546,11 +546,11 @@ property can be set using one of the class constructors that accepts a value. + The property can be set using one of the class constructors that accepts a value. The property is used to supply application-specific error details related to the `Body` element of the SOAP request. According to the SOAP specification, if an error occurs because the client request cannot be processed due to the `Body` element of the SOAP request, the property must be set. If an error occurs in the header entries of the SOAP request, you must throw a , so that the error details are returned in the SOAP header. If the error does not occur, due to the processing of the `Body` element, then the property must not be set. - In building an for the property, the and properties of can be used to ensure consistency with the SOAP specification. + In building an for the property, the and properties of can be used to ensure consistency with the SOAP specification. All immediate child elements of the detail element are called detail entries and each detail entry is encoded as an independent element within the detail element. @@ -591,7 +591,7 @@ for the property, the and properties of can be used to ensure consistency with the SOAP specification. + In building an for the property, the and properties of can be used to ensure consistency with the SOAP specification. @@ -879,7 +879,7 @@ ## Remarks The property is ignored when the SOAP protocol version 1.1 is used to communicate with an XML Web service. When SOAP 1.2 is used, the property sets the `node` element within a `fault` element of a SOAP message. - The and properties both identify the piece of code that caused the exception; they just refer to their SOAP 1.1 and SOAP 1.2 names respectively. Because they both refer to the same property value, applications can just access the property. The value of these properties is set by the constructors that accept an `actor` parameter. + The and properties both identify the piece of code that caused the exception; they just refer to their SOAP 1.1 and SOAP 1.2 names respectively. Because they both refer to the same property value, applications can just access the property. The value of these properties is set by the constructors that accept an `actor` parameter. ]]> diff --git a/xml/System.Web.Services.Protocols/SoapExtension.xml b/xml/System.Web.Services.Protocols/SoapExtension.xml index 7933ac9a7c9..c9320b628ff 100644 --- a/xml/System.Web.Services.Protocols/SoapExtension.xml +++ b/xml/System.Web.Services.Protocols/SoapExtension.xml @@ -24,7 +24,7 @@ ## Remarks ASP.NET allows a SOAP-related infrastructure to be built by means of an extensibility mechanism. The ASP.NET SOAP extension architecture revolves around an extension that can inspect or modify a message at specific stages in message processing on either the client or the server. - ASP.NET SOAP extensions derive from the class. The and methods provide alternative mechanisms for initializing the SOAP extension to enhance performance. is the heart of most SOAP extensions, as the method is called at each stage defined in , allowing the SOAP extension to perform the desired behavior of that specific SOAP extension. For SOAP extensions that need to modify the SOAP request or SOAP response, provides an opportunity to receive the proposed data to be sent across the wire. + ASP.NET SOAP extensions derive from the class. The and methods provide alternative mechanisms for initializing the SOAP extension to enhance performance. is the heart of most SOAP extensions, as the method is called at each stage defined in , allowing the SOAP extension to perform the desired behavior of that specific SOAP extension. For SOAP extensions that need to modify the SOAP request or SOAP response, provides an opportunity to receive the proposed data to be sent across the wire. @@ -89,14 +89,14 @@ ensures that SOAP extensions with the highest priority can modify the actual data closest to the SOAP message sent or returned over the wire. + ensures that SOAP extensions with the highest priority can modify the actual data closest to the SOAP message sent or returned over the wire. - SOAP extensions should save references of the passed into and the returned from . If the SOAP extension is configured to run with a XML Web service method, the passed into contains the serialized SOAP request at the . Similarly, the reference returned from is written into when the serialization occurs and thus contains the serialized SOAP response in the . + SOAP extensions should save references of the passed into and the returned from . If the SOAP extension is configured to run with a XML Web service method, the passed into contains the serialized SOAP request at the . Similarly, the reference returned from is written into when the serialization occurs and thus contains the serialized SOAP response in the . ## Examples - The following example saves both the passed into and the returned from in the member variables `oldStream` and `newStream`, respectively. + The following example saves both the passed into and the returned from in the member variables `oldStream` and `newStream`, respectively. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Classic SoapExtension.ChainStream Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapExtension/ChainStream/source.cs" id="Snippet1"::: @@ -144,13 +144,13 @@ that gets called by ASP.NET depends on how the SOAP extension was specified. There are two methods for specifying a SOAP extension: + The overload of that gets called by ASP.NET depends on how the SOAP extension was specified. There are two methods for specifying a SOAP extension: - Apply a custom attribute, deriving from , to the individual XML Web service method. - Add a reference in either the web.config or app.config configuration files. - If you add a reference to one of the configuration files, the SOAP extension runs for all XML Web services within the scope of that configuration file. When specifying, a SOAP extension by referencing a configuration file, ASP.NET invokes the overload that passes in a . When specifying an extension by applying a custom attribute, ASP.NET invokes the that passes in a and a . + If you add a reference to one of the configuration files, the SOAP extension runs for all XML Web services within the scope of that configuration file. When specifying, a SOAP extension by referencing a configuration file, ASP.NET invokes the overload that passes in a . When specifying an extension by applying a custom attribute, ASP.NET invokes the that passes in a and a . For details on adding SOAP extensions to a configuration file, see [Configuration Options for XML Web Services Created Using ASP.NET](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/b2c0ew36(v=vs.100)). @@ -197,20 +197,20 @@ overload that accepts a . + If the SOAP extension is configured using a configuration file see the overload that accepts a . A SOAP extension has three opportunities to initialize data and they all have different purposes: - Class constructor - The class constructor is called every time a SOAP extension is instantiated and is typically used to initialize member variables. -- - , however, is called just once, the first time a SOAP request is made to an XML Web services method. If a custom attribute is applied to the XML Web service method, the method is invoked. This allows the SOAP extension to interrogate the of an XML Web service method for prototype information or to access extension-specific data passed by a class deriving from . The return value is cached by ASP.NET and passed into subsequent methods. Therefore, initialization done in is encapsulated essentially into a one-time performance hit. +- - , however, is called just once, the first time a SOAP request is made to an XML Web services method. If a custom attribute is applied to the XML Web service method, the method is invoked. This allows the SOAP extension to interrogate the of an XML Web service method for prototype information or to access extension-specific data passed by a class deriving from . The return value is cached by ASP.NET and passed into subsequent methods. Therefore, initialization done in is encapsulated essentially into a one-time performance hit. -- - is called every time a SOAP request is made to an XML Web service method, but has an advantage over the class constructor, in that the initialized in is passed to it. +- - is called every time a SOAP request is made to an XML Web service method, but has an advantage over the class constructor, in that the initialized in is passed to it. ## Examples - The following code demonstrates how you can obtain SOAP extension-specific data passed in using a class that derives from , and then cache that data in . This code example is part of a full code example for a `TraceExtension` SOAP extension that can be found in the class overview. This code example relies on a `TraceExtensionAttribute` being passed into the `attribute` parameter. In the full code example, `TraceExtensionAttribute` derives from and adds a `Filename` property, which is what stores in the cache. + The following code demonstrates how you can obtain SOAP extension-specific data passed in using a class that derives from , and then cache that data in . This code example is part of a full code example for a `TraceExtension` SOAP extension that can be found in the class overview. This code example relies on a `TraceExtensionAttribute` being passed into the `attribute` parameter. In the full code example, `TraceExtensionAttribute` derives from and adds a `Filename` property, which is what stores in the cache. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Classic SoapExtension.GetInitializer Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapExtension/GetInitializer/source.cs" id="Snippet1"::: @@ -254,15 +254,15 @@ - Class constructor - The class constructor is called every time a SOAP extension is instantiated and is typically used to initialize member variables. -- - This method is called just once, the first time a SOAP request is made to an XML Web services method. If a custom attribute is applied to the XML Web service method, the method is invoked. This allows the SOAP extension to interrogate the of an XML Web service method for prototype information or to access extension-specific data passed by a class deriving from . The return value is cached by ASP.NET and passed into subsequent methods. Therefore, initialization done in is encapsulated essentially into a one-time performance hit. +- - This method is called just once, the first time a SOAP request is made to an XML Web services method. If a custom attribute is applied to the XML Web service method, the method is invoked. This allows the SOAP extension to interrogate the of an XML Web service method for prototype information or to access extension-specific data passed by a class deriving from . The return value is cached by ASP.NET and passed into subsequent methods. Therefore, initialization done in is encapsulated essentially into a one-time performance hit. -- - This method is called every time a SOAP request is made to an XML Web service method, but has an advantage over the class constructor, in that the initialized in is passed to it. +- - This method is called every time a SOAP request is made to an XML Web service method, but has an advantage over the class constructor, in that the initialized in is passed to it. > [!NOTE] > You can also add a SOAP extension without deriving from by using the [\ Element](https://msdn.microsoft.com/library/7a373a98-6d82-4f8d-a6fc-2996da3fd54c) in a configuration file. For details, see [\ Element](https://msdn.microsoft.com/library/7a373a98-6d82-4f8d-a6fc-2996da3fd54c) and [SOAP Message Modification Using SOAP Extensions](https://msdn.microsoft.com/library/97d81ace-95e7-4acc-ae39-9692a0021e95). ## Examples - The following example demonstrates how you can use the data cached during the method. + The following example demonstrates how you can use the data cached during the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Classic SoapExtension.Initialize Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapExtension/Initialize/source.cs" id="Snippet1"::: @@ -299,12 +299,12 @@ is called at all stages for SOAP extensions applied to both XML Web services created using ASP.NET and their clients. At each , an instance of a class deriving from is passed to . If the SOAP extension is running on the XML Web service client, then a object is passed into ; otherwise a object is passed in. + is called at all stages for SOAP extensions applied to both XML Web services created using ASP.NET and their clients. At each , an instance of a class deriving from is passed to . If the SOAP extension is running on the XML Web service client, then a object is passed into ; otherwise a object is passed in. ## Examples - The following example is the portion of a SOAP extension that logs SOAP requests and SOAP responses. By logging the at the , the SOAP extension accesses the to be sent over the wire. If the SOAP extension is applied to an XML Web service method created using ASP.NET, then the contains the SOAP response from the XML Web service method. If the SOAP extension is applied to an XML Web service client, the contains the SOAP request to an XML Web service method. + The following example is the portion of a SOAP extension that logs SOAP requests and SOAP responses. By logging the at the , the SOAP extension accesses the to be sent over the wire. If the SOAP extension is applied to an XML Web service method created using ASP.NET, then the contains the SOAP response from the XML Web service method. If the SOAP extension is applied to an XML Web service client, the contains the SOAP request to an XML Web service method. Classic SoapExtension.ProcessMessage Example#1 diff --git a/xml/System.Web.Services.Protocols/SoapHeader.xml b/xml/System.Web.Services.Protocols/SoapHeader.xml index be7e0402161..981d2b4826f 100644 --- a/xml/System.Web.Services.Protocols/SoapHeader.xml +++ b/xml/System.Web.Services.Protocols/SoapHeader.xml @@ -119,7 +119,7 @@ ## Remarks To set the recipient of a SOAP header, set the property. Regardless of the version of the SOAP protocol used to communicate with an XML Web service, the .NET Framework automatically generates the SOAP message specific to the version of the SOAP protocol. Specifically, the XML element and XML namespace representing the recipient differ for the two versions. - XML Web services receiving the SOAP header can get the intended recipient by getting either the or properties. + XML Web services receiving the SOAP header can get the intended recipient by getting either the or properties. The recipient(s) for the `Body` element and each of the SOAP headers within the `Header` element of a SOAP message need not be the same. If a `Header` element exists in the SOAP message, it represents additional data that can be sent to and from the XML Web service method or an intermediary. The recipient of that data, known as the SOAP `Actor` in version 1.1, can be a different URI than the URI for the XML Web service method. @@ -173,12 +173,12 @@ to `true`. For SOAP headers not defined by the XML Web service, the initial value is `false`. If ASP.NET detects SOAP headers passed to an XML Web service method with set to `false` after the method returns, a is thrown back to the XML Web service client instead of the results from the XML Web service method. + For SOAP headers defined by an XML Web service, ASP.NET assumes the XML Web service method properly processed the SOAP header by setting the initial value of to `true`. For SOAP headers not defined by the XML Web service, the initial value is `false`. If ASP.NET detects SOAP headers passed to an XML Web service method with set to `false` after the method returns, a is thrown back to the XML Web service client instead of the results from the XML Web service method. ## Examples - The following `MyWebService` XML Web service defines the `MyHeader` SOAP header and requires it to be sent with any calls to the `MyWebMethod` XML Web service method. Additionally, the `MyWebMethod` receives any SOAP headers other than the `MyHeader` SOAP header. For SOAP headers that `MyWebMethod` can process, is set to `true`. + The following `MyWebService` XML Web service defines the `MyHeader` SOAP header and requires it to be sent with any calls to the `MyWebMethod` XML Web service method. Additionally, the `MyWebMethod` receives any SOAP headers other than the `MyHeader` SOAP header. For SOAP headers that `MyWebMethod` can process, is set to `true`. :::code language="aspx-csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapHeader/Overview/sourcecs.asmx"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/Classic SoapHeader.DidUnderstand Example/VB/sourcevb.asmx"::: @@ -375,7 +375,7 @@ ## Remarks When an XML Web service client adds a SOAP header to an XML Web service method call with the property set to `true`, the XML Web service method must set the property to `true`; otherwise, a is thrown back to the XML Web service client by ASP.NET. - Although both the and properties can be used to set the value of the `mustUnderstand` attribute within the SOAP header, the property allows you to set the attribute using a Boolean value. + Although both the and properties can be used to set the value of the `mustUnderstand` attribute within the SOAP header, the property allows you to set the attribute using a Boolean value. For details on adding SOAP headers to clients, see [Using SOAP Headers](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/77hkfhh8(v=vs.100)). @@ -481,7 +481,7 @@ ## Remarks To set the recipient of a SOAP header, set the property. Regardless of the version of the SOAP protocol used to communicate with an XML Web service, the .NET Framework automatically generates the SOAP message specific to the version of the SOAP protocol. Specifically, the XML element and XML namespace representing the recipient differ for the two versions. - XML Web services receiving the SOAP header can get the intended recipient by getting either the or properties. + XML Web services receiving the SOAP header can get the intended recipient by getting either the or properties. The recipient(s) for the `Body` element and each of the SOAP headers within the `Header` element of a SOAP message need not be the same. If a `Header` element exists in the SOAP message, it represents additional data that can be sent to and from the XML Web service method or an intermediary. The recipient of that data, known as the SOAP `Role` in version 1.2 of the SOAP specification and the SOAP `Actor` in version 1.1, can be a different URI than the URI for the XML Web service method. diff --git a/xml/System.Web.Services.Protocols/SoapHttpClientProtocol.xml b/xml/System.Web.Services.Protocols/SoapHttpClientProtocol.xml index 31688ea7f7b..c2a4c2a3af6 100644 --- a/xml/System.Web.Services.Protocols/SoapHttpClientProtocol.xml +++ b/xml/System.Web.Services.Protocols/SoapHttpClientProtocol.xml @@ -30,7 +30,7 @@ ## Remarks If you are building an XML Web service client, then a proxy class that derives indirectly or directly from must be created for the XML Web service. When the XML Web service client calls using SOAP, the proxy class must derive from , which derives from . , in turn, derives from . - To communicate with an XML Web service, create a proxy class that derives indirectly or directly from for the XML Web service you want to call. Instead of creating the proxy class manually, use the Web Services Description Language tool (Wsdl.exe) to create a proxy class for a given XML Web service's service description. When a proxy class is generated for the SOAP protocol, synchronous calls to XML Web service methods are made via the method, whereas asynchronous calls are made using the method and the method. + To communicate with an XML Web service, create a proxy class that derives indirectly or directly from for the XML Web service you want to call. Instead of creating the proxy class manually, use the Web Services Description Language tool (Wsdl.exe) to create a proxy class for a given XML Web service's service description. When a proxy class is generated for the SOAP protocol, synchronous calls to XML Web service methods are made via the method, whereas asynchronous calls are made using the method and the method. @@ -112,20 +112,20 @@ method directly, unless you were building your own proxy class for an XML Web service. + Typically, you would not call the method directly, unless you were building your own proxy class for an XML Web service. A proxy class generated by the Web Services Description Language tool (Wsdl.exe) from a Service Description exposes the XML Web service methods as names derived from the proxy class to call the XML Web service methods synchronously. To call the XML Web service methods asynchronously, two additional methods are added to the proxy class for each XML Web service method, one with the `Begin` prefix added to the name of the XML Web service method and one with the `End` prefix added. - The proxy class calls the method to start an asynchronous invocation call to the XML Web service method. For example, if an XML Web service exposes an XML Web service method named `Add`, the proxy class contains a method named `BeginAdd`, for starting an invocation to the XML Web service method. Within the code for the `BeginAdd`, a call is made to the method and the results are placed into the expected return type for `Add`. + The proxy class calls the method to start an asynchronous invocation call to the XML Web service method. For example, if an XML Web service exposes an XML Web service method named `Add`, the proxy class contains a method named `BeginAdd`, for starting an invocation to the XML Web service method. Within the code for the `BeginAdd`, a call is made to the method and the results are placed into the expected return type for `Add`. The `methodName` is used to find the custom attributes which may have been added to the method, such as . provides additional information about the derived method that is required for the SOAP protocol. - `asyncState` is passed into `callback` and is included in the that is returned from the method. The `asyncState` parameter can be used to pass information about the context of the asynchronous call, specified in the `callback` parameter, to the delegate that handles the result. + `asyncState` is passed into `callback` and is included in the that is returned from the method. The `asyncState` parameter can be used to pass information about the context of the asynchronous call, specified in the `callback` parameter, to the delegate that handles the result. ## Examples - The following code example is a proxy class generated by the Web Services Description Language tool (Wsdl.exe) for the `Math` XML Web service. Within the `BeginAdd` method of the proxy class, the method is starting an asynchronous invocation to the `Add` XML Web service method. + The following code example is a proxy class generated by the Web Services Description Language tool (Wsdl.exe) for the `Math` XML Web service. Within the `BeginAdd` method of the proxy class, the method is starting an asynchronous invocation to the `Add` XML Web service method. [!code-cpp[Classic SoapHttpClientProtocol.BeginInvoke Example#1](~/snippets/cpp/VS_Snippets_Remoting/Classic SoapHttpClientProtocol.BeginInvoke Example/CPP/source.cpp#1)] [!code-csharp[Classic SoapHttpClientProtocol.BeginInvoke Example#1](~/snippets/csharp/System.Web.Services.Protocols/SoapHttpClientProtocol/EndInvoke/source.cs#1)] @@ -172,7 +172,7 @@ method. Typically, the property refers to the base address of the XML Web service. However, before invoking the method, set the property to a URL of a discovery document. The method attempts to find a match in the discovery document to the binding defined in the proxy class and then dynamically bind to it. If successful, subsequent method calls are directed to the XML Web service described in the discovery document. + An XML Web service client can dynamically bind to an XML Web service other than the one referenced in the proxy class using the method. Typically, the property refers to the base address of the XML Web service. However, before invoking the method, set the property to a URL of a discovery document. The method attempts to find a match in the discovery document to the binding defined in the proxy class and then dynamically bind to it. If successful, subsequent method calls are directed to the XML Web service described in the discovery document. If the proxy class is built using the Web Services Description Language tool (Wsdl.exe), the proxy class defines the binding implemented by the XML Web service methods it invokes using the . When an XML Web service implements multiple bindings, Wsdl.exe creates a proxy class for each binding. Applied to each proxy class is a that defines the name of the binding and its namespace. The discovery document you set the property to must contain a reference to an XML Web service that implements the same binding name and namespace, or an exception is thrown. @@ -185,7 +185,7 @@ [!code-csharp[SoapHttpClientProtocol.Discover Example#1](~/snippets/csharp/System.Web.Services.Protocols/SoapHttpClientProtocol/Discover/source.cs#1)] [!code-vb[SoapHttpClientProtocol.Discover Example#1](~/snippets/visualbasic/System.Web.Services.Protocols/SoapHttpClientProtocol/Discover/source.vb#1)] - The following code example is a Web Service client using the preceding proxy class. Within the `EnterBtn_Click` event of the Web Form, the XML Web service client calls the method attempting to dynamically bind to the URL supplied by the user. + The following code example is a Web Service client using the preceding proxy class. Within the `EnterBtn_Click` event of the Web Form, the XML Web service client calls the method attempting to dynamically bind to the URL supplied by the user. > [!IMPORTANT] > This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -233,16 +233,16 @@ The proxy class does not have a binding defined. method directly, unless you were building your own proxy class for an XML Web service. + Typically, you would not call the method directly, unless you were building your own proxy class for an XML Web service. A proxy class generated by the Web Services Description Language tool (Wsdl.exe) for an XML Web service exposes the XML Web service methods as names off of the proxy class for calling the XML Web service methods synchronously. For calling the XML Web service methods asynchronously, two additional methods are added to the proxy class for each XML Web service method, one with the `Begin` prefix added to the name of the XML Web service method and one with the `End` prefix added. - The proxy class calls the method to complete an asynchronous invocation call to the XML Web service method. For example, if an XML Web service exposes an XML Web service method named `Add`, the proxy class contains a method named `EndAdd`, for completing an asynchronous invocation of an XML Web service method. Within the code for the `EndAdd` a call is made to the method and then the results are placed into the expected return type for `Add`. + The proxy class calls the method to complete an asynchronous invocation call to the XML Web service method. For example, if an XML Web service exposes an XML Web service method named `Add`, the proxy class contains a method named `EndAdd`, for completing an asynchronous invocation of an XML Web service method. Within the code for the `EndAdd` a call is made to the method and then the results are placed into the expected return type for `Add`. ## Examples - The following code example is a proxy class generated by Wsdl.exe for the `Math` XML Web service. Within the `EndAdd` method of the proxy class, the method completes the asynchronous invocation to the `Add` XML Web service method. + The following code example is a proxy class generated by Wsdl.exe for the `Math` XML Web service. Within the `EndAdd` method of the proxy class, the method completes the asynchronous invocation to the `Add` XML Web service method. [!code-cpp[Classic SoapHttpClientProtocol.EndInvoke Example#1](~/snippets/cpp/VS_Snippets_Remoting/Classic SoapHttpClientProtocol.EndInvoke Example/CPP/source.cpp#1)] [!code-csharp[Classic SoapHttpClientProtocol.EndInvoke Example#1](~/snippets/csharp/System.Web.Services.Protocols/SoapHttpClientProtocol/Invoke/source.cs#1)] @@ -391,16 +391,16 @@ The proxy class does not have a binding defined. method directly, unless you are building your own proxy class for an XML Web service. + Typically, you do not call the method directly, unless you are building your own proxy class for an XML Web service. - A proxy class generated by the Web Services Description Language tool (Wsdl.exe) for an XML Web service exposes the XML Web service methods as names off of the proxy class. The proxy class calls the method to invoke an XML Web service method call. For example, if an XML Web service exposes an XML Web service method named `Add`, the proxy class also contains a method named `Add`. Within the code for the `Add` method in the proxy class, a synchronous call is made to the XML Web service method through the method and then the results are placed into the expected return type for `Add`. + A proxy class generated by the Web Services Description Language tool (Wsdl.exe) for an XML Web service exposes the XML Web service methods as names off of the proxy class. The proxy class calls the method to invoke an XML Web service method call. For example, if an XML Web service exposes an XML Web service method named `Add`, the proxy class also contains a method named `Add`. Within the code for the `Add` method in the proxy class, a synchronous call is made to the XML Web service method through the method and then the results are placed into the expected return type for `Add`. The `methodName` parameter is used to find the custom attributes that may have been added to the method, such as . provides additional information on the derived method which is required for the SOAP protocol. ## Examples - The following code example is a proxy class generated by Wsdl.exe for the `Math` XML Web service. Within the `Add` method of the proxy class, the method is calling the `Add` XML Web service method. + The following code example is a proxy class generated by Wsdl.exe for the `Math` XML Web service. Within the `Add` method of the proxy class, the method is calling the `Add` XML Web service method. [!code-cpp[Classic SoapHttpClientProtocol.Invoke Example#1](~/snippets/cpp/VS_Snippets_Remoting/Classic SoapHttpClientProtocol.Invoke Example/CPP/source.cpp#1)] [!code-csharp[Classic SoapHttpClientProtocol.Invoke Example#1](~/snippets/csharp/System.Web.Services.Protocols/SoapHttpClientProtocol/Overview/source.cs#1)] diff --git a/xml/System.Web.Services.Protocols/SoapMessage.xml b/xml/System.Web.Services.Protocols/SoapMessage.xml index 356e6b3f52e..72b84f1bfaa 100644 --- a/xml/System.Web.Services.Protocols/SoapMessage.xml +++ b/xml/System.Web.Services.Protocols/SoapMessage.xml @@ -22,9 +22,9 @@ class is for SOAP extensions, representing the data in a SOAP request or SOAP response. When the method is called, a receives a at each . It is up to the particular SOAP extension to choose how to process the . Common SOAP extensions include encryption and compression. + The primary use of the class is for SOAP extensions, representing the data in a SOAP request or SOAP response. When the method is called, a receives a at each . It is up to the particular SOAP extension to choose how to process the . Common SOAP extensions include encryption and compression. - SOAP extensions can be applied to either or both an XML Web service method created using ASP.NET or an XML Web service client. When a SOAP extension is applied to an XML Web service method, the method receives an instance of , which derives from . Likewise, when a SOAP extension is applied to an XML Web service client, receives an instance of . + SOAP extensions can be applied to either or both an XML Web service method created using ASP.NET or an XML Web service client. When a SOAP extension is applied to an XML Web service method, the method receives an instance of , which derives from . Likewise, when a SOAP extension is applied to an XML Web service client, receives an instance of . @@ -176,7 +176,7 @@ ## Remarks The asserted stage is different for XML Web service clients and XML Web service methods. An XML Web service method's in parameters are available after the SOAP request is deserialized in the stage. For an XML Web service client, the in parameters are available prior to the SOAP request serialization process in the stage. - can be called during any , however an is thrown when in parameters are not available. + can be called during any , however an is thrown when in parameters are not available. ]]> @@ -209,7 +209,7 @@ ## Remarks The asserted stage is different for XML Web service clients and XML Web service methods. An XML Web service method's out parameters are available prior to the SOAP response serialization process in the stage. In an XML Web service client, the out parameters are available after the SOAP response deserialization process in the stage. - can be called during any , however an is thrown when out parameters are not available. + can be called during any , however an is thrown when out parameters are not available. ]]> @@ -245,7 +245,7 @@ ## Remarks Multiple stages can be asserted by performing a bitwise OR operation on multiple instances of the class. - can be called during any . + can be called during any . @@ -491,7 +491,7 @@ can be accessed during any , it only has data during and . + Although can be accessed during any , it only has data during and . @@ -616,7 +616,7 @@ ## Examples - The following code example demonstrates how to determine the within the method. + The following code example demonstrates how to determine the within the method. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/Classic SoapExtension.ProcessMessage Example/CPP/source.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapMessage/Stage/source.cs" id="Snippet1"::: @@ -652,9 +652,9 @@ ## Remarks SOAP extensions that inspect the data representing a SOAP request or SOAP response, such as a logging SOAP extension, can use the `Stream` property to view the data at each . - SOAP extensions that modify the data representing a SOAP request or SOAP response, such as encryption or compression SOAP extensions, should do so with the passed into the method of . The property of passed into is read-only. + SOAP extensions that modify the data representing a SOAP request or SOAP response, such as encryption or compression SOAP extensions, should do so with the passed into the method of . The property of passed into is read-only. - For more information on modifying the data representing a SOAP request or SOAP response, see . + For more information on modifying the data representing a SOAP request or SOAP response, see . diff --git a/xml/System.Web.Services.Protocols/SoapMessageStage.xml b/xml/System.Web.Services.Protocols/SoapMessageStage.xml index 8dcfbf76f47..381fde9d157 100644 --- a/xml/System.Web.Services.Protocols/SoapMessageStage.xml +++ b/xml/System.Web.Services.Protocols/SoapMessageStage.xml @@ -18,8 +18,8 @@ Specifies the processing stage of a SOAP message. - that can inspect or modify a message at specific stages in message processing on either the client or the server. This enumeration specifies the processing stage of the . @@ -30,17 +30,17 @@ The following table shows when each stage occurs during SOAP client and server p |---|---|---| |`AfterDeserialize`|Occurs after the SOAP message containing the response from an XML Web service method invocation has been deserialized into an object, but prior to the client receiving the deserialized results.|Occurs after a network request containing a SOAP message representing an XML Web service method invocation is deserialized into an object, but prior to the method on that object representing the XML Web service method is called.| |`AfterSerialize`|Occurs after a client invokes an XML Web service method and the parameters are serialized into XML, but prior to the SOAP message containing that XML is sent over the network.|Occurs after an XML Web service method returns and any return values are serialized into XML, but prior to the SOAP message containing that XML is sent over the network.| -|`BeforeDeserialize`|Occurs after the network response from an XML Web service method invocation has been received, but just before the response containing the SOAP message is deserialized into an object.|Occurs after a network request containing the SOAP message for an XML Web service method invocation is received by the Web server, but prior to the SOAP message being deserialized into an object.| +|`BeforeDeserialize`|Occurs after the network response from an XML Web service method invocation has been received, but just before the response containing the SOAP message is deserialized into an object.|Occurs after a network request containing the SOAP message for an XML Web service method invocation is received by the Web server, but prior to the SOAP message being deserialized into an object.| |`BeforeSerialize`|Occurs after a client invokes an XML Web service method, but prior to the invocation being serialized.|Occurs after the invocation to the XML Web service method returns, but prior to the return values being serialized and sent over the wire back to the client.| -## Examples +## Examples + +The following example is a fragment of a SOAP extension, which implements the method. Within the method, processing of a is handled specific to the . -The following example is a fragment of a SOAP extension, which implements the method. Within the method, processing of a is handled specific to the . - :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/SoapMessageState/CPP/SoapMessageState.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/SoapMessageStage/Overview/soapmessagestate.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Protocols/SoapMessageStage/Overview/soapmessagestate.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/System.Web.Services.Protocols/SoapMessageStage/Overview/soapmessagestate.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Web.Services.Protocols/SoapProtocolVersion.xml b/xml/System.Web.Services.Protocols/SoapProtocolVersion.xml index 0a0c51977c5..223ee1013ec 100644 --- a/xml/System.Web.Services.Protocols/SoapProtocolVersion.xml +++ b/xml/System.Web.Services.Protocols/SoapProtocolVersion.xml @@ -17,11 +17,11 @@ Specifies the version of the SOAP protocol used to communicate with an XML Web service. - and properties. - + and properties. + ]]> diff --git a/xml/System.Web.Services.Protocols/SoapServerMessage.xml b/xml/System.Web.Services.Protocols/SoapServerMessage.xml index 2dcb58c7b8a..fc85539612d 100644 --- a/xml/System.Web.Services.Protocols/SoapServerMessage.xml +++ b/xml/System.Web.Services.Protocols/SoapServerMessage.xml @@ -21,7 +21,7 @@ passed into the method of the SOAP extension by writing properties of the to the log file. + The following code fragment is part of a SOAP extension that logs the SOAP messages sent and received by an XML Web service method. This specific fragment processes the passed into the method of the SOAP extension by writing properties of the to the log file. @@ -214,7 +214,7 @@ property is an instance of the class implementing the XML Web service. If a SOAP extension knew ahead of time the type of the class, it could cast to that type and access properties and methods of the class implementing the XML Web service. The property can be accessed during or . + The property is an instance of the class implementing the XML Web service. If a SOAP extension knew ahead of time the type of the class, it could cast to that type and access properties and methods of the class implementing the XML Web service. The property can be accessed during or . diff --git a/xml/System.Web.Services.Protocols/SoapServerProtocol.xml b/xml/System.Web.Services.Protocols/SoapServerProtocol.xml index 8844e0cf2df..775ea321e1e 100644 --- a/xml/System.Web.Services.Protocols/SoapServerProtocol.xml +++ b/xml/System.Web.Services.Protocols/SoapServerProtocol.xml @@ -17,11 +17,11 @@ The .NET Framework creates an instance of the class to process XML Web service requests. - method to process XML Web service requests that are not explicitly declared and handled by users through a method in their XML Web service marked with `WebMethodAttribute`. - + method to process XML Web service requests that are not explicitly declared and handled by users through a method in their XML Web service marked with `WebMethodAttribute`. + ]]> @@ -152,11 +152,11 @@ Returns the to which the specified should be routed. The to which the specified by should be routed. - method to process XML Web service requests that are not explicitly declared and handled by users through a method in their XML Web service marked with `WebMethodAttribute`. - + method to process XML Web service requests that are not explicitly declared and handled by users through a method in their XML Web service marked with `WebMethodAttribute`. + ]]> diff --git a/xml/System.Web.Services.Protocols/TextReturnReader.xml b/xml/System.Web.Services.Protocols/TextReturnReader.xml index 82dd1e3d4b5..678d41efef8 100644 --- a/xml/System.Web.Services.Protocols/TextReturnReader.xml +++ b/xml/System.Web.Services.Protocols/TextReturnReader.xml @@ -18,19 +18,19 @@ Reads return values from HTTP response text for Web service clients implemented using HTTP but without SOAP. - and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. - - The class implements the client-side reading of non-XML text into Web method return values. To obtain a return value, the text, which is encoded in the body of an HTTP response, is parsed using regular expression pattern matching, as specified by the attribute , which can be applied to a Web method in a client proxy class. The class calls the class to actually perform the pattern matching. - - Text pattern matching provides a way for Web services to retrieve HTML content without converting it to XML documents that must be bound to XML Schema definitions. Regular expression search targets are specified in a Web Services Description Language (WSDL) document via `match` XML elements within `text` elements. Both elements belong to the namespace `http://microsoft.com/wsdl/mime/textMatching/`. - - When **match** elements are specified in a WSDL document, the Wsdl.exe tool applies attributes to the corresponding Web methods in the client proxy class that is generated. Also, is used in place of , the default class for deserializing Web method return values according to the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. - - You typically will not need to use the class directly. - + and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. + + The class implements the client-side reading of non-XML text into Web method return values. To obtain a return value, the text, which is encoded in the body of an HTTP response, is parsed using regular expression pattern matching, as specified by the attribute , which can be applied to a Web method in a client proxy class. The class calls the class to actually perform the pattern matching. + + Text pattern matching provides a way for Web services to retrieve HTML content without converting it to XML documents that must be bound to XML Schema definitions. Regular expression search targets are specified in a Web Services Description Language (WSDL) document via `match` XML elements within `text` elements. Both elements belong to the namespace `http://microsoft.com/wsdl/mime/textMatching/`. + + When **match** elements are specified in a WSDL document, the Wsdl.exe tool applies attributes to the corresponding Web methods in the client proxy class that is generated. Also, is used in place of , the default class for deserializing Web method return values according to the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. + + You typically will not need to use the class directly. + ]]> @@ -83,13 +83,13 @@ Returns an initializer for the specified method. An initializer for the specified method. - method. For the class, the initializer is a object based on the return type of the Web method. - - The method is invoked during service initialization. Later, at the time a response is processed, the initializer object is passed to the method of another instance. The other instance performs the actual reading. - + method. For the class, the initializer is a object based on the return type of the Web method. + + The method is invoked during service initialization. Later, at the time a response is processed, the initializer object is passed to the method of another instance. The other instance performs the actual reading. + ]]> @@ -118,11 +118,11 @@ A object for the return type of the Web method being invoked. Initializes an instance. - method supplies the object used by the method to parse text contained in the HTTP response. The method is invoked at the time a request is processed. The input parameter, `o`, is obtained by calling the method on another instance of the class that is obtained during client initialization. - + method supplies the object used by the method to parse text contained in the HTTP response. The method is invoked at the time a request is processed. The input parameter, `o`, is obtained by calling the method on another instance of the class that is obtained during client initialization. + ]]> @@ -154,11 +154,11 @@ Parses text contained in the HTTP response. An object containing the deserialized Web method return value. - class's implementation of the method uses the object passed as an argument to the method. It closes the response stream before returning the deserialized Web method return value. - + class's implementation of the method uses the object passed as an argument to the method. It closes the response stream before returning the deserialized Web method return value. + ]]> diff --git a/xml/System.Web.Services.Protocols/UrlEncodedParameterWriter.xml b/xml/System.Web.Services.Protocols/UrlEncodedParameterWriter.xml index 3fe55b3f896..b6ee0264663 100644 --- a/xml/System.Web.Services.Protocols/UrlEncodedParameterWriter.xml +++ b/xml/System.Web.Services.Protocols/UrlEncodedParameterWriter.xml @@ -97,7 +97,7 @@ method calls the other overload, , for each of the parameter values, including individual items in arrays. + This overload of the method calls the other overload, , for each of the parameter values, including individual items in arrays. ]]> @@ -134,7 +134,7 @@ method, , which is called for each Web method, calls this signature of the method for each of the parameter values, including individual items in arrays. + The other signature of the method, , which is called for each Web method, calls this signature of the method for each of the parameter values, including individual items in arrays. ]]> @@ -168,7 +168,7 @@ method. For the class, the initializer is the value of the property of the input object. The property is a array. The method is invoked during service initialization. Later, at the time a request is populated, the initializer object is passed to the method of another instance. The other object performs the actual writing. + An initializer is an object passed as a parameter to the method. For the class, the initializer is the value of the property of the input object. The property is a array. The method is invoked during service initialization. Later, at the time a request is populated, the initializer object is passed to the method of another instance. The other object performs the actual writing. ]]> @@ -201,9 +201,9 @@ method is invoked at the time a request is populated. + The method is invoked at the time a request is populated. - The input parameter, `initializer`, is obtained by calling the method on another instance during client initialization. + The input parameter, `initializer`, is obtained by calling the method on another instance during client initialization. ]]> diff --git a/xml/System.Web.Services.Protocols/UrlParameterReader.xml b/xml/System.Web.Services.Protocols/UrlParameterReader.xml index 3fd435bf14c..5c683b5adcf 100644 --- a/xml/System.Web.Services.Protocols/UrlParameterReader.xml +++ b/xml/System.Web.Services.Protocols/UrlParameterReader.xml @@ -23,7 +23,7 @@ ## Remarks and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. - The class provides a service-side method, , to read parameter name/value pairs that are encoded into an HTTP request URL's query string. For example, in the URL `http://contoso.com?a=1&b=2`, `a` and `b` are parameter names, and `1` and `2` are their values. + The class provides a service-side method, , to read parameter name/value pairs that are encoded into an HTTP request URL's query string. For example, in the URL `http://contoso.com?a=1&b=2`, `a` and `b` are parameter names, and `1` and `2` are their values. You typically will not need to use directly. HTTP-GET Web services are enabled when an ASP.NET configuration file's (Web.config) `protocols` element contains an `add` element whose name attribute's value is "`HttpGet`". The class is automatically used when an HTTP-GET Web service is enabled and an applicable HTTP request is received. @@ -81,7 +81,7 @@ method uses the content of the object's property. + The method uses the content of the object's property. ]]> diff --git a/xml/System.Web.Services.Protocols/UrlParameterWriter.xml b/xml/System.Web.Services.Protocols/UrlParameterWriter.xml index 2e67df1b968..761fbe73e46 100644 --- a/xml/System.Web.Services.Protocols/UrlParameterWriter.xml +++ b/xml/System.Web.Services.Protocols/UrlParameterWriter.xml @@ -24,7 +24,7 @@ ## Remarks and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. - The class provides a client-side method, , to encode parameters name/value pairs into an HTTP request URL's query string. For example, in the URL `http://contoso.com?a=1&b=2`, `a` and `b` are parameter names, and `1` and `2` are their values. + The class provides a client-side method, , to encode parameters name/value pairs into an HTTP request URL's query string. For example, in the URL `http://contoso.com?a=1&b=2`, `a` and `b` are parameter names, and `1` and `2` are their values. You typically will not need to use directly. Instead, when the Wsdl.exe tool generates client proxy code according to the HTTP-GET implementation, it applies the to each Web method and sets the attribute's property to . @@ -84,7 +84,7 @@ method encodes parameters name/value pairs into an HTTP request URL's query string. For example, in the URL `http://contoso.com?a=1&b=2`, `a` and `b` are parameter names, and `1` and `2` are their values. A new URL string, with any encoded parameters, is returned. + The method encodes parameters name/value pairs into an HTTP request URL's query string. For example, in the URL `http://contoso.com?a=1&b=2`, `a` and `b` are parameter names, and `1` and `2` are their values. A new URL string, with any encoded parameters, is returned. ]]> diff --git a/xml/System.Web.Services.Protocols/ValueCollectionParameterReader.xml b/xml/System.Web.Services.Protocols/ValueCollectionParameterReader.xml index 8ba2940c3cc..5efcc0e0247 100644 --- a/xml/System.Web.Services.Protocols/ValueCollectionParameterReader.xml +++ b/xml/System.Web.Services.Protocols/ValueCollectionParameterReader.xml @@ -21,7 +21,7 @@ and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. The class provides, among other methods, a common method for all service-side readers of collections of name/value pairs into Web method parameters. The name/value pairs have been parsed from an incoming HTTP request. + and other classes in the namespace support the .NET Framework's implementations of Web services via the HTTP-GET and HTTP-POST operations. Web service writers and readers serialize and deserialize, respectively, between the parameters or return objects of Web methods and the HTTP request or response streams. Web service writers and readers use HTTP for transport but don't exchange messages using the SOAP standard. The class provides, among other methods, a common method for all service-side readers of collections of name/value pairs into Web method parameters. The name/value pairs have been parsed from an incoming HTTP request. You typically will not need to use or its descendant classes directly. The appropriate types are used according to settings in an ASP.NET configuration file (Web.config). @@ -80,9 +80,9 @@ method is the property of the `methodinfo` parameter. The property value is an array of type . + The object returned by the method is the property of the `methodinfo` parameter. The property value is an array of type . - The method is invoked during service initialization. Later, at the time a request is processed, the initializer object is passed to the method of another instance. The other instance performs the actual reading. + The method is invoked during service initialization. Later, at the time a request is processed, the initializer object is passed to the method of another instance. The other instance performs the actual reading. ]]> @@ -115,9 +115,9 @@ method is invoked at the time a request is processed. + The method is invoked at the time a request is processed. - The input parameter, `o`, is obtained by calling the method on another instance during service initialization. + The input parameter, `o`, is obtained by calling the method on another instance during service initialization. ]]> @@ -216,7 +216,7 @@ method is called by the method defined in the two classes derived from , and . Those two classes' methods take an parameter. + The method is called by the method defined in the two classes derived from , and . Those two classes' methods take an parameter. ]]> diff --git a/xml/System.Web.Services.Protocols/WebClientAsyncResult.xml b/xml/System.Web.Services.Protocols/WebClientAsyncResult.xml index 17dd74ef161..d54738fe091 100644 --- a/xml/System.Web.Services.Protocols/WebClientAsyncResult.xml +++ b/xml/System.Web.Services.Protocols/WebClientAsyncResult.xml @@ -60,7 +60,7 @@ method. If the corresponding `End` method is subsequently called after the method, a is thrown, setting the property to . + The XML Web service request is canceled if the underlying transport supports the method. If the corresponding `End` method is subsequently called after the method, a is thrown, setting the property to . ]]> @@ -120,9 +120,9 @@ can be used to perform a , , or to wait for the asynchronous call to complete. + The can be used to perform a , , or to wait for the asynchronous call to complete. - For more details, see . + For more details, see . ]]> @@ -157,7 +157,7 @@ is set to `true` within the delegate, it is probable that the thread that called is the current thread. In this case, you should be careful about making another asynchronous Begin call from the callback method, since it can cause the stack to grow without bound if the calls continue to complete synchronously. Instead, the call should be completed at the original call site, outside the callback method. + If is set to `true` within the delegate, it is probable that the thread that called is the current thread. In this case, you should be careful about making another asynchronous Begin call from the callback method, since it can cause the stack to grow without bound if the calls continue to complete synchronously. Instead, the call should be completed at the original call site, outside the callback method. ]]> diff --git a/xml/System.Web.Services.Protocols/WebClientProtocol.xml b/xml/System.Web.Services.Protocols/WebClientProtocol.xml index bf0d645eebb..68f0b5ffe7d 100644 --- a/xml/System.Web.Services.Protocols/WebClientProtocol.xml +++ b/xml/System.Web.Services.Protocols/WebClientProtocol.xml @@ -167,7 +167,7 @@ property enables you to associate a request to a connection group. For more details, see . + The property enables you to associate a request to a connection group. For more details, see . ]]> @@ -201,7 +201,7 @@ ## Remarks When using the `Credentials` property, a XML Web service client must instantiate a class implementing , such as , and then set the client credentials specific to the authentication mechanism. The class can be used to set authentication credentials using the basic, digest, NTLM and Kerberos authentication mechanisms. - When the property is set to then the client negotiates with the server to do Kerberos and/or NTLM authentication depending on how the server is configured. + When the property is set to then the client negotiates with the server to do Kerberos and/or NTLM authentication depending on how the server is configured. @@ -398,9 +398,9 @@ is `true`, the `WWW-authenticate` header is sent with all subsequent requests. + When a client requests a resource without using credentials, the server challenges the request and indicates what authentication schemes it supports. The client chooses an authentication scheme and sends the appropriate `WWW-authenticate` header to the server. When is `true`, the `WWW-authenticate` header is sent with all subsequent requests. - When is `false`, a request is made to the XML Web service method without initially attempting to authenticate the user. If the XML Web service allows anonymous access, then the XML Web service method is executed. If anonymous access is disallowed, a 401 HTTP return code is sent back to the client. In response, the class returns authentication credentials to the Web server. If the client is authenticated and subsequently authorized to access the XML Web service, the XML Web service method is executed; otherwise the client is denied access. + When is `false`, a request is made to the XML Web service method without initially attempting to authenticate the user. If the XML Web service allows anonymous access, then the XML Web service method is executed. If anonymous access is disallowed, a 401 HTTP return code is sent back to the client. In response, the class returns authentication credentials to the Web server. If the client is authenticated and subsequently authorized to access the XML Web service, the XML Web service method is executed; otherwise the client is denied access. ]]> @@ -445,7 +445,7 @@ determines the encoding for the request message. The of the request will be annotated with the encoding value. + The determines the encoding for the request message. The of the request will be annotated with the encoding value. Classes deriving from support a particular protocol, such as does for SOAP, set this property to conform to encoding requirements for the specific protocol. For example, the sets the default encoding to UTF-8. @@ -561,9 +561,9 @@ property for the client to use. The default is determined by the location attribute found in the service description from which the proxy class was generated. + Proxy classes generated using Wsdl.exe will set a default property for the client to use. The default is determined by the location attribute found in the service description from which the proxy class was generated. - Derived classes supporting specific protocols, such as and might add extra information to to make the XML Web service request. + Derived classes supporting specific protocols, such as and might add extra information to to make the XML Web service request. The property can be changed to refer to any XML Web service that implements the same service description that the proxy class was generated from. diff --git a/xml/System.Web.Services.Protocols/XmlReturnReader.xml b/xml/System.Web.Services.Protocols/XmlReturnReader.xml index b87b88ab77c..c3fbcd75d97 100644 --- a/xml/System.Web.Services.Protocols/XmlReturnReader.xml +++ b/xml/System.Web.Services.Protocols/XmlReturnReader.xml @@ -81,7 +81,7 @@ ## Remarks An initializer is an object passed as a parameter to the Initialize method. For the class, the initializer is an object for the return type of the Web method. - The method is invoked during service initialization. Later, at the time a response is processed, the initializer object is passed to the method of another instance. The other instance performs the actual reading. + The method is invoked during service initialization. Later, at the time a response is processed, the initializer object is passed to the method of another instance. The other instance performs the actual reading. ]]> @@ -117,7 +117,7 @@ ## Remarks An initializer is an object passed as a parameter to the Initialize method. For the class, the initializer is an object for the return type of the Web method. - The method is invoked during service initialization. Later, at the time a response is processed, the initializer object for each Web method is passed to the method of another instance. The other instance performs the actual reading. + The method is invoked during service initialization. Later, at the time a response is processed, the initializer object for each Web method is passed to the method of another instance. The other instance performs the actual reading. ]]> @@ -150,9 +150,9 @@ method supplies the object used by the method to deserialize an XML document contained in the HTTP response. + The method supplies the object used by the method to deserialize an XML document contained in the HTTP response. - The method is invoked at the time a request is processed. The input parameter, `o`, is obtained by calling the or method on another instance during client initialization. + The method is invoked at the time a request is processed. The input parameter, `o`, is obtained by calling the or method on another instance during client initialization. ]]> @@ -188,7 +188,7 @@ class's implementation of the method uses the object passed as an argument to the method. It throws an exception if the HTTP response's MIME content type is not `text/xml`. The method closes the response before returning the deserialized Web method return value. + To deserialize the XML content of the HTTP response, the class's implementation of the method uses the object passed as an argument to the method. It throws an exception if the HTTP response's MIME content type is not `text/xml`. The method closes the response before returning the deserialized Web method return value. ]]> diff --git a/xml/System.Web.Services/WebMethodAttribute.xml b/xml/System.Web.Services/WebMethodAttribute.xml index 09b07af32ef..2c0aff961b0 100644 --- a/xml/System.Web.Services/WebMethodAttribute.xml +++ b/xml/System.Web.Services/WebMethodAttribute.xml @@ -266,9 +266,9 @@ to `true`, serializes the response of the XML Web service method into a memory buffer until either the response is completely serialized or the buffer is full. Once the response is buffered, it is returned to the XML Web service client over the network. When is `false`, the response to the XML Web service method is sent back to the client as it is serialized. In general, you only want to set to `false`, if it is known that an XML Web service method returns large amounts of data to the client. For smaller amounts of data, XML Web service performance is better with to `true`. + Setting to `true`, serializes the response of the XML Web service method into a memory buffer until either the response is completely serialized or the buffer is full. Once the response is buffered, it is returned to the XML Web service client over the network. When is `false`, the response to the XML Web service method is sent back to the client as it is serialized. In general, you only want to set to `false`, if it is known that an XML Web service method returns large amounts of data to the client. For smaller amounts of data, XML Web service performance is better with to `true`. - When is `false`, SOAP extensions are disabled for the XML Web service method. + When is `false`, SOAP extensions are disabled for the XML Web service method. @@ -436,7 +436,7 @@ property can be used to alias method or property names. The most common use of the property will be to uniquely identify polymorphic methods. By default, is set to the name of the XML Web service method. Therefore, if an XML Web service contains two or more XML Web service methods with the same name, you can uniquely identify the individual XML Web service methods by setting the to a name unique within the XML Web service, without changing the name of the actual method name in code. + The property can be used to alias method or property names. The most common use of the property will be to uniquely identify polymorphic methods. By default, is set to the name of the XML Web service method. Therefore, if an XML Web service contains two or more XML Web service methods with the same name, you can uniquely identify the individual XML Web service methods by setting the to a name unique within the XML Web service, without changing the name of the actual method name in code. When data is passed to an XML Web service it is sent in a request and when it is returned it is sent in a response. Within the request and response, the name used for the XML Web service method is its property. @@ -447,7 +447,7 @@ ## Examples - In the example below, is used to disambiguate the two `Add` methods. + In the example below, is used to disambiguate the two `Add` methods. :::code language="aspx-csharp" source="~/snippets/csharp/System.Web.Services/WebMethodAttribute/MessageName/sourcecs.asmx"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/Classic WebMethodAttribute.MessageName Example/VB/sourcevb.asmx"::: diff --git a/xml/System.Web.Services/WebService.xml b/xml/System.Web.Services/WebService.xml index 002fa24cc4d..4e02d84fedb 100644 --- a/xml/System.Web.Services/WebService.xml +++ b/xml/System.Web.Services/WebService.xml @@ -21,7 +21,7 @@ . Additional ASP.NET objects can be accessed through . + If you don't need access to the common ASP.NET objects, you can still create an XML Web service without deriving from . Additional ASP.NET objects can be accessed through . XML Web service methods that have the property of either or set to `true`, do not have access to their . As such, accessing any of the properties of the class, from within that XML Web service method, return `null`. @@ -196,7 +196,7 @@ class provides several methods that can be used in the processing of Web requests, including (for instantiating COM objects). + The class provides several methods that can be used in the processing of Web requests, including (for instantiating COM objects). diff --git a/xml/System.Web.Services/WebServiceAttribute.xml b/xml/System.Web.Services/WebServiceAttribute.xml index 75dc946dc00..17283431fd2 100644 --- a/xml/System.Web.Services/WebServiceAttribute.xml +++ b/xml/System.Web.Services/WebServiceAttribute.xml @@ -166,14 +166,14 @@ An XML qualified name is used to disambiguate elements with the same name with an XML document. An XML qualified name consists of the following two parts separated by a colon: namespace or a prefix associated with a namespace and local part. The namespace consists of a URI reference and for the purposes of the Service Description, is the value of the property. In general, a prefix, which acts like an alias to an URI, is associated with the namespace, so that all subsequent XML qualified names using the namespace can use the shortened prefix. The local part is a string beginning with a letter or underscore containing no spaces. Therefore, the XML qualified name identifying a XML Web service in the Service Description is in the following format: - : + : For more information on XML qualified names, see [Namespaces in XML 1.0](https://www.w3.org/TR/REC-xml-names/). ## Examples - The following example sets of the XML Web service to `MyName`. + The following example sets of the XML Web service to `MyName`. :::code language="aspx-csharp" source="~/snippets/csharp/System.Web.Services/WebServiceAttribute/Name/sourcecs.asmx"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/Classic WebServiceAttribute.Name Example/VB/sourcevb.asmx"::: @@ -210,9 +210,9 @@ ## Remarks XML namespaces offer a way to create names in an XML document that are identified by a Uniform Resource Identifier (URI). By using XML namespaces you can uniquely identify elements or attributes in a XML document. The service description for a XML Web service is defined in XML, specifically in Web Services Description Language (WSDL). - Within the Service Description for an XML Web service, is used as the default namespace for XML elements directly pertaining to the XML Web service. For example, the name of the XML Web service and its XML Web service methods pertain to the namespace specified in the `Namespace` property. Elements that are specific to WSDL pertain to the namespace. + Within the Service Description for an XML Web service, is used as the default namespace for XML elements directly pertaining to the XML Web service. For example, the name of the XML Web service and its XML Web service methods pertain to the namespace specified in the `Namespace` property. Elements that are specific to WSDL pertain to the namespace. - For XML Web service clients using SOAP to call an XML Web service, you can optionally add the or to call an XML Web service method. If the client is calling an XML Web service created using ASP.NET, the , and properties are all derived from the property by default. For instance, given an XML Web service method name of `Time` and a `Namespace` property of `http://www.contoso.com/`, the `Action` property is `http://www.contoso.com/Time` by default. To change the default settings for `RequestNamespace`, `ResponseNamespace`, and `Action` for an XML Web service method, you can add a to the XML Web service method. + For XML Web service clients using SOAP to call an XML Web service, you can optionally add the or to call an XML Web service method. If the client is calling an XML Web service created using ASP.NET, the , and properties are all derived from the property by default. For instance, given an XML Web service method name of `Time` and a `Namespace` property of `http://www.contoso.com/`, the `Action` property is `http://www.contoso.com/Time` by default. To change the default settings for `RequestNamespace`, `ResponseNamespace`, and `Action` for an XML Web service method, you can add a to the XML Web service method. > [!NOTE] > An XML namespace is different from the namespace the class resides in, in terms of the Windows SDK. To specify the namespace for the class, see [Namespace Keywords](/dotnet/csharp/language-reference/keywords/namespace-keywords) if you writing in C#. @@ -220,7 +220,7 @@ ## Examples - The following example sets to `http://www.contoso.com` and overrides that namespace for the property by adding a to the `Time` XML Web service method. + The following example sets to `http://www.contoso.com` and overrides that namespace for the property by adding a to the `Time` XML Web service method. :::code language="aspx-csharp" source="~/snippets/csharp/System.Web.Services/WebServiceAttribute/Namespace/sourcecs.asmx"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/Classic WebServiceAttribute.Namespace Example/VB/sourcevb.asmx"::: diff --git a/xml/System.Web.SessionState/HttpSessionState.xml b/xml/System.Web.SessionState/HttpSessionState.xml index e3d54b213d7..548953b2aac 100644 --- a/xml/System.Web.SessionState/HttpSessionState.xml +++ b/xml/System.Web.SessionState/HttpSessionState.xml @@ -32,15 +32,15 @@ Session data is associated with a specific browser session using a unique identifier. By default, this identifier is stored in a non-expiring session cookie in the browser, but you can also configure your application to store the session identifier in the URL by setting the `cookieless` attribute to `true` or in the [sessionState](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v%3dvs.100)) element of your application configuration. You can have ASP.NET determine whether cookies are supported by the browser by specifying a value of for the `cookieless` attribute. You can also have ASP.NET determine whether cookies are enabled for the browser by specifying a value of for the `cookieless` attribute. If cookies are supported when is specified, or enabled when is specified, then the session identifier will be stored in a cookie; otherwise the session identifier will be stored in the URL. - Sessions are started during the first request and session values will persist as long as a new request is made by the browser before the number of minutes specified in the property pass. When a new session begins, the session event is raised. You can use this event to perform any additional work at the start of a session, such as setting default session values. When a session times out, the method is called, or the ASP.NET application is shut down, the session event is raised. You can use this event to perform any necessary cleanup. The event is raised only when the session state `mode` is set to . + Sessions are started during the first request and session values will persist as long as a new request is made by the browser before the number of minutes specified in the property pass. When a new session begins, the session event is raised. You can use this event to perform any additional work at the start of a session, such as setting default session values. When a session times out, the method is called, or the ASP.NET application is shut down, the session event is raised. You can use this event to perform any necessary cleanup. The event is raised only when the session state `mode` is set to . - To improve performance, sessions that use cookies do not allocate session storage until data is actually stored in the object. For more information, see the property. + To improve performance, sessions that use cookies do not allocate session storage until data is actually stored in the object. For more information, see the property. Session state does not persist across ASP.NET application boundaries. If a browser navigates to another application, the session information is not available to the new application. Session values are stored in memory on the Web server, by default. You can also store session values in a SQL Server database, an ASP.NET state server, or a custom server. This enables you to preserve session values in cases where the ASP.NET or IIS process or the ASP.NET application restarts and to make session values available across all the servers in a Web farm. This behavior is configured by setting the `mode` attribute to a valid value in the [sessionState](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v%3dvs.100)) element of your application configuration. For more information, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). - Alternatives to session state include application state (see the property) and the ASP.NET cache (see the namespace), which store variables that can be accessed by all users of an ASP.NET application; the ASP.NET profile (see the namespace), which persists user values in a data store without expiring them using a time-out; ASP.NET , which persist control values in the ; ; the property; and fields on an HTML form that are available from an HTTP `POST` using the collection. For more details on the differences between session state and other state-management alternatives, see [ASP.NET State Management Recommendations](https://learn.microsoft.com/previous-versions/aspnet/z1hkazw7(v=vs.100)). + Alternatives to session state include application state (see the property) and the ASP.NET cache (see the namespace), which store variables that can be accessed by all users of an ASP.NET application; the ASP.NET profile (see the namespace), which persists user values in a data store without expiring them using a time-out; ASP.NET , which persist control values in the ; ; the property; and fields on an HTML form that are available from an HTTP `POST` using the collection. For more details on the differences between session state and other state-management alternatives, see [ASP.NET State Management Recommendations](https://learn.microsoft.com/previous-versions/aspnet/z1hkazw7(v=vs.100)). @@ -85,7 +85,7 @@ method is called, the current session is no longer valid and a new session can be started. causes the event to be raised. A new event will be raised on the next request. + Once the method is called, the current session is no longer valid and a new session can be started. causes the event to be raised. A new event will be raised on the next request. Session identifiers for abandoned or expired sessions are recycled by default. That is, if a request is made that includes the session identifier for an expired or abandoned session, a new session is started using the same session identifier. You can disable this by setting `regenerateExpiredSessionId` attribute of the [sessionState](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v%3dvs.100)) configuration element to `true`. For more information, see [Session Identifiers](https://learn.microsoft.com/previous-versions/aspnet/ms178582(v=vs.100)). @@ -130,7 +130,7 @@ ## Examples - The following example shows how to store values in session state by using the method. It also shows how to remove values in session state by using the method. A control is used to display the contents session state on the Web page. The method is used to iterate through the session-state collection and populate the control. + The following example shows how to store values in session state by using the method. It also shows how to remove values in session state by using the method. A control is used to display the contents session state on the Web page. The method is used to iterate through the session-state collection and populate the control. > [!IMPORTANT] > This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)). @@ -263,7 +263,7 @@ is `true`, the property returns ; otherwise the property returns . + When is `true`, the property returns ; otherwise the property returns . @@ -373,7 +373,7 @@ method. It also shows how to remove values in session state by using the method. A control is used to display the contents of session state on the Web page. The method is used to iterate through the session-state collection and populate the control. + The following example shows how to store values in session state by using the method. It also shows how to remove values in session state by using the method. A control is used to display the contents of session state on the Web page. The method is used to iterate through the session-state collection and populate the control. [!code-aspx-csharp[HttpSessionState#13](~/snippets/csharp/VS_Snippets_WebNet/HttpSessionState/CS/HttpSessionStateAddCS.aspx#13)] [!code-aspx-vb[HttpSessionState#13](~/snippets/visualbasic/VS_Snippets_WebNet/HttpSessionState/VB/HttpSessionStateAddVB.aspx#13)] @@ -411,7 +411,7 @@ ASP.NET identifies sessions uniquely with each browser. By default, the unique identifier for a session is stored in a non-expiring session cookie in the browser. You can specify that session identifiers not be stored in a cookie by setting the `cookieless` attribute to `true` in the [sessionState](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v%3dvs.100)) configuration element. > [!NOTE] -> To improve the security of your application, your application should allow users to log out, at which point it should call the method. This reduces the potential for an unwanted source using the unique identifier in the URL to retrieve private data stored in the session for a user. +> To improve the security of your application, your application should allow users to log out, at which point it should call the method. This reduces the potential for an unwanted source using the unique identifier in the URL to retrieve private data stored in the session for a user. ASP.NET maintains cookieless session state by automatically inserting a unique session ID into the page's URL. For example, the following URL has been modified by ASP.NET to include the unique session ID lit3py55t21z5v55vlm25s55: @@ -426,7 +426,7 @@ http://www.example.com/(S(4danlfat035muve4g0mvgfrr))/orderform.aspx By default, session identifiers used in cookieless sessions are recycled. That is, if a request is made with a session ID that has expired, a new session is started using the session ID supplied with the request. This behavior can result in the unwanted sharing of session data when a link that contains a cookieless session ID is shared with multiple browsers, perhaps through a search engine or other program. You can reduce the possibility of session data being shared by multiple clients by disabling the recycling of session identifiers. To do this, set the `regenerateExpiredSessionId` attribute of the [sessionState](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v%3dvs.100)) configuration element to `true`. This will result in a new session ID being generated when a cookieless session request is made with an expired session ID. Note that if the request made with the expired session ID uses the HTTP `POST` method, then any posted data will be lost when `regenerateExpiredSessionId` is `true`, as ASP.NET performs a redirect to ensure that the browser has the new session identifier in the URL. > [!NOTE] -> While setting the `regenerateExpiredSessionId` attribute to `true` reduces the possibility of unwanted sharing of session data, it does not protect against an unwanted source gaining access to the session of another user by obtaining the value and including it in requests to the server. If you are storing private or sensitive information in session state, it is recommended that you use SSL to encrypt any communication between the browser and server that includes the . +> While setting the `regenerateExpiredSessionId` attribute to `true` reduces the possibility of unwanted sharing of session data, it does not protect against an unwanted source gaining access to the session of another user by obtaining the value and including it in requests to the server. If you are storing private or sensitive information in session state, it is recommended that you use SSL to encrypt any communication between the browser and server that includes the . @@ -731,7 +731,7 @@ http://www.example.com/(S(4danlfat035muve4g0mvgfrr))/orderform.aspx ## Examples - The following example shows how to store values in session state by using the method. It also shows how to remove values in session state by using the method. A control is used to display the contents of session state on the Web page. The method is used to iterate through the session-state collection and populate the control. + The following example shows how to store values in session state by using the method. It also shows how to remove values in session state by using the method. A control is used to display the contents of session state on the Web page. The method is used to iterate through the session-state collection and populate the control. [!code-aspx-csharp[HttpSessionState#13](~/snippets/csharp/VS_Snippets_WebNet/HttpSessionState/CS/HttpSessionStateAddCS.aspx#13)] [!code-aspx-vb[HttpSessionState#13](~/snippets/visualbasic/VS_Snippets_WebNet/HttpSessionState/VB/HttpSessionStateAddVB.aspx#13)] @@ -771,7 +771,7 @@ http://www.example.com/(S(4danlfat035muve4g0mvgfrr))/orderform.aspx performs the same function as . + performs the same function as . ]]> @@ -835,13 +835,13 @@ http://www.example.com/(S(4danlfat035muve4g0mvgfrr))/orderform.aspx property is used to uniquely identify a browser with session data on the server. The value is randomly generated by ASP.NET and stored in a non-expiring session cookie in the browser. The value is then sent in a cookie with each request to the ASP.NET application. + The property is used to uniquely identify a browser with session data on the server. The value is randomly generated by ASP.NET and stored in a non-expiring session cookie in the browser. The value is then sent in a cookie with each request to the ASP.NET application. If you want to disable the use of cookies in your ASP.NET application and still make use of session state, you can configure your application to store the session identifier in the URL instead of a cookie by setting the `cookieless` attribute of the [sessionState](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v%3dvs.100)) configuration element to `true`, or to , in the Web.config file for your application. You can have ASP.NET determine whether cookies are supported by the browser by specifying a value of for the `cookieless` attribute. You can also have ASP.NET determine whether cookies are enabled for the browser by specifying a value of for the `cookieless` attribute. If cookies are supported when is specified, or enabled when is specified, then the session identifier will be stored in a cookie; otherwise the session identifier will be stored in the URL. For more information, see the property. - The is sent between the server and the browser in clear text, either in a cookie or in the URL. As a result, an unwanted source could gain access to the session of another user by obtaining the value and including it in requests to the server. If you are storing private or sensitive information in session state, it is recommended that you use SSL to encrypt any communication between the browser and server that includes the . + The is sent between the server and the browser in clear text, either in a cookie or in the URL. As a result, an unwanted source could gain access to the session of another user by obtaining the value and including it in requests to the server. If you are storing private or sensitive information in session state, it is recommended that you use SSL to encrypt any communication between the browser and server that includes the . - When using cookie-based session state, ASP.NET does not allocate storage for session data until the object is used. As a result, a new session ID is generated for each page request until the session object is accessed. If your application requires a static session ID for the entire session, you can either implement the `Session_Start` method in the application's Global.asax file and store data in the object to fix the session ID, or you can use code in another part of your application to explicitly store data in the object. + When using cookie-based session state, ASP.NET does not allocate storage for session data until the object is used. As a result, a new session ID is generated for each page request until the session object is accessed. If your application requires a static session ID for the entire session, you can either implement the `Session_Start` method in the application's Global.asax file and store data in the object to fix the session ID, or you can use code in another part of your application to explicitly store data in the object. If your application uses cookieless session state, the session ID is generated on the first page view and is maintained for the entire session. @@ -890,14 +890,14 @@ http://www.example.com/(S(4danlfat035muve4g0mvgfrr))/orderform.aspx is out-of-process ( or ), the object will not be created and will not be added to this collection. + If an object on a page does not support serialization and is out-of-process ( or ), the object will not be created and will not be added to this collection. The property is provided for compatibility with earlier versions of ASP. ## Examples - The following code example lists the `id` and object type of the objects in the collection. + The following code example lists the `id` and object type of the objects in the collection. [!code-csharp[HttpSessionState#10](~/snippets/csharp/VS_Snippets_WebNet/HttpSessionState/CS/snippetscs.aspx#10)] [!code-vb[HttpSessionState#10](~/snippets/visualbasic/VS_Snippets_WebNet/HttpSessionState/VB/snippetsvb.aspx#10)] diff --git a/xml/System.Web.SessionState/HttpSessionStateContainer.xml b/xml/System.Web.SessionState/HttpSessionStateContainer.xml index 3a2f4e5774d..9909ca534b3 100644 --- a/xml/System.Web.SessionState/HttpSessionStateContainer.xml +++ b/xml/System.Web.SessionState/HttpSessionStateContainer.xml @@ -80,7 +80,7 @@ event handler for a custom session-state module that populates a new object with new or existing session information and adds it to the of the current request using the method. For a full code example of a custom session-state module, see the class overview. + The following code example shows the event handler for a custom session-state module that populates a new object with new or existing session information and adds it to the of the current request using the method. For a full code example of a custom session-state module, see the class overview. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/CS/mysessionstatemodule.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/VB/mysessionstatemodule.vb" id="Snippet4"::: @@ -118,7 +118,7 @@ method of the marks the property as `true`. A custom session module can then query the property and remove the session information if the property is `true`. + The method of the marks the property as `true`. A custom session module can then query the property and remove the session information if the property is `true`. ]]> @@ -256,7 +256,7 @@ is `true`, the property returns ; otherwise, the property returns . + When is `true`, the property returns ; otherwise, the property returns . ]]> @@ -749,7 +749,7 @@ performs the same function as . + performs the same function as . ]]> @@ -849,9 +849,9 @@ is out-of-process ( or ), the object will not be created and will not be added to this collection. + If an object on a page does not support serialization and is out-of-process ( or ), the object will not be created and will not be added to this collection. - is provided for compatibility with earlier versions of ASP. + is provided for compatibility with earlier versions of ASP. ]]> diff --git a/xml/System.Web.SessionState/IHttpSessionState.xml b/xml/System.Web.SessionState/IHttpSessionState.xml index fde8cc82844..30fcc93edef 100644 --- a/xml/System.Web.SessionState/IHttpSessionState.xml +++ b/xml/System.Web.SessionState/IHttpSessionState.xml @@ -19,9 +19,9 @@ ## Remarks A session-state container provides access to the session-state values and related information for the current session. Session information included in a session-state container is exposed to application code through the class using the property. The class is a wrapper class for a session-state container. - The ASP.NET implementation of a session-state container is the class. At the beginning of a request, during the event, the creates and populates an object and assigns it to the current . At the end of a request, during the event, the retrieves the object from the current and performs any required session work, such as writing the session values to the session store, or abandoning the session. If the request is abruptly terminated, such as through a redirect, the performs the same cleanup by calling the method. + The ASP.NET implementation of a session-state container is the class. At the beginning of a request, during the event, the creates and populates an object and assigns it to the current . At the end of a request, during the event, the retrieves the object from the current and performs any required session work, such as writing the session values to the session store, or abandoning the session. If the request is abruptly terminated, such as through a redirect, the performs the same cleanup by calling the method. - To create a custom session-state container, create a class that implements the interface. If you are creating your own custom session-state container, you must also replace the with your own custom module. Your custom module will create an instance of your custom session-state container and add it to the current using the method. An example of a custom session-state module is included in the class overview. + To create a custom session-state container, create a class that implements the interface. If you are creating your own custom session-state container, you must also replace the with your own custom module. Your custom module will create an instance of your custom session-state container and add it to the current using the method. An example of a custom session-state module is included in the class overview. @@ -59,12 +59,12 @@ method is used to clear out session data and raise the **Session_OnEnd** event defined in the Global.asax file for the ASP.NET application. + The method is used to clear out session data and raise the **Session_OnEnd** event defined in the Global.asax file for the ASP.NET application. ## Examples - The following code example implements the method of the interface. The code example duplicates the behavior of the class in that it adds an property that is set to `true` when the method is called. The property is checked by the session-state module during the event to determine whether the session has been abandoned, and the session-state module clears out session data and executes the **Session_OnEnd** event. + The following code example implements the method of the interface. The code example duplicates the behavior of the class in that it adds an property that is set to `true` when the method is called. The property is checked by the session-state module during the event to determine whether the session has been abandoned, and the session-state module clears out session data and executes the **Session_OnEnd** event. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/CS/mysessionstate.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/VB/mysessionstate.vb" id="Snippet8"::: @@ -102,7 +102,7 @@ method of the interface to add a new item value to the internal session-state item collection. + The following code example implements the method of the interface to add a new item value to the internal session-state item collection. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/CS/mysessionstate.cs" id="Snippet15"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/VB/mysessionstate.vb" id="Snippet15"::: @@ -135,12 +135,12 @@ performs the same function as . + performs the same function as . ## Examples - The following code example implements the method of the interface to delete all items from an internal session-state item collection. + The following code example implements the method of the interface to delete all items from an internal session-state item collection. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/CS/mysessionstate.cs" id="Snippet18"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/VB/mysessionstate.vb" id="Snippet18"::: @@ -213,7 +213,7 @@ property returns a enumeration value that is based on the value of the `cookieless` attribute of the configuration element. If the `cookieless` attribute is set to `true`, then the property returns ; otherwise, the property returns . + The property returns a enumeration value that is based on the value of the `cookieless` attribute of the configuration element. If the `cookieless` attribute is set to `true`, then the property returns ; otherwise, the property returns . @@ -264,7 +264,7 @@ method of the interface to copy session-state item values to an array. + The following code example implements the method of the interface to copy session-state item values to an array. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/CS/mysessionstate.cs" id="Snippet22"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/VB/mysessionstate.vb" id="Snippet22"::: @@ -331,7 +331,7 @@ method of the interface to return an enumerator for the internal session-state item collection. + The following code example implements the method of the interface to return an enumerator for the internal session-state item collection. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/CS/mysessionstate.cs" id="Snippet21"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/VB/mysessionstate.vb" id="Snippet21"::: @@ -438,7 +438,7 @@ page attribute to `ReadOnly`. + Session state is set to read-only by setting the page attribute to `ReadOnly`. @@ -629,7 +629,7 @@ ## Remarks This `LCID` property is provided for compatibility with earlier versions of ASP only. If you do not need to maintain backward compatibility with ASP pages, use the property instead. - ASP.NET does not store the locale identifier in session state. The property calls the to get and set the identifier. + ASP.NET does not store the locale identifier in session state. The property calls the to get and set the identifier. @@ -708,7 +708,7 @@ method of the interface to delete a session-state item from the session-state item collection by key name. + The following code example implements the method of the interface to delete a session-state item from the session-state item collection by key name. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/CS/mysessionstate.cs" id="Snippet16"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/VB/mysessionstate.vb" id="Snippet16"::: @@ -741,12 +741,12 @@ performs the same function as . + performs the same function as . ## Examples - The following code example implements the method of the interface to delete all items from an internal session-state item collection. + The following code example implements the method of the interface to delete all items from an internal session-state item collection. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/CS/mysessionstate.cs" id="Snippet18"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/VB/mysessionstate.vb" id="Snippet18"::: @@ -782,7 +782,7 @@ method of the interface to delete a session-state item from the internal session-state item collection by numerical index. + The following code example implements the method of the interface to delete a session-state item from the internal session-state item collection by numerical index. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/CS/mysessionstate.cs" id="Snippet17"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.IHttpSessionState/VB/mysessionstate.vb" id="Snippet17"::: diff --git a/xml/System.Web.SessionState/ISessionIDManager.xml b/xml/System.Web.SessionState/ISessionIDManager.xml index 92ef000c3d0..18e9f6db5b9 100644 --- a/xml/System.Web.SessionState/ISessionIDManager.xml +++ b/xml/System.Web.SessionState/ISessionIDManager.xml @@ -21,7 +21,7 @@ If your interface implementation will support cookieless session identifiers, you will need to implement a solution for sending and retrieving session identifiers in the URL, such as an ISAPI filter. - If you only want to supply custom session-identifier values to be used by ASP.NET session state, you can create a class that inherits the class and override only the and methods with your own custom implementation. This enables you to supply your own session-identifier values, while relying on the base class to store values to the HTTP response and retrieve values from the HTTP request. For an example of overriding the class and implementing these methods, see the example provided for the method of the class. + If you only want to supply custom session-identifier values to be used by ASP.NET session state, you can create a class that inherits the class and override only the and methods with your own custom implementation. This enables you to supply your own session-identifier values, while relying on the base class to store values to the HTTP response and retrieve values from the HTTP request. For an example of overriding the class and implementing these methods, see the example provided for the method of the class. @@ -63,12 +63,12 @@ method is used to generate a unique session identifier that the object will use to identify a new session. The value returned by must be unique and must contain valid characters that can be stored in an HTTP response and request. If it is possible that the value returned by your implementation contains characters that are not valid in an HTTP response or request, you should use the method to encode the session-identifier value in your method implementation and the method to decode the session-identifier value in your method implementation. + The method is used to generate a unique session identifier that the object will use to identify a new session. The value returned by must be unique and must contain valid characters that can be stored in an HTTP response and request. If it is possible that the value returned by your implementation contains characters that are not valid in an HTTP response or request, you should use the method to encode the session-identifier value in your method implementation and the method to decode the session-identifier value in your method implementation. ## Examples - The following code example implements the method. The method creates a new to be used as a session identifier. + The following code example implements the method. The method creates a new to be used as a session identifier. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/CS/isessionidmodulesnippets.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/VB/isessionidmodulesnippets.vb" id="Snippet3"::: @@ -105,14 +105,14 @@ method is called by the during the and events. If you cannot retrieve a valid session identifier from the HTTP request, return `null`. If the receives `null` from the method, it will call the method to get a new session identifier for a new session. + The method is called by the during the and events. If you cannot retrieve a valid session identifier from the HTTP request, return `null`. If the receives `null` from the method, it will call the method to get a new session identifier for a new session. - If it is possible that the value returned by your implementation contains characters that are not valid in an HTTP response or request, you should use the method to encode the session-identifier value in your method implementation and the method to decode the session-identifier value in your method implementation. + If it is possible that the value returned by your implementation contains characters that are not valid in an HTTP response or request, you should use the method to encode the session-identifier value in your method implementation and the method to decode the session-identifier value in your method implementation. ## Examples - The following code example shows a partially implemented method. If your custom session-ID manager supports cookieless session identifiers, you will need to implement a solution for sending and retrieving session identifiers in the URL, such as an ISAPI filter. + The following code example shows a partially implemented method. If your custom session-ID manager supports cookieless session identifiers, you will need to implement a solution for sending and retrieving session identifiers in the URL, such as an ISAPI filter. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/CS/isessionidmodulesnippets.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/VB/isessionidmodulesnippets.vb" id="Snippet2"::: @@ -145,7 +145,7 @@ method to initialize the object. + Use the method to initialize the object. ]]> @@ -189,7 +189,7 @@ method is called for each request handled by the object. Use the method to initialize per-request data for the object. + The method is called for each request handled by the object. Use the method to initialize per-request data for the object. When the `suppressAutoDetectRedirect` parameter is `true`, the object should not use redirection to determine whether the browser supports cookies. @@ -225,12 +225,12 @@ calls the method during the event to remove the session identifier from the collection if a new session was created but was not used. + The calls the method during the event to remove the session identifier from the collection if a new session was created but was not used. ## Examples - The following code example implements the method. + The following code example implements the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/CS/isessionidmodulesnippets.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/VB/isessionidmodulesnippets.vb" id="Snippet4"::: @@ -272,14 +272,14 @@ method is called by the object during the event. The method stores the session identifier either in the URL (when cookieless session state is used) or in a non-expiring session cookie. + The method is called by the object during the event. The method stores the session identifier either in the URL (when cookieless session state is used) or in a non-expiring session cookie. - If it is possible that the value returned from your implementation contains characters that are not valid in an HTTP response or request, you should use the method to encode the session-identifier value in your method implementation and the method to decode the session-identifier value in your method implementation. + If it is possible that the value returned from your implementation contains characters that are not valid in an HTTP response or request, you should use the method to encode the session-identifier value in your method implementation and the method to decode the session-identifier value in your method implementation. ## Examples - The following code example shows a partially implemented method. If your custom session-ID manager supports cookieless session identifiers, you will need to implement a solution for sending and retrieving session identifiers in the URL, such as an ISAPI filter. + The following code example shows a partially implemented method. If your custom session-ID manager supports cookieless session identifiers, you will need to implement a solution for sending and retrieving session identifiers in the URL, such as an ISAPI filter. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/CS/isessionidmodulesnippets.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/VB/isessionidmodulesnippets.vb" id="Snippet5"::: @@ -317,14 +317,14 @@ method verifies that the supplied `id` is a valid session identifier. + The method verifies that the supplied `id` is a valid session identifier. - Your implementation should call the method from the method when retrieving a session identifier from an HTTP request to ensure that the supplied session identifier is properly formatted. + Your implementation should call the method from the method when retrieving a session identifier from an HTTP request to ensure that the supplied session identifier is properly formatted. ## Examples - The following code example implements the method and ensures the session-identifier value is a valid . + The following code example implements the method and ensures the session-identifier value is a valid . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/CS/isessionidmodulesnippets.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/VB/isessionidmodulesnippets.vb" id="Snippet6"::: diff --git a/xml/System.Web.SessionState/ISessionStateItemCollection.xml b/xml/System.Web.SessionState/ISessionStateItemCollection.xml index 305b4df4d8d..2d934db5736 100644 --- a/xml/System.Web.SessionState/ISessionStateItemCollection.xml +++ b/xml/System.Web.SessionState/ISessionStateItemCollection.xml @@ -70,12 +70,12 @@ method, you should set the property to `true` to indicate that values in the implementation have been modified. + In implementing the method, you should set the property to `true` to indicate that values in the implementation have been modified. ## Examples - The following code example shows an implementation of the method. For an example of a complete implementation of the interface, see the example provided for the interface overview. + The following code example shows an implementation of the method. For an example of a complete implementation of the interface, see the example provided for the interface overview. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/CS/isessionstateitemcollectionsnippets.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/VB/isessionstateitemcollectionsnippets.vb" id="Snippet6"::: @@ -111,7 +111,7 @@ ## Remarks The property is used by the to determine whether the values in an implementation have been modified. - In implementing the interface, you should initialize the property as `false` and set the property to `true` in the implementations of the , , or methods. + In implementing the interface, you should initialize the property as `false` and set the property to `true` in the implementations of the , , or methods. @@ -163,7 +163,7 @@ property that uses a to store session-variable names and values. For an example of a complete implementation of the interface, see the example provided in the interface overview. + The following code example shows an implementation of the property that uses a to store session-variable names and values. For an example of a complete implementation of the interface, see the example provided in the interface overview. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/CS/isessionstateitemcollectionsnippets.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/VB/isessionstateitemcollectionsnippets.vb" id="Snippet3"::: @@ -200,7 +200,7 @@ property that uses a to store session-variable names and values. For an example of a complete implementation of the interface, see the example provided in the interface overview. + The following code example shows an implementation of the property that uses a to store session-variable names and values. For an example of a complete implementation of the interface, see the example provided in the interface overview. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/CS/isessionstateitemcollectionsnippets.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/VB/isessionstateitemcollectionsnippets.vb" id="Snippet4"::: @@ -269,14 +269,14 @@ method, you should set the property to `true` to indicate values in the implementation have been modified. + In implementing the method, you should set the property to `true` to indicate values in the implementation have been modified. If the implementation does not contain an element with the specified `name`, the collection should remain unchanged and no exception be thrown. ## Examples - The following code example shows an implementation of the method. For an example of a complete implementation of the interface, see the example provided in the interface overview. + The following code example shows an implementation of the method. For an example of a complete implementation of the interface, see the example provided in the interface overview. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/CS/isessionstateitemcollectionsnippets.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/VB/isessionstateitemcollectionsnippets.vb" id="Snippet7"::: @@ -312,14 +312,14 @@ method, you should set the property to `true` to indicate values in the implementation have been modified. + In implementing the method, you should set the property to `true` to indicate values in the implementation have been modified. - Your implementation of the method should throw an exception if `index` is less than zero or is equal to or greater than . + Your implementation of the method should throw an exception if `index` is less than zero or is equal to or greater than . ## Examples - The following code example shows an implementation of the method. For an example of a complete implementation of the interface, see the example provided in the interface overview. + The following code example shows an implementation of the method. For an example of a complete implementation of the interface, see the example provided in the interface overview. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/CS/isessionstateitemcollectionsnippets.cs" id="Snippet8"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionStateItemCollection/VB/isessionstateitemcollectionsnippets.vb" id="Snippet8"::: diff --git a/xml/System.Web.SessionState/IStateRuntime.xml b/xml/System.Web.SessionState/IStateRuntime.xml index d9f61b81c33..890998034ff 100644 --- a/xml/System.Web.SessionState/IStateRuntime.xml +++ b/xml/System.Web.SessionState/IStateRuntime.xml @@ -89,7 +89,7 @@ method is used by unmanaged code in this service to manage the session data. + ASP.NET can manage session state out-of-process by using a Windows service called the ASP.NET state service. The method is used by unmanaged code in this service to manage the session data. This member supports the .NET Framework infrastructure implementation of the ASP.NET state service and is not intended be used directly from your code. For more information about session-state storage options, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). @@ -142,7 +142,7 @@ method is used by unmanaged code in this service to manage the session data. + ASP.NET can manage session state out-of-process by using a Windows service called the ASP.NET state service. The method is used by unmanaged code in this service to manage the session data. This member supports the .NET Framework infrastructure implementation of the ASP.NET state service and is not intended be used directly from your code. For more information about session-state storage options, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). @@ -175,7 +175,7 @@ method is used by unmanaged code in this service to stop processing the session data. This member is provided to support the .NET Framework infrastructure implementation of the ASP.NET state service and is not intended be used directly from your code. For more information about session-state storage options, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). + ASP.NET can manage session state out-of-process by using a Windows service called the ASP.NET state service. The method is used by unmanaged code in this service to stop processing the session data. This member is provided to support the .NET Framework infrastructure implementation of the ASP.NET state service and is not intended be used directly from your code. For more information about session-state storage options, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). ]]> diff --git a/xml/System.Web.SessionState/SessionIDManager.xml b/xml/System.Web.SessionState/SessionIDManager.xml index 22818be3699..5dca0023e7e 100644 --- a/xml/System.Web.SessionState/SessionIDManager.xml +++ b/xml/System.Web.SessionState/SessionIDManager.xml @@ -26,7 +26,7 @@ ## Remarks The class is an HTTP module that manages unique session identifiers for use with ASP.NET session state. The unique identifier for an ASP.NET session is the property, which can be accessed from the property of the current or . The ASP.NET session identifier is a randomly generated number encoded into a 24-character string consisting of lowercase characters from a to z and numbers from 0 to 5. - By default, the value is sent in a cookie with each request to the ASP.NET application. The name of the cookie that contains the value is ASP.NET_SessionId by default. You can configure a different cookie name by setting the `cookieName` attribute of the [sessionState Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v=vs.100)) to the desired cookie name. + By default, the value is sent in a cookie with each request to the ASP.NET application. The name of the cookie that contains the value is ASP.NET_SessionId by default. You can configure a different cookie name by setting the `cookieName` attribute of the [sessionState Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v=vs.100)) to the desired cookie name. If you want to disable the use of cookies in your ASP.NET application and still make use of session state, you can configure your application to store the session identifier in the URL instead of a cookie by setting the `cookieless` attribute of the `sessionState` element to `true` in the Web.config file for your application. For more information, see the property. @@ -68,7 +68,7 @@ ## Remarks This constructor is not intended to be called from application code. - ASP.NET calls this constructor to create an instance of the class. After calling the constructor, ASP.NET calls the method to initialize the new object. + ASP.NET calls this constructor to create an instance of the class. After calling the constructor, ASP.NET calls the method to initialize the new object. ]]> @@ -107,12 +107,12 @@ ## Remarks This method is not intended to be called from application code. - The method returns a unique session identifier that is a randomly generated number encoded into a 24-character string consisting of lowercase characters from a to z and numbers from 0 to 5. + The method returns a unique session identifier that is a randomly generated number encoded into a 24-character string consisting of lowercase characters from a to z and numbers from 0 to 5. ## Examples - The following code example shows a class that inherits the class and overrides the and methods with methods that supply and validate a as the . + The following code example shows a class that inherits the class and overrides the and methods with methods that supply and validate a as the . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/CS/GuidSessionIDModule.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/VB/GuidSessionIDModule.vb" id="Snippet7"::: @@ -172,7 +172,7 @@ ## Remarks This method is not intended to be called from application code. - This method is used internally by the class to decode custom values created by classes that inherit the class and override the and methods. To ensure the fidelity of a custom session-identifier value retrieved from the HTTP request by the method, the decodes the custom value using the method. + This method is used internally by the class to decode custom values created by classes that inherit the class and override the and methods. To ensure the fidelity of a custom session-identifier value retrieved from the HTTP request by the method, the decodes the custom value using the method. ]]> @@ -211,9 +211,9 @@ ## Remarks This method is not intended to be called from application code. - This method is used internally by the class to encode custom values created by classes that inherit the class and override the and methods. To ensure the fidelity of a custom session-identifier value stored in the HTTP response by the method, the encodes the custom value using the method. + This method is used internally by the class to encode custom values created by classes that inherit the class and override the and methods. To ensure the fidelity of a custom session-identifier value stored in the HTTP response by the method, the encodes the custom value using the method. - For an example of a class that inherits the class and overrides the and methods, see the method. + For an example of a class that inherits the class and overrides the and methods, see the method. ]]> @@ -252,7 +252,7 @@ ## Remarks This method is not intended to be called from application code. - The calls the method during the event to retrieve the from the current . + The calls the method during the event to retrieve the from the current . ]]> @@ -286,7 +286,7 @@ method reads the session configuration data from the [sessionState Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v=vs.100)) configuration element of the configuration files. + The method reads the session configuration data from the [sessionState Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/h6bb9cz9(v=vs.100)) configuration element of the configuration files. ]]> @@ -368,7 +368,7 @@ ## Remarks This method is not intended to be called from application code. - The calls the method during the event to remove the session identifier from the collection of the if a new session was created but was not used. + The calls the method during the event to remove the session identifier from the collection of the if a new session was created but was not used. ]]> @@ -412,7 +412,7 @@ ## Remarks This method is not intended to be called from application code. - The method is called by the object during the event. The method stores the session identifier in either the URL (when cookieless session state is used) or in a non-expiring session cookie. + The method is called by the object during the event. The method stores the session identifier in either the URL (when cookieless session state is used) or in a non-expiring session cookie. By default, the places a unique session identifier into a non-expiring session cookie and sets the `cookieAdded` parameter to `true`. @@ -453,7 +453,7 @@ ## Remarks The maximum length of a session identifier is 80 characters. - While session identifiers created by the method are 24 characters long, the maximum length of a session identifier allowed by the class is 80 characters. This is especially important if you implement a custom . The method, which retrieves session-identifier values from the current , ensures that values do not exceed the value and that the session identifier is a 24-character string containing only the lowercase characters a to z and the numbers 0 to 5 by calling the method. If you implement a custom class that inherits the class and overrides the method but not the method, your custom session-identifier values must meet the constraints above. For an example of overriding the class and implementing these methods, see the example provided for the method. + While session identifiers created by the method are 24 characters long, the maximum length of a session identifier allowed by the class is 80 characters. This is especially important if you implement a custom . The method, which retrieves session-identifier values from the current , ensures that values do not exceed the value and that the session identifier is a 24-character string containing only the lowercase characters a to z and the numbers 0 to 5 by calling the method. If you implement a custom class that inherits the class and overrides the method but not the method, your custom session-identifier values must meet the constraints above. For an example of overriding the class and implementing these methods, see the example provided for the method. ]]> @@ -493,14 +493,14 @@ ## Remarks This method is not intended to be called from application code. - The method verifies that the supplied `id` is a 24-character string consisting of lowercase characters from a to z and numbers from 0 to 5 and that the maximum length of the session ID does not exceed 80 characters. + The method verifies that the supplied `id` is a 24-character string consisting of lowercase characters from a to z and numbers from 0 to 5 and that the maximum length of the session ID does not exceed 80 characters. - The method calls the method when retrieving a session identifier from an HTTP request, to ensure that the supplied session identifier is properly formatted. + The method calls the method when retrieving a session identifier from an HTTP request, to ensure that the supplied session identifier is properly formatted. ## Examples - The following code example shows a class that inherits the class and overrides the and methods with methods that supply and validate a as the . + The following code example shows a class that inherits the class and overrides the and methods with methods that supply and validate a as the . :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/CS/GuidSessionIDModule.cs" id="Snippet7"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.ISessionIDModule/VB/GuidSessionIDModule.vb" id="Snippet7"::: diff --git a/xml/System.Web.SessionState/SessionStateActions.xml b/xml/System.Web.SessionState/SessionStateActions.xml index 8d19570301d..46bbab0429e 100644 --- a/xml/System.Web.SessionState/SessionStateActions.xml +++ b/xml/System.Web.SessionState/SessionStateActions.xml @@ -22,18 +22,18 @@ Identifies whether a session item from a data store is for a session that requires initialization. - enumeration is used by the and methods of a implementation. When a session item is retrieved from the data store, the enumeration value indicates whether the session requires initialization or not based on a value stored with the data. The and methods set an `actions` parameter to a enumeration value based on this value retrieved with the session item. If the value of the `actions` parameter is set to InitializeItem, the initializes the session and executes the `Session_OnStart` event defined in the Global.asax file for the ASP.NET application. If the value of the `actions` parameter is None, no additional steps are taken for the current session. - - A session item created by the method is created with a value indicating that the item requires initialization and that the and methods should set the `actions` parameter to InitializeItem. - - - -## Examples - For an example of a session-state store provider implementation that uses the enumeration, see [Implementing a Session-State Store Provider](https://learn.microsoft.com/previous-versions/aspnet/ms178587(v=vs.100)). - + enumeration is used by the and methods of a implementation. When a session item is retrieved from the data store, the enumeration value indicates whether the session requires initialization or not based on a value stored with the data. The and methods set an `actions` parameter to a enumeration value based on this value retrieved with the session item. If the value of the `actions` parameter is set to InitializeItem, the initializes the session and executes the `Session_OnStart` event defined in the Global.asax file for the ASP.NET application. If the value of the `actions` parameter is None, no additional steps are taken for the current session. + + A session item created by the method is created with a value indicating that the item requires initialization and that the and methods should set the `actions` parameter to InitializeItem. + + + +## Examples + For an example of a session-state store provider implementation that uses the enumeration, see [Implementing a Session-State Store Provider](https://learn.microsoft.com/previous-versions/aspnet/ms178587(v=vs.100)). + ]]> diff --git a/xml/System.Web.SessionState/SessionStateBehavior.xml b/xml/System.Web.SessionState/SessionStateBehavior.xml index da76ed319f1..ee9cd01f8b7 100644 --- a/xml/System.Web.SessionState/SessionStateBehavior.xml +++ b/xml/System.Web.SessionState/SessionStateBehavior.xml @@ -15,11 +15,11 @@ Specifies the type of session support that is required in order to handle a request. - enumeration is used with the method. You can call this method to indicate that session state support is needed to handle a request, and pass a enumeration value to specify what type of session state behavior applies to the request. - + enumeration is used with the method. You can call this method to indicate that session state support is needed to handle a request, and pass a enumeration value to specify what type of session state behavior applies to the request. + ]]> diff --git a/xml/System.Web.SessionState/SessionStateItemCollection.xml b/xml/System.Web.SessionState/SessionStateItemCollection.xml index f8a769e7bd0..a3f2466dfa1 100644 --- a/xml/System.Web.SessionState/SessionStateItemCollection.xml +++ b/xml/System.Web.SessionState/SessionStateItemCollection.xml @@ -138,14 +138,14 @@ [!INCLUDE [untrusted-data-method-note](~/includes/untrusted-data-method-note.md)] - The method can be used to read the contents of a collection from the session store. + The method can be used to read the contents of a collection from the session store. - To write the contents of a object to the session store, use the method. + To write the contents of a object to the session store, use the method. ## Examples - The following code example creates a collection from a file that was created using the method. + The following code example creates a collection from a file that was created using the method. [!code-csharp[System.Web.SessionState.SessionStateItemCollection#4](~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.SessionStateItemCollection/CS/serializecs.aspx#4)] [!code-vb[System.Web.SessionState.SessionStateItemCollection#4](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.SessionStateItemCollection/VB/serializevb.aspx#4)] @@ -195,11 +195,11 @@ ## Remarks The property is used to indicate whether the contents of the collection have changed. - The property is set to `true` when an object value is set or added to the collection using the property and when one or more object values are removed from the collection using the , , or methods. + The property is set to `true` when an object value is set or added to the collection using the property and when one or more object values are removed from the collection using the , , or methods. The property is also set to `true` when a mutable object is retrieved from the collection using the property. - Calling the method to populate a collection results in the property being set to `false`. + Calling the method to populate a collection results in the property being set to `false`. ]]> @@ -233,7 +233,7 @@ collection using the method. + The following code example gets the variable names in a collection using the method. [!code-csharp[System.Web.SessionState.SessionStateItemCollection#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.SessionStateItemCollection/CS/keyscs.aspx#1)] [!code-vb[System.Web.SessionState.SessionStateItemCollection#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.SessionStateItemCollection/VB/keysvb.aspx#1)] @@ -484,14 +484,14 @@ method can be used to write the contents of a collection to the session store. + The method can be used to write the contents of a collection to the session store. - To retrieve a serialized object from the session store, use the method. + To retrieve a serialized object from the session store, use the method. ## Examples - The following code example creates and populates a collection and writes the contents to a file using the method. + The following code example creates and populates a collection and writes the contents to a file using the method. [!code-csharp[System.Web.SessionState.SessionStateItemCollection#3](~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.SessionStateItemCollection/CS/serializecs.aspx#3)] [!code-vb[System.Web.SessionState.SessionStateItemCollection#3](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.SessionStateItemCollection/VB/serializevb.aspx#3)] diff --git a/xml/System.Web.SessionState/SessionStateItemExpireCallback.xml b/xml/System.Web.SessionState/SessionStateItemExpireCallback.xml index 98c6b0f7963..ba2d1824e3e 100644 --- a/xml/System.Web.SessionState/SessionStateItemExpireCallback.xml +++ b/xml/System.Web.SessionState/SessionStateItemExpireCallback.xml @@ -30,7 +30,7 @@ ## Remarks The delegate is used to enable a implementation to call the `Session_OnEnd` event from the Global.asax file. - For more information, see the remarks provided for the method. + For more information, see the remarks provided for the method. ]]> diff --git a/xml/System.Web.SessionState/SessionStateModule.xml b/xml/System.Web.SessionState/SessionStateModule.xml index bafaf6376ef..eba002d8e3b 100644 --- a/xml/System.Web.SessionState/SessionStateModule.xml +++ b/xml/System.Web.SessionState/SessionStateModule.xml @@ -100,7 +100,7 @@ ## Remarks This method is not intended to be called from application code. - An object is created when an ASP.NET application is started. The object creates and initializes the object for the application and calls the method when the object is released. The is specified in the configuration for an application. + An object is created when an ASP.NET application is started. The object creates and initializes the object for the application and calls the method when the object is released. The is specified in the configuration for an application. ]]> @@ -130,14 +130,14 @@ event is raised at the end of a request when the method has been called or when the session has expired. A session expires when the number of minutes specified by the property passes without a request being made for the session. + The event is raised at the end of a request when the method has been called or when the session has expired. A session expires when the number of minutes specified by the property passes without a request being made for the session. The **Session_OnEnd** event is used to perform any cleanup work for a session such as disposing of resources used by the session. You can specify a handler for the event by adding a public subroutine named **Session_OnEnd** to the Global.asax file. > [!NOTE] -> The **Session_OnEnd** event is only supported when the session-state property value is , which is the default. If the session-state is set to or , then the **Session_OnEnd** event in the Global.asax file is ignored. If the session state property value is , then support for the **Session_OnEnd** event is determined by the custom session-state store provider. +> The **Session_OnEnd** event is only supported when the session-state property value is , which is the default. If the session-state is set to or , then the **Session_OnEnd** event in the Global.asax file is ignored. If the session state property value is , then support for the **Session_OnEnd** event is determined by the custom session-state store provider. Though the event is public, you can only handle it by adding an event handler in the Global.asax file. This restriction is implemented because instances are reused for performance. When a session expires, only the **Session_OnEnd** event specified in the Global.asax file is executed, to prevent code from calling an event handler associated with an instance that is currently in use. @@ -211,7 +211,7 @@ public void Session_OnEnd() ## Remarks This method is not intended to be called from application code. - An is created when an ASP.NET application is started. The object calls the method when it creates the object for the application. The class is specified in the configuration for an application. + An is created when an ASP.NET application is started. The object calls the method when it creates the object for the application. The class is specified in the configuration for an application. ]]> diff --git a/xml/System.Web.SessionState/SessionStateStoreData.xml b/xml/System.Web.SessionState/SessionStateStoreData.xml index ff969fca04e..45a90c5c6f8 100644 --- a/xml/System.Web.SessionState/SessionStateStoreData.xml +++ b/xml/System.Web.SessionState/SessionStateStoreData.xml @@ -22,7 +22,7 @@ ## Remarks The class is used by ASP.NET and implementers of a custom session-state store to pass session-state information to and from the . - The class is used to represent session-state data for a session store to the . The object contains the session-state variable names and values, static object references, and information for the current session. + The class is used to represent session-state data for a session store to the . The object contains the session-state variable names and values, static object references, and information for the current session. ]]> @@ -62,11 +62,11 @@ class is used to represent session-state data for a session store to the . The object contains the session-state variable names and values, static object references, and information for the current session. + The class is used to represent session-state data for a session store to the . The object contains the session-state variable names and values, static object references, and information for the current session. The class is used by ASP.NET and implementers of a custom session-state store to pass session-state information to and from the . - Custom session-store implementers construct a object in implementations of the , , and methods. + Custom session-store implementers construct a object in implementations of the , , and methods. ]]> @@ -144,10 +144,10 @@ property is provided for compatibility with earlier versions of ASP. - Custom session-store implementers can obtain a reference to the class for the current instance using the method. + Custom session-store implementers can obtain a reference to the class for the current instance using the method. > [!NOTE] -> Custom objects stored in the collection must support binary serialization. For more information, see [Binary Serialization](/dotnet/standard/serialization/binary-serialization). +> Custom objects stored in the collection must support binary serialization. For more information, see [Binary Serialization](/dotnet/standard/serialization/binary-serialization). ]]> diff --git a/xml/System.Web.SessionState/SessionStateStoreProviderBase.xml b/xml/System.Web.SessionState/SessionStateStoreProviderBase.xml index bc4ee0c1da0..2ebde398294 100644 --- a/xml/System.Web.SessionState/SessionStateStoreProviderBase.xml +++ b/xml/System.Web.SessionState/SessionStateStoreProviderBase.xml @@ -29,16 +29,16 @@ ## Locking Session Store Data Because ASP.NET applications are multithreaded to support responding to concurrent requests, it is possible that concurrent requests might attempt to access the same session information. Consider a scenario where multiple frames in a frameset all access the same application. The separate requests for each frame in the frameset can be executed on the Web server concurrently on different threads. If the ASP.NET pages for each frame source access session-state variables, then you could have multiple threads accessing the session store concurrently. - To avoid data collisions at the session store and unexpected session-state behavior, the and classes include lock functionality that exclusively locks the session store item for a particular session for the duration of the execution of an ASP.NET page. Note that even if the attribute is marked as `ReadOnly`, other ASP.NET pages in the same application might be able to write to the session store, so a request for read-only session data from the store might still end up waiting for locked data to be freed. + To avoid data collisions at the session store and unexpected session-state behavior, the and classes include lock functionality that exclusively locks the session store item for a particular session for the duration of the execution of an ASP.NET page. Note that even if the attribute is marked as `ReadOnly`, other ASP.NET pages in the same application might be able to write to the session store, so a request for read-only session data from the store might still end up waiting for locked data to be freed. - A lock is set on session-store data at the beginning of the request, in the call to the method. When the request completes, the lock is released during the call to the method. + A lock is set on session-store data at the beginning of the request, in the call to the method. When the request completes, the lock is released during the call to the method. - If the object encounters locked session data during the call to either the or the method, it will re-request the session data at half-second intervals until either the lock is released or the amount of time that the session data has been locked exceeds the value of the property. If the execution time out is exceeded, the object will call the method to free the session-store data and request the session-store data at that time. + If the object encounters locked session data during the call to either the or the method, it will re-request the session data at half-second intervals until either the lock is released or the amount of time that the session data has been locked exceeds the value of the property. If the execution time out is exceeded, the object will call the method to free the session-store data and request the session-store data at that time. - Because locked session-store data might have been freed by a call to the method on a separate thread before the call to the method for the current response, an attempt could be made to set and release session-state store data that has already been released and modified by another session. To avoid this situation, the and methods return a lock identifier. This lock identifier must be included with each request to modify locked session-store data. Session-store data is modified only if the lock identifier in the data store matches the lock identifier supplied by the . + Because locked session-store data might have been freed by a call to the method on a separate thread before the call to the method for the current response, an attempt could be made to set and release session-state store data that has already been released and modified by another session. To avoid this situation, the and methods return a lock identifier. This lock identifier must be included with each request to modify locked session-store data. Session-store data is modified only if the lock identifier in the data store matches the lock identifier supplied by the . ## Deleting Expired Session Store Data - When the method is called for a particular session, the data for that session is deleted from the data store using the method; otherwise, the data will remain in the session data store to server future requests for the session. It is up to the implementation to delete expired session data. + When the method is called for a particular session, the data for that session is deleted from the data store using the method; otherwise, the data will remain in the session data store to server future requests for the session. It is up to the implementation to delete expired session data. @@ -97,7 +97,7 @@ abstract class. Initialization values for a implementation are passed to the method implementation. + You are not required to implement a constructor for a class that inherits the abstract class. Initialization values for a implementation are passed to the method implementation. @@ -138,13 +138,13 @@ object calls the method at the beginning of a request for an ASP.NET page, during the event. The method is called if: + The object calls the method at the beginning of a request for an ASP.NET page, during the event. The method is called if: - the incoming request has no session ID, or - the incoming request has a session ID, but the session is not found in the data store. - The method creates a new object with an empty object, an collection, and the specified `timeout` value. The collection for the ASP.NET application can be retrieved using the method. + The method creates a new object with an empty object, an collection, and the specified `timeout` value. The collection for the ASP.NET application can be retrieved using the method. @@ -186,11 +186,11 @@ method is used with sessions when the `cookieless` and `regenerateExpiredSessionId` attributes are both `true`. Having the `regenerateExpiredSessionId attribute` set to `true` causes the object to generate a new value when an expired value is encountered. + The method is used with sessions when the `cookieless` and `regenerateExpiredSessionId` attributes are both `true`. Having the `regenerateExpiredSessionId attribute` set to `true` causes the object to generate a new value when an expired value is encountered. - The process of generating a new value requires redirecting the browser to a URL that contains the newly generated value. The method is called during the initial request that contains an expired value. After the object acquires a new value to replace the expired value, it calls the method to add an uninitialized entry to the session-state data store. The browser is then redirected to the URL containing the newly generated value. The existence of the uninitialized entry in the session data store ensures that the redirected request that includes the newly generated value is not mistaken for a request for an expired session and is, instead, treated as a new session. + The process of generating a new value requires redirecting the browser to a URL that contains the newly generated value. The method is called during the initial request that contains an expired value. After the object acquires a new value to replace the expired value, it calls the method to add an uninitialized entry to the session-state data store. The browser is then redirected to the URL containing the newly generated value. The existence of the uninitialized entry in the session data store ensures that the redirected request that includes the newly generated value is not mistaken for a request for an expired session and is, instead, treated as a new session. - The uninitialized entry in the session data store is associated with the newly generated value and contains only default values, including an expiration date and time and a value that corresponds to the `actionFlags` parameter of the and methods. The uninitialized entry in the session-state store should include an `actionFlags` value equal to the enumeration value. This value is passed to the object by the and methods, and informs the object that the current session is a new but uninitialized session. The object will then initialize the new session and raise the `Session_OnStart` event. + The uninitialized entry in the session data store is associated with the newly generated value and contains only default values, including an expiration date and time and a value that corresponds to the `actionFlags` parameter of the and methods. The uninitialized entry in the session-state store should include an `actionFlags` value equal to the enumeration value. This value is passed to the object by the and methods, and informs the object that the current session is a new but uninitialized session. The object will then initialize the new session and raise the `Session_OnStart` event. For more information about cookieless sessions, see the property. @@ -227,7 +227,7 @@ method is called when the method executes at the closing of the application domain. Classes that inherit the class can use this method to free any resources no longer in use. + The method is called when the method executes at the closing of the application domain. Classes that inherit the class can use this method to free any resources no longer in use. @@ -265,7 +265,7 @@ object calls the method at the end of a request for an ASP.NET page, during the event. You can use the method to perform any per-request cleanup required by your session-state store provider. + The object calls the method at the end of a request for an ASP.NET page, during the event. You can use the method to perform any per-request cleanup required by your session-state store provider. @@ -314,17 +314,17 @@ object calls the method at the beginning of a request, during the event, when the attribute is set to `ReadOnly`. If the attribute is set to `true`, the object instead calls the method. + The object calls the method at the beginning of a request, during the event, when the attribute is set to `ReadOnly`. If the attribute is set to `true`, the object instead calls the method. - The method returns a object populated with session information from the data store and updates the expiration date of the session data. If no session-item data is found at the data store, the method sets the `locked` `out` parameter to `false` and returns `null`. This causes the object to call the method to create a new session item in the data store. + The method returns a object populated with session information from the data store and updates the expiration date of the session data. If no session-item data is found at the data store, the method sets the `locked` `out` parameter to `false` and returns `null`. This causes the object to call the method to create a new session item in the data store. - If session-item data is found at the data store but the data is locked, the method sets the `locked` `out` parameter to `true`, sets the `lockAge` `out` parameter to the current date and time minus the date and time when the item was locked (which is retrieved from the data store), sets the `lockId` `out` parameter to the lock identifier retrieved from the data store, and returns `null`. This causes the object to call the method again after a half-second interval to attempt to retrieve the session-item information. + If session-item data is found at the data store but the data is locked, the method sets the `locked` `out` parameter to `true`, sets the `lockAge` `out` parameter to the current date and time minus the date and time when the item was locked (which is retrieved from the data store), sets the `lockId` `out` parameter to the lock identifier retrieved from the data store, and returns `null`. This causes the object to call the method again after a half-second interval to attempt to retrieve the session-item information. - If the value that the `lockAge` `out` parameter is set to exceed the value, then the object calls the method to clear the lock on the session-item data, and then calls the method again. + If the value that the `lockAge` `out` parameter is set to exceed the value, then the object calls the method to clear the lock on the session-item data, and then calls the method again. - The `actionFlags` parameter is used when both the `cookieless` and `regenerateExpiredSessionId` attributes are set to `true`. An `actionFlags` value set to indicates that the entry in the session data store is a new session that requires initialization. Uninitialized entries in the session data store are created by a call to the method. If the item from the session data store is not an uninitialized item, the `actionFlags` parameter will be set to zero. + The `actionFlags` parameter is used when both the `cookieless` and `regenerateExpiredSessionId` attributes are set to `true`. An `actionFlags` value set to indicates that the entry in the session data store is a new session that requires initialization. Uninitialized entries in the session data store are created by a call to the method. If the item from the session data store is not an uninitialized item, the `actionFlags` parameter will be set to zero. - Custom session-state store implementers that support cookieless sessions should set the `actionFlags` `out` parameter to the value returned from the session data store for the current item. If the `actionFlags` parameter value for the requested session-store item equals the enumeration value, then the method should set the value in the data store to zero after setting the `actionFlags` `out` parameter. + Custom session-state store implementers that support cookieless sessions should set the `actionFlags` `out` parameter to the value returned from the session data store for the current item. If the `actionFlags` parameter value for the requested session-store item equals the enumeration value, then the method should set the value in the data store to zero after setting the `actionFlags` `out` parameter. @@ -373,13 +373,13 @@ object calls the method at the beginning of a request, during the event, when the attribute is set to `true`, which is the default. If the attribute is set to `ReadOnly`, the object instead calls the method. + The object calls the method at the beginning of a request, during the event, when the attribute is set to `true`, which is the default. If the attribute is set to `ReadOnly`, the object instead calls the method. - The method returns a object populated with session information from the data store, updates the expiration date of the stored data, and locks the session-item data at the data store for the duration of the request. If no session-item data is found at the data store, the method sets the `locked` `out` parameter to `false` and returns `null`. This causes the object to call the method to create a new session item in the data store. If session-item data is found at the data store but the data is locked, the method sets the `locked` `out` parameter to `true`, sets the `lockAge` `out` parameter to the current date and time minus the date and time when the item was locked (which is retrieved from the data store), sets the `lockId` `out` parameter to the lock identifier retrieved from the data store, and returns `null`. This causes the object to call the method again after a half-second interval to attempt to retrieve the session-item information and obtain a lock on the data. If the value that the `lockAge` `out` parameter is set to exceeds the value, then the calls the method to clear the lock on the session-item data, and then calls the method again. + The method returns a object populated with session information from the data store, updates the expiration date of the stored data, and locks the session-item data at the data store for the duration of the request. If no session-item data is found at the data store, the method sets the `locked` `out` parameter to `false` and returns `null`. This causes the object to call the method to create a new session item in the data store. If session-item data is found at the data store but the data is locked, the method sets the `locked` `out` parameter to `true`, sets the `lockAge` `out` parameter to the current date and time minus the date and time when the item was locked (which is retrieved from the data store), sets the `lockId` `out` parameter to the lock identifier retrieved from the data store, and returns `null`. This causes the object to call the method again after a half-second interval to attempt to retrieve the session-item information and obtain a lock on the data. If the value that the `lockAge` `out` parameter is set to exceeds the value, then the calls the method to clear the lock on the session-item data, and then calls the method again. - The `actionFlags` parameter is used when the `cookieless` and `regenerateExpiredSessionId` attributes are both set to `true`. An `actionFlags` value set to indicates that the entry in the session data store is a new session that requires initialization. Uninitialized entries in the session data store are created by a call to the method. If the item from the session data store is not an uninitialized item, the `actionFlags` parameter will be set to zero. + The `actionFlags` parameter is used when the `cookieless` and `regenerateExpiredSessionId` attributes are both set to `true`. An `actionFlags` value set to indicates that the entry in the session data store is a new session that requires initialization. Uninitialized entries in the session data store are created by a call to the method. If the item from the session data store is not an uninitialized item, the `actionFlags` parameter will be set to zero. - Custom session-state store implementers that support cookieless sessions should set the `actionFlags` `out` parameter to the value returned from the session data store for the current item. If the `actionFlags` parameter value for the requested session-store item equals the enumeration value, then the method should set the value in the data store to zero after setting the `actionFlags` `out` parameter. + Custom session-state store implementers that support cookieless sessions should set the `actionFlags` `out` parameter to the value returned from the session data store for the current item. If the `actionFlags` parameter value for the requested session-store item equals the enumeration value, then the method should set the value in the data store to zero after setting the `actionFlags` `out` parameter. @@ -417,7 +417,7 @@ object calls the method before calling any other method. You can use the method to perform any per-request initialization required by your session-state store provider. + The object calls the method before calling any other method. You can use the method to perform any per-request initialization required by your session-state store provider. @@ -459,11 +459,11 @@ object calls the method to update the expiration date and release a lock on an item in the session data store. It is called at the end of a request, during the event, if session values are unchanged. If session values have been modified, the object instead calls the method. + The object calls the method to update the expiration date and release a lock on an item in the session data store. It is called at the end of a request, during the event, if session values are unchanged. If session values have been modified, the object instead calls the method. - The object also calls the method when a lock on an item in the session data store has exceeded the value. For more information about locking and details about the lock identifier, see "Locking Session-Store Data" in the class overview. + The object also calls the method when a lock on an item in the session data store has exceeded the value. For more information about locking and details about the lock identifier, see "Locking Session-Store Data" in the class overview. - The method only removes the lock from an item in the session data store for the current application that matches the supplied session `id` and `lockId` values. If the `lockId` does not match the one in the data store, the method does nothing. + The method only removes the lock from an item in the session data store for the current application that matches the supplied session `id` and `lockId` values. If the `lockId` does not match the one in the data store, the method does nothing. @@ -507,7 +507,7 @@ object calls the method at the end of a request, during the event, to delete the data for a session item from the session data store if the method has been called. Only session data for the current application that matches the supplied session `id` and `lockId` values is deleted. For more information about locking and details about the lock identifier, see "Locking Session-Store Data" in the class overview. + The object calls the method at the end of a request, during the event, to delete the data for a session item from the session data store if the method has been called. Only session data for the current application that matches the supplied session `id` and `lockId` values is deleted. For more information about locking and details about the lock identifier, see "Locking Session-Store Data" in the class overview. @@ -547,13 +547,13 @@ object calls the method to update the expiration date and time for a session to the current date and time plus the session value when either: + The object calls the method to update the expiration date and time for a session to the current date and time plus the session value when either: -- the attribute is `true`, or +- the attribute is `true`, or - the request did not raise the and events due to an error. - If an ASP.NET page is requested and the attribute is set to `false`, the method is still called to update the expiration date and time of the data in the session data store. + If an ASP.NET page is requested and the attribute is set to `false`, the method is still called to update the expiration date and time of the data in the session data store. @@ -600,11 +600,11 @@ object calls the method at the end of a request, during the event, to insert current session-item information into the data store or update existing session-item information in the data store with current values, to update the expiration time on the item, and to release the lock on the data. Only session data for the current application that matches the supplied session `id` and `lockId` values is updated. For more information about locking, see "Locking Session Store Data" in the class overview. + The object calls the method at the end of a request, during the event, to insert current session-item information into the data store or update existing session-item information in the data store with current values, to update the expiration time on the item, and to release the lock on the data. Only session data for the current application that matches the supplied session `id` and `lockId` values is updated. For more information about locking, see "Locking Session Store Data" in the class overview. - If the session values for the current request have not been modified, the method is not called. Instead, the method is called. + If the session values for the current request have not been modified, the method is not called. Instead, the method is called. - If the method has been called, the method is not called. Instead, the object calls the method to delete session-item data from the data source. + If the method has been called, the method is not called. Instead, the object calls the method to delete session-item data from the data source. @@ -644,9 +644,9 @@ object calls the method when the module is initialized to determine whether calls to the `Session_OnEnd` event are supported by the implementation and to associate the delegate with the `Session_OnEnd` event. + The object calls the method when the module is initialized to determine whether calls to the `Session_OnEnd` event are supported by the implementation and to associate the delegate with the `Session_OnEnd` event. - Custom session-state store provider implementers should use the method to inform the object whether calls to the `Session_OnEnd` event are supported and to set a local reference to the delegate supplied by the `expireCallback` parameter. The custom implementation must decide when the local delegate will be called. For example, the delegate could be called during the call to the method, which is called when a session is abandoned. + Custom session-state store provider implementers should use the method to inform the object whether calls to the `Session_OnEnd` event are supported and to set a local reference to the delegate supplied by the `expireCallback` parameter. The custom implementation must decide when the local delegate will be called. For example, the delegate could be called during the call to the method, which is called when a session is abandoned. diff --git a/xml/System.Web.SessionState/SessionStateUtility.xml b/xml/System.Web.SessionState/SessionStateUtility.xml index 00666480405..355f9e464ac 100644 --- a/xml/System.Web.SessionState/SessionStateUtility.xml +++ b/xml/System.Web.SessionState/SessionStateUtility.xml @@ -26,10 +26,10 @@ |Method|Use| |------------|---------| -| method|Can be used by custom session-state modules to either retrieve session information for an existing session or create session information for a new session.| -| method|Called by the session-state module to add the session data to the current and make it available to application code through the property.| -| method|Called by the session-state module during the or events at the end of a request, to clear session data from the current .| -| method|Called by the session-state module to get a reference to the collection based on objects defined in the Global.asax file. The collection returned is included with the session data added to the current .| +| method|Can be used by custom session-state modules to either retrieve session information for an existing session or create session information for a new session.| +| method|Called by the session-state module to add the session data to the current and make it available to application code through the property.| +| method|Called by the session-state module during the or events at the end of a request, to clear session data from the current .| +| method|Called by the session-state module to get a reference to the collection based on objects defined in the Global.asax file. The collection returned is included with the session data added to the current .| Session data is passed to and retrieved from the current as an object or any valid implementation of the interface. @@ -90,12 +90,12 @@ method is used by a session-state module to apply session data to the current request. This occurs during the event at the beginning of a request. Session data for the current request is either retrieved for an existing session or created for a new session. The session data is then encapsulated in an implementation instance, which is passed to the method along with the current . The supplied session data is then made available to application code through the property of the current context. + The method is used by a session-state module to apply session data to the current request. This occurs during the event at the beginning of a request. Session data for the current request is either retrieved for an existing session or created for a new session. The session data is then encapsulated in an implementation instance, which is passed to the method along with the current . The supplied session data is then made available to application code through the property of the current context. ## Examples - The following code example shows the handler for the event in a custom session-state module. The custom module retrieves existing session information or creates new session information and uses the method to add it to the of the current request. This code example is part of a larger example provided for the class. + The following code example shows the handler for the event in a custom session-state module. The custom module retrieves existing session information or creates new session information and uses the method to add it to the of the current request. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/CS/mysessionstatemodule.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/VB/mysessionstatemodule.vb" id="Snippet4"::: @@ -132,12 +132,12 @@ method can be used by a session-state module to retrieve session data from the current request. This occurs during the event at the end of a request. The returned session data can then be written to the session data store. If the session has been abandoned, the session data can be removed from the data store and , and the **Session_OnEnd** event can be executed. + The method can be used by a session-state module to retrieve session data from the current request. This occurs during the event at the end of a request. The returned session data can then be written to the session data store. If the session has been abandoned, the session data can be removed from the data store and , and the **Session_OnEnd** event can be executed. ## Examples - The following code example shows the handler for the event in a custom session-state module. The module retrieves session data from the for the current request using the method. This code example is part of a larger example provided for the class. + The following code example shows the handler for the event in a custom session-state module. The module retrieves session data from the for the current request using the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/CS/mysessionstatemodule.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/VB/mysessionstatemodule.vb" id="Snippet5"::: @@ -176,14 +176,14 @@ method is used to retrieve the collection of static objects defined in the Global.asax file for the ASP.NET application. A session-state module implementation will supply the returned collection to the implementation instance that is added to the current context using the method. + The method is used to retrieve the collection of static objects defined in the Global.asax file for the ASP.NET application. A session-state module implementation will supply the returned collection to the implementation instance that is added to the current context using the method. - A can also use the method when creating a object. + A can also use the method when creating a object. ## Examples - The following code example shows the handler for the event in a custom session-state module. The module retrieves existing session information or creates new session information, including the collection returned from the method, and adds it to the of the current request. This code example is part of a larger example provided for the class. + The following code example shows the handler for the event in a custom session-state module. The module retrieves existing session information or creates new session information, including the collection returned from the method, and adds it to the of the current request. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/CS/mysessionstatemodule.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/VB/mysessionstatemodule.vb" id="Snippet4"::: @@ -274,12 +274,12 @@ method is used by a session-state module to execute the **Session_OnEnd** event defined in the Global.asax file for an ASP.NET application. A session-state module will call the method when a session has been abandoned, or if the session expires. + The method is used by a session-state module to execute the **Session_OnEnd** event defined in the Global.asax file for an ASP.NET application. A session-state module will call the method when a session has been abandoned, or if the session expires. ## Examples - The following code example shows the handler for the event in a custom session-state module. If the session has been abandoned, the module executes the **Session_OnEnd** event defined in the Global.asax file for the application using the method. This code example is part of a larger example provided for the class. + The following code example shows the handler for the event in a custom session-state module. If the session has been abandoned, the module executes the **Session_OnEnd** event defined in the Global.asax file for the application using the method. This code example is part of a larger example provided for the class. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/CS/mysessionstatemodule.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.SessionState.SessionStateUtility/VB/mysessionstatemodule.vb" id="Snippet5"::: @@ -320,7 +320,7 @@ method clears session data from the specified . A session-state module will call the method in the handler for the event. + The method clears session data from the specified . A session-state module will call the method in the handler for the event. diff --git a/xml/System.Web.SessionState/StateRuntime.xml b/xml/System.Web.SessionState/StateRuntime.xml index 5f420deb84f..6a2ecf5339f 100644 --- a/xml/System.Web.SessionState/StateRuntime.xml +++ b/xml/System.Web.SessionState/StateRuntime.xml @@ -129,7 +129,7 @@ method is used by unmanaged code in this service to manage the session data. + ASP.NET supports the option of managing session state out-of-process using a Windows service called the ASP.NET state service. The method is used by unmanaged code in this service to manage the session data. This member supports the .NET Framework infrastructure implementation of the ASP.NET state service and is not intended be used directly from your code. For more information about session-state storage options, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). @@ -185,7 +185,7 @@ method is used by unmanaged code in this service to manage the session data. + ASP.NET supports the option of managing session state out-of-process using a Windows service called the ASP.NET state service. The method is used by unmanaged code in this service to manage the session data. This member supports the .NET Framework infrastructure implementation of the ASP.NET state service and is not intended be used directly from your code. For more information about session-state storage options, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). @@ -221,7 +221,7 @@ method is used by unmanaged code in this service to stop processing the session data. This member is provided to support the .NET Framework infrastructure implementation of the ASP.NET state service and is not intended be used directly from your code. For more information about session state storage options, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). + ASP.NET supports the option of managing session state out-of-process using a Windows service called the ASP.NET state service. The method is used by unmanaged code in this service to stop processing the session data. This member is provided to support the .NET Framework infrastructure implementation of the ASP.NET state service and is not intended be used directly from your code. For more information about session state storage options, see [Session-State Modes](https://learn.microsoft.com/previous-versions/aspnet/ms178586(v=vs.100)). ]]> diff --git a/xml/System.Web.UI.Adapters/ControlAdapter.xml b/xml/System.Web.UI.Adapters/ControlAdapter.xml index 62b9776025f..735547c245d 100644 --- a/xml/System.Web.UI.Adapters/ControlAdapter.xml +++ b/xml/System.Web.UI.Adapters/ControlAdapter.xml @@ -34,19 +34,19 @@ During processing, the .NET Framework intercepts calls to the overridable methods of a control that could be target-specific. If a control adapter is attached, the .NET Framework calls the associated adapter methods. - The adapter performs rendering for the control through the method. If overridden, potentially should not call the base class implementation because that performs a call back on the method. This might cause the rendering to occur twice, once by the adapter and once by the control. + The adapter performs rendering for the control through the method. If overridden, potentially should not call the base class implementation because that performs a call back on the method. This might cause the rendering to occur twice, once by the adapter and once by the control. - The base method calls back on the method of the control. Thus, if you override , you should not call the base class implementation unless the rendering you implement is in addition to that provided by of the control. + The base method calls back on the method of the control. Thus, if you override , you should not call the base class implementation unless the rendering you implement is in addition to that provided by of the control. - You must ensure that the .NET Framework performs interception for adapters of the child controls. You can do this by calling the base method, which calls the method of the control, from your override. + You must ensure that the .NET Framework performs interception for adapters of the child controls. You can do this by calling the base method, which calls the method of the control, from your override. - The and methods are called by the control immediately before and after (respectively) the control calls the method. If pre- and post-rendering are the only browser-specific processing tasks required, using and might make it unnecessary to override . The default behavior of the and methods is to call the corresponding methods of the . + The and methods are called by the control immediately before and after (respectively) the control calls the method. If pre- and post-rendering are the only browser-specific processing tasks required, using and might make it unnecessary to override . The default behavior of the and methods is to call the corresponding methods of the . - To maintain its own state information, a control adapter can override the , , , and methods. , , , and are called when the private control and view states are saved and loaded, respectively. + To maintain its own state information, a control adapter can override the , , , and methods. , , , and are called when the private control and view states are saved and loaded, respectively. - The , , , and base methods call back on the corresponding class methods. Thus, any of these methods that are overridden must call their base methods; otherwise, the event associated with the class method will not be raised. + The , , , and base methods call back on the corresponding class methods. Thus, any of these methods that are overridden must call their base methods; otherwise, the event associated with the class method will not be raised. - Controls and adapters optionally implement the and interfaces. The .NET Framework determines whether an adapter exists and whether the adapter implements these interfaces. If it does, the adapter should override the , , and methods, as necessary. If the postback data is not recognized in the adapter, it must call back on the control to process it. Subsequent event handlers also must call back on the control. + Controls and adapters optionally implement the and interfaces. The .NET Framework determines whether an adapter exists and whether the adapter implements these interfaces. If it does, the adapter should override the , , and methods, as necessary. If the postback data is not recognized in the adapter, it must call back on the control to process it. Subsequent event handlers also must call back on the control. ]]> @@ -124,9 +124,9 @@ method is called just before the method, and is used to perform target-specific preprocessing before the rendering of the control. + The method is called just before the method, and is used to perform target-specific preprocessing before the rendering of the control. - Use the method in combination with the method to ensure opening and closing tag consistency. + Use the method in combination with the method to ensure opening and closing tag consistency. ]]> @@ -260,7 +260,7 @@ object and the method is overridden, the override is called instead of the method. Thus, can be used to create a target-specific child control set. + If there is a derived control adapter attached to a object and the method is overridden, the override is called instead of the method. Thus, can be used to create a target-specific child control set. For more information about combining controls to create a new control, see [Composite Controls](https://msdn.microsoft.com/library/fb174677-d845-467c-8bf3-cc096b2490b0). @@ -299,9 +299,9 @@ method is called just after the method, and is used to perform target-specific postprocessing after the rendering of the control. + The method is called just after the method, and is used to perform target-specific postprocessing after the rendering of the control. - Use the method in combination with the method to ensure opening and closing tag consistency. + Use the method in combination with the method to ensure opening and closing tag consistency. ]]> @@ -341,11 +341,11 @@ and methods. + Control state is the essential state information needed even if view state is disabled. When an adapter needs to maintain its own control state information, it can override the and methods. An adapter might need to maintain control state information when there are features that need to have state maintained across requests, independent from the state of the associated control. For example, a composite control consisting of a large textual display and a group of controls might render as a single view on desktop computer browsers. On other browsers, it might split its rendering - one view for the textual display and the other for the radio button group. The adapter would need to maintain its own target-specific information about the currently active view. - The method is called immediately after the method, in the `LoadState` lifecycle stage. The adapter control state is separate and in addition to the control state of the control. + The method is called immediately after the method, in the `LoadState` lifecycle stage. The adapter control state is separate and in addition to the control state of the control. ]]> @@ -381,11 +381,11 @@ and methods. + When an adapter needs to maintain its own view state information, it can override the and methods. An adapter needs to maintain view state information when there is data that must be maintained across requests, independent from the view state of the associated control. For example, a grid control on desktop computer browsers might render as a single view of rows and columns of values. On other browsers, it might split its rendering into multiple separate views, such as a list of rows and details of a single row. The adapter would need to maintain the data for the views that are not currently active in view state. - The method is called immediately before the method in the `LoadState` lifecycle stage. The adapter view state is separate and in addition to the view state of the control. + The method is called immediately before the method in the `LoadState` lifecycle stage. The adapter view state is separate and in addition to the view state of the control. ]]> @@ -422,14 +422,14 @@ object and the method is overridden, the override method is called instead of the method. + If there is an adapter attached to a object and the method is overridden, the override method is called instead of the method. - Override to perform target-specific processing in the `Initialize` stage of the control lifecycle. Typically, these are functions that are performed when a control is created. + Override to perform target-specific processing in the `Initialize` stage of the control lifecycle. Typically, these are functions that are performed when a control is created. ## Examples - The following code sample derives a custom control adapter from the class. It then overrides the method to set a property on the associated control and call the base method to complete the control initialization. + The following code sample derives a custom control adapter from the class. It then overrides the method to set a property on the associated control and call the base method to complete the control initialization. :::code language="cpp" source="~/snippets/cpp/VS_Snippets_WebNet/ControlAdapter_OnInit/CPP/controladapter_oninit.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/ControlAdapter_OnInit/CS/controladapter_oninit.cs" id="Snippet1"::: @@ -471,9 +471,9 @@ object and the method is overridden, the override method is called instead of the method. + If there is an adapter attached to a object and the method is overridden, the override method is called instead of the method. - Override the method to perform target-specific processing in the `Load` stage of the control lifecycle. Typically, these are functions that should be performed for each client request. + Override the method to perform target-specific processing in the `Load` stage of the control lifecycle. Typically, these are functions that should be performed for each client request. ]]> @@ -511,9 +511,9 @@ object and the method is overridden, the override method is called instead of the method. + If there is an adapter attached to a object and the method is overridden, the override method is called instead of the method. - Override the method to perform target-specific processing in the `PreRender` stage of the control lifecycle. Typically, these are functions that immediately precede rendering of the control output. + Override the method to perform target-specific processing in the `PreRender` stage of the control lifecycle. Typically, these are functions that immediately precede rendering of the control output. ]]> @@ -551,9 +551,9 @@ object and the method is overridden, the override method is called instead of the method. + If there is an adapter attached to a object and the method is overridden, the override method is called instead of the method. - Override the method to do target-specific processing in the `Unload` stage of the control lifecycle. Typically, these are cleanup functions that precede disposition of the control. + Override the method to do target-specific processing in the `Unload` stage of the control lifecycle. Typically, these are cleanup functions that precede disposition of the control. ]]> @@ -675,7 +675,7 @@ method to generate target-specific markup to send to the client browser. The method is called in place of the method if a object is attached to a object. + Override the method to generate target-specific markup to send to the client browser. The method is called in place of the method if a object is attached to a object. ]]> @@ -717,7 +717,7 @@ method when it is necessary to generate target-specific markup for the child control set of a composite control, in addition to the markup for the individual child controls. + Override the method when it is necessary to generate target-specific markup for the child control set of a composite control, in addition to the markup for the individual child controls. ]]> @@ -756,11 +756,11 @@ and methods. + Control state is the essential state information needed even if view state is disabled. When an adapter needs to maintain its own control state information, it can override the and methods. An adapter might need to maintain control state information when there are features that need to have state maintained across requests, independent from the state of the associated control. For example, a composite control consisting of a large textual display and a group of controls might render as a single view on desktop computer browsers. On other browsers, it might split its rendering - one view for the textual display and the other for the radio button group. The adapter would need to maintain its own target-specific information about the currently active view. - The method is called immediately after the method in the `SaveState` lifecycle stage. The adapter control state is separate and in addition to the control state of the control. + The method is called immediately after the method in the `SaveState` lifecycle stage. The adapter control state is separate and in addition to the control state of the control. ]]> @@ -794,11 +794,11 @@ and methods. + When an adapter needs to maintain its own view state information, it can override the and methods. An adapter needs to maintain view state information when there is data that must be maintained across requests, independent from the associated view state of the control. For example, a grid control on desktop computer browsers might render as a single view of rows and columns of values. On other browsers, it might split its rendering into multiple separate views, such as a list of rows and details of a single row. The adapter would need to maintain the data for the views that are not currently active in view state. - The method is called immediately before the method in the `SaveState` lifecycle stage. The adapter view state is separate and in addition to the view state of the control. + The method is called immediately before the method in the `SaveState` lifecycle stage. The adapter view state is separate and in addition to the view state of the control. ]]> diff --git a/xml/System.Web.UI.Adapters/PageAdapter.xml b/xml/System.Web.UI.Adapters/PageAdapter.xml index 995843c38fe..ddf6459725a 100644 --- a/xml/System.Web.UI.Adapters/PageAdapter.xml +++ b/xml/System.Web.UI.Adapters/PageAdapter.xml @@ -26,28 +26,28 @@ The members of the class provide the following functionality: -- The and properties define additional HTTP headers and HTTP `GET` and `POST` parameters that can be used to vary caching. They are called during cache initialization from the class. +- The and properties define additional HTTP headers and HTTP `GET` and `POST` parameters that can be used to vary caching. They are called during cache initialization from the class. -- The method returns an object that can be used to persist the combined view and control states of the page. It is referenced from the property if a derived page adapter is present. +- The method returns an object that can be used to persist the combined view and control states of the page. It is referenced from the property if a derived page adapter is present. -- The method provides a DHTML code fragment that can be used to reference forms in scripts. +- The method provides a DHTML code fragment that can be used to reference forms in scripts. -- The method returns a collection of the postback variables if the page is in postback. It is called by the .NET Framework instead of the method if a derived page adapter is present. +- The method returns a collection of the postback variables if the page is in postback. It is called by the .NET Framework instead of the method if a derived page adapter is present. -- The and methods are used by control adapters to render hyperlinks if a derived page adapter is present. +- The and methods are used by control adapters to render hyperlinks if a derived page adapter is present. -- The method renders a hyperlink or postback client tag that can submit the form. +- The method renders a hyperlink or postback client tag that can submit the form. -- The and methods are used by radio button control adapters to reference the other controls in a radio button group. +- The and methods are used by radio button control adapters to reference the other controls in a radio button group. - The property provides access to the combined control and view states of the object through the internal `ClientState` property of the class. -- The method is used by control adapters to perform device-specific text transformation. +- The method is used by control adapters to perform device-specific text transformation. ## Examples - The following code example demonstrates how to derive a class named `CustomPageAdapter` from the class and override the method. The method adds an attribute named `src` to a hyperlink, which contains a reference to the current page. All hyperlinks rendered in pages to which `CustomPageAdapter` is attached will have the `src` attribute. + The following code example demonstrates how to derive a class named `CustomPageAdapter` from the class and override the method. The method adds an attribute named `src` to a hyperlink, which contains a reference to the current page. All hyperlinks rendered in pages to which `CustomPageAdapter` is attached will have the `src` attribute. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Adapters.PageAdapter.RenderBeginHyperlink/CS/pageadapter.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Adapters.PageAdapter.RenderBeginHyperlink/VB/pageadapter.vb" id="Snippet1"::: @@ -233,7 +233,7 @@ method returns one of the following collections: + The method returns one of the following collections: - Form variables if the HTTP data transfer method is `POST`. @@ -306,7 +306,7 @@ method provides a DHTML reference to the postback form. The code fragment has the following format: + The method provides a DHTML reference to the postback form. The code fragment has the following format: `document.forms['` `formID` `']` @@ -347,7 +347,7 @@ and methods to reference the other controls in the group. + Radio button control adapters use the and methods to reference the other controls in the group. ]]> @@ -379,14 +379,14 @@ property uses the method to return the object, derived from the class, that forms and extracts the combined control and view states for the page. If there is no derived page adapter attached to the page, a object is used to maintain the state in a hidden field on the page. + The property uses the method to return the object, derived from the class, that forms and extracts the combined control and view states for the page. If there is no derived page adapter attached to the page, a object is used to maintain the state in a hidden field on the page. |Link type|Resulting link| |---------------|--------------------| -|Code Entity Reference,cer|| -|Code Entity Reference Qualified, cerq|| -|Code Entity Reference Specific,cers|| -|Code Entity Reference Qualified Specific, cerqs|| +|Code Entity Reference,cer|| +|Code Entity Reference Qualified, cerq|| +|Code Entity Reference Specific,cers|| +|Code Entity Reference Qualified Specific, cerqs|| ]]> @@ -431,9 +431,9 @@ class uses a object to maintain a list of radio button groups. Each element in is a collection of the controls in a radio button group. The method adds a control to the appropriate collection, creating the collection if it does not already exist, and creating if there are no previously registered controls. + The class uses a object to maintain a list of radio button groups. Each element in is a collection of the controls in a radio button group. The method adds a control to the appropriate collection, creating the collection if it does not already exist, and creating if there are no previously registered controls. - Radio button control adapters use the and methods to reference the other controls in a radio button group. + Radio button control adapters use the and methods to reference the other controls in a radio button group. ]]> @@ -489,14 +489,14 @@ method writes an opening hyperlink tag. When `writer` is , this tag has the following format: + The method writes an opening hyperlink tag. When `writer` is , this tag has the following format: `` ## Examples - The following code example demonstrates how to derive a class named `CustomPageAdapter` from the class and override the method. The method adds an attribute named `src` to a hyperlink, which contains a reference to the current page. All hyperlinks rendered in pages to which `CustomPageAdapter` is attached will have the `src` attribute. + The following code example demonstrates how to derive a class named `CustomPageAdapter` from the class and override the method. The method adds an attribute named `src` to a hyperlink, which contains a reference to the current page. All hyperlinks rendered in pages to which `CustomPageAdapter` is attached will have the `src` attribute. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Adapters.PageAdapter.RenderBeginHyperlink/CS/pageadapter.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Adapters.PageAdapter.RenderBeginHyperlink/VB/pageadapter.vb" id="Snippet1"::: @@ -546,14 +546,14 @@ method writes an opening hyperlink tag. When `writer` is an object, this tag has the following format: + The method writes an opening hyperlink tag. When `writer` is an object, this tag has the following format: `` ## Examples - The following code example demonstrates how to derive a class named `CustomPageAdapter` from the class and override the method. adds an attribute named `src` to a hyperlink, which contains a reference to the current page. All hyperlinks rendered in pages to which `CustomPageAdapter` is attached will have the `src` attribute. + The following code example demonstrates how to derive a class named `CustomPageAdapter` from the class and override the method. adds an attribute named `src` to a hyperlink, which contains a reference to the current page. All hyperlinks rendered in pages to which `CustomPageAdapter` is attached will have the `src` attribute. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Adapters.PageAdapter.RenderBeginHyperlink/CS/pageadapter.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Adapters.PageAdapter.RenderBeginHyperlink/VB/pageadapter.vb" id="Snippet1"::: @@ -596,7 +596,7 @@ method writes a closing hyperlink tag. When the text writer is an object, this tag has the following format: + The method writes a closing hyperlink tag. When the text writer is an object, this tag has the following format: `` @@ -658,7 +658,7 @@ method writes a postback event as a scriptless hyperlink. + The method writes a postback event as a scriptless hyperlink. ]]> @@ -713,7 +713,7 @@ method writes a postback event as a scriptless hyperlink, including the possibly chunked view state, `__EVENTTARGET=target`, `__EVENTARGUMENT=argument`, `__PREVIOUSPAGE=currentFilePath` parameters, and an `accessKey="accessKey"` attribute. + The method writes a postback event as a scriptless hyperlink, including the possibly chunked view state, `__EVENTTARGET=target`, `__EVENTARGUMENT=argument`, `__PREVIOUSPAGE=currentFilePath` parameters, and an `accessKey="accessKey"` attribute. View state is encrypted if the `enableViewStateMac` attribute of the [pages Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/950xf363(v=vs.100)) configuration element is set to `true`. @@ -767,7 +767,7 @@ method writes a postback event as a scriptless hyperlink, including the possibly chunked view state, `__EVENTTARGET=target`, `__EVENTARGUMENT=argument`, `__PREVIOUSPAGE=currentFilePath` parameters, and an `accessKey="accessKey"` attribute. + The method writes a postback event as a scriptless hyperlink, including the possibly chunked view state, `__EVENTTARGET=target`, `__EVENTARGUMENT=argument`, `__PREVIOUSPAGE=currentFilePath` parameters, and an `accessKey="accessKey"` attribute. ]]> @@ -805,9 +805,9 @@ method can be used, for example, to transform tab characters (`\t`) into line breaks (`\n`). + The method can be used, for example, to transform tab characters (`\t`) into line breaks (`\n`). - The base method returns `text` unchanged. + The base method returns `text` unchanged. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/Annotation.xml b/xml/System.Web.UI.DataVisualization.Charting/Annotation.xml index 6848fec41e0..05246feff79 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/Annotation.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/Annotation.xml @@ -35,7 +35,7 @@ There are two ways to use axis values when you specify the position and size of an annotation: -- Set the , or both of these annotation properties to the and property values of a object. +- Set the , or both of these annotation properties to the and property values of a object. - Use the property to anchor the annotation to a data point. In this case, its positioning is automatically calculated. @@ -139,7 +139,7 @@ property, or by setting the and properties. Its and properties must be set to . + The annotation must be anchored by either using the property, or by setting the and properties. Its and properties must be set to . ]]> @@ -191,9 +191,9 @@ ## Remarks The annotation is anchored to the X and Y values of the specified data point, and automatically uses the same axes coordinates as the data point. - To automatically position the annotation relative to the anchor point, make sure its and properties are set to . The property can be used to change the annotation's automatic position alignment to the anchor point. The and properties can be used to add extra spacing. + To automatically position the annotation relative to the anchor point, make sure its and properties are set to . The property can be used to change the annotation's automatic position alignment to the anchor point. The and properties can be used to add extra spacing. - When you use this property, make sure the and properties are set to , as they have precedence. + When you use this property, make sure the and properties are set to , as they have precedence. Set this value to `null` to disable annotation anchoring to a data point. @@ -276,7 +276,7 @@ or the property, and its property must be set to . + The annotation must be anchored using either the or the property, and its property must be set to . ]]> @@ -318,7 +318,7 @@ or property, and its property must be set to . + The annotation must be anchored using either the or property, and its property must be set to . ]]> @@ -366,7 +366,7 @@ ## Remarks The annotation is anchored to the X coordinate and is specified in relative chart or axes coordinates, depending on the property value. - To automatically position an annotation relative to an anchor point, make sure its property is set to . The property can be used to change the automatic position alignment of the annotation to the anchor point. The and properties may be used to add extra spacing. + To automatically position an annotation relative to an anchor point, make sure its property is set to . The property can be used to change the automatic position alignment of the annotation to the anchor point. The and properties may be used to add extra spacing. This property has a higher priority than the property. @@ -418,7 +418,7 @@ ## Remarks The annotation is anchored to the Y coordinate and is specified in relative chart or axes coordinates, depending on the property value. - To automatically position an annotation relative to an anchor point make sure its property is set to . The property can be used to change the automatic position alignment of the annotation to the anchor point. The and properties may be used to add extra spacing. + To automatically position an annotation relative to an anchor point make sure its property is set to . The property can be used to change the automatic position alignment of the annotation to the anchor point. The and properties may be used to add extra spacing. This property has a higher priority than the property. @@ -797,7 +797,7 @@ and . + Two colors are used to draw the gradients, and . This property does not apply to line-type annotations, image annotations and text annotations. @@ -849,7 +849,7 @@ and . + Two colors are used to draw the hatching, and . This property does not apply to line-type annotations, image annotations and text annotations. @@ -905,7 +905,7 @@ when or is used. + The secondary color is used with the when or is used. This property does not apply to line-type annotations, image annotations and text annotations. @@ -957,7 +957,7 @@ property, or set the annotation axes using the and properties and set the property to `false`. + To use axes coordinates, anchor an annotation to a data point using the property, or set the annotation axes using the and properties and set the property to `false`. ]]> @@ -1171,7 +1171,7 @@ Annotation height can be in relative chart coordinates or in axes coordinates. Chart relative coordinates are used by default. - To use axes coordinates, anchor an annotation to a data point using the property, or set the annotation axes using the or properties and set the property to `false`. + To use axes coordinates, anchor an annotation to a data point using the property, or set the annotation axes using the or properties and set the property to `false`. Set the height to to achieve automatic size calculation for annotations with text. The size will automatically be calculated based on the annotation text and font size. @@ -1250,7 +1250,7 @@ ## Remarks The height and width of an annotation may be set in relative chart or in axes coordinates. Relative chart coordinates are the default. - To express the size of an annotation in axes coordinates, set the property to `false`. Then anchor the annotation to a data point or set the and properties. + To express the size of an annotation in axes coordinates, set the property to `false`. Then anchor the annotation to a data point or set the and properties. ]]> @@ -1554,7 +1554,7 @@ property, or set the annotation axes using the or properties and set the property to `false`. + To use axes coordinates, anchor an annotation to a data point using the property, or set the annotation axes using the or properties and set the property to `false`. ]]> @@ -2017,9 +2017,9 @@ ## Remarks The X coordinate of an annotation is specified in relative chart coordinates or in axes coordinates. Relative chart coordinates are used by default. - To use axes coordinates, anchor an annotation to a data point using the property, or set the annotation axes using the and properties. + To use axes coordinates, anchor an annotation to a data point using the property, or set the annotation axes using the and properties. - Set the position to to automatically calculate position when the annotation has been anchored using the property or the and properties. + Set the position to to automatically calculate position when the annotation has been anchored using the property or the and properties. ]]> @@ -2067,9 +2067,9 @@ ## Remarks The Y coordinate of an annotation is specified in relative chart coordinates or in axes coordinates. Relative chart coordinates are used by default. - To use axes coordinates, anchor an annotation to a data point using the property, or set the annotation axes using the or properties. + To use axes coordinates, anchor an annotation to a data point using the property, or set the annotation axes using the or properties. - Set the position to to automatically calculate the position when the annotation has been anchored using the property or the and properties. + Set the position to to automatically calculate the position when the annotation has been anchored using the property or the and properties. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/AnnotationGroup.xml b/xml/System.Web.UI.DataVisualization.Charting/AnnotationGroup.xml index d7232ca43fb..23edaf33355 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/AnnotationGroup.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/AnnotationGroup.xml @@ -263,7 +263,7 @@ and . + Two colors are used to draw the gradient, and . ]]> @@ -313,7 +313,7 @@ and . + Two colors are used to draw the hatching, and . ]]> @@ -367,7 +367,7 @@ when or are used. + A secondary color is used with when or are used. ]]> @@ -579,7 +579,7 @@ ## Remarks The height and width of an annotation may be set in relative chart or in axes coordinates. By default, relative chart coordinates are used. - To use axes coordinates, set the property to `false`. Then either anchor the annotation to a data point or set the or properties. + To use axes coordinates, set the property to `false`. Then either anchor the annotation to a data point or set the or properties. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/ArrowAnnotation.xml b/xml/System.Web.UI.DataVisualization.Charting/ArrowAnnotation.xml index 0b4185a651f..d195eaa4d33 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/ArrowAnnotation.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/ArrowAnnotation.xml @@ -16,13 +16,13 @@ Represents an arrow annotation. - @@ -77,13 +77,13 @@ Gets or sets the position alignment of the annotation to the anchor point. A enumeration value that represents the alignment of the annotation to the anchor point. - , or the and properties. - - Its and properties must be set to . - + , or the and properties. + + Its and properties must be set to . + ]]> @@ -125,13 +125,13 @@ Gets the name of the annotation type. For internal use, should not be used. A value that represents the name of the annotation type. - diff --git a/xml/System.Web.UI.DataVisualization.Charting/Axis.xml b/xml/System.Web.UI.DataVisualization.Charting/Axis.xml index 6a38293dbca..e38721bd471 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/Axis.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/Axis.xml @@ -29,7 +29,7 @@ control, and is exposed by the , , and properties of objects. + This class encapsulates all the functionality for axes in the control, and is exposed by the , , and properties of objects. For all charts - except bar, stacked bar, pie and doughnut - the primary and secondary axes are as follows: @@ -383,7 +383,7 @@ If an axis is enabled, the axis, along with all its attributes (tick marks, strip lines, labels, and so forth), will be displayed regardless of whether or not it is being used to plot a . - If a value of is used, an axis may or may not be displayed, depending on whether it is being used to plot a . The axes that are used to plot data are determined by the and property settings. + If a value of is used, an axis may or may not be displayed, depending on whether it is being used to plot a . The axes that are used to plot data are determined by the and property settings. > [!NOTE] > If an axis is not enabled but an adjacent axis is using grid lines, one of those grid lines will be displayed in place of the axis that is not enabled. The same situation will occur if the property of an axis is set to , but the axis is not being used to plot data; the grid line of an adjacent axis will be drawn instead. @@ -475,7 +475,7 @@ ## Remarks Use this property to specify the color of interlaced strip lines that are displayed when you invoke the property. - To specify the border color of the interlaced strip lines, you must display the strips using the collection property instead of the property. + To specify the border color of the interlaced strip lines, you must display the strips using the collection property instead of the property. ]]> @@ -633,7 +633,7 @@ The property of the tick marks, labels and grid lines of an axis has priority over the property setting of the object. - A value of zero represents an "Auto" value. Also, cannot be set to not set (that is, a ). If you assign , a value of "Auto" - that is, a value of zero - will be used instead. + A value of zero represents an "Auto" value. Also, cannot be set to not set (that is, a ). If you assign , a value of "Auto" - that is, a value of zero - will be used instead. **Note** The minor grid lines and tick marks of an axis never use this property for their interval offset. @@ -1276,7 +1276,7 @@ ## Remarks Use this property to specify the style, formatting, and so forth, of axis labels. - If the property is `true`, the font size, font angle and the use of offset labels are determined automatically. If you set any one of the LabelStyle.Font.Size, or properties, the property will be set to `false`. + If the property is `true`, the font size, font angle and the use of offset labels are determined automatically. If you set any one of the LabelStyle.Font.Size, or properties, the property will be set to `false`. Note that if a format that consists of a date without a time is used for labels, and the data point values that are used specify times, the times will affect the positions of the data points, even though they are not displayed due to the label formatting. @@ -1707,7 +1707,7 @@ method. The value must be greater than the value. + To automatically round the maximum and minimum axis values call the method. The value must be greater than the value. ]]> @@ -1788,9 +1788,9 @@ control will assume the first data point occurs at zero. Also, if the value is explicitly set, the property will be ignored. The value must be less than the value. + Note that if you set this value explicitly, the X-values of data elements must be taken into account. If all data points have X-values of zero, the control will assume the first data point occurs at zero. Also, if the value is explicitly set, the property will be ignored. The value must be less than the value. - To automatically round the maximum and minimum axis values. call the method. + To automatically round the maximum and minimum axis values. call the method. ]]> @@ -2059,7 +2059,7 @@ method to round the values of an axis. Note that the interval used for the axis will not be changed when this method is called. This method is only supported for the X and X2 axes. The Y and Y2 axes values are rounded by default. + Call the method to round the values of an axis. Note that the interval used for the axis will not be changed when this method is called. This method is only supported for the X and X2 axes. The Y and Y2 axes values are rounded by default. ]]> @@ -2392,7 +2392,7 @@ ## Remarks Gets or sets title font properties such as face or size. - To set font properties at run time, a new object must be created. Any attempt to change the properties of the current object at run time will result in a compilation error. + To set font properties at run time, a new object must be created. Any attempt to change the properties of the current object at run time will result in a compilation error. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/AxisEnabled.xml b/xml/System.Web.UI.DataVisualization.Charting/AxisEnabled.xml index 3cc7f8c4057..30ec740fe37 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/AxisEnabled.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/AxisEnabled.xml @@ -20,7 +20,7 @@ ## Remarks The enumeration is used with the property to enable or disable an axis. - If the property is set to Auto, an axis may or may not be displayed, depending on whether it is being used to plot a . The axes that are used to plot data for a series are determined by the and property settings. + If the property is set to Auto, an axis may or may not be displayed, depending on whether it is being used to plot a . The axes that are used to plot data for a series are determined by the and property settings. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/AxisScaleBreakStyle.xml b/xml/System.Web.UI.DataVisualization.Charting/AxisScaleBreakStyle.xml index 5246c432f76..1be23f397b1 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/AxisScaleBreakStyle.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/AxisScaleBreakStyle.xml @@ -27,7 +27,7 @@ ## Remarks Scale breaks are intentional discontinuities on the Y-axis that are most often used to redistribute the data points in a series on a chart. This feature improves readability when there are large differences between the high and low values of the data in one series being plotted. Scale breaks are not drawn for differences between data in multiple series. - By default, scale breaks are disabled. You can enable scale breaks on the Y-axis by setting the property to `true`. To change the amount of vertical space of the scale break, you can specify a value. This is calculated as a percentage of the Y-axis scale. + By default, scale breaks are disabled. You can enable scale breaks on the Y-axis by setting the property to `true`. To change the amount of vertical space of the scale break, you can specify a value. This is calculated as a percentage of the Y-axis scale. You must have sufficient separation between ranges of data points in a single series to draw a scale break. By default, a scale break can be added only if there is a separation between the data ranges of at least 25% of the chart. If you enable a scale break but it does not appear, even though there is sufficient distance between the data ranges, you can set the property to a value less than 25. diff --git a/xml/System.Web.UI.DataVisualization.Charting/AxisType.xml b/xml/System.Web.UI.DataVisualization.Charting/AxisType.xml index 99892dafc33..1e5782f5ead 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/AxisType.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/AxisType.xml @@ -15,24 +15,24 @@ Specifies the axis type for the X and Y-axes of a . - enumeration represents the axis type used for the X and Y-axes of a . - - A is plotted using two axes, with the exception of pie and doughnut charts. This enumeration is used in conjunction with the and properties to set the axes used for plotting the associated data points of the . - - For all charts except for bar, stacked bar, pie and doughnut types, the primary and secondary axes are as follows: - -|Axis Type|Description| -|---------------|-----------------| -|Primary X-Axis|Bottom horizontal axis.| -|Secondary X-Axis|Top horizontal axis.| -|Primary Y-Axis|Left vertical axis.| -|Secondary Y-Axis|Right vertical axis.| - - Bar and stacked-bar charts have their axes rotated 90 degrees clockwise. For example, the primary X-axis for these two charts is the left-vertical axis. - + enumeration represents the axis type used for the X and Y-axes of a . + + A is plotted using two axes, with the exception of pie and doughnut charts. This enumeration is used in conjunction with the and properties to set the axes used for plotting the associated data points of the . + + For all charts except for bar, stacked bar, pie and doughnut types, the primary and secondary axes are as follows: + +|Axis Type|Description| +|---------------|-----------------| +|Primary X-Axis|Bottom horizontal axis.| +|Secondary X-Axis|Top horizontal axis.| +|Primary Y-Axis|Left vertical axis.| +|Secondary Y-Axis|Right vertical axis.| + + Bar and stacked-bar charts have their axes rotated 90 degrees clockwise. For example, the primary X-axis for these two charts is the left-vertical axis. + ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/BorderSkin.xml b/xml/System.Web.UI.DataVisualization.Charting/BorderSkin.xml index 5780426a794..a089b9b6731 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/BorderSkin.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/BorderSkin.xml @@ -453,7 +453,7 @@ property, when the and properties are used. + This color is combined with the primary background color, which is set with the property, when the and properties are used. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/CalloutAnnotation.xml b/xml/System.Web.UI.DataVisualization.Charting/CalloutAnnotation.xml index b170ef23ae4..791a5d6ef55 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/CalloutAnnotation.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/CalloutAnnotation.xml @@ -103,7 +103,7 @@ must be anchored using either the or the property, and its property must be set to . + The must be anchored using either the or the property, and its property must be set to . ]]> @@ -141,7 +141,7 @@ must be anchored using either the or the property, and its property must be set to . + The must be anchored using either the or the property, and its property must be set to . ]]> @@ -284,7 +284,7 @@ and properties. + Two colors are used to draw the gradient, and are set with the and properties. ]]> @@ -334,7 +334,7 @@ and properties. + Two colors are used to draw the hatching, and are set with the and properties. ]]> @@ -388,7 +388,7 @@ property when the or properties are used. + This color is used with the property when the or properties are used. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/Chart.xml b/xml/System.Web.UI.DataVisualization.Charting/Chart.xml index 1b227ca3017..3bcce1c395c 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/Chart.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/Chart.xml @@ -51,7 +51,7 @@ ## Remarks This class exposes all of the properties, methods and events of the Chart Web control. - Two important properties of the class are the and properties, both of which are collection properties. The collection property stores objects, which are used to store data that is to be displayed, along with attributes of that data. The collection property stores objects, which are primarily used to draw one or more charts using one set of axes. + Two important properties of the class are the and properties, both of which are collection properties. The collection property stores objects, which are used to store data that is to be displayed, along with attributes of that data. The collection property stores objects, which are primarily used to draw one or more charts using one set of axes. ]]> @@ -142,7 +142,7 @@ ## Remarks This method is used to align data points from different series along the X axis using their axis labels, and is applicable when: -- Multiple series are displayed and are indexed; that is, all data points have an of 0, or the property is `true`. +- Multiple series are displayed and are indexed; that is, all data points have an of 0, or the property is `true`. - All data points have non-empty axis labels, which are unique to their . If they are not unique, an exception will be thrown. @@ -213,7 +213,7 @@ ## Remarks This method is used to align data points from different series along the X axis using their axis labels, and is applicable when: -- Multiple series are displayed and are indexed; that is, all data points have an of 0, or the property is `true`. +- Multiple series are displayed and are indexed; that is, all data points have an of 0, or the property is `true`. - All data points have non-empty axis labels, which are unique to their . If they are not unique, an exception will be thrown. @@ -394,7 +394,7 @@ ## Remarks When the colors are automatically assigned at run time, there is no way to know what the colors will be prior to the time when the chart rendered; the `Color` property of an automatically assigned value will return at this time. - If you call the method, the colors for the series and the data points will be set, which allows for programmatic access. + If you call the method, the colors for the series and the data points will be set, which allows for programmatic access. ]]> @@ -448,9 +448,9 @@ object, the alpha component cannot be set to a value other than 255. This also means that, for the object only, a value cannot be used. + You can set this property to any valid ARGB (alpha, red, green, blue) value. Note that for the object, the alpha component cannot be set to a value other than 255. This also means that, for the object only, a value cannot be used. - The value will be the first color used if you are using gradient colors for the background. + The value will be the first color used if you are using gradient colors for the background. The alpha value controls the opacity of a color. If you set this color to "transparent" - that is, if you use an alpha value of 0 - no color will be assigned to the background of the title. As a result, the background will be transparent. @@ -660,7 +660,7 @@ ## Remarks This property defines a path to a background image for a legend, and can be an absolute or relative URL. - To position the image, use the and properties. + To position the image, use the and properties. You can also specify one of the colors displayed by the image as "transparent", by setting the property. @@ -871,7 +871,7 @@ ## Remarks The property determines the secondary background color of many objects, and is used when gradient colors are being applied. - You can set to any valid ARGB (alpha, red, green, blue) value. + You can set to any valid ARGB (alpha, red, green, blue) value. If hatching is used, the property determines the color of the hatching lines for the chart. @@ -919,7 +919,7 @@ instead. + To get or set the border color, use instead. ]]> @@ -1179,7 +1179,7 @@ instead. + To get or set the border width, use instead. ]]> @@ -1403,11 +1403,11 @@ - All chart data is available; that is, the series and their data points are populated. This is especially useful if data-binding is being used, because the data can be examined and the chart can be adjusted just prior to being drawn. -- All chart properties have been set, including those properties that have been set to "Auto". In other words, "Auto" properties now store the automatically calculated values, and can be examined and modified prior to the chart being drawn. Examples are the and properties of the class. +- All chart properties have been set, including those properties that have been set to "Auto". In other words, "Auto" properties now store the automatically calculated values, and can be examined and modified prior to the chart being drawn. Examples are the and properties of the class. Use this event to modify or customize the chart image before it is drawn. - When changes are made to a chart area, such as to the axis scale, the chart area properties must be recalculated in order to render the chart correctly. To recalculate the chart, call the method after making modifications. + When changes are made to a chart area, such as to the axis scale, the chart area properties must be recalculated in order to render the chart correctly. To recalculate the chart, call the method after making modifications. ]]> @@ -1528,14 +1528,14 @@ These data point properties include: -- -- -- -- -- -- -- -- , which are the names of the custom properties. +- +- +- +- +- +- +- +- , which are the names of the custom properties. ]]> @@ -1584,7 +1584,7 @@ These data point properties include: Other data point properties besides X and Y-values can be bound. The format is: PointProperty=Field[{Format}] [,PointProperty= Field[{Format}]]. For example:"Tooltip=Price{C1},Href=WebSiteName". - A list of these data point properties is as follows: , , , , , and , which are the names of the custom properties. + A list of these data point properties is as follows: , , , , , and , which are the names of the custom properties. ]]> @@ -1765,7 +1765,7 @@ These data point properties include: ## Remarks The data points in a series can be bound to a data source at any time using the property. - To force the chart to bind to the data source, call the method. + To force the chart to bind to the data source, call the method. The following is a list of objects that you can use as the data source: @@ -1944,7 +1944,7 @@ These data point properties include: ## Remarks Set this property to `true` to enable state management for the control. - The view state that is saved is determined by either the or properties. + The view state that is saved is determined by either the or properties. > [!NOTE] > This property must be set prior to the Page_Load (the Page_Init or the constructor will work) or it will have no effect. @@ -2444,7 +2444,7 @@ These data point properties include: is set to . + This property has no effect if is set to . When you render a chart image using the image tag method, a chart image is generated and then saved to disk at the server, in a format that is determined by the property. @@ -2502,7 +2502,7 @@ These data point properties include: ## Remarks Use this property to add objects to and remove objects from the object of the . This collection property is available at run time only. - An image - that is, an object derived from type , such as , that is created dynamically - can be stored in this collection, and then assigned at a later time to any image-related property, such as . + An image - that is, an object derived from type , such as , that is created dynamically - can be stored in this collection, and then assigned at a later time to any image-related property, such as . When you assign a object to an image-related property in the class, use the name of the object for the `string` value of the image-related property. @@ -2822,7 +2822,7 @@ These data point properties include: ## Remarks Use this method if you want to load a template from a stream, such as a memory stream, file stream, and so forth. - Make sure to set the property to `true` before saving the template with the method. + Make sure to set the property to `true` before saving the template with the method. If a loaded template has two data series, the appearance properties of the series are applied sequentially to the chart. In other words, the first template series appearance properties are assigned to the first series of the chart, the second template series appearance properties are applied to the second series of the chart, then the first template series is used again for the third series of the chart, and so on. The same holds true for chart areas, and any other collections that have appearance properties. @@ -2859,9 +2859,9 @@ These data point properties include: ## Remarks The `name` parameter must use a full path, for example, C:\MyPic.jpg. Note that you must also specify the file extension. - This method loads a template from disk that was saved using the method. + This method loads a template from disk that was saved using the method. - Make sure to set the property to `true` before saving the template with the method. + Make sure to set the property to `true` before saving the template with the method. If a loaded template has two data series, the appearance properties of the series are applied sequentially to the chart. In other words, the first template series appearance properties are assigned to the first series of the chart, the second template series appearance properties are applied to the second series of the chart, then the first template series is used again for the third series of the chart, and so on. The same holds true for chart areas, and any other collections that have appearance properties. @@ -3427,7 +3427,7 @@ These data point properties include: ; these properties are calculated prior to the chart being rendered. "Auto" is usually represented as a value. + Several chart properties can be set to "Auto" - for example, ; these properties are calculated prior to the chart being rendered. "Auto" is usually represented as a value. Call this method to reset these properties from their calculated value to "Auto" (). diff --git a/xml/System.Web.UI.DataVisualization.Charting/ChartArea.xml b/xml/System.Web.UI.DataVisualization.Charting/ChartArea.xml index 2d6fd8d5c28..fc7a9970486 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/ChartArea.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/ChartArea.xml @@ -41,7 +41,7 @@ When you use Shape chart types, which includes pie, doughnut, funnel, pyramid, polar, and radar charts, the inner plotting position defines the size of the chart type shape. For example, when you increase the value of the property on a pie chart, you will increase the radius of the pie shape. - For all other chart types, each chart area has two sets of X- and Y-axes, primary and secondary. To access properties related to these axes, use the , , and properties. If you need to set a property that affects all axes on the chart, use the property. + For all other chart types, each chart area has two sets of X- and Y-axes, primary and secondary. To access properties related to these axes, use the , , and properties. If you need to set a property that affects all axes on the chart, use the property. One or more series are associated with a chart area. The series has a property that determines the chart area that each series belongs to. By default, the series is connected to the default chart area. To disable the display of a series, set the property of that series to a zero-length string. @@ -49,7 +49,7 @@ A 3D chart is displayed on a chart area-by-chart area basis. You can use the property to enable and customize your chart in 3D. - The chart area minimum and maximum will not be automatically recalculated if you add new data, so the chart will not automatically change axis sizes. You can require the chart area to recalculate these values by using the method. + The chart area minimum and maximum will not be automatically recalculated if you add new data, so the chart will not automatically change axis sizes. You can require the chart area to recalculate these values by using the method. To align multiple chart areas vertically, set the property. To align multiple chart areas horizontally, you must first position the chart areas using the property, and then set the property to Horizontal. @@ -89,7 +89,7 @@ Use this constructor to create and initialize a new instance of the class. > [!NOTE] -> It is highly recommended that you use one of the `Add` or `Insert` methods of the collection property to add a chart area at run time. +> It is highly recommended that you use one of the `Add` or `Insert` methods of the collection property to add a chart area at run time. ]]> @@ -164,11 +164,11 @@ , and properties, it is possible to align or synchronize two or more chart areas horizontally, vertically or both. + Through the use of the , and properties, it is possible to align or synchronize two or more chart areas horizontally, vertically or both. - First, set the property to the name of a object. This chart area will then be aligned, based on the setting, which defines the alignment to use, and the setting, which defines the elements of the chart area that should be used to set the alignment. + First, set the property to the name of a object. This chart area will then be aligned, based on the setting, which defines the alignment to use, and the setting, which defines the elements of the chart area that should be used to set the alignment. - If the property is not set, the chart area will not be aligned, regardless of the and settings. + If the property is not set, the chart area will not be aligned, regardless of the and settings. ]]> @@ -229,10 +229,10 @@ |All|Chart areas are aligned using all values.| |AxesView|Chart areas are aligned using the view of the specified .| |None|Chart areas are not automatically aligned.| -|Position|Chart areas are aligned with the of the chart area specified.| -|InnerPlotPosition|Chart areas are aligned with the of the chart area specified.| +|Position|Chart areas are aligned with the of the chart area specified.| +|InnerPlotPosition|Chart areas are aligned with the of the chart area specified.| - If the value is not set, the property will have no effect. + If the value is not set, the property will have no effect. ]]> @@ -282,11 +282,11 @@ , and properties, it is possible to align or synchronize two or more chart areas horizontally, vertically or both. + Through the use of the , and properties, it is possible to align or synchronize two or more chart areas horizontally, vertically or both. - First, set the property to the name of a object. This chart area will then be aligned, based on the setting, which defines the alignment to use, and the setting, which defines the elements of the chart area that should be used to set the alignment. + First, set the property to the name of a object. This chart area will then be aligned, based on the setting, which defines the alignment to use, and the setting, which defines the elements of the chart area that should be used to set the alignment. - If the property is not set, the chart area will not be aligned, regardless of the and settings. + If the property is not set, the chart area will not be aligned, regardless of the and settings. ]]> @@ -398,7 +398,7 @@ ## Remarks The main purpose of this property is to provide access to the properties of the X, Y, X2 and Y2 axes at design time. - At run time, the axes for a chart area should be accessed using the individual axis properties, such as , , and so forth. + At run time, the axes for a chart area should be accessed using the individual axis properties, such as , , and so forth. If you decide to use this property at run time - for example, in an event - you can access an item in this array by specifying an enumeration member as the identifier. @@ -664,7 +664,7 @@ ## Remarks You can set this property to any valid ARGB (alpha, red, green, blue) value. - The value will be the first color used if you have specified gradient colors for the background. + The value will be the first color used if you have specified gradient colors for the background. The alpha value controls the opacity of a color. If you set this color to "transparent" - that is, if you use an alpha value of 0 - no color will be assigned to the background of the chart area. As a result, the background will be transparent. @@ -857,7 +857,7 @@ ## Remarks This property defines a path to a background image for a , and can be an absolute or relative URL. - To position the image, use the and properties. + To position the image, use the and properties. You can also specify one of the colors displayed by the image as "transparent", by setting the property. @@ -1090,7 +1090,7 @@ ## Remarks This property is one of several related properties that determine the secondary background color of objects, and is used when gradient colors are being applied. - You can set to any valid ARGB (alpha, red, green, blue) value. + You can set to any valid ARGB (alpha, red, green, blue) value. If hatching is used, the property determines the color of the hatching lines for the chart area. @@ -1333,9 +1333,9 @@ The depth of a series can be used to determine a Z value for a point that is used in a custom drawing routine. > [!NOTE] -> Any points used in custom 3D drawing must be transformed from relative 3D coordinates to relative 2D coordinates using the method. +> Any points used in custom 3D drawing must be transformed from relative 3D coordinates to relative 2D coordinates using the method. - To get relative X and Y-values from an axis, use the method for both the X and Y axes. + To get relative X and Y-values from an axis, use the method for both the X and Y axes. ]]> @@ -1372,9 +1372,9 @@ The Z position of a series is normally used for a custom drawing routine. > [!NOTE] -> Any points used in custom 3D drawing must be transformed from relative 3D coordinates to relative 2D coordinates using the method. +> Any points used in custom 3D drawing must be transformed from relative 3D coordinates to relative 2D coordinates using the method. - To get relative X and Y-values from an axis, use the method for both the X and Y axes. + To get relative X and Y-values from an axis, use the method for both the X and Y axes. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/ChartArea3DStyle.xml b/xml/System.Web.UI.DataVisualization.Charting/ChartArea3DStyle.xml index f0a615dd35a..3c5f7d58fdf 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/ChartArea3DStyle.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/ChartArea3DStyle.xml @@ -23,7 +23,7 @@ To enable 3D for a chart area, set the property to `true`. This causes 3D to be applied to all data series drawn in a chart area. - An isometric projection of a chart area can be displayed by setting the property to `true`, which is the default. Isometric views are not actually 3D, because the displayed angles of rotation may not match the actual angles of rotation around the vertical and horizontal axes. The actual angles are controlled using the and properties, respectively. + An isometric projection of a chart area can be displayed by setting the property to `true`, which is the default. Isometric views are not actually 3D, because the displayed angles of rotation may not match the actual angles of rotation around the vertical and horizontal axes. The actual angles are controlled using the and properties, respectively. For more information about isometric projections, see the Remarks section of the property. @@ -37,9 +37,9 @@ - Set the amount of perspective with the property. -- Control the depth of data points and the distance between data rows using the and properties, respectively. +- Control the depth of data points and the distance between data rows using the and properties, respectively. -- Rotate a chart area using the and properties. +- Rotate a chart area using the and properties. To work with coordinates of 3D points, use the class. @@ -265,7 +265,7 @@ and properties, respectively. + Isometric views are not actually 3D, because the displayed angles of rotation may not match the actual angles of rotation around the vertical and horizontal axes. The actual angles are controlled using the and properties, respectively. Note the following points concerning isometric projection: diff --git a/xml/System.Web.UI.DataVisualization.Charting/ChartColorPalette.xml b/xml/System.Web.UI.DataVisualization.Charting/ChartColorPalette.xml index a8973f3639b..9affbeecb91 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/ChartColorPalette.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/ChartColorPalette.xml @@ -22,9 +22,9 @@ If no colors are assigned to data points and their associated series, the default colors will be assigned to the data. For example: -- If is set to None, then the default palette is set to or BrightPastel. +- If is set to None, then the default palette is set to or BrightPastel. -- If. is set to None, then the default palette for the chart is used (). +- If. is set to None, then the default palette for the chart is used (). ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/ChartElementCollection`1.xml b/xml/System.Web.UI.DataVisualization.Charting/ChartElementCollection`1.xml index 2810274feb4..2911974d238 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/ChartElementCollection`1.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/ChartElementCollection`1.xml @@ -202,11 +202,11 @@ Resumes the invalidation of a chart element in the collection. - method several times, you will need to call the method an equal number of times. - + method several times, you will need to call the method an equal number of times. + ]]> @@ -256,13 +256,13 @@ Suspends the invalidation of a chart element in the collection. - method will have no effect after the method is called. - - If you call the method several times, you will need to call the method an equal number of times. - + method will have no effect after the method is called. + + If you call the method several times, you will need to call the method an equal number of times. + ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/ChartSerializer.xml b/xml/System.Web.UI.DataVisualization.Charting/ChartSerializer.xml index 98985fe8391..30e201339f7 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/ChartSerializer.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/ChartSerializer.xml @@ -44,11 +44,11 @@ > [!IMPORTANT] > The property is implemented internally by the control as the property -- Serialization of chart properties specified by the property. This is a comma-separated listing of all chart properties that are serializable. After this property is set to an explicit value, it is the responsibility of the developer to specify all properties to be saved. In other words, unlike the property, the names of chart areas and series will not be automatically persisted. The and properties can also be used in conjunction. However, make sure that is concatenated with itself when being set, otherwise the chart properties specified by the property will be overridden. +- Serialization of chart properties specified by the property. This is a comma-separated listing of all chart properties that are serializable. After this property is set to an explicit value, it is the responsibility of the developer to specify all properties to be saved. In other words, unlike the property, the names of chart areas and series will not be automatically persisted. The and properties can also be used in conjunction. However, make sure that is concatenated with itself when being set, otherwise the chart properties specified by the property will be overridden. To prohibit certain properties from being serialized, use the property. When one property is set as serializable and non-serializable, which is common when wildcards are used, the property has precedence. However, precedence also depends on how many wildcards were used when a property was specified. - By default, serializable properties are reset to their defaults before they are loaded. This behavior can be changed using the property. The method can also be used to explicitly reset chart properties to their default values. + By default, serializable properties are reset to their defaults before they are loaded. This behavior can be changed using the property. The method can also be used to explicitly reset chart properties to their default values. ]]> @@ -86,10 +86,10 @@ property. Note that the and properties can also be used along with the property. + By default, all chart properties will be serialized when any of the `Save` and `Load` methods are called. To provide more control over what is serialized, use the property. Note that the and properties can also be used along with the property. > [!IMPORTANT] - > The property determines types of chart characteristics, such as "appearance", to be serialized, and is actually implemented internally as the property. This means that setting the property and then setting the property will result in the property value being overridden, unless is concatenated. See the sample code below for an example of this procedure. + > The property determines types of chart characteristics, such as "appearance", to be serialized, and is actually implemented internally as the property. This means that setting the property and then setting the property will result in the property value being overridden, unless is concatenated. See the sample code below for an example of this procedure. If you set the property, all and objects names will automatically be serialized; this means that serialized data that pertains to chart areas and series will be applied to existing objects when loaded. @@ -289,7 +289,7 @@ When a load operation occurs, serializable properties are, by default, first reset to their default values before they are set to the persisted values, if saved. To change this behavior, use the property. - By default, all serialized chart properties will be loaded. To load specific serialized properties, set the , or properties before loading the data. + By default, all serialized chart properties will be loaded. To load specific serialized properties, set the , or properties before loading the data. Note that when data is saved using a `Save` method, only those properties that have non-default values are actually serialized. @@ -326,7 +326,7 @@ When a load operation occurs, by default the serializable properties are first reset to their default values before they are set to the persisted values, if saved. To change this behavior, use the property. - By default, all serialized chart properties will be loaded. By setting the , or properties, a specific set of properties can be loaded. + By default, all serialized chart properties will be loaded. By setting the , or properties, a specific set of properties can be loaded. If you use this definition, note that the format, which is set by the property, must be XML. @@ -365,7 +365,7 @@ When a load operation occurs, serializable properties are, by default, first reset to their default values before they are set to the persisted values, if saved. To change this behavior, use the property. - By default, all serialized chart properties will be loaded. To load specific serialized properties, set the , or properties before loading the data. + By default, all serialized chart properties will be loaded. To load specific serialized properties, set the , or properties before loading the data. Note that when data is saved using a `Save` method, only those properties that have non-default values are actually serialized. @@ -402,11 +402,11 @@ When a load operation occurs, by default serializable properties are first reset to their default values before they are set to the persisted values, if saved. To change this behavior, use the property. - By default, all serialized chart properties will be loaded. If you set the , or properties, a specific set of properties can be loaded. + By default, all serialized chart properties will be loaded. If you set the , or properties, a specific set of properties can be loaded. When you use this definition, the format must be XML; it can be changed with the property. - When you work with XML format text files, for simplicity use the method instead. + When you work with XML format text files, for simplicity use the method instead. ]]> @@ -440,13 +440,13 @@ property to limit chart characteristics to be serialized, along with the and properties. + By default all chart properties will be serialized when the `Save` and `Load` methods are called. You can use the property to limit chart characteristics to be serialized, along with the and properties. This property determines which chart characteristics will not be serialized. Wildcards can be used in the string expression, in the same manner as the property. For example, to exclude all chart `BackColor` properties from serialization, set this property to "*.BackColor". - Sometimes, a property can be set to be both serialized and not serialized, which is common when wildcards are used. The expression has a lower priority when compared to the expression. However, note that less weight is given to string expressions that use wildcards. For example, if the property is set to "*.BackColor" and the property is set to , all B`ackColor` properties except for objects will be serialized. + Sometimes, a property can be set to be both serialized and not serialized, which is common when wildcards are used. The expression has a lower priority when compared to the expression. However, note that less weight is given to string expressions that use wildcards. For example, if the property is set to "*.BackColor" and the property is set to , all B`ackColor` properties except for objects will be serialized. - If the property has been set, the priority depends on how many wild cards are used in the expression. For example, setting the property to will result in the property containing a "\*.Back\*" expression. If the property is set to "\*.Back\*", all `Back*` chart properties such as `BackColor`, `BackGradient`, and so forth, will still be serialized. This is because the property value has higher priority when compared to the property. + If the property has been set, the priority depends on how many wild cards are used in the expression. For example, setting the property to will result in the property containing a "\*.Back\*" expression. If the property is set to "\*.Back\*", all `Back*` chart properties such as `BackColor`, `BackGradient`, and so forth, will still be serialized. This is because the property value has higher priority when compared to the property. This property affects all save, load and reset operations. @@ -478,7 +478,7 @@ ## Remarks By default, this method resets all chart properties to their default values. - To limit the chart properties that are reset to their defaults, use the , and properties. + To limit the chart properties that are reset to their defaults, use the , and properties. Note that this method is also called automatically when a `Load` method is used and the property is set to `true`. @@ -520,13 +520,13 @@ , and properties. + By default, all chart properties with non-default values, which includes data points, will be serialized when this method is called. To control chart characteristics to be serialized, use the , and properties. If this method is used to save appearance properties as a template, make sure that the property of the object is first set to `true` before calling this method. Serialization of a chart as a template occurs differently from non-template serialization; template serialization concentrates on Appearance properties. - When a template is serialized, the method can be used to load the template, to provide the Appearance properties for a chart. + When a template is serialized, the method can be used to load the template, to provide the Appearance properties for a chart. Templates can be used to simulate custom palettes. @@ -559,7 +559,7 @@ , and properties. + By default, all chart properties with non-default values, which includes data points, will be serialized when this method is called. To control which chart characteristics are serialized, use the , and properties. When you use this definition, the format must be XML; the format can be set with the property. @@ -594,7 +594,7 @@ , and properties. + By default all chart properties with non-default values, which includes data points, will be serialized when this method is called. To control chart characteristics to be serialized use the , and properties. By default data is saved in an XML format. To save the data in a binary format, use the property. @@ -604,7 +604,7 @@ Serialization of a chart as a template proceeds differently from non-template serialization, primarily because template serialization concentrates on Appearance properties. - When a template is serialized, the method can be used to load the template, to provide the Appearance properties for a chart. + When a template is serialized, the method can be used to load the template, to provide the Appearance properties for a chart. Templates can be used to simulate custom palettes. @@ -637,11 +637,11 @@ , and properties. + By default, all chart properties with non-default values, which includes data points, will be serialized when this method is called. To control which chart characteristics are serialized, use the , and properties. When you use this definition, the format must be XML; the format can be changed with the property. - When you work with XML format text files, for simplicity use the method instead. + When you work with XML format text files, for simplicity use the method instead. ]]> @@ -675,13 +675,13 @@ property to limit chart characteristics to be serialized, along with the and properties. + By default all chart properties will be serialized when the `Save` and `Load` methods are called. You can use the property to limit chart characteristics to be serialized, along with the and properties. The property determines which chart characteristics will be serialized. Wildcards can be used in the string expression, in the same manner as the property. For example, to serialize all chart `BackColor` properties, set this property to "*.BackColor". If and/or child properties are specified, then the names of all and objects must be also specified to enable the persisted data to be applied to existing and objects; that is, you must specify "Series.Name" and "ChartArea.Name" expressions. See the sample code below for an example of this procedure. Similarly, if multiple chart areas are being used, the property of all plotted must also be saved. - Sometimes, a property can be set to be both serialized and not serialized, which is common when wildcards are used. The expression has a lower priority when compared to the expression. However, note that less weight is given to string expressions that use wildcards. For example, if the property is set to "*.BackColor" and the property is set to , all B`ackColor` properties except for objects will be serialized. + Sometimes, a property can be set to be both serialized and not serialized, which is common when wildcards are used. The expression has a lower priority when compared to the expression. However, note that less weight is given to string expressions that use wildcards. For example, if the property is set to "*.BackColor" and the property is set to , all B`ackColor` properties except for objects will be serialized. If you set the property, the property will be set internally. If the property is already set but another property needs to be serialized, make sure to concatenate the property when specifying that extra property. See the sample code below for an example of this procedure. diff --git a/xml/System.Web.UI.DataVisualization.Charting/CustomLabel.xml b/xml/System.Web.UI.DataVisualization.Charting/CustomLabel.xml index 8d44347a5be..fc9d60add98 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/CustomLabel.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/CustomLabel.xml @@ -35,7 +35,7 @@ Only custom labels may be used for the second label row. - The and properties determine the axis range that the label applies to. + The and properties determine the axis range that the label applies to. A grid line and/or tick mark can be displayed for a custom axis label by using the property; this property specifies whether a custom grid line or tick mark will be drawn in the middle of the label range. @@ -310,9 +310,9 @@ ## Remarks The property determines the start position of the axis range the label is applied to. - The difference between the values of the and properties determines where the label text will be displayed. For example, suppose the X-axis has a scale that ranges from 1 to 5 (1, 2 ,3 , 4, 5). In order to display a custom label just underneath the second point, you would set the property to 1.5 and the property to 2.5. + The difference between the values of the and properties determines where the label text will be displayed. For example, suppose the X-axis has a scale that ranges from 1 to 5 (1, 2 ,3 , 4, 5). In order to display a custom label just underneath the second point, you would set the property to 1.5 and the property to 2.5. - If the - or , depending on the axis in question - is set to a value, then this property will be displayed as a value in the designer. + If the - or , depending on the axis in question - is set to a value, then this property will be displayed as a value in the designer. This property should not be set to the same value as the property. diff --git a/xml/System.Web.UI.DataVisualization.Charting/CustomLabelsCollection.xml b/xml/System.Web.UI.DataVisualization.Charting/CustomLabelsCollection.xml index 43d986cbaad..6337aceb510 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/CustomLabelsCollection.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/CustomLabelsCollection.xml @@ -22,12 +22,12 @@ class represents a collection of objects, which in turn represent the custom labels that an object can use. This class is exposed as the collection property of an object. + The class represents a collection of objects, which in turn represent the custom labels that an object can use. This class is exposed as the collection property of an object. > [!NOTE] -> You can automatically populate the entire label row of an axis with custom labels using any method definition that includes a `DateTimeIntervalType` argument. +> You can automatically populate the entire label row of an axis with custom labels using any method definition that includes a `DateTimeIntervalType` argument. - The property indicates the total number of items in the collection, and is commonly used to find the upper bound of the collection. + The property indicates the total number of items in the collection, and is commonly used to find the upper bound of the collection. ]]> @@ -75,12 +75,12 @@ method creates and initializes objects for the entire first label row of an axis with labels of the specified type. + The method creates and initializes objects for the entire first label row of an axis with labels of the specified type. The `labelsStep` parameter determines how often the custom labels will be drawn. > [!NOTE] -> The method must be called prior to calling this particular method definition. +> The method must be called prior to calling this particular method definition. ]]> @@ -121,7 +121,7 @@ If a custom label is used anywhere in the first label row, no labels are automatically generated for that first row. > [!NOTE] -> The method must be called prior to calling this particular method definition. +> The method must be called prior to calling this particular method definition. ]]> @@ -167,7 +167,7 @@ The step determines how often the custom labels will be drawn, and optional label formatting can be specified as well. > [!NOTE] -> The method must be called prior to calling this particular method definition. +> The method must be called prior to calling this particular method definition. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/CustomizeLegendEventArgs.xml b/xml/System.Web.UI.DataVisualization.Charting/CustomizeLegendEventArgs.xml index e875e3fa52b..e12bdebad06 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/CustomizeLegendEventArgs.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/CustomizeLegendEventArgs.xml @@ -113,7 +113,7 @@ The property allows you to delete or modify both default and custom legend items in the event, and to add custom legend items. The order of legend items can also be changed. > [!NOTE] -> The and properties can be used to determine the data element that is associated with a default legend item. These properties will return zero-length strings for custom legend items, because custom items are not associated with chart data. +> The and properties can be used to determine the data element that is associated with a default legend item. These properties will return zero-length strings for custom legend items, because custom items are not associated with chart data. This property enables you to determine which the event was raised for, which enables you to customize an individual . diff --git a/xml/System.Web.UI.DataVisualization.Charting/CustomizeMapAreasEventArgs.xml b/xml/System.Web.UI.DataVisualization.Charting/CustomizeMapAreasEventArgs.xml index 2dbe46a8363..9a01f9fa334 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/CustomizeMapAreasEventArgs.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/CustomizeMapAreasEventArgs.xml @@ -21,7 +21,7 @@ ## Remarks This class provides data for the event of the Chart control. - The only property of this class is the s property, which enables developers to: + The only property of this class is the s property, which enables developers to: - Delete or customize map areas that have been created for a chart object; any , , or object that has a non-empty `Url`, `MapAreaAttributes` or `ToolTip` property will have an associated map area object. diff --git a/xml/System.Web.UI.DataVisualization.Charting/DataManipulator.xml b/xml/System.Web.UI.DataVisualization.Charting/DataManipulator.xml index 81530d0a005..7b9bfcdc523 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/DataManipulator.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/DataManipulator.xml @@ -1493,11 +1493,11 @@ method of the interface, perform the comparison(s) and then return `true` or `false`. The sort order is determined by the return value. + This method performs a custom sort on the data points in one or more series; the sort logic is defined by the `comparer` parameter. Override and implement the method of the interface, perform the comparison(s) and then return `true` or `false`. The sort order is determined by the return value. Note that if multiple series are sorted, the series must be aligned, otherwise an exception will be thrown. - The two object parameters of the method must always be of type . + The two object parameters of the method must always be of type . > [!IMPORTANT] > All data points, regardless of the series they belong to, are sorted based on the first series; if the position of a data point in the first series changes, all corresponding points in the other series change as well. @@ -1533,11 +1533,11 @@ method of the interface, perform the comparison(s) and then return `true` or `false`. The sort order is determined by the return value. + This method performs a custom sort on the data points in a series; the sort logic is defined by the `comparer` parameter. Override and implement the method of the interface, perform the comparison(s) and then return `true` or `false`. The sort order is determined by the return value. - The two object parameters of the method must always be of type . + The two object parameters of the method must always be of type . - To perform a custom sort for more than one series per function call, use the method. + To perform a custom sort for more than one series per function call, use the method. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/DataPoint.xml b/xml/System.Web.UI.DataVisualization.Charting/DataPoint.xml index 486306d1eed..e163d40f59a 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/DataPoint.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/DataPoint.xml @@ -74,7 +74,7 @@ ## Remarks This constructor can be used to create and initialize a new instance of the class. - However, it is highly recommended that you instead add data points at run time, using the collection property. + However, it is highly recommended that you instead add data points at run time, using the collection property. ]]> @@ -104,7 +104,7 @@ ## Remarks This constructor can be used to create and initialize a new instance of the class. - However, it is highly recommended that you instead add data points at run time, using the collection property. + However, it is highly recommended that you instead add data points at run time, using the collection property. ]]> @@ -136,7 +136,7 @@ ## Remarks This constructor can be used to create and initialize a new instance of the class. - However, it is highly recommended that you instead add data points at run time, using the collection property. + However, it is highly recommended that you instead add data points at run time, using the collection property. ]]> @@ -168,7 +168,7 @@ ## Remarks This constructor can be used to create and initialize a new instance of the class. - However, it is highly recommended that you instead add data points at run time, using the collection property. + However, it is highly recommended that you instead add data points at run time, using the collection property. ]]> @@ -206,7 +206,7 @@ ## Remarks This constructor can be used to create and initialize a new instance of the class. - However, it is highly recommended that you instead add data points at run time, using the collection property. + However, it is highly recommended that you instead add data points at run time, using the collection property. ]]> @@ -235,7 +235,7 @@ method to obtain an exact copy of the data point. + Use the method to obtain an exact copy of the data point. ]]> @@ -386,7 +386,7 @@ method to set the value(s) of a data point at run-time. + Use the method to set the value(s) of a data point at run-time. Note that if you set the X-value to a value other than zero (0), a scatter plot will be generated. For further details, see the Remarks section of the property. diff --git a/xml/System.Web.UI.DataVisualization.Charting/DataPointCollection.xml b/xml/System.Web.UI.DataVisualization.Charting/DataPointCollection.xml index af74d88b4da..9d8608432a6 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/DataPointCollection.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/DataPointCollection.xml @@ -32,13 +32,13 @@ This collection class is implemented as the property of a object. - objects can be appended or inserted into the collection with their X-value and Y-value(s) already specified as parameters. Note that they are also added automatically when a series is bound to a data source using either the or method. + objects can be appended or inserted into the collection with their X-value and Y-value(s) already specified as parameters. Note that they are also added automatically when a series is bound to a data source using either the or method. Data points are plotted in the order that they occur in this collection only if the series that the collection belongs to has its property set to `true` (the default value is `false`), or if all X-values for all data points are zero. Otherwise data points are plotted using their X-values. Data points can be located, and manipulated, based on maximum, minimum or specified X or Y-values using the overloaded `FindMaxValue`, `FindMinValue` or `FindValue` methods, respectively. - The [DataPointCollection.Count]() property indicates the total number of items in the collection and is commonly used to find the upper bound of the collection. + The [DataPointCollection.Count]() property indicates the total number of items in the collection and is commonly used to find the upper bound of the collection. ]]> @@ -115,9 +115,9 @@ ## Remarks This method adds object to the ; the object is always added to the end of the collection. - Use the method overload if your data points require more than one Y-value. + Use the method overload if your data points require more than one Y-value. - If your data points do not need an X-value - that is, if you are creating non-scatter plots - use the method instead. + If your data points do not need an X-value - that is, if you are creating non-scatter plots - use the method instead. ]]> @@ -164,7 +164,7 @@ In order for formatting to have an effect, a value must be a object. - If your data points do not need an X-value - that is, if you are creating non-scatter plots - use the method instead + If your data points do not need an X-value - that is, if you are creating non-scatter plots - use the method instead ]]> @@ -356,9 +356,9 @@ The following .NET types can be used for the object type parameters: ## Remarks This method binds all objects in a , and uses separate data sources for the X and Y-value(s). - Note that the first available column in the data source will be used if data-binding to a table. To bind to a column other than the first column, use the method. + Note that the first available column in the data source will be used if data-binding to a table. To bind to a column other than the first column, use the method. - You can bind to multiple Y-values by providing a comma-separated list of objects for the `yValues` parameter. + You can bind to multiple Y-values by providing a comma-separated list of objects for the `yValues` parameter. If Y-values are not provided by the data source, or if the wrong number of values are provided, an exception will be thrown. @@ -374,7 +374,7 @@ The following .NET types can be used for the object type parameters: - Lists -- All other objects that use the interface. +- All other objects that use the interface. ]]> @@ -429,7 +429,7 @@ The following .NET types can be used for the object type parameters: - Lists -- All other objects that use the interface. +- All other objects that use the interface. ]]> @@ -484,9 +484,9 @@ The following .NET types can be used for the object type parameters: ## Remarks This method binds the Y-value(s) of the data points in the collection to the first column of the specified data source(s). - To bind Y-values to a data source column that is not the first available column, use the method. + To bind Y-values to a data source column that is not the first available column, use the method. - You can bind several Y-values by specifying multiple data sources, using the `yValue` parameter. Note that the first available column in each data source will be used for each data point's successive Y-values. For example, the first column of the first data source will be bound to the first Y-value of data points, the first column of the second data source will be bound to the second Y-value of data points, and so forth. + You can bind several Y-values by specifying multiple data sources, using the `yValue` parameter. Note that the first available column in each data source will be used for each data point's successive Y-values. For example, the first column of the first data source will be bound to the first Y-value of data points, the first column of the second data source will be bound to the second Y-value of data points, and so forth. If Y-values are not provided by the data source, or if the wrong number of values are provided, an exception will be thrown. @@ -502,7 +502,7 @@ The following .NET types can be used for the object type parameters: - Lists -- All other objects that use the interface. +- All other objects that use the interface. ]]> @@ -543,7 +543,7 @@ The following .NET types can be used for the object type parameters: ## Remarks This method binds the Y-values of the data points in the collection to the specified fields(s) of the data source. - To bind only to the first field in a data source, use the method. + To bind only to the first field in a data source, use the method. You can bind to several fields by setting the `yFields` parameter to multiple field names that are comma-separated. Note that the first field will be used for the data point's first Y-value, the second named field will be used for the data point's second Y-value, and so forth. @@ -559,7 +559,7 @@ The following .NET types can be used for the object type parameters: - Lists -- All other objects that use the interface. +- All other objects that use the interface. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/ElementPosition.xml b/xml/System.Web.UI.DataVisualization.Charting/ElementPosition.xml index 0bb767c36e5..1335f7d02ca 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/ElementPosition.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/ElementPosition.xml @@ -25,9 +25,9 @@ class is used to define the position of a chart element, and represents one rectangle using the , , and properties. + The class is used to define the position of a chart element, and represents one rectangle using the , , and properties. - The class is always exposed as a `Position` property, such as , , and so forth. It is also exposed in the and events of the control as a property of the object. + The class is always exposed as a `Position` property, such as , , and so forth. It is also exposed in the and events of the control as a property of the object. The position of the applicable chart elements can be set automatically by setting the property to `true`; chart elements can also be positioned at design time in the Design View. @@ -147,7 +147,7 @@ property to . + Use this property to automatically position a chart element. For example, to position the legend automatically, set the property to . ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/Grid.xml b/xml/System.Web.UI.DataVisualization.Charting/Grid.xml index 49df34f6627..592e56e93f8 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/Grid.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/Grid.xml @@ -25,11 +25,11 @@ and properties of each object. + This class provides the functionality for the grids on the chart, and is exposed using the and properties of each object. - Major grid lines by default do not have their , , , and properties set. When these properties for major grid lines are not set, the control determines the appropriate values for grid lines automatically. + Major grid lines by default do not have their , , , and properties set. When these properties for major grid lines are not set, the control determines the appropriate values for grid lines automatically. - The axis and its minor grid lines by default have their , , , and properties set to **Auto** (0). If axis labels or minor grid lines are enabled and these properties are not modified, the control automatically determines how often to draw the minor grid lines. + The axis and its minor grid lines by default have their , , , and properties set to **Auto** (0). If axis labels or minor grid lines are enabled and these properties are not modified, the control automatically determines how often to draw the minor grid lines. Axis grids: @@ -159,7 +159,7 @@ The interval is measured in axis units, and determines how often an applicable chart element is drawn. For example, suppose a column chart has an X axis step of 1 (that is, 1, 2, 3, 4, and so forth); if you set the property for the X axis to 2, an axis label will be displayed for every other column. - The same holds true for all applicable chart elements. In other words, if in the previous example strip lines were being used, with an of 0.5, and their property was 2, a strip line would be displayed at 0.5, 2.5, 4.5, and so on. + The same holds true for all applicable chart elements. In other words, if in the previous example strip lines were being used, with an of 0.5, and their property was 2, a strip line would be displayed at 0.5, 2.5, 4.5, and so on. If you set a chart element `Interval` property to zero, an interval will be automatically determined by the control. @@ -213,7 +213,7 @@ The property setting defines the units of measurement of the offset. - The can be a negative value. + The can be a negative value. ]]> @@ -315,7 +315,7 @@ Interval types can be set to ; the type of interval then depends on either the X-values or Y-values of the plotted objects, depending on which axis the applicable elements belong to. - Setting the property for a value axis will only have an effect if the values of the data points are or `double` values. Also, the or property of the plotted must be set to or . + Setting the property for a value axis will only have an effect if the values of the data points are or `double` values. Also, the or property of the plotted must be set to or . Setting the property for a categorical axis will only have an effect if the property (or property, depending on the axis in question) of the plotted object is either or . diff --git a/xml/System.Web.UI.DataVisualization.Charting/HitTestResult.xml b/xml/System.Web.UI.DataVisualization.Charting/HitTestResult.xml index 5e7f90e59b7..4c9487ddda8 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/HitTestResult.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/HitTestResult.xml @@ -19,7 +19,7 @@ class represents the results of a hit test, and is exposed as the return object from a method call. + The class represents the results of a hit test, and is exposed as the return object from a method call. A hit test checks a specified point in the chart to determine if a chart element is located at that point. If a chart element is detected, the class is used to obtain information about that chart element. @@ -27,7 +27,7 @@ If a data point is located, you can use the property to get the index of that data point; that is, the zero-based index of the point in the . Use the property to get the associated object for that data point. - The and properties are used to get the associated chart area and axis of the chart element - if any - returned by the hit test. Note that these properties may be `null` if the returned chart element does not have an associated chart area or axis. + The and properties are used to get the associated chart area and axis of the chart element - if any - returned by the hit test. Note that these properties may be `null` if the returned chart element does not have an associated chart area or axis. Use the property to determine the type of the chart element returned by a hit test. @@ -86,7 +86,7 @@ ## Remarks If the chart object returned by the hit test is an object that is associated with an axis - for example, a scrollbar element, tick mark, grid line or strip line - the property will reference the object with which the returned chart object is associated. Otherwise this property will be `null`. - Note that the method can be called explicitly, in which case a chart element may or may not be at the specified location. + Note that the method can be called explicitly, in which case a chart element may or may not be at the specified location. ]]> @@ -128,7 +128,7 @@ If no chart element is returned by the hit test, the value of this property will be `null`. - **Note** The method can be called explicitly, in which case a chart element may or may not be at the specified location. + **Note** The method can be called explicitly, in which case a chart element may or may not be at the specified location. ]]> @@ -207,7 +207,7 @@ If a chart element is located at the point that is checked by the hit test, this property will reference that chart element, otherwise the value of this property will be `null`. > [!NOTE] -> If a data point is returned by the hit test, this property will still return a `null`. To obtain information about the data point, use the and properties instead. +> If a data point is returned by the hit test, this property will still return a `null`. To obtain information about the data point, use the and properties instead. ]]> @@ -247,7 +247,7 @@ ## Remarks If a data point is at the location that is checked by a hit test, the property will return the zero-based index of that data point, otherwise it will return a negative one (-1). - All data points are stored in a , which is exposed as the collection property of a object; the index of the is zero-based. + All data points are stored in a , which is exposed as the collection property of a object; the index of the is zero-based. Use the property to determine the series to which the data point belongs. diff --git a/xml/System.Web.UI.DataVisualization.Charting/IDataPointFilter.xml b/xml/System.Web.UI.DataVisualization.Charting/IDataPointFilter.xml index a0bace94f6f..4c721b7397d 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/IDataPointFilter.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/IDataPointFilter.xml @@ -16,17 +16,17 @@ interface exposes the method, which takes a specific data point within a series and returns a `Boolean` value that determines whether that data point will be filtered. + The interface exposes the method, which takes a specific data point within a series and returns a `Boolean` value that determines whether that data point will be filtered. To perform custom filtering: - Derive a new or existing class from this interface. -- Override the method to provide the custom filtering logic. +- Override the method to provide the custom filtering logic. - To initiate the filtering operation, call one of the `Filter` methods in the class that takes an object as its first parameter. - For sample source code, see the method. + For sample source code, see the method. ]]> @@ -69,7 +69,7 @@ Filtered points, by default, are removed from a series. They can also be displayed as empty points by setting the value of the property to `true`. - Filtered points can also be marked as filtered if they do not match filtering criteria, as determined by the value. + Filtered points can also be marked as filtered if they do not match filtering criteria, as determined by the value. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/Legend.xml b/xml/System.Web.UI.DataVisualization.Charting/Legend.xml index 53126d0b142..a6e462b60f2 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/Legend.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/Legend.xml @@ -25,7 +25,7 @@ class encapsulates all the functionality of the control's legend, and is exposed using the collection property of the root object. + The class encapsulates all the functionality of the control's legend, and is exposed using the collection property of the root object. There can be any number of legends for a chart image. @@ -53,21 +53,21 @@ Legend series symbols are rectangles, dots or lines. The symbol type is set automatically by the chart and depends on the plotted chart type. - Legend text by default is automatically sized. You can disable automatic sizing of legend text by disabling the property. When this property is set to `false`, the size of the legend text is determined by the Size property of the legend . If the property is enabled, the property determines the minimum font size that a legend item can have when resizing. + Legend text by default is automatically sized. You can disable automatic sizing of legend text by disabling the property. When this property is set to `false`, the size of the legend text is determined by the Size property of the legend . If the property is enabled, the property determines the minimum font size that a legend item can have when resizing. - The property defines a limit on the number of characters that can be shown on one line before text is wrapped to another line. If you do not wish to wrap text in the legend, set the value of the property to zero. By default, when the entire legend text does not fit in the legend, the text will be truncated. You can set the on the legend to get the text to wrap instead of being truncated. + The property defines a limit on the number of characters that can be shown on one line before text is wrapped to another line. If you do not wish to wrap text in the legend, set the value of the property to zero. By default, when the entire legend text does not fit in the legend, the text will be truncated. You can set the on the legend to get the text to wrap instead of being truncated. If the contents of the legend cannot fit into the given space, legend entries are truncated. An ellipsis is shown to indicate that there are more entries than the legend has space for. To prevent the legend items from being truncated, set the position and size of the legend using the property. When setting the legend position or size, the chart can no longer automatically position the elements in the chart. In some cases, you many need to manually position other chart elements to achieve the desired appearance. Another option would be to define your own cell columns instead of using the default legend settings. - The object has a CellColumn Collection; each CellColumn object represents a column in the Legend. A cell column has and properties that can be used to adjust the size of the columns. + The object has a CellColumn Collection; each CellColumn object represents a column in the Legend. A cell column has and properties that can be used to adjust the size of the columns. - When the legend contains many entries, can be used to improve readability. When this property is set to True, it will display a back color that you can set using the property. + When the legend contains many entries, can be used to improve readability. When this property is set to True, it will display a back color that you can set using the property. - By default, the legend is positioned in the top-right corner of the chart. This position can be modified by using the and properties of the legend. The legend can also be associated with a chart area by use of the property. This property specifies the name of the chart area for which the legend should be docked. In addition, the property can be used to display the legend inside a chart area. + By default, the legend is positioned in the top-right corner of the chart. This position can be modified by using the and properties of the legend. The legend can also be associated with a chart area by use of the property. This property specifies the name of the chart area for which the legend should be docked. In addition, the property can be used to display the legend inside a chart area. - When is set to False, the property defines the maximum size, in percent, of the legend within the available chart when the legend is automatically positioned. This property should be set if you wish to adjust the width or height of the legend after the docking properties have been set. + When is set to False, the property defines the maximum size, in percent, of the legend within the available chart when the legend is automatically positioned. This property should be set if you wish to adjust the width or height of the legend after the docking properties have been set. The legend can be modified using the event. @@ -172,7 +172,7 @@ always centers the legend, either vertically or horizontally. - Setting the property will have no effect if the property is not set to . + Setting the property will have no effect if the property is not set to . ]]> @@ -267,7 +267,7 @@ ## Remarks You can set this property to any valid ARGB (alpha, red, green, blue) value. - The value will be the first color used if you have specified gradient colors for the background. + The value will be the first color used if you have specified gradient colors for the background. The alpha value controls the opacity of a color. If you set this color to "transparent" - that is, if you use an alpha value of 0 - no color will be assigned to the background of the legend. As a result, the background will be transparent. @@ -459,7 +459,7 @@ ## Remarks This property defines a path to a background image for a legend, and can be an absolute or relative URL. - To position the image, use the and properties. + To position the image, use the and properties. You can also specify one of the colors displayed by the image as "transparent", by setting the property. @@ -690,7 +690,7 @@ ## Remarks The property determines the secondary background color of many objects, and is used when gradient colors are being applied. - You can set to any valid ARGB (alpha, red, green, blue) value. + You can set to any valid ARGB (alpha, red, green, blue) value. If hatching is used, the property determines the color of the hatching lines for the legend. @@ -1085,7 +1085,7 @@ ## Remarks The can be docked to the top, left, bottom or right of either the entire chart image, or the inside or outside of a chart area. If the property is set to `false`, docking applies to the entire chart image. If the property is set to `true`, docking applies to the object specified by the property - This property has no effect if the property is not set to . + This property has no effect if the property is not set to . ]]> @@ -1522,7 +1522,7 @@ This property will only have an effect if the property is set to the name of a object. > [!NOTE] -> If the property is set to any value other than , the property also has no effect. This is because the position of the legend is determined by the property setting. +> If the property is set to any value other than , the property also has no effect. This is because the position of the legend is determined by the property setting. ]]> @@ -1941,9 +1941,9 @@ property is automatic (that is, Legend.Position.Auto = `true`) the legend position is calculated automatically by the control, taking into account the , and property settings. + If the property is automatic (that is, Legend.Position.Auto = `true`) the legend position is calculated automatically by the control, taking into account the , and property settings. - If it is not automatic, the , and properties are ignored, and the legend position is solely determined by the value of the returned object. + If it is not automatic, the , and properties are ignored, and the legend position is solely determined by the value of the returned object. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/LegendCell.xml b/xml/System.Web.UI.DataVisualization.Charting/LegendCell.xml index 7e46e114daf..5d83277754d 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/LegendCell.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/LegendCell.xml @@ -292,7 +292,7 @@ - Text: A string is specified using the property, and will be displayed in the legend cell. -- SeriesSymbol: A series symbol is defined by the property in the class. It will be displayed for the legend cell. Recall that a series symbol is a visual indicator - a line, rectangle or marker. When is set to , all marker attributes of the custom item apply to the cell. +- SeriesSymbol: A series symbol is defined by the property in the class. It will be displayed for the legend cell. Recall that a series symbol is a visual indicator - a line, rectangle or marker. When is set to , all marker attributes of the custom item apply to the cell. - Image: An image is defined using the property and will be displayed in the legend cell. diff --git a/xml/System.Web.UI.DataVisualization.Charting/LegendCellColumn.xml b/xml/System.Web.UI.DataVisualization.Charting/LegendCellColumn.xml index 7e59b7eb271..fd134aebcab 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/LegendCellColumn.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/LegendCellColumn.xml @@ -243,7 +243,7 @@ ## Remarks This property determines the type of content that will be displayed in each individual legend cell column. There are two possible values: -- Text: By default, the #LEGENDTEXT keyword is used to place the value in each cell column. However, you can use the property to set any keyword(s) that will be replaced by a value of the corresponding series. +- Text: By default, the #LEGENDTEXT keyword is used to place the value in each cell column. However, you can use the property to set any keyword(s) that will be replaced by a value of the corresponding series. - SeriesSymbol: The legend cell will contain a series symbol, such as a rectangle, line, line with marker, or marker, of the same fill color as its corresponding series. diff --git a/xml/System.Web.UI.DataVisualization.Charting/LegendCollection.xml b/xml/System.Web.UI.DataVisualization.Charting/LegendCollection.xml index 1354c5321e9..668e623c5d1 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/LegendCollection.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/LegendCollection.xml @@ -19,13 +19,13 @@ Represents a collection of objects. - class is implemented as the collection property of the root object. - - objects can be appended, inserted or removed from the collection at either design time or run time. - + class is implemented as the collection property of the root object. + + objects can be appended, inserted or removed from the collection at either design time or run time. + ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/LegendItem.xml b/xml/System.Web.UI.DataVisualization.Charting/LegendItem.xml index 085185e5e5c..c3361e95f43 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/LegendItem.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/LegendItem.xml @@ -72,7 +72,7 @@ ## Remarks Use this constructor to create and initialize a new instance of the class. - Note that you can also add custom legend items using the `Add` and `Insert` methods associated with the collection property of the object. + Note that you can also add custom legend items using the `Add` and `Insert` methods associated with the collection property of the object. ]]> @@ -359,7 +359,7 @@ This property is only implemented if the property is set to . - You can set to any valid ARGB (alpha, red, green, blue) value. + You can set to any valid ARGB (alpha, red, green, blue) value. If hatching is used, the property determines the color of the hatching lines for the legend item. diff --git a/xml/System.Web.UI.DataVisualization.Charting/LegendItemsCollection.xml b/xml/System.Web.UI.DataVisualization.Charting/LegendItemsCollection.xml index f014f0fc867..32e8b3b1496 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/LegendItemsCollection.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/LegendItemsCollection.xml @@ -26,7 +26,7 @@ This collection class is exposed in two ways: -- As the object property of the object, which can be used to add, delete or modify custom legend items. The term "custom" refers to legend items that have user-defined text, symbol color, and so forth. In comparison, "default" legend items are items that are automatically inserted into the legend and represent a data series or data point. Default legend item entries for pie and doughnut charts represent the plotted data points, whereas item entries for all other chart types represent the plotted series. The property is available at both design time and run time. +- As the object property of the object, which can be used to add, delete or modify custom legend items. The term "custom" refers to legend items that have user-defined text, symbol color, and so forth. In comparison, "default" legend items are items that are automatically inserted into the legend and represent a data series or data point. Default legend item entries for pie and doughnut charts represent the plotted data points, whereas item entries for all other chart types represent the plotted series. The property is available at both design time and run time. - In the event, as the property of the parameter. The property stores both default legend items and custom legend items that have been added to the control at design time. Legend items can be modified or deleted; in addition, their order can be changed. @@ -75,7 +75,7 @@ ## Remarks Appends a custom legend item with the specified text and symbol color to the end of the collection. - To add a custom legend item that uses an image for its symbol, call the method. + To add a custom legend item that uses an image for its symbol, call the method. To insert a custom object into the collection, use one of the `Insert` methods in this class. @@ -113,7 +113,7 @@ ## Remarks Appends a custom legend item to the collection with the specified text and image to be used as the symbol for the legend item. - To add a custom legend item that uses a color for its symbol, call the method. + To add a custom legend item that uses a color for its symbol, call the method. To insert a object into the collection use one of the `Insert` methods in this class. @@ -161,9 +161,9 @@ ## Remarks Inserts a custom legend item into the collection at the specified location using the specified text and symbol color. - To insert a legend item that uses an image for its symbol, use the method. + To insert a legend item that uses an image for its symbol, use the method. - Use the method to append a object that uses a color for its symbol to the end if the collection. + Use the method to append a object that uses a color for its symbol to the end if the collection. ]]> @@ -200,9 +200,9 @@ ## Remarks Inserts a custom legend item into the collection at the specified location using the specified text and image for the symbol. - To insert a legend item that uses a color for its symbol, use the method. + To insert a legend item that uses a color for its symbol, use the method. - Use the method to append a object with a symbol image to the end if the collection. + Use the method to append a object with a symbol image to the end if the collection. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/LineAnchorCapStyle.xml b/xml/System.Web.UI.DataVisualization.Charting/LineAnchorCapStyle.xml index 7544ca7bdf1..708706946ca 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/LineAnchorCapStyle.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/LineAnchorCapStyle.xml @@ -15,11 +15,11 @@ Specifies the shape - that is, the anchor cap - to draw on the point end of the label callout line. - enumeration represents the shape to be drawn on the point end of the label callout line. It is used in conjunction with the and the properties. If a callout line is not used, this enumeration will have no effect. - + enumeration represents the shape to be drawn on the point end of the label callout line. It is used in conjunction with the and the properties. If a callout line is not used, this enumeration will have no effect. + ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/LineAnnotation.xml b/xml/System.Web.UI.DataVisualization.Charting/LineAnnotation.xml index 58d3b21bf0c..54260621ec8 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/LineAnnotation.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/LineAnnotation.xml @@ -102,7 +102,7 @@ , or the and properties. Its and properties must be set to . + The annotation must be anchored using either , or the and properties. Its and properties must be set to . ]]> @@ -500,7 +500,7 @@ property to `false`. Then anchor the annotation to a data point or set the or properties. + The width and height of an annotation may be set in relative chart or in axes coordinates. By default, relative chart coordinates are used. To use axes coordinates for the annotation size, set the property to `false`. Then anchor the annotation to a data point or set the or properties. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/MapArea.xml b/xml/System.Web.UI.DataVisualization.Charting/MapArea.xml index b5f9f72b9e5..ce75e7ae924 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/MapArea.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/MapArea.xml @@ -315,7 +315,7 @@ When setting coordinates, use the relative coordinate system of the chart, where the top-left corner of the chart image is "0,0" and the bottom-right corner of the image is "100,100". - After the shape and coordinates are defined for the map area, the , and/or properties can be used to specify a particular user interaction. + After the shape and coordinates are defined for the map area, the , and/or properties can be used to specify a particular user interaction. Note the following: @@ -576,7 +576,7 @@ When retrieving the shapes of objects that are stored in the , any shape that is not a rectangle or a circle will be considered a polygon. For example, a custom map area can be added to the map areas collection using a object as a parameter, which allows any type of shape to be used. If the property of this particular object is retrieved, it will return a . - After the shape and coordinates of a map area are defined, the , and/or properties can be used to specify a particular user interaction. + After the shape and coordinates of a map area are defined, the , and/or properties can be used to specify a particular user interaction. Note the following: diff --git a/xml/System.Web.UI.DataVisualization.Charting/NamedImage.xml b/xml/System.Web.UI.DataVisualization.Charting/NamedImage.xml index 9840696f5fe..164f464f0f1 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/NamedImage.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/NamedImage.xml @@ -29,7 +29,7 @@ The property determines the unique name of a object. The property determines its associated image, which can be any object derived from the .NET Framework class. - When one of the image properties of the control is set by specifying a `string` value, the collection property is first checked to determine whether an image with the specified name exists. If a matching object is found, this image is used. If a matching object is not located, the `string` value is treated as a URL, image resource name, or an image path. + When one of the image properties of the control is set by specifying a `string` value, the collection property is first checked to determine whether an image with the specified name exists. If a matching object is found, this image is used. If a matching object is not located, the `string` value is treated as a URL, image resource name, or an image path. ]]> @@ -195,7 +195,7 @@ This property value is used when you set a chart image property to a object. - When one of the image properties of the control is set by specifying a `string` value, the collection property - of type - is first checked to determine whether an image with the specified name exists. If a matching object is found, this image is used. If a matching object is not located, the `string` value is treated as a URL, an image resource name, or an image path. + When one of the image properties of the control is set by specifying a `string` value, the collection property - of type - is first checked to determine whether an image with the specified name exists. If a matching object is found, this image is used. If a matching object is not located, the `string` value is treated as a URL, an image resource name, or an image path. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/NamedImagesCollection.xml b/xml/System.Web.UI.DataVisualization.Charting/NamedImagesCollection.xml index f408a884cf9..c4efb54b4e7 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/NamedImagesCollection.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/NamedImagesCollection.xml @@ -19,17 +19,17 @@ Represents a collection of objects. - class represents a collection of objects, which are objects that have an associated image and a name that is unique to the collection. - - This class is exposed as the collection property of the root object, and is only available at run time. - - An image can be any object derived from the .NET Framework class, such as , which is created dynamically. The image can be stored in this collection, and then assigned at a later time to any image property in the control, such as . - - When one of the image properties in the control is set by specifying a `string` value, the collection property, of type , is first checked to see if an image with that name exists. If a matching object is found, this image is used. If a matching object is not located, the string expression is treated as a URL, image resource name or pathname. - + class represents a collection of objects, which are objects that have an associated image and a name that is unique to the collection. + + This class is exposed as the collection property of the root object, and is only available at run time. + + An image can be any object derived from the .NET Framework class, such as , which is created dynamically. The image can be stored in this collection, and then assigned at a later time to any image property in the control, such as . + + When one of the image properties in the control is set by specifying a `string` value, the collection property, of type , is first checked to see if an image with that name exists. If a matching object is found, this image is used. If a matching object is not located, the string expression is treated as a URL, image resource name or pathname. + ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/Point3D.xml b/xml/System.Web.UI.DataVisualization.Charting/Point3D.xml index e0a5a94882c..c3a7606efa2 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/Point3D.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/Point3D.xml @@ -21,7 +21,7 @@ ## Remarks The class represents the coordinates of a 3D data point. - Any point used in custom 3D drawing - which is accomplished using GDI+ - must be transformed from relative X, Y and Z (3D) coordinates into relative X and Y (2D) coordinates using the method. By calling , the X and Y-values of the objects are changed so that they reflect the 3-dimensional space. The new X and Y points can then be used for GDI+ method calls - the Z value is then disregarded - after being changed to absolute pixel coordinates using the method. + Any point used in custom 3D drawing - which is accomplished using GDI+ - must be transformed from relative X, Y and Z (3D) coordinates into relative X and Y (2D) coordinates using the method. By calling , the X and Y-values of the objects are changed so that they reflect the 3-dimensional space. The new X and Y points can then be used for GDI+ method calls - the Z value is then disregarded - after being changed to absolute pixel coordinates using the method. Note that the Z coordinate may be less than zero (located behind a chart area) or greater than 100 (located in front of a chart area). @@ -118,9 +118,9 @@ method. This method takes an array of objects as its only parameter. By calling , the X and Y property values are changed to reflect the 3-dimensional space. + Any point used in custom 3D drawing - which is accomplished using GDI+ - must be transformed from X, Y and Z (3D) coordinates into X and Y (2D) coordinates using the method. This method takes an array of objects as its only parameter. By calling , the X and Y property values are changed to reflect the 3-dimensional space. - These new X and Y coordinates are then converted to absolute coordinates, by using a method such as the method. After converting the coordinates, the property of each Point3D object can be used for any GDI+ method that take a object as a parameter. + These new X and Y coordinates are then converted to absolute coordinates, by using a method such as the method. After converting the coordinates, the property of each Point3D object can be used for any GDI+ method that take a object as a parameter. ]]> @@ -158,11 +158,11 @@ method. This method takes an array of Point3D objects as its only parameter. By calling the method, the X and Y property values are changed to reflect the 3-dimensional space. + Any point used in custom 3D drawing - which is accomplished using GDI+ - must be transformed from X, Y and Z (3D) coordinates into X and Y (2D) coordinates using the method. This method takes an array of Point3D objects as its only parameter. By calling the method, the X and Y property values are changed to reflect the 3-dimensional space. - These new X and Y coordinates are then converted to absolute coordinates using the method. They are then used for GDI+ method calls. + These new X and Y coordinates are then converted to absolute coordinates using the method. They are then used for GDI+ method calls. - A relative X coordinate can be obtained from an axis value by calling the method. + A relative X coordinate can be obtained from an axis value by calling the method. ]]> @@ -200,11 +200,11 @@ method. This method takes an array of Point3D objects as its only parameter. By calling the method, the X and Y property values are changed to reflect the 3-dimensional space. + Any point used in custom 3D drawing - which is accomplished using GDI+ - must be transformed from X, Y and Z (3D) coordinates into X and Y (2D) coordinates using the method. This method takes an array of Point3D objects as its only parameter. By calling the method, the X and Y property values are changed to reflect the 3-dimensional space. - These new X and Y coordinates are then converted to absolute coordinates by using the method. They are then used for GDI+ method calls. + These new X and Y coordinates are then converted to absolute coordinates by using the method. They are then used for GDI+ method calls. - A relative Y coordinate can be obtained from an axis value using the method. + A relative Y coordinate can be obtained from an axis value using the method. ]]> @@ -254,11 +254,11 @@ **Note** This Z property may be less than zero (located behind a chart area) or greater than 100 (located in front of a chart area). - Any point used in custom 3D drawing - which is accomplished using GDI+ - must be transformed from X, Y and Z (3D) coordinates into X and Y (2D) coordinates using the method. This method takes an array of Point3D objects as its only parameter. By calling the method, the X and Y property values are changed to reflect the 3-dimensional space. + Any point used in custom 3D drawing - which is accomplished using GDI+ - must be transformed from X, Y and Z (3D) coordinates into X and Y (2D) coordinates using the method. This method takes an array of Point3D objects as its only parameter. By calling the method, the X and Y property values are changed to reflect the 3-dimensional space. - These new X and Y coordinates are then converted to absolute coordinates by using the method. They are then used for GDI+ method calls. + These new X and Y coordinates are then converted to absolute coordinates by using the method. They are then used for GDI+ method calls. - Relative Z coordinates can be obtained for series by using the and methods. + Relative Z coordinates can be obtained for series by using the and methods. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/PolygonAnnotation.xml b/xml/System.Web.UI.DataVisualization.Charting/PolygonAnnotation.xml index 8f5408b412f..09c376e2297 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/PolygonAnnotation.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/PolygonAnnotation.xml @@ -276,7 +276,7 @@ property, when the and properties are used. + This secondary color is used with a primary color, defined with the property, when the and properties are used. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/PolylineAnnotation.xml b/xml/System.Web.UI.DataVisualization.Charting/PolylineAnnotation.xml index 65f7fbb6c2e..47716976b0d 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/PolylineAnnotation.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/PolylineAnnotation.xml @@ -602,7 +602,7 @@ method is called. Set the property to `true` to switch from the default mode to free-draw mode, which allows the user to freely-draw while moving the mouse cursor. + Two different placement modes are supported when the method is called. Set the property to `true` to switch from the default mode to free-draw mode, which allows the user to freely-draw while moving the mouse cursor. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/RectangleAnnotation.xml b/xml/System.Web.UI.DataVisualization.Charting/RectangleAnnotation.xml index 3e52b1e2f03..a8f820b9c34 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/RectangleAnnotation.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/RectangleAnnotation.xml @@ -179,7 +179,7 @@ and a secondary color that is specified with the . + Two colors are used to draw the gradient, a primary color that is specified the and a secondary color that is specified with the . ]]> @@ -283,7 +283,7 @@ when the or property is used. + This color is used with when the or property is used. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/SerializationContents.xml b/xml/System.Web.UI.DataVisualization.Charting/SerializationContents.xml index 7a66de16177..106d87168c5 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/SerializationContents.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/SerializationContents.xml @@ -21,11 +21,11 @@ Specifies the type of chart content to be serialized. - enumeration represents the chart content type to be serialized. This enumeration is used with the and properties. - + enumeration represents the chart content type to be serialized. This enumeration is used with the and properties. + ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/Series.xml b/xml/System.Web.UI.DataVisualization.Charting/Series.xml index c16c2ea8b62..d5fc8117b2a 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/Series.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/Series.xml @@ -96,7 +96,7 @@ > [!NOTE] > This series is only capable of storing objects that have one Y-value. If a data point that has multiple Y-values is added to this series, an exception will be thrown. - To create a series at run time, use the method. + To create a series at run time, use the method. ]]> @@ -431,7 +431,7 @@ public void CreateSecondLegend() Certain properties are only applicable for specific chart types. For example, the property does not apply to line charts, but does apply to an area chart. - To display an image that indicates an empty point, use the and properties, and not the property. + To display an image that indicates an empty point, use the and properties, and not the property. The property determines the axis label for empty points. Note that for stacked chart types, the axis label is determined by the property of the first plotted series that has this property set. @@ -744,7 +744,7 @@ public void CreateSecondLegend() This property has precedence over the property of the root object, with respect to the display of data. - NOTE: If the `Palette` property for both the and objects is set to None, and no color is assigned to the relevant data series/data points, the default palette "BrightPastel" or is used. + NOTE: If the `Palette` property for both the and objects is set to None, and no color is assigned to the relevant data series/data points, the default palette "BrightPastel" or is used. ]]> @@ -798,7 +798,7 @@ public void CreateSecondLegend() collection property allows you to add and remove data points to a series. This property also provides methods and properties that can be used to manipulate this collection, such as finding data points, performing data-binding, and so forth. + The collection property allows you to add and remove data points to a series. This property also provides methods and properties that can be used to manipulate this collection, such as finding data points, performing data-binding, and so forth. ]]> @@ -1197,7 +1197,7 @@ public void SetSeriesShadowOffset () ## Remarks The property determines the type of data stored by the series. - Set this property to to allow the X-value to be entered as a value, and not as a . Date and time values are internally stored by .NET Framework as values. The same holds true for the and properties of objects. + Set this property to to allow the X-value to be entered as a value, and not as a . Date and time values are internally stored by .NET Framework as values. The same holds true for the and properties of objects. The `IntervalType` property found in axis label, tick mark, and grid classes determines the interval type. diff --git a/xml/System.Web.UI.DataVisualization.Charting/SeriesCollection.xml b/xml/System.Web.UI.DataVisualization.Charting/SeriesCollection.xml index 70f2800018c..600c36cd73d 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/SeriesCollection.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/SeriesCollection.xml @@ -19,15 +19,15 @@ Represents a collection of objects. - class represents a collection of objects, which in turn represent a grouping of related data points and attributes for the series. This collection class is implemented as the collection property of the root object. - - Series objects can be appended, inserted or removed from the collection at both design time and run time. - - When a series is added to the collection, it is automatically assigned to the object named "Default" or, if "Default" does not exist, to the first available chart area in the chart area collection. - + class represents a collection of objects, which in turn represent a grouping of related data points and attributes for the series. This collection class is implemented as the collection property of the root object. + + Series objects can be appended, inserted or removed from the collection at both design time and run time. + + When a series is added to the collection, it is automatically assigned to the object named "Default" or, if "Default" does not exist, to the first available chart area in the chart area collection. + ]]> @@ -55,15 +55,15 @@ Adds a object with the given name to the end of the collection. The new object appended to the collection. - objects to the class, the associated objects of the newly added object cannot have more than one Y-value per data point. - + objects to the class, the associated objects of the newly added object cannot have more than one Y-value per data point. + ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/SmartLabelStyle.xml b/xml/System.Web.UI.DataVisualization.Charting/SmartLabelStyle.xml index 25a8d3de66f..880696f2087 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/SmartLabelStyle.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/SmartLabelStyle.xml @@ -31,15 +31,15 @@ ## Remarks When smart labels are enabled, the chart repositions overlapping data point labels, based on a set of user-defined rules. - Callout lines will be drawn to link the label with its data point. The visual attributes of the callout line can be controlled. These visual attributes include color, line style, and line width. The and properties control the embellishments, such as arrowheads, that appear at the end of the callout line. + Callout lines will be drawn to link the label with its data point. The visual attributes of the callout line can be controlled. These visual attributes include color, line style, and line width. The and properties control the embellishments, such as arrowheads, that appear at the end of the callout line. - The property can be set to any object. If you set the color of the callout line, you will also automatically set the color of the and the embellishment defined by the . + The property can be set to any object. If you set the color of the callout line, you will also automatically set the color of the and the embellishment defined by the . - The property controls the pixel width of the callout line. Use of this property will also scale the embellishments of the and the . + The property controls the pixel width of the callout line. Use of this property will also scale the embellishments of the and the . - The movement of smart labels can be controlled through the use of several motion-related properties. These define the rules of movement for the direction, distance and whether the data point label is allowed to leave the plotting area. The default movement rules will normally resolve most issues. The defines a value that specifies the maximum distance in pixels from the data point that data point labels are allowed to be moved in case of overlapping. The property defines a value that specifies the minimum distance in pixels from the data point that data point labels will be moved in case of overlapping. When a data point label needs to be repositioned, the label will be moved by at least the number of pixels specified. + The movement of smart labels can be controlled through the use of several motion-related properties. These define the rules of movement for the direction, distance and whether the data point label is allowed to leave the plotting area. The default movement rules will normally resolve most issues. The defines a value that specifies the maximum distance in pixels from the data point that data point labels are allowed to be moved in case of overlapping. The property defines a value that specifies the minimum distance in pixels from the data point that data point labels will be moved in case of overlapping. When a data point label needs to be repositioned, the label will be moved by at least the number of pixels specified. - The property indicates whether the labels are hidden when overlapping issues cannot be resolved. If the property is `true`, and the data point cannot be drawn within the area specified by and in the directions allowed by , the data point label will not be drawn. + The property indicates whether the labels are hidden when overlapping issues cannot be resolved. If the property is `true`, and the data point cannot be drawn within the area specified by and in the directions allowed by , the data point label will not be drawn. The property defines the direction(s) in which the data point label can be moved. This property accepts one value or a bitwise-OR of multiple values. The default is the bitwise-OR of all values, to allow repositioning in all possible directions except to the center of the data point. @@ -521,7 +521,7 @@ private void SetSmartLabelsOptions() and , in the directions allowed by the , property, and this property is `true`, the data point label will not be drawn. + If the point cannot be drawn within the area specified by the properties and , in the directions allowed by the , property, and this property is `true`, the data point label will not be drawn. > [!NOTE] > Smart labels only work when the property is set to zero. diff --git a/xml/System.Web.UI.DataVisualization.Charting/StripLine.xml b/xml/System.Web.UI.DataVisualization.Charting/StripLine.xml index 24c55b0fd31..bb017f963e6 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/StripLine.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/StripLine.xml @@ -41,11 +41,11 @@ - Add a threshold line at a specific constant value. - A single object can either be drawn once, or repeatedly, for a given interval. This action is controlled by the property. When a value of -1 is assigned to the property, one strip line will be drawn. When a non-zero value is assigned to the property, a strip line will be drawn repeatedly at each given interval. The location where a strip line is drawn is also affected by the and properties of the strip line. + A single object can either be drawn once, or repeatedly, for a given interval. This action is controlled by the property. When a value of -1 is assigned to the property, one strip line will be drawn. When a non-zero value is assigned to the property, a strip line will be drawn repeatedly at each given interval. The location where a strip line is drawn is also affected by the and properties of the strip line. Strip lines are always associated with an object. They can be added at both design time and run time. - To add a horizontal or vertical line to display a threshold, set the property to a value of 0.0. This will result in a line being drawn. You can use the , and properties for the color, width and style of the line. No chart background properties (`Back*`) are used when the property is set to 0.0. + To add a horizontal or vertical line to display a threshold, set the property to a value of 0.0. This will result in a line being drawn. You can use the , and properties for the color, width and style of the line. No chart background properties (`Back*`) are used when the property is set to 0.0. Use the property of the strip line to associate text with a strip line. The placement and orientation of this text can be controlled by the property. @@ -326,7 +326,7 @@ public partial class StripLines : System.Web.UI.Page ## Remarks You can set this property to any valid ARGB (alpha, red, green, blue) value. - To set a gradient for the strip line, set the and properties. + To set a gradient for the strip line, set the and properties. If you set this color to "transparent" - in other words, set the alpha value to 0 - no color will be assigned to the background of the element. As a result, the background will be transparent. @@ -655,7 +655,7 @@ public partial class StripLines : System.Web.UI.Page and properties. This property is not applicable if the property is set to a value of 0.0. + The hatch pattern consists of a solid background color and lines drawn over the background. The two colors used in the hatch style are set by the and properties. This property is not applicable if the property is set to a value of 0.0. ]]> @@ -715,7 +715,7 @@ public partial class StripLines : System.Web.UI.Page ## Remarks The property defines a path to a background image for many chart elements, and is an absolute or relative URL. - To position this image, use the and properties. + To position this image, use the and properties. You can also specify that one color will be displayed by the image as "transparent" by setting the property. @@ -895,7 +895,7 @@ public partial class StripLines : System.Web.UI.Page If the property is set to , the location where the image is drawn will be determined by the property setting. - This property is not applicable if is set to a value of 0.0. + This property is not applicable if is set to a value of 0.0. ]]> @@ -1299,7 +1299,7 @@ public partial class StripLines : System.Web.UI.Page property to a value of zero (0.0), one strip line will be displayed, with a width specified by the property. When you set to a value of other than zero, multiple strip lines will be shown. The unit that is used for the property is defined by the property. + When you set the property to a value of zero (0.0), one strip line will be displayed, with a width specified by the property. When you set to a value of other than zero, multiple strip lines will be shown. The unit that is used for the property is defined by the property. @@ -1560,7 +1560,7 @@ public partial class StripLines : System.Web.UI.Page The property setting defines the units of measurement of the offset. - The can be a negative value. + The can be a negative value. The default value is `Auto` (`0`). @@ -2456,9 +2456,9 @@ public partial class StripLines : System.Web.UI.Page ## Remarks This property cannot be set to a value less than 0.0, otherwise an exception will be raised. - A setting of 0.0 will result in a line being drawn; this line will use the , and property settings for its color, width and style. None of the `Back*` properties in this class are utilized when the value of is 0.0. + A setting of 0.0 will result in a line being drawn; this line will use the , and property settings for its color, width and style. None of the `Back*` properties in this class are utilized when the value of is 0.0. - If you set the property to a value greater than 0.0, a strip will be created. The , and properties only apply to the border of the strip; all of the `Back*` properties are then used for the background properties of the strip. + If you set the property to a value greater than 0.0, a strip will be created. The , and properties only apply to the border of the strip; all of the `Back*` properties are then used for the background properties of the strip. If the value of the property is greater than 0.0, the units are determined by the relevant axis scale. diff --git a/xml/System.Web.UI.DataVisualization.Charting/TickMark.xml b/xml/System.Web.UI.DataVisualization.Charting/TickMark.xml index 0669511420e..96078a57404 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/TickMark.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/TickMark.xml @@ -27,11 +27,11 @@ ## Remarks The class encapsulates the functionality for all chart tick marks. - The class is exposed as the and properties of objects. + The class is exposed as the and properties of objects. By default, major tick marks are displayed at the major grid lines, whereas minor tick marks must be explicitly displayed. - MajorTickMark.Interval is not set (`Double.NaN`) by default, and the tick marks are drawn according to . MinorTickMark.Interval is set to `Auto` (`0`) by default, and the Chart control automatically determines the interval. + MajorTickMark.Interval is not set (`Double.NaN`) by default, and the tick marks are drawn according to . MinorTickMark.Interval is set to `Auto` (`0`) by default, and the Chart control automatically determines the interval. A developer can use this class to: @@ -162,7 +162,7 @@ To display tick marks for three-dimensional (3D) charts, so that they are just drawn for the width of a wall, set the property to . Then specify a tick mark size of zero (0) using the property. - If the property is set to , tick marks are not displayed. Tick marks can also be toggled on or off by setting the [Tickmark.Enabled]() property to `true` or `false`. + If the property is set to , tick marks are not displayed. Tick marks can also be toggled on or off by setting the [Tickmark.Enabled]() property to `true` or `false`. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/Title.xml b/xml/System.Web.UI.DataVisualization.Charting/Title.xml index f4bcaf1d8ec..e72e5df7208 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/Title.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/Title.xml @@ -26,7 +26,7 @@ class encapsulates all the functionality of a title for the control. This class is exposed using the collection property of the root object. + The class encapsulates all the functionality of a title for the control. This class is exposed using the collection property of the root object. There can be any number of titles for an entire chart image. @@ -187,7 +187,7 @@ property has no effect on alignment if the property is not set to . + The property has no effect on alignment if the property is not set to . ]]> @@ -251,7 +251,7 @@ ## Remarks You can set this property to any valid ARGB (alpha, red, green, blue) value. - The value will be the first color used if you have specified gradient colors for the background. + The value will be the first color used if you have specified gradient colors for the background. The alpha value controls the opacity of a color. If you set this color to "transparent" - that is, if you use an alpha value of 0 - no color will be assigned to the background of the title. As a result, the background will be transparent. @@ -443,7 +443,7 @@ ## Remarks This property defines a path to a background image for a title, and can be an absolute or relative URL. - To position the image, use the and properties. + To position the image, use the and properties. You can also specify one of the colors displayed by the image as "transparent", by setting the property. @@ -681,7 +681,7 @@ ## Remarks This property is one of several related properties that determine the secondary background color of objects, and is used when gradient colors are being applied. - You can set to any valid ARGB (alpha, red, green, blue) value. + You can set to any valid ARGB (alpha, red, green, blue) value. If hatching is used, the property determines the color of the hatching lines for the title. @@ -972,7 +972,7 @@ ## Remarks The can be docked to the top, left, bottom or right of either the entire chart image, or the inside or outside of a chart area. If the property is set to `false`, docking applies to the entire chart image. If the property is set to `true`, docking applies to the object specified by the property - This property has no effect if the property is not set to . + This property has no effect if the property is not set to . ]]> @@ -1180,7 +1180,7 @@ ## Remarks If the property is set to `false`, the title is docked to the outside edge of the plotted chart areas; if this property is set to `true`, the title will be docked to the inside edge of the chart area. This property will have no effect if the name of a object is not assigned to the property. - **Note** This behavior only applies if the property is set to . If this is not the case, setting the property has no effect, because the position of the title is then determined by the property value. + **Note** This behavior only applies if the property is set to . If this is not the case, setting the property has no effect, because the position of the title is then determined by the property value. ]]> @@ -1349,9 +1349,9 @@ property is automatic (that is, Title.Position.Auto = `true`) the title position is calculated automatically by the control, taking into account the , and property settings. + If the property is automatic (that is, Title.Position.Auto = `true`) the title position is calculated automatically by the control, taking into account the , and property settings. - If it is not automatic, the , and properties are ignored, and the title position is solely determined by the value of the returned object. + If it is not automatic, the , and properties are ignored, and the title position is solely determined by the value of the returned object. ]]> diff --git a/xml/System.Web.UI.DataVisualization.Charting/TitleCollection.xml b/xml/System.Web.UI.DataVisualization.Charting/TitleCollection.xml index 9129ad8591d..c0b4bbab243 100644 --- a/xml/System.Web.UI.DataVisualization.Charting/TitleCollection.xml +++ b/xml/System.Web.UI.DataVisualization.Charting/TitleCollection.xml @@ -19,13 +19,13 @@ Represents a collection of objects. - class is implemented as the collection property of the root object. - - objects can be appended, inserted or removed from the collection at design time and run time. - + class is implemented as the collection property of the root object. + + objects can be appended, inserted or removed from the collection at design time and run time. + ]]> diff --git a/xml/System.Web.UI.Design.MobileControls.Converters/DataFieldConverter.xml b/xml/System.Web.UI.Design.MobileControls.Converters/DataFieldConverter.xml index b1be0e95e95..387fc71a0bc 100644 --- a/xml/System.Web.UI.Design.MobileControls.Converters/DataFieldConverter.xml +++ b/xml/System.Web.UI.Design.MobileControls.Converters/DataFieldConverter.xml @@ -221,7 +221,7 @@ method is called by the designer host before the host calls . + The method is called by the designer host before the host calls . > [!NOTE] > You typically do not access a type converter directly. This implementation of is intended for use by a data-bound control at design time, and is instantiated with a on a property. diff --git a/xml/System.Web.UI.Design.MobileControls.Converters/DataMemberConverter.xml b/xml/System.Web.UI.Design.MobileControls.Converters/DataMemberConverter.xml index 7b2407dca37..6ad77a6c58a 100644 --- a/xml/System.Web.UI.Design.MobileControls.Converters/DataMemberConverter.xml +++ b/xml/System.Web.UI.Design.MobileControls.Converters/DataMemberConverter.xml @@ -220,7 +220,7 @@ method is called by the designer host before calling . + The method is called by the designer host before calling . > [!NOTE] > You typically do not access a type converter directly. This implementation of is intended for use by a data-bound control at design time, and is instantiated with a on a property. diff --git a/xml/System.Web.UI.Design.MobileControls/IMobileDesigner.xml b/xml/System.Web.UI.Design.MobileControls/IMobileDesigner.xml index 76f58814afa..5d3255f960c 100644 --- a/xml/System.Web.UI.Design.MobileControls/IMobileDesigner.xml +++ b/xml/System.Web.UI.Design.MobileControls/IMobileDesigner.xml @@ -21,11 +21,11 @@ Provides the interface for all mobile control designers between the .NET framework and a design host such as Visual Studio 2005. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - . - + . + ]]> ASP.NET and XHTML Compliance diff --git a/xml/System.Web.UI.Design.MobileControls/IMobileWebFormServices.xml b/xml/System.Web.UI.Design.MobileControls/IMobileWebFormServices.xml index 39eb49a664b..89bc7b378a2 100644 --- a/xml/System.Web.UI.Design.MobileControls/IMobileWebFormServices.xml +++ b/xml/System.Web.UI.Design.MobileControls/IMobileWebFormServices.xml @@ -21,11 +21,11 @@ Defines an interface for a page designer component to obtain services from a designer host such as Visual Studio 2005 at design time. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - interface. Before attempting to use the methods in a custom designer component, verify that the design host actually implements the interface. - + interface. Before attempting to use the methods in a custom designer component, verify that the design host actually implements the interface. + ]]> ASP.NET Control Designers Overview @@ -56,11 +56,11 @@ Clears all items in the designer host's **Undo** cache at design time. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - method is implemented by the designer host, verify that it exists before invoking it. - + method is implemented by the designer host, verify that it exists before invoking it. + ]]> ASP.NET Control Designers Overview @@ -97,11 +97,11 @@ Gets an item from the cache of the designer host at design time. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. An object from the cache of the designer host. - method is implemented by the designer host, verify that it exists before invoking it. - + method is implemented by the designer host, verify that it exists before invoking it. + ]]> ASP.NET Control Designers Overview @@ -132,11 +132,11 @@ Refreshes the page in the designer host at design time. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - method is implemented by the designer host, verify that it exists before invoking it. - + method is implemented by the designer host, verify that it exists before invoking it. + ]]> ASP.NET Control Designers Overview diff --git a/xml/System.Web.UI.Design.MobileControls/MobileResource.xml b/xml/System.Web.UI.Design.MobileControls/MobileResource.xml index 6075de98ea8..c345949c94f 100644 --- a/xml/System.Web.UI.Design.MobileControls/MobileResource.xml +++ b/xml/System.Web.UI.Design.MobileControls/MobileResource.xml @@ -24,11 +24,11 @@ Supports looking up culture-specific resources for mobile controls at design time. This class cannot be inherited. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. - method provides access to resources at design time. - + method provides access to resources at design time. + ]]> @@ -60,11 +60,11 @@ Returns a string resource with a specified name. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. The value of a resource. - - + + ]]> diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/CatalogPartDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/CatalogPartDesigner.xml index 0d5634c2267..1819eaa2a76 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/CatalogPartDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/CatalogPartDesigner.xml @@ -17,18 +17,18 @@ Provides design-time support for , , and controls. - is a multi-purpose designer that provides design-time rendering for and controls, which both inherit from the base class. serves as a standard control designer, adding only what customization is needed to validate the associated control and apply its design mode state to the design-time rendering. - - If you have a custom control, you can create a derived designer, such as , to provide design-time rendering. You can safely override any of the members as needed; however, when overriding the method, be sure to call the base implementation to avoid losing design mode state information. - - - -## Examples - and share an identical interface and functionality. For an applicable code example, see the class overview. - + is a multi-purpose designer that provides design-time rendering for and controls, which both inherit from the base class. serves as a standard control designer, adding only what customization is needed to validate the associated control and apply its design mode state to the design-time rendering. + + If you have a custom control, you can create a derived designer, such as , to provide design-time rendering. You can safely override any of the members as needed; however, when overriding the method, be sure to call the base implementation to avoid losing design mode state information. + + + +## Examples + and share an identical interface and functionality. For an applicable code example, see the class overview. + ]]> @@ -82,11 +82,11 @@ Creates a copy of the associated control to render at design time. A copy of the associated control. - diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/CatalogZoneDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/CatalogZoneDesigner.xml index 7ec3778783c..71b93608cda 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/CatalogZoneDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/CatalogZoneDesigner.xml @@ -22,7 +22,7 @@ ## Remarks provides design-time rendering of controls. It includes support for editable designer regions, templates, and auto-formats to allow a page developer to easily alter the appearance of the control. - The public and collections provide quick formatting options for the page developer and can be safely overridden to change the default appearance of a custom control. + The public and collections provide quick formatting options for the page developer and can be safely overridden to change the default appearance of a custom control. ]]> diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/ConnectionsZoneDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/ConnectionsZoneDesigner.xml index 6e874299914..10168f1ee96 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/ConnectionsZoneDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/ConnectionsZoneDesigner.xml @@ -20,16 +20,16 @@ provides a design-time representation of a control with a menu to access the collection and the property for the convenience of the page developer. It is the only zone designer that does not support designer regions. This is because controls uses links to create connections instead of a drag-and-drop user interface (UI). + provides a design-time representation of a control with a menu to access the collection and the property for the convenience of the page developer. It is the only zone designer that does not support designer regions. This is because controls uses links to create connections instead of a drag-and-drop user interface (UI). - The collection and the property both appear on the verbs menu of the control. , when selected, provides a selection of color schemes. The check box, when selected, displays the contents of the control as it would appear in the browser; the control will be empty until a connection is made. + The collection and the property both appear on the verbs menu of the control. , when selected, provides a selection of color schemes. The check box, when selected, displays the contents of the control as it would appear in the browser; the control will be empty until a connection is made. - You can inherit from to support a custom control as with any other control designer. You can override the method to change the markup that renders the control. You can also override the collection to add a with a custom scheme. + You can inherit from to support a custom control as with any other control designer. You can override the method to change the markup that renders the control. You can also override the collection to add a with a custom scheme. ## Examples - The following code example shows how to hide additional properties from a custom control by overriding the method. + The following code example shows how to hide additional properties from a custom control by overriding the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/WebPartsDesigners_ConnectionsZoneDesigner_Overview/CS/ConnectionsZoneSample.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/WebPartsDesigners_ConnectionsZoneDesigner_Overview/vb/connectionszonesample.vb" id="Snippet1"::: @@ -169,12 +169,12 @@ method overrides the parent method to hide the , , , and properties in the designer. This is because the properties in question are not rendered by controls and are therefore not relevant. + The method overrides the parent method to hide the , , , and properties in the designer. This is because the properties in question are not rendered by controls and are therefore not relevant. ## Examples - For an example of how to override the method, see the class overview topic. + For an example of how to override the method, see the class overview topic. ]]> diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/DeclarativeCatalogPartDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/DeclarativeCatalogPartDesigner.xml index 02b7a8992c5..f2098810b2b 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/DeclarativeCatalogPartDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/DeclarativeCatalogPartDesigner.xml @@ -20,7 +20,7 @@ provides design-time support for controls. It extends its parent class, , by adding a control-specific to the collection. does not render the associated control on the design surface. + provides design-time support for controls. It extends its parent class, , by adding a control-specific to the collection. does not render the associated control on the design surface. ]]> @@ -81,7 +81,7 @@ associated with the control, the designer displays the standard gray box with the class name and instance name of the control. Otherwise, no design-time rendering occurs at all because the check boxes and Web Parts titles are rendered by the instead of the itself. + If there is no associated with the control, the designer displays the standard gray box with the class name and instance name of the control. Otherwise, no design-time rendering occurs at all because the check boxes and Web Parts titles are rendered by the instead of the itself. ]]> diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/EditorPartDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/EditorPartDesigner.xml index ba16de6a095..2e173f6cddf 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/EditorPartDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/EditorPartDesigner.xml @@ -22,7 +22,7 @@ ## Remarks is a public implementation of the base class for the purpose of rendering controls at design time. It adds the capability of carrying zone information from the associated control into design view, but does not otherwise change the functionality of the parent control. - As with other control designers, you can change the design-time rendering of custom controls by inheriting from and overriding the method. If you want to override the method, be sure to include the base implementation so as to retain zone information. + As with other control designers, you can change the design-time rendering of custom controls by inheriting from and overriding the method. If you want to override the method, be sure to include the base implementation so as to retain zone information. @@ -32,7 +32,7 @@ :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/WebPartsDesigners_EditorPartDesigner_Overview/CS/SecretEditorPart.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/WebPartsDesigners_EditorPartDesigner_Overview/vb/secreteditorpart.vb" id="Snippet1"::: - In order for the custom control to render, the page must have a control, an with a for the control to reside in, and a containing a control for the custom to act on, as shown in the following code example. + In order for the custom control to render, the page must have a control, an with a for the control to reside in, and a containing a control for the custom to act on, as shown in the following code example. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/WebPartsDesigners_EditorPartDesigner_Overview/CS/Default.aspx" id="Snippet2"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/WebPartsDesigners_EditorPartDesigner_Overview/vb/default.aspx" id="Snippet2"::: diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/EditorZoneDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/EditorZoneDesigner.xml index 9379951c95c..aac4b56cf94 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/EditorZoneDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/EditorZoneDesigner.xml @@ -22,7 +22,7 @@ ## Remarks provides design-time rendering of controls. It includes support for editable designer regions, templates, and auto-formats to allow a page developer to easily alter the appearance of the control. - The public and collections provide quick formatting options for the page developer and can be safely overridden to change the default appearance of a custom control. + The public and collections provide quick formatting options for the page developer and can be safely overridden to change the default appearance of a custom control. ]]> diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/ProxyWebPartManagerDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/ProxyWebPartManagerDesigner.xml index b2dd09e95fa..3b470983b83 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/ProxyWebPartManagerDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/ProxyWebPartManagerDesigner.xml @@ -20,7 +20,7 @@ class is identical to the class and provides design-time support for controls. It appears on the design surface as a plain gray box showing the name of the class and the ID of the specific control. You can change the rendering of a custom control by overriding the method in the same manner as with any standard . The property is overridden to always return `true`. + The class is identical to the class and provides design-time support for controls. It appears on the design surface as a plain gray box showing the name of the class and the ID of the specific control. You can change the rendering of a custom control by overriding the method in the same manner as with any standard . The property is overridden to always return `true`. ]]> diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/WebPartDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/WebPartDesigner.xml index 6fc63fd1d36..fa47f06e760 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/WebPartDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/WebPartDesigner.xml @@ -24,7 +24,7 @@ inherits a property from its parent that is always set to `true`. This causes the visual design environment to generate a control to hold a temporary copy of the on the design surface; this copy is then persisted into markup. If you override the property to return `false`, the visual design environment generates markup directly from the actual control. - Web Parts designers generally act much like regular control designers; the principal methods for setting design-time appearance derive from the class. Specifically, you can override the method to change the design-time markup associated with the control. You can likewise override the and methods to handle errors and empty strings (""), respectively. + Web Parts designers generally act much like regular control designers; the principal methods for setting design-time appearance derive from the class. Specifically, you can override the method to change the design-time markup associated with the control. You can likewise override the and methods to handle errors and empty strings (""), respectively. diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/WebPartManagerDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/WebPartManagerDesigner.xml index bc003e99df6..b3a7d0b9157 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/WebPartManagerDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/WebPartManagerDesigner.xml @@ -20,12 +20,12 @@ class provides a bare-minimum design-time rendering of the control. It appears on the design surface as a plain gray box showing the name of the class and the ID of the current . You can change the rendering of a custom control by overriding the method in the same manner as with any standard . The property is overridden to always return `true`. + The class provides a bare-minimum design-time rendering of the control. It appears on the design surface as a plain gray box showing the name of the class and the ID of the current . You can change the rendering of a custom control by overriding the method in the same manner as with any standard . The property is overridden to always return `true`. ## Examples - The following code example shows how to change the design-time appearance of a custom control by overriding the method of the designer. + The following code example shows how to change the design-time appearance of a custom control by overriding the method of the designer. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/WebPartsDesigners_WebPartManagerDesigner_Overview/CS/PrettyPartManager.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/WebPartsDesigners_WebPartManagerDesigner_Overview/vb/prettypartmanager.vb" id="Snippet1"::: diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/WebPartZoneBaseDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/WebPartZoneBaseDesigner.xml index 6bd36369fdf..e830cbe9ffa 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/WebPartZoneBaseDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/WebPartZoneBaseDesigner.xml @@ -20,7 +20,7 @@ is the base class for and can be inherited to support custom implementations of controls. extends its own base class, , by overriding the method to hide the property. Otherwise, the main purpose of this class for a control developer is that, unlike its parent, has a public constructor so it can be inherited directly and used as a public implementation of the base class. For details, see . + is the base class for and can be inherited to support custom implementations of controls. extends its own base class, , by overriding the method to hide the property. Otherwise, the main purpose of this class for a control developer is that, unlike its parent, has a public constructor so it can be inherited directly and used as a public implementation of the base class. For details, see . ]]> @@ -105,7 +105,7 @@ method overrides to hide the property in the designer after calling the parent method. This is because the default control does not render any zone-level verbs. If you wish to render zone-level verbs in a derived class, you must override this method to not hide the property. + The method overrides to hide the property in the designer after calling the parent method. This is because the default control does not render any zone-level verbs. If you wish to render zone-level verbs in a derived class, you must override this method to not hide the property. ]]> diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/WebPartZoneDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/WebPartZoneDesigner.xml index efecee0a07d..b294e1f3579 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/WebPartZoneDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/WebPartZoneDesigner.xml @@ -22,7 +22,7 @@ ## Remarks provides design-time rendering of controls. It includes support for editable designer regions, templates, and auto-formats to allow a page developer to easily alter the appearance of the control. - The public and collections provide quick formatting options for the page developer and can be safely overridden to change the default appearance of a custom control. + The public and collections provide quick formatting options for the page developer and can be safely overridden to change the default appearance of a custom control. ]]> diff --git a/xml/System.Web.UI.Design.WebControls.WebParts/WebZoneDesigner.xml b/xml/System.Web.UI.Design.WebControls.WebParts/WebZoneDesigner.xml index 8a8739c1e29..41012f93bc3 100644 --- a/xml/System.Web.UI.Design.WebControls.WebParts/WebZoneDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls.WebParts/WebZoneDesigner.xml @@ -20,7 +20,7 @@ class is the abstract base class for both and , which all the other zone designers inherit from. By inheriting directly from instead of , it allows implementations of the method that do not automatically clear the collection, thus enabling the designer to render exceptions from child controls. + The class is the abstract base class for both and , which all the other zone designers inherit from. By inheriting directly from instead of , it allows implementations of the method that do not automatically clear the collection, thus enabling the designer to render exceptions from child controls. Like other designers in this namespace, overrides the property to always return `true`. diff --git a/xml/System.Web.UI.Design.WebControls/AccessDataSourceDesigner.xml b/xml/System.Web.UI.Design.WebControls/AccessDataSourceDesigner.xml index 51b1193499c..4e333e7a91d 100644 --- a/xml/System.Web.UI.Design.WebControls/AccessDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/AccessDataSourceDesigner.xml @@ -146,12 +146,12 @@ method maps the property of the control to the designer site, and then uses the property of the control to generate the connection string. + The method maps the property of the control to the designer site, and then uses the property of the control to generate the connection string. ## Examples - The following code example shows how to use the method to display the connection string of the Microsoft Access database that is associated with the control in the control placeholder at design time. + The following code example shows how to use the method to display the connection string of the Microsoft Access database that is associated with the control in the control placeholder at design time. This code example is part of a larger example provided for the class. @@ -193,14 +193,14 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to, or remove them from, the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to, or remove them from, the **Properties** grid. - For the control, the method creates the design-time property to shadow the property of the control. + For the control, the method creates the design-time property to shadow the property of the control. ## Examples - The following code example shows how to override the method to make the property read-only and visible in the **Properties** grid. + The following code example shows how to override the method to make the property read-only and visible in the **Properties** grid. This code example is part of a larger example provided for the class. diff --git a/xml/System.Web.UI.Design.WebControls/AdRotatorDesigner.xml b/xml/System.Web.UI.Design.WebControls/AdRotatorDesigner.xml index 00050f382fc..5e181a67164 100644 --- a/xml/System.Web.UI.Design.WebControls/AdRotatorDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/AdRotatorDesigner.xml @@ -30,11 +30,11 @@ Provides design-time support in a visual designer for the control. - control is parsed. A design-time version of the control is created on the design surface. When you switch back to source view, the design-time control code is persisted to the markup for the Web page. - + control is parsed. A design-time version of the control is created on the design surface. When you switch back to source view, the design-time control code is persisted to the markup for the Web page. + ]]> @@ -90,13 +90,13 @@ Generates the markup that is used to render the control on the design surface. The markup that represents the control on the design surface. - method in a templated data-bound control designer, see . - - If the control that is associated with this designer has templates, it displays the templates in the designer. - + method in a templated data-bound control designer, see . + + If the control that is associated with this designer has templates, it displays the templates in the designer. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/BaseDataBoundControlDesigner.xml b/xml/System.Web.UI.Design.WebControls/BaseDataBoundControlDesigner.xml index dba843de377..84e7b3f8e70 100644 --- a/xml/System.Web.UI.Design.WebControls/BaseDataBoundControlDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/BaseDataBoundControlDesigner.xml @@ -91,7 +91,7 @@ method typically involves unhooking events from the previous data source, and then attaching new events to the new data source. + The implementation of the method typically involves unhooking events from the previous data source, and then attaching new events to the new data source. ]]> @@ -123,7 +123,7 @@ override that displays a dialog that can be used to create a data source for the associated control, see . + For an example of a override that displays a dialog that can be used to create a data source for the associated control, see . ]]> @@ -162,7 +162,7 @@ method in a designer that is derived from the class, perform the necessary actions to set up the data-bound control so that when the design-time markup is retrieved, the control renders properly. Typically, you will associate a design-time data source rather than the live data source, for performance reasons. + When you override the method in a designer that is derived from the class, perform the necessary actions to set up the data-bound control so that when the design-time markup is retrieved, the control renders properly. Typically, you will associate a design-time data source rather than the live data source, for performance reasons. ]]> @@ -294,7 +294,7 @@ method unhooks the event handlers for the designer from all data source events. + The method unhooks the event handlers for the designer from all data source events. ]]> @@ -328,7 +328,7 @@ class retrieves sample data that is used for binding purposes at design time before rendering the control. If the control is not data bound, it calls the method. If there is an error rendering the control, it calls the method. + The class retrieves sample data that is used for binding purposes at design time before rendering the control. If the control is not data bound, it calls the method. If there is an error rendering the control, it calls the method. ]]> @@ -436,7 +436,7 @@ method when it is ready to use the designer to render a control that is derived from the class. The method and its base methods configure properties and connect events that are necessary for the operation of the designer. + The designer host calls the method when it is ready to use the designer to render a control that is derived from the class. The method and its base methods configure properties and connect events that are necessary for the operation of the designer. ]]> @@ -475,7 +475,7 @@ method connects to the current data source. If the current data source is different from the data source to which the control was previously connected, or `forceUpdateView` is `true`, the associated control is redrawn on the design surface. + The method connects to the current data source. If the current data source is different from the data source to which the control was previously connected, or `forceUpdateView` is `true`, the associated control is redrawn on the design surface. ]]> @@ -514,7 +514,7 @@ method handles the event, which is raised when the schema of the data source to which the associated control is bound changes. Override the method to perform additional actions that are required when new schema is available. + The method handles the event, which is raised when the schema of the data source to which the associated control is bound changes. Override the method to perform additional actions that are required when new schema is available. ]]> @@ -550,9 +550,9 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add or remove properties from the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add or remove properties from the **Properties** grid. - For the class, the shadows the property of the control. It makes a copy of the attribute array of the , and then adds these attributes to the shadowed property. It sets the attribute of the shadowed property to `false` unless the attribute of the property of the control is already set to `true`. + For the class, the shadows the property of the control. It makes a copy of the attribute array of the , and then adds these attributes to the shadowed property. It sets the attribute of the shadowed property to `false` unless the attribute of the property of the control is already set to `true`. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/BaseDataListComponentEditor.xml b/xml/System.Web.UI.Design.WebControls/BaseDataListComponentEditor.xml index a77986d5a0a..b921a927326 100644 --- a/xml/System.Web.UI.Design.WebControls/BaseDataListComponentEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/BaseDataListComponentEditor.xml @@ -18,13 +18,13 @@ Provides a component editor base class for Web server controls that are derived from the class. - class are invoked from designers derived from the class, and are used to edit the properties of controls that are derived from the class. For examples of such controls, see and . - - The method displays a component editor for the associated control, if one can be created. The method returns the index of the initial page to be displayed in the component editor. - + class are invoked from designers derived from the class, and are used to edit the properties of controls that are derived from the class. For examples of such controls, see and . + + The method displays a component editor for the associated control, if one can be created. The method returns the index of the initial page to be displayed in the component editor. + ]]> @@ -61,11 +61,11 @@ The index in the array of page control types, of the initial page to display. Initializes a new instance of the class. - class creates a component editor that is derived from the class, when the user selects **Property Builder** from the context menu within the designer. - + class creates a component editor that is derived from the class, when the user selects **Property Builder** from the context menu within the designer. + ]]> @@ -103,11 +103,11 @@ the component was successfully edited; otherwise, . - method gets a array of page control types by using the method. It creates a object, and then calls its method to display the component editor. - + method gets a array of page control types by using the method. It creates a object, and then calls its method to display the component editor. + ]]> @@ -143,11 +143,11 @@ Gets the index of the initial page to display in the component editor. The index of the initial page in the array. - object is created. - + object is created. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/BaseDataListDesigner.xml b/xml/System.Web.UI.Design.WebControls/BaseDataListDesigner.xml index 5ef1d15ccaa..cbf5d7f14d7 100644 --- a/xml/System.Web.UI.Design.WebControls/BaseDataListDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/BaseDataListDesigner.xml @@ -39,19 +39,19 @@ The property returns a object, which typically contains an object that is derived from the class for each level in the inheritance tree of the designer. -- The , , , and properties provide access to the corresponding properties of the associated control. +- The , , , and properties provide access to the corresponding properties of the associated control. - The property provides access to the designer of the data source of the associated control. The property gets the default view of the data source. The class methods provide the following functionality: -- The method prepares the designer to view, edit, and design the associated control. The method invokes a component editor for the control. The method is used to add, remove, or shadow design-time properties of the associated control. +- The method prepares the designer to view, edit, and design the associated control. The method invokes a component editor for the control. The method is used to add, remove, or shadow design-time properties of the associated control. -- The method generates an object that can be used as a data source at design time. The method gets the data source from the container of the associated control. The method gets the data source from the control container, resolved to a specific data member. The method gets the data source of the template container. +- The method generates an object that can be used as a data source at design time. The method gets the data source from the container of the associated control. The method gets the data source from the control container, resolved to a specific data member. The method gets the data source of the template container. -- The method is called when there is a change to the associated control. The method is called when the associated control data source has changed. The method is called when the schema of the associated control data source changes. The method is called when an automatic formatting scheme has been applied. +- The method is called when there is a change to the associated control. The method is called when the associated control data source has changed. The method is called when the schema of the associated control data source changes. The method is called when an automatic formatting scheme has been applied. -- The and methods can be overridden to implement functionality that should occur when an associated control style has changed or when the designer template-editing verbs have changed, respectively. The method handles the property-builder event. +- The and methods can be overridden to implement functionality that should occur when an associated control style has changed or when the designer template-editing verbs have changed, respectively. The method handles the property-builder event. ]]> @@ -128,7 +128,7 @@ property creates an empty object and adds the that is returned by the base property to this object. Then it adds it to the object, and then returns this object. + The property creates an empty object and adds the that is returned by the base property to this object. Then it adds it to the object, and then returns this object. ]]> @@ -162,7 +162,7 @@ property provides access from the designer to the property of the associated control that is derived from the class. The indicates the primary key of the data source that is bound to the associated control. + The property provides access from the designer to the property of the associated control that is derived from the class. The indicates the primary key of the data source that is bound to the associated control. ]]> @@ -194,7 +194,7 @@ property provides access from the designer to the property of the associated control that is derived from the class. The indicates the table or element of the data source that is bound to the associated control. + The property provides access from the designer to the property of the associated control that is derived from the class. The indicates the table or element of the data source that is bound to the associated control. ]]> @@ -296,7 +296,7 @@ property causes the property of the associated control to be set. If the is set to a , indicating a new data source is to be defined, a **Create Data Source** dialog box is displayed. If the is set to a indicating there is no data source, the is set to an empty string (""). + Setting the designer's property causes the property of the associated control to be set. If the is set to a , indicating a new data source is to be defined, a **Create Data Source** dialog box is displayed. If the is set to a indicating there is no data source, the is set to an empty string (""). ]]> @@ -329,7 +329,7 @@ property gets the default view of the data source that is bound to the associated control by passing the property to the method of the object. If no view is returned or the property is not set, the method of the is used to get the view names and the first view name is used to get the default view. + The property gets the default view of the data source that is bound to the associated control by passing the property to the method of the object. If no view is returned or the property is not set, the method of the is used to get the view names and the first view name is used to get the default view. ]]> @@ -399,9 +399,9 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the class has a property that implements the interface, the method disconnects the event of the object. + If the associated control that is derived from the class has a property that implements the interface, the method disconnects the event of the object. - If the implements the method, the disconnects the , , and events. The also disconnects the and events of the object. It finally calls the base method. + If the implements the method, the disconnects the , , and events. The also disconnects the and events of the object. It finally calls the base method. ]]> @@ -455,7 +455,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method attempts to construct a object from the data source that is defined by the and properties. If this is not possible, it creates a from dummy data. + The method attempts to construct a object from the data source that is defined by the and properties. If this is not possible, it creates a from dummy data. ]]> @@ -499,7 +499,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method attempts to construct a object from the data source that is specified by the `selectedDataSource` parameter. If this is not possible, it creates a from dummy data. + The method attempts to construct a object from the data source that is specified by the `selectedDataSource` parameter. If this is not possible, it creates a from dummy data. ]]> @@ -536,7 +536,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method uses the method to construct a data source from the object that is specified by the and properties of the associated control derived from the class. + The method uses the method to construct a data source from the object that is specified by the and properties of the associated control derived from the class. ]]> @@ -577,7 +577,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method uses the method to construct a data source from the object that is specified by the property of the associated control derived from the class. + The method uses the method to construct a data source from the object that is specified by the property of the associated control derived from the class. ]]> @@ -627,7 +627,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method calls the method to construct a data source from the object that is specified by the and properties of the associated control derived from class. + The method calls the method to construct a data source from the object that is specified by the and properties of the associated control derived from class. ]]> @@ -668,9 +668,9 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method when it is ready to use the designer to render the control that is derived from the class. The method and its base methods configure properties and connect to events that are necessary for the operation of the designer. + The designer host calls the method when it is ready to use the designer to render the control that is derived from the class. The method and its base methods configure properties and connect to events that are necessary for the operation of the designer. - The connects to the design-time data source and updates the design-time markup. If the property implements the interface, the connects the , , and events. + The connects to the design-time data source and updates the design-time markup. If the property implements the interface, the connects the , , and events. The `component` parameter is the control, derived from the , that is associated with this designer, or a copy of that control. @@ -711,7 +711,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method creates a or object, and then invokes the method of the component editor. + The method creates a or object, and then invokes the method of the component editor. ]]> @@ -756,7 +756,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method is obsolete and has no functionality. + The method is obsolete and has no functionality. ]]> @@ -790,9 +790,9 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method is called when a object is applied to the associated control that is derived from the class. A object defines a object that is applied to the control. + The method is called when a object is applied to the associated control that is derived from the class. A object defines a object that is applied to the control. - A designer can override the to inspect properties of the control or to take some other action. + A designer can override the to inspect properties of the control or to take some other action. ]]> @@ -831,7 +831,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method is called when the event of a control that is derived from the class executes. Typically, this is in response to a property change on the control (for example, a **Properties** grid change). If the object to which the control is bound is changed, the control is redrawn on the design surface. + The method is called when the event of a control that is derived from the class executes. Typically, this is in response to a property change on the control (for example, a **Properties** grid change). If the object to which the control is bound is changed, the control is redrawn on the design surface. ]]> @@ -866,7 +866,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the base method connects the associated control that is derived from the class to the current data source, and if that is different from the data source to which the control was connected, the method updates the design-time markup. + The base method connects the associated control that is derived from the class to the current data source, and if that is different from the data source to which the control was connected, the method updates the design-time markup. ]]> @@ -910,7 +910,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method invokes a component editor for the associated control that is derived from the class. It creates a or object, and then invokes the method of the component editor. + The method invokes a component editor for the associated control that is derived from the class. It creates a or object, and then invokes the method of the component editor. ]]> @@ -943,7 +943,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method calls the method, which in turn calls the method to update the control to reflect the data source change. + Unless the designer is in template-editing mode or a field is being added or edited, the method calls the method, which in turn calls the method to update the control to reflect the data source change. ]]> @@ -982,7 +982,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method can serve as notification that a style of the associated control that is derived from the class has changed. + The method can serve as notification that a style of the associated control that is derived from the class has changed. ]]> @@ -1014,7 +1014,7 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method can be implemented to perform additional processing, such recording that a change has occurred, when the template-editing verbs change. + The method can be implemented to perform additional processing, such recording that a change has occurred, when the template-editing verbs change. ]]> @@ -1053,9 +1053,9 @@ The `DesignTimeHtmlRequiresLoadComplete` property returns `true` if the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. - For controls that are derived from the class, the creates design-time properties to shadow the , , , and properties. + For controls that are derived from the class, the creates design-time properties to shadow the , , , and properties. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/BaseValidatorDesigner.xml b/xml/System.Web.UI.Design.WebControls/BaseValidatorDesigner.xml index 5b2044b34e2..dcc6d951d55 100644 --- a/xml/System.Web.UI.Design.WebControls/BaseValidatorDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/BaseValidatorDesigner.xml @@ -35,14 +35,14 @@ ## Remarks In a visual designer, when you switch from Source to Design view, the markup source code that describes a control that is derived from the abstract class is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to markup source code and edited into the markup for the Web page. The objects provide design-time support for controls that are derived from the class in a visual designer. - The method gets the markup that is used to render the associated control at design time. + The method gets the markup that is used to render the associated control at design time. ## Examples The following example derives the `SimpleCompareValidator` control from the class. `SimpleCompareValidator` is a copy of the . The example also derives the designer `SimpleCompareValidatorDesigner` from the class and uses the attribute to associate the `SimpleCompareValidatorDesigner` class with the `SimpleCompareValidator` control. - `SimpleCompareValidatorDesigner` overrides the method to draw a solid border around the `SimpleCompareValidator` control at design time if the value of the property of the control is the or field. + `SimpleCompareValidatorDesigner` overrides the method to draw a solid border around the `SimpleCompareValidator` control at design time if the value of the property of the control is the or field. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.BaseValidatorDesigner/CS/CustomCompareValidatorDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.BaseValidatorDesigner/VB/customcomparevalidatordesigner.vb" id="Snippet1"::: @@ -142,12 +142,12 @@ or property of the associated control that is derived from the class is an empty string (""), or if the property is set to the field, the method sets the property to the control ID, which is enclosed in brackets ([]) and sets the property to the field. The then calls the base method to generate the markup, and restores the control properties to their original values, if necessary. + If the or property of the associated control that is derived from the class is an empty string (""), or if the property is set to the field, the method sets the property to the control ID, which is enclosed in brackets ([]) and sets the property to the field. The then calls the base method to generate the markup, and restores the control properties to their original values, if necessary. ## Examples - The following code example shows how to override the method that draws a solid border around the associated control at design time if the value of the property of the control is set to the or field. + The following code example shows how to override the method that draws a solid border around the associated control at design time if the value of the property of the control is set to the or field. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.BaseValidatorDesigner/CS/CustomCompareValidatorDesigner.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.BaseValidatorDesigner/VB/customcomparevalidatordesigner.vb" id="Snippet3"::: @@ -186,7 +186,7 @@ method to shadow control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the properties grid. + Control designer objects use methods that are derived from the method to shadow control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the properties grid. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/BulletedListDesigner.xml b/xml/System.Web.UI.Design.WebControls/BulletedListDesigner.xml index 2f2efb19ec9..aa13b4dc934 100644 --- a/xml/System.Web.UI.Design.WebControls/BulletedListDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/BulletedListDesigner.xml @@ -95,9 +95,9 @@ method to filter the set of events that the control it is designing will expose through the object. + Control designers use methods that are derived from the method to filter the set of events that the control it is designing will expose through the object. - For the control, the method removes the event from the list that is exposed by the designer. + For the control, the method removes the event from the list that is exposed by the designer. The keys in the interface are the names of the events. The values in the are objects of type . diff --git a/xml/System.Web.UI.Design.WebControls/ButtonDesigner.xml b/xml/System.Web.UI.Design.WebControls/ButtonDesigner.xml index db51965d226..cb5791c11eb 100644 --- a/xml/System.Web.UI.Design.WebControls/ButtonDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/ButtonDesigner.xml @@ -34,9 +34,9 @@ ## Examples This section provides two code examples. The first demonstrates how to extend the class. The second demonstrates how to extend the class and associate it with the class that is created in the first code example. - The following code example shows how to create a custom designer class that extends the class and overrides the method. If the property has not been set previously (that is, it has the field value), a call to the method sets it to a blue-dashed border with a width of three pixels, and then displays that border on the design surface. If the property has been set, the existing border property values are displayed. + The following code example shows how to create a custom designer class that extends the class and overrides the method. If the property has not been set previously (that is, it has the field value), a call to the method sets it to a blue-dashed border with a width of three pixels, and then displays that border on the design surface. If the property has been set, the existing border property values are displayed. - Typically, the calls its base method, , which calls into the method of the associated control to generate the markup. + Typically, the calls its base method, , which calls into the method of the associated control to generate the markup. :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls_ButtonDesignerSamples/VB/custombutton.vb" id="Snippet1"::: @@ -113,16 +113,16 @@ method replaces the property with the property of the control if the contains no displayable characters. Then, the method calls its base method, , which calls into the method to generate the markup. + The method replaces the property with the property of the control if the contains no displayable characters. Then, the method calls its base method, , which calls into the method to generate the markup. ## Examples - The following code example demonstrates how to override the method to change the generated markup. + The following code example demonstrates how to override the method to change the generated markup. - If the property has not been set previously (that is, it has the field value), a call to the method sets it to a blue-dashed border with a width of three pixels, and then displays that border on the design surface. If the property has been set, the existing border property values are displayed. + If the property has not been set previously (that is, it has the field value), a call to the method sets it to a blue-dashed border with a width of three pixels, and then displays that border on the design surface. If the property has been set, the existing border property values are displayed. - Typically, the calls its base method, , which calls into the method of the associated control to generate the markup. + Typically, the calls its base method, , which calls into the method of the associated control to generate the markup. :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls_ButtonDesignerSamples/VB/custombutton.vb" id="Snippet1"::: diff --git a/xml/System.Web.UI.Design.WebControls/CalendarDesigner.xml b/xml/System.Web.UI.Design.WebControls/CalendarDesigner.xml index 376fcf74290..2b876c7e3c0 100644 --- a/xml/System.Web.UI.Design.WebControls/CalendarDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/CalendarDesigner.xml @@ -101,11 +101,11 @@ The object for this designer. Initializes the designer with the specified component. - to initialize the component for the designer. - + to initialize the component for the designer. + ]]> @@ -139,11 +139,11 @@ The object that contains the event data. Called when an auto-format scheme has been applied to the control. - Introduction to ASP.NET Control Designers diff --git a/xml/System.Web.UI.Design.WebControls/ChangePasswordDesigner.xml b/xml/System.Web.UI.Design.WebControls/ChangePasswordDesigner.xml index 55d47cb349d..9ac3a9417dc 100644 --- a/xml/System.Web.UI.Design.WebControls/ChangePasswordDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/ChangePasswordDesigner.xml @@ -188,7 +188,7 @@ method sets the mode of the associated control, which can be a copy, to the current mode of the actual control. Next, it forces the child controls to be recreated, and then calls the base method to generate the markup. If an error occurs, the calls the method to generate the markup for a placeholder. + The method sets the mode of the associated control, which can be a copy, to the current mode of the actual control. Next, it forces the child controls to be recreated, and then calls the base method to generate the markup. If an error occurs, the calls the method to generate the markup for a placeholder. ]]> @@ -228,7 +228,7 @@ method calls the method to generate the markup for the design-time rendering of the control. It also adds a object to the `regions` parameter that describes the current view of the control. + The method calls the method to generate the markup for the design-time rendering of the control. It also adds a object to the `regions` parameter that describes the current view of the control. ]]> @@ -269,7 +269,7 @@ method serializes the current template (the or property) of the control to its persisted form, which is a object of markup text. This persisted form consists of the serialized child controls appended together. + The method serializes the current template (the or property) of the control to its persisted form, which is a object of markup text. This persisted form consists of the serialized child controls appended together. ]]> @@ -342,7 +342,7 @@ method when it is ready to use the designer to render the control. The method and its base methods configure properties and connect events that are necessary for the operation of the designer. + The designer host calls the method when it is ready to use the designer to render the control. The method and its base methods configure properties and connect events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer, or a copy of the control specified by `component`. @@ -383,9 +383,9 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add or remove properties from the **Properties** grid. + Control designers use methods derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add or remove properties from the **Properties** grid. - For the control, the method sets the attribute to `false` for properties that do not apply to templates (removes them from the **Properties** grid) when a user template has been defined. + For the control, the method sets the attribute to `false` for properties that do not apply to templates (removes them from the **Properties** grid) when a user template has been defined. ]]> @@ -458,7 +458,7 @@ method sets an editable region in a designer to a control or template that is specified in its persisted form by the `content` parameter. + The method sets an editable region in a designer to a control or template that is specified in its persisted form by the `content` parameter. ]]> @@ -492,7 +492,7 @@ property constructs a object and populates it with the collection returned by the base property. It then adds a object for each of the templates ( and ) of the associated control. + The property constructs a object and populates it with the collection returned by the base property. It then adds a object for each of the templates ( and ) of the associated control. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/CheckBoxDesigner.xml b/xml/System.Web.UI.Design.WebControls/CheckBoxDesigner.xml index b5b470b639a..13e6e8a6352 100644 --- a/xml/System.Web.UI.Design.WebControls/CheckBoxDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/CheckBoxDesigner.xml @@ -27,12 +27,12 @@ class overrides the method of the class to ensure that the control is displayed with a meaningful representation at design time. If the property is empty, the method of this class sets the property of the control to the property of the control. + The class overrides the method of the class to ensure that the control is displayed with a meaningful representation at design time. If the property is empty, the method of this class sets the property of the control to the property of the control. ## Examples - The following code example creates a custom designer class, named `SampleCheckBoxDesigner`, that inherits from the class. It overrides the method. If the property has not been set previously, a call to this method sets it to a string and displays that string on the design surface. If the property has been set, the existing property value is displayed. + The following code example creates a custom designer class, named `SampleCheckBoxDesigner`, that inherits from the class. It overrides the method. If the property has not been set previously, a call to this method sets it to a string and displays that string on the design surface. If the property has been set, the existing property value is displayed. :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls_CheckBoxDesignerSamples/VB/customcheckbox.vb" id="Snippet1"::: @@ -98,14 +98,14 @@ property is empty or consists only of white space, then the generated HTML contains the of the check box control; otherwise, the generated HTML contains the contents of the control's property. + If the property is empty or consists only of white space, then the generated HTML contains the of the check box control; otherwise, the generated HTML contains the contents of the control's property. Override this method to change the generated HTML. ## Examples - The following code example overrides the method. If the property has not been set previously, a call to this method sets it to a string and displays that string on the design surface. If the property has already been set, the existing property value is displayed. + The following code example overrides the method. If the property has not been set previously, a call to this method sets it to a string and displays that string on the design surface. If the property has already been set, the existing property value is displayed. :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls_CheckBoxDesignerSamples/VB/customcheckbox.vb" id="Snippet2"::: diff --git a/xml/System.Web.UI.Design.WebControls/CompositeControlDesigner.xml b/xml/System.Web.UI.Design.WebControls/CompositeControlDesigner.xml index 9491ba02a40..7c9e962d5f4 100644 --- a/xml/System.Web.UI.Design.WebControls/CompositeControlDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/CompositeControlDesigner.xml @@ -17,11 +17,11 @@ Extends design-time behavior for controls that implement the methods of the abstract class. - can be used with other control types that implement the interface. Otherwise functions similarly to its base class, . For an example, see . - + can be used with other control types that implement the interface. Otherwise functions similarly to its base class, . For an example, see . + ]]> Introduction to ASP.NET Control Designers @@ -74,11 +74,11 @@ Creates the child controls of this control. - method is used to recreate the child controls in the associated control. It ensures that the control collection is created before creating the design-time markup. - + method is used to recreate the child controls in the associated control. It ensures that the control collection is created before creating the design-time markup. + ]]> Introduction to ASP.NET Control Designers @@ -106,13 +106,13 @@ Gets the HTML that is used to represent the control at design time. The HTML that is used to represent the control at design time. - . - - In this overridden method, the base implementation always creates the child controls on the associated control. - + . + + In this overridden method, the base implementation always creates the child controls on the associated control. + ]]> Introduction to ASP.NET Control Designers @@ -142,13 +142,13 @@ The , which is the control associated with this designer. Initializes the designer with the specified object. - to initialize the component for design. - - The base implementation will throw an exception if the associated control does not implement the interface. - + to initialize the component for design. + + The base implementation will throw an exception if the associated control does not implement the interface. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ContentDesigner.xml b/xml/System.Web.UI.Design.WebControls/ContentDesigner.xml index 6c866d51f61..0182fd098cc 100644 --- a/xml/System.Web.UI.Design.WebControls/ContentDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/ContentDesigner.xml @@ -67,11 +67,11 @@ Gets the object for this designer. The associated with this designer. - objects add elements to the for the control. - + objects add elements to the for the control. + ]]> Introduction to ASP.NET Control Designers @@ -127,11 +127,11 @@ Gets the markup that is used to represent the control at design time from the specified object. The markup that is used to represent the control at design time. - includes region identifiers. should add elements to the specified by the `regions` parameter. - + includes region identifiers. should add elements to the specified by the `regions` parameter. + ]]> Introduction to ASP.NET Control Designers @@ -162,11 +162,11 @@ Gets the content of the specified object. The persistence string for the content of the specified . - elements are defined in the and the design-time markup contains region identifiers, the method is used to return the content for each in the - + elements are defined in the and the design-time markup contains region identifiers, the method is used to return the content for each in the + ]]> Introduction to ASP.NET Control Designers @@ -194,11 +194,11 @@ Gets the inner markup of the control. The inner markup of the control. - Introduction to ASP.NET Control Designers @@ -228,15 +228,15 @@ The objects that represent the properties of the class of the component. The keys in the dictionary of properties are property names. When overridden in a derived class, allows a designer to change or remove items from the set of properties that it exposes through a object. - . - - The keys in the dictionary of properties are the names of the properties. The objects are of type . - - In this overridden method, the designer clears all properties except and . - + . + + The keys in the dictionary of properties are the names of the properties. The objects are of type . + + In this overridden method, the designer clears all properties except and . + ]]> @@ -270,15 +270,15 @@ The objects that represent the events of the class of the component. The keys in the dictionary of events are event names. When overridden in a derived class, allows a designer to add items to the set of events that it exposes through a object. - . - - The keys in the dictionary of events are the names of the events. The objects are of type . - - In this overridden method, the designer clears all events for this control. - + . + + The keys in the dictionary of events are the names of the events. The objects are of type . + + In this overridden method, the designer clears all events for this control. + ]]> @@ -314,13 +314,13 @@ The persistence string for the content. Sets the content of the specified object. - elements are defined in the and the design-time markup contains region identifiers, the method is used to set the content for each in the . - + elements are defined in the and the design-time markup contains region identifiers, the method is used to set the content for each in the . + ]]> Introduction to ASP.NET Control Designers diff --git a/xml/System.Web.UI.Design.WebControls/CreateUserWizardDesigner.xml b/xml/System.Web.UI.Design.WebControls/CreateUserWizardDesigner.xml index 918390b7e14..369ce486a45 100644 --- a/xml/System.Web.UI.Design.WebControls/CreateUserWizardDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/CreateUserWizardDesigner.xml @@ -199,7 +199,7 @@ method to display debugging information on the design surface in case of an error. + The following code example demonstrates how to override the method to display debugging information on the design surface in case of an error. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/WebNet.Design.WebControls.CreateUserWizardDesigner/CS/createuserdesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/WebNet.Design.WebControls.CreateUserWizardDesigner/VB/createuserdesigner.vb" id="Snippet1"::: @@ -263,7 +263,7 @@ method provides a way to add items to the dictionary of properties that a designer exposes. + The method provides a way to add items to the dictionary of properties that a designer exposes. The keys in the dictionary of properties are the names of the properties. The objects are of type . @@ -300,11 +300,11 @@ property is `true`, the designer uses a temporary copy of the wizard control to generate the design-time HTML; when the value of is `false`, the designer uses the wizard control itself to generate the design-time HTML. + When the value of the property is `true`, the designer uses a temporary copy of the wizard control to generate the design-time HTML; when the value of is `false`, the designer uses the wizard control itself to generate the design-time HTML. - The value of modifies the return value of the designer's property. When is `true`, returns a copy of the wizard control. When is `false`, returns the wizard control itself. + The value of modifies the return value of the designer's property. When is `true`, returns a copy of the wizard control. When is `false`, returns the wizard control itself. - If the wizard control is marked with a class-level attribute, the is ignored, because the value of is always `true`. + If the wizard control is marked with a class-level attribute, the is ignored, because the value of is always `true`. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/DataBoundControlDesigner.xml b/xml/System.Web.UI.Design.WebControls/DataBoundControlDesigner.xml index 2d50e39fb95..fecedd18914 100644 --- a/xml/System.Web.UI.Design.WebControls/DataBoundControlDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/DataBoundControlDesigner.xml @@ -24,11 +24,11 @@ Provides a base class for design-time support for controls that derive from . - class if you want to create a designer for the Web server control or for a class that extends . - + class if you want to create a designer for the Web server control or for a class that extends . + ]]> @@ -298,11 +298,11 @@ to release both managed and unmanaged resources; to release only unmanaged resources. Releases the unmanaged resources used by the object and optionally releases the managed resources. - method unregisters the designer's event handlers from all data source events. - + method unregisters the designer's event handlers from all data source events. + ]]> @@ -386,11 +386,11 @@ An object containing the properties to filter. Overridden by the designer to shadow run-time properties of the data-bound control with corresponding properties implemented by the designer. - method to perform any additional actions required when the data source of the underlying data-bound control changes. - + method to perform any additional actions required when the data source of the underlying data-bound control changes. + ]]> @@ -453,11 +453,11 @@ if the designer can refresh the data source; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Introduction to ASP.NET Control Designers @@ -490,11 +490,11 @@ Indicates whether to suppress any events raised while refreshing the schema. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Introduction to ASP.NET Control Designers @@ -524,11 +524,11 @@ For a description of this member, see . An object that describes the data source. - instance is cast to an interface. - + instance is cast to an interface. + ]]> Introduction to ASP.NET Control Designers @@ -559,11 +559,11 @@ For a description of this member, see . The selected data member from the selected data source, if the control allows the user to select an object (such as a object) for the data source, and provides a property to select a particular list (or object) within the data source. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -595,11 +595,11 @@ For a description of this member, see . An object implementing an interface containing the design-time property of the associated control, or if a data source is not found. - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/DataControlFieldDesigner.xml b/xml/System.Web.UI.Design.WebControls/DataControlFieldDesigner.xml index f12a809d10f..3b03b0402e6 100644 --- a/xml/System.Web.UI.Design.WebControls/DataControlFieldDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/DataControlFieldDesigner.xml @@ -127,11 +127,11 @@ When overridden in a derived class, creates a field for the specified data field. The new template field. - method is invoked when you click on the link to convert a data field into a in the fields editor. - + method is invoked when you click on the link to convert a data field into a in the fields editor. + ]]> @@ -184,11 +184,11 @@ Gets an unique ID for a control that is created when a data field is converted into a . A unique ID for the control. - method is a helper method that can be used by the method to generate unique IDs for the controls that are created when you click the link to convert a data field into a in the fields editor. - + method is a helper method that can be used by the method to generate unique IDs for the controls that are created when you click the link to convert a data field into a in the fields editor. + ]]> @@ -299,11 +299,11 @@ Gets a object for the specified data field. The new template field. - method is a helper method that can be used by the method to create a new object and initialize its properties using the specified data field properties. - + method is a helper method that can be used by the method to create a new object and initialize its properties using the specified data field properties. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/DataGridDesigner.xml b/xml/System.Web.UI.Design.WebControls/DataGridDesigner.xml index 380b6c39850..730569d4b8d 100644 --- a/xml/System.Web.UI.Design.WebControls/DataGridDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/DataGridDesigner.xml @@ -27,7 +27,7 @@ class. The code overrides the method to customize the , , and properties when the control is rendered on a design surface. + The following code example demonstrates how to extend the class. The code overrides the method to customize the , , and properties when the control is rendered on a design surface. :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataListDesigner_Sample2/VB/simpledatalistdesigner.vb" id="Snippet1"::: @@ -156,7 +156,7 @@ method releases all the resources held by the managed objects that this object references. + When the `disposing` parameter is `true`, the method releases all the resources held by the managed objects that this object references. ]]> @@ -229,13 +229,13 @@ method to alter the appearance of the control on the design surface. + The following code example shows how to override the method to alter the appearance of the control on the design surface. The code uses `Try...Catch...Finally` syntax to do the following: - The `Try` section changes the values of the properties of the data grid control. -- The `Catch` section catches any exceptions and sends them to the method. +- The `Catch` section catches any exceptions and sends them to the method. - The `Finally` section sets the properties to their original values. @@ -305,7 +305,7 @@ method to modify the appearance of the control on the design surface when an exception occurs. + The following code example shows how to override the method to modify the appearance of the control on the design surface when an exception occurs. This code example is part of a larger example provided for the class. @@ -352,7 +352,7 @@ method is obsolete. To access the template metadata, see . + The method is obsolete. To access the template metadata, see . ]]> @@ -436,7 +436,7 @@ method is obsolete. To access the template metadata, see . + The method is obsolete. To access the template metadata, see . ]]> @@ -473,7 +473,7 @@ method to ensure that the designer is only initialized with instances of the `SimpleDataGrid` class. + The following code example shows how to override the method to ensure that the designer is only initialized with instances of the `SimpleDataGrid` class. This code example is part of a larger example provided for the class. diff --git a/xml/System.Web.UI.Design.WebControls/DataListDesigner.xml b/xml/System.Web.UI.Design.WebControls/DataListDesigner.xml index fcf7d918ef3..7e8810dfae4 100644 --- a/xml/System.Web.UI.Design.WebControls/DataListDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/DataListDesigner.xml @@ -27,7 +27,7 @@ class. The code overrides the method to display a five-point border that is purple if the control is enabled. + The following code example demonstrates how to extend the class. The code overrides the method to display a five-point border that is purple if the control is enabled. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridDesigner_Sample2/CS/SimpleGridView.cs" id="Snippet10"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataGridDesigner_Sample2/CS/SimpleGridView.cs" id="Snippet1"::: @@ -156,7 +156,7 @@ and . + Rather than using editing frames, use template groups and designer editing regions. For more information, see and . ]]> @@ -193,7 +193,7 @@ method releases all resources held by the managed objects that this object references. + When `disposing` is `true`, the method releases all resources held by the managed objects that this object references. ]]> @@ -237,7 +237,7 @@ and . + Rather than using editing frames, use template groups and designer editing regions. For more information, see and . ]]> @@ -271,13 +271,13 @@ method. It alters the appearance of the control on the design surface if the control's property is `true`. + The following code example shows how to override the method. It alters the appearance of the control on the design surface if the control's property is `true`. The code uses `Try...Catch...Finally` syntax to do the following: - The `Try` section changes the values of the properties of the control. -- The `Catch` section catches any exceptions and sends them to the method. +- The `Catch` section catches any exceptions and sends them to the method. - The `Finally` section sets the properties to their original values. @@ -346,7 +346,7 @@ method to modify the appearance of the control on the design surface when an exception occurs. + The following code example shows how to override the method to modify the appearance of the control on the design surface when an exception occurs. This code example is part of a larger example provided for the class. @@ -393,7 +393,7 @@ method is obsolete. To access the template metadata, see . + The method is obsolete. To access the template metadata, see . ]]> @@ -442,7 +442,7 @@ and . + Rather than using editing frames, use template groups and designer editing regions. For more information, see and . ]]> @@ -478,7 +478,7 @@ method to ensure that the designer is initialized only with instances of the `SimpleDataList` class. + The following code example shows how to override the method to ensure that the designer is initialized only with instances of the `SimpleDataList` class. This code example is part of a larger example provided for the class. @@ -515,7 +515,7 @@ method to perform additional actions that might be required when new schema becomes available. + Override the method to perform additional actions that might be required when new schema becomes available. ]]> @@ -546,7 +546,7 @@ and . + Rather than using editing verbs, use template groups and designer editing regions. For more information, see and . ]]> @@ -593,7 +593,7 @@ and . + Rather than using editing verbs, use template groups and designer editing regions. For more information, see and . ]]> diff --git a/xml/System.Web.UI.Design.WebControls/DataPagerDesigner.xml b/xml/System.Web.UI.Design.WebControls/DataPagerDesigner.xml index 9b4bdbcb47e..d2ad458ae18 100644 --- a/xml/System.Web.UI.Design.WebControls/DataPagerDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/DataPagerDesigner.xml @@ -34,11 +34,11 @@ The methods of the class provide the following functionality: -- The and methods return the HTML markup that is used to render the associated at design time. +- The and methods return the HTML markup that is used to render the associated at design time. -- The method prepares the designer to view, edit, and design the associated control. +- The method prepares the designer to view, edit, and design the associated control. -- The method is used to add or remove properties from the properties grid for the control. +- The method is used to add or remove properties from the properties grid for the control. ]]> @@ -128,7 +128,7 @@ collection is not empty, the method refreshes the object to force the method to be called and then calls its base implementation. If the collection is empty, the method invokes the method to generate the markup. + If the collection is not empty, the method refreshes the object to force the method to be called and then calls its base implementation. If the collection is empty, the method invokes the method to generate the markup. ]]> @@ -164,7 +164,7 @@ method is used by the designer to render the control at design time if the collection is empty. The method calls the method to create a placeholder that displays the type and the ID of the control, and additional instructions for the user. + The method is used by the designer to render the control at design time if the collection is empty. The method calls the method to create a placeholder that displays the type and the ID of the control, and additional instructions for the user. ]]> @@ -199,7 +199,7 @@ method when it is ready to use the designer to render the control. The method and its base methods configure properties and connect to events that are required for the designer. + The designer host calls the method when it is ready to use the designer to render the control. The method and its base methods configure properties and connect to events that are required for the designer. The `component` parameter is the control that is associated with this designer, or a copy of the control. @@ -260,7 +260,7 @@ method adds a new property to the property grid of the control that corresponds to the property. If the property is set to `true`, the method also sets the attribute of the property to `BrowsableAttribute.No`. This prevents pager fields from being deleted by using the `Fields` dialog box when a templated pager field is in template mode. + The method adds a new property to the property grid of the control that corresponds to the property. If the property is set to `true`, the method also sets the attribute of the property to `BrowsableAttribute.No`. This prevents pager fields from being deleted by using the `Fields` dialog box when a templated pager field is in template mode. ]]> @@ -297,7 +297,7 @@ property creates a collection of objects that represent the template elements in a control at design time. It adds one element to the collection for each object in the collection of the associated control. + The property creates a collection of objects that represent the template elements in a control at design time. It adds one element to the collection for each object in the collection of the associated control. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/DataPagerFieldTypeEditor.xml b/xml/System.Web.UI.Design.WebControls/DataPagerFieldTypeEditor.xml index 7f248473930..261268126ad 100644 --- a/xml/System.Web.UI.Design.WebControls/DataPagerFieldTypeEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/DataPagerFieldTypeEditor.xml @@ -125,7 +125,7 @@ method and will always return `UITypeEditorEditStyle.Modal`. + This method indicates the editor style that is used by the method and will always return `UITypeEditorEditStyle.Modal`. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/DataProviderNameConverter.xml b/xml/System.Web.UI.Design.WebControls/DataProviderNameConverter.xml index 06aec42d427..7d32fc92510 100644 --- a/xml/System.Web.UI.Design.WebControls/DataProviderNameConverter.xml +++ b/xml/System.Web.UI.Design.WebControls/DataProviderNameConverter.xml @@ -17,15 +17,15 @@ Creates a user-selectable list of ActiveX® Data Objects (ADO) for the .NET Framework (ADO.NET) provider names. - class is a object that is typically referenced by the attribute. - - The names that are returned by the method are of ADO.NET providers, from the method, that create data objects. - - The method gets a value indicating whether the returned provider names are an exclusive list of possible values. The method gets a value indicating whether the returned provider names are a standard set of values that can be picked from a list. - + class is a object that is typically referenced by the attribute. + + The names that are returned by the method are of ADO.NET providers, from the method, that create data objects. + + The method gets a value indicating whether the returned provider names are an exclusive list of possible values. The method gets a value indicating whether the returned provider names are a standard set of values that can be picked from a list. + ]]> @@ -57,11 +57,11 @@ Initializes a new instance of the class. - class when the class is referenced by a attribute. - + class when the class is referenced by a attribute. + ]]> @@ -94,13 +94,13 @@ Returns a list of the available ActiveX® Data Objects (ADO) for the .NET Framework (ADO.NET) provider names. A containing the names of the available ADO.NET providers. - method uses the method to return a object containing the ADO.NET provider names. It converts this to a string array, and then converts this array to a object. - - The `context` parameter is not used by the . - + method uses the method to return a object containing the ADO.NET provider names. It converts this to a string array, and then converts this array to a object. + + The `context` parameter is not used by the . + ]]> @@ -133,13 +133,13 @@ Gets a value indicating whether the returned ActiveX® Data Objects (ADO) for the .NET Framework (ADO.NET) provider names are an exclusive list of possible values. Always . - class and override the method to return an exclusive list of ADO.NET provider names, also override the method to return `true` when the provider name list is exclusive. - - The `context` parameter is not used by the . - + class and override the method to return an exclusive list of ADO.NET provider names, also override the method to return `true` when the provider name list is exclusive. + + The `context` parameter is not used by the . + ]]> @@ -171,11 +171,11 @@ Gets a value indicating whether this object returns a standard set of ActiveX® Data Objects (ADO) for the .NET Framework (ADO.NET) provider names that can be picked from a list. Always . - method. - + method. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/DataSourceIDConverter.xml b/xml/System.Web.UI.Design.WebControls/DataSourceIDConverter.xml index d3890636cdd..361feccee19 100644 --- a/xml/System.Web.UI.Design.WebControls/DataSourceIDConverter.xml +++ b/xml/System.Web.UI.Design.WebControls/DataSourceIDConverter.xml @@ -17,19 +17,19 @@ Creates a user-selectable list of data source names. - class is a object that is typically referenced by the attribute. - - The data source names that are returned by the method are of components from the container of the specified context that are valid data sources. - - The method gets a value indicating whether the returned data source names are an exclusive list of possible values. The method gets a value indicating whether the data source names are a standard set of values that can be picked from a list. - - The method converts the specified object to the native type of the converter. The method gets a value indicating whether this can convert an object in the specified source type to the native type. - - The method indicates whether the specified component implements the interface. - + class is a object that is typically referenced by the attribute. + + The data source names that are returned by the method are of components from the container of the specified context that are valid data sources. + + The method gets a value indicating whether the returned data source names are an exclusive list of possible values. The method gets a value indicating whether the data source names are a standard set of values that can be picked from a list. + + The method converts the specified object to the native type of the converter. The method gets a value indicating whether this can convert an object in the specified source type to the native type. + + The method indicates whether the specified component implements the interface. + ]]> @@ -60,11 +60,11 @@ Initializes a new instance of the class. - class when the class is referenced by a attribute. - + class when the class is referenced by a attribute. + ]]> @@ -99,13 +99,13 @@ if is a string; otherwise, . - method can only convert from a string, so the only returns `true` when `sourcetype` is a string. - - The does not use the `context` parameter. - + method can only convert from a string, so the only returns `true` when `sourcetype` is a string. + + The does not use the `context` parameter. + ]]> @@ -141,13 +141,13 @@ Converts the specified object to the native type of the converter. The parameter is returned as a string. - is thrown. - - The method does not use the `context` or `culture` parameter. - + is thrown. + + The method does not use the `context` or `culture` parameter. + ]]> @@ -181,11 +181,11 @@ Returns a list of the available data source names. A containing the names of the controls that implement the interface and are available for use in the given context. - method creates a list of the names of the components that are valid data sources in the container of the object that is specified by the `context` parameter. It then converts that list to a object. - + method creates a list of the names of the components that are valid data sources in the container of the object that is specified by the `context` parameter. It then converts that list to a object. + ]]> @@ -223,13 +223,13 @@ Gets a value indicating whether the returned data source names are an exclusive list of possible values. Always . - class and override the method to return an exclusive list of data source names, also override the method to return `true` when the data source name list is exclusive. - - The `context` parameter is not used by the . - + class and override the method to return an exclusive list of data source names, also override the method to return `true` when the data source name list is exclusive. + + The `context` parameter is not used by the . + ]]> @@ -261,11 +261,11 @@ Gets a value indicating whether this object returns a standard set of data source names that can be picked from a list. Always . - method. - + method. + ]]> @@ -298,11 +298,11 @@ if is a valid data source; otherwise, . - method considers the `component` parameter to be a valid data source if it implements the interface. - + method considers the `component` parameter to be a valid data source if it implements the interface. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/DetailsViewDesigner.xml b/xml/System.Web.UI.Design.WebControls/DetailsViewDesigner.xml index 0bd6eb64c9c..6019e05cdd9 100644 --- a/xml/System.Web.UI.Design.WebControls/DetailsViewDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/DetailsViewDesigner.xml @@ -34,19 +34,19 @@ The class methods provide the following functionality: -- The method binds the associated control to a design-time data source. +- The method binds the associated control to a design-time data source. -- The method returns the markup that is used to render the associated at design time. +- The method returns the markup that is used to render the associated at design time. -- The method prepares the designer to view, edit, and design the associated . +- The method prepares the designer to view, edit, and design the associated . -- The method is called when a region of the design-time view of the associated is clicked. +- The method is called when a region of the design-time view of the associated is clicked. -- The method is called when the schema of the data source of the associated changes. +- The method is called when the schema of the data source of the associated changes. -- The method is used to remove or add additional properties or to shadow properties of the associated . +- The method is used to remove or add additional properties or to shadow properties of the associated . - Design-time editable regions are not supported in the control, so the and methods have no functionality. + Design-time editable regions are not supported in the control, so the and methods have no functionality. @@ -55,7 +55,7 @@ The example derives the `MyDetailsView` control from the . The `MyDetailsView` is simply a copy of the control. The example also derives the `MyDetailsViewDesigner` class from and places a object for `MyDetailsViewDesigner` on the `MyDetailsView` control. - `The MyDetailsViewDesigner` overrides the property to specify that the pager row of the design-time view of the `MyDetailsView` contain five page links. It overrides the method to make the property visible in the **Property** grid at design time. It overrides the method to include the property, if it is specified, as a new first row in the `MyDetailsView` grid at design time. If the property of the `MyDetailsView` is the or value, the draws a blue dashed border around the control to make its extent more visible. + `The MyDetailsViewDesigner` overrides the property to specify that the pager row of the design-time view of the `MyDetailsView` contain five page links. It overrides the method to make the property visible in the **Property** grid at design time. It overrides the method to include the property, if it is specified, as a new first row in the `MyDetailsView` grid at design time. If the property of the `MyDetailsView` is the or value, the draws a blue dashed border around the control to make its extent more visible. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DetailsViewDesigner/CS/detailsviewdesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DetailsViewDesigner/VB/detailsviewdesigner.vb" id="Snippet1"::: @@ -190,7 +190,7 @@ method binds the associated control to the design-time data source and calculates the number of pager and automatically generated rows that are required, based on features that are specified for the . + The method binds the associated control to the design-time data source and calculates the number of pager and automatically generated rows that are required, based on features that are specified for the . The `dataBoundControl` parameter represents the control that is associated with this designer, or a copy of that control. @@ -235,12 +235,12 @@ method sets the property of the control to `true`, if the collection is empty. The then sets the collection of the control to an empty array if the schema of the data source cannot be obtained. It refreshes the object to force the method to be called. It then calls the base method to generate the markup. + First, the method sets the property of the control to `true`, if the collection is empty. The then sets the collection of the control to an empty array if the schema of the data source cannot be obtained. It refreshes the object to force the method to be called. It then calls the base method to generate the markup. ## Examples - The following code example shows how to override the method in a class inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from is the or value, the draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control. + The following code example shows how to override the method in a class inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from is the or value, the draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DetailsViewDesigner/CS/detailsviewdesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DetailsViewDesigner/VB/detailsviewdesigner.vb" id="Snippet4"::: @@ -283,14 +283,14 @@ method calls the method to generate the markup for the design-time rendering of the control. The method also populates `regions` with a object for each clickable or selectable region of the design-time rendering. + The method calls the method to generate the markup for the design-time rendering of the control. The method also populates `regions` with a object for each clickable or selectable region of the design-time rendering. For the , the first cell in each row is selectable; all the cells in the rows are clickable. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from the is the or value, the draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from the is the or value, the draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DetailsViewDesigner/CS/detailsviewdesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DetailsViewDesigner/VB/detailsviewdesigner.vb" id="Snippet4"::: @@ -365,7 +365,7 @@ method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. + The designer host calls the method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. The `component` parameter represents the control that is associated with this designer or a copy of that control. @@ -404,7 +404,7 @@ method saves the selected region index and updates the markup that renders the control on the design surface. + The method saves the selected region index and updates the markup that renders the control on the design surface. ]]> @@ -437,7 +437,7 @@ method calls the method, which in turn calls the method to update the control to reflect the data source change. + Unless the designer is in template editing mode or a field is being added or edited, the method calls the method, which in turn calls the method to update the control to reflect the data source change. ]]> @@ -472,14 +472,14 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the `Properties` grid. + Control designers use methods derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the `Properties` grid. - For the control, the method sets the object of the property to `false` when the control is in template mode. This ensures that a column that is in template mode cannot be deleted using the `Fields` dialog box. + For the control, the method sets the object of the property to `false` when the control is in template mode. This ensures that a column that is in template mode cannot be deleted using the `Fields` dialog box. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the `Properties` grid of the control at design time. The example makes the property visible in the `Properties` grid. + The following code example shows how to override the method in a class that is inherited from the class to change the `Properties` grid of the control at design time. The example makes the property visible in the `Properties` grid. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DetailsViewDesigner/CS/detailsviewdesigner.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DetailsViewDesigner/VB/detailsviewdesigner.vb" id="Snippet3"::: @@ -565,7 +565,7 @@ method has no functionality; there is no support for editable regions in the design-time view of the control. + The method has no functionality; there is no support for editable regions in the design-time view of the control. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/EmbeddedMailObjectCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/EmbeddedMailObjectCollectionEditor.xml index b12d71b1823..474bf1ba6c7 100644 --- a/xml/System.Web.UI.Design.WebControls/EmbeddedMailObjectCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/EmbeddedMailObjectCollectionEditor.xml @@ -17,17 +17,17 @@ Provides a component editor for embedded mail object collections in a object. - class provides a user interface for editing the elements of the object of objects. - - The objects define the content and format of the email notification messages that are sent by the , , , and other controls. The elements define the embedded objects within these email messages. - - The is invoked by selecting the ellipsis (**…**) button on the **EmbeddedObjects** property, under **MailDefinition**, in the **Properties** grid of the visual designer. - - The method edits the value of the specified object using the specified service provider and context. - + class provides a user interface for editing the elements of the object of objects. + + The objects define the content and format of the email notification messages that are sent by the , , , and other controls. The elements define the embedded objects within these email messages. + + The is invoked by selecting the ellipsis (**…**) button on the **EmbeddedObjects** property, under **MailDefinition**, in the **Properties** grid of the visual designer. + + The method edits the value of the specified object using the specified service provider and context. + ]]> @@ -64,11 +64,11 @@ The of the collection to edit. Initializes a new instance of the class. - class when the user selects the ellipsis (**…**) button on the **EmbeddedObjects** property, under **MailDefinition**, in the **Properties** grid of the visual designer, when designing a , , , or other control that encapsulates a object. - + class when the user selects the ellipsis (**…**) button on the **EmbeddedObjects** property, under **MailDefinition**, in the **Properties** grid of the visual designer, when designing a , , , or other control that encapsulates a object. + ]]> @@ -106,11 +106,11 @@ Edits the value of the specified object using the specified service provider and context. The new ; otherwise, if the value of the object has not changed, unchanged. - method calls the method of the `context` parameter, and then calls the base method. Exceptions that are thrown are propagated back to the caller. The method of `context` is called when the editing is complete. - + method calls the method of the `context` parameter, and then calls the base method. Exceptions that are thrown are propagated back to the caller. The method of `context` is called when the editing is complete. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/EntityDataSourceDesigner.xml b/xml/System.Web.UI.Design.WebControls/EntityDataSourceDesigner.xml index 6be1b4476eb..c81f568b9b1 100644 --- a/xml/System.Web.UI.Design.WebControls/EntityDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/EntityDataSourceDesigner.xml @@ -428,11 +428,11 @@ The properties to be filtered. Used by the designer to add properties or remove properties in the properties grid, or to shadow properties of the associated control. - . - + . + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/FormViewDesigner.xml b/xml/System.Web.UI.Design.WebControls/FormViewDesigner.xml index 306331852d3..52eabb2e08f 100644 --- a/xml/System.Web.UI.Design.WebControls/FormViewDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/FormViewDesigner.xml @@ -34,11 +34,11 @@ The class methods provide the following functionality: -- The method returns the markup that is used to render the associated at design time. +- The method returns the markup that is used to render the associated at design time. -- The method prepares the designer to view, edit, and design the associated . +- The method prepares the designer to view, edit, and design the associated . -- The method is called when the schema of the data source for the associated changes. +- The method is called when the schema of the data source for the associated changes. @@ -51,7 +51,7 @@ - The property to specify that the pager row for the design-time view of the `MyFormView` contain four page links. -- The method to include the property, if it is specified, as a new first row in the `MyFormView` grid at design time. If the property of the `MyFormView` is the or value, the draws a blue dashed border around the control to make its extent more visible. +- The method to include the property, if it is specified, as a new first row in the `MyFormView` grid at design time. If the property of the `MyFormView` is the or value, the draws a blue dashed border around the control to make its extent more visible. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.FormViewDesigner/CS/formviewdesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.FormViewDesigner/VB/formviewdesigner.vb" id="Snippet1"::: @@ -187,14 +187,14 @@ control, the method sets the collection of the control to an empty array if the schema for the data source cannot be obtained. The refreshes the object to force a call to the method. The then calls the base method to generate the markup. + If an item template has been defined for the control, the method sets the collection of the control to an empty array if the schema for the data source cannot be obtained. The refreshes the object to force a call to the method. The then calls the base method to generate the markup. - If no item template has been defined for the control, the calls the method to generate markup that renders to a placeholder. + If no item template has been defined for the control, the calls the method to generate markup that renders to a placeholder. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from the is the or value, the draws a blue dashed border around the control to make its extent more visible. The example does not change the run-time appearance of the control. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from the is the or value, the draws a blue dashed border around the control to make its extent more visible. The example does not change the run-time appearance of the control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.FormViewDesigner/CS/formviewdesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.FormViewDesigner/VB/formviewdesigner.vb" id="Snippet4"::: @@ -238,7 +238,7 @@ control does not include one of the item templates, the method calls the method, which generates the markup for a placeholder that contains instructions on how to edit template content and a message that an item template is required. + If the markup for the control does not include one of the item templates, the method calls the method, which generates the markup for a placeholder that contains instructions on how to edit template content and a message that an item template is required. ]]> @@ -275,7 +275,7 @@ method when it is ready to use the designer to render the control. The and its base methods configure properties and connect to events that are necessary for the operation of the designer. + The designer host calls the method when it is ready to use the designer to render the control. The and its base methods configure properties and connect to events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer or a copy of the control. @@ -312,7 +312,7 @@ method calls the method, which in turn calls the method to update the control to reflect the data source change. + Unless the designer is in template editing mode or a field is being added or edited, the method calls the method, which in turn calls the method to update the control to reflect the data source change. ]]> @@ -398,7 +398,7 @@ always returns `2`. This causes two page links to be displayed in the pager row of the control at design time, if the mode is numeric. + The always returns `2`. This causes two page links to be displayed in the pager row of the control at design time, if the mode is numeric. diff --git a/xml/System.Web.UI.Design.WebControls/GridViewDesigner.xml b/xml/System.Web.UI.Design.WebControls/GridViewDesigner.xml index b3b6b6cc6a7..b36fcfdcedb 100644 --- a/xml/System.Web.UI.Design.WebControls/GridViewDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/GridViewDesigner.xml @@ -34,19 +34,19 @@ The methods of the class provide the following functionality: -- The method binds the associated control to a design-time data source. +- The method binds the associated control to a design-time data source. -- The method returns the markup that is used to render the associated at design time. +- The method returns the markup that is used to render the associated at design time. -- The method prepares the designer to view, edit, and design the associated . +- The method prepares the designer to view, edit, and design the associated . -- The method is called when a region of the design-time view of the associated is clicked. +- The method is called when a region of the design-time view of the associated is clicked. -- The method is called when the schema of the data source of the associated changes. +- The method is called when the schema of the data source of the associated changes. -- The method is used to remove or add properties or to shadow properties of the associated . +- The method is used to remove or add properties or to shadow properties of the associated . - Design-time editable regions are not supported in the control, so the and methods have no functionality. + Design-time editable regions are not supported in the control, so the and methods have no functionality. @@ -55,7 +55,7 @@ The example derives the `MyGridView` control from the . The `MyGridView` is simply a copy of the . The example also derives the `MyGridViewDesigner` class from the class and places a object for the `MyGridViewDesigner` on the `MyGridView` control. - The `MyGridViewDesigner` overrides the method to make the property visible in the **Properties** grid at design time. It overrides the method to include the property, if it is specified, as a new first row in the `MyGridView` control at design time. If the property of the `MyGridView` control has the or value, the draws a blue dashed border around the control to make its extent more visible. + The `MyGridViewDesigner` overrides the method to make the property visible in the **Properties** grid at design time. It overrides the method to include the property, if it is specified, as a new first row in the `MyGridView` control at design time. If the property of the `MyGridView` control has the or value, the draws a blue dashed border around the control to make its extent more visible. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.GridViewDesigner/CS/gridviewdesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.GridViewDesigner/VB/gridviewdesigner.vb" id="Snippet1"::: @@ -190,7 +190,7 @@ method binds the associated control to the design-time data source and assigns a unique value to the field of each cell of the control's design-time rendering. + The method binds the associated control to the design-time data source and assigns a unique value to the field of each cell of the control's design-time rendering. The `dataBoundControl` parameter is the control that is associated with this designer, or a copy of that control. @@ -241,14 +241,14 @@ 2. Sets the property of the control to `null`, if the schema of the data source cannot be obtained. -3. Refreshes the object to force the method to be called. +3. Refreshes the object to force the method to be called. 4. Calls the base method to generate the markup. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from the class has the or value, the draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from the class has the or value, the draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.GridViewDesigner/CS/gridviewdesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.GridViewDesigner/VB/gridviewdesigner.vb" id="Snippet4"::: @@ -291,14 +291,14 @@ method calls the method to generate the markup for the design-time rendering of the control. The also populates `regions` with a object for each clickable or selectable region of the design-time rendering. + The method calls the method to generate the markup for the design-time rendering of the control. The also populates `regions` with a object for each clickable or selectable region of the design-time rendering. For the , the first cell in each row is selectable; all the cells in the rows are clickable. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from the class has the or value, the draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The example adds a new first row to the grid to contain the property, if the is defined. If the property of the control that is derived from the class has the or value, the draws a blue dashed border around the control to make its extent more visible. It does not change the run-time appearance of the control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.GridViewDesigner/CS/gridviewdesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.GridViewDesigner/VB/gridviewdesigner.vb" id="Snippet4"::: @@ -374,7 +374,7 @@ method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. + The designer host calls the method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer, or a copy of the control. @@ -413,7 +413,7 @@ method saves the selected region index and updates the markup that renders the control on the design surface. + The method saves the selected region index and updates the markup that renders the control on the design surface. ]]> @@ -446,7 +446,7 @@ method calls the method, which in turn calls the method to update the control to reflect the data source change. + Unless the designer is in template-editing mode or a field is being added or edited, the method calls the method, which in turn calls the method to update the control to reflect the data source change. ]]> @@ -481,14 +481,14 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. - For the control, the method sets the object of the property to `false` when the control is in template mode. This is so a column that is in template mode cannot be deleted using the **Fields** dialog box. + For the control, the method sets the object of the property to `false` when the control is in template mode. This is so a column that is in template mode cannot be deleted using the **Fields** dialog box. ## Examples - The following code example shows how to override the method in a class that is inherited from the to change the **Properties** grid of the control at design time. The example makes the property visible in the **Properties** grid. + The following code example shows how to override the method in a class that is inherited from the to change the **Properties** grid of the control at design time. The example makes the property visible in the **Properties** grid. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.GridViewDesigner/CS/gridviewdesigner.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.GridViewDesigner/VB/gridviewdesigner.vb" id="Snippet3"::: @@ -530,7 +530,7 @@ control allows paging and the property is greater than 0, the property returns the plus 1 (but not greater than 100). If the does not allow paging or the is 0, returns `5`. + If the associated control allows paging and the property is greater than 0, the property returns the plus 1 (but not greater than 100). If the does not allow paging or the is 0, returns `5`. ]]> @@ -566,7 +566,7 @@ method has no functionality; there is no support for editable regions in the design-time view of the control. + The method has no functionality; there is no support for editable regions in the design-time view of the control. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/HiddenFieldDesigner.xml b/xml/System.Web.UI.Design.WebControls/HiddenFieldDesigner.xml index 3fb50415891..7230bc6a156 100644 --- a/xml/System.Web.UI.Design.WebControls/HiddenFieldDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/HiddenFieldDesigner.xml @@ -22,7 +22,7 @@ ## Remarks In a visual designer, when the user switches from Source to Design view, the markup source code that describes a control is parsed and a design-time version of the control is created on the design surface. When the user switches back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The class provides design-time support for the in a visual designer. - The method returns the markup that is used to render the associated at design time. The method prepares the designer to view, edit, and design the associated . + The method returns the markup that is used to render the associated at design time. The method prepares the designer to view, edit, and design the associated . @@ -31,7 +31,7 @@ The example derives the `MyHiddenField` control from the . The `MyHiddenField` is a copy of the . The example also derives the `MyHiddenFieldDesigner` class from the class and applies a attribute for the `MyHiddenFieldDesigner` on the `MyHiddenField` control. - The `MyHiddenFieldDesigner` overrides the method to generate a placeholder that includes the property in the placeholder, along with the control class name and the property. + The `MyHiddenFieldDesigner` overrides the method to generate a placeholder that includes the property in the placeholder, along with the control class name and the property. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.HiddenFieldDesigner/CS/HiddenFieldDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.HiddenFieldDesigner/VB/HiddenFieldDesigner.vb" id="Snippet1"::: @@ -106,12 +106,12 @@ method generates the markup for a placeholder that includes the control class name and the property. + The method generates the markup for a placeholder that includes the control class name and the property. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The override generates a placeholder that includes the property in the placeholder, along with the control class name and the property. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of the control at design time. The override generates a placeholder that includes the property in the placeholder, along with the control class name and the property. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.HiddenFieldDesigner/CS/HiddenFieldDesigner.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.HiddenFieldDesigner/VB/HiddenFieldDesigner.vb" id="Snippet3"::: @@ -153,7 +153,7 @@ method when it is ready to use the designer to render the control. The and its base methods configure properties and connect to events that are necessary for the operation of the designer. + The designer calls the method when it is ready to use the designer to render the control. The and its base methods configure properties and connect to events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer or a copy of the control. diff --git a/xml/System.Web.UI.Design.WebControls/HierarchicalDataBoundControlDesigner.xml b/xml/System.Web.UI.Design.WebControls/HierarchicalDataBoundControlDesigner.xml index 145bda8f76d..415865f37cd 100644 --- a/xml/System.Web.UI.Design.WebControls/HierarchicalDataBoundControlDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/HierarchicalDataBoundControlDesigner.xml @@ -34,19 +34,19 @@ The class methods provide the following functionality: -- The method performs the actions that are necessary to connect to the current data source. +- The method performs the actions that are necessary to connect to the current data source. -- The method creates a new data source for the associated control. +- The method creates a new data source for the associated control. -- The method binds the associated control that is derived from the class to a design-time data source. +- The method binds the associated control that is derived from the class to a design-time data source. -- The method performs the actions that are necessary to disconnect from the current data source. +- The method performs the actions that are necessary to disconnect from the current data source. -- The method gets a data source that can be used at design time for the associated control. +- The method gets a data source that can be used at design time for the associated control. -- The method constructs a sample data source that can be used at design time for the associated control. +- The method constructs a sample data source that can be used at design time for the associated control. -- The method is used to remove properties from or add additional properties to or to shadow properties of the associated control that is derived from the class. +- The method is used to remove properties from or add additional properties to or to shadow properties of the associated control that is derived from the class. @@ -55,7 +55,7 @@ The example derives the `MyHierarchicalDataBoundControl` class from the . The `MyHierarchicalDataBoundControl` class is simply a copy of the . The example also derives the `MyHierarchicalDataBoundControlDesigner` class from the class and places a object for the `MyHierarchicalDataBoundControlDesigner` on the `MyHierarchicalDataBoundControl` class. - The `MyHierarchicalDataBoundControlDesigner` overrides the method to make the property visible in the **Properties** grid at design time. It overrides the method to generate the markup for a placeholder if the design time markup is `null` or , or if the design-time markup is an empty `` block (that is, if there is no inner markup between the `` and `` tags). + The `MyHierarchicalDataBoundControlDesigner` overrides the method to make the property visible in the **Properties** grid at design time. It overrides the method to generate the markup for a placeholder if the design time markup is `null` or , or if the design-time markup is an empty `` block (that is, if there is no inner markup between the `` and `` tags). :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.HierarchicalDataBoundControlDesigner/CS/hierarchicaldatabounddesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.HierarchicalDataBoundControlDesigner/VB/hierarchicaldatabounddesigner.vb" id="Snippet1"::: @@ -162,7 +162,7 @@ method disconnects the and events from the previous data source, and then attaches these events to the new data source. + The method disconnects the and events from the previous data source, and then attaches these events to the new data source. ]]> @@ -195,7 +195,7 @@ method displays a dialog box that can be used to create a data source for the associated control that is derived from the class. + The method displays a dialog box that can be used to create a data source for the associated control that is derived from the class. ]]> @@ -229,7 +229,7 @@ method first sets the property of the control to reference the design-time data source and sets the property to `null`. The calls back to the method of the control that is derived from the class to bind to the design-time data source. Finally, it restores the original values of the and properties. + The method first sets the property of the control to reference the design-time data source and sets the property to `null`. The calls back to the method of the control that is derived from the class to bind to the design-time data source. Finally, it restores the original values of the and properties. The `dataBoundControl` parameter is the control that is derived from the class that is associated with this designer, or a copy of that control. @@ -338,7 +338,7 @@ method disconnects the and events from the current data source. + The method disconnects the and events from the current data source. ]]> @@ -405,7 +405,7 @@ method has a single node with an empty path. + The sample data constructed by the method has a single node with an empty path. ]]> @@ -440,14 +440,14 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. - For controls that are derived from the class, the method creates design-time properties to shadow the and properties. + For controls that are derived from the class, the method creates design-time properties to shadow the and properties. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the **Properties** grid of the control at design time. The example makes the property visible in the **Properties** grid. + The following code example shows how to override the method in a class that is inherited from the class to change the **Properties** grid of the control at design time. The example makes the property visible in the **Properties** grid. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.HierarchicalDataBoundControlDesigner/CS/hierarchicaldatabounddesigner.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.HierarchicalDataBoundControlDesigner/VB/hierarchicaldatabounddesigner.vb" id="Snippet3"::: diff --git a/xml/System.Web.UI.Design.WebControls/HierarchicalDataSourceIDConverter.xml b/xml/System.Web.UI.Design.WebControls/HierarchicalDataSourceIDConverter.xml index 9f42f7de39f..aa31fa84d1b 100644 --- a/xml/System.Web.UI.Design.WebControls/HierarchicalDataSourceIDConverter.xml +++ b/xml/System.Web.UI.Design.WebControls/HierarchicalDataSourceIDConverter.xml @@ -17,13 +17,13 @@ Creates a user-selectable list of hierarchical data source names. - class is a object that is typically referenced by the attribute. All members except the method are inherited from the . - - The method indicates whether the specified component implements the interface. - + class is a object that is typically referenced by the attribute. All members except the method are inherited from the . + + The method indicates whether the specified component implements the interface. + ]]> @@ -55,11 +55,11 @@ Initializes a new instance of the class. - class when the class is referenced by a attribute. - + class when the class is referenced by a attribute. + ]]> @@ -92,11 +92,11 @@ if is a valid data source; otherwise, . - method considers `component` a valid data source if it implements the interface. - + method considers `component` a valid data source if it implements the interface. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/HotSpotCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/HotSpotCollectionEditor.xml index 6f97dff9a6e..0187ef562fe 100644 --- a/xml/System.Web.UI.Design.WebControls/HotSpotCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/HotSpotCollectionEditor.xml @@ -24,7 +24,7 @@ The is invoked by selecting the ellipsis button (**…**) on the **HotSpots** property in the visual designer's **Properties** grid. - The method always returns `false` to indicate that only one object can be selected at a time in the editor. The method returns an array of types that the editor can create. The property returns the name of the Help topic that the editor displays. + The method always returns `false` to indicate that only one object can be selected at a time in the editor. The method returns an array of types that the editor can create. The property returns the name of the Help topic that the editor displays. ]]> @@ -95,7 +95,7 @@ method always returns `false`; thus, only one object can be selected at a time in the object. + The method always returns `false`; thus, only one object can be selected at a time in the object. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/HyperLinkDesigner.xml b/xml/System.Web.UI.Design.WebControls/HyperLinkDesigner.xml index d4ff9985d7c..99a5aa70653 100644 --- a/xml/System.Web.UI.Design.WebControls/HyperLinkDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/HyperLinkDesigner.xml @@ -31,14 +31,14 @@ In a visual designer, when you switch from Source to Design view, the markup source code that describes a control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The class provides design-time support for the control. - The method returns the markup that is used to render the associated control at design time. The method is called when there is a change to the associated control. + The method returns the markup that is used to render the associated control at design time. The method is called when there is a change to the associated control. ## Examples This section contains two code examples. The first one demonstrates how to derive a class from the class, override a method, and supply a property value. The second one demonstrates how to derive a control from the control and apply an attribute on the derived control. - The following code example shows how to derive a `CustomHyperLinkDesigner` class from the class. It overrides the method to supply a default value for the property if the original value for the is an empty string (""). This ensures that the associated control will be visible at design time. + The following code example shows how to derive a `CustomHyperLinkDesigner` class from the class. It overrides the method to supply a default value for the property if the original value for the is an empty string (""). This ensures that the associated control will be visible at design time. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/HyperLinkDesigner_Resubmit/CS/CustomHyperLinkDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/HyperLinkDesigner_Resubmit/VB/customhyperlinkdesigner.vb" id="Snippet1"::: @@ -119,12 +119,12 @@ method generates the design-time markup for the associated control. The method first saves local copies of the , , and properties, as well as the child collection. It provides default values for these properties if the original values are `null` or blank. The method then calls the base method to generate the markup and restores the properties and child control collection to their original values, if necessary. + The method generates the design-time markup for the associated control. The method first saves local copies of the , , and properties, as well as the child collection. It provides default values for these properties if the original values are `null` or blank. The method then calls the base method to generate the markup and restores the properties and child control collection to their original values, if necessary. ## Examples - The following code example shows how to derive the `CustomHyperLinkDesigner` class from the class. It overrides the method to supply a default value for the property if the original value for is an empty string (""). This ensures that the associated control will be visible at design time. + The following code example shows how to derive the `CustomHyperLinkDesigner` class from the class. It overrides the method to supply a default value for the property if the original value for is an empty string (""). This ensures that the associated control will be visible at design time. This code example is part of a larger example provided for the class. @@ -166,9 +166,9 @@ method is called when the event of the associated control is raised. Typically, this is in response to a property change on the control (for example, a **Properties** grid change). + The method is called when the event of the associated control is raised. Typically, this is in response to a property change on the control (for example, a **Properties** grid change). - The creates a object, and then calls the base method. + The creates a object, and then calls the base method. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/LabelDesigner.xml b/xml/System.Web.UI.Design.WebControls/LabelDesigner.xml index 974b48a0d09..525ca35453e 100644 --- a/xml/System.Web.UI.Design.WebControls/LabelDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/LabelDesigner.xml @@ -31,14 +31,14 @@ In a visual designer, when you switch from Source to Design view, the markup source code that describes a control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The class provides design-time support for the control. - The method is called when there is a change to the associated control. + The method is called when there is a change to the associated control. ## Examples The following code example shows how to derive the `SampleLabel` control from the control, and applies a attribute on the `SampleLabel` control to associate it with the `SampleLabelDesigner` class. - The code example also derives the `SampleLabelDesigner` from the class. It overrides the method to set the property to , if the original was the or value. This improves the visibility of the associated control at design time. + The code example also derives the `SampleLabelDesigner` from the class. It overrides the method to set the property to , if the original was the or value. This improves the visibility of the associated control at design time. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls_LabelDesignerExample/CS/CustomLabelDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls_LabelDesignerExample/VB/customlabeldesigner.vb" id="Snippet1"::: @@ -119,9 +119,9 @@ method is called when the event of the associated control is raised. Typically, this is in response to a property change on the control (for example, a **Properties** grid change). + The method is called when the event of the associated control is raised. Typically, this is in response to a property change on the control (for example, a **Properties** grid change). - The creates a object and calls the base method. + The creates a object and calls the base method. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/LinqDataSourceDesigner.xml b/xml/System.Web.UI.Design.WebControls/LinqDataSourceDesigner.xml index 3c20ba33fe4..9823cc082ea 100644 --- a/xml/System.Web.UI.Design.WebControls/LinqDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/LinqDataSourceDesigner.xml @@ -116,7 +116,7 @@ method can be called if the property of the associated control implements the interface. In that case, the property value is `true`. + The method can be called if the property of the associated control implements the interface. In that case, the property value is `true`. If the property is `true`, the **Configure Data Source** menu item is displayed in the **LinqDataSource Tasks** menu of the associated control on the visual designer surface. When this item is selected, the **Configure Data Source** wizard is started. @@ -152,7 +152,7 @@ method can be called if all the following conditions are true: + The method can be called if all the following conditions are true: - The property of the associated control implements the interface. @@ -160,7 +160,7 @@ If these conditions are true, the property value is `true`. - If the is `true`, the **Refresh Schema** menu item is displayed in the **LinqDataSource Tasks** menu of the associated control on the visual designer surface. + If the is `true`, the **Refresh Schema** menu item is displayed in the **LinqDataSource Tasks** menu of the associated control on the visual designer surface. ]]> @@ -193,9 +193,9 @@ method starts the **Configure Data Source** wizard on the visual designer surface. + The method starts the **Configure Data Source** wizard on the visual designer surface. - The method is called when the **Configure Data Source** menu item is selected on the **LinqDataSource Tasks** menu of the associated control. The **Configure Data Source** menu item appears on the **LinqDataSource Tasks** menu when the property is `true`. + The method is called when the **Configure Data Source** menu item is selected on the **LinqDataSource Tasks** menu of the associated control. The **Configure Data Source** menu item appears on the **LinqDataSource Tasks** menu when the property is `true`. ]]> @@ -697,7 +697,7 @@ method only if is `true`. + The design host calls the method only if is `true`. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ListControlDataBindingHandler.xml b/xml/System.Web.UI.Design.WebControls/ListControlDataBindingHandler.xml index 2ec32f9a862..3a7cf99639d 100644 --- a/xml/System.Web.UI.Design.WebControls/ListControlDataBindingHandler.xml +++ b/xml/System.Web.UI.Design.WebControls/ListControlDataBindingHandler.xml @@ -23,7 +23,7 @@ ## Remarks The class performs design-time data binding of a control. The class is referenced by the using the class. - The method performs the design-time data binding. + The method performs the design-time data binding. @@ -35,7 +35,7 @@ :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/ListControlDesigner_Samples/CS/SimpleRadioButtonList.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/ListControlDesigner_Samples/VB/simpleradiobuttonlist.vb" id="Snippet5"::: - The following code example shows how to derive the `SimpleRadioButtonListDataBindingHandler` class from the class. It overrides the method to add a message to the associated `SimpleRadioButtonList` control when that control is data bound. + The following code example shows how to derive the `SimpleRadioButtonListDataBindingHandler` class from the class. It overrides the method to add a message to the associated `SimpleRadioButtonList` control when that control is data bound. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/ListControlDesigner_Samples/CS/SimpleRadioButtonListDataBindingHandler.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/ListControlDesigner_Samples/VB/simpleradiobuttonlistdatabindinghandler.vb" id="Snippet6"::: @@ -118,12 +118,12 @@ control that is specified by `control` has a data source specified within its property, the method clears the collection of the , and then adds a string message indicating that the is data bound to the collection. + If the control that is specified by `control` has a data source specified within its property, the method clears the collection of the , and then adds a string message indicating that the is data bound to the collection. ## Examples - The following code example shows how to override the method to add a string message to the associated `SimpleRadioButtonList` control when that control is data bound. + The following code example shows how to override the method to add a string message to the associated `SimpleRadioButtonList` control when that control is data bound. This code example is part of a larger example provided for the class. diff --git a/xml/System.Web.UI.Design.WebControls/ListControlDesigner.xml b/xml/System.Web.UI.Design.WebControls/ListControlDesigner.xml index 53b4d963a5b..3b3cd803a7e 100644 --- a/xml/System.Web.UI.Design.WebControls/ListControlDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/ListControlDesigner.xml @@ -43,30 +43,30 @@ - The property returns a object, which typically contains an object that is derived from the object for each level in the inheritance tree of the designer. -- The and properties provide access to the corresponding properties of a control that is derived from the class. The and indicate the fields of the data source that provide the text and value content of the list items, respectively. +- The and properties provide access to the corresponding properties of a control that is derived from the class. The and indicate the fields of the data source that provide the text and value content of the list items, respectively. The class methods provide the following functionality: -- The method binds the associated control that is derived from the to a design-time data source. +- The method binds the associated control that is derived from the to a design-time data source. -- The method returns the markup that is used to render the associated control at design time. +- The method returns the markup that is used to render the associated control at design time. -- The method returns the design-time component from the associated control container. +- The method returns the design-time component from the associated control container. -- The method returns the from the control container, resolved to the design-time property of the control. +- The method returns the from the control container, resolved to the design-time property of the control. -- The method prepares the designer to view and design the associated control that is derived from the . +- The method prepares the designer to view and design the associated control that is derived from the . -- The method is called when the for the associated control has changed. +- The method is called when the for the associated control has changed. -- The method is used to remove additional properties from, add additional properties to, or shadow properties of the associated control that is derived from the . +- The method is used to remove additional properties from, add additional properties to, or shadow properties of the associated control that is derived from the . ## Examples This section provides two code examples. The first demonstrates how to derive a custom control designer. The second demonstrates how to associate a derived control with a designer. - The following code example shows how to create a class named `SimpleRadioButtonListDesigner` that inherits from the class. The `SimpleRadioButtonListDesigner` class overrides the , , and methods. The `SimpleRadioButtonListDesigner` class displays a `SimpleRadioButtonList` control on the design surface. + The following code example shows how to create a class named `SimpleRadioButtonListDesigner` that inherits from the class. The `SimpleRadioButtonListDesigner` class overrides the , , and methods. The `SimpleRadioButtonListDesigner` class displays a `SimpleRadioButtonList` control on the design surface. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/ListControlDesigner_Samples/CS/SimpleRadioButtonListDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/ListControlDesigner_Samples/VB/simpleradiobuttonlistdesigner.vb" id="Snippet1"::: @@ -180,9 +180,9 @@ base class, the method sets the and properties of the object to reference the design-time data source, then calls the method, and then restores the and properties to their original values. + For the base class, the method sets the and properties of the object to reference the design-time data source, then calls the method, and then restores the and properties to their original values. - For the class, however, the method has no functionality, because objects were just added to the collection. + For the class, however, the method has no functionality, because objects were just added to the collection. ]]> @@ -327,12 +327,12 @@ object is data-bound, the method clears the collection and adds a message indicating the control is data-bound. If the associated control is not data-bound and the collection is empty, the adds a message indicating the control is unbound. Then, the calls its base method to generate the markup. + If the associated control derived from the object is data-bound, the method clears the collection and adds a message indicating the control is data-bound. If the associated control is not data-bound and the collection is empty, the adds a message indicating the control is unbound. Then, the calls its base method to generate the markup. ## Examples - The following code example overrides the method to customize the markup that is displayed for the associated control on a design surface. If the property is not defined for the associated control, it is set to `Gainsboro`, and the control is displayed with that background color. After this is done, the base implementation of the method is called. + The following code example overrides the method to customize the markup that is displayed for the associated control on a design surface. If the property is not defined for the associated control, it is set to `Gainsboro`, and the control is displayed with that background color. After this is done, the base implementation of the method is called. This code example is part of a larger example provided for the class. @@ -378,9 +378,9 @@ method returns `null` if a property is not found, or if a with the same name does not exist. + The method returns `null` if a property is not found, or if a with the same name does not exist. - If the cannot be resolved to the property of the associated control, the returns an interface containing the design-time . + If the cannot be resolved to the property of the associated control, the returns an interface containing the design-time . ]]> @@ -423,7 +423,7 @@ method returns `null` if a property is not found, or if a with the same name does not exist. + The method returns `null` if a property is not found, or if a with the same name does not exist. ]]> @@ -461,14 +461,14 @@ method when it is ready to use the designer to render the control that is derived from the class. The method and its base methods configure properties and connect to events that are necessary for the operation of the designer. + The designer host calls the method when it is ready to use the designer to render the control that is derived from the class. The method and its base methods configure properties and connect to events that are necessary for the operation of the designer. The `component` parameter is the control, derived from the , that is associated with this designer or is a copy of that control. ## Examples - The following code example overrides the method in a designer derived from the class to ensure that only instances of a control class named `SimpleRadioButtonList` are used by the custom designer. + The following code example overrides the method in a designer derived from the class to ensure that only instances of a control class named `SimpleRadioButtonList` are used by the custom designer. This code example is part of a larger example provided for the class. @@ -552,12 +552,12 @@ Handles changes made to the component. This includes changes made in the propert base method connects the associated control that is derived from the object to the current data source and, if that is different from the data source to which the control was connected, updates the design-time markup. The method updates the design-time markup after connecting to the current data source. + The base method connects the associated control that is derived from the object to the current data source and, if that is different from the data source to which the control was connected, updates the design-time markup. The method updates the design-time markup after connecting to the current data source. ## Examples - The following code example overrides the method in a class that inherits from the class. When the data source that is associated with the designer class changes, the method is called and this code sets a variable named `changedDataSource` to `true`. + The following code example overrides the method in a class that inherits from the class. When the data source that is associated with the designer class changes, the method is called and this code sets a variable named `changedDataSource` to `true`. This code example is part of a larger example provided for the class. @@ -605,12 +605,12 @@ Handles changes made to the component. This includes changes made in the propert base method connects the associated control that is derived from the class to the current data source and, if that is different from the data source to which the control was connected, updates the design-time markup. The method of the designer unconditionally updates the design-time markup after connecting to the current data source. The value of `forceUpdateView` is ignored. + The base method connects the associated control that is derived from the class to the current data source and, if that is different from the data source to which the control was connected, updates the design-time markup. The method of the designer unconditionally updates the design-time markup after connecting to the current data source. The value of `forceUpdateView` is ignored. ## Examples - The following code example overrides the method in a class that inherits from the class. When the data source that is associated with the designer class changes, the is called and this code sets a variable named `changedDataSource` to `true`. + The following code example overrides the method in a class that inherits from the class. When the data source that is associated with the designer class changes, the is called and this code sets a variable named `changedDataSource` to `true`. This code example is part of a larger example provided for the class. @@ -656,9 +656,9 @@ Handles changes made to the component. This includes changes made in the propert method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. - For controls that are derived from the object, the adds the attribute to the and properties of the associated control. + For controls that are derived from the object, the adds the attribute to the and properties of the associated control. ]]> @@ -700,7 +700,7 @@ Handles changes made to the component. This includes changes made in the propert property returns `false` so that a data source dropdown is not displayed with the **Choose Data Source** menu item in the **Common Tasks** context menu. Instead, this menu item displays the **Choose Data Source** dialog box, which allows the user to select a and the and properties. + The property returns `false` so that a data source dropdown is not displayed with the **Choose Data Source** menu item in the **Common Tasks** context menu. Instead, this menu item displays the **Choose Data Source** dialog box, which allows the user to select a and the and properties. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ListItemsCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/ListItemsCollectionEditor.xml index 783e3c606cc..d68f9eddd31 100644 --- a/xml/System.Web.UI.Design.WebControls/ListItemsCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/ListItemsCollectionEditor.xml @@ -25,7 +25,7 @@ The is invoked by selecting the ellipsis (**…**) button on the **ListItems** property in the **Properties** grid of the visual designer. - The method always returns `false` to indicate that only one object can be selected at a time in the editor. The property returns the name of the Help topic that the editor displays. + The method always returns `false` to indicate that only one object can be selected at a time in the editor. The property returns the name of the Help topic that the editor displays. @@ -112,7 +112,7 @@ method always returns `false`; thus, only one object can be selected at a time in the object. + The method always returns `false`; thus, only one object can be selected at a time in the object. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ListViewDesigner.xml b/xml/System.Web.UI.Design.WebControls/ListViewDesigner.xml index 8d1e34fd0c3..d7e48da1da1 100644 --- a/xml/System.Web.UI.Design.WebControls/ListViewDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/ListViewDesigner.xml @@ -32,11 +32,11 @@ The methods of the class provide the following functionality: -- The and methods return the HTML markup that is used to render the associated control at design time. +- The and methods return the HTML markup that is used to render the associated control at design time. -- The and methods provide support for editable regions at design time. +- The and methods provide support for editable regions at design time. -- The method prepares the designer to view, edit, and design the associated control. +- The method prepares the designer to view, edit, and design the associated control. ]]> @@ -131,7 +131,7 @@ control ( and ) are not defined, the method calls the method to generate the HTML markup. + If the two required templates for the control ( and ) are not defined, the method calls the method to generate the HTML markup. ]]> @@ -197,7 +197,7 @@ method overrides the default implementation to support region-based editing on the design surface and to return the content for a specified region. + The method overrides the default implementation to support region-based editing on the design surface and to return the content for a specified region. ]]> @@ -229,7 +229,7 @@ method is used by the designer to render the control at design time if the two required templates for the control ( and ) are not defined. The method calls the method to create a placeholder that displays the type and the ID of the control, and additional instructions for the user. + The method is used by the designer to render the control at design time if the two required templates for the control ( and ) are not defined. The method calls the method to create a placeholder that displays the type and the ID of the control, and additional instructions for the user. ]]> @@ -265,7 +265,7 @@ method when it is ready to use the designer to render the control. The method and its base methods configure properties and connect to events that are required for the designer. + The designer host calls the method when it is ready to use the designer to render the control. The method and its base methods configure properties and connect to events that are required for the designer. The `component` parameter is the control that is associated with this designer, or a copy of the control. @@ -303,7 +303,7 @@ method overrides its base implementation to ignore change notifications while persisting a template's content in the page markup. + The method overrides its base implementation to ignore change notifications while persisting a template's content in the page markup. ]]> @@ -334,7 +334,7 @@ method notifies control designer object for the control that is bound to the associated data source that the fields in the schema have changed. When this method is called, it prevents the control from updating itself. + The method notifies control designer object for the control that is bound to the associated data source that the fields in the schema have changed. When this method is called, it prevents the control from updating itself. ]]> @@ -363,7 +363,7 @@ property always returns 21. This causes 21 records to be displayed in the design surface for the control. An exception is if there is a control inside the template and the property is set to a value less than 21. In that case, the number of records to display is the value of the property. The maximum number of records that the control will display on the designer surface is 21 records. + The property always returns 21. This causes 21 records to be displayed in the design surface for the control. An exception is if there is a control inside the template and the property is set to a value less than 21. In that case, the number of records to display is the value of the property. The maximum number of records that the control will display on the designer surface is 21 records. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/LiteralDesigner.xml b/xml/System.Web.UI.Design.WebControls/LiteralDesigner.xml index c52e904f652..b84d2e0e401 100644 --- a/xml/System.Web.UI.Design.WebControls/LiteralDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/LiteralDesigner.xml @@ -23,15 +23,15 @@ Provides design-time support in a visual designer for the Web server control. - control allows a text string to be used as a control on a Web page. - - In a visual designer, when you switch from Source to Design view, the markup source code that describes a control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The class provides design-time support for the control. - - The method is called when there is a design-time change to the associated control. - + control allows a text string to be used as a control on a Web page. + + In a visual designer, when you switch from Source to Design view, the markup source code that describes a control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The class provides design-time support for the control. + + The method is called when there is a design-time change to the associated control. + ]]> @@ -64,11 +64,11 @@ Initializes a new instance of the class. - class when it creates the associated control or a copy of the control on the design surface. - + class when it creates the associated control or a copy of the control on the design surface. + ]]> @@ -100,13 +100,13 @@ A object that contains the event data. Called when there is a change to the associated control. - method is called when the event of the associated control is raised. Typically, this is in response to a property change on the control (for example, a `Properties` grid change). - - The creates a object and then calls the base method. - + method is called when the event of the associated control is raised. Typically, this is in response to a property change on the control (for example, a `Properties` grid change). + + The creates a object and then calls the base method. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/LoginDesigner.xml b/xml/System.Web.UI.Design.WebControls/LoginDesigner.xml index 8e1618bbba0..ae0d20fcc0e 100644 --- a/xml/System.Web.UI.Design.WebControls/LoginDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/LoginDesigner.xml @@ -36,17 +36,17 @@ The class methods provide the following functionality: -- The method returns the markup that is used to render the associated at design time. +- The method returns the markup that is used to render the associated at design time. -- The method returns a serialized copy of the template for the associated . +- The method returns a serialized copy of the template for the associated . -- The method provides the markup that is used to render the associated at design time when an error has occurred. +- The method provides the markup that is used to render the associated at design time when an error has occurred. -- The method prepares the designer to view, edit, and design the associated . +- The method prepares the designer to view, edit, and design the associated . -- The method is used to remove properties from, add additional properties to, or shadow properties of the associated . +- The method is used to remove properties from, add additional properties to, or shadow properties of the associated . -- The method sets a region of the associated from a serialized copy of a control template. +- The method sets a region of the associated from a serialized copy of a control template. @@ -55,7 +55,7 @@ The example derives the `MyLogin` control from the . The `MyLogin` is a copy of the control. The example also derives the `MyLoginDesigner` class from the and applies a attribute for the `MyLoginDesigner` on the `MyLogin` control. - The `MyLoginDesigner` overrides the method to make the property visible in the **Properties** grid at design time. It overrides the method to draw a blue, dashed border around the control to make its extent more visible, if the property of the `MyLogin` control is the or value. It overrides the method to generate the markup for a placeholder that includes the error message rendered in red, bold text. + The `MyLoginDesigner` overrides the method to make the property visible in the **Properties** grid at design time. It overrides the method to draw a blue, dashed border around the control to make its extent more visible, if the property of the `MyLogin` control is the or value. It overrides the method to generate the markup for a placeholder that includes the error message rendered in red, bold text. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/CS/LoginDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/VB/LoginDesigner.vb" id="Snippet1"::: @@ -132,7 +132,7 @@ property creates a object for the class, adds it to the object that is obtained from the base property, and then returns the . + The property creates a object for the class, adds it to the object that is obtained from the base property, and then returns the . ]]> @@ -231,12 +231,12 @@ method creates an object for the property of the associated control and adds it to the object that is referenced by the `regions` parameter. The method uses the base method to generate the markup for the design-time rendering of the control. + The method creates an object for the property of the associated control and adds it to the object that is referenced by the `regions` parameter. The method uses the base method to generate the markup for the design-time rendering of the control. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the control at design time. The example draws a blue, dashed border around the control to make its extent more visible, if the property of the control is the or value. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the control at design time. The example draws a blue, dashed border around the control to make its extent more visible, if the property of the control is the or value. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/CS/LoginDesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/VB/LoginDesigner.vb" id="Snippet4"::: @@ -280,11 +280,11 @@ method creates a copy of the object of the associated control in the control container and returns a serialized copy. + The method creates a copy of the object of the associated control in the control container and returns a serialized copy. - The serialized template can be restored to a part of the control using the method. + The serialized template can be restored to a part of the control using the method. - The `region` parameter is not used by the . + The `region` parameter is not used by the . ]]> @@ -328,7 +328,7 @@ ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the control at design time. The example generates the markup for a placeholder that includes the error message rendered in red, bold text. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the control at design time. The example generates the markup for a placeholder that includes the error message rendered in red, bold text. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/CS/LoginDesigner.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/VB/LoginDesigner.vb" id="Snippet2"::: @@ -365,7 +365,7 @@ method when it is ready to use the designer to render the control. The method and its base methods configure properties and set up events that are necessary for the operation of the designer. + The visual designer calls the method when it is ready to use the designer to render the control. The method and its base methods configure properties and set up events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer or a copy of the control. @@ -404,14 +404,14 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. - If a property has been defined for the control, the sets the attribute of properties that do not apply when templated to `false` so those properties do not appear in the **Properties** grid. + If a property has been defined for the control, the sets the attribute of properties that do not apply when templated to `false` so those properties do not appear in the **Properties** grid. ## Examples - The following code sample creates a class derived from , and overrides the method to change the **Properties** grid of a control at design time. The example makes the property visible in the **Properties** grid. + The following code sample creates a class derived from , and overrides the method to change the **Properties** grid of a control at design time. The example makes the property visible in the **Properties** grid. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/CS/LoginDesigner.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/VB/LoginDesigner.vb" id="Snippet3"::: @@ -485,9 +485,9 @@ method parses a serialized template for the associated control that is specified by the `content` parameter, and then uses the template to update the region of the control that is specified by the property of the `region` parameter. + The method parses a serialized template for the associated control that is specified by the `content` parameter, and then uses the template to update the region of the control that is specified by the property of the `region` parameter. - The property of the control can be serialized using the method. + The property of the control can be serialized using the method. ]]> @@ -521,7 +521,7 @@ property gets a object from the base property, and then adds a object that contains a single object for the layout template of the associated control to the . The property returns this to the caller. + The property gets a object from the base property, and then adds a object that contains a single object for the layout template of the associated control to the . The property returns this to the caller. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/LoginNameDesigner.xml b/xml/System.Web.UI.Design.WebControls/LoginNameDesigner.xml index 45004820c2d..55a43e6e74d 100644 --- a/xml/System.Web.UI.Design.WebControls/LoginNameDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/LoginNameDesigner.xml @@ -24,7 +24,7 @@ In a visual designer, when you switch from Source to Design view, the markup source code that describes the control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to the markup source code and edited into the markup for the Web page. The class provides design-time support for the control. - The property always returns `true`, indicating that the designer creates a temporary copy of the associated to generate the design-time markup. The method provides the markup that is used to render the associated at design time when an error has occurred. + The property always returns `true`, indicating that the designer creates a temporary copy of the associated to generate the design-time markup. The method provides the markup that is used to render the associated at design time when an error has occurred. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/LoginStatusDesigner.xml b/xml/System.Web.UI.Design.WebControls/LoginStatusDesigner.xml index e9b227cd140..c43f0095645 100644 --- a/xml/System.Web.UI.Design.WebControls/LoginStatusDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/LoginStatusDesigner.xml @@ -26,7 +26,7 @@ The property returns a object, which typically contains an object that is derived from the class for each level in the inheritance tree of the designer. The property always returns `true`, indicating that the designer creates a temporary copy of the associated to generate the design-time markup, since the user authentication status is not available at design time. - The method returns the markup that is used to render the associated at design time. The method prepares the designer to view, edit, and design the associated . + The method returns the markup that is used to render the associated at design time. The method prepares the designer to view, edit, and design the associated . @@ -35,7 +35,7 @@ The example derives the `MyLoginStatus` control from the . The `MyLoginStatus` is a copy of the control. The example also derives the `MyLoginStatusDesigner` class from , and then applies a attribute for the `MyLoginStatusDesigner` on the `MyLoginStatus` control. - The `MyLoginStatusDesigner` overrides the method to draw a blue, dashed border around the control to make it more visible, if the property of the `MyLoginStatus` is the or value. + The `MyLoginStatusDesigner` overrides the method to draw a blue, dashed border around the control to make it more visible, if the property of the `MyLoginStatus` is the or value. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginStatusDesigner/CS/LoginStatusDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginStatusDesigner/VB/LoginStatusDesigner.vb" id="Snippet1"::: @@ -112,7 +112,7 @@ property creates a object for the class, adds it to the that is obtained from the base property, and then returns the collection. + The property creates a object for the class, adds it to the that is obtained from the base property, and then returns the collection. ]]> @@ -147,12 +147,12 @@ or property (depending on whether the user is logged in), is `null`, an empty string (""), or a single space (" "), the method sets the or property, as appropriate, to the property, enclosed in brackets ("[ ]"). Then, regardless of the setting of the or , the method calls the base method to generate the markup for the design-time rendering of the control. + If the or property (depending on whether the user is logged in), is `null`, an empty string (""), or a single space (" "), the method sets the or property, as appropriate, to the property, enclosed in brackets ("[ ]"). Then, regardless of the setting of the or , the method calls the base method to generate the markup for the design-time rendering of the control. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example draws a blue, dashed border around the control to make its extent more visible, if the property of the control is the or value. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example draws a blue, dashed border around the control to make its extent more visible, if the property of the control is the or value. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginStatusDesigner/CS/LoginStatusDesigner.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginStatusDesigner/VB/LoginStatusDesigner.vb" id="Snippet2"::: @@ -193,7 +193,7 @@ method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. + The visual designer calls the method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer or a copy of the control. diff --git a/xml/System.Web.UI.Design.WebControls/LoginViewDesigner.xml b/xml/System.Web.UI.Design.WebControls/LoginViewDesigner.xml index a4f64d2aaca..9622366b111 100644 --- a/xml/System.Web.UI.Design.WebControls/LoginViewDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/LoginViewDesigner.xml @@ -28,11 +28,11 @@ The class methods provide the following functionality: -- The methods return the markup that is used to render the associated control at design time. The method gets the markup that renders a placeholder for the associated control at design time when the current template is not defined. The method provides the markup that renders the associated control at design time when an error has occurred. +- The methods return the markup that is used to render the associated control at design time. The method gets the markup that renders a placeholder for the associated control at design time when the current template is not defined. The method provides the markup that renders the associated control at design time when an error has occurred. -- The method returns a serialized copy of the current template for the associated control. The method sets a region of the associated control from a serialized copy of a control template. +- The method returns a serialized copy of the current template for the associated control. The method sets a region of the associated control from a serialized copy of a control template. -- The method prepares the designer to view, edit, and design the associated control. The method is called when there is a change to the associated control. The method is used to remove properties from, add additional properties to, or shadow properties of the associated control. +- The method prepares the designer to view, edit, and design the associated control. The method is called when there is a change to the associated control. The method is used to remove properties from, add additional properties to, or shadow properties of the associated control. @@ -43,15 +43,15 @@ The `MyLoginViewDesigner` control overrides the following members: -- The method to make the property visible in the **Properties** grid at design time. +- The method to make the property visible in the **Properties** grid at design time. -- The method to draw an orange border around the control to make its extent more visible. +- The method to draw an orange border around the control to make its extent more visible. -- The method to generate the markup for a placeholder that includes the error message, which is rendered in red, bold text. +- The method to generate the markup for a placeholder that includes the error message, which is rendered in red, bold text. -- The method to generate the markup for a placeholder that contains the names of the role groups that are defined for the control. +- The method to generate the markup for a placeholder that contains the names of the role groups that are defined for the control. -- The method to throw an exception, if the associated control is not a `MyLoginView` object. +- The method to throw an exception, if the associated control is not a `MyLoginView` object. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/CS/LoginViewDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/VB/LoginViewDesigner.vb" id="Snippet1"::: @@ -125,7 +125,7 @@ property creates a object for the class, adds it to the that is obtained from the base property, and then returns the . + The property creates a object for the class, adds it to the that is obtained from the base property, and then returns the . ]]> @@ -169,12 +169,12 @@ method sets the template index of the associated control to the current design-time index, and then causes the associated control to recreate and data bind its child controls, if necessary. Next, the calls the base method to generate the markup. + The method sets the template index of the associated control to the current design-time index, and then causes the associated control to recreate and data bind its child controls, if necessary. Next, the calls the base method to generate the markup. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example draws an orange border around the control to make its extent more visible. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example draws an orange border around the control to make its extent more visible. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/CS/LoginViewDesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/VB/LoginViewDesigner.vb" id="Snippet4"::: @@ -215,12 +215,12 @@ method creates an object for a template editing area on the visual designer surface, and then initializes it as a template. If no templates are defined, a string is displayed that prompts you to click to begin editing. A predefined constant is used to generate the returned markup. + The method creates an object for a template editing area on the visual designer surface, and then initializes it as a template. If no templates are defined, a string is displayed that prompts you to click to begin editing. A predefined constant is used to generate the returned markup. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example draws an orange border around the control to make its extent more visible. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example draws an orange border around the control to make its extent more visible. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/CS/LoginViewDesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/VB/LoginViewDesigner.vb" id="Snippet4"::: @@ -262,9 +262,9 @@ interface can be obtained from the `region` parameter, the method returns the persisted template. Otherwise, it calls the base method to generate the content. + If a template implementing the interface can be obtained from the `region` parameter, the method returns the persisted template. Otherwise, it calls the base method to generate the content. - The serialized template can be restored to the control by using the method. + The serialized template can be restored to the control by using the method. ]]> @@ -300,12 +300,12 @@ method first formats a string message that specifies the name of the current template of the associated control and also specifies that the template is empty. Then the generates the markup for a placeholder containing that message. + The method first formats a string message that specifies the name of the current template of the associated control and also specifies that the template is empty. Then the generates the markup for a placeholder containing that message. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example generates the markup for a placeholder that includes the names of all the objects that are defined for the associated control. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example generates the markup for a placeholder that includes the names of all the objects that are defined for the associated control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/CS/LoginViewDesigner.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/VB/LoginViewDesigner.vb" id="Snippet5"::: @@ -349,7 +349,7 @@ ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example generates the markup for a placeholder that includes the error message, which is rendered in red, bold text. + The following code example shows how to override the method in a class that is inherited from the class to change the appearance of a control that is derived from the class at design time. The example generates the markup for a placeholder that includes the error message, which is rendered in red, bold text. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/CS/LoginViewDesigner.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/VB/LoginViewDesigner.vb" id="Snippet2"::: @@ -386,14 +386,14 @@ method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. + The visual designer calls the method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer or a copy of the control. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the behavior of a control that is derived from the class at design time. The example throws an , if the associated control is not a `MyLoginView` object. + The following code example shows how to override the method in a class that is inherited from the class to change the behavior of a control that is derived from the class at design time. The example throws an , if the associated control is not a `MyLoginView` object. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/CS/LoginViewDesigner.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/VB/LoginViewDesigner.vb" id="Snippet6"::: @@ -437,9 +437,9 @@ method is called when the event of the associated control executes. Typically, this is in response to a property change on the control (for example, a **Properties** grid change). If the control template is changed, the **Properties** grid is refreshed. + The method is called when the event of the associated control executes. Typically, this is in response to a property change on the control (for example, a **Properties** grid change). If the control template is changed, the **Properties** grid is refreshed. - The verifies that the current template index is valid, and then calls the base method. + The verifies that the current template index is valid, and then calls the base method. ]]> @@ -474,14 +474,14 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. - The method applies the attribute of the property so that it does not appear in the **Properties** grid. + The method applies the attribute of the property so that it does not appear in the **Properties** grid. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the **Properties** grid of a control that is derived from the class at design time. The example makes the property visible in the **Properties** grid. + The following code example shows how to override the method in a class that is inherited from the class to change the **Properties** grid of a control that is derived from the class at design time. The example makes the property visible in the **Properties** grid. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/CS/LoginViewDesigner.cs" id="Snippet3"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginViewDesigner/VB/LoginViewDesigner.vb" id="Snippet3"::: @@ -526,9 +526,9 @@ method parses a serialized template for the associated control that is specified by the `content` parameter, and then uses the template to update the region of the control that is specified by the property of the `region` parameter. + The method parses a serialized template for the associated control that is specified by the `content` parameter, and then uses the template to update the region of the control that is specified by the property of the `region` parameter. - The current template of the control can be serialized using the method. + The current template of the control can be serialized using the method. ]]> @@ -562,7 +562,7 @@ property gets a object from the base property, and then adds objects that contain a single object for the anonymous template (which corresponds to no user logged on), for the logged-on template, and for each element in the collection of the associated control to the . The returns this to the caller. + The property gets a object from the base property, and then adds objects that contain a single object for the anonymous template (which corresponds to no user logged on), for the logged-on template, and for each element in the collection of the associated control to the . The returns this to the caller. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/MailDefinitionBodyFileNameEditor.xml b/xml/System.Web.UI.Design.WebControls/MailDefinitionBodyFileNameEditor.xml index 689dd25eb9a..04aa4e62315 100644 --- a/xml/System.Web.UI.Design.WebControls/MailDefinitionBodyFileNameEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/MailDefinitionBodyFileNameEditor.xml @@ -20,7 +20,7 @@ class provides a user interface for selecting a file for the property of a object. The specifies the file that contains the email message body. + The class provides a user interface for selecting a file for the property of a object. The specifies the file that contains the email message body. The objects define the content and format of the email notification messages that are sent by controls. For example, the , and controls use the . @@ -147,7 +147,7 @@ `Text Files(*.txt)|*.txt|HTML Files(*.htm;*.html)|*.htm;*.html|All Files(*.*)|*.*|` - A localized version of this string is the default value for the . + A localized version of this string is the default value for the . ]]> diff --git a/xml/System.Web.UI.Design.WebControls/MenuBindingsEditor.xml b/xml/System.Web.UI.Design.WebControls/MenuBindingsEditor.xml index d428921f0a2..1fffb28bed8 100644 --- a/xml/System.Web.UI.Design.WebControls/MenuBindingsEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/MenuBindingsEditor.xml @@ -17,23 +17,23 @@ Provides a component editor for the collection of the associated control. - class provides a user interface for editing the elements of the collection within the associated control. - - The object is invoked by selecting the ellipsis (**…**) button on the **DataBindings** property in the **Properties** grid of the visual designer, or by choosing **Edit Menu Items** from the **Common Tasks** context menu on the control. - - The method edits the values of the data bindings collection of the associated control. The method gets the editing style that is associated with this editor. - - - -## Examples - The following code example shows how to use the attribute to associate the class and the class (the bindings editor base class) with a property in a custom control, derived from the class, that gets and sets a collection. - + class provides a user interface for editing the elements of the collection within the associated control. + + The object is invoked by selecting the ellipsis (**…**) button on the **DataBindings** property in the **Properties** grid of the visual designer, or by choosing **Edit Menu Items** from the **Common Tasks** context menu on the control. + + The method edits the values of the data bindings collection of the associated control. The method gets the editing style that is associated with this editor. + + + +## Examples + The following code example shows how to use the attribute to associate the class and the class (the bindings editor base class) with a property in a custom control, derived from the class, that gets and sets a collection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuEditors/CS/MenuEditors.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuEditors/VB/MenuEditors.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuEditors/VB/MenuEditors.vb" id="Snippet2"::: + ]]> @@ -65,11 +65,11 @@ Initializes a new instance of the class. - class when you select the ellipsis (**…**) button on the **DataBindings** property in the **Properties** grid of the visual designer, or by choosing **Edit Menu Items** from the **Common Tasks** context menu on the control, when designing the associated control. - + class when you select the ellipsis (**…**) button on the **DataBindings** property in the **Properties** grid of the visual designer, or by choosing **Edit Menu Items** from the **Common Tasks** context menu on the control, when designing the associated control. + ]]> @@ -107,11 +107,11 @@ Edits the value of the data bindings collection of the associated control. The new ; otherwise, if the value of the object has not changed, unchanged. - method extracts the associated control and the object that is associated with that control from the `context` parameter. Then the method calls back on the object to display an editing dialog box that is used to edit the collection of the control. - + method extracts the associated control and the object that is associated with that control from the `context` parameter. Then the method calls back on the object to display an editing dialog box that is used to edit the collection of the control. + ]]> @@ -150,11 +150,11 @@ Gets the editing style that is associated with this editor. The editing style that is associated with this editor. - method always returns the value, which indicates that the editor user interface (UI) is a modal dialog box. - + method always returns the value, which indicates that the editor user interface (UI) is a modal dialog box. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/MenuDesigner.xml b/xml/System.Web.UI.Design.WebControls/MenuDesigner.xml index ebb57055382..0e048e009be 100644 --- a/xml/System.Web.UI.Design.WebControls/MenuDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/MenuDesigner.xml @@ -34,11 +34,11 @@ The class methods provide the following functionality: -- The method prepares the designer to view, edit, and design the associated control. The method returns the markup that is used to render the associated at design time. +- The method prepares the designer to view, edit, and design the associated control. The method returns the markup that is used to render the associated at design time. -- The method gets the markup that renders a placeholder for the associated control at design time when no markup is otherwise available. The method provides the markup that renders the associated control at design time when an error has occurred. +- The method gets the markup that renders a placeholder for the associated control at design time when no markup is otherwise available. The method provides the markup that renders the associated control at design time when an error has occurred. -- The method binds the associated control to the design-time data source. The method constructs a sample data source that can be used at design time for the associated control. +- The method binds the associated control to the design-time data source. The method constructs a sample data source that can be used at design time for the associated control. @@ -49,13 +49,13 @@ `The MyMenuDesigner` overrides the following members: -- The method to draw an orange, dotted border around the control to make its extent more visible. +- The method to draw an orange, dotted border around the control to make its extent more visible. -- The method to generate the markup for a placeholder that includes the error message, which is rendered in red, bold text. +- The method to generate the markup for a placeholder that includes the error message, which is rendered in red, bold text. -- The to generate the markup for a placeholder that contains a message indicating that no menu items are defined. +- The to generate the markup for a placeholder that contains a message indicating that no menu items are defined. -- The method to throw an exception, if the associated control is not a `MyMenu` object. +- The method to throw an exception, if the associated control is not a `MyMenu` object. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/CS/MenuDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/VB/MenuDesigner.vb" id="Snippet1"::: @@ -134,7 +134,7 @@ property creates a object for the class, adds it to the that is obtained from the base property, and then returns the . + The property creates a object for the class, adds it to the that is obtained from the base property, and then returns the . ]]> @@ -231,13 +231,13 @@ method clears the property, and then calls the base method: + If one of the following conditions is true, the method clears the property, and then calls the base method: - The property is not `null` or an empty string (""). - The property is not `null`. -- The collection contains one or more elements. +- The collection contains one or more elements. The `dataBoundControl` parameter is the control that is associated with this designer or a copy of that control. @@ -275,12 +275,12 @@ method calls the method to bind the design-time data source to the associated control, and then the calls the method to cause the control to generate its static-view and dynamic-view markup. The returns the markup for the current view. If the current view is not defined, the calls the base method. + The method calls the method to bind the design-time data source to the associated control, and then the calls the method to cause the control to generate its static-view and dynamic-view markup. The returns the markup for the current view. If the current view is not defined, the calls the base method. ## Examples - The following code example shows how to override the method in a class that is inherited from the class. The overridden method changes the appearance of a control that is derived from the control at design time. The example draws an orange, dotted border around the control to make its extent more visible, if the property of the control is the or value. + The following code example shows how to override the method in a class that is inherited from the class. The overridden method changes the appearance of a control that is derived from the control at design time. The example draws an orange, dotted border around the control to make its extent more visible, if the property of the control is the or value. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/CS/MenuDesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/VB/MenuDesigner.vb" id="Snippet4"::: @@ -318,12 +318,12 @@ method generates the markup for a placeholder that specifies the control name and a message instructing you to use the collection editor to add items. + The method generates the markup for a placeholder that specifies the control name and a message instructing you to use the collection editor to add items. ## Examples - The following code example shows how to override the method in a class that is inherited from the class. The overridden method changes the appearance of a control that is derived from the class at design time. The example generates the markup for a placeholder that includes a message indicating that no menu items are defined for the associated control. + The following code example shows how to override the method in a class that is inherited from the class. The overridden method changes the appearance of a control that is derived from the class at design time. The example generates the markup for a placeholder that includes a message indicating that no menu items are defined for the associated control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/CS/MenuDesigner.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/VB/MenuDesigner.vb" id="Snippet5"::: @@ -363,12 +363,12 @@ method generates markup that renders the error design-time control as a placeholder that contains the type name, the control name, and messages describing the error. + The method generates markup that renders the error design-time control as a placeholder that contains the type name, the control name, and messages describing the error. ## Examples - The following code example shows how to override the method in a class that is inherited from the class. The overridden method changes the appearance of a control that is derived from the class at design time. The example generates the markup for a placeholder that includes the error message, which is rendered in red, bold text. + The following code example shows how to override the method in a class that is inherited from the class. The overridden method changes the appearance of a control that is derived from the class at design time. The example generates the markup for a placeholder that includes the error message, which is rendered in red, bold text. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/CS/MenuDesigner.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/VB/MenuDesigner.vb" id="Snippet2"::: @@ -405,7 +405,7 @@ method has several root menu items with empty paths. This sample data source is used at design time if no menu items are defined for the associated control and if the menu cannot be bound to a data source. + The sample data source that is constructed by the method has several root menu items with empty paths. This sample data source is used at design time if no menu items are defined for the associated control and if the menu cannot be bound to a data source. ]]> @@ -440,14 +440,14 @@ method when it is ready to use the designer to render the control. The method and its base methods configure properties and set up events that are necessary for the operation of the designer. + The visual designer calls the method when it is ready to use the designer to render the control. The method and its base methods configure properties and set up events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer or a copy of that control. ## Examples - The following code example shows how to override the method in a class that is inherited from the class. The overridden method changes the behavior of a control that is derived from the class at design time. The example throws an exception, if the associated control is not a `MyMenu` object. + The following code example shows how to override the method in a class that is inherited from the class. The overridden method changes the behavior of a control that is derived from the class at design time. The example throws an exception, if the associated control is not a `MyMenu` object. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/CS/MenuDesigner.cs" id="Snippet6"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuDesigner/VB/MenuDesigner.vb" id="Snippet6"::: @@ -489,7 +489,7 @@ method will be called by the design host only if the property is true. + The method will be called by the design host only if the property is true. ]]> @@ -672,7 +672,7 @@ property gets a object from the base property. It then adds to the a object named "`ItemTemplates`" that contains two objects named "StaticItemTemplate" and "DynamicItemTemplate". The property returns this to the caller. + The property gets a object from the base property. It then adds to the a object named "`ItemTemplates`" that contains two objects named "StaticItemTemplate" and "DynamicItemTemplate". The property returns this to the caller. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/MenuItemCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/MenuItemCollectionEditor.xml index cdbd88aeb8d..2f786585549 100644 --- a/xml/System.Web.UI.Design.WebControls/MenuItemCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/MenuItemCollectionEditor.xml @@ -24,7 +24,7 @@ The is invoked by selecting the ellipsis (**…**) button on the **Items** property in the **Properties** grid of the visual designer, or by choosing **Edit Menu Items** from the **Common Tasks** context menu on the control. - The method edits the values of the menu item collection of the associated control. The method gets the editing style that is associated with this editor. + The method edits the values of the menu item collection of the associated control. The method gets the editing style that is associated with this editor. @@ -110,7 +110,7 @@ method extracts the associated control and the object that is associated with that control from the `context` parameter. Then the calls back on the to display an editing dialog box that is used to edit the object of the control. + The method extracts the associated control and the object that is associated with that control from the `context` parameter. Then the calls back on the to display an editing dialog box that is used to edit the object of the control. The `provider` parameter is not used. @@ -152,7 +152,7 @@ method always returns the value, which indicates that the user interface for the editor is a modal dialog box. + The method always returns the value, which indicates that the user interface for the editor is a modal dialog box. The `context` parameter is not used. diff --git a/xml/System.Web.UI.Design.WebControls/MenuItemStyleCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/MenuItemStyleCollectionEditor.xml index ce3d7d167db..a708e4fd21c 100644 --- a/xml/System.Web.UI.Design.WebControls/MenuItemStyleCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/MenuItemStyleCollectionEditor.xml @@ -17,27 +17,27 @@ Provides a component editor for objects in the associated control. - class provides a user interface for editing the elements of objects in the associated control at design time, under the control of the object. - - There is a associated with each of the and properties of the control. These objects are used to apply styles to menu items that depend on their level (nesting depth) in the menu structure. - - The is invoked, for example, by selecting the ellipsis button (**…**) on the **LevelMenuItemStyles** or **LevelSelectedStyles** row in the **Properties** grid of the visual designer. - - The method always returns `false` to indicate that only one object can be selected at a time in the editor. The method creates a new form to display and edit the current . - - The method creates a new instance of the specified collection item type. The method returns an array of types that the editor can create. - - - -## Examples - The following code example shows how to use the attribute to associate the and classes (the collection editor base class) with a property in a custom control, derived from the class, that gets and sets a collection. - + class provides a user interface for editing the elements of objects in the associated control at design time, under the control of the object. + + There is a associated with each of the and properties of the control. These objects are used to apply styles to menu items that depend on their level (nesting depth) in the menu structure. + + The is invoked, for example, by selecting the ellipsis button (**…**) on the **LevelMenuItemStyles** or **LevelSelectedStyles** row in the **Properties** grid of the visual designer. + + The method always returns `false` to indicate that only one object can be selected at a time in the editor. The method creates a new form to display and edit the current . + + The method creates a new instance of the specified collection item type. The method returns an array of types that the editor can create. + + + +## Examples + The following code example shows how to use the attribute to associate the and classes (the collection editor base class) with a property in a custom control, derived from the class, that gets and sets a collection. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuEditors/CS/MenuEditors.cs" id="Snippet4"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuEditors/VB/MenuEditors.vb" id="Snippet4"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.MenuEditors/VB/MenuEditors.vb" id="Snippet4"::: + ]]> @@ -77,11 +77,11 @@ The of the collection to edit. Initializes a new instance of the class. - class when you select, for example, the ellipsis button (**…**) on the **LevelMenuItemStyles** or **LevelSelectedStyles** row in the **Properties** grid of the visual designer when designing a control or a control that is derived from the class. - + class when you select, for example, the ellipsis button (**…**) on the **LevelMenuItemStyles** or **LevelSelectedStyles** row in the **Properties** grid of the visual designer when designing a control or a control that is derived from the class. + ]]> @@ -111,11 +111,11 @@ Gets a value indicating whether multiple elements can be selected in the editor at one time. Always . - method always returns `false`; thus, only one object can be selected at a time in the object. - + method always returns `false`; thus, only one object can be selected at a time in the object. + ]]> @@ -147,11 +147,11 @@ Creates a new form to display and edit the current object. An instance of the to use as the . - method calls the base method to create the form, and then formats a caption for the form. - + method calls the base method to create the form, and then formats a caption for the form. + ]]> @@ -185,11 +185,11 @@ Creates a new instance of the specified collection item type. A new instance of the specified type, . - method is used to create new objects. The calls the method to access the activation methods for late-bound support. - + method is used to create new objects. The calls the method to access the activation methods for late-bound support. + ]]> @@ -221,11 +221,11 @@ Gets the data types that this collection editor can create. A type array of the data types the can create. - object can create type objects. - + object can create type objects. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ObjectDataSourceDesigner.xml b/xml/System.Web.UI.Design.WebControls/ObjectDataSourceDesigner.xml index 3ca15ce0532..080aa0ffa46 100644 --- a/xml/System.Web.UI.Design.WebControls/ObjectDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/ObjectDataSourceDesigner.xml @@ -30,9 +30,9 @@ - The property specifies the method that performs the Select function. The property specifies the type of the business object that provides the data for the associated control. -- The method returns a data source view with the specified name. The method returns a list of data source view names for the associated control. The method extracts the metadata for the Select method from the associated business object. +- The method returns a data source view with the specified name. The method returns a list of data source view names for the associated control. The method extracts the metadata for the Select method from the associated business object. -- The method causes the Configure Data Source wizard to be displayed on the visual designer surface. The method removes properties from, adds additional properties to, or shadows properties of the associated control. +- The method causes the Configure Data Source wizard to be displayed on the visual designer surface. The method removes properties from, adds additional properties to, or shadows properties of the associated control. @@ -41,9 +41,9 @@ The example derives the `MyObjectDataSource` control from the . The `MyObjectDataSource` is a copy of the control. The example also derives the `MyObjectDataSourceDesigner` class from the and applies a attribute for the `MyObjectDataSourceDesigner` on the `MyObjectDataSource` control. - The `MyObjectDataSourceDesigner` overrides the method to make the property visible in the **Properties** grid at design time. + The `MyObjectDataSourceDesigner` overrides the method to make the property visible in the **Properties** grid at design time. - The `MyObjectDataSourceDesigner` overrides the method to display the and properties in a placeholder, in addition to the control type and ID. + The `MyObjectDataSourceDesigner` overrides the method to display the and properties in a placeholder, in addition to the control type and ID. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.ObjectDataSourceDesigner/CS/ObjectDataSourceDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.ObjectDataSourceDesigner/VB/ObjectDataSourceDesigner.vb" id="Snippet1"::: @@ -126,9 +126,9 @@ method can be called, and the property is `true`, if the property of the associated control implements either the or the interface. + The method can be called, and the property is `true`, if the property of the associated control implements either the or the interface. - If the is `true`, the **Configure Data Source** menu item is displayed in the **Common ObjectDataSource Tasks** context menu of the associated control on the visual designer surface. The Configure Data Source wizard is invoked when this menu item is selected. + If the is `true`, the **Configure Data Source** menu item is displayed in the **Common ObjectDataSource Tasks** context menu of the associated control on the visual designer surface. The Configure Data Source wizard is invoked when this menu item is selected. ]]> @@ -163,9 +163,9 @@ method can be called, and the property is `true`, if the property of the associated control implements either the or interface, and the and properties both contain a value. + The method can be called, and the property is `true`, if the property of the associated control implements either the or interface, and the and properties both contain a value. - If the is `true`, the **Refresh Schema** menu item is displayed in the **Common ObjectDataSource Tasks** context menu of the associated control on the visual designer surface. + If the is `true`, the **Refresh Schema** menu item is displayed in the **Common ObjectDataSource Tasks** context menu of the associated control on the visual designer surface. ]]> @@ -201,9 +201,9 @@ method initiates a transaction that causes the Configure Data Source wizard to appear on the visual designer surface. + The method initiates a transaction that causes the Configure Data Source wizard to appear on the visual designer surface. - The method is called when you select the **Configure Data Source** menu item on the **Common ObjectDataSource Tasks** context menu of the associated control. The **Configure Data Source** menu item appears on the context menu when the property is `true`. + The method is called when you select the **Configure Data Source** menu item on the **Common ObjectDataSource Tasks** context menu of the associated control. The **Configure Data Source** menu item appears on the context menu when the property is `true`. ]]> @@ -240,7 +240,7 @@ method returns an object with the specified name. If `viewName` is `null` or an empty string (""), the first view name in the array of names that is returned by is used as the specified name. If no view names are returned by the , generates an unnamed . + The method returns an object with the specified name. If `viewName` is `null` or an empty string (""), the first view name in the array of names that is returned by is used as the specified name. If no view names are returned by the , generates an unnamed . ]]> @@ -274,7 +274,7 @@ method gets the view names from the names of the schema data tables of the associated control. + The method gets the view names from the names of the schema data tables of the associated control. ]]> @@ -308,14 +308,14 @@ method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. + Control designers use methods that are derived from the method to shadow various control properties with corresponding design-time properties that the designer implements, and to add properties to or remove properties from the **Properties** grid. - The method creates design-time properties to shadow the and properties of the associated control so that they appear in the **Properties** grid of the visual designer. + The method creates design-time properties to shadow the and properties of the associated control so that they appear in the **Properties** grid of the visual designer. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the **Properties** grid of a control that is derived from the class at design time. The example makes the property visible in the **Properties** grid. + The following code example shows how to override the method in a class that is inherited from the class to change the **Properties** grid of a control that is derived from the class at design time. The example makes the property visible in the **Properties** grid. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.ObjectDataSourceDesigner/CS/ObjectDataSourceDesigner.cs" id="Snippet4"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.ObjectDataSourceDesigner/VB/ObjectDataSourceDesigner.vb" id="Snippet4"::: @@ -358,7 +358,7 @@ method extracts the metadata for the method that is named by the property from the object that is named by the property, which is the type of the business object that provides the data for the associated control. The metadata is saved in a array and in the array of the designer. + The method extracts the metadata for the method that is named by the property from the object that is named by the property, which is the type of the business object that provides the data for the associated control. The metadata is saved in a array and in the array of the designer. ]]> @@ -396,7 +396,7 @@ ## Remarks The property shadows the property of the associated control. - When the value of the property is changed, the design-time markup for the associated control is updated. The method is called, if the property is true; otherwise, the event is raised. + When the value of the property is changed, the design-time markup for the associated control is updated. The method is called, if the property is true; otherwise, the event is raised. ]]> @@ -434,7 +434,7 @@ ## Remarks The property shadows the property of the associated control. - When the value of the property is changed, the design-time markup for the associated control is updated. The method is called, if the property is true; otherwise, the event is raised. + When the value of the property is changed, the design-time markup for the associated control is updated. The method is called, if the property is true; otherwise, the event is raised. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ObjectDesignerDataSourceView.xml b/xml/System.Web.UI.Design.WebControls/ObjectDesignerDataSourceView.xml index 1a8970a7acc..cae3b9571f1 100644 --- a/xml/System.Web.UI.Design.WebControls/ObjectDesignerDataSourceView.xml +++ b/xml/System.Web.UI.Design.WebControls/ObjectDesignerDataSourceView.xml @@ -24,11 +24,11 @@ The class provides design-time support for the control in a visual designer. An object provides members that indicate whether various database-type operations can be performed and that return schema and design-time data. - The , , and properties indicate whether the associated control can perform the corresponding database-type operations. + The , , and properties indicate whether the associated control can perform the corresponding database-type operations. - The property, which is always `true`, indicates that the associated control can sort rows. The and properties, which are always `false`, indicate that the associated control cannot perform server paging and cannot return the total number of rows in a query, respectively. + The property, which is always `true`, indicates that the associated control can sort rows. The and properties, which are always `false`, indicate that the associated control cannot perform server paging and cannot return the total number of rows in a query, respectively. - The property gets a schema that describes the data source view that is represented by this view object. The method generates design-time data that matches the schema of the associated control. + The property gets a schema that describes the data source view that is represented by this view object. The method generates design-time data that matches the schema of the associated control. ]]> @@ -73,7 +73,7 @@ class when requested by the method of the object that is associated with the control on the visual designer surface. + The .NET Framework creates a new instance of the class when requested by the method of the object that is associated with the control on the visual designer surface. ]]> @@ -306,7 +306,7 @@ method provides a design-time version of the view for use by the associated data-bound control designer. + The method provides a design-time version of the view for use by the associated data-bound control designer. It is not expected that the designer will perform actual data access at design-time time. Instead, the designer creates sample data that matches the schema of the data source. @@ -340,7 +340,7 @@ property gets the schema tables from the associated designer. If any objects are returned, the schema selects the with the same property as this view object, or it selects the first if this view has no name. The then creates and returns a object from the selected . + The property gets the schema tables from the associated designer. If any objects are returned, the schema selects the with the same property as this view object, or it selects the first if this view has no name. The then creates and returns a object from the selected . This allows the designer of a data-bound control to provide relevant choices based on the design-time data source view that is selected for data binding. diff --git a/xml/System.Web.UI.Design.WebControls/PanelContainerDesigner.xml b/xml/System.Web.UI.Design.WebControls/PanelContainerDesigner.xml index 7b29b933edd..b59ecc6751d 100644 --- a/xml/System.Web.UI.Design.WebControls/PanelContainerDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/PanelContainerDesigner.xml @@ -28,7 +28,7 @@ The property always returns `true`, indicating that the designer creates a temporary copy of the associated to generate the design-time markup. - The method prepares the designer to view, edit, and design the associated control. The method sets collection elements to the string representations of various style attributes of the associated control. + The method prepares the designer to view, edit, and design the associated control. The method sets collection elements to the string representations of various style attributes of the associated control. @@ -43,7 +43,7 @@ - The property to provide a default caption for the `MyPanelContainer` control, if none was defined. -- The method to throw an exception, if the associated control is not a `MyPanelContainer` object. +- The method to throw an exception, if the associated control is not a `MyPanelContainer` object. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.PanelContainerDesigner/CS/PanelContainerDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.PanelContainerDesigner/VB/PanelContainerDesigner.vb" id="Snippet1"::: @@ -122,9 +122,9 @@ method calls the base method, which adds string representations of style attributes to the `styleAttributes` collection. These attributes are based on the style properties of the associated control. + The method calls the base method, which adds string representations of style attributes to the `styleAttributes` collection. These attributes are based on the style properties of the associated control. - The sets the direction of `styleAttribute` to a code indicating left-to-right or right-to-left, based on the value of the property of the associated control. + The sets the direction of `styleAttribute` to a code indicating left-to-right or right-to-left, based on the value of the property of the associated control. ]]> @@ -198,7 +198,7 @@ property is an empty string (""), the property returns an empty object. Otherwise, the property returns a default object that is generated by the base property. + If the property is an empty string (""), the property returns an empty object. Otherwise, the property returns a default object that is generated by the base property. @@ -242,14 +242,14 @@ method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. + The visual designer calls the method when it is ready to use the designer to render the control. The and its base methods configure properties and set up events that are necessary for the operation of the designer. The `component` parameter is the control that is associated with this designer or a copy of the control. ## Examples - The following code example shows how to override the method in a class that is inherited from the class to change the behavior of a control that is derived from the class at design time. The example throws an exception, if the associated control is not a `MyPanelContainer` object. + The following code example shows how to override the method in a class that is inherited from the class to change the behavior of a control that is derived from the class at design time. The example throws an exception, if the associated control is not a `MyPanelContainer` object. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.PanelContainerDesigner/CS/PanelContainerDesigner.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.PanelContainerDesigner/VB/PanelContainerDesigner.vb" id="Snippet5"::: diff --git a/xml/System.Web.UI.Design.WebControls/PanelDesigner.xml b/xml/System.Web.UI.Design.WebControls/PanelDesigner.xml index d209294fd16..d87d1be67ad 100644 --- a/xml/System.Web.UI.Design.WebControls/PanelDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/PanelDesigner.xml @@ -24,17 +24,17 @@ Provides design-time support in a visual designer for the control. - control is used as a container for other controls, especially when controls are generated programmatically. - - The class provides design-time support for controls in a visual designer. However, for all new implementations of the Panel control, use the instead of the . - - In a visual designer, when you switch from Source to Design view, the markup source code that describes the associated control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to markup source code and edited into the markup for the Web page. - - The method maps a specified property and value to a specified markup style. The method provides notification when a behavior is attached to the designer. - + control is used as a container for other controls, especially when controls are generated programmatically. + + The class provides design-time support for controls in a visual designer. However, for all new implementations of the Panel control, use the instead of the . + + In a visual designer, when you switch from Source to Design view, the markup source code that describes the associated control is parsed and a design-time version of the control is created on the design surface. When you switch back to Source view, the design-time control is persisted to markup source code and edited into the markup for the Web page. + + The method maps a specified property and value to a specified markup style. The method provides notification when a behavior is attached to the designer. + ]]> @@ -69,11 +69,11 @@ Initializes a new instance of the class. - class when it creates the associated control or a copy of that control on the design surface. - + class when it creates the associated control or a copy of that control on the design surface. + ]]> @@ -109,11 +109,11 @@ An object that is the property value. Maps a specified property and value to a specified markup style. - method provides special handling for the and properties, but calls the base method for all other values of the `propName` parameter. - + method provides special handling for the and properties, but calls the base method for all other values of the `propName` parameter. + ]]> @@ -149,11 +149,11 @@ Provides notification when a behavior is attached to the designer. - method calls the base method. Then the maps the and properties to the appropriate style by using the method, if these properties are defined. - + method calls the base method. Then the maps the and properties to the appropriate style by using the method, if these properties are defined. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ParameterCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/ParameterCollectionEditor.xml index d3ee5f0ff7b..0cf73bb1b86 100644 --- a/xml/System.Web.UI.Design.WebControls/ParameterCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/ParameterCollectionEditor.xml @@ -17,23 +17,23 @@ Provides a component editor for the object that is specified by the properties of the associated data source control. - class provides a user interface for editing the elements of the object at design time, as specified by one of the `Parameters` properties. The `Parameters` properties include the , , , and properties of the , , and other data source controls. - - The is invoked by selecting the ellipsis (**…**) button on one of the `Parameters` properties in the **Properties** grid of the visual designer. - - The method edits the elements of the for the associated data source control. The method gets the editing style that is associated with this editor. - - - -## Examples - The following code example shows how to use the attribute to associate the and (the collection editor base class) classes with a `SelectParameters` property in a custom control. - + class provides a user interface for editing the elements of the object at design time, as specified by one of the `Parameters` properties. The `Parameters` properties include the , , , and properties of the , , and other data source controls. + + The is invoked by selecting the ellipsis (**…**) button on one of the `Parameters` properties in the **Properties** grid of the visual designer. + + The method edits the elements of the for the associated data source control. The method gets the editing style that is associated with this editor. + + + +## Examples + The following code example shows how to use the attribute to associate the and (the collection editor base class) classes with a `SelectParameters` property in a custom control. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DesignerEditors/CS/DesignerEditors.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DesignerEditors/VB/DesignerEditors.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.DesignerEditors/VB/DesignerEditors.vb" id="Snippet2"::: + ]]> @@ -69,11 +69,11 @@ Initializes a new instance of the class. - class when the page designer selects the ellipsis (**…**) button on one of the `Parameters` properties in the visual designer's **Properties** grid while designing the associated data source control. - + class when the page designer selects the ellipsis (**…**) button on one of the `Parameters` properties in the visual designer's **Properties** grid while designing the associated data source control. + ]]> @@ -113,13 +113,13 @@ Edits the elements of the objects of the associated data source control. The new ; otherwise, if the value of the object has not changed, unchanged. - method extracts the associated data source control and the data source control designer that is associated with that control from the `context` parameter. The supported data source controls include the and controls, with their corresponding and designers. - - Once the data is extracted, the calls back to the data source control designer to display an editing dialog box that is used to edit a object that is referenced by one of the `Parameters` properties of the data source control. - + method extracts the associated data source control and the data source control designer that is associated with that control from the `context` parameter. The supported data source controls include the and controls, with their corresponding and designers. + + Once the data is extracted, the calls back to the data source control designer to display an editing dialog box that is used to edit a object that is referenced by one of the `Parameters` properties of the data source control. + ]]> @@ -157,11 +157,11 @@ Gets the editing style that is associated with this editor. The editing style that is associated with this editor. - method always returns the value, which indicates that the user interface for the editor is a modal dialog box. - + method always returns the value, which indicates that the user interface for the editor is a modal dialog box. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ParameterEditorUserControl.xml b/xml/System.Web.UI.Design.WebControls/ParameterEditorUserControl.xml index 7b7f9aeb036..c74c1066fe5 100644 --- a/xml/System.Web.UI.Design.WebControls/ParameterEditorUserControl.xml +++ b/xml/System.Web.UI.Design.WebControls/ParameterEditorUserControl.xml @@ -17,17 +17,17 @@ Provides a reusable object for editing objects. - class provides a user interface for editing the elements of objects that are referenced by several different properties of controls at design time. - - The class encapsulates most of the functionality of the . The consists of an enclosing form that holds the , and **OK** and **Cancel** buttons. - - The method adds an array of existing parameters to the . The method removes all parameters from the . The method gets all parameters from the . - - The method controls whether additions and deletions can be made to the parameters in the . - + class provides a user interface for editing the elements of objects that are referenced by several different properties of controls at design time. + + The class encapsulates most of the functionality of the . The consists of an enclosing form that holds the , and **OK** and **Cancel** buttons. + + The method adds an array of existing parameters to the . The method removes all parameters from the . The method gets all parameters from the . + + The method controls whether additions and deletions can be made to the parameters in the . + ]]> @@ -67,11 +67,11 @@ An interface to the current design host, such as Visual Studio 2005. Initializes a new instance of the class using the specified . - constructor initializes the component controls of the object, initializes UI elements, connects events for the individual component editors, and adds the component editors to the collection for the . - + constructor initializes the component controls of the object, initializes UI elements, connects events for the individual component editors, and adds the component editors to the collection for the . + ]]> @@ -102,11 +102,11 @@ A array of existing parameters to add to the editor. Adds an array of existing parameters to the editor. - method adds the elements of `parameters` to the control in the object. If there is more than one element, the selects the first one in the . Then the refreshes the control and raises the event. - + method adds the elements of `parameters` to the control in the object. If there is more than one element, the selects the first one in the . Then the refreshes the control and raises the event. + ]]> @@ -138,11 +138,11 @@ Removes all parameters from the editor. - method removes the parameters from the control in the object. Then the refreshes the control and raises the event. - + method removes the parameters from the control in the object. Then the refreshes the control and raises the event. + ]]> @@ -175,11 +175,11 @@ Gets all parameters from the editor. A array of all parameters from the editor. - method populates a array with all parameters from the control in the . - + method populates a array with all parameters from the control in the . + ]]> @@ -293,11 +293,11 @@ A that indicates whether additions and deletions can be made to the being edited. Controls whether additions and deletions can be made to the values in the editor. - method controls whether additions and deletions can be made to the element in the object. The enables or disables the Up, Down, Add, and Delete buttons but it does not affect the editing of individual elements. - + method controls whether additions and deletions can be made to the element in the object. The enables or disables the Up, Down, Add, and Delete buttons but it does not affect the editing of individual elements. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/RegexEditorDialog.xml b/xml/System.Web.UI.Design.WebControls/RegexEditorDialog.xml index 206464b34d1..08f7b062a6b 100644 --- a/xml/System.Web.UI.Design.WebControls/RegexEditorDialog.xml +++ b/xml/System.Web.UI.Design.WebControls/RegexEditorDialog.xml @@ -176,7 +176,7 @@ method and the method, if it has been overridden. invokes the protected method with the `disposing` parameter set to `true`. `Finalize` specifies the `disposing` parameter as `false`. + This method is called by the public method and the method, if it has been overridden. invokes the protected method with the `disposing` parameter set to `true`. `Finalize` specifies the `disposing` parameter as `false`. When the `disposing` parameter is `true`, this method releases all resources held by any managed objects that this references. This method invokes the `Dispose()` method of each referenced object. diff --git a/xml/System.Web.UI.Design.WebControls/RepeaterDesigner.xml b/xml/System.Web.UI.Design.WebControls/RepeaterDesigner.xml index 115524b5133..91edcd77899 100644 --- a/xml/System.Web.UI.Design.WebControls/RepeaterDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/RepeaterDesigner.xml @@ -479,7 +479,7 @@ method uses the method to construct a data source from the object that is specified by the and properties. + The method uses the method to construct a data source from the object that is specified by the and properties. ]]> @@ -517,7 +517,7 @@ method uses the method to construct a data source from the object that is specified by the property. + The method uses the method to construct a data source from the object that is specified by the property. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/RoleGroupCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/RoleGroupCollectionEditor.xml index ebaf0d8a274..a5b7873a7c9 100644 --- a/xml/System.Web.UI.Design.WebControls/RoleGroupCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/RoleGroupCollectionEditor.xml @@ -74,11 +74,11 @@ . - method is inherited from the class. - + method is inherited from the class. + ]]> Extending Design-Time Support diff --git a/xml/System.Web.UI.Design.WebControls/SiteMapDataSourceDesigner.xml b/xml/System.Web.UI.Design.WebControls/SiteMapDataSourceDesigner.xml index 6f3ac1768a9..bba8cba5af4 100644 --- a/xml/System.Web.UI.Design.WebControls/SiteMapDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/SiteMapDataSourceDesigner.xml @@ -128,11 +128,11 @@ Gets an array of names representing named views in the data source. This implementation always returns an empty string array. - ASP.NET Site Maps @@ -191,11 +191,11 @@ A object containing information about the event. Called when the associated component changes. - also calls the base method, which raises the event, and also calls the method which raises the event. - + also calls the base method, which raises the event, and also calls the method which raises the event. + ]]> Extending Design-Time Support @@ -254,11 +254,11 @@ if the underlying data source has a configuration wizard that can be launched with the method; otherwise, . - instance is cast to an interface. - + instance is cast to an interface. + ]]> ASP.NET Site Maps @@ -288,11 +288,11 @@ For a description of this member, see . Always . - instance is cast to an interface. - + instance is cast to an interface. + ]]> ASP.NET Site Maps @@ -322,11 +322,11 @@ For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> ASP.NET Site Maps @@ -354,11 +354,11 @@ For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> Extending Design-Time Support @@ -392,11 +392,11 @@ For a description of this member, see . A designer data-source view that contains information about the identified view, or if a view with the specified name is not found. - instance is cast to an interface. - + instance is cast to an interface. + ]]> ASP.NET Site Maps @@ -433,11 +433,11 @@ For a description of this member, see . The names of the views in the underlying data source. - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -472,11 +472,11 @@ suppresses data source events until the refresh is finished. For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -507,11 +507,11 @@ For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> @@ -540,11 +540,11 @@ For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> ASP.NET Site Maps @@ -574,11 +574,11 @@ For a description of this member, see . - instance is cast to an interface. - + instance is cast to an interface. + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/SqlDataSourceConnectionStringEditor.xml b/xml/System.Web.UI.Design.WebControls/SqlDataSourceConnectionStringEditor.xml index afdbf2b4ac7..82361e5046b 100644 --- a/xml/System.Web.UI.Design.WebControls/SqlDataSourceConnectionStringEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/SqlDataSourceConnectionStringEditor.xml @@ -24,7 +24,7 @@ If an interface is available, connection strings are retrieved from the data services of the visual designer. If an interface is not available, a modal dialog box is shown to allow editing of the connection string. - Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method displays a user interface for building the connection string expression and returns the connection string that is selected by the user. The method indicates the display style of the user interface. + Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method displays a user interface for building the connection string expression and returns the connection string that is selected by the user. The method indicates the display style of the user interface. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/SqlDataSourceDesigner.xml b/xml/System.Web.UI.Design.WebControls/SqlDataSourceDesigner.xml index 2f0dba7abf9..c378f567630 100644 --- a/xml/System.Web.UI.Design.WebControls/SqlDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/SqlDataSourceDesigner.xml @@ -537,7 +537,7 @@ method will be called by the design host only if is `true`. + The method will be called by the design host only if is `true`. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/SubMenuStyleCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/SubMenuStyleCollectionEditor.xml index 9db197cbe3b..8cf87dea9c9 100644 --- a/xml/System.Web.UI.Design.WebControls/SubMenuStyleCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/SubMenuStyleCollectionEditor.xml @@ -26,9 +26,9 @@ The is invoked, for example, by selecting the ellipsis button (**…**) on the **LevelSubMenuStyles** row in the **Properties** grid of the visual designer. - The method always returns `false` to indicate that only one object can be selected at a time in the editor. The method creates a new form to display and edit the . + The method always returns `false` to indicate that only one object can be selected at a time in the editor. The method creates a new form to display and edit the . - The method creates a new instance of the specified collection item type. The method returns an array of types that the editor can create. + The method creates a new instance of the specified collection item type. The method returns an array of types that the editor can create. @@ -113,7 +113,7 @@ method always returns `false`; thus, only one object can be selected at a time in the object. + The method always returns `false`; thus, only one object can be selected at a time in the object. ]]> @@ -149,7 +149,7 @@ method calls the base method to create the form, and then formats a caption for the form. + The method calls the base method to create the form, and then formats a caption for the form. ]]> @@ -187,7 +187,7 @@ method is used to create new objects. The calls the method to access the activation methods for late-bound support. + The method is used to create new objects. The calls the method to access the activation methods for late-bound support. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/TableDesigner.xml b/xml/System.Web.UI.Design.WebControls/TableDesigner.xml index 87c5fe1f25e..c0c56896758 100644 --- a/xml/System.Web.UI.Design.WebControls/TableDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/TableDesigner.xml @@ -24,19 +24,19 @@ Extends design-time behavior for the Web server control. - class. The second code example demonstrates how to display the `StyledTable` class at design time. - - The following code example demonstrates how to create a designer class named `StyledTableDesigner`, which is derived from the class, and is used to display two cells at design time for a class that is derived from the class. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.TableDesigner/VB/customtabledesigner.vb" id="Snippet1"::: - - The following code example uses the `DesignerAttribute` to associate the `StyledTableDesigner` class with the `StyledTable` class so that it can be displayed at design time. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.TableDesigner/VB/customtable.vb" id="Snippet3"::: - + class. The second code example demonstrates how to display the `StyledTable` class at design time. + + The following code example demonstrates how to create a designer class named `StyledTableDesigner`, which is derived from the class, and is used to display two cells at design time for a class that is derived from the class. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.TableDesigner/VB/customtabledesigner.vb" id="Snippet1"::: + + The following code example uses the `DesignerAttribute` to associate the `StyledTableDesigner` class with the `StyledTable` class so that it can be displayed at design time. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.TableDesigner/VB/customtable.vb" id="Snippet3"::: + ]]> @@ -89,18 +89,18 @@ Gets the HTML that is used to represent the control at design time. The HTML used to represent the control at design time. - method ensures that the table has at least one row and cell and that the cells contain some text for display at design time. - - - -## Examples - The following code example demonstrates how to override the method to display rows and cells for the `StyledTable` class on the design surface. In the `Try` block, the code checks whether the table contains any rows or cells, and if it does not, creates a row and performs a loop to create two cells for the row, along with placeholder text to display in each cell at design time. If the table is not empty, but a row is, the code performs the same loop to create and populate the cells. In the `Finally` block, the code returns the values to their original state. - - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.TableDesigner/VB/customtabledesigner.vb" id="Snippet2"::: - + method ensures that the table has at least one row and cell and that the cells contain some text for display at design time. + + + +## Examples + The following code example demonstrates how to override the method to display rows and cells for the `StyledTable` class on the design surface. In the `Try` block, the code checks whether the table contains any rows or cells, and if it does not, creates a row and performs a loop to create two cells for the row, along with placeholder text to display in each cell at design time. If the table is not empty, but a row is, the code performs the same loop to create and populate the cells. In the `Finally` block, the code returns the values to their original state. + + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.TableDesigner/VB/customtabledesigner.vb" id="Snippet2"::: + ]]> diff --git a/xml/System.Web.UI.Design.WebControls/ValidationSummaryDesigner.xml b/xml/System.Web.UI.Design.WebControls/ValidationSummaryDesigner.xml index 8d82c142bed..89ae9665110 100644 --- a/xml/System.Web.UI.Design.WebControls/ValidationSummaryDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/ValidationSummaryDesigner.xml @@ -114,7 +114,7 @@ method to shadow control properties with corresponding design-time properties that the designer implements, to add properties to the properties grid, to remove properties from the properties grid, and to change attributes of properties in the properties grid. + Control designers use methods that are derived from the method to shadow control properties with corresponding design-time properties that the designer implements, to add properties to the properties grid, to remove properties from the properties grid, and to change attributes of properties in the properties grid. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/WizardDesigner.xml b/xml/System.Web.UI.Design.WebControls/WizardDesigner.xml index 0c9a0ba477f..18868342b29 100644 --- a/xml/System.Web.UI.Design.WebControls/WizardDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/WizardDesigner.xml @@ -411,16 +411,16 @@ The event data. Called when the associated control changes. - method is called when a property of the associated control is changed. This lets you perform any processing that is required after a property change. - + method is called when a property of the associated control is changed. This lets you perform any processing that is required after a property change. + ]]> - Override the method to provide additional processing before you persist the control and before you refresh the design-time HTML markup. - + Override the method to provide additional processing before you persist the control and before you refresh the design-time HTML markup. + When you override the method in a derived class, make sure that you call the method for the base class so that registered delegates receive the event. diff --git a/xml/System.Web.UI.Design.WebControls/WizardStepCollectionEditor.xml b/xml/System.Web.UI.Design.WebControls/WizardStepCollectionEditor.xml index 3ffc40612a4..f62aba58128 100644 --- a/xml/System.Web.UI.Design.WebControls/WizardStepCollectionEditor.xml +++ b/xml/System.Web.UI.Design.WebControls/WizardStepCollectionEditor.xml @@ -154,7 +154,7 @@ property of the base class. Use the method to override the default implementation. + The default implementation looks in the collection for the Item property and returns the returning Type of the item. Do not call this directly. Instead, use the property of the base class. Use the method to override the default implementation. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/XmlDataSourceDesigner.xml b/xml/System.Web.UI.Design.WebControls/XmlDataSourceDesigner.xml index 5c6f9359087..c1dab45870c 100644 --- a/xml/System.Web.UI.Design.WebControls/XmlDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/XmlDataSourceDesigner.xml @@ -135,7 +135,7 @@ method is called by the design host, if the property is `true`. + The method is called by the design host, if the property is `true`. ]]> diff --git a/xml/System.Web.UI.Design.WebControls/XmlDesigner.xml b/xml/System.Web.UI.Design.WebControls/XmlDesigner.xml index f0a1a022f08..3f746a929e7 100644 --- a/xml/System.Web.UI.Design.WebControls/XmlDesigner.xml +++ b/xml/System.Web.UI.Design.WebControls/XmlDesigner.xml @@ -80,14 +80,14 @@ when you are finished using the class. The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). + Call when you are finished using the class. The method leaves the in an unusable state. After calling , you must release all references to the so the garbage collector can reclaim the memory that the was occupying. For more information, see [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged) and [Implementing a Dispose Method](/dotnet/standard/garbage-collection/implementing-dispose). > [!NOTE] -> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. +> Always call before you release your last reference to the . Otherwise, the resources it is using will not be freed until the garbage collector calls the object's `Finalize` method. - The method is called by the public `Dispose()` method and the method, if it has been overridden. The `Dispose()` invokes the protected `Dispose(Boolean)` method with `disposing` set to `true`. The `Finalize` specifies the `disposing` parameter as `false`. + The method is called by the public `Dispose()` method and the method, if it has been overridden. The `Dispose()` invokes the protected `Dispose(Boolean)` method with `disposing` set to `true`. The `Finalize` specifies the `disposing` parameter as `false`. - When `disposing` is `true`, the method releases all resources that are held by any managed objects that this references. The method invokes the `Dispose()` method of each referenced object. + When `disposing` is `true`, the method releases all resources that are held by any managed objects that this references. The method invokes the `Dispose()` method of each referenced object. ]]> diff --git a/xml/System.Web.UI.Design/AppSettingsExpressionEditor.xml b/xml/System.Web.UI.Design/AppSettingsExpressionEditor.xml index 756b27f064c..83776a6e575 100644 --- a/xml/System.Web.UI.Design/AppSettingsExpressionEditor.xml +++ b/xml/System.Web.UI.Design/AppSettingsExpressionEditor.xml @@ -28,7 +28,7 @@ The property for an object returns the string `AppSettings`. The class is associated with the expression prefix `AppSettings` and the implementation. - The method evaluates an input application setting expression string. The method returns the implementation that is used to enter and edit application setting expressions. + The method evaluates an input application setting expression string. The method returns the implementation that is used to enter and edit application setting expressions. @@ -135,11 +135,11 @@ method looks up the application setting that is specified by `expression`, and then returns the value of the application setting. + The method looks up the application setting that is specified by `expression`, and then returns the value of the application setting. - The visual designer uses the method to evaluate an application setting expression and provide the design-time value for an associated control property. The visual designer calls the method with the expression string, and uses the evaluated expression result to assign control property values that are rendered on the design surface. + The visual designer uses the method to evaluate an application setting expression and provide the design-time value for an associated control property. The visual designer calls the method with the expression string, and uses the evaluated expression result to assign control property values that are rendered on the design surface. - At run time, the page parser uses the and methods of the corresponding implementation to evaluate an expression and provide the run-time value for an associated control property. + At run time, the page parser uses the and methods of the corresponding implementation to evaluate an expression and provide the run-time value for an associated control property. ]]> @@ -180,7 +180,7 @@ method returns a simple editor sheet implementation, which uses a single input string to form the expression. + The method returns a simple editor sheet implementation, which uses a single input string to form the expression. ]]> diff --git a/xml/System.Web.UI.Design/ClientScriptItem.xml b/xml/System.Web.UI.Design/ClientScriptItem.xml index 5732f56b8f1..644607439bd 100644 --- a/xml/System.Web.UI.Design/ClientScriptItem.xml +++ b/xml/System.Web.UI.Design/ClientScriptItem.xml @@ -22,9 +22,9 @@ ## Remarks The class represents a `script` element that is contained in a Web document at design time. A custom control designer implementation can use a object to add client script elements to a Web Form or user control. - At design time, use the class to set or examine client script elements that are contained in a document, such as a Web form, a Web server control, a content page, or a master page, on the design surface. Retrieve the collection of client script elements that are contained within the Web document by using the method. Add a client script element to the Web document by using the method. + At design time, use the class to set or examine client script elements that are contained in a document, such as a Web form, a Web server control, a content page, or a master page, on the design surface. Retrieve the collection of client script elements that are contained within the Web document by using the method. Add a client script element to the Web document by using the method. - Typically, a `script` element either contains script statements or specifies an external location for script statements. The `script` element can optionally define the language of the script statements. Use the constructor to initialize the properties for a new script object. Use the properties to examine the `script` object attributes and contents. The property represents the `language` attribute of the `script` element. The property represents the `src` attribute. The property represents the script statements to be executed on the client that are contained in the `script` element. + Typically, a `script` element either contains script statements or specifies an external location for script statements. The `script` element can optionally define the language of the script statements. Use the constructor to initialize the properties for a new script object. Use the properties to examine the `script` object attributes and contents. The property represents the `language` attribute of the `script` element. The property represents the `src` attribute. The property represents the script statements to be executed on the client that are contained in the `script` element. Use the class to manage scripts that are to be executed at design-time. @@ -171,7 +171,7 @@ ## Remarks The property represents the language in which the script statements are written. If the property is `null` or an empty string (""), the `language` attribute is not set in the `script` element. When a client script block does not specify the script language, the client browser determines the language. - The property is initialized by the constructor. + The property is initialized by the constructor. ]]> @@ -211,11 +211,11 @@ property specifies an external source location for the client script contents. Typically, the script statements for a `script` element are specified using either the or property. + The property specifies an external source location for the client script contents. Typically, the script statements for a `script` element are specified using either the or property. If the property is `null` or an empty string (""), the `src` attribute is not set in the `script` element. - The property is initialized by the . + The property is initialized by the . ]]> @@ -255,11 +255,11 @@ property represents the statements that are contained in the `script` element. Typically, the script statements for a `script` element are specified using either the or property. + The property represents the statements that are contained in the `script` element. Typically, the script statements for a `script` element are specified using either the or property. If the property is `null` or an empty string (""), the `script` element does not contain any script statements. - The property is initialized by the constructor. + The property is initialized by the constructor. ]]> diff --git a/xml/System.Web.UI.Design/ClientScriptItemCollection.xml b/xml/System.Web.UI.Design/ClientScriptItemCollection.xml index 6caf088cf1f..03f1f5c90b0 100644 --- a/xml/System.Web.UI.Design/ClientScriptItemCollection.xml +++ b/xml/System.Web.UI.Design/ClientScriptItemCollection.xml @@ -22,7 +22,7 @@ ## Remarks Each object in the class represents a `script` block that is contained in a document (a Web Form, Web server control, a content page, or a master page) at design time. - Use the class to set or examine client script elements that are contained in a Web Forms document on the design surface. Retrieve the collection of client script elements that are contained within the Web document by using the method. Add a client script element to the Web document by using the method. + Use the class to set or examine client script elements that are contained in a Web Forms document on the design surface. Retrieve the collection of client script elements that are contained within the Web document by using the method. Add a client script element to the Web document by using the method. To add client script elements at run time, use the class. @@ -62,7 +62,7 @@ ## Remarks If `clientScriptItems` is `null` (`Nothing` in Visual Basic) or does not contain any elements, the constructor initializes an empty object. Otherwise, the items in the `clientScriptItems` array are used to set the items for the . - The constructor is typically used in classes that are derived from the class. Visual designers implement the method to return a object for the client script elements in a Web document at design time. + The constructor is typically used in classes that are derived from the class. Visual designers implement the method to return a object for the client script elements in a Web document at design time. ]]> diff --git a/xml/System.Web.UI.Design/ColorBuilder.xml b/xml/System.Web.UI.Design/ColorBuilder.xml index d6269a22b1e..086e79e36ab 100644 --- a/xml/System.Web.UI.Design/ColorBuilder.xml +++ b/xml/System.Web.UI.Design/ColorBuilder.xml @@ -18,24 +18,24 @@ Provides an HTML color string builder at design time that allows a user to select a color. - method starts a user interface for selecting a color value. - - The class is not intended for use outside of the design time environment. requires the , which is typically available within a Web Forms project at design time. If you want to build HTML color strings, you may want to implement a method that converts the RGB values of a object to an HTML-compatible RRGGBB format string. If you intend to use a control to select a color or configure a color, you can build a user interface for this, or you may want to use a control which allows you to edit properties with the default providing a color selection interface. - - - -## Examples + method starts a user interface for selecting a color value. + + The class is not intended for use outside of the design time environment. requires the , which is typically available within a Web Forms project at design time. If you want to build HTML color strings, you may want to implement a method that converts the RGB values of a object to an HTML-compatible RRGGBB format string. If you intend to use a control to select a color or configure a color, you can build a user interface for this, or you may want to use a control which allows you to edit properties with the default providing a color selection interface. + + + +## Examples :::code language="cpp" source="~/snippets/cpp/VS_Snippets_WebNet/ColorBuilderExample/CPP/colorbuilderdesigner.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/ColorBuilderExample/CS/colorbuilderdesigner.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/ColorBuilderExample/VB/colorbuilderdesigner.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/ColorBuilderExample/VB/colorbuilderdesigner.vb" id="Snippet1"::: + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_WebNet/ColorBuilderExample/CPP/colorbuilderdesigner.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/ColorBuilderExample/CS/colorbuilderdesigner.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/ColorBuilderExample/VB/colorbuilderdesigner.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/ColorBuilderExample/VB/colorbuilderdesigner.vb" id="Snippet2"::: + ]]> @@ -69,18 +69,18 @@ Starts a color editor to build an HTML color property value. The color value, represented as a string in an HTML color format, or if the builder service could not be retrieved. - diff --git a/xml/System.Web.UI.Design/ConnectionStringEditor.xml b/xml/System.Web.UI.Design/ConnectionStringEditor.xml index 768d52f4fe8..2c8de8e60dd 100644 --- a/xml/System.Web.UI.Design/ConnectionStringEditor.xml +++ b/xml/System.Web.UI.Design/ConnectionStringEditor.xml @@ -22,7 +22,7 @@ ## Remarks An instance of the class is a object that can be used at design time to select and edit a connection string expression and to assign the expression to a control property. For example, the control uses the class at design time to set the value of the property. - Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method displays a user interface for building the connection string expression and returns the connection string that is selected by the user. The method indicates the display style of the user interface. + Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method displays a user interface for building the connection string expression and returns the connection string that is selected by the user. The method indicates the display style of the user interface. @@ -98,9 +98,9 @@ method starts the user interface for editing the `value` object. The designer host calls the method when you edit the value of a property that the connection string editor is associated with. The input service provider is used to obtain any editing services that are required within the method. + The method starts the user interface for editing the `value` object. The designer host calls the method when you edit the value of a property that the connection string editor is associated with. The input service provider is used to obtain any editing services that are required within the method. - If an service implementation is supported in the specified context, the method initializes a control, which prompts you to select an existing connection expression or build a new connection expression. If an service implementation is not supported in the specified context, the method displays a simple instance of the class, which prompts you to enter the connection expression string. + If an service implementation is supported in the specified context, the method initializes a control, which prompts you to select an existing connection expression or build a new connection expression. If an service implementation is not supported in the specified context, the method displays a simple instance of the class, which prompts you to enter the connection expression string. If you cancel without selecting a connection expression string, the returned object is the same as the `value` parameter. @@ -137,9 +137,9 @@ method of the class returns the value. If an service implementation is supported in the specified context, the method returns the value. + By default, the method of the class returns the value. If an service implementation is supported in the specified context, the method returns the value. - If the method is not supported in the specified context, the method returns the value. + If the method is not supported in the specified context, the method returns the value. ]]> @@ -175,7 +175,7 @@ method gets the provider name for the current instance of the class. For example, in the class, which is derived from class, the method returns the provider name. + The method gets the provider name for the current instance of the class. For example, in the class, which is derived from class, the method returns the provider name. ]]> @@ -211,7 +211,7 @@ method sets the provider name on the `instance` parameter. For example, in the `SqlDataSourceConnectionStringEditor`, which derives from the class, this either sets the provider name or adds an object, if the connection is a configured connection. In this implementation, the method does nothing. + The method sets the provider name on the `instance` parameter. For example, in the `SqlDataSourceConnectionStringEditor`, which derives from the class, this either sets the provider name or adds an object, if the connection is a configured connection. In this implementation, the method does nothing. ]]> diff --git a/xml/System.Web.UI.Design/ConnectionStringsExpressionEditor.xml b/xml/System.Web.UI.Design/ConnectionStringsExpressionEditor.xml index 031f5c9731f..34cca88d40a 100644 --- a/xml/System.Web.UI.Design/ConnectionStringsExpressionEditor.xml +++ b/xml/System.Web.UI.Design/ConnectionStringsExpressionEditor.xml @@ -17,13 +17,13 @@ Provides properties and methods for selecting a data connection expression that is associated with a control property at design time. - class to select a connection string from the `connectionStrings` configuration section. - - The class is derived from the class, and although it is public for technical reasons, there is no advantage in deriving from it. - + class to select a connection string from the `connectionStrings` configuration section. + + The class is derived from the class, and although it is public for technical reasons, there is no advantage in deriving from it. + ]]> @@ -91,15 +91,15 @@ Evaluates a connection string expression and provides the design-time value for a control property. The object referenced by the evaluated expression string if the expression evaluation succeeded; otherwise, . - method looks up the connection name and type specified by `expression`, and then returns the connection. - - The visual designer uses the method to evaluate a connection string expression and provide the design-time value for an associated control property. The visual designer uses the method to parse the expression string at design time, and then calls the method with the parsed expression data. The visual designer uses the evaluated expression result to assign control property values that are rendered on the design surface. - - At run time, the page parser uses the and methods of the corresponding implementation to evaluate an expression and provide the run-time value for an associated control property. - + method looks up the connection name and type specified by `expression`, and then returns the connection. + + The visual designer uses the method to evaluate a connection string expression and provide the design-time value for an associated control property. The visual designer uses the method to parse the expression string at design time, and then calls the method with the parsed expression data. The visual designer uses the evaluated expression result to assign control property values that are rendered on the design surface. + + At run time, the page parser uses the and methods of the corresponding implementation to evaluate an expression and provide the run-time value for an associated control property. + ]]> @@ -132,11 +132,11 @@ Returns an expression editor sheet for a connection string expression. An instance that defines the connection string expression properties. - method returns an editor sheet implementation for connection string expressions. The editor sheet for connection string expressions allows users to select a connection name and type, based on the current connection strings that are defined in the [connectionStrings Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/bf7sd233(v=vs.100)) section of the Web configuration file. Once users have selected the connection expression properties, the editor sheet implementation combines the connection name and type into a connection string expression, which is returned to the visual designer. - + method returns an editor sheet implementation for connection string expressions. The editor sheet for connection string expressions allows users to select a connection name and type, based on the current connection strings that are defined in the [connectionStrings Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/bf7sd233(v=vs.100)) section of the Web configuration file. Once users have selected the connection expression properties, the editor sheet implementation combines the connection name and type into a connection string expression, which is returned to the visual designer. + ]]> diff --git a/xml/System.Web.UI.Design/ContainerControlDesigner.xml b/xml/System.Web.UI.Design/ContainerControlDesigner.xml index 1d3c18aa683..4b20ee550b9 100644 --- a/xml/System.Web.UI.Design/ContainerControlDesigner.xml +++ b/xml/System.Web.UI.Design/ContainerControlDesigner.xml @@ -44,7 +44,7 @@ ## Examples - The following code example demonstrates how to derive a designer class from the class. The example defines a simple control that is derived from the class, and then defines an associated designer, which is derived from the class. The derived designer class overrides the and properties to customize the frame that is around the editable region of the control on the design surface. + The following code example demonstrates how to derive a designer class from the class. The example defines a simple control that is derived from the class, and then defines an associated designer, which is derived from the class. The derived designer class overrides the and properties to customize the frame that is around the editable region of the control on the design surface. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/SimpleContainerControlDesigner/CS/simplecontainercontrol.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/SimpleContainerControlDesigner/VB/simplecontainercontrol.vb" id="Snippet1"::: @@ -105,9 +105,9 @@ method adds a set of style attributes for the design-time representation of the control. The style attribute values are added to the `styleAttributes` collection, keyed by the style attribute name. For example, you can access the height value in the collection as `styleAttributes["height"]` for C# or `styleAttributes("height")` for Microsoft Visual Basic. + The method adds a set of style attributes for the design-time representation of the control. The style attribute values are added to the `styleAttributes` collection, keyed by the style attribute name. For example, you can access the height value in the collection as `styleAttributes["height"]` for C# or `styleAttributes("height")` for Microsoft Visual Basic. - If the associated control is not derived from the class, the method does not add attribute values to the `styleAttributes` collection. + If the associated control is not derived from the class, the method does not add attribute values to the `styleAttributes` collection. ]]> @@ -172,7 +172,7 @@ string is the caption that is displayed in the frame around the editable region of the control on the design surface. + The string is the caption that is displayed in the frame around the editable region of the control on the design surface. The default caption for a frame is the property of the designer instance. This is typically the same as the run-time property of the control. @@ -249,11 +249,11 @@ method returns a collection of style attributes for the design-time representation of the control. + The method returns a collection of style attributes for the design-time representation of the control. To examine a style attribute value at design time for a control, use the style attribute name as a key to the returned collection. Style attribute values are stored as strings in the collection. For example, you can access the height value in the collection as `styleAttributes["height"]` for C# or `styleAttributes("height")` for Microsoft Visual Basic. - If the associated control is not derived from the class, the method returns an empty collection. + If the associated control is not derived from the class, the method returns an empty collection. ]]> @@ -291,9 +291,9 @@ method to get the HTML for the control. Child controls that are contained in the editable design region are rendered using their associated control designers. + Use the method to get the HTML for the control. Child controls that are contained in the editable design region are rendered using their associated control designers. - The method initializes a new object for the editable region of associated control, and then returns the region through the `regions` collection. + The method initializes a new object for the editable region of associated control, and then returns the region through the `regions` collection. ]]> @@ -327,7 +327,7 @@ class implements a single designer region instead of a collection of designer regions. Therefore, the `region` parameter is ignored, and the method returns the content for the single designer region that is contained in the control designer. + The class implements a single designer region instead of a collection of designer regions. Therefore, the `region` parameter is ignored, and the method returns the content for the single designer region that is contained in the control designer. ]]> @@ -360,7 +360,7 @@ method returns `null` to indicate that the class does not have persisted inner content. + The method returns `null` to indicate that the class does not have persisted inner content. ]]> @@ -417,7 +417,7 @@ class implements a single designer region instead of a collection of designer regions. Therefore, the `region` parameter is ignored, and the method sets the content for the single designer region that is contained in the control designer. + The class implements a single designer region instead of a collection of designer regions. Therefore, the `region` parameter is ignored, and the method sets the content for the single designer region that is contained in the control designer. ]]> diff --git a/xml/System.Web.UI.Design/ControlDesigner.xml b/xml/System.Web.UI.Design/ControlDesigner.xml index 5edf2d26490..fe3fbefdc9f 100644 --- a/xml/System.Web.UI.Design/ControlDesigner.xml +++ b/xml/System.Web.UI.Design/ControlDesigner.xml @@ -36,7 +36,7 @@ - The property. -- The method. +- The method. - The class. @@ -49,7 +49,7 @@ - The class. -- The method. +- The method. - The class. @@ -60,15 +60,15 @@ ## Control Designer Regions Regions are editable areas in the design-time view of a Web server control. This feature offers WYSIWYG-like editing of the template content, inner controls, and properties at design time. You can have the control designer create controls in regions or you can use the Toolbox to drag and drop controls into regions. Regions are managed with the following features: -- The method. +- The method. - The class. - The class. -- The method. +- The method. -- The method. +- The method. ## Templates The model for creating a UI for design-time editing of templated controls, such as the control, has been greatly improved from earlier versions. You can create complex custom controls that include templates for various parts of the control, and your custom control designer can help page developers who are modifying templates with the following features: @@ -82,15 +82,15 @@ ## Design-Time Rendering The class has the following methods to support design-time rendering of the Web server control. Most of these methods are the same as in earlier versions: -- The method. +- The method. -- The method. +- The method. -- The method. +- The method. -- The method. +- The method. -- The method. +- The method. @@ -160,7 +160,7 @@ and a control, together with properties to set the Text properties on both internal controls, and also the and properties of the control. An associated control designer class creates three commands, each of which sets two properties on the control, and can be rolled back with the undo functionality of the design host. + The following code example demonstrates how to create a simple composite control with a and a control, together with properties to set the Text properties on both internal controls, and also the and properties of the control. An associated control designer class creates three commands, each of which sets two properties on the control, and can be rolled back with the undo functionality of the design host. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DesignerInvokeTransactedChange/CS/InvokeTransactedChangeSample.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DesignerInvokeTransactedChange/VB/InvokeTransactedChangeSample.vb" id="Snippet1"::: @@ -307,15 +307,15 @@ method to create HTML markup to display an error message for a control at design time. The value for `errorMessage` specifies a localized string that is displayed to the user of the control at design time. + Use the method to create HTML markup to display an error message for a control at design time. The value for `errorMessage` specifies a localized string that is displayed to the user of the control at design time. - The class implementation of the method returns a table with two rows, as follows: + The class implementation of the method returns a table with two rows, as follows: - The first row contains the type name and site name for the property of the object. - The second row contains the input error message string. - To generate HTML markup for an error message with an associated exception, use the overload. To generate HTML markup for an exception without specifying a localized error message, use the method. + To generate HTML markup for an error message with an associated exception, use the overload. To generate HTML markup for an exception without specifying a localized error message, use the method. ]]> @@ -355,15 +355,15 @@ method to provide simple HTML markup that can be used to display error and exception details for a control at design time. The value for `errorMessage` specifies a localized string that is displayed to the user of the control at design time. + Use the method to provide simple HTML markup that can be used to display error and exception details for a control at design time. The value for `errorMessage` specifies a localized string that is displayed to the user of the control at design time. - The class implementation of the method returns a table with two rows, as follows: + The class implementation of the method returns a table with two rows, as follows: - The first row contains the type name and site name for the property of the object. -- The second row contains the input error message and the string of the exception. +- The second row contains the input error message and the string of the exception. - To generate HTML markup for an error message without specifying an exception, use the overload. To generate HTML markup for an exception without specifying a localized error message, use the method. + To generate HTML markup for an error message without specifying an exception, use the overload. To generate HTML markup for an exception without specifying a localized error message, use the method. ]]> @@ -449,7 +449,7 @@ method in a templated control designer. A string is then passed as the `instruction` parameter in a call to the method, which provides the design-time HTML markup. + The following code example demonstrates how to override the method in a templated control designer. A string is then passed as the `instruction` parameter in a call to the method, which provides the design-time HTML markup. This code example is part of a larger example provided for the property. @@ -619,7 +619,7 @@ The default implementation of the property returns `false`. > [!NOTE] -> The property is obsolete. Use the method for equivalent control designer functionality. +> The property is obsolete. Use the method for equivalent control designer functionality. ]]> @@ -690,7 +690,7 @@ method in a custom control designer. If the Text property for the associated control is empty, the method calls the method. Otherwise, the method creates and renders a Hyperlink control. + The following code example demonstrates how to override the method in a custom control designer. If the Text property for the associated control is empty, the method calls the method. Otherwise, the method creates and renders a Hyperlink control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.ControlDesigner_Example/CS/SimpleControlDesigner.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.ControlDesigner_Example/VB/simplecontroldesigner.vb" id="Snippet5"::: @@ -739,9 +739,9 @@ method to get the design-time HTML markup and the current list of control designer regions. Using the DesignerRegionCollection, the design host can then request the markup for each editable control designer region. + The design host calls the method to get the design-time HTML markup and the current list of control designer regions. Using the DesignerRegionCollection, the design host can then request the markup for each editable control designer region. - The method is provided for a derived control designer, such as the class, that must process the content for the region before calling the method. + The method is provided for a derived control designer, such as the class, that must process the content for the region before calling the method. @@ -786,7 +786,7 @@ ## Remarks A resource provider factory creates resource providers and resource writers, depending on the current settings in the system.web/globalization section of the configuration file (either the Machine.config or Web.config files for both global and local resources). If no globalization settings are found, the `serviceProvider` parameter is used to create a object using the default implementation for the design host. - Typically, control developers will not override the method. + Typically, control developers will not override the method. ]]> @@ -824,9 +824,9 @@ method returns an empty string (""). + The default implementation of the method returns an empty string (""). - Classes deriving from the class can support region-based editing on the design surface and override the method to return the content for a specified region. + Classes deriving from the class can support region-based editing on the design surface and override the method to return the content for a specified region. @@ -867,12 +867,12 @@ method is to return a string that contains the name of the component. The method should be called in the implementation of the method when there is no design-time HTML markup. + The default behavior of the method is to return a string that contains the name of the component. The method should be called in the implementation of the method when there is no design-time HTML markup. ## Examples - The following code example demonstrates how to override the method in a custom control designer. If the `Text` property for the associated control is empty, the method calls method. Otherwise, the method creates and renders a `Hyperlink` control. + The following code example demonstrates how to override the method in a custom control designer. If the `Text` property for the associated control is empty, the method calls method. Otherwise, the method creates and renders a `Hyperlink` control. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.ControlDesigner_Example/CS/SimpleControlDesigner.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.ControlDesigner_Example/VB/simplecontroldesigner.vb" id="Snippet5"::: @@ -912,12 +912,12 @@ method is typically called, if an exception is thrown in the method. + The method is typically called, if an exception is thrown in the method. ## Examples - The following code example demonstrates how to generate design-time HTML markup for the control when an error occurs and call the method. + The following code example demonstrates how to generate design-time HTML markup for the control when an error occurs and call the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/CS/LoginDesigner.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.WebControls.LoginDesigner/VB/LoginDesigner.vb" id="Snippet2"::: @@ -1003,7 +1003,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method for equivalent control designer functionality. +> The method is obsolete. Use the method for equivalent control designer functionality. ]]> @@ -1127,7 +1127,7 @@ method uses the property to determine whether properties, other than the ID property, should be hidden from the property grids while the control is in template editing mode. + The ID property is never hidden. The method uses the property to determine whether properties, other than the ID property, should be hidden from the property grids while the control is in template editing mode. ]]> @@ -1193,18 +1193,18 @@ method is called by the design host to complete the following actions: + The method is called by the design host to complete the following actions: - Load the control designer with the component to design. -- Set up the view on the control using the method. +- Set up the view on the control using the method. - Verify that the associated control is of the right type. ## Examples - The following code example demonstrates how to use a control class and a control designer class that override the method to initialize internal variables. + The following code example demonstrates how to use a control class and a control designer class that override the method to initialize internal variables. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.ControlDesigner_Example/CS/SimpleControlDesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.ControlDesigner_Example/VB/simplecontroldesigner.vb" id="Snippet1"::: @@ -1247,7 +1247,7 @@ ## Remarks A Web server control is in template mode when a read-only template is currently being viewed or an editable template is being edited in a design host such as Visual Studio 2005. - The class supplies a default object to update the value when the template mode changes for the associated control. Custom designers that are derived from the class can override the method to perform additional processing when the template editing mode changes for a control in the design host. + The class supplies a default object to update the value when the template mode changes for the associated control. Custom designers that are derived from the class can override the method to perform additional processing when the template editing mode changes for a control in the design host. ]]> @@ -1268,7 +1268,7 @@ method also calls method. + Calling method also calls method. ]]> @@ -1300,9 +1300,9 @@ method in the method. + To enable the control designer to handle paint events, use the method in the method. - The method provides the design host with a way to instruct the control designer to redraw the control. Essentially, this is the same as calling method, because it causes the whole control to be redrawn. + The method provides the design host with a way to instruct the control designer to redraw the control. Essentially, this is the same as calling method, because it causes the whole control to be redrawn. ]]> @@ -1335,9 +1335,9 @@ method in the method. + To enable the control designer to handle paint events, use the method in the method. - The method provides the design host with a way to instruct the control designer to redraw a specific part of the control. + The method provides the design host with a way to instruct the control designer to redraw a specific part of the control. ]]> @@ -1392,14 +1392,14 @@ method notifies the design host, which is determined by the property of `component`, that a change is occurring in the associated control and, if the change is not canceled by the design host, invokes the specified `callback` using the specified `context`, and then notifies the design host that the change has completed. + The implementation of the method notifies the design host, which is determined by the property of `component`, that a change is occurring in the associated control and, if the change is not canceled by the design host, invokes the specified `callback` using the specified `context`, and then notifies the design host that the change has completed. If the design host or the associated control throws a static `Canceled` exception field of a exception, the transaction is canceled without invoking `callback`. ## Examples - The following code example demonstrates how to create a simple composite control with a and a control, together with properties to set the label text, and also the , , and properties of the control. An associated control designer class creates three commands, each of which sets two properties on the control. By using the method, you can use the undo functionality of the design host, such as Visual Studio 2005, to roll back each completed transaction as a unit. + The following code example demonstrates how to create a simple composite control with a and a control, together with properties to set the label text, and also the , , and properties of the control. An associated control designer class creates three commands, each of which sets two properties on the control. By using the method, you can use the undo functionality of the design host, such as Visual Studio 2005, to roll back each completed transaction as a unit. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DesignerInvokeTransactedChange/CS/InvokeTransactedChangeSample.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DesignerInvokeTransactedChange/VB/InvokeTransactedChangeSample.vb" id="Snippet1"::: @@ -1451,14 +1451,14 @@ method notifies the design host, which is determined by the property of `component`, that a change is occurring to the specified `member` (property or method) of the associated control and, if the change is not canceled by the design host, invokes the specified `callback` using the specified `context` as the argument, and then notifies the design host that the change has completed. + The implementation of the method notifies the design host, which is determined by the property of `component`, that a change is occurring to the specified `member` (property or method) of the associated control and, if the change is not canceled by the design host, invokes the specified `callback` using the specified `context` as the argument, and then notifies the design host that the change has completed. If the design host or associated control throws a static `Canceled` exception field of a exception, the transaction is canceled without invoking `callback`. ## Examples - For a code example, see . + For a code example, see . ]]> @@ -1510,14 +1510,14 @@ method notifies the design host, which is represented by `serviceProvider`, that a change is occurring to the specified `member` (property or method) of the associated control and, if the change is not canceled by the design host, invokes the specified `callback` using the specified `context` as the argument, and then notifies the design host that the change has completed. + The implementation of the method notifies the design host, which is represented by `serviceProvider`, that a change is occurring to the specified `member` (property or method) of the associated control and, if the change is not canceled by the design host, invokes the specified `callback` using the specified `context` as the argument, and then notifies the design host that the change has completed. If the design host or the associated control throws a static `Canceled` exception field of a exception, the transaction is canceled without invoking `callback`. ## Examples - For a code example, see . + For a code example, see . ]]> @@ -1579,7 +1579,7 @@ ## Remarks > [!NOTE] -> The property is obsolete. Use the property and the method on the property for equivalent control designer functionality. +> The property is obsolete. Use the property and the method on the property for equivalent control designer functionality. ]]> @@ -1625,7 +1625,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the property for equivalent control designer functionality. +> The method is obsolete. Use the method on the property for equivalent control designer functionality. ]]> @@ -1659,7 +1659,7 @@ method is called by the design host to create resource entries for each property that is marked with a object and any properties that use an explicit resource expression as a value. + The method is called by the design host to create resource entries for each property that is marked with a object and any properties that use an explicit resource expression as a value. ]]> @@ -1694,9 +1694,9 @@ method is called after a object has applied a predefined format to the associated control. A object defines the automatic formatting scheme name and style settings that are applied to the control. + The method is called after a object has applied a predefined format to the associated control. A object defines the automatic formatting scheme name and style settings that are applied to the control. - Classes deriving from the class override the method to perform additional processing when an automatic formatting scheme is applied to the associated control. + Classes deriving from the class override the method to perform additional processing when an automatic formatting scheme is applied to the associated control. ]]> @@ -1730,7 +1730,7 @@ ## Remarks > [!NOTE] -> The OnBehaviorAttached method is obsolete. Use the and methods on the property for equivalent control designer functionality. +> The OnBehaviorAttached method is obsolete. Use the and methods on the property for equivalent control designer functionality. ]]> @@ -1776,10 +1776,10 @@ method is called when the data-binding collection has been changed by an external caller. + The method is called when the data-binding collection has been changed by an external caller. > [!NOTE] -> The method is obsolete. Use the event on the collection for equivalent control designer functionality. +> The method is obsolete. Use the event on the collection for equivalent control designer functionality. ]]> @@ -1821,16 +1821,16 @@ - The user enters or exits template editing mode for the control. - The class supplies a default delegate to handle the event. Classes deriving from override the method to process events that are raised when the user clicks a control. + The class supplies a default delegate to handle the event. Classes deriving from override the method to process events that are raised when the user clicks a control. - The method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - The default implementation of the method returns without performing any processing. + The default implementation of the method returns without performing any processing. ## Examples - The following code example shows how to use a handler for the event in a clickable region of the control and use a object to identify the region that is being clicked. + The following code example shows how to use a handler for the event in a clickable region of the control and use a object to identify the region that is being clicked. This code example is part of a larger code example for the class. @@ -1877,7 +1877,7 @@ method is called when a property on the associated control is changed. It allows the implementer to do any processing that might be required after a property change. Calling the method causes the design host to call the method. The base implementation of the method also persists the control in the page markup. + The method is called when a property on the associated control is changed. It allows the implementer to do any processing that might be required after a property change. Calling the method causes the design host to call the method. The base implementation of the method also persists the control in the page markup. ]]> @@ -1918,7 +1918,7 @@ or method is called, the event occurs before any changes are made to the associated control. After the changes are complete, the method occurs. + When either the or method is called, the event occurs before any changes are made to the associated control. After the changes are complete, the method occurs. ]]> @@ -1961,9 +1961,9 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method for equivalent control designer functionality. +> The method is obsolete. Use the method for equivalent control designer functionality. - The method typically is called only by the design-time environment when a user action causes the associated Web server control to be resized. The method might be called several times during a resizing process to display the updated size of the control before the resizing is completed. The width and height properties of the control are updated before the method is called. + The method typically is called only by the design-time environment when a user action causes the associated Web server control to be resized. The method might be called several times during a resizing process to display the updated size of the control before the resizing is completed. The width and height properties of the control are updated before the method is called. ]]> @@ -2005,11 +2005,11 @@ - The user enters or exits template editing mode for the control. - The class supplies a default delegate to handle the event. Classes deriving from should set the value and override the method to process events that are raised when the design host draws the control on the design surface. + The class supplies a default delegate to handle the event. Classes deriving from should set the value and override the method to process events that are raised when the design host draws the control on the design surface. - The method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - The default implementation of the method returns without performing any processing. + The default implementation of the method returns without performing any processing. ]]> @@ -2050,7 +2050,7 @@ method, you can add items to the dictionary of properties that a control designer exposes through a object. + With the method, you can add items to the dictionary of properties that a control designer exposes through a object. The keys in the dictionary of properties are the names of the properties. The objects are of type . @@ -2097,7 +2097,7 @@ method is obsolete and there is no replacement for this feature. + The method is obsolete and there is no replacement for this feature. ]]> @@ -2184,7 +2184,7 @@ method, and then, when the changes are persisted to the tag, all `meta:` attributes are also persisted. + Whenever an item is cloned, there might be some internal data structures, such as `meta:` attributes, that should be included in the cloned control by the control designer. A page developer might add `meta:` attributes to the markup of a control and there is no way, nor is there a reason, for the control to distinguish what those tags might be. Therefore, if your control designer provides a way to edit complex properties or formats before applying changes to a page, you would create a clone of the control, pass both the original control and the clone to this method, and then, when the changes are persisted to the tag, all `meta:` attributes are also persisted. ]]> @@ -2256,7 +2256,7 @@ class can support region-based editing on the design surface and override the method to set the content for a specified region. + Classes deriving from the class can support region-based editing on the design surface and override the method to set the content for a specified region. @@ -2301,9 +2301,9 @@ method is not overridden in derived designers. The base class causes the design host to call the method for the region. Override the method when custom data is required for the control before calling method. + Normally, the method is not overridden in derived designers. The base class causes the design host to call the method for the region. Override the method when custom data is required for the control before calling method. - Use the method to insert HTML markup into a region of the control. + Use the method to insert HTML markup into a region of the control. ]]> @@ -2341,12 +2341,12 @@ method to set the value of the current property for the control designer, instead of the obsolete property. + There are several flags that can be set. For example, use the method to set the value of the current property for the control designer, instead of the obsolete property. ## Examples - The following code example shows how to use the method to indicate that the template is in editing mode. + The following code example shows how to use the method to indicate that the template is in editing mode. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DesignerTemplateGroupSample/CS/TemplateGroupsSample.cs" id="Snippet5"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DesignerTemplateGroupSample/VB/TemplateGroupsSample.vb" id="Snippet5"::: @@ -2461,15 +2461,15 @@ method is called by the design host to update the display of the associated Web server control at design time, such as when the control has been modified. Also, a control designer can call the method after modifying values of the control to update the display of the control. + The method is called by the design host to update the display of the associated Web server control at design time, such as when the control has been modified. Also, a control designer can call the method after modifying values of the control to update the display of the control. > [!NOTE] -> If you are calling the event, or using the object to set properties, the interface calls the method for you. +> If you are calling the event, or using the object to set properties, the interface calls the method for you. ## Examples - The following code example demonstrates how to respond to a `Click` event in a control designer to change the focus between regions in a multi-region control and use the method to update the appearance of the control in the design host. + The following code example demonstrates how to respond to a `Click` event in a control designer to change the focus between regions in a multi-region control and use the method to update the appearance of the control in the design host. This code example is part of a larger example for the class. @@ -2510,7 +2510,7 @@ If the property is `false`, the property returns an instance of the property for the control. Changes to the instance of the control are persisted. - The setting in the object is used to set the value of the property. Therefore, the setting determines the type of control that is returned by the property in the base class. If the is not specified in the control designer declaration, the object behavior is equivalent to specifying the property as `false`. + The setting in the object is used to set the value of the property. Therefore, the setting determines the type of control that is returned by the property in the base class. If the is not specified in the control designer declaration, the object behavior is equivalent to specifying the property as `false`. ]]> @@ -2553,12 +2553,12 @@ If the property is `false`, the property returns an instance of the property for the control. Changes to the instance of the control are persisted. - The setting in the object is used to set the value of the property. Therefore, the setting determines the type of control that is returned by the property in the base class. If the is not specified in the control designer declaration, the object behavior is equivalent to specifying the property as `false`. + The setting in the object is used to set the value of the property. Therefore, the setting determines the type of control that is returned by the property in the base class. If the is not specified in the control designer declaration, the object behavior is equivalent to specifying the property as `false`. ## Examples - The following code example demonstrates how to mark a control designer with the attribute. The code example derives a Web server control from the class and associates the control with a custom control designer implementation. The control designer class declaration is marked with the `SupportsPreviewControl` attribute set to `true`. The control designer overrides the method, and then displays the property of the control in italic at design time. + The following code example demonstrates how to mark a control designer with the attribute. The code example derives a Web server control from the class and associates the control with a custom control designer implementation. The control designer class declaration is marked with the `SupportsPreviewControl` attribute set to `true`. The control designer overrides the method, and then displays the property of the control in italic at design time. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.SupportsPreviewControlAttribute/CS/supportspreviewdesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.SupportsPreviewControlAttribute/VB/supportspreviewdesigner.vb" id="Snippet1"::: diff --git a/xml/System.Web.UI.Design/ControlLocation.xml b/xml/System.Web.UI.Design/ControlLocation.xml index d6c0799e80b..d7a6ca520e5 100644 --- a/xml/System.Web.UI.Design/ControlLocation.xml +++ b/xml/System.Web.UI.Design/ControlLocation.xml @@ -16,11 +16,11 @@ Specifies the possible locations for adding a control in a container. - enumeration is used by the method. - + enumeration is used by the method. + ]]> Extending Design-Time Support diff --git a/xml/System.Web.UI.Design/ControlParser.xml b/xml/System.Web.UI.Design/ControlParser.xml index 8435bdf9a8f..dbbd98f40d5 100644 --- a/xml/System.Web.UI.Design/ControlParser.xml +++ b/xml/System.Web.UI.Design/ControlParser.xml @@ -82,9 +82,9 @@ method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. + The method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. - The method throws an exception if the parser cannot build the control. + The method throws an exception if the parser cannot build the control. @@ -134,9 +134,9 @@ method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. + The method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. - The method throws an exception if the parser cannot build the control. + The method throws an exception if the parser cannot build the control. @@ -183,9 +183,9 @@ method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. + The method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. - The method throws an exception if the parser cannot build the controls from the `controlText` parameter. + The method throws an exception if the parser cannot build the controls from the `controlText` parameter. ]]> @@ -242,7 +242,7 @@ method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. + The method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. ]]> @@ -284,7 +284,7 @@ method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. + The method accesses the string representing the register directives on the ASP.NET Web page using the services of the designer host. Designer host services are acquired through the property of the object, or if that is not available, the service. ]]> diff --git a/xml/System.Web.UI.Design/ControlPersister.xml b/xml/System.Web.UI.Design/ControlPersister.xml index 28821eaf296..db0d737cac6 100644 --- a/xml/System.Web.UI.Design/ControlPersister.xml +++ b/xml/System.Web.UI.Design/ControlPersister.xml @@ -79,7 +79,7 @@ implementation to work correctly. This method uses the of the specified control to retrieve the designer host. + This method requires an implementation to work correctly. This method uses the of the specified control to retrieve the designer host. @@ -121,7 +121,7 @@ implementation to work correctly. This method uses the of the specified control to retrieve the designer host. + This method requires an implementation to work correctly. This method uses the of the specified control to retrieve the designer host. ]]> @@ -330,7 +330,7 @@ method requires an interface implementation in order to work correctly. + The method requires an interface implementation in order to work correctly. ]]> @@ -369,7 +369,7 @@ method requires an interface implementation in order to work correctly. + The method requires an interface implementation in order to work correctly. ]]> diff --git a/xml/System.Web.UI.Design/DataBindingCollectionConverter.xml b/xml/System.Web.UI.Design/DataBindingCollectionConverter.xml index d45a0261d67..8466491253f 100644 --- a/xml/System.Web.UI.Design/DataBindingCollectionConverter.xml +++ b/xml/System.Web.UI.Design/DataBindingCollectionConverter.xml @@ -27,7 +27,7 @@ method for all destination types except , for which an empty string ("") is returned. + This type converter calls the base method for all destination types except , for which an empty string ("") is returned. ]]> @@ -92,7 +92,7 @@ . Otherwise this method calls the method of the base class. + This method returns an empty string if the `destinationType` parameter is of type . Otherwise this method calls the method of the base class. ]]> diff --git a/xml/System.Web.UI.Design/DataBindingCollectionEditor.xml b/xml/System.Web.UI.Design/DataBindingCollectionEditor.xml index 1681513cba4..b656f6ac02d 100644 --- a/xml/System.Web.UI.Design/DataBindingCollectionEditor.xml +++ b/xml/System.Web.UI.Design/DataBindingCollectionEditor.xml @@ -24,11 +24,11 @@ Provides a user interface for editing a collection of data bindings. - class is obsolete. At design time, editing of data bindings is accomplished from a instead of the property grid. For more information, see . - + class is obsolete. At design time, editing of data bindings is accomplished from a instead of the property grid. For more information, see . + ]]> @@ -123,11 +123,11 @@ Gets the editor style used by the method. A object that specifies the editor style of the component or control. - diff --git a/xml/System.Web.UI.Design/DataBindingHandler.xml b/xml/System.Web.UI.Design/DataBindingHandler.xml index d263df3d778..23eecbb8c76 100644 --- a/xml/System.Web.UI.Design/DataBindingHandler.xml +++ b/xml/System.Web.UI.Design/DataBindingHandler.xml @@ -18,17 +18,17 @@ Provides a base class for a data-binding handler. - provides a base class for data-binding handlers. A data-binding handler can be used within a designer to perform data-binding to enable a meaningful display of the control on the design surface. Typically a control's designer is responsible for this functionality. However, when a control is not live on the design surface, such as within the template of another control, it does not have a designer, and this functionality is provided by a data-binding handler if one has been specified with a in the code for the control. - - To use a data-binding handler, the control which has the data-bound property or properties must have a specified within its code that indicates the type of data-binding handler to use. - - For example, the control is associated with the class through a in the code for the class. Within a template for a , a control whose text property has been data bound displays the word "DataBound" on the label. Without the data-binding handler, the label would be invisible at design-time, as it does not have a designer to bind its data-bound properties while in a templated control at design-time. - - To implement a data-binding handler, define a new class that derives from this class and implement the method to set the appropriate properties. - + provides a base class for data-binding handlers. A data-binding handler can be used within a designer to perform data-binding to enable a meaningful display of the control on the design surface. Typically a control's designer is responsible for this functionality. However, when a control is not live on the design surface, such as within the template of another control, it does not have a designer, and this functionality is provided by a data-binding handler if one has been specified with a in the code for the control. + + To use a data-binding handler, the control which has the data-bound property or properties must have a specified within its code that indicates the type of data-binding handler to use. + + For example, the control is associated with the class through a in the code for the class. Within a template for a , a control whose text property has been data bound displays the word "DataBound" on the label. Without the data-binding handler, the label would be invisible at design-time, as it does not have a designer to bind its data-bound properties while in a templated control at design-time. + + To implement a data-binding handler, define a new class that derives from this class and implement the method to set the appropriate properties. + ]]> @@ -85,11 +85,11 @@ The to bind. Binds the specified control. - diff --git a/xml/System.Web.UI.Design/DataColumnSelectionConverter.xml b/xml/System.Web.UI.Design/DataColumnSelectionConverter.xml index a05d6319774..26eb45c62af 100644 --- a/xml/System.Web.UI.Design/DataColumnSelectionConverter.xml +++ b/xml/System.Web.UI.Design/DataColumnSelectionConverter.xml @@ -22,14 +22,14 @@ ## Remarks Use the class to convert object types before assignment to a control property. In general, the class supports converting string object types and supplies a list of standard values available for assignment to the associated control property. The standard values collection is the list of field names for bound column fields for the current control. - To support converting additional object types, derive a class from and override the and methods for the additional object types. To support a custom list of standard assignable values, override the method. + To support converting additional object types, derive a class from and override the and methods for the additional object types. To support a custom list of standard assignable values, override the method. Apply the attribute to specify the class as the type converter for a control property. For example, the property of the control specifies as its type converter. > [!NOTE] > You should never access a type converter directly. Instead, call the appropriate converter by using a object. For more information, see the examples in . - The method indicates that the converter supports returning a list of available values through the method. The method indicates that the list is not an exclusive list of possible values. + The method indicates that the converter supports returning a list of available values through the method. The method indicates that the list is not an exclusive list of possible values. ]]> @@ -103,9 +103,9 @@ method to determine whether the method supports converting the source type. + Call the method to determine whether the method supports converting the source type. - The method can convert only from a string, so the method returns `true` when `sourceType` is a string. + The method can convert only from a string, so the method returns `true` when `sourceType` is a string. ]]> @@ -144,7 +144,7 @@ ## Remarks If `value` is a string, then the string representation of `value` is returned. If `value` is `null`, an empty string ("") is returned. For all other values, a exception is thrown. - Call the method to determine whether the method supports converting the source type. + Call the method to determine whether the method supports converting the source type. ]]> @@ -178,9 +178,9 @@ method uses the property of the specified `context` object to obtain an implementation. If the implementation is available, it is used to access the associated control at design time and retrieve the list of available values from the associated component. + The method uses the property of the specified `context` object to obtain an implementation. If the implementation is available, it is used to access the associated control at design time and retrieve the list of available values from the associated component. - The collection of available values is built from the bound column fields in the control. The bound column fields consist of objects in the collection, and from the bound column fields automatically generated for fields in the data source. + The collection of available values is built from the bound column fields in the control. The bound column fields consist of objects in the collection, and from the bound column fields automatically generated for fields in the data source. ]]> @@ -219,7 +219,7 @@ method for a instance returns `false`, indicating that the list returned by the method is not an exclusive list of all possible assignable values. + The method for a instance returns `false`, indicating that the list returned by the method is not an exclusive list of all possible assignable values. ]]> @@ -254,9 +254,9 @@ method indicates whether the converter supports returning a list of available values through the method. + The method indicates whether the converter supports returning a list of available values through the method. - The method for the object returns `true` if the specified `context` object supplies an implementation in its property. The method uses the implementation to access the associated control at design time and retrieve the list of available bound column fields from the associated component. + The method for the object returns `true` if the specified `context` object supplies an implementation in its property. The method uses the implementation to access the associated control at design time and retrieve the list of available bound column fields from the associated component. ]]> diff --git a/xml/System.Web.UI.Design/DataFieldConverter.xml b/xml/System.Web.UI.Design/DataFieldConverter.xml index a286d60604f..09355845515 100644 --- a/xml/System.Web.UI.Design/DataFieldConverter.xml +++ b/xml/System.Web.UI.Design/DataFieldConverter.xml @@ -212,7 +212,7 @@ provides. + If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that provides. ]]> diff --git a/xml/System.Web.UI.Design/DataMemberConverter.xml b/xml/System.Web.UI.Design/DataMemberConverter.xml index 145bd67b7ca..b8b4128dd1b 100644 --- a/xml/System.Web.UI.Design/DataMemberConverter.xml +++ b/xml/System.Web.UI.Design/DataMemberConverter.xml @@ -205,7 +205,7 @@ provides. + If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that provides. ]]> diff --git a/xml/System.Web.UI.Design/DataSetFieldSchema.xml b/xml/System.Web.UI.Design/DataSetFieldSchema.xml index 129ebf4ec3b..370e0804939 100644 --- a/xml/System.Web.UI.Design/DataSetFieldSchema.xml +++ b/xml/System.Web.UI.Design/DataSetFieldSchema.xml @@ -24,7 +24,7 @@ class to get the properties of a data field using a . You can discover the structure of a data field by using the following properties in this class: , , , , and . In addition, you can use the property to determine if a data column is set for , or the property to determine if a data column is in the primary key. + Use the class to get the properties of a data field using a . You can discover the structure of a data field by using the following properties in this class: , , , , and . In addition, you can use the property to determine if a data column is set for , or the property to determine if a data column is in the primary key. The class is used by custom control designer components to provide information about a data field at design time. diff --git a/xml/System.Web.UI.Design/DataSetViewSchema.xml b/xml/System.Web.UI.Design/DataSetViewSchema.xml index e464cc6cbb7..2092f4d3776 100644 --- a/xml/System.Web.UI.Design/DataSetViewSchema.xml +++ b/xml/System.Web.UI.Design/DataSetViewSchema.xml @@ -21,21 +21,21 @@ Represents the structure, or schema, of a . This class cannot be inherited. - class to list the structure of data using a at design time. Use the method to get a list of information about each field as objects. - - The class is used by custom control designer components to provide UI options to the user at design time that accurately reflect the structure of the data. - - To examine the components of data using a , use the following classes. - -- - -- - -- - + class to list the structure of data using a at design time. Use the method to get a list of information about each field as objects. + + The class is used by custom control designer components to provide UI options to the user at design time that accurately reflect the structure of the data. + + To examine the components of data using a , use the following classes. + +- + +- + +- + ]]> @@ -95,11 +95,11 @@ . - method inherited from is not implemented in this class and always returns `null`. - + method inherited from is not implemented in this class and always returns `null`. + ]]> @@ -131,11 +131,11 @@ Gets an array containing information about each data field in the view. An array of objects. - method does not return information about hidden fields. - + method does not return information about hidden fields. + ]]> diff --git a/xml/System.Web.UI.Design/DataSourceConverter.xml b/xml/System.Web.UI.Design/DataSourceConverter.xml index 0ca432e1132..de059c0f004 100644 --- a/xml/System.Web.UI.Design/DataSourceConverter.xml +++ b/xml/System.Web.UI.Design/DataSourceConverter.xml @@ -171,7 +171,7 @@ method, and then returning the components that are valid data sources. + The data sources that are accessible to the component are determined by retrieving a list of components from the designer, testing each component with the method, and then returning the components that are valid data sources. ]]> @@ -209,7 +209,7 @@ provides. + If the list is exclusive, such as in an enumeration data type, then no other values are valid. If the list is not exclusive, then there are other valid values besides the list of standard values that provides. ]]> @@ -277,7 +277,7 @@ method uses the method to determine the components that are available as standard accessible data sources. For the class, a valid data source is a component that implements the or interface. + The method uses the method to determine the components that are available as standard accessible data sources. For the class, a valid data source is a component that implements the or interface. ]]> diff --git a/xml/System.Web.UI.Design/DataSourceDesigner.xml b/xml/System.Web.UI.Design/DataSourceDesigner.xml index 8d7c45263e5..7032f93b0e4 100644 --- a/xml/System.Web.UI.Design/DataSourceDesigner.xml +++ b/xml/System.Web.UI.Design/DataSourceDesigner.xml @@ -26,13 +26,13 @@ ## Remarks The class is the base class for data source designers, such as the , , and classes. If you create a new data source control, you might also want to create a custom control designer for your control and derive it from the class. - The class has two event methods: the and methods. Both of these events can be temporarily disabled with the method, which sets the property. The event methods can be enabled again with the method. + The class has two event methods: the and methods. Both of these events can be temporarily disabled with the method, which sets the property. The event methods can be enabled again with the method. There are two static methods that you can use to evaluate the equivalency of schemas or views without creating an instance of the class: -- The method compares two schemas. +- The method compares two schemas. -- The method compares the schemas of two views. +- The method compares the schemas of two views. @@ -92,7 +92,7 @@ constructor is called by the design host at design time. + The constructor is called by the design host at design time. ]]> @@ -123,7 +123,7 @@ control and a control, along with properties to set the `Text` properties on both internal controls, as well as the and properties of the control. An associated control designer class creates three commands, each of which sets two properties on the control, and whose settings can be rolled back with the undo functionality in the design host. Although the code example does not use a custom object, it illustrates how to override the property. + The following code example demonstrates how to create a simple composite control with a control and a control, along with properties to set the `Text` properties on both internal controls, as well as the and properties of the control. An associated control designer class creates three commands, each of which sets two properties on the control, and whose settings can be rolled back with the undo functionality in the design host. Although the code example does not use a custom object, it illustrates how to override the property. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DesignerInvokeTransactedChange/CS/InvokeTransactedChangeSample.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DesignerInvokeTransactedChange/VB/InvokeTransactedChangeSample.vb" id="Snippet1"::: @@ -249,9 +249,9 @@ method is not supported in the class; however, it can be overridden by custom data source designers inheriting from the class. + The method is not supported in the class; however, it can be overridden by custom data source designers inheriting from the class. - In a design host such as Visual Studio 2005, you can see the method in action by completing the following process: + In a design host such as Visual Studio 2005, you can see the method in action by completing the following process: 1. Put a or an control on your page. @@ -325,7 +325,7 @@ method returns the result from the base method. + The default implementation of the method returns the result from the base method. ]]> @@ -364,7 +364,7 @@ method should return `null`. + In derived classes, if `viewName` does not exist, the method should return `null`. ]]> @@ -426,7 +426,7 @@ method notifies the control designers of each control that is bound to the associated data source to refresh its control in the design host. The method can be suppressed with the method or by calling the method with an argument of `false`. + The method notifies the control designers of each control that is bound to the associated data source to refresh its control in the design host. The method can be suppressed with the method or by calling the method with an argument of `false`. ]]> @@ -462,7 +462,7 @@ method notifies the control designers of each control that is bound to the associated data source that the fields in the schema have changed. The method can be suppressed with the method or by calling the method with an argument of `false`. + The method notifies the control designers of each control that is bound to the associated data source that the fields in the schema have changed. The method can be suppressed with the method or by calling the method with an argument of `false`. ]]> @@ -502,7 +502,7 @@ method is not supported in the class. However, it is supported in derived classes, such as the class. + The method is not supported in the class. However, it is supported in derived classes, such as the class. ]]> @@ -539,7 +539,7 @@ property to `false` or by calling the method with an argument of `true`. + Data source events can be suppressed by setting the property to `false` or by calling the method with an argument of `true`. ]]> @@ -615,7 +615,7 @@ method can be used without an instance of the class. + Comparison of the two schemas is based on the views, as well as the names and types of the fields that are contained in the views. The method can be used without an instance of the class. ]]> @@ -675,7 +675,7 @@ property can be set by calling the or method with an argument of `true`. + The property can be set by calling the or method with an argument of `true`. ]]> @@ -713,7 +713,7 @@ method can be used without an instance of the class. + The method can be used without an instance of the class. ]]> diff --git a/xml/System.Web.UI.Design/DataSourceViewSchemaConverter.xml b/xml/System.Web.UI.Design/DataSourceViewSchemaConverter.xml index 460650d4ccf..c4de76cf587 100644 --- a/xml/System.Web.UI.Design/DataSourceViewSchemaConverter.xml +++ b/xml/System.Web.UI.Design/DataSourceViewSchemaConverter.xml @@ -22,14 +22,14 @@ ## Remarks Use the class to convert object types before assignment to a control property. In general, the supports converting string object types and supplies a list of standard values available for assignment to the associated control property. The standard values collection is the list of fields in the data source schema for the current control. - To support converting additional object types, derive a class from and override the and methods for the additional object types. To support a custom list of standard assignable values, override the method. + To support converting additional object types, derive a class from and override the and methods for the additional object types. To support a custom list of standard assignable values, override the method. Apply the attribute to specify the class as the type converter for a control property. For example, the property of the class and the property of the class use the as the property type converter. > [!NOTE] > You should never access a type converter directly. Instead, call the appropriate converter by using a object. For more information, see the examples in . - The method indicates that the converter supports returning a list of available values through the method. The method indicates that the list is not an exclusive list of possible values. + The method indicates that the converter supports returning a list of available values through the method. The method indicates that the list is not an exclusive list of possible values. ]]> @@ -104,9 +104,9 @@ method to determine whether the method supports converting the source type. + Call the method to determine whether the method supports converting the source type. - The method can convert only from a string, so the method returns `true` when `sourceType` is a string. + The method can convert only from a string, so the method returns `true` when `sourceType` is a string. ]]> @@ -147,7 +147,7 @@ ## Remarks If `value` is a string, then the string representation of `value` is returned. If `value` is `null`, an empty string ("") is returned. For all other specified values, a exception is thrown. - Call the method to determine whether the method supports converting the source type. + Call the method to determine whether the method supports converting the source type. ]]> @@ -200,7 +200,7 @@ method uses the property of the specified `context` object to obtain an implementation. If the implementation is available, it is used to access the data source schema for the associated control at design time and retrieve the list of available fields from the associated data source schema view. + The method uses the property of the specified `context` object to obtain an implementation. If the implementation is available, it is used to access the data source schema for the associated control at design time and retrieve the list of available fields from the associated data source schema view. The collection of available values is built from the fields in the data source schema for the associated control. @@ -272,7 +272,7 @@ method for a returns `false`, indicating that the list returned by the method is not an exclusive list of all possible assignable values. + The method for a returns `false`, indicating that the list returned by the method is not an exclusive list of all possible assignable values. ]]> @@ -309,9 +309,9 @@ method indicates whether the converter supports returning a list of available values through the method. + The method indicates whether the converter supports returning a list of available values through the method. - The method for the object returns `true` if the specified `context` object supplies an implementation in its property. The method uses the implementation to retrieve the list of available fields from the associated data source schema. + The method for the object returns `true` if the specified `context` object supplies an implementation in its property. The method uses the implementation to retrieve the list of available fields from the associated data source schema. ]]> diff --git a/xml/System.Web.UI.Design/DesignTimeData.xml b/xml/System.Web.UI.Design/DesignTimeData.xml index ff70a533a76..58cb4f9b7b6 100644 --- a/xml/System.Web.UI.Design/DesignTimeData.xml +++ b/xml/System.Web.UI.Design/DesignTimeData.xml @@ -43,11 +43,11 @@ Creates a object that contains three columns with names indicating that the columns are connected to a data source. A new object with three columns and no data. - ASP.NET Control Designers Overview @@ -76,11 +76,11 @@ Creates a object that contains three columns with names that indicate that the columns contain sample data. A new with three columns. These columns can contain data of type string. - method to add rows of data to the resulting table. - + method to add rows of data to the resulting table. + ]]> ASP.NET Control Designers Overview @@ -129,11 +129,11 @@ Creates a sample object with the same schema as the provided data. A object that contains columns with the same names and data types as the provided . - method to add rows of data to the resulting table. - + method to add rows of data to the resulting table. + ]]> @@ -173,11 +173,11 @@ Creates a object with the same schema as the provided data and optionally containing column names indicating that the data is bound data. A object. - to add rows of data to the resulting table. - + to add rows of data to the resulting table. + ]]> ASP.NET Control Designers Overview @@ -264,18 +264,18 @@ Gets the specified data member from the specified data source. An object implementing containing the specified data member from the specified data source, if it exists. - - is - - -or- - + is + + -or- + is . ASP.NET Control Designers Overview Walkthrough: Creating a Basic Control Designer for a Web Server Control diff --git a/xml/System.Web.UI.Design/DesignerAutoFormat.xml b/xml/System.Web.UI.Design/DesignerAutoFormat.xml index c2fe0db32ec..6678a738921 100644 --- a/xml/System.Web.UI.Design/DesignerAutoFormat.xml +++ b/xml/System.Web.UI.Design/DesignerAutoFormat.xml @@ -30,15 +30,15 @@ 2. Derive a designer class from the class or another designer class that is appropriate for your control, such as the . -3. Derive a format class from the class that formats your custom control by overriding the method. +3. Derive a format class from the class that formats your custom control by overriding the method. 4. In your designer class, populate the property, which is a object, with one instance of your format class for each named format that your designer can apply. The class provides the following members to support automatic formatting at design time: -- The method, which applies the named format to the specified control. +- The method, which applies the named format to the specified control. -- The method, which provides a copy of the control for previewing in an **AutoFormat** dialog box of a visual designer such as Visual Studio 2005. +- The method, which provides a copy of the control for previewing in an **AutoFormat** dialog box of a visual designer such as Visual Studio 2005. - The property, which provides the text to display in a list of formats in a visual designer. @@ -85,7 +85,7 @@ constructor to create a new format and add it to a collection that is represented by the property of a object. + Use the constructor to create a new format and add it to a collection that is represented by the property of a object. ]]> @@ -123,7 +123,7 @@ method applies formatting to the specified control based on the property. You can apply the styles directly to the control, or set the property and then use the method for the control to apply the style changes to the control. + The method applies formatting to the specified control based on the property. You can apply the styles directly to the control, or set the property and then use the method for the control to apply the style changes to the control. @@ -171,9 +171,9 @@ method is used by visual designers, such as Visual Studio 2005, in an **AutoFormat** dialog box to display a formatted run-time preview of the control at design time before applying the format to the actual control. + The method is used by visual designers, such as Visual Studio 2005, in an **AutoFormat** dialog box to display a formatted run-time preview of the control at design time before applying the format to the actual control. - Regardless of the setting of the attribute for the object, the method returns a copy of the control in the `runtimeControl` parameter. + Regardless of the setting of the attribute for the object, the method returns a copy of the control in the `runtimeControl` parameter. ]]> @@ -218,7 +218,7 @@ property from each object in the collection of a to create a list of available automatic style formats. + A visual designer, such as Visual Studio 2005, uses the property from each object in the collection of a to create a list of available automatic style formats. @@ -259,7 +259,7 @@ property is read-only, each individual property that it contains can be set. For example, you can set the or property of the object. + Although the object returned by the property is read-only, each individual property that it contains can be set. For example, you can set the or property of the object. @@ -306,7 +306,7 @@ method returns a string that contains the value of the property of the object. + The method returns a string that contains the value of the property of the object. ]]> diff --git a/xml/System.Web.UI.Design/DesignerAutoFormatCollection.xml b/xml/System.Web.UI.Design/DesignerAutoFormatCollection.xml index b618e816858..462af80fe4b 100644 --- a/xml/System.Web.UI.Design/DesignerAutoFormatCollection.xml +++ b/xml/System.Web.UI.Design/DesignerAutoFormatCollection.xml @@ -36,25 +36,25 @@ Additionally, use the methods and properties to provide the following functionality: -- The method to add a single format to the collection. +- The method to add a single format to the collection. -- The method to add a format at a particular index within the collection. +- The method to add a format at a particular index within the collection. -- The method to remove a format. +- The method to remove a format. -- The method to remove the format at a particular index. +- The method to remove the format at a particular index. -- The method to determine whether a particular format is already in the collection. +- The method to determine whether a particular format is already in the collection. -- The method to retrieve the index of a format within the collection. +- The method to retrieve the index of a format within the collection. - The property to get or set the format at a particular index, using array notation. -- The method to remove all formats from the collection. +- The method to remove all formats from the collection. - The property to determine the number of formats in the collection. -- The method to get the position of a format within the collection. +- The method to get the position of a format within the collection. @@ -92,7 +92,7 @@ constructor to create an empty collection. You can add elements to the collection by using the or method. + Use the constructor to create an empty collection. You can add elements to the collection by using the or method. ]]> @@ -129,7 +129,7 @@ method adds the specified object to the end of the collection. To add a object to the collection at a specific index location, use the method. + The method adds the specified object to the end of the collection. To add a object to the collection at a specific index location, use the method. @@ -173,7 +173,7 @@ method to remove all formats from the collection. To remove a specific format from the collection, use the method. To remove a format at a particular index, use the method. + Use the method to remove all formats from the collection. To remove a specific format from the collection, use the method. To remove a format at a particular index, use the method. ]]> @@ -211,7 +211,7 @@ method determines equality by using the method on the objects that are being compared. + The method determines equality by using the method on the objects that are being compared. ]]> @@ -282,7 +282,7 @@ method determines equality by using the method on the objects that are being compared. + The method determines equality by using the method on the objects that are being compared. ]]> @@ -320,7 +320,7 @@ method adds a object to the collection at a specific index location. To add a single to the end of the collection, use the method. + The method adds a object to the collection at a specific index location. To add a single to the end of the collection, use the method. > [!NOTE] > When you insert an item into a collection, the index values change for subsequent items in the collection. @@ -366,9 +366,9 @@ indexer to retrieve the object at the specified index within the collection or to set the format at the specified index within the collection. You can index elements in the collection by using array notation. For example, you can index an element at index `i` with the notation `AutoFormats(i)` for Microsoft VisualBasic or `AutoFormats[i]` for C#. + Use the indexer to retrieve the object at the specified index within the collection or to set the format at the specified index within the collection. You can index elements in the collection by using array notation. For example, you can index an element at index `i` with the notation `AutoFormats(i)` for Microsoft VisualBasic or `AutoFormats[i]` for C#. - When you have a reference to the object and need the index of the object in the collection, use the method. + When you have a reference to the object and need the index of the object in the collection, use the method. ]]> @@ -407,7 +407,7 @@ property examines each format in the collection and returns the largest height and the largest width in a structure. A visual designer, such as Visual Studio 2005, uses the to determine the initial size of the **AutoFormat** dialog box. The minimum size is 200-by-200 pixels. + The property examines each format in the collection and returns the largest height and the largest width in a structure. A visual designer, such as Visual Studio 2005, uses the to determine the initial size of the **AutoFormat** dialog box. The minimum size is 200-by-200 pixels. ]]> @@ -443,13 +443,13 @@ method removes the first occurrence of `format` from the collection. If the object does not contain `format`, the collection remains unchanged. No exception is thrown. + The method removes the first occurrence of `format` from the collection. If the object does not contain `format`, the collection remains unchanged. No exception is thrown. - The method determines equality by using the method on the objects that are being compared. + The method determines equality by using the method on the objects that are being compared. - The method performs a linear search; therefore, the average execution time is proportional to the value. + The method performs a linear search; therefore, the average execution time is proportional to the value. - To remove a format at a particular index from the collection, use the method. To remove all formats from the collection, use the method. + To remove a format at a particular index from the collection, use the method. To remove all formats from the collection, use the method. > [!NOTE] > When you remove an item from a collection, the index values change for subsequent items in the collection. @@ -488,7 +488,7 @@ method to remove a format at a particular index from the collection. To remove a specified format from the collection, use the method. To remove all formats from the collection, use the method. + Use the method to remove a format at a particular index from the collection. To remove a specified format from the collection, use the method. To remove all formats from the collection, use the method. > [!NOTE] > When you remove an item from a collection, the index values change for subsequent items in the collection. @@ -532,7 +532,7 @@ ## Remarks Enumerating through a collection is not a thread-safe procedure intrinsically. Even when a collection is synchronized, other threads can still modify the collection. This causes exceptions during enumeration. - Lock the collection by using the method during the entire enumeration to guarantee thread safety. For detailed information about locking collections for thread-safe access, see . + Lock the collection by using the method during the entire enumeration to guarantee thread safety. For detailed information about locking collections for thread-safe access, see . ]]> diff --git a/xml/System.Web.UI.Design/DesignerAutoFormatStyle.xml b/xml/System.Web.UI.Design/DesignerAutoFormatStyle.xml index b29402669d7..0b5ef133e37 100644 --- a/xml/System.Web.UI.Design/DesignerAutoFormatStyle.xml +++ b/xml/System.Web.UI.Design/DesignerAutoFormatStyle.xml @@ -20,7 +20,7 @@ class encapsulates the properties that control the appearance of a Web server control for automatic formatting at design time. You can specify the background color, font color, and the vertical alignment of a control by setting the , , and properties, respectively. + The class encapsulates the properties that control the appearance of a Web server control for automatic formatting at design time. You can specify the background color, font color, and the vertical alignment of a control by setting the , , and properties, respectively. ]]> diff --git a/xml/System.Web.UI.Design/DesignerDataSourceView.xml b/xml/System.Web.UI.Design/DesignerDataSourceView.xml index 35511400b8c..73443b651d6 100644 --- a/xml/System.Web.UI.Design/DesignerDataSourceView.xml +++ b/xml/System.Web.UI.Design/DesignerDataSourceView.xml @@ -17,18 +17,18 @@ Serves as the base class for design-time data source view classes. - object along with a custom class and two custom classes. - - This example is part of a larger sample for the class. - + object along with a custom class and two custom classes. + + This example is part of a larger sample for the class. + :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataSourceDesignerSample/CS/DataSourceDesignerSample.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataSourceDesignerSample/VB/DataSourceDesignerSample.vb" id="Snippet2"::: + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataSourceDesignerSample/VB/DataSourceDesignerSample.vb" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/DataSourceDesignerSample/CS/DataSourceDesignerSample.cs" id="Snippet5"::: -:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataSourceDesignerSample/VB/DataSourceDesignerSample.vb" id="Snippet5"::: - +:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/DataSourceDesignerSample/VB/DataSourceDesignerSample.vb" id="Snippet5"::: + ]]> @@ -62,10 +62,10 @@ Initializes a new instance of the class using the specified data source designer and view name. To be added. - is - - -or- - + is + + -or- + is . ASP.NET Control Designers Overview Extending Design-Time Support @@ -279,11 +279,11 @@ Generates design-time data that matches the schema of the associated data source control using the specified number of rows, indicating whether it is returning sample data or real data. A object containing data to display at design time. - method with views, schemas, and a data source designer, see . - + method with views, schemas, and a data source designer, see . + ]]> Extending Design-Time Support @@ -340,11 +340,11 @@ Gets a schema that describes the data source view that is represented by this view object. An object. - method with views, schemas, and a data source designer, see . - + method with views, schemas, and a data source designer, see . + ]]> Extending Design-Time Support diff --git a/xml/System.Web.UI.Design/DesignerHierarchicalDataSourceView.xml b/xml/System.Web.UI.Design/DesignerHierarchicalDataSourceView.xml index e528fd930b2..a4ffe6bb229 100644 --- a/xml/System.Web.UI.Design/DesignerHierarchicalDataSourceView.xml +++ b/xml/System.Web.UI.Design/DesignerHierarchicalDataSourceView.xml @@ -123,7 +123,7 @@ method should provide a design-time version of data for use by the associated data-bound control designer. + The method should provide a design-time version of data for use by the associated data-bound control designer. It is not expected or recommended that the designer perform actual data access at design time. Instead, the designer should create sample data that matches the schema of the data source. @@ -199,7 +199,7 @@ ## Examples - For a complete example of using the method with views and schemas and a data source designer, see . + For a complete example of using the method with views and schemas and a data source designer, see . ]]> diff --git a/xml/System.Web.UI.Design/DesignerRegion.xml b/xml/System.Web.UI.Design/DesignerRegion.xml index cb1094828e4..170ceb1522d 100644 --- a/xml/System.Web.UI.Design/DesignerRegion.xml +++ b/xml/System.Web.UI.Design/DesignerRegion.xml @@ -24,9 +24,9 @@ The class provides the base functionality for designer regions, such as the ability to click, select, and highlight a region in the design surface. Use a object in a control designer implementation to define a region that does not require editing. Use the derived class in a control designer implementation to define a region with editable content at design time. Use the derived class in a control designer implementation to define an editable region that represents a template in a control. - To support regions within a class that is derived from the , override the method and add one or more initialized objects to the collection. Optionally, you can handle mouse clicks in the regions on the design surface by overriding the method. + To support regions within a class that is derived from the , override the method and add one or more initialized objects to the collection. Optionally, you can handle mouse clicks in the regions on the design surface by overriding the method. - Use the properties of a object to determine how the region is displayed by the visual designer. Override the property to indicate that the region can be selected by the user on the design surface. Use the property to highlight the designer region in the visual designer; for example, you can highlight a region after a user has clicked to select it. Use the and properties to store or retrieve additional details about the region. In particular, the property is used by the visual designer to display ToolTip information when the user moves the mouse pointer over the designer region. Use the property to access the methods and properties of the control designer object that contains the designer region. + Use the properties of a object to determine how the region is displayed by the visual designer. Override the property to indicate that the region can be selected by the user on the design surface. Use the property to highlight the designer region in the visual designer; for example, you can highlight a region after a user has clicked to select it. Use the and properties to store or retrieve additional details about the region. In particular, the property is used by the visual designer to display ToolTip information when the user moves the mouse pointer over the designer region. Use the property to access the methods and properties of the control designer object that contains the designer region. ]]> @@ -84,16 +84,16 @@ |Property|Initial Value| |--------------|-------------------| -||An empty string ("").| -||The input `designer` object.| -||An empty string ("").| -||`false`.| -||`false`.| -||The input `name` object.| -||An empty object.| -||`false`.| -||`false`.| -||`null`.| +||An empty string ("").| +||The input `designer` object.| +||An empty string ("").| +||`false`.| +||`false`.| +||The input `name` object.| +||An empty object.| +||`false`.| +||`false`.| +||`null`.| ]]> @@ -153,16 +153,16 @@ |Property|Initial Value| |--------------|-------------------| -||An empty string ("").| -||The input `designer` object.| -||An empty string ("").| -||`false`.| -||`false`.| -||The input `name` object.| -||An empty object.| -||The input `selectable` value.| -||`false`.| -||`null`.| +||An empty string ("").| +||The input `designer` object.| +||An empty string ("").| +||`false`.| +||`false`.| +||The input `name` object.| +||An empty object.| +||The input `selectable` value.| +||`false`.| +||`null`.| ]]> @@ -340,7 +340,7 @@ method returns a value that is equivalent to calling the method on the object with this designer region. + The method returns a value that is equivalent to calling the method on the object with this designer region. ]]> @@ -488,7 +488,7 @@ ## Remarks Within a control designer implementation, use the property to store or retrieve additional information for the designer region. - For example, if the control designer implementation supports selecting from multiple designer regions, you can use the property in a control designer to store a unique index for each region. You can then use the property for the region that is passed into the method to store the index for the currently selected region. + For example, if the control designer implementation supports selecting from multiple designer regions, you can use the property in a control designer to store a unique index for each region. You can then use the property for the region that is passed into the method to store the index for the currently selected region. ]]> diff --git a/xml/System.Web.UI.Design/DesignerRegionCollection.xml b/xml/System.Web.UI.Design/DesignerRegionCollection.xml index b9476d0c78c..be17e8c8bbf 100644 --- a/xml/System.Web.UI.Design/DesignerRegionCollection.xml +++ b/xml/System.Web.UI.Design/DesignerRegionCollection.xml @@ -32,27 +32,27 @@ ## Remarks The class, and any derived class, uses the class to contain and enumerate the designer regions for the control in a design host, such as Visual Studio 2005. - For example, the method can be used to define and add regions to the collection. + For example, the method can be used to define and add regions to the collection. Use the property to access the control designer object that contains the designer region collection. Use the methods and properties to examine and maintain the objects that are in the collection. The collection dynamically increases as objects are added. Indexes in this collection are zero-based. Use the property to determine how many designer regions are in the collection. Use the members to provide the following functionality: -- The method to add a single designer region to the collection. +- The method to add a single designer region to the collection. -- The method to add a designer region at a particular index within the collection. +- The method to add a designer region at a particular index within the collection. -- The method to remove a designer region. +- The method to remove a designer region. -- The method to remove the designer region at a particular index. +- The method to remove the designer region at a particular index. -- The method to determine whether a particular designer region is already in the collection. +- The method to determine whether a particular designer region is already in the collection. -- The method to retrieve the index of a designer region within the collection. +- The method to retrieve the index of a designer region within the collection. -- The indexer to get or set the designer region at a particular index, using array notation. +- The indexer to get or set the designer region at a particular index, using array notation. -- The method to remove all designer regions from the collection. +- The method to remove all designer regions from the collection. ]]> @@ -100,7 +100,7 @@ constructor to create an empty collection. You can add elements to the collection by using the or method. + Use the constructor to create an empty collection. You can add elements to the collection by using the or method. ]]> @@ -137,9 +137,9 @@ constructor creates an empty collection and sets the property to the specified control designer object. The visual designer, such as Visual Studio 2005, uses the constructor to initialize a designer region collection for a specific control designer. + The constructor creates an empty collection and sets the property to the specified control designer object. The visual designer, such as Visual Studio 2005, uses the constructor to initialize a designer region collection for a specific control designer. - You can add elements to the collection by using the or method. + You can add elements to the collection by using the or method. ]]> @@ -175,7 +175,7 @@ method adds the specified object to the end of the collection. To add a object to the collection at a specific index location, use the method. + The method adds the specified object to the end of the collection. To add a object to the collection at a specific index location, use the method. ]]> @@ -206,7 +206,7 @@ method to remove all regions from the collection. To remove a specific region from the collection, use the method. To remove a region at a particular index, use the method. + Use the method to remove all regions from the collection. To remove a specific region from the collection, use the method. To remove a region at a particular index, use the method. ]]> @@ -242,9 +242,9 @@ method determines equality by using the method on the objects. + The method determines equality by using the method on the objects. - The method performs a linear search; therefore, the average execution time is proportional to the property. Because template region collections are typically small, the performance of the linear search operation is not critical. + The method performs a linear search; therefore, the average execution time is proportional to the property. Because template region collections are typically small, the performance of the linear search operation is not critical. ]]> @@ -281,7 +281,7 @@ or method to add the design regions to the collection. + Use the or method to add the design regions to the collection. ]]> @@ -379,9 +379,9 @@ method determines equality by using the method on the objects. + The method determines equality by using the method on the objects. - The method performs a linear search; therefore, the average execution time is proportional to the property. Because template region collections are typically small, the performance of the linear search operation is not critical. + The method performs a linear search; therefore, the average execution time is proportional to the property. Because template region collections are typically small, the performance of the linear search operation is not critical. ]]> @@ -418,7 +418,7 @@ method adds a object to the collection at a specific index location. To add a single to the end of the collection, use the method. + The method adds a object to the collection at a specific index location. To add a single to the end of the collection, use the method. > [!NOTE] > When you insert an item into the collection, the indexes change for subsequent items in the collection. @@ -511,7 +511,7 @@ ## Remarks Enumerating through a collection is not a thread-safe procedure intrinsically. Even when a collection is synchronized, other threads can still modify the collection. This causes exceptions during enumeration. - Lock the collection by using the method during the whole enumeration to guarantee thread safety. + Lock the collection by using the method during the whole enumeration to guarantee thread safety. ]]> @@ -547,9 +547,9 @@ indexer to retrieve the region at the specified index within the collection or to set the region at the specified index within the collection. You can index elements in the collection by using array notation. For example, you can index an element at index `i` with the notation `DesignerRegions(i)` for Microsoft VisualBasic or `DesignerRegions[i]` for C#. + Use the indexer to retrieve the region at the specified index within the collection or to set the region at the specified index within the collection. You can index elements in the collection by using array notation. For example, you can index an element at index `i` with the notation `DesignerRegions(i)` for Microsoft VisualBasic or `DesignerRegions[i]` for C#. - When you have a reference to the region object and need the index of the object in the collection, use the method. + When you have a reference to the region object and need the index of the object in the collection, use the method. ]]> @@ -627,13 +627,13 @@ method removes the first occurrence of the specified region from the collection. If the object does not contain the specified `region`, the collection remains unchanged. No exception is thrown. + The method removes the first occurrence of the specified region from the collection. If the object does not contain the specified `region`, the collection remains unchanged. No exception is thrown. - The method determines equality by using the method on the object. + The method determines equality by using the method on the object. - The method performs a linear search; therefore, the average execution time is proportional to the property. Because template region collections are typically small, the performance of the linear search operation is not critical. + The method performs a linear search; therefore, the average execution time is proportional to the property. Because template region collections are typically small, the performance of the linear search operation is not critical. - To remove a region at a particular index from the collection, use the method. To remove all regions from the collection, use the method. + To remove a region at a particular index from the collection, use the method. To remove all regions from the collection, use the method. > [!NOTE] > When you remove an item from the collection, the indexes change for subsequent items in the collection. @@ -670,7 +670,7 @@ method to remove a region at a particular index from the collection. To remove a specified region from the collection, use the method. To remove all regions from the collection, use the method. + Use the method to remove a region at a particular index from the collection. To remove a specified region from the collection, use the method. To remove all regions from the collection, use the method. > [!NOTE] > When you remove an item from the collection, the indexes change for subsequent items in the collection. @@ -712,7 +712,7 @@ ## Remarks Enumerating through a collection is not a thread-safe procedure intrinsically. Even when a collection is synchronized, other threads can still modify the collection. This causes exceptions during enumeration. - Lock the collection by using the method during the whole enumeration to guarantee thread safety. For detailed information about locking collections for thread-safe access, see . + Lock the collection by using the method during the whole enumeration to guarantee thread safety. For detailed information about locking collections for thread-safe access, see . ]]> diff --git a/xml/System.Web.UI.Design/DesignerRegionMouseEventArgs.xml b/xml/System.Web.UI.Design/DesignerRegionMouseEventArgs.xml index 7c93e95aeb8..0efac5aff72 100644 --- a/xml/System.Web.UI.Design/DesignerRegionMouseEventArgs.xml +++ b/xml/System.Web.UI.Design/DesignerRegionMouseEventArgs.xml @@ -24,7 +24,7 @@ The class supplies a default delegate to handle the event. When you click a selected control or a designer region of a selected control at design time, the designer host initializes a object for a event type, and then sets the property with a object. - When the object indicates that you clicked a designer region, the default delegate in the class passes the object to the method. Classes deriving from the class override the method to process events that are raised when you click a control in the design host. + When the object indicates that you clicked a designer region, the default delegate in the class passes the object to the method. Classes deriving from the class override the method to process events that are raised when you click a control in the design host. The property represents the control designer region that the event applies to, if any. The property represents the location on the design surface that was clicked. @@ -77,7 +77,7 @@ delegate method uses the constructor to initialize a object for use with a object. + A delegate method uses the constructor to initialize a object for use with a object. When you click a control region at design time, the designer host initializes a object for a event type, and then sets the property with a object. @@ -119,7 +119,7 @@ ## Remarks The property contains the coordinates that identify where you clicked, relative to the upper left corner of the region. - The property is initialized by the constructor. + The property is initialized by the constructor. ]]> @@ -158,7 +158,7 @@ ## Remarks The property represents the control designer region that was clicked, if any. - The property is initialized by the constructor. + The property is initialized by the constructor. diff --git a/xml/System.Web.UI.Design/EditableDesignerRegion.xml b/xml/System.Web.UI.Design/EditableDesignerRegion.xml index f60bb3ec00c..52d9a52d891 100644 --- a/xml/System.Web.UI.Design/EditableDesignerRegion.xml +++ b/xml/System.Web.UI.Design/EditableDesignerRegion.xml @@ -20,7 +20,7 @@ class to help manage templates at design time. A will use an instance of this class with its method to generate HTML markup of the region's content. + Use the class to help manage templates at design time. A will use an instance of this class with its method to generate HTML markup of the region's content. diff --git a/xml/System.Web.UI.Design/ExpressionEditor.xml b/xml/System.Web.UI.Design/ExpressionEditor.xml index f63771fba21..1b95be1d81f 100644 --- a/xml/System.Web.UI.Design/ExpressionEditor.xml +++ b/xml/System.Web.UI.Design/ExpressionEditor.xml @@ -24,7 +24,7 @@ When you browse the property for a control in the design-time Properties grid, the visual designer displays a dialog box to set expressions for a control property. You can select the expression type based on a list of expression prefixes. When you select an expression prefix from the list, the visual designer uses the associated and objects to set, evaluate, and convert the expression string based on the syntax for that type of expression. The visual designer sets the expression for the associated control property, and then uses the evaluated expression result to assign control property values that are rendered on the design surface. - The static methods get the expression editor that is associated with a particular expression prefix or expression builder. The property for an object returns the configured expression prefix. The method evaluates an input expression string. The method returns the implementation that is used to prompt for the custom expression properties in the expressions dialog box. + The static methods get the expression editor that is associated with a particular expression prefix or expression builder. The property for an object returns the configured expression prefix. The method evaluates an input expression string. The method returns the implementation that is used to prompt for the custom expression properties in the expressions dialog box. Typically, to support a new expression type at design time, you define a unique expression prefix and provide custom and implementations. Optionally, you can provide a custom implementation that defines properties that are used to form the expression in the expressions dialog box. @@ -82,7 +82,7 @@ class is abstract, you cannot create an instance of the class directly using the constructor. + Because the class is abstract, you cannot create an instance of the class directly using the constructor. ]]> @@ -128,9 +128,9 @@ method to evaluate an expression and provide the design-time value for an associated control property. + The visual designer host uses the method to evaluate an expression and provide the design-time value for an associated control property. - The visual designer uses the method to parse the expression string at design time, and then calls the method with the parsed expression data. The visual designer uses the evaluated expression result to assign control property values that are rendered on the design surface. + The visual designer uses the method to parse the expression string at design time, and then calls the method with the parsed expression data. The visual designer uses the evaluated expression result to assign control property values that are rendered on the design surface. ]]> @@ -193,7 +193,7 @@ ## Remarks The expression prefix identifies the custom expression type and associates an expression with the expression builder and expression editor. When custom expressions are parsed in a page, the expression prefix is used to create instances of the associated and classes. To associate an expression prefix with an expression builder and expression editor, apply the and attributes to the custom class and configure the expression prefix for an expression builder in the `expressionBuilders` element in the Web configuration file. - Typically, derived classes do not override the property. The base class sets the value based on the attribute for the associated object. + Typically, derived classes do not override the property. The base class sets the value based on the attribute for the associated object. ]]> @@ -242,13 +242,13 @@ method overloads to find the object that is associated with a particular expression prefix or expression builder type. + Use the static method overloads to find the object that is associated with a particular expression prefix or expression builder type. For each custom expression type, an expression prefix identifies the associated expression builder and expression editor. When custom expressions are parsed in a page, the expression prefix is used to create instances of the associated and classes. To associate an expression prefix with an expression builder and expression editor, apply the and attributes to the custom class and configure the expression prefix for an expression builder in the `expressionBuilders` element in the Web configuration file. - To find the associated expression editor for an expression prefix, the method enumerates the available implementations for a matching prefix. The implementations can be configured in the `expressionBuilders` section of the Web configuration file. If an available implementation defines the expression prefix, the method returns the type that is specified in the attribute of the metadata. + To find the associated expression editor for an expression prefix, the method enumerates the available implementations for a matching prefix. The implementations can be configured in the `expressionBuilders` section of the Web configuration file. If an available implementation defines the expression prefix, the method returns the type that is specified in the attribute of the metadata. ]]> @@ -289,13 +289,13 @@ overloads to find the object that is associated with a particular expression prefix or expression builder type. + Use the static overloads to find the object that is associated with a particular expression prefix or expression builder type. For each custom expression type, an expression prefix identifies the associated expression builder and expression editor. When custom expressions are parsed in a page, the expression prefix is used to create instances of the associated and classes. To associate an expression prefix with an expression builder and expression editor, apply the and attributes to the custom class and configure the expression prefix for an expression builder in the `expressionBuilders` element in the Web configuration file. - The method enumerates the available implementations to locate `expressionBuilderType`. The implementations can be configured in the `expressionBuilders` section of the Web configuration file. If `expressionBuilderType` is found in the set of available implementations, the method returns the type that is specified in the attribute of the metadata. + The method enumerates the available implementations to locate `expressionBuilderType`. The implementations can be configured in the `expressionBuilders` section of the Web configuration file. If `expressionBuilderType` is found in the set of available implementations, the method returns the type that is specified in the attribute of the metadata. ]]> @@ -340,11 +340,11 @@ method returns an implementation that defines the strings that are combined to form a custom expression. The visual designer uses an expression editor sheet to prompt for one or more strings that combine into a custom expression. The base class method returns a default expression editor sheet, which uses a single input string to form the expression. The expression editor sheet defines the property grid for the expression. Therefore, the properties that the expression editor exposes become properties that can be defined for the expression in the dialog box. + The method returns an implementation that defines the strings that are combined to form a custom expression. The visual designer uses an expression editor sheet to prompt for one or more strings that combine into a custom expression. The base class method returns a default expression editor sheet, which uses a single input string to form the expression. The expression editor sheet defines the property grid for the expression. Therefore, the properties that the expression editor exposes become properties that can be defined for the expression in the dialog box. - Classes deriving from the class optionally can override the method to provide a custom expression editor sheet. A custom expression editor sheet can allow design-time input for multiple properties, which are combined together to form the expression string. + Classes deriving from the class optionally can override the method to provide a custom expression editor sheet. A custom expression editor sheet can allow design-time input for multiple properties, which are combined together to form the expression string. - For example, the class derives from the class and provides an implementation for evaluating and associating a resource string reference with a control property at design time. The class is associated with the expression prefix `Resources` and the implementation. The method returns a , which defines the individual properties that form a resource reference expression. + For example, the class derives from the class and provides an implementation for evaluating and associating a resource string reference with a control property at design time. The class is associated with the expression prefix `Resources` and the implementation. The method returns a , which defines the individual properties that form a resource reference expression. ]]> diff --git a/xml/System.Web.UI.Design/ExpressionEditorSheet.xml b/xml/System.Web.UI.Design/ExpressionEditorSheet.xml index aa1dd6e4937..98eb93d2524 100644 --- a/xml/System.Web.UI.Design/ExpressionEditorSheet.xml +++ b/xml/System.Web.UI.Design/ExpressionEditorSheet.xml @@ -26,15 +26,15 @@ Typically, to supply a new expression type at design time, you define a unique expression prefix and provide custom and implementations. Optionally, you can provide a custom implementation that defines properties that are used to form the expression. To associate an expression prefix with an expression builder and an expression editor, apply the attribute and an attribute to the custom class, and then configure the expression prefix for an expression builder in the `expressionBuilders` element in the Web configuration file. - The default implementation of the method returns a basic editor sheet, which uses a single input string to form the expression. Custom expression editors that are derived from the can override the method to return a custom editor sheet implementation. Typically, a custom editor sheet contains multiple properties that are used to build the expression string. The method returns the resulting expression string based on the current expression properties. + The default implementation of the method returns a basic editor sheet, which uses a single input string to form the expression. Custom expression editors that are derived from the can override the method to return a custom editor sheet implementation. Typically, a custom editor sheet contains multiple properties that are used to build the expression string. The method returns the resulting expression string based on the current expression properties. - For example, the class derives from the class and provides an implementation for evaluating and associating a resource string reference with a control property at design time. The class is associated with the expression prefix `Resources` and the implementation. The method returns a , which defines the individual properties that form a resource reference expression. + For example, the class derives from the class and provides an implementation for evaluating and associating a resource string reference with a control property at design time. The class is associated with the expression prefix `Resources` and the implementation. The method returns a , which defines the individual properties that form a resource reference expression. When you inherit from the class, you must override the following members: -- The method to return a custom editor sheet implementation. +- The method to return a custom editor sheet implementation. -- The constructor to implement custom initialization actions for your expression editor sheet implementation. +- The constructor to implement custom initialization actions for your expression editor sheet implementation. ]]> @@ -83,7 +83,7 @@ class is abstract, you cannot create an instance of an directly using the constructor. + Because the class is abstract, you cannot create an instance of an directly using the constructor. ]]> @@ -123,7 +123,7 @@ ## Remarks A custom expression editor sheet contains design-time settings for multiple expression properties, which are combined to form an expression string. Control property values can be set using expression strings; the expression strings are evaluated at run time by an expression builder. - The method returns an expression string that is built from the current expression properties. The visual designer allows you to set the expression sheet properties, and then calls the method to get the expression string and set the control property value. + The method returns an expression string that is built from the current expression properties. The visual designer allows you to set the expression sheet properties, and then calls the method to get the expression string and set the control property value. ]]> @@ -215,9 +215,9 @@ constructor to set the implementation for a custom expression editor sheet. + Use the constructor to set the implementation for a custom expression editor sheet. - The property can be used to access services that are provided by the designer host. For example, call the method with the interface to access project items, documents, or configuration file details that are provided through the visual designer. + The property can be used to access services that are provided by the designer host. For example, call the method with the interface to access project items, documents, or configuration file details that are provided through the visual designer. ]]> diff --git a/xml/System.Web.UI.Design/ExpressionsCollectionEditor.xml b/xml/System.Web.UI.Design/ExpressionsCollectionEditor.xml index 8a3c2ab8dcd..6e5f63c2da4 100644 --- a/xml/System.Web.UI.Design/ExpressionsCollectionEditor.xml +++ b/xml/System.Web.UI.Design/ExpressionsCollectionEditor.xml @@ -17,13 +17,13 @@ Provides a user interface for selecting and editing an expressions binding collection at design time. - class is a object that can be used at design time to select and edit a collection of expression bindings, and assign the expressions to a control property. - - A designer host, such as Visual Studio 2005, uses the and class implementations with the and classes to set the expression bindings for control properties at design time, and the class to persist the expressions for run time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type. The expression string is bound to the control property at design time, and then used at run time to determine the value for the property. - + class is a object that can be used at design time to select and edit a collection of expression bindings, and assign the expressions to a control property. + + A designer host, such as Visual Studio 2005, uses the and class implementations with the and classes to set the expression bindings for control properties at design time, and the class to persist the expressions for run time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type. The expression string is bound to the control property at design time, and then used at run time to determine the value for the property. + ]]> @@ -88,15 +88,15 @@ Edits the value of the specified object with the specified service provider and context. An object containing the selected expressions; otherwise, if no expressions are selected, the object. - method launches the user interface for editing the `value` object. The designer host calls the method when you attempt to edit the value of a property that this editor is associated with. The input service provider is used to obtain any editing services that are required within the . - - A designer host, such as Visual Studio 2005, uses the and class implementations with the and classes to set the expression bindings for control properties at design time, and the class to persist the expressions for run time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type. The expression string is bound to the control property at design time, and then used at run time to determine the value for the property. - - If users cancel the user interface without modifying the expression binding collection, the method returns the input `value` parameter. - + method launches the user interface for editing the `value` object. The designer host calls the method when you attempt to edit the value of a property that this editor is associated with. The input service provider is used to obtain any editing services that are required within the . + + A designer host, such as Visual Studio 2005, uses the and class implementations with the and classes to set the expression bindings for control properties at design time, and the class to persist the expressions for run time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type. The expression string is bound to the control property at design time, and then used at run time to determine the value for the property. + + If users cancel the user interface without modifying the expression binding collection, the method returns the input `value` parameter. + ]]> @@ -128,13 +128,13 @@ Gets the editing style that is associated with this editor for the specified context. An enumeration value indicating the editing style for the provided user interface. - method returns the value by default. - - If is not supported in the specified context, the returns . - + method returns the value by default. + + If is not supported in the specified context, the returns . + ]]> diff --git a/xml/System.Web.UI.Design/ExtenderControlToolboxItem.xml b/xml/System.Web.UI.Design/ExtenderControlToolboxItem.xml index 2654b48ad06..9e69735de98 100644 --- a/xml/System.Web.UI.Design/ExtenderControlToolboxItem.xml +++ b/xml/System.Web.UI.Design/ExtenderControlToolboxItem.xml @@ -23,13 +23,13 @@ Provides a way to determine which target controls can be extended by a particular extender control in the toolbox. - method returns the collection of target types. The collection is cached for performance by using the dictionary. - - If you write an extender control that implements , but that does not derive from , specify this type in the attribute of your control. - + method returns the collection of target types. The collection is cached for performance by using the dictionary. + + If you write an extender control that implements , but that does not derive from , specify this type in the attribute of your control. + ]]> @@ -149,11 +149,11 @@ Returns the collection of target types. A read-only collection of the target types. - dictionary. - + dictionary. + ]]> diff --git a/xml/System.Web.UI.Design/HierarchicalDataSourceConverter.xml b/xml/System.Web.UI.Design/HierarchicalDataSourceConverter.xml index 47d253a830d..0ef2fb4255e 100644 --- a/xml/System.Web.UI.Design/HierarchicalDataSourceConverter.xml +++ b/xml/System.Web.UI.Design/HierarchicalDataSourceConverter.xml @@ -95,7 +95,7 @@ method uses the method to determine which components are available as standard accessible data sources. For the class, a valid data source is a component that implements the interface. + The method uses the method to determine which components are available as standard accessible data sources. For the class, a valid data source is a component that implements the interface. ]]> diff --git a/xml/System.Web.UI.Design/HierarchicalDataSourceDesigner.xml b/xml/System.Web.UI.Design/HierarchicalDataSourceDesigner.xml index 09275b07957..78afa0feba1 100644 --- a/xml/System.Web.UI.Design/HierarchicalDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design/HierarchicalDataSourceDesigner.xml @@ -184,7 +184,7 @@ method is not supported in the class. + The method is not supported in the class. ]]> @@ -318,7 +318,7 @@ method notifies the designer of each control bound to the associated data source to refresh its control in the design host. This method can be suppressed with the method, or by calling the method with an argument of `false`. + The method notifies the designer of each control bound to the associated data source to refresh its control in the design host. This method can be suppressed with the method, or by calling the method with an argument of `false`. ]]> @@ -355,7 +355,7 @@ method, or by calling the method with an argument of `true`. + This method notifies the designers of each control bound to the associated data source that the fields in the schema have changed. This method can be suppressed with the method, or by calling the method with an argument of `true`. ]]> @@ -432,7 +432,7 @@ property to `false`, or by calling the method with an argument of `true`. + Data source events can be suppressed by setting the property to `false`, or by calling the method with an argument of `true`. ]]> diff --git a/xml/System.Web.UI.Design/HtmlControlDesigner.xml b/xml/System.Web.UI.Design/HtmlControlDesigner.xml index 11cf6b5da47..82ca687ef97 100644 --- a/xml/System.Web.UI.Design/HtmlControlDesigner.xml +++ b/xml/System.Web.UI.Design/HtmlControlDesigner.xml @@ -88,7 +88,7 @@ ## Remarks > [!NOTE] -> The property is obsolete. Use the and methods on the property to map properties to styles. Use the method on the class to set styles for the control at design time. +> The property is obsolete. Use the and methods on the property to map properties to styles. Use the method on the class to set styles for the control at design time. ]]> @@ -231,7 +231,7 @@ ## Remarks The design host, such as Visual Studio 2005, uses the class to get the class to get the to set expressions for control properties at design time. Expression strings reference a localizable resource, an application setting, a connection string, or a custom expression type. - The collection contains an element for each control property that has an associated expression string. Each property for each element indicates the associated expression builder implementation. The expression string is parsed and evaluated by its associated to determine the control property value at run time. + The collection contains an element for each control property that has an associated expression string. Each property for each element indicates the associated expression builder implementation. The expression string is parsed and evaluated by its associated to determine the control property value at run time. ]]> @@ -270,7 +270,7 @@ method should be called by the designer host to initialize the designer. + The method should be called by the designer host to initialize the designer. ]]> @@ -314,7 +314,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the and methods on the property to map properties to styles. Use the method on the class to set styles for the control at design time. Override the method to manipulate the initial styles for the control at design time. +> The method is obsolete. Use the and methods on the property to map properties to styles. Use the method on the class to set styles for the control at design time. Override the method to manipulate the initial styles for the control at design time. ]]> @@ -359,7 +359,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the and methods on the property to map properties to styles. Use the method on the class to set styles for the control at design time. Override the method for the control designer to perform actions before the designer object is released. +> The method is obsolete. Use the and methods on the property to map properties to styles. Use the method on the class to set styles for the control at design time. Override the method for the control designer to perform actions before the designer object is released. ]]> @@ -404,10 +404,10 @@ method should be called by a control designer after the control designer has made a change to the data bindings for the control. + The method should be called by a control designer after the control designer has made a change to the data bindings for the control. > [!NOTE] -> The method is obsolete. Use the event on the collection for equivalent control designer functionality. +> The method is obsolete. Use the event on the collection for equivalent control designer functionality. ]]> @@ -474,7 +474,7 @@ method provides a way to add items to or remove items from the dictionary of events that a designer exposes through a object. + The method provides a way to add items to or remove items from the dictionary of events that a designer exposes through a object. The keys in the dictionary of events are the names of the events. The objects are of type . @@ -514,7 +514,7 @@ method provides a way to add items to or remove items from the dictionary of properties that a designer exposes through a object. + The method provides a way to add items to or remove items from the dictionary of properties that a designer exposes through a object. The keys in the dictionary of properties are the names of the properties. The objects are of type . diff --git a/xml/System.Web.UI.Design/HyperLinkDataBindingHandler.xml b/xml/System.Web.UI.Design/HyperLinkDataBindingHandler.xml index 570bf543730..7efdeaf576f 100644 --- a/xml/System.Web.UI.Design/HyperLinkDataBindingHandler.xml +++ b/xml/System.Web.UI.Design/HyperLinkDataBindingHandler.xml @@ -21,7 +21,7 @@ method. + The following code example creates a class, named `CustomHyperLinkDataBindingHandler`, which derives from the `HyperLinkDataBindingHandler` class. It resolves design-time data binding for the `CustomHyperLink` class using the method. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/HyperLinkDesigner_Resubmit/CS/CustomHyperLinkDesigner.cs" id="Snippet2"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/HyperLinkDesigner_Resubmit/VB/customhyperlinkdesigner.vb" id="Snippet2"::: @@ -84,7 +84,7 @@ and properties of the control are data-bound. If the property is data-bound, this method sets the value of the property to "DataBound". If the property is data-bound, this method sets the value of the property to a text string so the control will have the appearance of a working hyperlink. + This method determines whether the and properties of the control are data-bound. If the property is data-bound, this method sets the value of the property to "DataBound". If the property is data-bound, this method sets the value of the property to a text string so the control will have the appearance of a working hyperlink. diff --git a/xml/System.Web.UI.Design/IControlDesignerBehavior.xml b/xml/System.Web.UI.Design/IControlDesignerBehavior.xml index 7cd5ba1b84e..eb8e5971864 100644 --- a/xml/System.Web.UI.Design/IControlDesignerBehavior.xml +++ b/xml/System.Web.UI.Design/IControlDesignerBehavior.xml @@ -21,13 +21,13 @@ Enables the extension of specific behaviors of a control designer. - [!NOTE] -> The interface is obsolete. Use the and interfaces for equivalent control designer functionality. - +> The interface is obsolete. Use the and interfaces for equivalent control designer functionality. + ]]> @@ -55,13 +55,13 @@ Gets the design-time view control object for the designer. The view control object for the designer. - [!NOTE] -> The interface is obsolete. Use the and interfaces for equivalent control designer functionality. - +> The interface is obsolete. Use the and interfaces for equivalent control designer functionality. + ]]> @@ -89,13 +89,13 @@ Gets or sets the design-time HTML for the designer's control. The HTML used at design time to format the control. - [!NOTE] -> The interface is obsolete. Use the and interfaces for equivalent control designer functionality. - +> The interface is obsolete. Use the and interfaces for equivalent control designer functionality. + ]]> @@ -123,17 +123,17 @@ Provides an opportunity to perform processing when the designer enters or exits template mode. - [!NOTE] > The interface is obsolete. Use the and interfaces for equivalent control designer functionality. - Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - + Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). + + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + ]]> When overriding in a derived class, be sure to call the base class's method so that registered delegates receive the event. diff --git a/xml/System.Web.UI.Design/IDataBindingSchemaProvider.xml b/xml/System.Web.UI.Design/IDataBindingSchemaProvider.xml index a6d07d0a48b..a22227a7809 100644 --- a/xml/System.Web.UI.Design/IDataBindingSchemaProvider.xml +++ b/xml/System.Web.UI.Design/IDataBindingSchemaProvider.xml @@ -77,7 +77,7 @@ method is called by the design host only if the property is `true`. + The method is called by the design host only if the property is `true`. ]]> diff --git a/xml/System.Web.UI.Design/IDataSourceDesigner.xml b/xml/System.Web.UI.Design/IDataSourceDesigner.xml index 23383615d85..02ab91c5461 100644 --- a/xml/System.Web.UI.Design/IDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design/IDataSourceDesigner.xml @@ -14,19 +14,19 @@ Defines the basic functionality for a data source designer. - interface defines an interface through which you can implement basic services for a data source designer. A designer is only active at design time, and must be associated with a data source, using a , in order to be loaded when a data source of the associated type is created at design time. - - The interface provides methods and properties that you can implement in order to provide custom behavior at design time. - - A designer can also use the available design-time services to perform a variety of tasks, including surveying the current design-time environment for components and their properties, reading and setting the values of properties of components, managing the toolbox, managing selected components, or displaying a user interface that can be used to configure values or to apply further processing. - - In most cases, implement your custom designer for a data source by deriving it from the class. Data sources whose associated designer does not derive from are displayed in the component tray. The class implements the interface and provides additional design-time support that may be of use to authors of designers. For more information, see the reference documentation for these classes. - - For an overview of creating design components, see [Extending Design-Time Support](https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2010/37899azc(v=vs.100)). - + interface defines an interface through which you can implement basic services for a data source designer. A designer is only active at design time, and must be associated with a data source, using a , in order to be loaded when a data source of the associated type is created at design time. + + The interface provides methods and properties that you can implement in order to provide custom behavior at design time. + + A designer can also use the available design-time services to perform a variety of tasks, including surveying the current design-time environment for components and their properties, reading and setting the values of properties of components, managing the toolbox, managing selected components, or displaying a user interface that can be used to configure values or to apply further processing. + + In most cases, implement your custom designer for a data source by deriving it from the class. Data sources whose associated designer does not derive from are displayed in the component tray. The class implements the interface and provides additional design-time support that may be of use to authors of designers. For more information, see the reference documentation for these classes. + + For an overview of creating design components, see [Extending Design-Time Support](https://learn.microsoft.com/previous-versions/visualstudio/visual-studio-2010/37899azc(v=vs.100)). + ]]> @@ -102,11 +102,11 @@ Launches the underlying data source's configuration wizard. - is `true`. - + is `true`. + ]]> @@ -131,11 +131,11 @@ Occurs when a data source has changed in a way that affects data-bound controls. - event occurs when the value of a field in the data source, or a property in the data-bound control that affects the data bindings to that field, has changed. - + event occurs when the value of a field in the data source, or a property in the data-bound control that affects the data bindings to that field, has changed. + ]]> @@ -167,13 +167,13 @@ Gets the for the specified view. A containing information about the identified view, or if a view with the specified name is not found. - can define a view in a way that is useful within the context of that class. - - Use the method to get a list of view names. - + can define a view in a way that is useful within the context of that class. + + Use the method to get a list of view names. + ]]> diff --git a/xml/System.Web.UI.Design/IDataSourceProvider.xml b/xml/System.Web.UI.Design/IDataSourceProvider.xml index 3d5d2e19c6d..be713278671 100644 --- a/xml/System.Web.UI.Design/IDataSourceProvider.xml +++ b/xml/System.Web.UI.Design/IDataSourceProvider.xml @@ -15,18 +15,18 @@ Defines an interface that a control designer can implement to provide access to a data source. - interface. This interface is used by the and classes. - - - -## Examples - The following code example shows a custom class, named `TemplatedListDesigner`, which inherits from the class and implements the `IDataSourceProvider` interface. - - :::code language="xml" source="~/snippets/common/VS_Snippets_WebNet/system.web.ui.design_samples1/Common/System.Web.UI.Design_Samples1.xml" id="Snippet1"::: - + interface. This interface is used by the and classes. + + + +## Examples + The following code example shows a custom class, named `TemplatedListDesigner`, which inherits from the class and implements the `IDataSourceProvider` interface. + + :::code language="xml" source="~/snippets/common/VS_Snippets_WebNet/system.web.ui.design_samples1/Common/System.Web.UI.Design_Samples1.xml" id="Snippet1"::: + ]]> @@ -53,13 +53,13 @@ Gets the selected data member from the selected data source. The selected data member from the selected data source, if the control allows the user to select an (such as a ) for the data source, and provides a property to select a particular list (or ) within the data source. - methods of the interface. The `GetSelectedDataSource` method gets an arbitrary object as the data source, and this implementation of the `GetResolvedSelectedDataSource` method converts that object into an object. - - :::code language="xml" source="~/snippets/common/VS_Snippets_WebNet/system.web.ui.design_samples1/Common/System.Web.UI.Design_Samples1.xml" id="Snippet17"::: - + methods of the interface. The `GetSelectedDataSource` method gets an arbitrary object as the data source, and this implementation of the `GetResolvedSelectedDataSource` method converts that object into an object. + + :::code language="xml" source="~/snippets/common/VS_Snippets_WebNet/system.web.ui.design_samples1/Common/System.Web.UI.Design_Samples1.xml" id="Snippet17"::: + ]]> @@ -86,13 +86,13 @@ Gets a reference to the selected data source from the data source provider. The currently selected data source object of this data source provider. - methods of the interface. The `GetSelectedDataSource` method is used to ensure that the data source associated with the control at design time is an object that implements the interface. This allows users to iterate through the data source. - - :::code language="xml" source="~/snippets/common/VS_Snippets_WebNet/system.web.ui.design_samples1/Common/System.Web.UI.Design_Samples1.xml" id="Snippet17"::: - + methods of the interface. The `GetSelectedDataSource` method is used to ensure that the data source associated with the control at design time is an object that implements the interface. This allows users to iterate through the data source. + + :::code language="xml" source="~/snippets/common/VS_Snippets_WebNet/system.web.ui.design_samples1/Common/System.Web.UI.Design_Samples1.xml" id="Snippet17"::: + ]]> diff --git a/xml/System.Web.UI.Design/IDataSourceSchema.xml b/xml/System.Web.UI.Design/IDataSourceSchema.xml index 5c1200faf4f..c90ea4efdc3 100644 --- a/xml/System.Web.UI.Design/IDataSourceSchema.xml +++ b/xml/System.Web.UI.Design/IDataSourceSchema.xml @@ -14,13 +14,13 @@ Provides basic functionality for describing the structure of a data source at design time. - interface to describe a custom data source at design time. For example, the , , and classes implement the interface. - - Classes that implement the are used by custom control designer components to provide lists of fields and views for data-bound controls at design time. - + interface to describe a custom data source at design time. For example, the , , and classes implement the interface. + + Classes that implement the are used by custom control designer components to provide lists of fields and views for data-bound controls at design time. + ]]> @@ -50,11 +50,11 @@ Gets an array of schema descriptors for views contained in the data source. An array of objects. - method returns an array of objects that implement the interface. For example, in the array returned by the method, each element of the array is a object that implements . - + method returns an array of objects that implement the interface. For example, in the array returned by the method, each element of the array is a object that implements . + ]]> diff --git a/xml/System.Web.UI.Design/IDataSourceViewSchema.xml b/xml/System.Web.UI.Design/IDataSourceViewSchema.xml index 2bd04a98da8..9d47019acff 100644 --- a/xml/System.Web.UI.Design/IDataSourceViewSchema.xml +++ b/xml/System.Web.UI.Design/IDataSourceViewSchema.xml @@ -17,7 +17,7 @@ class are used by custom control designer components to provide lists of views in a data source for data-bound controls at design time. In a class that is derived from the , use the method to get an array of objects. + Classes that implement the class are used by custom control designer components to provide lists of views in a data source for data-bound controls at design time. In a class that is derived from the , use the method to get an array of objects. ]]> @@ -51,7 +51,7 @@ class implements the interface. It uses its implementation of the method to create an array of objects. + The class implements the interface. It uses its implementation of the method to create an array of objects. ]]> @@ -83,7 +83,7 @@ class implements the interface; its implementation of the method returns an array of objects, each of which derives from the interface. + The class implements the interface; its implementation of the method returns an array of objects, each of which derives from the interface. ]]> diff --git a/xml/System.Web.UI.Design/IHierarchicalDataSourceDesigner.xml b/xml/System.Web.UI.Design/IHierarchicalDataSourceDesigner.xml index f87f347e8d6..3d63cdb650c 100644 --- a/xml/System.Web.UI.Design/IHierarchicalDataSourceDesigner.xml +++ b/xml/System.Web.UI.Design/IHierarchicalDataSourceDesigner.xml @@ -284,7 +284,7 @@ method. + You can restore events with the method. ]]> diff --git a/xml/System.Web.UI.Design/IHtmlControlDesignerBehavior.xml b/xml/System.Web.UI.Design/IHtmlControlDesignerBehavior.xml index a88f615a7dc..8d87e7b68e5 100644 --- a/xml/System.Web.UI.Design/IHtmlControlDesignerBehavior.xml +++ b/xml/System.Web.UI.Design/IHtmlControlDesignerBehavior.xml @@ -117,7 +117,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the property of the class for equivalent control designer functionality. +> The method is obsolete. Use the method on the property of the class for equivalent control designer functionality. ]]> @@ -161,7 +161,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the class for equivalent control designer functionality. +> The method is obsolete. Use the method on the class for equivalent control designer functionality. ]]> @@ -201,7 +201,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the property of the class for equivalent control designer functionality. +> The method is obsolete. Use the method on the property of the class for equivalent control designer functionality. ]]> @@ -275,7 +275,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the property of the class for equivalent control designer functionality. +> The method is obsolete. Use the method on the property of the class for equivalent control designer functionality. ]]> @@ -320,7 +320,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the class for equivalent control designer functionality. +> The method is obsolete. Use the method on the class for equivalent control designer functionality. ]]> diff --git a/xml/System.Web.UI.Design/ITemplateEditingFrame.xml b/xml/System.Web.UI.Design/ITemplateEditingFrame.xml index b7efaad511c..1e6234e7591 100644 --- a/xml/System.Web.UI.Design/ITemplateEditingFrame.xml +++ b/xml/System.Web.UI.Design/ITemplateEditingFrame.xml @@ -71,7 +71,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. Use the property on each template group element in the collection of a control designer. +> The interface is obsolete. Use the property on each template group element in the collection of a control designer. ]]> @@ -106,7 +106,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. Use the property on each template group element in the collection of a control designer. +> The interface is obsolete. Use the property on each template group element in the collection of a control designer. ]]> @@ -141,7 +141,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. Use the property in the property for each template group element in the collection of a control designer. +> The interface is obsolete. Use the property in the property for each template group element in the collection of a control designer. ]]> @@ -175,7 +175,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. Use the property in the property for each template group element in the collection of a control designer. +> The interface is obsolete. Use the property in the property for each template group element in the collection of a control designer. ]]> @@ -209,7 +209,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. The template group name is provided in the property of each template group element in the collection of a control designer. +> The interface is obsolete. The template group name is provided in the property of each template group element in the collection of a control designer. ]]> @@ -271,7 +271,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. Use the property on each template group element in the collection of a control designer. +> The interface is obsolete. Use the property on each template group element in the collection of a control designer. ]]> @@ -329,7 +329,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. A template name is provided through the property of a object. Enumerate the collection of template definitions by using the property of each element in the collection of a control designer. +> The interface is obsolete. A template name is provided through the property of a object. Enumerate the collection of template definitions by using the property of each element in the collection of a control designer. ]]> @@ -365,7 +365,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. A template style is provided through the property of a object. Enumerate the collection of template definitions by using the property of each element in the collection of a control designer. +> The interface is obsolete. A template style is provided through the property of a object. Enumerate the collection of template definitions by using the property of each element in the collection of a control designer. ]]> @@ -404,7 +404,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. Use the property on each template group element in the collection of a control designer. +> The interface is obsolete. Use the property on each template group element in the collection of a control designer. ]]> @@ -439,7 +439,7 @@ ## Remarks > [!NOTE] -> The interface is obsolete. Use the property of each template group in the collection for a control designer. +> The interface is obsolete. Use the property of each template group in the collection for a control designer. ]]> diff --git a/xml/System.Web.UI.Design/IWebFormReferenceManager.xml b/xml/System.Web.UI.Design/IWebFormReferenceManager.xml index eb91f8b45e5..fbc0bd41493 100644 --- a/xml/System.Web.UI.Design/IWebFormReferenceManager.xml +++ b/xml/System.Web.UI.Design/IWebFormReferenceManager.xml @@ -67,7 +67,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the class for equivalent designer functionality. +> The method is obsolete. Use the method on the class for equivalent designer functionality. ]]> @@ -101,7 +101,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the class for equivalent designer functionality. +> The method is obsolete. Use the method on the class for equivalent designer functionality. ]]> @@ -138,7 +138,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method on the class for equivalent designer functionality. +> The method is obsolete. Use the method on the class for equivalent designer functionality. ]]> diff --git a/xml/System.Web.UI.Design/IWebFormsDocumentService.xml b/xml/System.Web.UI.Design/IWebFormsDocumentService.xml index 13d69256494..f0255d178d2 100644 --- a/xml/System.Web.UI.Design/IWebFormsDocumentService.xml +++ b/xml/System.Web.UI.Design/IWebFormsDocumentService.xml @@ -123,7 +123,7 @@ ## Remarks > [!NOTE] -> The interface property is obsolete. Use the property on the class for equivalent designer functionality. +> The interface property is obsolete. Use the property on the class for equivalent designer functionality. ]]> @@ -190,7 +190,7 @@ ## Remarks > [!NOTE] -> The interface property is obsolete. Use the property on the class for equivalent designer functionality. +> The interface property is obsolete. Use the property on the class for equivalent designer functionality. ]]> diff --git a/xml/System.Web.UI.Design/MailFileEditor.xml b/xml/System.Web.UI.Design/MailFileEditor.xml index 8859652fa72..a383db05c1d 100644 --- a/xml/System.Web.UI.Design/MailFileEditor.xml +++ b/xml/System.Web.UI.Design/MailFileEditor.xml @@ -22,9 +22,9 @@ ## Remarks The class is an object that can be used at design time to select and edit a mail file name as a string, and assign the string to a control property. For example, the control uses the class at design time to set the value of the property. - Use the attribute to associate the with a property. When the associated property is edited in the design surface, the designer host calls the method. The method displays a dialog box for selecting a mail file name from a filtered list of files, and returns the file name that is selected by the user. The method indicates the display style of the user interface. + Use the attribute to associate the with a property. When the associated property is edited in the design surface, the designer host calls the method. The method displays a dialog box for selecting a mail file name from a filtered list of files, and returns the file name that is selected by the user. The method indicates the display style of the user interface. - Derive a class from the to define a custom editor for a mail file name property. For example, a derived class can override the method, and display an instance with a custom mail file filter or title. + Derive a class from the to define a custom editor for a mail file name property. For example, a derived class can override the method, and display an instance with a custom mail file filter or title. diff --git a/xml/System.Web.UI.Design/MdbDataFileEditor.xml b/xml/System.Web.UI.Design/MdbDataFileEditor.xml index 7e22e2d071a..7ccaf2142d8 100644 --- a/xml/System.Web.UI.Design/MdbDataFileEditor.xml +++ b/xml/System.Web.UI.Design/MdbDataFileEditor.xml @@ -22,9 +22,9 @@ ## Remarks An object is used at design time to select and edit a URL for a Microsoft Access database file (.mdb), and then assign the URL to a control property. For example, the control uses the class at design time to set the value of the property. - Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method uses the method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The method indicates the display style of the user interface. + Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method uses the method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The method indicates the display style of the user interface. - Derive a class from the to define a custom editor for an Access database URL property. For example, a derived class can override the method, and then call the method with a custom or value. + Derive a class from the to define a custom editor for an Access database URL property. For example, a derived class can override the method, and then call the method with a custom or value. @@ -88,7 +88,7 @@ string is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. + The string is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. ]]> @@ -118,7 +118,7 @@ property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. + The property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. The property default value indicates two URL filters for the dialog box: one for Microsoft Access database files (*.mdb) and another for all files (\*.\*). diff --git a/xml/System.Web.UI.Design/ReadWriteControlDesigner.xml b/xml/System.Web.UI.Design/ReadWriteControlDesigner.xml index cede6c155c5..2dc828d5906 100644 --- a/xml/System.Web.UI.Design/ReadWriteControlDesigner.xml +++ b/xml/System.Web.UI.Design/ReadWriteControlDesigner.xml @@ -133,7 +133,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the method for equivalent control designer functionality. +> The method is obsolete. Use the method for equivalent control designer functionality. > [!NOTE] > this method must be overridden in a derived class to implement the designer. @@ -175,7 +175,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the members of the property instead. For example, use the and methods on the property to map properties to styles. +> The method is obsolete. Use the members of the property instead. For example, use the and methods on the property to map properties to styles. ]]> diff --git a/xml/System.Web.UI.Design/ResourceExpressionEditor.xml b/xml/System.Web.UI.Design/ResourceExpressionEditor.xml index 8dbd8b861c0..75c61d3a16f 100644 --- a/xml/System.Web.UI.Design/ResourceExpressionEditor.xml +++ b/xml/System.Web.UI.Design/ResourceExpressionEditor.xml @@ -28,7 +28,7 @@ The base property for a returns the string `Resources`. The class is associated with the expression prefix `Resources` and the implementation. - The method evaluates an input resource expression. The method returns the implementation that is used to select the resource name, class, and designer default value, and to form a resource expression from the selected resource values. + The method evaluates an input resource expression. The method returns the implementation that is used to select the resource name, class, and designer default value, and to form a resource expression from the selected resource values. @@ -130,11 +130,11 @@ method looks up the resource that is specified by `expression`, and then returns the resource. + The method looks up the resource that is specified by `expression`, and then returns the resource. - The visual designer uses the method to evaluate a resource expression and provide the design-time value for an associated control property. At run time, the page parser uses the and methods of the corresponding implementation to evaluate an expression and provide the run-time value for an associated control property. + The visual designer uses the method to evaluate a resource expression and provide the design-time value for an associated control property. At run time, the page parser uses the and methods of the corresponding implementation to evaluate an expression and provide the run-time value for an associated control property. - The visual designer uses the method to parse the expression string at design time, and then calls the method with the parsed expression data. + The visual designer uses the method to parse the expression string at design time, and then calls the method with the parsed expression data. ]]> @@ -171,7 +171,7 @@ method returns an expression editor sheet implementation for resource expressions. The visual designer host uses the expression editor sheet in its expressions dialog box. + The method returns an expression editor sheet implementation for resource expressions. The visual designer host uses the expression editor sheet in its expressions dialog box. ]]> diff --git a/xml/System.Web.UI.Design/ResourceExpressionEditorSheet.xml b/xml/System.Web.UI.Design/ResourceExpressionEditorSheet.xml index eadfb3b091c..b25bca9635e 100644 --- a/xml/System.Web.UI.Design/ResourceExpressionEditorSheet.xml +++ b/xml/System.Web.UI.Design/ResourceExpressionEditorSheet.xml @@ -22,7 +22,7 @@ ## Remarks The visual designer uses the class with the class to select the individual properties of a resource reference expression, and to combine the selected resource expression property values into a resource expression. - The method returns a object. In the expressions dialog box, when you select a control property and bind it to a resource expression, the visual designer calls the method. The visual designer uses the returned object to prompt for the and properties. Once the resource expression properties are selected, the visual designer calls the method to combine the properties into a resource expression string. + The method returns a object. In the expressions dialog box, when you select a control property and bind it to a resource expression, the visual designer calls the method. The visual designer uses the returned object to prompt for the and properties. Once the resource expression properties are selected, the visual designer calls the method to combine the properties into a resource expression string. The property must be specified in a resource expression; it indexes the resource value. The property is optional. It references the class key or file name that defines the resource in the global resources folder. @@ -83,7 +83,7 @@ and property values are set using the input `expression` string. The property is set using the input `serviceProvider` implementation. + The initial and property values are set using the input `expression` string. The property is set using the input `serviceProvider` implementation. ]]> @@ -225,7 +225,7 @@ ## Remarks The property is required for a resource expression; it indicates the name of the resource. The name of the resource is used at both run time and design time to look up a resource and assign it to a control property. - For example, if the property for a control is assigned to the resource expression `<%$ Resources:Strings, labelText $>`, the resource expression is evaluated and the field is assigned to the `labelText` resource value in the `Strings` class. + For example, if the property for a control is assigned to the resource expression `<%$ Resources:Strings, labelText $>`, the resource expression is evaluated and the field is assigned to the `labelText` resource value in the `Strings` class. ]]> diff --git a/xml/System.Web.UI.Design/RouteUrlExpressionEditor.xml b/xml/System.Web.UI.Design/RouteUrlExpressionEditor.xml index d73a8a124ac..1e0b727ab1e 100644 --- a/xml/System.Web.UI.Design/RouteUrlExpressionEditor.xml +++ b/xml/System.Web.UI.Design/RouteUrlExpressionEditor.xml @@ -88,7 +88,7 @@ method to evaluate a `RouteUrl` expression and provide the design-time value for an associated control property. + The visual designer uses the method to evaluate a `RouteUrl` expression and provide the design-time value for an associated control property. ]]> @@ -126,7 +126,7 @@ method returns an editor-sheet implementation for `RouteUrl` expressions. The editor sheet for `RouteUrl` expressions enables users to select parameters and a route name. After users have selected the parameters and route name, the editor-sheet implementation generates a `RouteUrl` expression, which is returned to the visual designer. + The method returns an editor-sheet implementation for `RouteUrl` expressions. The editor sheet for `RouteUrl` expressions enables users to select parameters and a route name. After users have selected the parameters and route name, the editor-sheet implementation generates a `RouteUrl` expression, which is returned to the visual designer. ]]> diff --git a/xml/System.Web.UI.Design/RouteUrlExpressionEditorSheet.xml b/xml/System.Web.UI.Design/RouteUrlExpressionEditorSheet.xml index 9e11d4beea3..494abcc9333 100644 --- a/xml/System.Web.UI.Design/RouteUrlExpressionEditorSheet.xml +++ b/xml/System.Web.UI.Design/RouteUrlExpressionEditorSheet.xml @@ -21,9 +21,9 @@ ## Remarks The visual designer uses the class together with the class to select the individual properties of a `RouteUrl` expression, and to combine the selected expression property values into a `RouteUrl` expression. - The method returns a object. In the expressions dialog box, when you select a control property and bind it to a `RouteUrl` expression, the visual designer calls the method. The visual designer uses the returned object to prompt for the and properties. Once the properties are selected, the visual designer calls the method to combine the properties into a `RouteUrl` expression string. + The method returns a object. In the expressions dialog box, when you select a control property and bind it to a `RouteUrl` expression, the visual designer calls the method. The visual designer uses the returned object to prompt for the and properties. Once the properties are selected, the visual designer calls the method to combine the properties into a `RouteUrl` expression string. - The property must be specified if the property is not specified. The property must be specified if the is not specified. Both properties may be specified. + The property must be specified if the property is not specified. The property must be specified if the is not specified. Both properties may be specified. ]]> @@ -57,7 +57,7 @@ and property values are set using the input `expression` string. The property is set using the input `serviceProvider` implementation. + The initial and property values are set using the input `expression` string. The property is set using the input `serviceProvider` implementation. ]]> diff --git a/xml/System.Web.UI.Design/RouteValueExpressionEditor.xml b/xml/System.Web.UI.Design/RouteValueExpressionEditor.xml index 2c3c6b36239..5689cb8b83a 100644 --- a/xml/System.Web.UI.Design/RouteValueExpressionEditor.xml +++ b/xml/System.Web.UI.Design/RouteValueExpressionEditor.xml @@ -88,7 +88,7 @@ method to evaluate a `RouteValue` expression and to provide the design-time value for an associated control property. + The visual designer uses the method to evaluate a `RouteValue` expression and to provide the design-time value for an associated control property. ]]> @@ -126,7 +126,7 @@ method returns an editor-sheet implementation for `RouteValue` expressions. The editor sheet for `RouteValue` expressions enables users to select a URL parameter. After users have selected the parameter, the editor-sheet implementation generates a `RouteValue` expression that is returned to the visual designer. + The method returns an editor-sheet implementation for `RouteValue` expressions. The editor sheet for `RouteValue` expressions enables users to select a URL parameter. After users have selected the parameter, the editor-sheet implementation generates a `RouteValue` expression that is returned to the visual designer. ]]> diff --git a/xml/System.Web.UI.Design/RouteValueExpressionEditorSheet.xml b/xml/System.Web.UI.Design/RouteValueExpressionEditorSheet.xml index 12542713d7d..6c1a443a54d 100644 --- a/xml/System.Web.UI.Design/RouteValueExpressionEditorSheet.xml +++ b/xml/System.Web.UI.Design/RouteValueExpressionEditorSheet.xml @@ -21,7 +21,7 @@ ## Remarks The visual designer uses the class together with the class to select the individual properties of a `RouteValue` expression, and to combine the selected expression property values into a `RouteValue` expression. - The method returns a object. In the expressions dialog box, when you select a control property and bind it to a `RouteValue` expression, the visual designer calls the method. The visual designer uses the returned object to prompt for the property. Once the property is selected, the visual designer calls the method to create a `RouteValue` expression string. + The method returns a object. In the expressions dialog box, when you select a control property and bind it to a `RouteValue` expression, the visual designer calls the method. The visual designer uses the returned object to prompt for the property. Once the property is selected, the visual designer calls the method to create a `RouteValue` expression string. The property must be specified in order to create a `RouteValue` expression string. diff --git a/xml/System.Web.UI.Design/ScriptManagerDesigner.xml b/xml/System.Web.UI.Design/ScriptManagerDesigner.xml index fb5f50a5d5f..99125ff4591 100644 --- a/xml/System.Web.UI.Design/ScriptManagerDesigner.xml +++ b/xml/System.Web.UI.Design/ScriptManagerDesigner.xml @@ -240,13 +240,13 @@ ## Remarks The collection that is returned includes framework scripts that are sent automatically to the client to support AJAX functionality such as the and control. - When you use the method, be aware of the following guidelines: + When you use the method, be aware of the following guidelines: -- objects with the same and properties are removed as duplicates. +- objects with the same and properties are removed as duplicates. -- objects with the same are not removed as duplicates at design time. However, they are removed as duplicates at run time. +- objects with the same are not removed as duplicates at design time. However, they are removed as duplicates at run time. -- The method is used to return a fully qualified URL for the property of a object. +- The method is used to return a fully qualified URL for the property of a object. - The objects in the returned collection are cloned versions of the original script references and therefore cannot be modified in designer code by using this collection. diff --git a/xml/System.Web.UI.Design/SupportsPreviewControlAttribute.xml b/xml/System.Web.UI.Design/SupportsPreviewControlAttribute.xml index cd4cba87111..a36a0ad4644 100644 --- a/xml/System.Web.UI.Design/SupportsPreviewControlAttribute.xml +++ b/xml/System.Web.UI.Design/SupportsPreviewControlAttribute.xml @@ -28,25 +28,25 @@ ## Remarks Apply the attribute to a control designer class to indicate the type of preview control that is supported by the control designer. Use this attribute to change a preview control for design-time rendering without affecting the actual persisted instance of the associated control. - Typically, you specify the when declaring a custom designer class that is derived from the class. The value of the property for the attribute determines the behavior for the and members in the base class. + Typically, you specify the when declaring a custom designer class that is derived from the class. The value of the property for the attribute determines the behavior for the and members in the base class. Set the property to `true` to indicate that the designer uses a temporary copy of the associated control to generate the design-time HTML. Changes to the temporary control are not persisted. - Set the property to `false` to indicate that the designer returns the control instance, specifically the property, from the method. Changes to the control object are persisted. + Set the property to `false` to indicate that the designer returns the control instance, specifically the property, from the method. Changes to the control object are persisted. For example, the class is marked with the set to `true`. The designer uses the preview control with the automatic style formatting task, which allows the user to preview various autoformat stylesthat can be applied to the calendar. As the user selects different autoformat styles in the user interface, the selected style scheme is applied to the preview control. Applying a new style to the preview control does not change the scheme that is applied to the instance of the control in the designer. - If the is not specified in the control designer declaration, the behavior is equivalent to specifying the as `false`. + If the is not specified in the control designer declaration, the behavior is equivalent to specifying the as `false`. > [!NOTE] -> Designer classes derived from the class can override the and members, and ignore the attribute. To determine the expected behavior for and , see the reference documentation for the derived control designer class. +> Designer classes derived from the class can override the and members, and ignore the attribute. To determine the expected behavior for and , see the reference documentation for the derived control designer class. For general information about using attributes, see [Attributes Overview](https://msdn.microsoft.com/library/a4daf212-2410-423d-a800-7a08864e9bff) and [Attributes](/dotnet/standard/attributes/). For more information about design-time attributes, see [Attributes and Design-Time Support](https://msdn.microsoft.com/library/7aed9eb4-124b-4a15-a0a3-458f37ac9ef7). ## Examples - The following code example demonstrates how to mark a control designer with the attribute. The code example derives an ASP.NET server control from the class and associates the ASP.NET server control with a custom control designer implementation. The control designer class declaration is marked with the `SupportsPreviewControl` attribute set to `true`. The control designer overrides the method and encloses the design-time HTML for the control in italic tags. + The following code example demonstrates how to mark a control designer with the attribute. The code example derives an ASP.NET server control from the class and associates the ASP.NET server control with a custom control designer implementation. The control designer class declaration is marked with the `SupportsPreviewControl` attribute set to `true`. The control designer overrides the method and encloses the design-time HTML for the control in italic tags. :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.Design.SupportsPreviewControlAttribute/CS/supportspreviewdesigner.cs" id="Snippet1"::: :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.Design.SupportsPreviewControlAttribute/VB/supportspreviewdesigner.vb" id="Snippet1"::: @@ -118,7 +118,7 @@ ## Remarks The property of the field is set to `false`. - Use the method to determine whether the value for the property is set to the default preview value. + Use the method to determine whether the value for the property is set to the default preview value. ]]> @@ -153,9 +153,9 @@ method overrides the method. + The method overrides the method. - The method compares two instances based on the value of their properties. + The method compares two instances based on the value of their properties. ]]> @@ -186,9 +186,9 @@ method overrides the method. + The method overrides the method. - The method generates the same hash code for two objects that are equal according to the method. The hash code is suitable for use in hashing algorithms and data structures, such as hash tables. + The method generates the same hash code for two objects that are equal according to the method. The hash code is suitable for use in hashing algorithms and data structures, such as hash tables. ]]> @@ -222,7 +222,7 @@ method compares the value for the property of the current object with the value for the property of the static field. + The method compares the value for the property of the current object with the value for the property of the static field. ]]> @@ -259,11 +259,11 @@ property by applying the attribute to a custom designer class declaration. The value of the property for the attribute determines the behavior for the and members in the base class. + Typically, you specify a value for the property by applying the attribute to a custom designer class declaration. The value of the property for the attribute determines the behavior for the and members in the base class. Set the property to `true` to indicate that the designer uses a temporary copy of the associated control to generate the design-time HTML. Changes to the temporary control are not persisted. - Set the property to `false` to indicate that the designer returns the control instance, specifically the property, from the method. Changes to the control object are persisted. + Set the property to `false` to indicate that the designer returns the control instance, specifically the property, from the method. Changes to the control object are persisted. ]]> diff --git a/xml/System.Web.UI.Design/TemplateDefinition.xml b/xml/System.Web.UI.Design/TemplateDefinition.xml index c6b24df53e1..9fa318ac855 100644 --- a/xml/System.Web.UI.Design/TemplateDefinition.xml +++ b/xml/System.Web.UI.Design/TemplateDefinition.xml @@ -416,7 +416,7 @@ property is read-only, its properties can be set, and if is true, the content can be edited. + Although this property is read-only, its properties can be set, and if is true, the content can be edited. ]]> diff --git a/xml/System.Web.UI.Design/TemplateEditingVerb.xml b/xml/System.Web.UI.Design/TemplateEditingVerb.xml index ab4c5784290..0f0bbe1afff 100644 --- a/xml/System.Web.UI.Design/TemplateEditingVerb.xml +++ b/xml/System.Web.UI.Design/TemplateEditingVerb.xml @@ -168,7 +168,7 @@ allows the resources used by the to be reallocated for other purposes. + Calling allows the resources used by the to be reallocated for other purposes. > [!NOTE] > The class is obsolete. Expose templates through the property of a control designer. The design host creates a for each defined for a control designer. @@ -251,9 +251,9 @@ For more information about `Dispose` and , see [Cle and cleans up resources by calling `Dispose(false)`. Override `Dispose(Boolean)` to customize the cleanup. + This method overrides and cleans up resources by calling `Dispose(false)`. Override `Dispose(Boolean)` to customize the cleanup. - Application code should not call this method; an object's `Finalize` method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the method. + Application code should not call this method; an object's `Finalize` method is automatically invoked during garbage collection, unless finalization by the garbage collector has been disabled by a call to the method. For more information, see [Finalize Methods and Destructors](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/0s71x931(v%3dvs.100)), [Cleaning Up Unmanaged Resources](/dotnet/standard/garbage-collection/unmanaged), and [Overriding the Finalize Method](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/ddae83kx(v=vs.100)). diff --git a/xml/System.Web.UI.Design/TemplateGroupCollection.xml b/xml/System.Web.UI.Design/TemplateGroupCollection.xml index 431df13f99d..9160af34dc2 100644 --- a/xml/System.Web.UI.Design/TemplateGroupCollection.xml +++ b/xml/System.Web.UI.Design/TemplateGroupCollection.xml @@ -36,25 +36,25 @@ Additionally, use the methods and properties to provide the following functionality: -- The method to add a single group to the collection. +- The method to add a single group to the collection. -- The method to add a group at a particular index within the collection. +- The method to add a group at a particular index within the collection. -- The method to remove a group. +- The method to remove a group. -- The method to remove the group at a particular index. +- The method to remove the group at a particular index. -- The method to determine whether a particular group is already in the collection. +- The method to determine whether a particular group is already in the collection. -- The method to retrieve the index of a group within the collection. +- The method to retrieve the index of a group within the collection. -- The indexer to get or set the group at a particular index, using array notation. +- The indexer to get or set the group at a particular index, using array notation. -- The method to add multiple groups to the collection. +- The method to add multiple groups to the collection. You can add multiple groups either as an array of groups or as a object that you retrieve through the property of another control designer. -- The method to remove all groups from the collection. +- The method to remove all groups from the collection. @@ -99,7 +99,7 @@ constructor to create an empty collection. You can add elements to the collection by using the , , or method. + Use the constructor to create an empty collection. You can add elements to the collection by using the , , or method. ]]> @@ -135,9 +135,9 @@ method adds the specified object to the end of the collection. To add a object to the collection at a specific index location, use the method. + The method adds the specified object to the end of the collection. To add a object to the collection at a specific index location, use the method. - To add multiple groups to the collection, use the method. + To add multiple groups to the collection, use the method. ]]> @@ -173,7 +173,7 @@ method adds multiple groups to the collection. To add a single object to the end of the collection, use the method. To add a object to the collection at a specific index location, use the method. + The method adds multiple groups to the collection. To add a single object to the end of the collection, use the method. To add a object to the collection at a specific index location, use the method. ]]> @@ -207,7 +207,7 @@ method to remove all groups from the collection. To remove a specific group from the collection, use the method. To remove a group at a particular index, use the method. + Use the method to remove all groups from the collection. To remove a specific group from the collection, use the method. To remove a group at a particular index, use the method. ]]> @@ -244,9 +244,9 @@ method determines equality by using the method on the objects. + The method determines equality by using the method on the objects. - The method performs a linear search; therefore, the average execution time is proportional to the property. Because template group collections typically are small, the performance of the linear search operation is not critical. + The method performs a linear search; therefore, the average execution time is proportional to the property. Because template group collections typically are small, the performance of the linear search operation is not critical. ]]> @@ -366,9 +366,9 @@ method determines equality by using the method on the objects. + The method determines equality by using the method on the objects. - The performs a linear search; therefore, the average execution time is proportional to the property. Because template group collections typically are small, the performance of the linear search operation is not critical. + The performs a linear search; therefore, the average execution time is proportional to the property. Because template group collections typically are small, the performance of the linear search operation is not critical. ]]> @@ -406,7 +406,7 @@ method adds a object to the collection at a specific index location. To add a single to the end of the collection, use the method. To add multiple groups to the collection, use the method. + The method adds a object to the collection at a specific index location. To add a single to the end of the collection, use the method. To add multiple groups to the collection, use the method. > [!NOTE] > When you insert an item into the collection, the indexes change for subsequent items in the collection. @@ -452,9 +452,9 @@ indexer to retrieve the group at a specified `index` within the collection or to set the group at a specified `index` within the collection. You can index elements in the collection by using array notation. For example, you can index an element at index `i` with the notation `TemplateGroups(i)` for Microsoft VisualBasic or `TemplateGroups[i]` for C#. + Use the indexer to retrieve the group at a specified `index` within the collection or to set the group at a specified `index` within the collection. You can index elements in the collection by using array notation. For example, you can index an element at index `i` with the notation `TemplateGroups(i)` for Microsoft VisualBasic or `TemplateGroups[i]` for C#. - When you have a reference to the group object and need the index of the object in the collection, use the method. + When you have a reference to the group object and need the index of the object in the collection, use the method. ]]> @@ -495,13 +495,13 @@ method removes the first occurrence of `group` from the collection. If the object does not contain `group`, the collection remains unchanged. No exception is thrown. + The method removes the first occurrence of `group` from the collection. If the object does not contain `group`, the collection remains unchanged. No exception is thrown. - The method determines equality by using the method on the objects. + The method determines equality by using the method on the objects. - The method performs a linear search; therefore, the average execution time is proportional to the property. Because template group collections typically are small, the performance of the linear search operation is not critical. + The method performs a linear search; therefore, the average execution time is proportional to the property. Because template group collections typically are small, the performance of the linear search operation is not critical. - To remove a group at a particular index from the collection, use the method. To remove all the groups from the collection, use the method. + To remove a group at a particular index from the collection, use the method. To remove all the groups from the collection, use the method. > [!NOTE] > When you remove an item from the collection, the indexes change for subsequent items in the collection. @@ -539,7 +539,7 @@ method to remove a group at a particular index from the collection. To remove a specified group from the collection, use the method. To remove all the groups from the collection, use the method. + Use the method to remove a group at a particular index from the collection. To remove a specified group from the collection, use the method. To remove all the groups from the collection, use the method. > [!NOTE] > When you remove an item from the collection, the indexes change for subsequent items in the collection. diff --git a/xml/System.Web.UI.Design/TemplateModeChangedEventArgs.xml b/xml/System.Web.UI.Design/TemplateModeChangedEventArgs.xml index f9590c2bfe1..bce929224f8 100644 --- a/xml/System.Web.UI.Design/TemplateModeChangedEventArgs.xml +++ b/xml/System.Web.UI.Design/TemplateModeChangedEventArgs.xml @@ -26,7 +26,7 @@ When the object indicates that the template mode has changed, the default delegate in the class updates the value for the property. - Custom designers that are derived from the class can override the method to perform additional processing when the template editing mode changes for a control on the design surface. + Custom designers that are derived from the class can override the method to perform additional processing when the template editing mode changes for a control on the design surface. For more information about events and delegates, see [Handling and Raising Events](/dotnet/standard/events/). @@ -66,7 +66,7 @@ delegate method uses the constructor to initialize a object for use with a object. + A delegate method uses the constructor to initialize a object for use with a object. When you exit or enter template editing mode, the designer host initializes a object for a event type, and then sets the property with a object. The `newTemplateGroup` parameter specifies a new template group when you enter template editing mode. The `newTemplateGroup` parameter is typically `null` for exiting template editing mode. @@ -105,7 +105,7 @@ property specifies a new template group when you enter template editing mode. is `null` for events that are raised when you exit template editing mode. + The property specifies a new template group when you enter template editing mode. is `null` for events that are raised when you exit template editing mode. ]]> diff --git a/xml/System.Web.UI.Design/TemplatedControlDesigner.xml b/xml/System.Web.UI.Design/TemplatedControlDesigner.xml index 6c180ed5227..6b4393f171f 100644 --- a/xml/System.Web.UI.Design/TemplatedControlDesigner.xml +++ b/xml/System.Web.UI.Design/TemplatedControlDesigner.xml @@ -227,9 +227,9 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the property to manipulate templates within a designer for template-based controls. +> The method is obsolete. Use the property to manipulate templates within a designer for template-based controls. - If already in template mode and editing a different template frame, this method calls to save all its templates and close that frame. + If already in template mode and editing a different template frame, this method calls to save all its templates and close that frame. ]]> @@ -278,7 +278,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the property to manipulate templates within a designer for template-based controls. +> The method is obsolete. Use the property to manipulate templates within a designer for template-based controls. ]]> @@ -318,7 +318,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the property to manipulate templates within a designer for template-based controls. +> The method is obsolete. Use the property to manipulate templates within a designer for template-based controls. ]]> @@ -383,7 +383,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the property of the collection elements to examine template metadata within a designer for template-based controls. +> The method is obsolete. Use the property of the collection elements to examine template metadata within a designer for template-based controls. ]]> @@ -564,7 +564,7 @@ ## Remarks > [!NOTE] -> The method is obsolete. Use the property of the collection elements to examine template metadata within a designer for template-based controls. +> The method is obsolete. Use the property of the collection elements to examine template metadata within a designer for template-based controls. ]]> @@ -729,7 +729,7 @@ The property is never hidden. ## Remarks > [!NOTE] -> The method is obsolete. Use the and methods on the property to map properties to styles. +> The method is obsolete. Use the and methods on the property to map properties to styles. ]]> @@ -822,11 +822,11 @@ The property is never hidden. ## Remarks The event is raised by the designer host for certain actions on a control in the design surface. For example, an event is raised when the user enters or exits template editing mode for a control. - The class supplies a default delegate to handle the event. Classes deriving from the override the method to process events that are raised when the template mode changes for the associated control. + The class supplies a default delegate to handle the event. Classes deriving from the override the method to process events that are raised when the template mode changes for the associated control. - The method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - The default delegate performs the updates that are required for a template mode change event in the base class, and then calls the method. The base method in the class returns without performing any additional processing for the event. If a class derives from the and overrides the base method, the default delegate calls the override method in the derived class. + The default delegate performs the updates that are required for a template mode change event in the base class, and then calls the method. The base method in the class returns without performing any additional processing for the event. If a class derives from the and overrides the base method, the default delegate calls the override method in the derived class. Use the property to determine whether the control designer is in template editing mode currently. diff --git a/xml/System.Web.UI.Design/TextDataBindingHandler.xml b/xml/System.Web.UI.Design/TextDataBindingHandler.xml index abf8fbae59e..5db9c6f16eb 100644 --- a/xml/System.Web.UI.Design/TextDataBindingHandler.xml +++ b/xml/System.Web.UI.Design/TextDataBindingHandler.xml @@ -18,11 +18,11 @@ Provides a data-binding handler for a data-bound control at design time. - object is a data-binding handler that can provide data to a data-bound text property at design time. Data-binding handlers are used when there is no designer for the control present that would otherwise provide the data for the data bound property. - + object is a data-binding handler that can provide data to a data-bound text property at design time. Data-binding handlers are used when there is no designer for the control present that would otherwise provide the data for the data bound property. + ]]> @@ -80,13 +80,13 @@ The to data-bind. Data-binds the specified control. - method of sets the `Text` property of the control, if it exists, to a sample data string. - - This method should be implemented in a derived class to provide functionality to a custom data-binding handler. The logic for the data-binding should be implemented within this method, and can be specific to the type or types that the handler is binding a property or properties on. - + method of sets the `Text` property of the control, if it exists, to a sample data string. + + This method should be implemented in a derived class to provide functionality to a custom data-binding handler. The logic for the data-binding should be implemented within this method, and can be specific to the type or types that the handler is binding a property or properties on. + ]]> diff --git a/xml/System.Web.UI.Design/TransactedChangeCallback.xml b/xml/System.Web.UI.Design/TransactedChangeCallback.xml index d74ff505e13..f76fe2925cb 100644 --- a/xml/System.Web.UI.Design/TransactedChangeCallback.xml +++ b/xml/System.Web.UI.Design/TransactedChangeCallback.xml @@ -25,11 +25,11 @@ if the transaction completed successfully; if the transaction should be rolled back. - . - + . + ]]> diff --git a/xml/System.Web.UI.Design/TypeSchema.xml b/xml/System.Web.UI.Design/TypeSchema.xml index 948aec2cdff..0386dbfe400 100644 --- a/xml/System.Web.UI.Design/TypeSchema.xml +++ b/xml/System.Web.UI.Design/TypeSchema.xml @@ -21,13 +21,13 @@ Represents the structure, or schema, of an object type. - class provides information about a particular class, given an instance of that class. For example, given a object, a object, or an instance of a custom class that you create, the methods and properties provide information about the class from which the object derives. It does not provide information about the specific instance, but about the class. - - The class is used by custom control designers to assist in preparing sample data for previewing custom controls. - + class provides information about a particular class, given an instance of that class. For example, given a object, a object, or an instance of a custom class that you create, the methods and properties provide information about the class from which the object derives. It does not provide information about the specific instance, but about the class. + + The class is used by custom control designers to assist in preparing sample data for previewing custom controls. + ]]> @@ -83,20 +83,20 @@ Gets an array of schema descriptors for views into a data source. An array of instances of , or of instances of a class that implements the interface. - method always returns an array of objects that implement the interface, the exact return value is dependent on the object that is provided when creating the instance of the class. - - The following table provides examples of return values. - -|Underlying Type|Return Value| -|---------------------|------------------| -|A |An array of type , one for each .| -|A |A one-item array containing a .| -|An type|A one-item array containing an .| -|Any other type|A one-item array containing an .| - + method always returns an array of objects that implement the interface, the exact return value is dependent on the object that is provided when creating the instance of the class. + + The following table provides examples of return values. + +|Underlying Type|Return Value| +|---------------------|------------------| +|A |An array of type , one for each .| +|A |A one-item array containing a .| +|An type|A one-item array containing an .| +|Any other type|A one-item array containing an .| + ]]> diff --git a/xml/System.Web.UI.Design/UpdatePanelTriggerCollectionEditor.xml b/xml/System.Web.UI.Design/UpdatePanelTriggerCollectionEditor.xml index 7d33521a0f7..cda8691e7d8 100644 --- a/xml/System.Web.UI.Design/UpdatePanelTriggerCollectionEditor.xml +++ b/xml/System.Web.UI.Design/UpdatePanelTriggerCollectionEditor.xml @@ -87,7 +87,7 @@ method always returns `false`. Therefore, only one trigger can be selected every time that the object is used. A trigger can be an or a object. + The method always returns `false`. Therefore, only one trigger can be selected every time that the object is used. A trigger can be an or a object. ]]> diff --git a/xml/System.Web.UI.Design/UrlBuilder.xml b/xml/System.Web.UI.Design/UrlBuilder.xml index bc70371b9b4..3bb2141b6e1 100644 --- a/xml/System.Web.UI.Design/UrlBuilder.xml +++ b/xml/System.Web.UI.Design/UrlBuilder.xml @@ -18,20 +18,20 @@ Starts a URL editor that allows a user to select or create a URL. This class cannot be inherited. - method starts a user interface for selecting a URL. - - - -## Examples - The following code example shows how to use the method to launch a URL builder from a menu command at design time. - + method starts a user interface for selecting a URL. + + + +## Examples + The following code example shows how to use the method to launch a URL builder from a menu command at design time. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_WebNet/UrlBuilderExample/CPP/urlbuilderdesigner.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/UrlBuilderExample/CS/urlbuilderdesigner.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/UrlBuilderExample/VB/urlbuilderdesigner.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/UrlBuilderExample/VB/urlbuilderdesigner.vb" id="Snippet1"::: + ]]> @@ -85,15 +85,15 @@ Creates a UI to create or pick a URL. The URL returned from the UI. - method to launch a URL builder from a menu command at design time. - + method to launch a URL builder from a menu command at design time. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_WebNet/UrlBuilderExample/CPP/urlbuilderdesigner.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/UrlBuilderExample/CS/urlbuilderdesigner.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/UrlBuilderExample/VB/urlbuilderdesigner.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/UrlBuilderExample/VB/urlbuilderdesigner.vb" id="Snippet1"::: + ]]> @@ -134,13 +134,13 @@ Creates a UI to create or pick a URL, using the specified object. The URL returned from the UI. - @@ -180,11 +180,11 @@ Creates a UI to create or pick a URL, using the specified object. The URL returned from the UI. - interface is used to obtain the implementation for the designer host. - + interface is used to obtain the implementation for the designer host. + ]]> diff --git a/xml/System.Web.UI.Design/ViewEvent.xml b/xml/System.Web.UI.Design/ViewEvent.xml index f340a0ac774..6eb27cfb649 100644 --- a/xml/System.Web.UI.Design/ViewEvent.xml +++ b/xml/System.Web.UI.Design/ViewEvent.xml @@ -28,7 +28,7 @@ - You enter or exit template editing mode for a control. - The class supplies a default delegate to handle the event. Custom control designers override the , , and methods to process those events for the control on the design surface. + The class supplies a default delegate to handle the event. Custom control designers override the , , and methods to process those events for the control on the design surface. The designer host initializes a object for the type of action on the design surface, and then passes the object to the delegate. The property of the object indicates which type of action: @@ -73,7 +73,7 @@ ## Remarks A delegate method compares the property to the static fields to determine which type of action raised the event. A object is equal to to indicate that you clicked a region on the design surface. - The class supplies a default delegate. If the event type is , the delegate calls the method. Classes deriving from the class override the method to handle click events on a region at design time. The event arguments indicate which designer region was clicked, if any. + The class supplies a default delegate. If the event type is , the delegate calls the method. Classes deriving from the class override the method to handle click events on a region at design time. The event arguments indicate which designer region was clicked, if any. ]]> @@ -106,7 +106,7 @@ ## Remarks A delegate method compares the property to the static fields to determine which type of action raised the event. A object is equal to to indicate a paint event on the control on the design surface. - The class supplies a default delegate. If the event type is , the delegate calls the method. Classes deriving from the class override the method to handle click events on a region at design time. + The class supplies a default delegate. If the event type is , the delegate calls the method. Classes deriving from the class override the method to handle click events on a region at design time. ]]> @@ -141,7 +141,7 @@ The class supplies a default delegate. If the event type is , the delegate sets the value for the property. - Custom designers that are derived from the class can override the method to perform additional processing when the template editing mode changes for a control on the design surface. + Custom designers that are derived from the class can override the method to perform additional processing when the template editing mode changes for a control on the design surface. ]]> diff --git a/xml/System.Web.UI.Design/ViewEventArgs.xml b/xml/System.Web.UI.Design/ViewEventArgs.xml index 10a5cde1d06..a1c5356b866 100644 --- a/xml/System.Web.UI.Design/ViewEventArgs.xml +++ b/xml/System.Web.UI.Design/ViewEventArgs.xml @@ -22,7 +22,7 @@ ## Remarks The event is raised by the designer host for certain actions on a control on the design surface. The is handled by a delegate method, which takes a object as a parameter. - The class supplies a default delegate to handle the . Custom control designers override the , , and methods to process those events for the control on the design surface. + The class supplies a default delegate to handle the . Custom control designers override the , , and methods to process those events for the control on the design surface. The designer host initializes a object for the type of action on the design surface, and then passes the object to the delegate. The property represents the control designer region that the event applies to. The property of the object indicates which type of action: @@ -87,7 +87,7 @@ constructor is used by the designer host to initialize a object for the event. The designer host passes the initialized object to the delegate. + The constructor is used by the designer host to initialize a object for the event. The designer host passes the initialized object to the delegate. Typically, `region` is set for events, and `null` (`Nothing` in Visual Basic) for and events. @@ -127,11 +127,11 @@ ## Remarks The property supplies the event arguments that are specific to the type of action that is specified in the property. - For example, when you click a region, the designer host initializes the as a event, and then initializes the property as a object. + For example, when you click a region, the designer host initializes the as a event, and then initializes the property as a object. Similarly, the designer host initializes the property with a object for a event, or a object for a event. - The property is initialized by the constructor. + The property is initialized by the constructor. ]]> @@ -178,7 +178,7 @@ The property supplies the event arguments that are specific to the type of action. - The property is initialized by the constructor. + The property is initialized by the constructor. ]]> @@ -215,7 +215,7 @@ ## Remarks The property represents the control designer region that the event applies to. Typically, the property is set for events, and `null` (`Nothing` in Visual Basic) for and events. - The property is initialized by the constructor. + The property is initialized by the constructor. ]]> diff --git a/xml/System.Web.UI.Design/ViewEventHandler.xml b/xml/System.Web.UI.Design/ViewEventHandler.xml index d5463037afc..dc91846dd36 100644 --- a/xml/System.Web.UI.Design/ViewEventHandler.xml +++ b/xml/System.Web.UI.Design/ViewEventHandler.xml @@ -25,15 +25,15 @@ A object that contains the event data. Represents the method that will handle the event that is raised by visual design tools, such as Visual Studio 2005, implementing the interface. This class cannot be inherited. - delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see [Handling and Raising Events](/dotnet/standard/events/). - - The event is raised by the designer host for certain actions on a control on the design surface. The event is handled by a delegate method, which takes a object as a parameter. - - Typically, control designer classes do not directly implement or assign a delegate. The base class supplies a default delegate for the event. Custom control designers override the , , and methods to process those events for the control on the design surface. The method sets the default event delegate for the delegate. - + delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event-handler delegates, see [Handling and Raising Events](/dotnet/standard/events/). + + The event is raised by the designer host for certain actions on a control on the design surface. The event is handled by a delegate method, which takes a object as a parameter. + + Typically, control designer classes do not directly implement or assign a delegate. The base class supplies a default delegate for the event. Custom control designers override the , , and methods to process those events for the control on the design surface. The method sets the default event delegate for the delegate. + ]]> diff --git a/xml/System.Web.UI.Design/WebControlToolboxItem.xml b/xml/System.Web.UI.Design/WebControlToolboxItem.xml index 6212dc6b45f..d8af10af0be 100644 --- a/xml/System.Web.UI.Design/WebControlToolboxItem.xml +++ b/xml/System.Web.UI.Design/WebControlToolboxItem.xml @@ -24,17 +24,17 @@ Provides a base class for a Web server control . - provides a base class for toolbox items that create Web server controls. This class extends and provides the following additional methods: - -- gets the value of an attribute of the toolbox item. - -- gets the HTML that represents the initial state of the control. - -- gets the type of the associated runtime component. - + provides a base class for toolbox items that create Web server controls. This class extends and provides the following additional methods: + +- gets the value of an attribute of the toolbox item. + +- gets the HTML that represents the initial state of the control. + +- gets the type of the associated runtime component. + ]]> @@ -65,11 +65,11 @@ Initializes a new instance of the class. - is set to a short version of the type name. - + is set to a short version of the type name. + ]]> @@ -95,11 +95,11 @@ The of the tool for this toolbox item. Creates a new instance of the class using the provided type. - is set to a short version of the type name. - + is set to a short version of the type name. + ]]> @@ -153,11 +153,11 @@ Creates objects from each type contained in this , and adds them to the specified designer. An array of created objects. - always throws an exception, indicating that the method is inherited from and only intended for use with Windows Forms. - + always throws an exception, indicating that the method is inherited from and only intended for use with Windows Forms. + ]]> The method is only available in Windows Forms. @@ -218,11 +218,11 @@ Gets the value of the specified type of attribute of the toolbox item. The value of the specified type of attribute. - if the `attributeType` parameter is anything other than a . - + if the `attributeType` parameter is anything other than a . + ]]> The parameter is not a . diff --git a/xml/System.Web.UI.Design/WebFormsReferenceManager.xml b/xml/System.Web.UI.Design/WebFormsReferenceManager.xml index 7e27865dad3..6a9c86dd6c0 100644 --- a/xml/System.Web.UI.Design/WebFormsReferenceManager.xml +++ b/xml/System.Web.UI.Design/WebFormsReferenceManager.xml @@ -26,7 +26,7 @@ - Classes deriving from can use the property to access a implementation supplied by the designer host. The implementation is supplied through the property of property. -- Other designer classes can access the implementation by first obtaining the services implementation through the designer component's , and then calling the method using the designer host property. +- Other designer classes can access the implementation by first obtaining the services implementation through the designer component's , and then calling the method using the designer host property. > [!NOTE] > replaces the obsolete interface . Older designer hosts may only support the interface implementation. Check that the and implementations supplied by the designer host are not `null` to ensure the designer host implements the and classes. @@ -194,7 +194,7 @@ uses the tag prefix and name to locate the user control register directive in the current document, and returns the `src` attribute value defined in the register directive. + uses the tag prefix and name to locate the user control register directive in the current document, and returns the `src` attribute value defined in the register directive. ]]> diff --git a/xml/System.Web.UI.Design/WebFormsRootDesigner.xml b/xml/System.Web.UI.Design/WebFormsRootDesigner.xml index f1d73eab0f0..b8ade395890 100644 --- a/xml/System.Web.UI.Design/WebFormsRootDesigner.xml +++ b/xml/System.Web.UI.Design/WebFormsRootDesigner.xml @@ -178,7 +178,7 @@ property is set by the method. + The property is set by the method. ]]> @@ -214,7 +214,7 @@ method is called by a control designer and provides a way for action items for the control designer to be implemented in the Web Forms page through a design host, such as Visual Studio 2005. + The method is called by a control designer and provides a way for action items for the control designer to be implemented in the Web Forms page through a design host, such as Visual Studio 2005. ]]> @@ -383,7 +383,7 @@ method enables a consistent display of empty controls at design time. + The method enables a consistent display of empty controls at design time. ]]> diff --git a/xml/System.Web.UI.Design/XmlDataFileEditor.xml b/xml/System.Web.UI.Design/XmlDataFileEditor.xml index d0fcb0265cd..667e89b989d 100644 --- a/xml/System.Web.UI.Design/XmlDataFileEditor.xml +++ b/xml/System.Web.UI.Design/XmlDataFileEditor.xml @@ -22,9 +22,9 @@ ## Remarks An object is used at design time to select and edit a URL for an XML data file (.xml), and then assign the URL to a control property. For example, the control uses the class at design time to set the value of the property. - Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method uses the method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The method indicates the display style of the user interface. + Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method uses the method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The method indicates the display style of the user interface. - Derive a class from the to define a custom editor for an XML data property. For example, a derived class can override the method, and then call the method with a custom or value. + Derive a class from the to define a custom editor for an XML data property. For example, a derived class can override the method, and then call the method with a custom or value. @@ -88,7 +88,7 @@ property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. + The property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. ]]> @@ -118,7 +118,7 @@ property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. + The property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. The property default value indicates two URL filters for the dialog box: one for XML data files (*.xml) and another for all files (\*.\*). diff --git a/xml/System.Web.UI.Design/XsdSchemaFileEditor.xml b/xml/System.Web.UI.Design/XsdSchemaFileEditor.xml index 0b99da5a0f5..f94e3cd5e29 100644 --- a/xml/System.Web.UI.Design/XsdSchemaFileEditor.xml +++ b/xml/System.Web.UI.Design/XsdSchemaFileEditor.xml @@ -22,9 +22,9 @@ ## Remarks An object is used at design time to select and edit a URL for an XML schema definition file (.xsd), and to assign the URL to a control property. - Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method uses the method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The method indicates the display style of the user interface. + Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method uses the method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The method indicates the display style of the user interface. - Derive a class from the to define a custom editor for an XML schema URL property. For example, a derived class can override the method, and then call the method with a custom or value. + Derive a class from the to define a custom editor for an XML schema URL property. For example, a derived class can override the method, and then call the method with a custom or value. @@ -89,7 +89,7 @@ property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. + The property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. ]]> @@ -119,7 +119,7 @@ property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. + The property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. The property default value indicates two URL filters for the dialog box: one for XML schema definition files (*.xsd) and another for all files (\*.\*). diff --git a/xml/System.Web.UI.Design/XslTransformFileEditor.xml b/xml/System.Web.UI.Design/XslTransformFileEditor.xml index cc255fde9bc..781424d0bf0 100644 --- a/xml/System.Web.UI.Design/XslTransformFileEditor.xml +++ b/xml/System.Web.UI.Design/XslTransformFileEditor.xml @@ -22,9 +22,9 @@ ## Remarks An object is used at design time to select and edit a URL for a XML transform file (.xsl) and to assign the URL to a control property. For example, the control uses the class at design time to set the value of the property. - Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method uses the method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The method indicates the display style of the user interface. + Use the attribute to associate the with a property. When the associated property is edited on the design surface, the designer host calls the method. The method uses the method, which in turn displays a user interface for selecting the URL, and then returns the URL that is selected by the user. The method indicates the display style of the user interface. - Derive a class from the to define a custom editor for an XML transform file URL property. For example, a derived class can override the method, and then call the method with a custom or value. + Derive a class from the to define a custom editor for an XML transform file URL property. For example, a derived class can override the method, and then call the method with a custom or value. @@ -88,7 +88,7 @@ property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. + The property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. ]]> @@ -118,7 +118,7 @@ property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. + The property is used by the method when calling the method, which displays the URL selection dialog box to the user at design time. The property default value indicates two URL filters for the dialog box: one for XML transform files (*.xsl) and another for all files (\*.\*). diff --git a/xml/System.Web.UI.HtmlControls/HtmlAnchor.xml b/xml/System.Web.UI.HtmlControls/HtmlAnchor.xml index 6f87ae57b2b..ad20ad54d97 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlAnchor.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlAnchor.xml @@ -40,7 +40,7 @@ > [!CAUTION] > This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. ASP.NET provides an input request validation feature to block script and HTML in user input. Validation server controls are also provided to assess user input. For more information, see [Validation Server Control Syntax](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/e5a8xz39(v=vs.100)). - For a list of initial property values for an instance of , see the constructor. + For a list of initial property values for an instance of , see the constructor. @@ -81,7 +81,7 @@ |Property|Initial Value| |--------------|-------------------| -||The "a" literal string.| +||The "a" literal string.| @@ -268,7 +268,7 @@ method so that it always displays a tag in a custom server control. + The following code example demonstrates how to override the method so that it always displays a tag in a custom server control. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomHtmlAnchorOnPreRender/CS/custom_htmlanchor_onprerendercs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomHtmlAnchorOnPreRender/VB/custom_htmlanchor_onprerendervb.aspx" id="Snippet1"::: @@ -311,7 +311,7 @@ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. @@ -361,7 +361,7 @@ method is used by the control, when it is clicked, to raise a event. + The method is used by the control, when it is clicked, to raise a event. This method is used primarily by control developers extending the functionality of the control. @@ -396,12 +396,12 @@ property is a malformed URL, the method throws an exception. + If the value of the property is a malformed URL, the method throws an exception. ## Examples - The following code example demonstrates how to override the method in a custom server control so that specific title text, accessible as a ToolTip, is always displayed for the control. + The following code example demonstrates how to override the method in a custom server control so that specific title text, accessible as a ToolTip, is always displayed for the control. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomHtmlAnchorRenderAttributes/CS/custom_htmlanchor_renderattributescs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomHtmlAnchorRenderAttributes/VB/custom_htmlanchor_renderattributesvb.aspx" id="Snippet1"::: @@ -497,7 +497,7 @@ method calls the method. + The method calls the method. This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. @@ -548,7 +548,7 @@ > > When creating accessible Web pages, avoid using the property to target another window. For more information, see [ASP.NET Accessibility](https://learn.microsoft.com/previous-versions/aspnet/ms228011(v=vs.100)). - The value must begin with a letter in the range of A to Z (case-insensitive), except for the following special values, which begin with an underscore. + The value must begin with a letter in the range of A to Z (case-insensitive), except for the following special values, which begin with an underscore. |Target value|Description| |------------------|-----------------| diff --git a/xml/System.Web.UI.HtmlControls/HtmlButton.xml b/xml/System.Web.UI.HtmlControls/HtmlButton.xml index 6b1d58919a9..62488d4dd4d 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlButton.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlButton.xml @@ -45,7 +45,7 @@ > [!NOTE] > The control renders ECMAScript to the client browser. The client browser must have ECMAScript enabled for this control to function properly. For more information on client script, see [Client Script in ASP.NET Web Pages](https://learn.microsoft.com/previous-versions/aspnet/3hc29e2a(v=vs.100)). - For a list of initial property values for an instance of , see the constructor. + For a list of initial property values for an instance of , see the constructor. > [!CAUTION] > This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. ASP.NET provides an input request validation feature to block script and HTML in user input. Validation server controls are also provided to assess user input. For more information, see [Validation Server Control Syntax](https://msdn.microsoft.com/library/96d2c59e-693c-4079-9b53-b3ff0d9e9133). @@ -91,7 +91,7 @@ |Property|Initial value| |--------------|-------------------| -||The "button" literal string.| +||The "button" literal string.| @@ -148,7 +148,7 @@ ## Examples - The following code example demonstrates how to use the property to prevent page validation from occurring. Note that the method activates each validation control independently. + The following code example demonstrates how to use the property to prevent page validation from occurring. Note that the method activates each validation control independently. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/HtmlButtonCausesValidation/CS/htmlbuttoncausesvalidationcs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/HtmlButtonCausesValidation/VB/htmlbuttoncausesvalidationvb.aspx" id="Snippet1"::: @@ -190,12 +190,12 @@ method is used primarily by control developers extending the functionality of the control. + The method is used primarily by control developers extending the functionality of the control. ## Examples - The following code example demonstrates how to override the method in a custom server control so that it always displays the with bold text. + The following code example demonstrates how to override the method in a custom server control so that it always displays the with bold text. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomHtmlButtonOnPreRender/CS/custom_htmlbutton_onprerendercs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomHtmlButtonOnPreRender/VB/custom_htmlbutton_onprerendervb.aspx" id="Snippet1"::: @@ -238,7 +238,7 @@ Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. @@ -287,9 +287,9 @@ method is used by the control, when it is clicked, to raise a event. + The method is used by the control, when it is clicked, to raise a event. - If the property is `true`, the method is called using the group of controls specified in the property. + If the property is `true`, the method is called using the group of controls specified in the property. This method is used primarily by control developers extending the functionality of the control. @@ -326,14 +326,14 @@ method writes the `onclick` attribute of the rendered control, and then calls the base method. + The method writes the `onclick` attribute of the rendered control, and then calls the base method. - The method is used primarily by control developers extending the functionality of the control. + The method is used primarily by control developers extending the functionality of the control. ## Examples - The following code example demonstrates how to override the method in a custom server control so that a title is always displayed for the control. + The following code example demonstrates how to override the method in a custom server control so that a title is always displayed for the control. :::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/CustomHtmlButtonRenderAttributes/CS/custom_htmlbutton_renderattributescs.aspx" id="Snippet1"::: :::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/CustomHtmlButtonRenderAttributes/VB/custom_htmlbutton_renderattributesvb.aspx" id="Snippet1"::: diff --git a/xml/System.Web.UI.HtmlControls/HtmlContainerControl.xml b/xml/System.Web.UI.HtmlControls/HtmlContainerControl.xml index abb0d03e2d7..e30fcdcf753 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlContainerControl.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlContainerControl.xml @@ -23,9 +23,9 @@ ## Remarks The most common controls with a closing tag are the `
`, ``, ``, `
`, ``, and `` elements. - The and properties allow you to manipulate the content between the opening and closing tags of -derived controls. + The and properties allow you to manipulate the content between the opening and closing tags of -derived controls. - For a list of initial property values for an instance of , see the constructor. + For a list of initial property values for an instance of , see the constructor. A new instance of this class is not created directly. @@ -93,7 +93,7 @@ |Property|Initial Value| |--------------|-------------------| -||The "span" literal string.| +||The "span" literal string.| ]]> @@ -138,7 +138,7 @@ |Property|Initial Value| |--------------|-------------------| -||The value specified by the `tag` parameter.| +||The value specified by the `tag` parameter.| ]]> @@ -330,7 +330,7 @@ ## Remarks This method is used primarily by the .NET Framework infrastructure and is not intended to be used directly from your code. However, control developers can override this method to specify how a custom server control restores its view state. For more information, see [ASP.NET State Management Overview](https://learn.microsoft.com/previous-versions/aspnet/75x4ha6s(v=vs.100)). - The method calls the base class's method. In addition, the method sets the property. + The method calls the base class's method. In addition, the method sets the property. ]]> @@ -370,9 +370,9 @@ method overrides the method to render the opening tag, child controls, and closing tag of the control. + The method overrides the method to render the opening tag, child controls, and closing tag of the control. - The method is used primarily by control developers extending the functionality of the control. + The method is used primarily by control developers extending the functionality of the control. ]]> @@ -437,9 +437,9 @@ method is called by the method to render the closing tag of the control. + The method is called by the method to render the closing tag of the control. - The method is used primarily by control developers extending the functionality of the control. + The method is used primarily by control developers extending the functionality of the control. ]]> diff --git a/xml/System.Web.UI.HtmlControls/HtmlControl.xml b/xml/System.Web.UI.HtmlControls/HtmlControl.xml index f2ddbe70239..365745cde1b 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlControl.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlControl.xml @@ -97,7 +97,7 @@ |Property|Initial Value| |--------------|-------------------| -||The "span" literal string.| +||The "span" literal string.| ]]> @@ -146,7 +146,7 @@ |Property|Initial Value| |--------------|-------------------| -||The value of the `tag` parameter.| +||The value of the `tag` parameter.| ]]> @@ -317,7 +317,7 @@ method to access an attribute on the server control. All HTML server controls store their attributes in the property. HTML attributes are treated by the ASP.NET page framework as properties on the HTML server control to which they belong. The method's `name` parameter is case-insensitive. + Use the method to access an attribute on the server control. All HTML server controls store their attributes in the property. HTML attributes are treated by the ASP.NET page framework as properties on the HTML server control to which they belong. The method's `name` parameter is case-insensitive. ]]> @@ -362,7 +362,7 @@ method calls the method and passes the specified control. + The method calls the method and passes the specified control. ]]> @@ -396,9 +396,9 @@ method writes the attribute of the control. + The method writes the attribute of the control. - The method is used primarily by control developers extending the functionality of the control. + The method is used primarily by control developers extending the functionality of the control. ]]> @@ -432,9 +432,9 @@ method renders the opening angle bracket (\<), followed by the control's tag name, attributes, and a closing angle bracket (>). + The method renders the opening angle bracket (\<), followed by the control's tag name, attributes, and a closing angle bracket (>). - The method is used primarily by control developers extending the functionality of the control. + The method is used primarily by control developers extending the functionality of the control. ]]> @@ -472,9 +472,9 @@ method to set an attribute on the server control. All HTML server controls store their attributes in the property. + Use the method to set an attribute on the server control. All HTML server controls store their attributes in the property. - HTML attributes are treated by the ASP.NET page framework as properties on the HTML server control to which they belong. The method's `name` parameter is case-insensitive. + HTML attributes are treated by the ASP.NET page framework as properties on the HTML server control to which they belong. The method's `name` parameter is case-insensitive. ]]> @@ -571,7 +571,7 @@ method calls the method. + The method calls the method. This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. @@ -619,7 +619,7 @@ method calls the method. + The method calls the method. This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. diff --git a/xml/System.Web.UI.HtmlControls/HtmlEmptyTagControlBuilder.xml b/xml/System.Web.UI.HtmlControls/HtmlEmptyTagControlBuilder.xml index ce6b683fa07..2aa97db4550 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlEmptyTagControlBuilder.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlEmptyTagControlBuilder.xml @@ -55,7 +55,7 @@ method is used internally by the ASP.NET page framework and is not intended to be called from your code. + The method is used internally by the ASP.NET page framework and is not intended to be called from your code. ]]> @@ -86,7 +86,7 @@ method overrides the base class's method to always return `false`, because the class represents controls that do not have closing tags. The method of the class determines whether a control has both an opening and a closing tag. + The method overrides the base class's method to always return `false`, because the class represents controls that do not have closing tags. The method of the class determines whether a control has both an opening and a closing tag. ]]> diff --git a/xml/System.Web.UI.HtmlControls/HtmlForm.xml b/xml/System.Web.UI.HtmlControls/HtmlForm.xml index dc09162faa6..43284c485a0 100644 --- a/xml/System.Web.UI.HtmlControls/HtmlForm.xml +++ b/xml/System.Web.UI.HtmlControls/HtmlForm.xml @@ -33,7 +33,7 @@ You can configure controls that implement the interface to post to a different target page. This is referred to as cross-page posting. For more information, see [Cross-Page Posting in ASP.NET Web Forms](https://learn.microsoft.com/previous-versions/aspnet/ms178139(v=vs.100)). - For a list of initial property values for an instance of , see the constructor. + For a list of initial property values for an instance of , see the constructor. @@ -77,7 +77,7 @@ |Property|Initial Value| |--------------|-------------------| -||The "form" literal string.| +||The "form" literal string.| @@ -154,7 +154,7 @@ value for each control on a page. For more information, see the property. + To prevent naming conflicts when multiple instances of a control are rendered, ASP.NET automatically generates a unique value for each control on a page. For more information, see the property. ]]> @@ -285,7 +285,7 @@ ## Remarks Use the property to access the control on the form to display as the control with input focus when the control is loaded. Controls that can be selected are displayed with a visual cue indicating that they have the focus. For example, a control with focus is displayed with the insertion point positioned inside of it. - The control with focus can also be set using the or methods. These methods have precedence over the property. If either of these methods are called to set the control with focus, the value of the property is ignored. + The control with focus can also be set using the or methods. These methods have precedence over the property. If either of these methods are called to set the control with focus, the value of the property is ignored. @@ -490,13 +490,13 @@ method, Web server controls must perform any initialization steps that are required to create and set up an instance. In this stage of the server control's life cycle, the control's view state has yet to be populated. Additionally, you cannot access other server controls when this method is called, regardless of whether it is a child or parent to this control. Other server controls are not guaranteed to be created and ready for access. + When notified by the method, Web server controls must perform any initialization steps that are required to create and set up an instance. In this stage of the server control's life cycle, the control's view state has yet to be populated. Additionally, you cannot access other server controls when this method is called, regardless of whether it is a child or parent to this control. Other server controls are not guaranteed to be created and ready for access. Raising an event invokes the event handler through a delegate. For more information, see [Handling and Raising Events](/dotnet/standard/events/). - The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. + The method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class. - The method is used primarily by control developers extending the functionality of the control. + The method is used primarily by control developers extending the functionality of the control. ]]> @@ -532,7 +532,7 @@ method is called just prior to rendering the control. If the property is set to `true`, the method registers the smart navigation script file reference so that it gets rendered. + The method is called just prior to rendering the control. If the property is set to `true`, the method registers the smart navigation script file reference so that it gets rendered. > [!NOTE] > The property has been deprecated in ASP.NET version 2.0. @@ -573,9 +573,9 @@ method renders an HTML `