Class ChartBorder

The ChartBorder class holds formatting information for the border associated with a point. ChartBordersInfo

Inheritance

System.Object

ChartBorder

Implements

System.Runtime.Serialization.ISerializable

Inherited Members

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.Windows.Forms.Chart

Assembly: Syncfusion.Chart.Base.dll

Syntax

public sealed class ChartBorder : ISerializable

Constructors

ChartBorder()

Initializes a new instance of the ChartBorder class.

Declaration

public ChartBorder()

ChartBorder(ChartBorderStyle)

Initializes a new instance of the ChartBorder class with the specified ChartBorderStyle.

Declaration

public ChartBorder(ChartBorderStyle style)

Parameters

Type	Name	Description
ChartBorderStyle	style	The line style that is to be applied to the border.

ChartBorder(ChartBorderStyle, Color)

Initializes a new instance of the ChartBorder class with the specified ChartBorderStyle and System.Drawing.Color.

Declaration

public ChartBorder(ChartBorderStyle style, Color color)

Parameters

Type	Name	Description
ChartBorderStyle	style	A ChartBorderStyle that is to be applied to the border.
System.Drawing.Color	color	A System.Drawing.Color specifying the color of the border.

ChartBorder(ChartBorderStyle, Color, ChartBorderWeight)

Initializes a new instance of the ChartBorder class with the specified ChartBorderStyle and System.Drawing.Color.

Declaration

public ChartBorder(ChartBorderStyle style, Color color, ChartBorderWeight weight)

Parameters

Type	Name	Description
ChartBorderStyle	style	A ChartBorderStyle that is to be applied to the border.
System.Drawing.Color	color	A System.Drawing.Color specifying the color of the border.
ChartBorderWeight	weight	A ChartBorderWeight specifying the thickness of the border.

Properties

Color

Specifies the color of the chart border. This value comes from the System.Drawing.Color enumeration.

Declaration

public Color Color { get; }

Property Value

Type	Description
System.Drawing.Color	The color.

IsEmpty

gets whether this ChartBorder is uninitialized.

Declaration

public bool IsEmpty { get; }

Property Value

Type	Description
System.Boolean	True if this instance is empty; otherwise, false.

Style

Gets what type of border line style this border has. This value comes from the ChartBorderStyle enumeration.

Declaration

public ChartBorderStyle Style { get; }

Property Value

Type	Description
ChartBorderStyle	The style.

Weight

Gets the weight of the border the chart. This value comes from the ChartBorderWeight enumeration.

Declaration

public ChartBorderWeight Weight { get; }

Property Value

Type	Description
ChartBorderWeight	The weight.

Width

Gets the width in pixels of the chart border.

Declaration

public int Width { get; }

Property Value

Type	Description
System.Int32	The width.

Methods

Clone()

Creates an exact copy of this object.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A ChartBorder object.

Compare(ChartBorder, ChartBorder)

The basic == operator.

Declaration

public static bool Compare(ChartBorder lhs, ChartBorder rhs)

Parameters

Type	Name	Description
ChartBorder	lhs	The left-hand side of the operator.
ChartBorder	rhs	The right-hand side of the operator.

Returns

Type	Description
System.Boolean	Boolean value.

Equals(Object)

Overridden. Returns True if the ChartBorder object passed is equal.

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
System.Object	o	The object to compare to.

Returns

Type	Description
System.Boolean	True if both are equal; false otherwise.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Overridden. Returns the hash code for the current ChartBorder instance.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current System.Object.

Overrides

System.Object.GetHashCode()

MakeBlackAndWhite()

Returns a copy of this border object replacing the color with System.Drawing.Color.Black.

Declaration

public ChartBorder MakeBlackAndWhite()

Returns

Type	Description
ChartBorder	A black colored ChartBorder.

ToString()

Returns a compact string representation of the ChartBorder. All information in ChartBorder will be encoded.

Declaration

public override string ToString()

Returns

Type	Description
System.String	A System.String that represents the current System.Object.

Overrides

System.Object.ToString()

ToString(String)

Returns a compact string representation of the ChartBorder. All information in ChartBorder will be encoded.

Declaration

public string ToString(string format)

Parameters

Type	Name	Description
System.String	format	Format in which string representation should be rendered. "compact" for compact text; default is full text version.

Returns

Type	Description
System.String	The String.

Operators

Equality(ChartBorder, ChartBorder)

The basic == operator.

Declaration

public static bool operator ==(ChartBorder lhs, ChartBorder rhs)

Parameters

Type	Name	Description
ChartBorder	lhs	The left-hand side of the operator.
ChartBorder	rhs	The right-hand side of the operator.

Returns

Type	Description
System.Boolean	Boolean value.

Inequality(ChartBorder, ChartBorder)

The basic != operator.

Declaration

public static bool operator !=(ChartBorder lhs, ChartBorder rhs)

Parameters

Type	Name	Description
ChartBorder	lhs	The left-hand side of the operator.
ChartBorder	rhs	The right-hand side of the operator.

Returns

Type	Description
System.Boolean	Boolean value.

Explicit Interface Implementations

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Implements the ISerializable interface and returns the data needed to serialize the ChartBorder.

Declaration

[SecurityCritical]
void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
System.Runtime.Serialization.SerializationInfo	info	A SerializationInfo object containing the information required to serialize the object.
System.Runtime.Serialization.StreamingContext	context	A StreamingContext object containing the source and destination of the serialized stream.

Implements

System.Runtime.Serialization.ISerializable