CacheableWebPart.RenderCachedOutput Method
This member is reserved for internal use and is not intended to be used directly from your code.Creates a data stream.
Namespace: Microsoft.SharePoint.Portal.WebControls
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Syntax
'Declaration
Public Function RenderCachedOutput ( _
ByRef output As HtmlTextWriter _
) As Boolean
'Usage
Dim instance As CacheableWebPart
Dim output As HtmlTextWriter
Dim returnValue As Boolean
returnValue = instance.RenderCachedOutput(output)
public bool RenderCachedOutput(
ref HtmlTextWriter output
)
Parameters
- output
Type: System.Web.UI.HtmlTextWriter
A data stream
Return Value
Type: System.Boolean
true if the RenderCachedOutput method successfully retrieves an HTML fragment from the cache and writes it to the output stream; otherwise, false.
If RenderCachedOutput returns true, your RenderWebPart method does not need to render any HTML. If RenderCachedOutput returns false, your RenderWebPart method needs to continue to execute and run the code that renders the actual HTML output and then call the StoreCachedOutput(System.Web.UI.HtmlTextWriter) method to save the HTML fragment in the cache.
Remarks
Data cannot be changed for the period of time set by the CacheTimeout property.