ChartObject Class

Represents a chart object on the report.

Namespace CrystalDecisions.CrystalReports.Engine Assembly CrystalDecisions.CrystalReports.Engine (CrystalDecisions.CrystalReports.Engine.dll)

Syntax

'Declaration
Public Class ChartObject
    Inherits ReportObject
    Implements IDisposable
public class ChartObject : ReportObject, IDisposable

Remarks

This class allows you to retrieve information and set generic format options inherited from the ReportObject class.

Example

This example shows how to retrieve a ReportObject object by name using the Item property of the ReportObjects collection, and cast the ReportObject as a ChartObject. It also shows how to update the properties of a chart object.

'Declaration

      Private Function GetChartObject _
         (ByVal reportObjectName As String) As ChartObject

         Dim chart As ChartObject

         If TypeOf _
            (Report.ReportDefinition.ReportObjects. _
            Item(reportObjectName)) Is ChartObject Then
            chart = _
               Report.ReportDefinition.ReportObjects. _
               Item(reportObjectName)
            GetChartObject = chart
         Else : GetChartObject = Nothing
         End If
      End Function

      Private Sub UpdateChartObjectProperties(ByVal myReportDocument As ReportDocument, ByVal chartObjectName As String, ByVal top As Integer, ByVal left As Integer, ByVal height As Integer, ByVal width As Integer)
        Dim myReportObject As ReportObject = myReportDocument.ReportDefinition.ReportObjects.Item(chartObjectName)
        If Not myReportObject Is Nothing And myReportObject.Kind = ReportObjectKind.ChartObject Then
          Dim myChartObject As ChartObject = myReportObject
          myChartObject.Top = top
          myChartObject.Left = left
          myChartObject.Height = height
          myChartObject.Width = width

          Dim myBorder As Border = myChartObject.Border()
          myBorder.BackgroundColor = Color.White
          myBorder.BorderColor = Color.Red

          Dim myObjectFormat As ObjectFormat = myChartObject.ObjectFormat
          myObjectFormat.EnableCanGrow = False
          myObjectFormat.EnableSuppress = False
          myObjectFormat.EnableCloseAtPageBreak = True
          myObjectFormat.EnableKeepTogether = True
        End If
      End Sub
      
      private ChartObject GetChartObject(string reportObjectName)
      {
         ChartObject chart;

         chart =
            Report.ReportDefinition.ReportObjects[reportObjectName]
            as ChartObject;
         return chart;
      }

      private void UpdateChartObjectProperties(ReportDocument reportDocument, String chartObjectName, int top, int left, int height, int width)
      {
        ReportObject reportObject = reportDocument.ReportDefinition.ReportObjects[chartObjectName];
        if (reportObject != null && reportObject.Kind == ReportObjectKind.ChartObject)
        {
          ChartObject chartObject = (ChartObject)reportObject;
          chartObject.Top = top;
          chartObject.Left = left;
          chartObject.Height = height;
          chartObject.Width = width;

          Border border = chartObject.Border;
          border.BackgroundColor = Color.White;
          border.BorderColor = Color.Red;

          ObjectFormat objectFormat = chartObject.ObjectFormat;
          objectFormat.EnableCanGrow = false;
          objectFormat.EnableSuppress = false;
          objectFormat.EnableCloseAtPageBreak = true;
          objectFormat.EnableKeepTogether = true;
        }
      }
      

Inheritance Hierarchy

Object
   EngineObjectBase
      ReportObject
         ChartObject

Version Information

Crystal Reports Basic for Visual Studio 2008

Supported since: Crystal Reports for Visual Studio .NET 2002

See Also

Reference

ChartObject Members
CrystalDecisions.CrystalReports.Engine Namespace