CancelEventArgs Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет данные для события отмены.
public ref class CancelEventArgs : EventArgs
public class CancelEventArgs : EventArgs
type CancelEventArgs = class
inherit EventArgs
Public Class CancelEventArgs
Inherits EventArgs
- Наследование
- Производный
Примеры
В следующем примере используется и CancelEventHandler используется CancelEventArgs для обработки Closing события Formобъекта . В этом коде предполагается, что вы создали Form переменную уровня Boolean класса с именем isDataSaved. Кроме того, предполагается, что вы добавили инструкцию для вызова OtherInitialize метода из метода формы Load или конструктора (после вызова 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
void OtherInitialize()
{
Closing += Form1_Closing;
// Exchange commented line and note the difference.
isDataSaved = true;
//this.isDataSaved = false;
}
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
Замечание
Событие Closing устарело и заменено FormClosing. Оно предлагается в качестве примера только для иллюстрации CancelEventArgsиспользования.
CancelEventArgs Cancel предоставляет свойство, указывающее, следует ли отменить событие.
Конструкторы
| Имя | Описание |
|---|---|
| CancelEventArgs() |
Инициализирует новый экземпляр CancelEventArgs класса с заданным |
| CancelEventArgs(Boolean) |
Инициализирует новый экземпляр CancelEventArgs класса с свойством, Cancel заданным заданным значением. |
Свойства
| Имя | Описание |
|---|---|
| Cancel |
Возвращает или задает значение, указывающее, следует ли отменить событие. |
Методы
| Имя | Описание |
|---|---|
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |