IRuntimeFilter.CheckRuntimeRender method

NOTE: This API is now obsolete.

Indicates whether the Web Part will be rendered on the page.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name := "FullTrust")> _
<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")> _
<ObsoleteAttribute("Use IRuntimeFilter2 instead.")> _
Function CheckRuntimeRender ( _
    IsIncludedFilter As String _
) As Boolean
'Usage
Dim instance As IRuntimeFilter
Dim IsIncludedFilter As String
Dim returnValue As Boolean

returnValue = instance.CheckRuntimeRender(IsIncludedFilter)
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[ObsoleteAttribute("Use IRuntimeFilter2 instead.")]
bool CheckRuntimeRender(
    string IsIncludedFilter
)

Parameters

  • IsIncludedFilter
    Type: System.String

    Stores the parameters used by the IRuntimeFilter interface to determine whether the Web Part will be included on the page.

Return value

Type: System.Boolean
A Boolean value that indicates whether the Web Part will be rendered. true if the Web Part will be included on the page; otherwise, false.

Remarks

The CheckRuntimeRender method is only valid when called in personalization mode. It will not be called when in customization mode. Also, the CheckRuntimeRender method is only called for Global Web Parts. Global Web Parts are Web Parts that were created in customization mode where the user hasn't personalized the Web Part.

See also

Reference

IRuntimeFilter interface

IRuntimeFilter members

Microsoft.SharePoint.WebPartPages namespace