Class ChartCalloutInfo
This class provides a StyleInfoSubObjectBase object for callout associated with a ChartPoint.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Chart
Assembly: Syncfusion.Chart.Base.dll
Syntax
public class ChartCalloutInfo : ChartSubStyleInfoBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject
Constructors
ChartCalloutInfo()
Initializes a new instance of the ChartCalloutInfo class.
Declaration
public ChartCalloutInfo()
ChartCalloutInfo(StyleInfoSubObjectIdentity)
Initializes a new ChartCalloutInfo object and associates it with an existing StyleInfoSubObjectIdentity.
Declaration
public ChartCalloutInfo(StyleInfoSubObjectIdentity identity)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this ChartCalloutInfo. |
ChartCalloutInfo(StyleInfoSubObjectIdentity, ChartCalloutInfoStore)
Initializes a new instance of ChartCalloutInfo object and associates it with an existing StyleInfoSubObjectIdentity.
Declaration
public ChartCalloutInfo(StyleInfoSubObjectIdentity identity, ChartCalloutInfoStore store)
Parameters
Type | Name | Description |
---|---|---|
StyleInfoSubObjectIdentity | identity | A StyleInfoSubObjectIdentity that holds the identity for this ChartCalloutInfo. A ChartCalloutInfoStore that holds data for this ChartCalloutInfo. All changes made in this style object will be saved in the ChartCalloutInfoStore object. |
ChartCalloutInfoStore | 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 callout.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color Color { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Color | The color. |
Default
Gets a default ChartCalloutInfo that is to be used with a default style.
Declaration
public static ChartCalloutInfo Default { get; }
Property Value
Type |
---|
ChartCalloutInfo |
DisplayTextAndFormat
Gets or sets the textFormat that is to be associated with a ChartPoint. This text will be rendered with prefix or sufix text with the format of {0},{1},{2}
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public string DisplayTextAndFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String | The text. |
Enable
Gets or sets the boolean value that is to be used with the callout.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public bool Enable { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The Enable. |
Font
Gets or sets the font that is to be associated with a ChartPoint. This font will be rendered at a position near the point if
Declaration
[ChartTemplate(ChartTemplateSet.Content)]
public ChartFontInfo Font { get; set; }
Property Value
Type | Description |
---|---|
ChartFontInfo | The font. |
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 callout's color has been initialized.
Declaration
public bool HasColor { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasDisplayTextAndFormat
Gets a value indicating whether textFormat information has been initialized for the current object.
Declaration
public bool HasDisplayTextAndFormat { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasEnable
Gets a value indicating whether the callout feature is enabled.
Declaration
public bool HasEnable { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
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 |
|
HasOffsetX
Gets a value indicating whether OffsetX information has been initialized for the current object.
Declaration
public bool HasOffsetX { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasOffsetY
Gets a value indicating whether OffsetY information has been initialized for the current object.
Declaration
public bool HasOffsetY { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasPosition
Gets a value indicating whether this instance has text Position.
Declaration
public bool HasPosition { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasTextColor
Gets a value indicating whether the callout's text color has been initialized.
Declaration
public bool HasTextColor { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HasTextOffset
Gets a value indicating whether TextOffset information has been initialized for the current object.
Declaration
public bool HasTextOffset { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
|
HiddenX
This is associated with the label position placement on mouse dragging.
Declaration
public float HiddenX { get; set; }
Property Value
Type | Description |
---|---|
System.Single | duplicate value. |
HiddenY
This is associated with the label position placement on mouse dragging.
Declaration
public float HiddenY { get; set; }
Property Value
Type | Description |
---|---|
System.Single | duplicate value. |
IsDragged
This is associated with the label placement on mouse dragging.
Declaration
public bool IsDragged { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | duplicate value. |
OffsetX
This is associated with a Text property and used for internal purpose. OffsetX offset for text.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float OffsetX { get; set; }
Property Value
Type | Description |
---|---|
System.Single | OffsetX value. |
OffsetY
This is associated with a Text property and used for internal purpose. OffsetY offset for text.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float OffsetY { get; set; }
Property Value
Type | Description |
---|---|
System.Single | OffsetY value. |
Position
Gets or sets the Position of text that is to be displayed at this point.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public LabelPosition Position { get; set; }
Property Value
Type |
---|
LabelPosition |
Text
This is associated with a Text property and used for internal purpose. Text duplicate for displaytextandformat.
Declaration
public string Text { get; set; }
Property Value
Type | Description |
---|---|
System.String | duplicate value. |
TextColor
Gets or sets the text color that is to be used with the callout.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public Color TextColor { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Color | The text color. |
TextOffset
This is associated with a Text property and used for internal purpose. TextOffset offset for text.
Declaration
[ChartTemplate(ChartTemplateSet.Simple)]
public float TextOffset { get; set; }
Property Value
Type | Description |
---|---|
System.Single | TextOffset value. |
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 ChartCalloutInfo 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
ResetBorder()
Resets line information.
Declaration
public void ResetBorder()
ResetColor()
Resets the callout's color.
Declaration
public void ResetColor()
ResetDisplayTextAndFormat()
Resets textFormat information.
Declaration
public void ResetDisplayTextAndFormat()
ResetEnable()
Resets enable calloutr.
Declaration
public void ResetEnable()
ResetFont()
Resets Font information.
Declaration
public void ResetFont()
ResetOffsetX()
Resets OffsetX information.
Declaration
public void ResetOffsetX()
ResetOffsetY()
Resets OffsetY information.
Declaration
public void ResetOffsetY()
ResetTextColor()
Resets the callout's text color.
Declaration
public void ResetTextColor()
ResetTextOffset()
Resets TextOffset information.
Declaration
public void ResetTextOffset()