AnnotationCollection.AddImageAnnotation(String) Method

Appends the specified ImageAnnotation object to the current collection.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.1.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public ImageAnnotation AddImageAnnotation(
    string name
)

VB.NET

Public Function AddImageAnnotation(
    name As String
) As ImageAnnotation

Parameters

Name	Type	Description
name	String	A String value which specifies the name of the annotation.

Returns

Type	Description
ImageAnnotation	An ImageAnnotation object representing the image annotation to be added.

Remarks

This method adds an ImageAnnotation object with the specified name to the annotations collection of a chart, pane or series point.

After an annotation is added to an element’s collection, it can be accessed via the corresponding property of this element (ChartControl.Annotations, XYDiagramPaneBase.Annotations, or SeriesPoint.Annotations). Alternatively, to centrally access all annotations that are present in a chart control, use the ChartControl.AnnotationRepository property.

When you use the AddImageAnnotation method to add annotations to the XYDiagramPaneBase.Annotations or SeriesPoint.Annotations collections, this automatically anchors the annotation to the pane or the series point (the annotation’s AnchorPoint property is initialized with a PaneAnchorPoint or SeriesPointAnchorPoint object).

For more information, refer to Annotations.