Class ChartRelatedPointInfo
For certain chart types such as Gantt charts, it is required to have relationships between points. These are called 'Related Points'. This class represents such related points.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Chart
Assembly: Syncfusion.Chart.Base.dll
Syntax
public class ChartRelatedPointInfo : ChartSubStyleInfoBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject
Constructors
ChartRelatedPointInfo()
Initializes a new instance of the ChartRelatedPointInfo class.
Declaration
public ChartRelatedPointInfo()
ChartRelatedPointInfo(StyleInfoSubObjectIdentity)
Initializes a new ChartRelatedPointInfo object and associates it with an existing StyleInfoSubObjectIdentity.
Declaration
public ChartRelatedPointInfo(StyleInfoSubObjectIdentity identity)
Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this ChartRelatedPointInfo. |
ChartRelatedPointInfo(StyleInfoSubObjectIdentity, ChartRelatedPointInfoStore)
Initializes a new ChartRelatedPointInfo object and associates it with an existing StyleInfoSubObjectIdentity.
Declaration
public ChartRelatedPointInfo(StyleInfoSubObjectIdentity identity, ChartRelatedPointInfoStore store)
Parameters
| Type | Name | Description |
|---|---|---|
| StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this ChartRelatedPointInfo. A ChartRelatedPointInfoStore that holds data for this ChartRelatedPointInfo. All changes made in this style object will be saved in the ChartRelatedPointInfo object. |
| ChartRelatedPointInfoStore | store |
Properties
Alignment
Gets or sets the pen alignment that is to be used for any visual representation.
Declaration
public PenAlignment Alignment { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Drawing.Drawing2D.PenAlignment | The alignment. |
Border
Gets or sets the border that is to be used for any visual representation linking this related point with others.
Declaration
public ChartRelatedPointLineInfo Border { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartRelatedPointLineInfo | The border. |
Color
Gets or sets the color that is to be used for any visual representation.
Declaration
public Color Color { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Drawing.Color | The color. |
Count
Gets the number of points.
Declaration
public int Count { get; }
Property Value
| Type |
|---|
| System.Int32 |
DashPattern
Gets or sets the dash pattern that is to be used for any visual representation.
Declaration
public float[] DashPattern { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single[] | The dash pattern. |
DashStyle
Gets or sets the dash style that is to be used for any visual representation.
Declaration
public DashStyle DashStyle { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Drawing.Drawing2D.DashStyle | The dash style. |
Default
Returns a default ChartRelatedPointInfo that is to be used with a default style.
Declaration
public static ChartRelatedPointInfo Default { get; }
Property Value
| Type |
|---|
| ChartRelatedPointInfo |
Remarks
The Default of the ChartStyleInfo class will return the default border info that this method generates through its overridden version of Syncfusion.Windows.Forms.Chart.ChartRelatedPointInfo.GetDefaultStyle.
EndSymbol
Gets or sets the end symbol that is to be used for any visual representation linking this related point with others.
Declaration
public ChartRelatedPointSymbolInfo EndSymbol { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartRelatedPointSymbolInfo | The end symbol. |
GdipPen
Gets the GDI+ pen.
Declaration
public Pen GdipPen { get; }
Property Value
| Type | Description |
|---|---|
| System.Drawing.Pen | The GDI+ pen. |
HasAlignment
Gets a value indicating whether the Alignment property has been initialized.
Declaration
public bool HasAlignment { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
HasBorder
Gets a value indicating whether the Border property has been initialized.
Declaration
public bool HasBorder { 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 |
|
HasEndSymbol
Gets a value indicating whether the EndSymbol property has been initialized.
Declaration
public bool HasEndSymbol { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
HasPoints
Gets a value indicating whether the Points property has been initialized.
Declaration
public bool HasPoints { get; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
HasStartSymbol
Gets a value indicating whether the StartSymbol property has been initialized.
Declaration
public bool HasStartSymbol { 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 |
|
Points
Gets or sets an array of indices of related points.
Declaration
public int[] Points { get; set; }
Property Value
| Type |
|---|
| System.Int32[] |
StartSymbol
Gets or sets the start symbol that is to be used for any visual representation linking this related point with others.
Declaration
public ChartRelatedPointSymbolInfo StartSymbol { get; set; }
Property Value
| Type | Description |
|---|---|
| ChartRelatedPointSymbolInfo | The start symbol. |
Width
Gets or sets the width that is to be used for any visual representation.
Declaration
public float Width { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Single | The width. |
Methods
Dispose()
Clears all the resources used by the component.
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()
ResetBorder()
Resets the Border property.
Declaration
public void ResetBorder()
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()
ResetEndSymbol()
Resets the EndSymbol property.
Declaration
public void ResetEndSymbol()
ResetPoints()
Resets the Points property.
Declaration
public void ResetPoints()
ResetStartSymbol()
Resets the StartSymbol property.
Declaration
public void ResetStartSymbol()
ResetWidth()
Resets the Width property.
Declaration
public void ResetWidth()