Class ChartSymbolInfo
This class provides a StyleInfoSubObjectBase object for symbols associated with a ChartPoint.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Chart
Assembly: Syncfusion.Chart.Base.dll
Syntax
public class ChartSymbolInfo : ChartSubStyleInfoBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject
Constructors
ChartSymbolInfo()
Initializes a new instance of the ChartSymbolInfo class.
Declaration
public ChartSymbolInfo()
ChartSymbolInfo(StyleInfoSubObjectIdentity)
Initializes a new ChartSymbolInfo object and associates it with an existing StyleInfoSubObjectIdentity.
Declaration
public ChartSymbolInfo(StyleInfoSubObjectIdentity identity)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this ChartSymbolInfo. |
ChartSymbolInfo(StyleInfoSubObjectIdentity, ChartSymbolInfoStore)
Initializes a new instance of ChartSymbolInfo object and associates it with an existing StyleInfoSubObjectIdentity.
Declaration
public ChartSymbolInfo(StyleInfoSubObjectIdentity identity, ChartSymbolInfoStore store)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this ChartSymbolInfo. A ChartSymbolInfoStore that holds data for this ChartSymbolInfo. All changes made in this style object will be saved in the ChartSymbolInfoStore object. |
ChartSymbolInfoStore | store |
Properties
Border
Gets or sets the information that is to be used for drawing border.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartLineInfo Border { get; set; }
Property Value
Type | Description |
---|---|
ChartLineInfo | The border. |
Color
Gets or sets the color that is to be used with the symbol.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color Color { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Color | The color. |
Default
Gets a default ChartSymbolInfo that is to be used with a default style.
Declaration
public static ChartSymbolInfo Default { get; }
Property Value
Type |
---|
ChartSymbolInfo |
DimmedColor
Gets or sets the color of the dimmed symbol.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color DimmedColor { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Color | The color of the dimmed symbol. |
HasBorder
Gets a value indicating whether line information has been initialized for the current object.
Declaration
public bool HasBorder { get; }
Property Value
Type |
---|
System.Boolean |
HasColor
Gets a value indicating whether the symbol's color has been initialized.
Declaration
public bool HasColor { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasDimmedColor
Gets a value indicating whether this instance has dimmed color.
Declaration
public bool HasDimmedColor { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasHighlightColor
Gets a value indicating whether this instance has highlight color.
Declaration
public bool HasHighlightColor { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasImageIndex
Gets a value indicating whether the ImageIndex has been initialized.
Declaration
public bool HasImageIndex { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasMarker
Indicates whether the marker of the symbol has been initialized.
Declaration
public bool HasMarker { get; }
Property Value
Type |
---|
System.Boolean |
HasOffset
Gets a value indicating whether the offset of the symbol has been initialized.
Declaration
public bool HasOffset { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasShape
Gets a value indicating whether the style has been initialized.
Declaration
public bool HasShape { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasSize
Gets a value indicating whether the size of the symbol has been initialized.
Declaration
public bool HasSize { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HighlightColor
Gets or sets the color of the highlighted symbol.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color HighlightColor { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Color | The color of the highlighted symbol. |
ImageIndex
Gets or sets the image index that is to be used to access the image from the associated ChartStyleInfo object's ImageList.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public int ImageIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The index of the image. |
Marker
Gets or sets the marker of the symbol.
Declaration
public ChartMarker Marker { get; set; }
Property Value
Type |
---|
ChartMarker |
Offset
Gets or sets the offset of the symbol.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public Size Offset { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Size | The offset. |
Shape
Gets or sets the style of the symbol that is to be displayed.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartSymbolShape Shape { get; set; }
Property Value
Type |
---|
ChartSymbolShape |
Size
Gets or sets the size of the symbol.
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public Size Size { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Size | The size. |
Methods
CreateSubObjectIdentity(StyleInfoProperty)
Override this method to create a product-specific identity object for a sub object.
Declaration
public override StyleInfoSubObjectIdentity CreateSubObjectIdentity(StyleInfoProperty sip)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoProperty | sip |
Returns
Type | Description |
---|---|
StyleInfoSubObjectIdentity | An identity object for a subobject of this style. |
Overrides
Dispose()
Method to dispose ChartSymbolInfo object
Declaration
public void Dispose()
GetDefaultStyle()
Returns Default.
Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type | Description |
---|---|
StyleInfoBase | A ChartSymbolInfo object with default values. |
Overrides
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
ResetBorder()
Resets line information.
Declaration
public void ResetBorder()
ResetColor()
Resets the symbol's color.
Declaration
public void ResetColor()
ResetDimmedColor()
Resets the color of the dimmed.
Declaration
public void ResetDimmedColor()
ResetHighlightColor()
Resets the color of the highlighted symbol.
Declaration
public void ResetHighlightColor()
ResetImageIndex()
Resets the image index.
Declaration
public void ResetImageIndex()
ResetMarker()
Resets the marker.
Declaration
public void ResetMarker()
ResetOffset()
Resets the offset.
Declaration
public void ResetOffset()
ResetShape()
Resets the symbol style.
Declaration
public void ResetShape()
ResetSize()
Resets the size.
Declaration
public void ResetSize()