Skip to content

Add missing text - System.Web #8112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 28, 2022
Merged

Add missing text - System.Web #8112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b1519f5
add missing text
gewarren May 28, 2022
3f0499c
fix xref
gewarren May 28, 2022
00eb7bf
fix error
gewarren May 28, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 6 additions & 36 deletions xml/System.Web.ApplicationServices/ProfilePropertyMetadata.xml
View file
Open in desktop
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -37,9 +37,7 @@
## Remarks ## Remarks
You use the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> class to retrieve information about a profile property when you access profiles through the <xref:System.Web.ApplicationServices.ProfileService> 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. You use the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> class to retrieve information about a profile property when you access profiles through the <xref:System.Web.ApplicationServices.ProfileService> 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 <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> object from an application that is compatible with the Windows Communication Framework (WCF), use the <xref:System.Web.ApplicationServices.ProfileService.GetPropertiesMetadata%2A> method of the <xref:System.Web.ApplicationServices.ProfileService> class. The user does not have to be logged on to retrieve the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> object because the metadata for profile properties is not specific to a user's profile property values. To access the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> object from an application that's compatible with Windows Communication Framework (WCF), use the <xref:System.Web.ApplicationServices.ProfileService.GetPropertiesMetadata%2A> method of the <xref:System.Web.ApplicationServices.ProfileService> class. The user does not have to be logged on to retrieve the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> object because the metadata for profile properties is not specific to a user's profile property values.

The values in the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata> class are set in the Web.config file in the element of the section when the property is defined.


]]></format> ]]></format>
</remarks> </remarks>
Expand Down Expand Up @@ -107,7 +105,7 @@
<format type="text/markdown"><![CDATA[ <format type="text/markdown"><![CDATA[


## Remarks ## Remarks
When you enable anonymous identification with settings in the element, you can set which profile properties are available to anonymous users. You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.AllowAnonymousAccess%2A> property in the element of the section of the Web.config file when the property is defined. From the client application, use the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.AllowAnonymousAccess%2A> property to determine whether a profile property can be set for an anonymous user. When you enable anonymous identification, you can set which profile properties are available to anonymous users. From the client application, use the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.AllowAnonymousAccess%2A> property to determine whether a profile property can be set for an anonymous user.


]]></format> ]]></format>
</remarks> </remarks>
Expand Down Expand Up @@ -225,14 +223,7 @@
<summary>Gets or sets a value that indicates whether a profile property is read-only.</summary> <summary>Gets or sets a value that indicates whether a profile property is read-only.</summary>
<value> <value>
<see langword="true" /> if the profile property is read-only; otherwise, <see langword="false" />.</value> <see langword="true" /> if the profile property is read-only; otherwise, <see langword="false" />.</value>
<remarks> <remarks>To be added.</remarks>
<format type="text/markdown"><![CDATA[

## Remarks
You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.IsReadOnly%2A> property in the element of the section of the Web.config file when the property is defined.

]]></format>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PropertyName"> <Member MemberName="PropertyName">
Expand Down Expand Up @@ -268,14 +259,7 @@
<Docs> <Docs>
<summary>Gets or sets the name of the profile property.</summary> <summary>Gets or sets the name of the profile property.</summary>
<value>The name of the profile property as defined in the Web.config file.</value> <value>The name of the profile property as defined in the Web.config file.</value>
<remarks> <remarks>To be added.</remarks>
<format type="text/markdown"><![CDATA[

## Remarks
You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.PropertyName%2A> property in the element of the section of the Web.config file when the property is defined.

]]></format>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="SerializeAs"> <Member MemberName="SerializeAs">
Expand Down Expand Up @@ -311,14 +295,7 @@
<Docs> <Docs>
<summary>Gets or sets a value that indicates how to serialize the property value.</summary> <summary>Gets or sets a value that indicates how to serialize the property value.</summary>
<value>The enumeration value.</value> <value>The enumeration value.</value>
<remarks> <remarks>To be added.</remarks>
<format type="text/markdown"><![CDATA[

## Remarks
You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.SerializeAs%2A> property in the element of the section of the Web.config file when the property is defined.

]]></format>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TypeName"> <Member MemberName="TypeName">
Expand Down Expand Up @@ -354,14 +331,7 @@
<Docs> <Docs>
<summary>Gets or sets the assembly-qualified name of the profile property type.</summary> <summary>Gets or sets the assembly-qualified name of the profile property type.</summary>
<value>The assembly-qualified name of the profile property type.</value> <value>The assembly-qualified name of the profile property type.</value>
<remarks> <remarks>To be added.</remarks>
<format type="text/markdown"><![CDATA[

## Remarks
You set the <xref:System.Web.ApplicationServices.ProfilePropertyMetadata.TypeName%2A> property in the element of the section of the Web.config file when the property is defined.

]]></format>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>
Expand Down
Empty file modified xml/System.Web.Caching/OutputCacheUtility.xml
View file
Open in desktop
Whitespace-only changes.
10 changes: 5 additions & 5 deletions xml/System.Web.Caching/SqlCacheDependency.xml
View file
Open in desktop
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@


