Customize Chart Title

29 Nov 202413 minutes to read

Chart title is a concise description at the top of a chart, offering context and clarity for the data displayed. Using DocIO, you can customize the chart title in the chart.

Set the Chart Title Name

The following code snippet illustrates how to set the chart title name.

NOTE

Refer to the appropriate tabs in the code snippets section: C# [Cross-platform] for ASP.NET Core, Blazor, Xamarin, UWP, .NET MAUI, and WinUI; C# [Windows-specific] for WinForms and WPF; VB.NET [Windows-specific] for VB.NET applications.

C# [Cross-platform]

// Set the chart title.
chart.ChartTitle = "Purchase Details";

C# [Windows-specific]

// Set the chart title.
chart.ChartTitle = "Purchase Details";

VB.NET [Windows-specific]

' Set the chart title.
chart.ChartTitle = "Purchase Details"

Customize the Chart Title Area

The following code snippet illustrates how to customize the chart title area.

C# [Cross-platform]

// Customize chart title area.
chart.ChartTitleArea.FontName = "Calibri";
chart.ChartTitleArea.Bold = true;
chart.ChartTitleArea.Color = OfficeKnownColors.Red;
chart.ChartTitleArea.Underline = OfficeUnderline.DashLong;
chart.ChartTitleArea.Size = 14;

C# [Windows-specific]

// Customize chart title area.
chart.ChartTitleArea.FontName = "Calibri";
chart.ChartTitleArea.Bold = true;
chart.ChartTitleArea.Color = OfficeKnownColors.Red;
chart.ChartTitleArea.Underline = OfficeUnderline.DashLong;
chart.ChartTitleArea.Size = 14;

VB.NET [Windows-specific]

' Customize chart title area.
chart.ChartTitleArea.FontName = "Calibri"
chart.ChartTitleArea.Bold = True
chart.ChartTitleArea.Color = OfficeKnownColors.Red
chart.ChartTitleArea.Underline = OfficeUnderline.DashLong
chart.ChartTitleArea.Size = 14

Resize the Chart Title Area

The following code snippet illustrates how to resize the chart title area.

C# [Cross-platform]

//Manually resizing chart title area using Layout.
chart.ChartTitleArea.Layout.Top = 10;
chart.ChartTitleArea.Layout.Left = 10;

//Manually resizing chart title area using Manual Layout.
chart.ChartTitleArea.Layout.ManualLayout.Top = 0.005;
chart.ChartTitleArea.Layout.ManualLayout.Left = 0.26;

C# [Windows-specific]

//Manually resizing chart title area using Layout.
chart.ChartTitleArea.Layout.Top = 10;
chart.ChartTitleArea.Layout.Left = 10;

//Manually resizing chart title area using Manual Layout.
chart.ChartTitleArea.Layout.ManualLayout.Top = 0.005;
chart.ChartTitleArea.Layout.ManualLayout.Left = 0.26;

VB.NET [Windows-specific]

' Manually resizing chart title area using Layout.
chart.ChartTitleArea.Layout.Top = 10
chart.ChartTitleArea.Layout.Left = 10

' Manually resizing chart title area using Manual Layout.
chart.ChartTitleArea.Layout.ManualLayout.Top = 0.005
chart.ChartTitleArea.Layout.ManualLayout.Left = 0.26

The complete code snippet illustrating the above options is shown below.

C# [Cross-platform]

FileStream fileStreamPath = new FileStream("Data/Template.docx", FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
//Open an existing document from file system through constructor of WordDocument class.
using (WordDocument document = new WordDocument(fileStreamPath, FormatType.Docx))
{
    //Get the paragraph.
    WParagraph paragraph = document.LastParagraph;
    //Get the chart entity.
    WChart chart = paragraph.ChildEntities[0] as WChart;

    // Set the chart title.
    chart.ChartTitle = "Purchase Details";

    // Customize chart title area.
    chart.ChartTitleArea.FontName = "Calibri";
    chart.ChartTitleArea.Bold = true;
    chart.ChartTitleArea.Color = OfficeKnownColors.Black;
    chart.ChartTitleArea.Underline = OfficeUnderline.WavyHeavy;

    //Manually resizing chart title area using Layout.
    chart.ChartTitleArea.Layout.Left = 5;
   
    using (FileStream outputStream = new FileStream("Sample.docx", FileMode.Create, FileAccess.ReadWrite, FileShare.ReadWrite))
    {
        //Save the Word file.
        document.Save(outputStream, FormatType.Docx);
    }
}

C# [Windows-specific]

using (WordDocument document = new WordDocument("Template.docx", FormatType.Docx))
{
    //Get the paragraph.
    WParagraph paragraph = document.LastParagraph;
    //Get the chart entity.
    WChart chart = paragraph.ChildEntities[0] as WChart;
    // Set the chart title.
    chart.ChartTitle = "Purchase Details";

    // Customize chart title area.
    chart.ChartTitleArea.FontName = "Calibri";
    chart.ChartTitleArea.Bold = true;
    chart.ChartTitleArea.Color = OfficeKnownColors.Black;
    chart.ChartTitleArea.Underline = OfficeUnderline.WavyHeavy;

    //Manually resizing chart title area using Layout.
    chart.ChartTitleArea.Layout.Left = 5;
    document.Save("Sample.docx");
}

VB.NET [Windows-specific]

Using document As New WordDocument("Template.docx", FormatType.Docx)
    ' Get the paragraph.
    Dim paragraph As WParagraph = document.LastParagraph

    ' Get the chart entity.
    Dim chart As WChart = TryCast(paragraph.ChildEntities(0), WChart)

    ' Set the chart title.
    chart.ChartTitle = "Purchase Details"

    ' Customize chart title area.
    chart.ChartTitleArea.FontName = "Calibri"
    chart.ChartTitleArea.Bold = True
    chart.ChartTitleArea.Color = OfficeKnownColors.Black
    chart.ChartTitleArea.Underline = OfficeUnderline.WavyHeavy

    ' Manually resize chart title area using Layout.
    chart.ChartTitleArea.Layout.Left = 5

    document.Save("Sample.docx")
End Using

You can download a complete working sample from GitHub.

Remove Chart Title

The following code example illustrates how to remove the chart title from the Word document.

C# [Cross-platform]

//Creates a new instance of WordDocument.
using (WordDocument document = new WordDocument())
{
        //Adds section to the document.
        IWSection sec = document.AddSection();
        //Adds paragraph to the section.
        IWParagraph paragraph = sec.AddParagraph();
        //Creates and Appends chart to the paragraph.
        WChart chart = paragraph.AppendChart(446, 270);
        //Sets chart type.
        chart.ChartType = OfficeChartType.Pie;
        //Sets chart title.
        chart.ChartTitle = string.Empty;
        //Sets data for chart.
        chart.ChartData.SetValue(1, 1, "");
        chart.ChartData.SetValue(1, 2, "Sales");
        chart.ChartData.SetValue(2, 1, "Phyllis Lapin");
        chart.ChartData.SetValue(2, 2, 141.396);
        chart.ChartData.SetValue(3, 1, "Stanley Hudson");
        chart.ChartData.SetValue(3, 2, 80.368);
        //Creates a new chart series with the name “Sales”.
        IOfficeChartSerie pieSeries = chart.Series.Add("Sales");
        pieSeries.Values = chart.ChartData[2, 2, 3, 2];
        //Sets category labels.
        chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 3, 1];
        //Saves the Word document to MemoryStream.
        MemoryStream stream = new MemoryStream();
        document.Save(stream, FormatType.Docx);
        //Closes the document.
        document.Close();
}

C# [Windows-specific]

//Creates a new instance of WordDocument.
using (WordDocument document = new WordDocument())
{
    //Adds section to the document.
    IWSection sec = document.AddSection();
    //Adds paragraph to the section.
    IWParagraph paragraph = sec.AddParagraph();
    //Creates and Appends chart to the paragraph.
    WChart chart = paragraph.AppendChart(446, 270);
    //Sets chart type.
    chart.ChartType = OfficeChartType.Pie;
    //Sets chart title.
    chart.ChartTitle = string.Empty;
    //Sets data for chart.
    chart.ChartData.SetValue(1, 1, "");
    chart.ChartData.SetValue(1, 2, "Sales");
    chart.ChartData.SetValue(2, 1, "Phyllis Lapin");
    chart.ChartData.SetValue(2, 2, 141.396);
    chart.ChartData.SetValue(3, 1, "Stanley Hudson");
    chart.ChartData.SetValue(3, 2, 80.368);
    //Creates a new chart series with the name “Sales”.
    IOfficeChartSerie pieSeries = chart.Series.Add("Sales");
    pieSeries.Values = chart.ChartData[2, 2, 3, 2];
    //Sets category labels.
    chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData[2, 1, 3, 1];
    //Saves the document
    document.Save("Sample.docx");
    //Closes the document.
    document.Close();
}

VB.NET [Windows-specific]

'Creates an empty WordDocument instance
 Dim document As New WordDocument()
'Adds section to the document.
 Dim sec As IWSection =  document.AddSection() 
'Adds paragraph to the section.
 Dim paragraph As IWParagraph =  sec.AddParagraph() 
'Creates and Appends chart to the paragraph.
 Dim chart As WChart =  paragraph.AppendChart(446,270) 
'Sets chart type.
 chart.ChartType = OfficeChartType.Pie
'Sets chart title.
 chart.ChartTitle = String.Empty
'Sets data for chart.
 chart.ChartData.SetValue(1, 1, "")
 chart.ChartData.SetValue(1, 2, "Sales")
 chart.ChartData.SetValue(2, 1, "Phyllis Lapin")
 chart.ChartData.SetValue(2, 2, 141.396)
 chart.ChartData.SetValue(3, 1, "Stanley Hudson")
 chart.ChartData.SetValue(3, 2, 80.368)
'Creates a new chart series with the name “Sales”.
 Dim pieSeries As IOfficeChartSerie =  chart.Series.Add("Sales") 
 pieSeries.Values = chart.ChartData(2, 2, 3, 2)
'Sets category labels.
 chart.PrimaryCategoryAxis.CategoryLabels = chart.ChartData(2, 1, 3, 1)
'Saves the document
 document.Save("Sample.docx", FormatType.Docx)
'Closes the document
 document.Close()

You can download a complete working sample from GitHub.