AlignedTitle.WordWrap Property

Gets or sets whether a title’s text should wrap when it’s too lengthy.

Namespace: DevExpress.XtraCharts

Assembly: DevExpress.XtraCharts.v24.2.dll

Declaration

C#

[XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)]
public bool WordWrap { get; set; }

VB.NET

<XtraChartsLocalizableCategory(XtraChartsCategory.Behavior)>
Public Property WordWrap As Boolean

Property Value

Type	Description
Boolean	true, if a title’s text should wrap; otherwise, false.

Remarks

Use the WordWrap property to enable automatic word wrapping for lengthy titles.

After you enable the WordWrap property, the DockableTitle.MaximumLinesCount property is in effect, allowing you to determine the number of lines that will appear when a title’s text is wrapped. Note that if a title’s length exceeds this limit, the last line of text will be cut off.

The following images demonstrates how these properties work for chart titles.

WordWrap = false	WordWrap = true MaximumLinesCount = 0	WordWrap = true MaximumLinesCount = 2

Example

This example demonstrates how word-wrapping can be enabled for chart titles at runtime. In addition, you can determine the maximum number of lines in which a title is allowed to wrap.

C#

// Create a title and add it to the chart's collection.
ChartTitle chartTitle1 = new ChartTitle();
ChartControl1.Titles.Add(chartTitle1);
chartTitle1.Text = "Just a Very Lengthy Title for Such a Small Chart";

// Enable word-wrapping for the title,
// and define a limit for its lines.
chartTitle1.WordWrap = true;
chartTitle1.MaxLineCount = 2;

VB.NET

' Create a title and add it to the chart's collection.
Dim chartTitle1 As New ChartTitle()
myChart.Titles.Add(chartTitle1)
chartTitle1.Text = "Just a Very Lengthy Title for Such a Small Chart"

' Enable word-wrapping for the title,
' and define a limit for its lines.
chartTitle1.WordWrap = True
chartTitle1.MaxLineCount = 2

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the WordWrap property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-chart-create-and-customize-chart-titles/CS/Form1.cs#L22

chartTitle2.WordWrap = true;
chartTitle2.MaxLineCount = 2;

VB.NET

winforms-charts-create-a-side-by-side-stacked-bars/VB/SideBySideStackedBarChart/Form1.vb#L52

stackedBarChart.Titles(0).Text = "A Side-By-Side Stacked Bar Chart"
stackedBarChart.Titles(0).WordWrap = True
' Add the chart to the form.

winforms-chart-create-and-customize-chart-titles/VB/Form1.vb#L23

chartTitle2.Text = "The capability to word-wrap is available for chart titles."
chartTitle2.WordWrap = True
chartTitle2.MaxLineCount = 2