The <xref:System.Web.Caching.SqlCacheDependency> class also supports integration with the <xref:System.Data.SqlClient.SqlDependency?displayProperty=nameWithType> class when using a SQL Server 2005 database. The query notification mechanism of SQL Server 2005 detects changes to data that invalidate the results of an SQL query and removes any cached items associated with the SQL query from the <xref:System.Web.Caching.Cache?displayProperty=nameWithType>. The <xref:System.Web.Caching.SqlCacheDependency> class also supports integration with the <xref:System.Data.SqlClient.SqlDependency?displayProperty=nameWithType> class when using a SQL Server 2005 database. The query notification mechanism of SQL Server 2005 detects changes to data that invalidate the results of an SQL query and removes any cached items associated with the SQL query from the <xref:System.Web.Caching.Cache?displayProperty=nameWithType>.


You can use the <xref:System.Web.Caching.SqlCacheDependency> class to add items to your application's <xref:System.Web.Caching.Cache> that are dependent on either a SQL Server database table or on an SQL query when using SQL Server 2005. You can also use this class with the directive to make an output-cached page or a user control dependent on a SQL Server database table. Finally, you can use the <xref:System.Web.Caching.SqlCacheDependency> class with the page directive to make an output-cached page dependent on the results of an SQL query when using SQL Server 2005. Query notification using SQL Server 2005 is not supported on the directive for user controls. You can use the <xref:System.Web.Caching.SqlCacheDependency> class to add items to your application's <xref:System.Web.Caching.Cache> that are dependent on either a SQL Server database table or on an SQL query when using SQL Server 2005. You can also use this class with the `@ OutputCache` directive to make an output-cached page or a user control dependent on a SQL Server database table. Finally, you can use the <xref:System.Web.Caching.SqlCacheDependency> class with the `@ OutputCache` page directive to make an output-cached page dependent on the results of an SQL query when using SQL Server 2005. Query notification using SQL Server 2005 is not supported on the `@ OutputCache` directive for user controls.


> [!NOTE] > [!NOTE]
> For this class to work correctly when using table-based notifications, the database and any tables that you want to make dependencies on must have notifications enabled. You can enable notifications by calling methods of the <xref:System.Web.Caching.SqlCacheDependencyAdmin> class or by using the command-line tool. In addition, the proper configuration settings must be included in the application's Web.config file. > For this class to work correctly when using table-based notifications, the database and any tables that you want to make dependencies on must have notifications enabled. You can enable notifications by calling methods of the <xref:System.Web.Caching.SqlCacheDependencyAdmin> class or by using the `aspnet_regsql.exe` command-line tool. In addition, the proper configuration settings must be included in the application's Web.config file.
> >
> Using a <xref:System.Web.Caching.SqlCacheDependency> object with SQL Server 2005 query notification does not require any explicit configuration. Consult the SQL Server 2005 Books Online for information about restrictions on the types of Transact-SQL queries that are allowed when using query notification. > Using a <xref:System.Web.Caching.SqlCacheDependency> object with SQL Server 2005 query notification does not require any explicit configuration. Consult the SQL Server documentation for information about restrictions on the types of Transact-SQL queries that are allowed when using query notification.


The following example shows an ASP.NET Web.config file that enables table-based dependencies on a SQL Server database table. The following example shows an ASP.NET Web.config file that enables table-based dependencies on a SQL Server database table.


