Class ChartStyleInfo

This class contains appearance information for each ChartPoint ChartPoint.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
StyleInfoBase
ChartStyleInfoBase
ChartStyleInfo
ChartBaseStyleInfo
Implements
System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable
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 class ChartStyleInfo : ChartStyleInfoBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable

Constructors

ChartStyleInfo()

Overloaded constructor. Initializes a new style object.

Declaration
public ChartStyleInfo()

ChartStyleInfo(StyleInfoIdentityBase)

Initializes a new style object and associates it with an existing Syncfusion.Windows.Forms.Chart.ChartStyleInfoIdentity.

Declaration
public ChartStyleInfo(StyleInfoIdentityBase identity)
Parameters
Type Name Description
StyleInfoIdentityBase identity

A Syncfusion.Windows.Forms.Chart.ChartStyleInfoIdentity that holds the identity for this ChartStyleInfo.

ChartStyleInfo(StyleInfoIdentityBase, ChartStyleInfoStore)

Initializes a new style object and associates it with an existing Syncfusion.Windows.Forms.Chart.ChartStyleInfoIdentity.

Declaration
public ChartStyleInfo(StyleInfoIdentityBase identity, ChartStyleInfoStore store)
Parameters
Type Name Description
StyleInfoIdentityBase identity

A Syncfusion.Windows.Forms.Chart.ChartStyleInfoIdentity that holds the identity for this ChartStyleInfo.
ChartStyleInfoStore store

A ChartStyleInfoStore that holds data for this ChartStyleInfo. All changes made in this style object will be saved in the ChartStyleInfoStore object.

ChartStyleInfo(ChartStyleInfo)

Initializes a new style object and copies all data from an existing style object.

Declaration
public ChartStyleInfo(ChartStyleInfo style)
Parameters
Type Name Description
ChartStyleInfo style

The style object that contains the original data.

ChartStyleInfo(ChartStyleInfoStore)

Initializes a new style object and associates it with an existing ChartStyleInfoStore.

Declaration
public ChartStyleInfo(ChartStyleInfoStore store)
Parameters
Type Name Description
ChartStyleInfoStore store

A ChartStyleInfoStore that holds data for this ChartStyleInfo. All changes made in this style object will be saved in the ChartStyleInfoStore object.

Properties

AltTagFormat

Gets or sets the alt tag with default settings that is to be used. this is used in ASP.NET chart to define the format of "alt" tag value. for the appearance of the ChartPoint.

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

BaseStyle

Gets or sets the base style with default settings that is to be used for the appearance of the ChartPoint.

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

Border

Gets or sets the information that is to be used for drawing lines.

Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartLineInfo Border { get; set; }
Property Value
Type Description
ChartLineInfo

The border.

Callout

Gets or sets the attributes of the Callout that is to be displayed at this point.

Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartCalloutInfo Callout { get; set; }
Property Value
Type Description
ChartCalloutInfo

The Callout.

CustomProperties

Returns a collection of custom property objects that have at least one initialized value. The primary purpose of this collection is to support design-time code serialization of custom properties.

Declaration
public ChartStyleInfoCustomPropertiesCollection CustomProperties { get; }
Property Value
Type Description
ChartStyleInfoCustomPropertiesCollection

Default

Returns a ChartStyleInfo with default settings.

Declaration
public static ChartStyleInfo Default { get; }
Property Value
Type Description
ChartStyleInfo

DimmedInterior

Gets or sets the attributes of the brush that are to be used to hide this point when the mouse moves over on other point.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public BrushInfo DimmedInterior { get; set; }
Property Value
Type Description
BrushInfo

DisplayShadow

Gets a value indicating whether a shadow should be rendered when this point is displayed.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool DisplayShadow { get; set; }
Property Value
Type Description
System.Boolean

true if [display shadow]; otherwise, false.

DisplayText

Gets or Sets whether text should be displayed at this point.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool DisplayText { get; set; }
Property Value
Type Description
System.Boolean

DrawTextShape

Gets or sets whether text should be draw with shape in the background at this point.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool DrawTextShape { get; set; }
Property Value
Type Description
System.Boolean

ElementBorders

Gets or sets the border settings for elements associated with the chart point. You can specify the inner and outer border. It is currently used only by symbols rendered by the ChartPoint.

