BehaviorEditorPart Web Server Control Overview

Article
10/22/2014

The BehaviorEditorPart control provides an editor control that enables end users to change properties that affect the behavior of an associated WebPart or GenericWebPart control.

This topic contains:

Background
Code Examples
Class Reference

Background

The BehaviorEditorPart Web server control is an editor part control that enables end users to change several user interface (UI) properties on an associated WebPart control at run time. The following table lists user customizable features and the corresponding WebPart control property values that users can edit by using the BehaviorEditorPart control.

User Customizable Feature	WebPart Control Property
Set the description text of the Web Part.	Description
Set the Title link.	TitleUrl
Set the Title icon image link.	TitleIconImageUrl
Set the Catalog icon image link.	CatalogIconImageUrl
Set the Help link.	HelpUrl
Hide or show the control.	Hidden
Specify the Help mode.	HelpMode
Select the export mode.	ExportMode
Set the authorization filter.	AuthorizationFilter
Specify whether a Web part can be removed from the page.	AllowClose
Specify whether a Web part's properties can be edited.	AllowEdit
Specify whether a Web part can be hidden.	AllowHide
Specify whether a Web part can be minimized.	AllowMinimize
Specify whether a Web part can be moved between zones, or only within its own zone.	AllowZoneChange

Enabling a BehaviorEditorPart Web Server Control

The BehaviorEditorPart control is displayed at run time when a Web Parts page is in edit mode, and when the user has selected an associated WebPart control for editing. The BehaviorEditorPart control resides in an EditorZone control.

Note

An EditorZone zone can contain only EditorPart controls. EditorPart controls cannot be put in any other type of zone.

The BehaviorEditorPart control is not displayed on the page when the following conditions are true:

The IsShared property of the WebPart control being edited is set to true.
The page is in user personalization scope (which is the default).

For the BehaviorEditorPart control to be displayed, you must do the following:

Add an entry to the Web.config file that gives an authorized user permission to change Web pages in shared personalization scope. This means that the user's changes are visible to all other users. For more information, see How to: Enable Shared Personalization of Web Parts Pages.
Programmatically change the page from user-level to shared-level personalization scope at run time. For example, you can change scope by calling the ToggleScope method.

For an example of how to make the BehaviorEditorPart control visible in a page, see the BehaviorEditorPart. For more information about shared controls and personalization scope, see Web Parts Personalization Overview.