AnnotationCollection.AddTextAnnotation(String, String) Method

Appends the specified TextAnnotation object to the current collection.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v23.2.dll

NuGet Package: DevExpress.Charts

Declaration

C#

public TextAnnotation AddTextAnnotation(
    string name,
    string text
)

VB.NET

Public Function AddTextAnnotation(
    name As String,
    text As String
) As TextAnnotation

Parameters

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

Returns

Type	Description
TextAnnotation	A TextAnnotation object representing the text annotation to be added.

Remarks

This method adds a TextAnnotation object with the specified name and text 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 AddTextAnnotation 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.