Modifier

Partager via

DesignerRegionMouseEventArgs.Region Property

  • Reference

Definition

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

Gets the designer region that was clicked, if any.

public:
 property System::Web::UI::Design::DesignerRegion ^ Region { System::Web::UI::Design::DesignerRegion ^ get(); };
public System.Web.UI.Design.DesignerRegion Region { get; }
member this.Region : System.Web.UI.Design.DesignerRegion
Public ReadOnly Property Region As DesignerRegion

Property Value

DesignerRegion

The DesignerRegion that the click event applies to, or null if no region was clicked.

Examples

The following code example shows how to use the DesignerRegionMouseEventArgs to identify the region that was clicked and to change 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 Region property represents the control designer region that was clicked, if any.

The Region property is initialized by the DesignerRegionMouseEventArgs constructor.

Applies to

See also