Expand Down Expand Up @@ -114,7 +114,7 @@
]]></format> ]]></format>
</remarks> </remarks>
<exception cref="T:System.ArgumentNullException">The <paramref name="sqlCmd" /> parameter is <see langword="null" />.</exception> <exception cref="T:System.ArgumentNullException">The <paramref name="sqlCmd" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.Web.HttpException">The <see cref="T:System.Data.SqlClient.SqlCommand" /> instance has its <see cref="P:System.Data.SqlClient.SqlCommand.NotificationAutoEnlist" /> property set to <see langword="true" /> and there is an directive on the page with the <see langword="SqlDependency" /> attribute set to <c>CommandNotification</c>.</exception> <exception cref="T:System.Web.HttpException">The <see cref="T:System.Data.SqlClient.SqlCommand" /> instance has its <see cref="P:System.Data.SqlClient.SqlCommand.NotificationAutoEnlist" /> property set to <see langword="true" /> and there is an `@ OutputCache` directive on the page with the <see langword="SqlDependency" /> attribute set to <c>CommandNotification</c>.</exception>
<altmember cref="M:System.Web.Caching.SqlCacheDependency.#ctor(System.String,System.String)" /> <altmember cref="M:System.Web.Caching.SqlCacheDependency.#ctor(System.String,System.String)" />
</Docs> </Docs>
</Member> </Member>
Expand Down Expand Up @@ -167,7 +167,7 @@
</configuration> </configuration>
``` ```


Two exceptions are commonly thrown when this constructor is used: <xref:System.Web.Caching.DatabaseNotEnabledForNotificationException> and <xref:System.Web.Caching.TableNotEnabledForNotificationException>. If a <xref:System.Web.Caching.DatabaseNotEnabledForNotificationException> is thrown, you can call the <xref:System.Web.Caching.SqlCacheDependencyAdmin.EnableNotifications%2A?displayProperty=nameWithType> method in exception-handling code, or use the command-line tool to set up the database for notifications. If a <xref:System.Web.Caching.TableNotEnabledForNotificationException> is thrown, you can call the <xref:System.Web.Caching.SqlCacheDependencyAdmin.EnableTableForNotifications%2A?displayProperty=nameWithType> method or use to set up the table for notifications. Two exceptions are commonly thrown when this constructor is used: <xref:System.Web.Caching.DatabaseNotEnabledForNotificationException> and <xref:System.Web.Caching.TableNotEnabledForNotificationException>. If a <xref:System.Web.Caching.DatabaseNotEnabledForNotificationException> is thrown, you can call the <xref:System.Web.Caching.SqlCacheDependencyAdmin.EnableNotifications%2A?displayProperty=nameWithType> method in exception-handling code, or use the `aspnet_regsql.exe` command-line tool to set up the database for notifications. If a <xref:System.Web.Caching.TableNotEnabledForNotificationException> is thrown, you can call the <xref:System.Web.Caching.SqlCacheDependencyAdmin.EnableTableForNotifications%2A?displayProperty=nameWithType> method or use `aspnet_regsql.exe` to set up the table for notifications.






Expand Down
8 changes: 4 additions & 4 deletions xml/System.Web.Compilation/BuildProvider.xml
View file
Open in desktop
Original file line number Original file line Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@


To define custom build actions for a file type within an ASP.NET application, you must derive a class from <xref:System.Web.Compilation.BuildProvider>, implement members within the derived class for building the file type, and configure the build provider for the corresponding file extension within the application configuration file. To define custom build actions for a file type within an ASP.NET application, you must derive a class from <xref:System.Web.Compilation.BuildProvider>, implement members within the derived class for building the file type, and configure the build provider for the corresponding file extension within the application configuration file.


