-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
PartialCachingControl.xml
70 lines (65 loc) · 4.7 KB
/
PartialCachingControl.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<Type Name="PartialCachingControl" FullName="System.Web.UI.PartialCachingControl">
<TypeSignature Language="C#" Value="public class PartialCachingControl : System.Web.UI.BasePartialCachingControl" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PartialCachingControl extends System.Web.UI.BasePartialCachingControl" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.PartialCachingControl" />
<TypeSignature Language="VB.NET" Value="Public Class PartialCachingControl
Inherits BasePartialCachingControl" />
<TypeSignature Language="F#" Value="type PartialCachingControl = class
 inherit BasePartialCachingControl" />
<TypeSignature Language="C++ CLI" Value="public ref class PartialCachingControl : System::Web::UI::BasePartialCachingControl" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.BasePartialCachingControl</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Created when a user control (.ascx file) is specified for output caching, using either the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)) page directive or the <see cref="T:System.Web.UI.PartialCachingAttribute" /> attribute, and the user control is inserted into a page's control hierarchy by dynamically loading the user control with the <see cref="M:System.Web.UI.TemplateControl.LoadControl(System.String)" /> method.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Page and control developers cannot use the <xref:System.Web.UI.PartialCachingControl> class directly. ASP.NET creates an instance of the <xref:System.Web.UI.PartialCachingControl> class to wrap a user control (.ascx file) when a dynamically loaded user control enables output caching. You can enable output caching for a user control using either the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)) page directive or the <xref:System.Web.UI.PartialCachingAttribute> attribute.
You add a user control to a page programmatically by calling the <xref:System.Web.UI.TemplateControl.LoadControl%2A?displayProperty=nameWithType> method.
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/h30h475z(v=vs.100)">Caching Portions of an ASP.NET Page</related>
</Docs>
<Members>
<Member MemberName="CachedControl">
<MemberSignature Language="C#" Value="public System.Web.UI.Control CachedControl { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.UI.Control CachedControl" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.PartialCachingControl.CachedControl" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CachedControl As Control" />
<MemberSignature Language="F#" Value="member this.CachedControl : System.Web.UI.Control" Usage="System.Web.UI.PartialCachingControl.CachedControl" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::UI::Control ^ CachedControl { System::Web::UI::Control ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.UI.Control</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a reference to the user control that is cached.</summary>
<value>The user control that is cached.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property returns the user control only when its output is not cached. If the user control output exists in the output cache, this property returns `null`, because an instance of the control is never created.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>