Declaration
[Obsolete("This property isn't used anymore. Use the Symbol.Border property.")]
public ChartBordersInfo ElementBorders { get; set; }
Property Value
Type Description
ChartBordersInfo

Font

Gets /sets the font that is to be used for drawing text.

Declaration
public ChartFontInfo Font { get; set; }
Property Value
Type Description
ChartFontInfo

The font.

Format

Gets or sets the stringformat.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public StringFormat Format { get; set; }
Property Value
Type Description
System.Drawing.StringFormat

The format.

GdipFont

Creates or returns a cached GDI+ font generated from font information of the Font object.

Declaration
public Font GdipFont { get; }
Property Value
Type Description
System.Drawing.Font

The gdip font.

GdipPen

Creates or returns a cached GDI+ font generated from font information of the Font object.

Declaration
public Pen GdipPen { get; }
Property Value
Type Description
System.Drawing.Pen

The gdip pen.

HasBaseStyle

Gets a value indicating whether this instance has base style.

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

true if this instance has base style; otherwise, false.

HasBorder

Gets a value indicating whether line information has been initialized for the current object.

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

true if this instance has border; otherwise, false.

HasCallout

Gets a value indicating whether Callout information has been initialized for the current object.

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

true if this instance has Callout; otherwise, false.

HasDimmedInterior

Gets a value indicating whether this style contains the local value of DimmedInterior property.

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

true if this instance contains the local value of DimmedInterior property; otherwise, false.

HasDisplayShadow

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

HasDisplayText

Gets a value indicating whether this style contains the local value of DisplayText property.

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

true if this instance contains the local value of DisplayText property; otherwise, false.

HasElementBorders

Gets a value indicating whether this style contains the local value of ElementBorders property.

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

true if this instance contains the local value of ElementBorders property; otherwise, false.

HasFont

Gets a value indicating whether font information has been initialized for the current object.

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

true if this instance has font; otherwise, false.

HasFormat

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

HasHighlightInterior

Gets a value indicating whether this style contains the local value of HighlightInterior property.

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

true if this instance contains the local value of HighlightInterior property; otherwise, false.

HasHighlightOnMouseOver

Gets a value indicating whether this style contains the local value of HighlightOnMouseOver property.

Declaration
[Obsolete("This property isn't used anymore.")]
public bool HasHighlightOnMouseOver { get; }
Property Value
Type Description
System.Boolean

true if this instance contains the local value of HighlightOnMouseOver property; otherwise, false.

HasHitTestRadius

Gets a value indicating whether this style contains the local value of HitTestRadius property.

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

true if this instance contains the local value of HitTestRadius property; otherwise, false.

HasImageIndex

Gets a value indicating whether image index information has been initialized for the current object.

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

HasImages

Gets a value indicating whether ImageList information has been initialized for the current object.

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

HasInterior

Gets a value indicating whether interior information has been initialized for the current object.

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

true if this instance has interior; otherwise, false.

HasLabel

Gets a value indicating whether this style contains the local value of Label property.

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

true if this instance contains the local value of Label property; otherwise, false.

HasPointWidth

Gets a value indicating whether this style contains the local value of PointWidth property.

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

true if this instance contains the local value of PointWidth property; otherwise, false.

HasRelatedPoints

Gets a value indicating whether this instance has related points.

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

true if this instance has related points; otherwise, false.

HasShadowInterior

Gets a value indicating whether this style contains the local value of ShadowInterior property.

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

true if this instance contains the local value of ShadowInterior property; otherwise, false.

HasShadowOffset

Gets a value indicating whether this style contains the local value of ShadowOffset property.

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

true if this instance contains the local value of ShadowOffset property; otherwise, false.

HasSymbol

Gets a value indicating whether symbol information has been initialized for the current object.

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

true if this instance has symbol; otherwise, false.

HasText

Gets a value indicating whether text information has been initialized for the current object.

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

true if this instance has text; otherwise, false.

HasTextColor

Gets a value indicating whether this instance has text color.

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

true if this instance has text color; otherwise, false.

HasTextFormat

Gets a value indicating whether this style contains the local value of TextFormat property.

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

true if this instance contains the local value of TextFormat property; otherwise, false.

