ListViewInsertedEventArgs.KeepInInsertMode ListViewInsertedEventArgs.KeepInInsertMode ListViewInsertedEventArgs.KeepInInsertMode ListViewInsertedEventArgs.KeepInInsertMode Property

Definition

Gets or sets a value that indicates whether the user's input values are preserved for the controls inside the InsertItemTemplate template.

public:
 property bool KeepInInsertMode { bool get(); void set(bool value); };
public bool KeepInInsertMode { get; set; }
member this.KeepInInsertMode : bool with get, set
Public Property KeepInInsertMode As Boolean

Property Value

true if the user's input values are preserved for the controls inside the InsertItemTemplate template; false if the user's input values are replaced with the default values for the controls. The default is false.

Examples

The following example shows how to use the KeepInInsertMode property to preserve the values entered by the user when an error occurs during the insert operation. This code example is part of a larger example provided for the ListViewInsertedEventArgs class.

void ContactsListView_ItemInserted(Object sender, ListViewInsertedEventArgs e)
{
  if (e.Exception != null)
  {
    if (e.AffectedRows == 0)
    {
      e.KeepInInsertMode = true;
      Message.Text = "An exception occurred inserting the new Contact. " +
        "Please verify your values and try again.";
    }
    else
      Message.Text = "An exception occurred inserting the new Contact. " +
        "Please verify the values in the newly inserted item.";

    e.ExceptionHandled = true;
  }
}
Sub ContactsListView_ItemInserted(ByVal sender As Object, ByVal e As ListViewInsertedEventArgs)

  If e.Exception IsNot Nothing Then

    If e.AffectedRows = 0 Then
      e.KeepInInsertMode = True
      Message.Text = "An exception occurred inserting the new Contact. " & _
        "Please verify your values and try again."
    Else
      Message.Text = "An exception occurred inserting the new Contact. " & _
        "Please verify the values in the newly inserted item."
    End If

    e.ExceptionHandled = True
  End If
End Sub

Remarks

By default, the ListView control resets the control's values from the InsertItemTemplate template to their default values after an insert operation. This enables users to add values for a new item to be inserted. If an exception is raised during the insert operation, you can keep the ListView control in insert mode by setting the KeepInInsertMode property to true. This maintains the values from the previous attempt to insert an item for the controls inside the InsertItemTemplate template.

Applies to

See also