System.Design 2.0.0.0 System.Web.UI.Design.DesignerObject

The object represents a region of content within the design-time markup that is generated by a implementation. A control developer uses designer regions in a custom implementation to define separate areas within the design-time markup for the associated control and to provide editing and event handling for the area. A visual designer, such as vsprvslong, can use designer regions to display the separate areas of a control on the design surface and to raise user events for the region to the control designer. Designer regions can simplify a control designer implementation because many region-based features are provided by the base designer classes and the visual designer.

The class provides the base functionality for designer regions, such as the ability to click, select, and highlight a region in the design surface. Use a object in a control designer implementation to define a region that does not require editing. Use the derived class in a control designer implementation to define a region with editable content at design time. Use the derived class in a control designer implementation to define an editable region that represents a template in a control.

To support regions within a class that is derived from the , override the method and add one or more initialized objects to the collection. Optionally, you can handle mouse clicks in the regions on the design surface by overriding the method.

Use the properties of a object to determine how the region is displayed by the visual designer. Override the property to indicate that the region can be selected by the user on the design surface. Use the property to highlight the designer region in the visual designer; for example, you can highlight a region after a user has clicked to select it. Use the and properties to store or retrieve additional details about the region. In particular, the property is used by the visual designer to display ToolTip information when the user moves the mouse pointer over the designer region. Use the property to access the methods and properties of the control designer object that contains the designer region.

Defines a region of content within the design-time markup for the associated control.

- Constructor
  2.0.0.0

  The following table shows the initial property values for an instance of the class.

  Property

  Initial Value

  An empty string ("").

  The input object.

  An empty string ("").

  false.

  false.

  The input object.

  An empty object.

  false.

  false.

  null.

  Initializes a new instance of the class with the specified name for a control designer.

  The control designer that contains this designer region.
  The name of this designer region.
- Constructor
  2.0.0.0

  The following table shows the initial property values for an instance of the class.

  Property

  Initial Value

  An empty string ("").

  The input object.

  An empty string ("").

  false.

  false.

  The input object.

  An empty object.

  The input value.

  false.

  null.

  Initializes a new instance of the class with the specified name for a control designer, optionally setting the instance as a selectable region in the designer.

  The control designer that contains this designer region.
  The name of this designer region.
  true to select the region; otherwise, false.
- Property
  2.0.0.0
  System.String To be added.

  The property is used by the design host to display ToolTip information when the user moves the mouse pointer over the designer region.

  Gets or sets the description for a designer region.

- Field
  2.0.0.0
  System.String null

  The attribute name for a designer region is _designerRegion. The field is used to identify regions within the design-time HTML markup for the control designer.

  Defines the HTML attribute name for a designer region.

- Property
  2.0.0.0
  System.String To be added. To be added.

  Gets or sets the friendly display name for a designer region.

- Property
  2.0.0.0
  System.Boolean To be added. To be added.

  Gets or sets a value indicating whether the region size is to be explicitly set on the designer region by the design host.

- Method
  2.0.0.0
  System.Drawing.Rectangle

  The method returns a value that is equivalent to calling the method on the object with this designer region.

  Retrieves the size of the designer region on the design surface.

  A representing the designer region size on the design surface.

- Property
  2.0.0.0
  System.Boolean To be added. To be added.

  Gets or sets a value indicating whether to highlight the designer region on the design surface.

- Property
  2.0.0.0
  System.Boolean To be added. To be added.

  Gets or sets a value indicating whether the designer region can be selected by the user on the design surface.

- Property
  2.0.0.0
  System.Boolean To be added. To be added.

  Gets or sets a value indicating whether the designer region is currently selected on the design surface.

- Property
  2.0.0.0
  System.Object To be added.

  Within a control designer implementation, use the property to store or retrieve additional information for the designer region.

  For example, if the control designer implementation supports selecting from multiple designer regions, you can use the property in a control designer to store a unique index for each region. You can then use the property for the region that is passed into the method to store the index for the currently selected region.

  Gets or sets optional user data to associate with the designer region.