System.Web 2.0.0.0 System.Web.UI.WebControls.WebParts.Part System.ComponentModel.Designer("System.Web.UI.Design.WebControls.WebParts.EditorPartDesigner, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.ComponentModel.Design.IDesigner") System.ComponentModel.Bindable(false)

The class provides a base set of properties and methods that are used by the derived controls provided with the Web Parts control set, and by custom controls. An control allows a user to edit an associated control by modifying its layout, appearance, properties, behavior, or other characteristics.

The editing user interface (UI), which consists of zones that contain controls, is displayed after a Web page enters edit mode.

An control can be used only within a zone that derives from the class, such as the control.

After a page has entered edit mode, a user can select a control to edit by clicking an edit verb on the verbs menu of the selected control. Only one control can be edited at a time.

Several derived controls are provided with the Web Parts control set, as listed in the following table. These controls provide all the editing capabilities that are necessary for most applications. The typical approach for using these controls in a Web Parts page is to declare them in page persistence format within a <zonetemplate> element, where <zonetemplate> is the child element of an <asp:editorzone> element. For a code example, see the Example section of this topic.

Type of control

Description

Edits the appearance of the associated control, including properties such as its title text, height, width, and border attributes.

Edits certain behaviors of the associated control, such as whether it can be edited, whether it can be closed, or whether it can be moved to another zone. This control is only visible on a page when a control is being edited in shared personalization scope.

Edits layout attributes for the associated control, such as whether it is in a normal or minimized (collapsed) state, and what zone it is placed in.

Edits properties of the associated control, if those properties were declared in the source code with a WebBrowsable attribute.

To improve accessibility, all the controls provided in the Web Parts control set are rendered within a <fieldset> element. The <fieldset> element groups the related set of controls used for editing in a given control, and it facilitates tabbed navigation among those controls for both visual user agents (such as ordinary Web browsers) and speech-oriented user agents (such as screen-reading software).

Serves as the base class for controls that reside in zones and are used to edit controls.

- Constructor
  To be added.

  Initializes the class for use by an inherited class instance. This constructor can be called only by an inherited class.

  2.0.0.0
- Method
  System.Boolean

  The method is a critical method on an control. It is defined as an abstract method in the class, and must be implemented by inherited controls. The method's purpose is to save the values a user has entered into an control to the corresponding properties in the control that is referenced in the property.

  The method is called when the user clicks a button representing an OK or an apply verb in the editing user interface (UI).

  Saves the values in an control to the corresponding properties in the associated control.

  true if the action of saving values from the control to the control is successful; otherwise (if an error occurs), false.

  2.0.0.0
- Property
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.Browsable(false)
  System.Boolean To be added.

  At certain points in the editing process, the zone that contains an control checks the property to determine whether to display the control.

  There are two scenarios where the property returns false and the control is not displayed. The first scenario occurs when the control being edited is a control. The second scenario occurs when the control being edited has its and properties set to true, while the page's personalization scope is set at user level.

  Gets a value that indicates whether a control should be displayed when its associated control is in edit mode.

  2.0.0.0
- Property
  System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)
  System.ComponentModel.Browsable(false)
  System.String To be added.

  The property returns either the current value of the base property or, if the control has no title, a calculated value. The calculated value consists of a localizable resource string for untitled controls. In the cases where no value is assigned to the property, the value of the property differs from the property.

  Because the property is designed to be a read-only, calculated property to get the actual current value of the displayed title at run time, do not attempt to use this property to set a title for an control. To set a title, use the base property.

  Gets a string that contains the title text displayed in the title bar of an control.

  2.0.0.0
- Method
  System.Collections.IDictionary

  The method returns information about the state of the zone that contains an control. The state information is returned in the form of a dictionary.

  Retrieves the current state of an control's parent zone.

  An that has the current state of the zone that contains an control.

  2.0.0.0
- Method
  2.0.0.0
  System.Void ``

  In addition to calling the base method, the method also checks the property. If the value is false, meaning that the control should not be displayed, then the property is also set to false.

  Raises the event.

  An that contains the event data.
- Method
  System.Void

  The method is a critical method on an control. It is defined as an abstract method in the class, and must be implemented by inherited controls. The purpose of the method is to retrieve the current values from the control referenced in the property, and update the fields in the control with those values so a user can edit them.

  The method is called whenever the values in the associated control might have changed. For every control, the zone that contains the control calls the method immediately after calling the method, so that the values in the control are always synchronized with the values in the associated control. Another case where the method is called is when a control is entering edit mode.

  The method is not called after the method if that method returns false, because in that case, an error has occurred.

  Retrieves the property values from a control for its associated control.

  2.0.0.0
- Property
  System.Web.UI.WebControls.WebParts.WebPart To be added.

  The control (or other server or user control) that is currently being edited corresponds to the value of the property. Only one control can be edited at a time, and when a control is in edit mode, the property provides a reference to that control.

  After the zone has added the control to its collection of controls, it then assigns the value of its own property to the property on the control.

  An control uses the property especially in its two critical methods-- and --to get and set the property values on the associated control.

  Gets a reference to the control that is currently being edited.

  2.0.0.0