Edit

Share via

DesignerRegionMouseEventArgs Class

  • Reference

Definition

Namespace:
System.Web.UI.Design
Assembly:
System.Design.dll

Provides data for a ViewEvent event that is raised when you click on a selected control or a designer region in a selected control. This class cannot be inherited.

public ref class DesignerRegionMouseEventArgs sealed : EventArgs
public sealed class DesignerRegionMouseEventArgs : EventArgs
type DesignerRegionMouseEventArgs = class
    inherit EventArgs
Public NotInheritable Class DesignerRegionMouseEventArgs
Inherits EventArgs
Inheritance
Object
EventArgs
DesignerRegionMouseEventArgs

Examples

The following code example shows how to use the DesignerRegionMouseEventArgs to identify the region that was clicked and to change the view accordingly. This example is part of a larger example provided for the EditableDesignerRegion class.

// Handler for the Click event, which provides the region in the arguments.
protected override void OnClick(DesignerRegionMouseEventArgs e)
{
    if (e.Region == null)
        return;

    // If the clicked region is not a header, return
    if (e.Region.Name.IndexOf("Header") != 0)
        return;

    // Switch the current view if required
    if (e.Region.Name.Substring(6, 1) != myControl.CurrentView.ToString())
    {
        myControl.CurrentView = int.Parse(e.Region.Name.Substring(6, 1));
        base.UpdateDesignTimeHtml();
    }
}

' Handler for the Click event, which provides the region in the arguments.
Protected Overrides Sub OnClick(ByVal e As DesignerRegionMouseEventArgs)
    If IsNothing(e.Region) Then
        Return
    End If

    ' If the clicked region is not a header, return
    If e.Region.Name.IndexOf("Header") <> 0 Then
        Return
    End If

    ' Switch the current view if required
    If e.Region.Name.Substring(6, 1) <> myControl.CurrentView.ToString() Then
        myControl.CurrentView = Integer.Parse(e.Region.Name.Substring(6, 1))
        MyBase.UpdateDesignTimeHtml()
    End If
End Sub

Remarks

The ViewEvent event is raised by the designer host for certain actions on a control on the design surface. For example, an event is raised when you click a selected control or a designer region in a selected control on the design surface.

The ControlDesigner class supplies a default delegate to handle the ViewEvent event. When you click a selected control or a designer region of a selected control at design time, the designer host initializes a ViewEventArgs object for a Click event type, and then sets the EventArgs property with a DesignerRegionMouseEventArgs object.

When the ViewEventArgs object indicates that you clicked a designer region, the default delegate in the ControlDesigner class passes the DesignerRegionMouseEventArgs object to the OnClick method. Classes deriving from the ControlDesigner class override the OnClick method to process events that are raised when you click a control in the design host.

The Region property represents the control designer region that the event applies to, if any. The Location property represents the location on the design surface that was clicked.

For more information about events and delegates, see Handling and Raising Events.

Constructors

DesignerRegionMouseEventArgs(DesignerRegion, Point)

Initializes a new instance of the DesignerRegionMouseEventArgs class with the specified region and location.

Properties

Location

Gets the location within the control that was clicked.
Region

Gets the designer region that was clicked, if any.

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to

See also