Class ChartRegion

The Chart Region represents a region on the client area of the Chart control that has a ToolTip. It can be a point region. A point region is a region that represents the visual appearance of a point. For example, the Rectangle of a point. When the ChartRegion represents a chart point, IsChartPoint is set to True.

Inheritance
System.Object
ChartRegion
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.Windows.Forms.Chart
Assembly: Syncfusion.Chart.Base.dll
Syntax
public class ChartRegion

Constructors

ChartRegion(Region, ChartRegionData)

Initializes a new instance of the ChartRegion class.

Declaration
public ChartRegion(Region region, ChartRegionData data)
Parameters
Type Name Description
System.Drawing.Region region

The region.
ChartRegionData data

The data.

ChartRegion(Region, ChartRegionType, String, Int32, String)

Initializes a new instance of the ChartRegion class.

Declaration
public ChartRegion(Region region, ChartRegionType regionType, string toolTip, int index, string description)
Parameters
Type Name Description
System.Drawing.Region region

The region.
ChartRegionType regionType

Type of the region.
System.String toolTip

The tool tip.
System.Int32 index

Axis index.
System.String description

The description.

ChartRegion(Region, ChartRegionType, String, String)

Initializes a new instance of the ChartRegion class.

Declaration
public ChartRegion(Region region, ChartRegionType regionType, string toolTip, string description)
Parameters
Type Name Description
System.Drawing.Region region

The region.
ChartRegionType regionType

Type of the region.
System.String toolTip

The tool tip.
System.String description

The description.

ChartRegion(Region, RectangleF, ChartRegionType, PointF, Int32, Int32, String)

Initializes a new instance of the ChartRegion class.

Declaration
public ChartRegion(Region region, RectangleF bounds, ChartRegionType regionType, PointF pt, int seriesIndex, int index, string description)
Parameters
Type Name Description
System.Drawing.Region region

The region.
System.Drawing.RectangleF bounds

The rectangle bounds.
ChartRegionType regionType

Type of the region.
System.Drawing.PointF pt
System.Int32 seriesIndex

Series Index.
System.Int32 index
System.String description

The description.

ChartRegion(Region, Int32, Int32, String, String)

Initializes a new instance of the ChartRegion class.

Declaration
public ChartRegion(Region region, int seriesIndex, int pointIndex, string toolTip, string description)
Parameters
Type Name Description
System.Drawing.Region region

The region.
System.Int32 seriesIndex

Index of the series.
System.Int32 pointIndex

Index of the point.
System.String toolTip

The tool tip.
System.String description

The description.

ChartRegion(Region, Int32, String, String)

Initializes a new instance of the ChartRegion class.

Declaration
public ChartRegion(Region region, int seriesIndex, string toolTip, string description)
Parameters
Type Name Description
System.Drawing.Region region

The region.
System.Int32 seriesIndex

Index of the series.
System.String toolTip

The tool tip.
System.String description

The description.

ChartRegion(Region, String, String)

Initializes a new instance of the ChartRegion class.

Declaration
public ChartRegion(Region region, string toolTip, string description)
Parameters
Type Name Description
System.Drawing.Region region

The region.
System.String toolTip

The tool tip.
System.String description

The description.

Properties

AxisIndex

Returns the index value of the axis that has this region.

Declaration
public int AxisIndex { get; }
Property Value
Type Description
System.Int32

The index of the axis.

AxisLabelIndex

Declaration
public int AxisLabelIndex { get; }
Property Value
Type Description
System.Int32

AxisLabelText

Declaration
public string AxisLabelText { get; }
Property Value
Type Description
System.String

Bounds

Returns the bounds of the rectangle

Declaration
public RectangleF Bounds { get; }
Property Value
Type Description
System.Drawing.RectangleF

The bounds value.

Description

Returns the description for this region.

Declaration
public string Description { get; }
Property Value
Type Description
System.String

The description.

IsChartPoint

Indicates whether the region represents a chart point.

Declaration
public bool IsChartPoint { get; }
Property Value
Type Description
System.Boolean

true if this instance is chart point; otherwise, false.

PointIndex

Gets the index of the point.

Declaration
public int PointIndex { get; }
Property Value
Type Description
System.Int32

The index of the point.

PointXY

Returns the index value of the axis that has this region.

Declaration
public PointF PointXY { get; }
Property Value
Type Description
System.Drawing.PointF

The index of the axis.

Region

Gets or sets the actual region that has the ToolTip.

Declaration
public Region Region { get; set; }
Property Value
Type Description
System.Drawing.Region

The region.

SeriesIndex

Returns the index value of the series that has this region.

Declaration
public int SeriesIndex { get; }
Property Value
Type Description
System.Int32

The index of the series.

ToolTip

Gets or sets the ToolTip of the region.

Declaration
public string ToolTip { get; set; }
Property Value
Type Description
System.String

The tool tip.

Type

Indicates whether the region represents a chart point.

Declaration
public ChartRegionType Type { get; }
Property Value
Type Description
ChartRegionType

The type.

Methods

Dispose()

Method to dispose ChartRegion objects.

Declaration
public void Dispose()

Finalize()

Declaration
protected void Finalize()

Extension Methods