Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
ViewEvent Class
Collapse the table of content
Expand the table of content

ViewEvent Class

Represents the kind of event that has occurred on a view of a control at design time. This class cannot be inherited.


Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)

public sealed class ViewEvent

The ViewEvent type exposes the following members.

Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Public fieldStatic memberClickIndicates that a view event was raised for a click on a designer region.
Public fieldStatic memberPaintIndicates that a view event was raised for drawing a control on the design surface.
Public fieldStatic memberTemplateModeChangedIndicates that a view event was raised for changing the template mode of a control designer.

A ViewEvent object is provided to the designer component by the design host, for example Visual Studio 2005, when raising an event caused by certain user actions on the design-time view of a control. The IControlDesignerView.ViewEvent event is handled by a ViewEventHandler delegate method, which takes a ViewEventArgs object as a parameter. The EventType property of the ViewEventArgs class is a ViewEvent object. The ViewEventHandler delegate method compares the EventType property to the static ViewEvent fields to determine which type of action raised the event. For example, an event is raised under the following circumstances:

  • You click a region on the design surface.

  • The designer draws a control on the design surface.

  • You enter or exit template editing mode for a control.

The ControlDesigner class supplies a default delegate to handle the IControlDesignerView.ViewEvent event. Custom control designers override the OnClick, OnPaint, and OnTemplateModeChanged methods to process those events for the control on the design surface.

The designer host initializes a ViewEventArgs object for the type of action on the design surface, and then passes the object to the ViewEventHandler delegate. The EventType property of the ViewEventArgs object indicates which type of action:

The EventArgs property supplies the event arguments that are specific to the type of action.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft