Class ChartDataLabelsImpl
Represents a collection of chart data labels.
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Charts
Assembly: Syncfusion.XlsIO.NET.dll
Syntax
public class ChartDataLabelsImpl : CommonObject, IDisposable, IChartDataLabels, ISerializable, IInternalChartTextArea, IChartTextArea, IInternalFont, IFont, IParentApplication, IOptimizedUpdate
Constructors
ChartDataLabelsImpl(IApplication, Object, Int32)
Initializes new instance of data label and sets its parent and application objects.
Declaration
public ChartDataLabelsImpl(IApplication application, object parent, int index)
Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object. |
| System.Object | parent | Parent object |
| System.Int32 | index | Data point index. |
Properties
BackgroundMode
Display mode of the background.
Declaration
public ExcelChartBackgroundMode BackgroundMode { get; set; }
Property Value
| Type |
|---|
| ExcelChartBackgroundMode |
Bold
True if the font is bold. Read / write Boolean.
Declaration
public bool Bold { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Color
Returns or sets the primary color of the object. Read / write ExcelKnownColors.
Declaration
public ExcelKnownColors Color { get; set; }
Property Value
| Type |
|---|
| ExcelKnownColors |
ColorObject
Data labels color. Read-only.
Declaration
public ColorObject ColorObject { get; }
Property Value
| Type |
|---|
| ColorObject |
Delimiter
Gets or sets the variant representing the separator used for data labels on the chart.
Declaration
public string Delimiter { get; set; }
Property Value
| Type |
|---|
| System.String |
Font
Returns FontImpl for current font. Read-only.
Declaration
public FontImpl Font { get; }
Property Value
| Type |
|---|
| FontImpl |
FontName
Returns or sets the font name. Read / write string.
Declaration
public string FontName { get; set; }
Property Value
| Type |
|---|
| System.String |
Format
Gets corresponding data format. Read-only.
Declaration
public ChartSerieDataFormatImpl Format { get; }
Property Value
| Type |
|---|
| ChartSerieDataFormatImpl |
FrameFormat
Return format of the text area.
Declaration
public IChartFrameFormat FrameFormat { get; }
Property Value
| Type |
|---|
| IChartFrameFormat |
HasTextRotation
Gets value indicating whether TextRotation was changed. Read-only.
Declaration
public bool HasTextRotation { get; }
Property Value
| Type |
|---|
| System.Boolean |
Index
Returns font index. Read-only.
Declaration
public int Index { get; }
Property Value
| Type |
|---|
| System.Int32 |
IsAutoColor
Indicates whether color is automatically selected. Read-only.
Declaration
public bool IsAutoColor { get; }
Property Value
| Type |
|---|
| System.Boolean |
IsAutoMode
True if background is set to automatic.
Declaration
public bool IsAutoMode { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsBubbleSize
Gets or sets a boolean value indicating whether to show bubble size for data labels.
Declaration
public bool IsBubbleSize { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsCategoryName
Gets or sets a boolean value indicating whether to display category name for data labels.
Declaration
public bool IsCategoryName { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsFormula
Gets or sets a value indicating whether this instance is formula.
Declaration
public bool IsFormula { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
|
IsLegendKey
Gets or sets a boolean value indicating whether data label legend key is visible.
Declaration
public bool IsLegendKey { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsPercentage
Gets or sets a boolean value indicating whether to display percentage value for data labels.
Declaration
public bool IsPercentage { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsSeriesName
Gets or sets a boolean value indicating whether to display series name for data labels.
Declaration
public bool IsSeriesName { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsValue
Gets or sets a boolean value indicating whether to display data label values.
Declaration
public bool IsValue { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
IsValueFromCells
Gets and sets boolean value indicating whether display to value from cells value to datalabels.
Declaration
public bool IsValueFromCells { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Italic
True if the font style is italic. Read / write Boolean.
Declaration
public bool Italic { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Layout
Gets or sets Excel 2007 layout data
Declaration
public IChartLayout Layout { get; set; }
Property Value
| Type |
|---|
| IChartLayout |
MacOSOutlineFont
True if the font is an outline font. Read / write Boolean.
Declaration
public bool MacOSOutlineFont { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
MacOSShadow
True if the font is a shadow font or if the object has a shadow. Read / write Boolean.
Declaration
public bool MacOSShadow { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
NumberFormat
Gets or sets a value indicating whether this instance is formula.
Declaration
public string NumberFormat { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
|
ParagraphType
Represents the Legend Paragraph
Declaration
public ChartParagraphType ParagraphType { get; set; }
Property Value
| Type |
|---|
| ChartParagraphType |
Position
Gets or sets the data labels position.
Declaration
public ExcelDataLabelPosition Position { get; set; }
Property Value
| Type |
|---|
| ExcelDataLabelPosition |
RGBColor
Gets / sets font color. Searches for the closest color in the workbook palette.
Declaration
public Color RGBColor { get; set; }
Property Value
| Type |
|---|
| Color |
RichText
Gets rich text.
Declaration
public IChartRichTextString RichText { get; }
Property Value
| Type |
|---|
| IChartRichTextString |
ShowLeaderLines
Gets or sets a boolean value indicating whether to display leader lines.
Declaration
public bool ShowLeaderLines { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Size
Returns or sets the size of the font. Read / write Variant.
Declaration
public double Size { get; set; }
Property Value
| Type |
|---|
| System.Double |
Strikethrough
True if the font is struck through with a horizontal line. Read / write Boolean
Declaration
public bool Strikethrough { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Subscript
True if the font is formatted as subscript. False by default. Read / write Boolean.
Declaration
public bool Subscript { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Superscript
True if the font is formatted as superscript. False by default. Read/write Boolean
Declaration
public bool Superscript { get; set; }
Property Value
| Type |
|---|
| System.Boolean |
Text
Area's text.
Declaration
public string Text { get; set; }
Property Value
| Type |
|---|
| System.String |
TextArea
Gets / sets text area.
Declaration
public ChartTextAreaImpl TextArea { get; set; }
Property Value
| Type |
|---|
| ChartTextAreaImpl |
TextRotation
Gets or sets the Text Rotation
Declaration
public Excel2007TextRotation TextRotation { get; set; }
Property Value
| Type |
|---|
| Excel2007TextRotation |
TextRotationAngle
Text rotation angle.
Declaration
public int TextRotationAngle { get; set; }
Property Value
| Type |
|---|
| System.Int32 |
Underline
Returns or sets the type of underline applied to the font. Can be one of the following ExcelUnderlineStyle constants. Read / write ExcelUnderline.
Declaration
public ExcelUnderline Underline { get; set; }
Property Value
| Type |
|---|
| ExcelUnderline |
ValueFromCellsRange
Gets and sets indicating whether value from cells range in datalables.
Declaration
public IRange ValueFromCellsRange { get; set; }
Property Value
| Type |
|---|
| IRange |
VerticalAlignment
Gets / sets font vertical alignment.
Declaration
public ExcelFontVertialAlignment VerticalAlignment { get; set; }
Property Value
| Type |
|---|
| ExcelFontVertialAlignment |
Methods
BeginUpdate()
This method should be called before several updates to the object will take place.
Declaration
public void BeginUpdate()
Clone(Object, Dictionary<Int32, Int32>, Dictionary<String, String>)
Creates a new object that is a copy of the current instance.
Declaration
public object Clone(object parent, Dictionary<int, int> dicFontIndexes, Dictionary<string, string> dicNewSheetNames)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | parent | Parent object for a copy of this instance. |
| System.Collections.Generic.Dictionary<System.Int32, System.Int32> | dicFontIndexes | New font indexes. |
| System.Collections.Generic.Dictionary<System.String, System.String> | dicNewSheetNames | New worksheet names. |
Returns
| Type | Description |
|---|---|
| System.Object | A new object that is a copy of this instance. |
EndUpdate()
This method should be called after several updates to the object took place.
Declaration
public void EndUpdate()
GenerateNativeFont()
Generates .Net font object corresponding to the current font.
Declaration
public Font GenerateNativeFont()
Returns
| Type | Description |
|---|---|
| Font | Generated .Net font. |
Serialize(IList<IBiffStorage>)
Saves object into OffsetArrayList.
Declaration
public void Serialize(IList<IBiffStorage> records)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IList<IBiffStorage> | records | OffsetArrayList that will receive all records. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | When specified OffsetArrayList is NULL. |
UpdateSerieIndex()
Updates Series index.
Declaration
public void UpdateSerieIndex()