This topic has not yet been rated - Rate this topic

WebPart.RequiresWebPartClientScript Method

SharePoint 2010

Windows SharePoint Services 3

Indicates whether this Web Part has client-side script to register with the Web Part Page Services Component (WPSC) framework.

Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

Copy

protected internal virtual bool RequiresWebPartClientScript()

Return Value

Type: System.Boolean
true, indicating that the Web Part does have client-side script to register.

Remarks

In the base class, this method always returns true. (In fact, that is all it does.) If your Web Part does not require client-side WPSC script support, you should override the RequiresWebPartClientScript method and return false.

Examples

This example shows how a Web Part that does not need client-side script support should advertise that fact.

Copy

protected override bool RequiresWebPartClientScript()
{
    // return base.RequiresWebPartClientScript();
    return false;
}

Reference

WebPart Class

WebPart Members

Microsoft.SharePoint.WebPartPages Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