FormViewModeEventArgs Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Provides data for the ModeChanging event.

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


type FormViewModeEventArgs = 
        inherit CancelEventArgs

System_CAPS_pubmethodFormViewModeEventArgs(FormViewMode, Boolean)

Initializes a new instance of the FormViewModeEventArgs class.


Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.)


Gets a value indicating whether the ModeChanging event was raised as a result of the user canceling an edit operation.


Gets or sets the mode to which the FormView control is changing.


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns a string that represents the current object.(Inherited from Object.)

The ModeChanging event is raised when a FormView control attempts to switch between edit, insert, and read-only mode, but before the mode actually changes. This allows you to provide an event-handling method that performs a custom routine, such as configuring the FormView control for a specific mode or canceling the mode change, whenever this event occurs.

A FormViewInsertEventArgs object is passed to the event-handling method, which allows you to determine the mode to which the FormView control is changing, to determine whether the ModeChanging event was raised as a result of the user canceling an edit or insert operation, or to indicate that the mode change should be canceled. To determine the new mode, use the NewMode property. You can also use the NewMode property to programmatically specify an alternate mode to which to change by setting it to one of the FormViewMode enumeration values. Use the CancelingEdit property to determine whether this event was raised as the result of the user canceling an edit or insert operation. To cancel the mode change, set the Cancel property to true.

For more information about handling events, see NIB: Consuming Events.

For a list of initial property values for an instance of the FormViewModeEventArgs class, see the FormViewModeEventArgs constructor.

The following example demonstrates how to use the FormViewModeEventArgs object passed to the event-handling method for the ModeChanging event to hide the pager row when the FormView control transitions to edit mode.

System_CAPS_security Security Note

This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see Script Exploits Overview.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 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.

Return to top