The specifies the file extension for supported files, and whether the build provider supports code files, Web files, resource files or all files. Use the `type` attribute to specify the fully qualified type name of the build provider implementation. Use the <xref:System.Web.Compilation.BuildProviderAppliesToAttribute> 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 <xref:System.Web.Compilation.BuildProvider> class supports. Use the <xref:System.Web.Configuration.BuildProviderCollection> class to examine build providers in a configuration file. For more information about configuring a build provider, see [buildProviders Element for compilation (ASP.NET Settings Schema)](https://msdn.microsoft.com/library/40fa889d-5412-487a-b6a9-21eb011c2384). The `add` element specifies the file extension for supported files, and whether the build provider supports code files, Web files, resource files, or all files. Use the `type` attribute to specify the fully qualified type name of the build provider implementation. Use the <xref:System.Web.Compilation.BuildProviderAppliesToAttribute> 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 <xref:System.Web.Compilation.BuildProvider> class supports. Use the <xref:System.Web.Configuration.BuildProviderCollection> 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 <xref:System.Web.Compilation.BuildProvider>, and override the <xref:System.Web.Compilation.BuildProvider.GenerateCode%2A> method to generate source code for the supported file type. The generated source is added to the <xref:System.Web.Compilation.AssemblyBuilder> 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 <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property to return a <xref:System.Web.Compilation.CompilerType> object for the supported programming language. If the build provider does not require a specific programming language, do not override the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> 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 <xref:System.Web.Compilation.BuildProvider>, and override the <xref:System.Web.Compilation.BuildProvider.GenerateCode%2A> method to generate source code for the supported file type. The generated source is added to the <xref:System.Web.Compilation.AssemblyBuilder> 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 <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property to return a <xref:System.Web.Compilation.CompilerType> object for the supported programming language. If the build provider does not require a specific programming language, do not override the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property; use the base class implementation, which indicates that the build provider can use any .NET Framework language, such as Visual Basic or C#.


Expand Down Expand Up @@ -276,7 +276,7 @@
## Remarks ## Remarks
Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> method to examine the default compiler type for a build provider. Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> method to examine the compiler type configured in a build provider for a specific language name. Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> method to examine the default compiler type for a build provider. Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> method to examine the compiler type configured in a build provider for a specific language name.


The base <xref:System.Web.Compilation.BuildProvider> class determines the default compiler type using the `defaultLanguage` attribute value in the section of the application configuration file. If there is no default language setting in the compilation section, the default compiler type is set using the <xref:Microsoft.VisualBasic.VBCodeProvider> language provider. The base <xref:System.Web.Compilation.BuildProvider> 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 <xref:Microsoft.VisualBasic.VBCodeProvider> language provider.


When deriving from the <xref:System.Web.Compilation.BuildProvider> class, you can use <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> to set the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property within your implementation. When deriving from the <xref:System.Web.Compilation.BuildProvider> class, you can use <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> to set the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property within your implementation.


Expand Down Expand Up @@ -315,7 +315,7 @@
## Remarks ## Remarks
Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> method to examine the compiler type configured in the build provider for a specific language name. Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> method to examine the default compiler type for a build provider. Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> method to examine the compiler type configured in the build provider for a specific language name. Use the <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerType%2A> method to examine the default compiler type for a build provider.


The base <xref:System.Web.Compilation.BuildProvider> class determines the default compiler type using the <xref:System.Web.Configuration.Compiler> elements in the <xref:System.Web.Configuration.CompilationSection.Compilers%2A> property of the <xref:System.Web.Configuration.CompilationSection> object for the configuration file. This is equivalent to examining the elements in the and the elements in the sections of the configuration file. For example, for the `language` value VB, the base class method returns a <xref:System.Web.Compilation.CompilerType> object that corresponds to the configured settings for an instance of <xref:Microsoft.VisualBasic.VBCodeProvider?displayProperty=nameWithType>. The base <xref:System.Web.Compilation.BuildProvider> class determines the default compiler type using the <xref:System.Web.Configuration.Compiler> elements in the <xref:System.Web.Configuration.CompilationSection.Compilers%2A> property of the <xref:System.Web.Configuration.CompilationSection> 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 <xref:System.Web.Compilation.CompilerType> object that corresponds to the configured settings for an instance of <xref:Microsoft.VisualBasic.VBCodeProvider?displayProperty=nameWithType>.


When you derive from the <xref:System.Web.Compilation.BuildProvider> class, you can use <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> to set the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property value for the language supported by your implementation. When you derive from the <xref:System.Web.Compilation.BuildProvider> class, you can use <xref:System.Web.Compilation.BuildProvider.GetDefaultCompilerTypeForLanguage%2A> to set the <xref:System.Web.Compilation.BuildProvider.CodeCompilerType%2A> property value for the language supported by your implementation.


Expand Down Expand Up @@ -626,7 +626,7 @@
<format type="text/markdown"><![CDATA[ <format type="text/markdown"><![CDATA[


## Remarks ## 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 element in the configuration file. 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 <xref:System.Web.Compilation.AssemblyBuilder.AddAssemblyReference%2A> 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 <xref:System.Web.Compilation.AssemblyBuilder.AddAssemblyReference%2A> 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.


Expand Down
Loading