AnnotationRepositoryChangingEventArgs Class

Data for the ChartControl.AnnotationRepositoryChanging event.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public class AnnotationRepositoryChangingEventArgs :
    EventArgs

VB.NET

Public Class AnnotationRepositoryChangingEventArgs
    Inherits EventArgs

Related API Members

AnnotationRepositoryChangingEventArgs is the data class for the following events:

• ChartControl.AnnotationRepositoryChanging

Remarks

The AnnotationRepositoryChanging event occurs when a user adds, edits or deletes an annotation before this change is applied to the annotation repository. The AnnotationRepositoryChangingEventArgs class exposes the following properties:

• Annotation
• Cancel
• Change

Example

The following example prevents Annotation1 from being deleted.

C#

void chartControl1_AnnotationRepositoryChanging(object sender, AnnotationRepositoryChangingEventArgs e) {
    if (e.Annotation.Name == "Annotation1" && e.Change == AnnotationRepositoryChange.Deletion) {
        e.Cancel = true;
    }
}

VB.NET

Private Sub chartControl1_AnnotationRepositoryChanging(ByVal sender As Object, ByVal e As AnnotationRepositoryChangingEventArgs)
    If e.Annotation.Name = "Annotation 1" AndAlso e.Change = AnnotationRepositoryChange.Deletion Then
        e.Cancel = True
    End If
End Sub

Inheritance

Object

EventArgs

AnnotationRepositoryChangingEventArgs

AnnotationImageEditingEventArgs

AnnotationTextEditingEventArgs