CancelEventArgs Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет данные для отменяемого события.
public ref class CancelEventArgs : EventArgs
public class CancelEventArgs : EventArgs
type CancelEventArgs = class
inherit EventArgs
Public Class CancelEventArgs
Inherits EventArgs
- Наследование
- Производный
Примеры
В следующем примере для обработки Closing события Formобъекта используется CancelEventArgs и CancelEventHandler . В этом коде предполагается, что вы создали с переменной 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
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.
Примечание
Событие Closing является нерекомендуемым и заменено на FormClosing. Он предлагается в качестве примера только для иллюстрации CancelEventArgsиспользования .
CancelEventArgsCancel предоставляет свойство , указывающее, следует ли отменить событие.
Конструкторы
CancelEventArgs() |
Инициализирует новый экземпляр класса CancelEventArgs, устанавливая свойство Cancel равным |
CancelEventArgs(Boolean) |
Инициализирует новый экземпляр класса CancelEventArgs, устанавливая свойство Cancel в заданное значение. |
Свойства
Cancel |
Возвращает или задает значение, показывающее, следует ли отменить событие. |
Методы
Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
GetType() |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
MemberwiseClone() |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |