Back to Devexpress

ChartOptionsPrint Class

corelibraries-devexpress-dot-xtracharts-dot-printing.md

latest4.1 KB
Original Source

ChartOptionsPrint Class

Provides print options for the chart control.

Namespace : DevExpress.XtraCharts.Printing

Assembly : DevExpress.XtraCharts.v25.2.dll

NuGet Package : DevExpress.Charts

Declaration

csharp
public class ChartOptionsPrint :
    BaseOptions,
    IXtraSupportShouldSerialize
vb
Public Class ChartOptionsPrint
    Inherits BaseOptions
    Implements IXtraSupportShouldSerialize

The following members return ChartOptionsPrint objects:

Remarks

The ChartOptionsPrint class provides a set of properties that control how the chart is printed. These properties can be accessed via the control’s ChartControl.OptionsPrint property.

Example

The following example demonstrates how to print a ChartControl , or show its Print Preview. To do this, you should use either the ChartControl.Print or ChartControl.ShowPrintPreview methods.

Note

A chart can be printed and previewed only if the XtraPrinting Library is available. To verify that printing the chart is possible, use the ChartControl.IsPrintingAvailable property.

When printing a chart, the current print settings will be used to represent a chart. Note that you can access and change these settings via the ChartControl.OptionsPrint property. End-users manually select the printer settings by clicking the Customize toolbar button ( ) in a chart’s preview, and setting the required options in the Printable Component Editor.

csharp
using DevExpress.XtraCharts;
// ...

private void ShowChartPreview(ChartControl chart) {
    // Check whether the ChartControl can be previewed.
    if (!chart.IsPrintingAvailable) {
        MessageBox.Show("The 'DevExpress.XtraPrinting.v7.2.dll' is not found", "Error");
        return;
    }
    // Open the Preview window.
    chart.ShowPrintPreview();
}

private void PrintChart(ChartControl chart) {
    // Check whether the ChartControl can be printed.
    if (!chart.IsPrintingAvailable) {
        MessageBox.Show("The 'DevExpress.XtraPrinting.v7.2.dll' is not found", "Error");
        return;
    }
    // Print.
    chart.Print();
}
vb
Imports DevExpress.XtraCharts
' ...

Sub ShowChartPreview(ByVal chart As ChartControl)
   ' Check whether the ChartControl can be previewed.
   If Not chart.IsPrintingAvailable Then
      MessageBox.Show("The 'DevExpress.XtraPrinting.v7.2.dll' is not found", "Error")
      Return
   End If

   ' Opens the Preview window.
   chart.ShowPrintPreview()
End Sub

Sub PrintChart(ByVal chart As ChartControl)
   ' Check whether the ChartControl can be printed.
   If Not chart.IsPrintingAvailable Then
      MessageBox.Show("The 'DevExpress.XtraPrinting.v7.2.dll' is not found", "Error")
      Return
   End If

   ' Print.
   chart.Print()
End Sub

Inheritance

Object ViewStatePersisterCore BaseOptions ChartOptionsPrint

See Also

ChartOptionsPrint Members

DevExpress.XtraCharts.Printing Namespace