HasTextOffset

Gets a value indicating whether this style contains the local value of TextOffset property.

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

true if this instance contains the local value of TextOffset property; otherwise, false.

HasTextOrientation

Gets a value indicating whether this instance has text orientation.

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

true if this instance has text orientation; otherwise, false.

HasToolTip

Gets a value indicating whether ToolTip information has been initialized for the current object.

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

true if this instance has tool tip; otherwise, false.

HasToolTipFormat

Gets a value indicating whether this instance has tool tip format.

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

true if this instance has tool tip format; otherwise, false.

HasUrl

Gets a value indicating whether Url information has been initialized for the current object.

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

true if this instance has Url; otherwise, false.

HighlightInterior

Gets or sets the attributes of the brush that are to be used to highlight this point when the mouse moves over it and HasHighlightOnMouseOver is enabled.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public BrushInfo HighlightInterior { get; set; }
Property Value
Type Description
BrushInfo

HighlightOnMouseOver

Gets a value indicating whether this point should be highlighted when the mouse moves over it.

Declaration
[Obsolete("This property isn't used anymore.")]
public bool HighlightOnMouseOver { get; set; }
Property Value
Type Description
System.Boolean

HitTestRadius

Controls the circle around this point that would be considered as being within the bounds of this point for hit-testing purposes.

Declaration
public float HitTestRadius { get; set; }
Property Value
Type Description
System.Single

ImageIndex

Gets or sets the image index from the associated System.Windows.Forms.ImageList property.

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

The index of the image.

Images

Gets or sets the imagelist that is to be associated with this ChartPoint. This property is used in conjunction with the ImageIndex property to display images associated with this point.

Declaration
[ChartTemplate(ChartTemplateSet.Collection)]
public ChartImageCollection Images { get; set; }
Property Value
Type Description
ChartImageCollection

The images.

Interior

Gets or sets a solid backcolor, gradient or pattern style with both back and forecolor for a ChartPoint's background.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public BrushInfo Interior { get; set; }
Property Value
Type Description
BrushInfo

The interior.

Label

Gets or sets the Label value.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string Label { get; set; }
Property Value
Type Description
System.String

PointWidth

Gets or sets the width of this point relative to the total width available. It is specially useful with Gantt charts to render series that overlap.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float PointWidth { get; set; }
Property Value
Type Description
System.Single

RelatedPoints

Gets or sets the offset of the text from the position of the ChartPoint.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartRelatedPointInfo RelatedPoints { get; set; }
Property Value
Type Description
ChartRelatedPointInfo

ShadowInterior

Gets or sets the interior attributes of the shadow displayed underneath this point.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public BrushInfo ShadowInterior { get; set; }
Property Value
Type Description
BrushInfo

ShadowOffset

Gets or sets the offset that is to be used when a shadow is rendered for this ChartPoint.

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

Store

Gets the ChartStyleInfoStore object that holds all the data for this style object.

Declaration
public ChartStyleInfoStore Store { get; }
Property Value
Type Description
ChartStyleInfoStore

Symbol

Gets or sets the attributes of the symbol that is to be displayed at this point.

Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartSymbolInfo Symbol { get; set; }
Property Value
Type Description
ChartSymbolInfo

The symbol.

Text

Gets or sets the text that is to be associated with a ChartPoint. This text will be rendered at a position near the point if DisplayText is set to True.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string Text { get; set; }
Property Value
Type Description
System.String

The text.

TextColor

Gets or sets the color of the text that is to be rendered for a ChartPoint.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color TextColor { get; set; }
Property Value
Type Description
System.Drawing.Color

TextFormat

Gets or sets the format that is to be applied to values that are displayed as text.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string TextFormat { get; set; }
Property Value
Type Description
System.String

TextOffset

Gets or sets the offset of the text from the position of the ChartPoint.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float TextOffset { get; set; }
Property Value
Type Description
System.Single

TextOrientation

Gets or sets the orientation of text that is to be displayed at this point.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public ChartTextOrientation TextOrientation { get; set; }
Property Value
Type Description
ChartTextOrientation

TextShape

Gets or sets custom shape in the background of the displaytext. Before use this, enable "DrawTextShape" property of series style.

