FilterWebPartVerbs Method

WebPartChrome.FilterWebPartVerbs Method (WebPartVerbCollection, WebPart)

 

Excludes specific verbs from being rendered, based on criteria provided by a developer.

Namespace:   System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

protected virtual WebPartVerbCollection FilterWebPartVerbs(
	WebPartVerbCollection verbs,
	WebPart webPart
)

Parameters

verbs
Type: System.Web.UI.WebControls.WebParts.WebPartVerbCollection

The collection of all verbs associated with the control referenced in the webPart parameter.

webPart
Type: System.Web.UI.WebControls.WebParts.WebPart

The control currently being rendered.

Return Value

Type: System.Web.UI.WebControls.WebParts.WebPartVerbCollection

A WebPartVerbCollection containing all verbs associated with the webPart.

Exception Condition
ArgumentNullException

The verbs collection is null.

- or -

webPart is null.

The FilterWebPartVerbs method provides a way to automatically filter certain verbs from the collection of verbs associated with a WebPart control, and prevent the filtered verbs from being rendered.

Notes to Inheritors:

If you create a custom WebPartChrome class, you can optionally override the FilterWebPartVerbs method to filter out specific verbs from being rendered. The most common way to do this is to create a private method that checks the verbs in the Verbs collection of a WebPart control and determines whether each verb should be rendered, based on criteria that you choose. Note that the base method provides a lot of default filtering criteria that would be difficult to reproduce if you completely override the method; if you only have a few special cases, you might want to call the base method first, and then pass the resulting collection through your own additional method to apply your custom filtering criteria.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft