Class ChartLineInfo
Provides a StyleInfoSubObjectBase object for border line settings associated with a point. Properties that have not been initialized will inherit default values from a base style.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Chart
Assembly: Syncfusion.Chart.Base.dll
Syntax
public class ChartLineInfo : ChartSubStyleInfoBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObjectConstructors
ChartLineInfo()
Overloaded. Constructor.
Declaration
public ChartLineInfo()ChartLineInfo(StyleInfoSubObjectIdentity)
Initializes a new ChartLineInfo object and associates it with an existing StyleInfoSubObjectIdentity.
Declaration
public ChartLineInfo(StyleInfoSubObjectIdentity identity)Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this ChartLineInfo. |
ChartLineInfo(StyleInfoSubObjectIdentity, ChartLineInfoStore)
Initializes a new ChartLineInfo object and associates it with an existing StyleInfoSubObjectIdentity.
Declaration
public ChartLineInfo(StyleInfoSubObjectIdentity identity, ChartLineInfoStore store)Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this ChartLineInfo. A ChartLineInfoStore that holds data for this ChartLineInfo. All changes made in this style object will be saved in the ChartLineInfoStore object. |
| ChartLineInfoStore | store |
Properties
Alignment
Gets or sets the pen alignment of the line represented by this object.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public PenAlignment Alignment { get; set; }Property Value
| Type | Description |
|---|---|
| System.Drawing.Drawing2D.PenAlignment | The alignment. |
Color
Gets or sets the color of the line. For line based charts it works only when 3D is enabled.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color Color { get; set; }Property Value
| Type | Description |
|---|---|
| System.Drawing.Color | The color. |
DashPattern
Gets or sets the dash pattern of the line represented by this object.
Declaration
[ChartTemplate(ChartTemplateSet.Collection)]
public float[] DashPattern { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single[] | The dash pattern. |
DashStyle
Gets or sets the style of the line represented by this object. DashStyle
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public DashStyle DashStyle { get; set; }Property Value
| Type | Description |
|---|---|
| System.Drawing.Drawing2D.DashStyle | The dash style. |
Default
Gets a default ChartLineInfo to be used with a default style.
Declaration
public static ChartLineInfo Default { get; }Property Value
| Type | Description |
|---|---|
| ChartLineInfo | The default. |
Remarks
The Default of the ChartStyleInfo class will return the default line info that this method generates through its overridden version of Syncfusion.Windows.Forms.Chart.ChartLineInfo.GetDefaultStyle.
GdipPen
Gets pen associated with style.
Declaration
public Pen GdipPen { get; }Property Value
| Type | Description |
|---|---|
| System.Drawing.Pen | The gdip pen. |
HasAlignment
Gets a value indicating whether the Alignment property has been initialized.
Declaration
public bool HasAlignment { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
HasColor
Gets a value indicating whether the Color property has been initialized.
Declaration
public bool HasColor { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
HasDashPattern
Gets a value indicating whether the DashPattern property has been initialized.
Declaration
public bool HasDashPattern { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
HasDashStyle
Gets a value indicating whether the DashStyle property has been initialized.
Declaration
public bool HasDashStyle { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
HasWidth
Gets a value indicating whether the Width property has been initialized.
Declaration
public bool HasWidth { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
Width
Gets or sets the width in pixels of the line represented by this object.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float Width { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single | The width. |
Methods
CreateDefault()
Resets the changes made in the ChartLineInfo class.
Declaration
public static ChartLineInfo CreateDefault()Returns
| Type | Description |
|---|---|
| ChartLineInfo | Returns default ChartLineInfo. |
Dispose()
Method to dispose ChartLineInfo object
Declaration
public void Dispose()MakeCopy(StyleInfoBase, StyleInfoProperty)
Makes an exact copy of the current object.
Declaration
public override IStyleInfoSubObject MakeCopy(StyleInfoBase newOwner, StyleInfoProperty sip)Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoBase | newOwner | The new owner style object for the copied object. |
| StyleInfoProperty | sip | The identifier for this object. |
Returns
| Type | Description |
|---|---|
| IStyleInfoSubObject | A copy of the current object registered with the new owner style object. |
Overrides
ResetAlignment()
Resets the Alignment property.
Declaration
public void ResetAlignment()ResetColor()
Resets the Color property.
Declaration
public void ResetColor()ResetDashPattern()
Resets the DashPattern property.
Declaration
public void ResetDashPattern()ResetDashStyle()
Resets the DashStyle property.
Declaration
public void ResetDashStyle()ResetWidth()
Resets the Width property.
Declaration
public void ResetWidth()