Declaration
public ChartCustomShapeInfo TextShape { get; set; }
Property Value
Type Description
ChartCustomShapeInfo

ToolTip

Gets or sets the ToolTip that is to be associated with the ChartPoint.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string ToolTip { get; set; }
Property Value
Type Description
System.String

The tool tip.

ToolTipFormat

Gets or sets the formatting that is to be applied to values that are displayed as ToolTips.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string ToolTipFormat { get; set; }
Property Value
Type Description
System.String

The tool tip format.

Url

Gets or sets the Url that is to be associated with a ChartPoint. This Url will be applied to the point if EnableUrl and CalcRegion property is set to True.This property is applicable only for ChartWeb.

Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string Url { get; set; }
Property Value
Type Description
System.String

The Url.

Methods

CopyFrom(IStyleInfo)

Copies properties from another style object. This method raises Changing and Changed notifications if the other object differs. (ModifyStyle does not raise these events).

Declaration
public void CopyFrom(IStyleInfo iStyle)
Parameters
Type Name Description
IStyleInfo iStyle

The style object to be applied on the current object.

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 ChartStyleInfo object

Declaration
public void Dispose()

ResetBaseStyle()

Resets the base style.

Declaration
public void ResetBaseStyle()

ResetBorder()

Resets line information.

Declaration
public void ResetBorder()

ResetCallout()

Resets Callout information.

Declaration
public void ResetCallout()

ResetDimmedInterior()

Resets DimmedInterior.

Declaration
public void ResetDimmedInterior()

ResetDisplayShadow()

Resets DisplayShadow.

Declaration
public void ResetDisplayShadow()

ResetDisplayText()

Resets DisplayText.

Declaration
public void ResetDisplayText()

ResetElementBorders()

Resets border information.

Declaration
public void ResetElementBorders()

ResetFont()

Resets font information.

Declaration
public void ResetFont()

ResetFormat()

Resets the Format.

Declaration
public void ResetFormat()

ResetHighlightInterior()

Declaration
public void ResetHighlightInterior()

ResetHighlightOnMouseOver()

Declaration
[Obsolete("This method isn't used anymore.")]
public void ResetHighlightOnMouseOver()

ResetHihglightInterior()

Declaration
[Obsolete("Use ResetHighlightInterior")]
public void ResetHihglightInterior()

ResetHitTestRadius()

Resets HitTestRadius.

Declaration
public void ResetHitTestRadius()

ResetImageIndex()

Resets image index information.

Declaration
public void ResetImageIndex()

ResetImages()

Resets ImageList information.

Declaration
public void ResetImages()

ResetInterior()

Resets interior information.

Declaration
public void ResetInterior()

ResetLabel()

Resets Label.

Declaration
public void ResetLabel()

ResetName()

Resets Name.

Declaration
public void ResetName()

ResetPointWidth()

Resets PointWidth.

Declaration
public void ResetPointWidth()

ResetRelatedPoints()

Resets RelatedPoints.

Declaration
public void ResetRelatedPoints()

ResetShadowInterior()

Resets ShadowInterior.

Declaration
public void ResetShadowInterior()

ResetShadowOffset()

Resets ShadowOffset.

Declaration
public void ResetShadowOffset()

ResetSymbol()

Resets symbol information.

Declaration
public void ResetSymbol()

ResetSystem()

Resets System.

Declaration
public void ResetSystem()

ResetText()

Resets text information.

Declaration
public void ResetText()

ResetTextColor()

Resets TextColor.

Declaration
public void ResetTextColor()

ResetTextFormat()

Resets TextFormat.

Declaration
public void ResetTextFormat()

ResetTextOffset()

Reset TextOffset.

Declaration
public void ResetTextOffset()

ResetTextOrientation()

Resets TextOrientation.

Declaration
public void ResetTextOrientation()

ResetToolTip()

Resets ToolTip information.

Declaration
public void ResetToolTip()

ResetToolTipFormat()

Resets TooltipFormat.

Declaration
public void ResetToolTipFormat()

ResetUrl()

Resets Url information.

Declaration
public void ResetUrl()

WriteXmlSchema(XmlWriter)

Serializes this style to XML.

Declaration
public void WriteXmlSchema(XmlWriter xw)
Parameters
Type Name Description
System.Xml.XmlWriter xw

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable