Class ChartSerializatorCommon

This class contains common code used for charts serialization.

Inheritance

System.Object

ChartSerializatorCommon

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.XlsIO.Implementation.XmlSerialization.Charts

Assembly: Syncfusion.XlsIO.Base.dll

Syntax

public class ChartSerializatorCommon

Constructors

ChartSerializatorCommon()

Declaration

public ChartSerializatorCommon()

Fields

BevelProperties

Jagged Array represents the 3D Bevel Attributes

Declaration

public static string[][] BevelProperties

Field Value

Type
System.String[][]

InnerAttributeArray

Jagged Array represents the Inner Shadow Attributes

Declaration

public static string[][] InnerAttributeArray

Field Value

Type
System.String[][]

LightingProperties

Jagged Array represents the 3D Lighting Attributes

Declaration

public static string[][] LightingProperties

Field Value

Type
System.String[][]

MaterialProperties

Jagged Array represents the 3D Material Attributes

Declaration

public static string[][] MaterialProperties

Field Value

Type
System.String[][]

OuterAttributeArray

Jagged Array represents the Outer Shadow Attributes

Declaration

public static string[][] OuterAttributeArray

Field Value

Type
System.String[][]

PerspectiveAttributeArray

Jagged Array represents the Perspective Shadow Attributes

Declaration

public static string[][] PerspectiveAttributeArray

Field Value

Type
System.String[][]

Methods

SerailizeOuter(XmlWriter, Int32, Boolean, IShadow)

This method Serailizes the Outer Shadow

Declaration

[Obsolete("This method is obsolete and will be removed soon. Please use SerializeOuter(XmlWriter writer, int outer, bool CustomShadow, IShadow Shadow) method. Sorry for inconvenience.")]
public static void SerailizeOuter(XmlWriter writer, int outer, bool CustomShadow, IShadow Shadow)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	outer	the jagged array index of OuterAttributeArry
System.Boolean	CustomShadow	if set to true [custom shadow style].
IShadow	Shadow	The ShadowImpl object

Serialize3D(XmlWriter, IThreeDFormat)

This method Serailizes the 3DProperties

Declaration

public static void Serialize3D(XmlWriter writer, IThreeDFormat Three_D)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IThreeDFormat	Three_D	ThreeD format

SerializeBoolValueTag(XmlWriter, String, Boolean)

Serialize xml tag that contains value attribute with tag value.

Declaration

public static void SerializeBoolValueTag(XmlWriter writer, string tagName, bool value)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.String	tagName	Tag name to serialize.
System.Boolean	value	Value to serialize.

SerializeBottomBevel(XmlWriter, Int32)

This method serializes the Bevel Bottom

Declaration

public static void SerializeBottomBevel(XmlWriter writer, int bevel)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	bevel	the jagged array index of Bevelproperties Array

SerializeBottomBevel(XmlWriter, Int32, Int32)

This method serialize the Bevel bottom

Declaration

public static void SerializeBottomBevel(XmlWriter writer, int lineHeight, int lineWidth)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	lineHeight	Bevel bottom Height Value
System.Int32	lineWidth	Bevel bottom width Value

SerializeBottomBevel(XmlWriter, Int32, Int32, Int32)

This method serializes the Bevel Bottom

Declaration

public static void SerializeBottomBevel(XmlWriter writer, int bevel, int lineHeight, int lineWidth)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	bevel	the jagged array index of Bevelproperties Array
System.Int32	lineHeight	Bevel bottom Height Value
System.Int32	lineWidth	Bevel bottom width Value

SerializeDoubleValueTag(XmlWriter, String, Double)

Serialize the double value attributes.

Declaration

public static void SerializeDoubleValueTag(XmlWriter writer, string tagName, double value)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer
System.String	tagName
System.Double	value

SerializeDoubleValueTag(XmlWriter, String, String, Double)

Seralize the double value

Declaration

public static void SerializeDoubleValueTag(XmlWriter writer, string tagName, string tagNamespace, double value)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer
System.String	tagName
System.String	tagNamespace
System.Double	value

SerializeFrameFormat(XmlWriter, IChartFillBorder, ChartImpl, Boolean)

Serializes frame format.

Declaration

public static void SerializeFrameFormat(XmlWriter writer, IChartFillBorder format, ChartImpl chart, bool isRoundCorners)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IChartFillBorder	format	Fill format to serialize.
ChartImpl	chart	Parent chart object.
System.Boolean	isRoundCorners	Indicates whether area corners should be rounded.

SerializeFrameFormat(XmlWriter, IChartFillBorder, ChartImpl, Boolean, Boolean)

Serializes frame format.

Declaration

public static void SerializeFrameFormat(XmlWriter writer, IChartFillBorder format, ChartImpl chart, bool isRoundCorners, bool serializeLineAutoValues)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IChartFillBorder	format	Fill format to serialize.
ChartImpl	chart	Parent chart object.
System.Boolean	isRoundCorners	Indicates whether area corners should be rounded.
System.Boolean	serializeLineAutoValues

SerializeFrameFormat(XmlWriter, IChartFillBorder, FileDataHolder, RelationCollection, Boolean, Boolean)

Serializes frame format.

Declaration

public static void SerializeFrameFormat(XmlWriter writer, IChartFillBorder format, FileDataHolder holder, RelationCollection relations, bool isRoundCorners, bool serilaizeLineAutoValues)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IChartFillBorder	format	Fill format to serialize.
FileDataHolder	holder	Parent file data holder.
RelationCollection	relations	Chart's relations collection
System.Boolean	isRoundCorners	Indicates whether area corners should be rounded.
System.Boolean	serilaizeLineAutoValues

SerializeInner(XmlWriter, Int32, Boolean, IShadow)

Serializes the inner shadow.

Declaration

public static void SerializeInner(XmlWriter writer, int inner, bool CustomShadow, IShadow Shadow)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	inner	The jagged array index of the InnerAttributeArry.
System.Boolean	CustomShadow	if set to true [custom shadow style].
IShadow	Shadow	The ShadowImpl object.

SerializeLayout(XmlWriter, Object)

Serializes text area layout settings.

Declaration

public static void SerializeLayout(XmlWriter writer, object textArea)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Object	textArea	Text area to serialize layout settings for.

SerializeLight(XmlWriter, Int32)

This method serailize the Lighting properties

Declaration

public static void SerializeLight(XmlWriter writer, int light)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	light	the jagged array index of LightingPropertiesArray

SerializeLineProperties(XmlWriter, IChartBorder, IWorkbook)

Serializes chart line properties.

Declaration

public static void SerializeLineProperties(XmlWriter writer, IChartBorder border, IWorkbook book)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IChartBorder	border	Border to serialize.
IWorkbook	book	Parent workbook.

SerializeManualLayout(XmlWriter, IChartManualLayout)

Serializes text area manual layout settings.

Declaration

public static void SerializeManualLayout(XmlWriter writer, IChartManualLayout manualLayout)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IChartManualLayout	manualLayout

SerializeMaterial(XmlWriter, Int32)

This method serialize the Material properties

Declaration

public static void SerializeMaterial(XmlWriter writer, int material)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	material	the jagged array index of MaterialPropertiesArray

SerializeOuter(XmlWriter, Int32, Boolean, IShadow)

This method Serailizes the Outer Shadow

Declaration

public static void SerializeOuter(XmlWriter writer, int outer, bool CustomShadow, IShadow Shadow)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	outer	the jagged array index of OuterAttributeArry
System.Boolean	CustomShadow	if set to true [custom shadow style].
IShadow	Shadow	The ShadowImpl object

SerializeParagraphRunProperites(XmlWriter, IFont, String, IWorkbook, Double)

Serializes paragraph run.

Declaration

[Obsolete("This method is obsolete and will be removed soon. Please use SerializeParagraphRunProperties(XmlWriter writer, IFont textArea, string mainTagName, IWorkbook book, double defaultFontSize) method. Sorry for inconvenience.")]
public static void SerializeParagraphRunProperites(XmlWriter writer, IFont textArea, string mainTagName, IWorkbook book, double defaultFontSize)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize paragraph tag into.
IFont	textArea	Text area that contains paragraph run information (formatting and text).
System.String	mainTagName	Name of the main xml tag.
IWorkbook	book	Parent workbook.
System.Double	defaultFontSize

SerializeParagraphRunProperties(XmlWriter, IFont, String, IWorkbook, Double)

Serializes paragraph run.

Declaration

public static void SerializeParagraphRunProperties(XmlWriter writer, IFont textArea, string mainTagName, IWorkbook book, double defaultFontSize)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize paragraph tag into.
IFont	textArea	Text area that contains paragraph run information (formatting and text).
System.String	mainTagName	Name of the main xml tag.
IWorkbook	book	Parent workbook.
System.Double	defaultFontSize

SerializePatternFill(XmlWriter, ColorObject, Boolean, ColorObject, Boolean, ExcelGradientPattern, IWorkbook)

Serializes pattern fill.

Declaration

public static void SerializePatternFill(XmlWriter writer, ColorObject foreColor, bool isAutoFore, ColorObject backColor, bool isAutoBack, ExcelGradientPattern pattern, IWorkbook book)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
ColorObject	foreColor	Foreground color.
System.Boolean	isAutoFore	Indicates whether foreground color is auto and foreColor argument should be ignored.
ColorObject	backColor	Background color.
System.Boolean	isAutoBack	Indicates whether background color is auto and backColor argument should be ignored.
ExcelGradientPattern	pattern	Pattern to serialize.
IWorkbook	book	Parent workbook.

SerializePatternFill(XmlWriter, ColorObject, Boolean, ColorObject, Boolean, String, IWorkbook, Double)

Serializes pattern fill.

Declaration

public static void SerializePatternFill(XmlWriter writer, ColorObject foreColor, bool isAutoFore, ColorObject backColor, bool isAutoBack, string strPreset, IWorkbook book, double Alphavalue)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
ColorObject	foreColor	Foreground color.
System.Boolean	isAutoFore	Indicates whether foreground color is auto and foreColor argument should be ignored.
ColorObject	backColor	Background color.
System.Boolean	isAutoBack	Indicates whether background color is auto and backColor argument should be ignored.
System.String	strPreset	Preset pattern value.
IWorkbook	book	Parent workbook.
System.Double	Alphavalue

SerializePatternFill(XmlWriter, ColorObject, Boolean, String, String, IWorkbook, Double)

Serializes pattern fill.

Declaration

public static void SerializePatternFill(XmlWriter writer, ColorObject color, bool bAutoColor, string strDash2007, string strPreset, IWorkbook book, double Alphavalue)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
ColorObject	color	Color to serialize.
System.Boolean	bAutoColor	Indicates whether color is automatic and should be ignored or not.
System.String	strDash2007	Preset dash value.
System.String	strPreset	Preset pattern value.
IWorkbook	book	Parent workbook.
System.Double	Alphavalue

SerializePerspective(XmlWriter, Int32, Boolean, IShadow)

This method serializes the Perspective shadow properties

Declaration

public static void SerializePerspective(XmlWriter writer, int perspective, bool CustomShadow, IShadow Shadow)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	perspective	the jagged array index of PerspectiveAttributeArry
System.Boolean	CustomShadow	if set to true [custom shadow style].
IShadow	Shadow	The ShadowImpl object

SerializeRgbColor(XmlWriter, ExcelKnownColors, IWorkbook)

Serializes rgb color.

Declaration

public static void SerializeRgbColor(XmlWriter writer, ExcelKnownColors colorIndex, IWorkbook book)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
ExcelKnownColors	colorIndex	Color index to serialize.
IWorkbook	book	Parent workbook.

SerializeRgbColor(XmlWriter, Color)

Serializes rgb color.

Declaration

public static void SerializeRgbColor(XmlWriter writer, Color color)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Drawing.Color	color	Color to serialize.

SerializeRgbColor(XmlWriter, Color, Double)

Serializes rgb color.

Declaration

public static void SerializeRgbColor(XmlWriter writer, Color color, double alphaValue)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Drawing.Color	color	Color to serialize.
System.Double	alphaValue	Alpha component of the color to serialize, 0 - 100000.

SerializeRgbColor(XmlWriter, Color, Int32, Int32, Int32)

Serializes rgb color.

Declaration

public static void SerializeRgbColor(XmlWriter writer, Color color, int alpha, int tint, int shade)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Drawing.Color	color	Color to serialize.
System.Int32	alpha	Alpha component of the color to serialize, 0-100000.
System.Int32	tint	Tint value of the color to serialize, 0-100000.
System.Int32	shade	Shape value of the color to serialize, 0-100000.

SerializeRichText(XmlWriter, IChartTextArea, IWorkbook, String, Double)

Serializes rich text.

Declaration

public static void SerializeRichText(XmlWriter writer, IChartTextArea textArea, IWorkbook book, string tagName, double defaultFontSize)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IChartTextArea	textArea	Text area that contains rich text to serialize.
IWorkbook	book	Parent workbook.
System.String	tagName	Name of the main xml tag.
System.Double	defaultFontSize

SerializeShadow(XmlWriter, IShadow, Boolean)

This method serailizes the Shadow propeties

Declaration

public static void SerializeShadow(XmlWriter writer, IShadow shadow, bool CustomShadow)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IShadow	shadow	Shadow format to serialize into
System.Boolean	CustomShadow	Whether the current format contains the Custom Shadow Style

SerializeSolidFill(XmlWriter, ColorObject, Boolean, IWorkbook, Double)

Serializes solid fill.

Declaration

public static void SerializeSolidFill(XmlWriter writer, ColorObject color, bool isAutoColor, IWorkbook book, double alphavalue)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
ColorObject	color	Color that is used for filling.
System.Boolean	isAutoColor	Indicates whether color is automatic or was manually changed.
IWorkbook	book	Parent workbook.
System.Double	alphavalue

SerializeTextArea(XmlWriter, IChartTextArea, WorkbookImpl, RelationCollection, Double)

Serializes text area.

Declaration

public static void SerializeTextArea(XmlWriter writer, IChartTextArea textArea, WorkbookImpl book, RelationCollection relations, double defaultFontSize)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IChartTextArea	textArea	Text area to serialize.
WorkbookImpl	book	Parent workbook.
RelationCollection	relations	Chart's relations.
System.Double	defaultFontSize

SerializeTextAreaText(XmlWriter, IChartTextArea, IWorkbook, Double)

Serializes text from text area.

Declaration

public static void SerializeTextAreaText(XmlWriter writer, IChartTextArea textArea, IWorkbook book, double defaultFontSize)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
IChartTextArea	textArea	Text area to serialize values for.
IWorkbook	book	Parent workbook.
System.Double	defaultFontSize

SerializeTopBevel(XmlWriter, Int32)

This method serialize the Bevel top

Declaration

public static void SerializeTopBevel(XmlWriter writer, int bevel)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	bevel	the jagged array index of bevelpropertiesArray

SerializeTopBevel(XmlWriter, Int32, Int32)

This method serialize the Bevel top

Declaration

public static void SerializeTopBevel(XmlWriter writer, int lineHeight, int lineWidth)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	lineHeight	Bevel top Height Value
System.Int32	lineWidth	Bevel top width Value

SerializeTopBevel(XmlWriter, Int32, Int32, Int32)

This method serialize the Bevel top

Declaration

public static void SerializeTopBevel(XmlWriter writer, int bevel, int lineHeight, int lineWidth)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.Int32	bevel	the jagged array index of bevelpropertiesArray
System.Int32	lineHeight	Bevel top Height Value
System.Int32	lineWidth	Bevel top width Value

SerializeValueTag(XmlWriter, String, String)

Serialize xml tag that contains value attribute with tag value.

Declaration

public static void SerializeValueTag(XmlWriter writer, string tagName, string value)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.String	tagName	Tag name to serialize.
System.String	value	Value to serialize.

SerializeValueTag(XmlWriter, String, String, String)

Serialize xml tag that contains value attribute with tag value.

Declaration

public static void SerializeValueTag(XmlWriter writer, string tagName, string tagNamespace, string value)

Parameters

Type	Name	Description
System.Xml.XmlWriter	writer	XmlWriter to serialize into.
System.String	tagName	Tag name to serialize.
System.String	tagNamespace	Namespace of the xml tag.
System.String	value	Value to serialize.