CancelEventArgs Класс

Определение

Предоставляет данные для отменяемого события.Provides data for a cancelable event.

public ref class CancelEventArgs : EventArgs
public class CancelEventArgs : EventArgs
type CancelEventArgs = class
    inherit EventArgs
Public Class CancelEventArgs
Inherits EventArgs
Наследование
CancelEventArgs
Производный

Примеры

В следующем примере с помощью CancelEventArgs и CancelEventHandler обрабатывается событие Closing Form.The following example uses CancelEventArgs and a CancelEventHandler to handle the Closing event of a Form. В этом коде предполагается, что вы создали Form с переменной Boolean уровня класса с именем isDataSaved.This code assumes that you have created a Form with a class-level Boolean variable named isDataSaved. Также предполагается, что вы добавили оператор для вызова метода OtherInitialize из Load метода формы или конструктора (после вызова InitializeComponent).It also assumes that you have added a statement to invoke the OtherInitialize method from the form's Load method or the constructor (after the call to InitializeComponent).

private:
   // Call this method from the InitializeComponent() method of your form
   void OtherInitialize()
   {
      this->Closing += gcnew CancelEventHandler( this, &Form1::Form1_Cancel );
      this->myDataIsSaved = true;
   }

   void Form1_Cancel( Object^ /*sender*/, CancelEventArgs^ e )
   {
      if ( !myDataIsSaved )
      {
         e->Cancel = true;
         MessageBox::Show( "You must save first." );
      }
      else
      {
         e->Cancel = false;
         MessageBox::Show( "Goodbye." );
      }
   }
// Call this method from the constructor of your form
    private void OtherInitialize() {
       this.Closing += new CancelEventHandler(this.Form1_Closing);
       // Exchange commented line and note the difference.
       this.isDataSaved = true;
       //this.isDataSaved = false;
    }

    private void Form1_Closing(Object sender, CancelEventArgs e) {
       if (!isDataSaved) {
          e.Cancel = true;
          MessageBox.Show("You must save first.");
       }
       else {
          e.Cancel = false;
          MessageBox.Show("Goodbye.");
       }
    }
 
' Call this method from the Load method of your form.
Private Sub OtherInitialize()
    ' Exchange commented line and note the difference.
    Me.isDataSaved = True
    'Me.isDataSaved = False
End Sub

Private Sub Form1_Closing(sender As Object, e As _
   System.ComponentModel.CancelEventArgs) Handles MyBase.Closing
    If Not isDataSaved Then
        e.Cancel = True
        MessageBox.Show("You must save first.")
    Else
        e.Cancel = False
        MessageBox.Show("Goodbye.")
    End If
End Sub

Комментарии

Событие, которое можно отменить, вызывается компонентом, когда он собирается выполнить действие, которое может быть отменено, например событие Closing Form.A cancelable event is raised by a component when it is about to perform an action that can be canceled, such as the Closing event of a Form.

Примечание

Событие Closing является устаревшим и заменено FormClosing.The Closing event is deprecated and has been replaced by FormClosing. Он предлагается в качестве примера только для иллюстрации использования CancelEventArgs.It is offered as an example here only to illustrate the usage of CancelEventArgs.

CancelEventArgs предоставляет свойство Cancel, указывающее, должно ли быть отменено событие.CancelEventArgs provides the Cancel property to indicate whether the event should be canceled.

Конструкторы

CancelEventArgs()

Инициализирует новый экземпляр класса CancelEventArgs, устанавливая свойство Cancel равным false.Initializes a new instance of the CancelEventArgs class with the Cancel property set to false.

CancelEventArgs(Boolean)

Инициализирует новый экземпляр класса CancelEventArgs, устанавливая свойство Cancel в заданное значение.Initializes a new instance of the CancelEventArgs class with the Cancel property set to the given value.

Свойства

Cancel

Возвращает или задает значение, показывающее, следует ли отменить событие.Gets or sets a value indicating whether the event should be canceled.

Методы

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Применяется к

Дополнительно