Class Format

Represents a class that helps to describes many format that is used to customize the style of each code snippet.

Inheritance

System.Object

Format

Implements

ISnippetFormat

IBackgroundFormat

IBorderFormat

IXMLDataProvider

System.IDisposable

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)

Namespace: Syncfusion.Windows.Forms.Edit.Implementation.Formatting

Assembly: Syncfusion.Edit.Windows.dll

Syntax

public class Format : ISnippetFormat, IBackgroundFormat, IBorderFormat, IXMLDataProvider, IDisposable

Constructors

Format()

Initializes a new instance of the Format class.

Declaration

public Format()

Format(String)

Initializes a new instance of the Format class using format name.

Declaration

public Format(string name)

Parameters

Type	Name	Description
System.String	name	format name

Format(String, ISnippetFormat)

Initializes a new instance of the Format class using name and another existing format.

Declaration

public Format(string name, ISnippetFormat inherit)

Parameters

Type	Name	Description
System.String	name	Name.
ISnippetFormat	inherit	Fornat to inherit.

Format(String, Color, Color, Color, Font)

Initializes a new instance of the Format class using font and Colors.

Declaration

public Format(string name, Color fontColor, Color foreColor, Color backColor, Font font)

Parameters

Type	Name	Description
System.String	name	Name.
System.Drawing.Color	fontColor	snippet's font's color
System.Drawing.Color	foreColor	snippet's forecolor
System.Drawing.Color	backColor	snippet's background
System.Drawing.Font	font	snippet's font's size

Format(String, Color, Color, Color, String, Single)

Initializes a new instance of the Format class using font[ + size ] and Colors.

Declaration

public Format(string name, Color fontColor, Color foreColor, Color backColor, string fontName, float fontSize)

Parameters

Type	Name	Description
System.String	name	Name.
System.Drawing.Color	fontColor	snippet's font's color
System.Drawing.Color	foreColor
System.Drawing.Color	backColor	snippet's background
System.String	fontName
System.Single	fontSize	snippet's font's size

Format(String, Font)

Initializes a new instance of the Format class using name and Font.

Declaration

public Format(string name, Font font)

Parameters

Type	Name	Description
System.String	name	name of this format
System.Drawing.Font	font	snippet's font at this format

Properties

BackColor

Gets or sets the background color of snippet. If you want to draw rectangle over the snippet set Background Color. Empty value and Foreground property to needed rectangle border color. If both properties Background and Foreground set to not Empty value then for drawing used hatch brush according to BackStyle property value. If Foreground set to Color.Empty value then will be filled snippet rectangle by Background color.

Declaration

public Color BackColor { get; set; }

Property Value

Type
System.Drawing.Color

BackGroundPen

Gets the pen which is used to draw rectangle around text.

Declaration

public Pen BackGroundPen { get; }

Property Value

Type
System.Drawing.Pen

BorderColor

Gets or sets the border color of frame.

Declaration

public Color BorderColor { get; set; }

Property Value

Type
System.Drawing.Color

BorderStyle

Gets or sets the style of border line.

Declaration

public FrameBorderStyle BorderStyle { get; set; }

Property Value

Type
FrameBorderStyle

BorderWeight

Gets or sets the weight of border line.

Declaration

public BorderWeight BorderWeight { get; set; }

Property Value

Type
BorderWeight

Font

Gets or sets the font of current format.

Declaration

public Font Font { get; set; }

Property Value

Type
System.Drawing.Font

FontBold

Gets or sets a value indicating whether the font is bold or not.

Declaration

public bool FontBold { get; set; }

Property Value

Type
System.Boolean

FontColor

Gets or sets the color of the font.

Declaration

public Color FontColor { get; set; }

Property Value

Type
System.Drawing.Color

FontFamily

Gets or sets the currently used font family.

Declaration

public FontFamily FontFamily { get; set; }

Property Value

Type
System.Drawing.FontFamily

FontItalic

Gets or sets a value indicating whether the font is italic or not.

Declaration

public bool FontItalic { get; set; }

Property Value

Type
System.Boolean

FontSize

Gets or sets the font size that are specified in the formats.

Declaration

public float FontSize { get; set; }

Property Value

Type
System.Single

ForeColor

Gets or sets the fore color of the format.

Declaration

public Color ForeColor { get; set; }

Property Value

Type
System.Drawing.Color

HatchStyle

Gets or sets the Style of background brush. This property used only when Background and Foreground colors set to not Empty values.

Declaration

public HatchStyle HatchStyle { get; set; }

Property Value

Type
System.Drawing.Drawing2D.HatchStyle

IsDoubleLine

Gets or sets a value indicating whether the line has double style

Declaration

protected bool IsDoubleLine { get; }

Property Value

Type
System.Boolean

LineColor

Gets or sets the color of Line.

Declaration

public Color LineColor { get; set; }

Property Value

Type
System.Drawing.Color

LineWidth

Gets the line pen width.

Declaration

protected float LineWidth { get; }

Property Value

Type
System.Single

Name

Gets or sets the name of the format.

Declaration

public string Name { get; set; }

Property Value

Type
System.String

Parent

Gets or sets the parent of the format.

Declaration

public FormatManager Parent { get; set; }

Property Value

Type
FormatManager

RightToLeft

Gets or sets a value indicating whether the control is in RightToLeft rendering mode.

Declaration

public bool RightToLeft { get; set; }

Property Value

Type
System.Boolean

StrikeOut

Gets a value indicating whether the text is strike out or not.

Declaration

public bool StrikeOut { get; }

Property Value

Type
System.Boolean

StrikeOutColor

Gets or sets the strike out color of text.

Declaration

public Color StrikeOutColor { get; set; }

Property Value

Type
System.Drawing.Color

StrikeOutPen

Gets pen used for drawing text strike out.

Declaration

protected Pen StrikeOutPen { get; }

Property Value

Type
System.Drawing.Pen

StringFormat

Gets or sets the StringFormat that are used to draw the string.

Declaration

public StringFormat StringFormat { get; set; }

Property Value

Type
System.Drawing.StringFormat

TextBrush

Gets the brush, that is used to draw text.

Declaration

protected Brush TextBrush { get; }

Property Value

Type
System.Drawing.Brush

TextDrawOffset

Gets or sets the text draw offset value .

Declaration

public int TextDrawOffset { get; set; }

Property Value

Type
System.Int32

UnderlineBrush

Gets the brush used for underlining.

Declaration

protected Brush UnderlineBrush { get; }

Property Value

Type
System.Drawing.Brush

UnderlinePen

Gets the pen used for underlining.

Declaration

protected Pen UnderlinePen { get; }

Property Value

Type
System.Drawing.Pen

UnderlineStyle

Gets or sets the style that are used for underlining.

Declaration

public UnderlineStyle UnderlineStyle { get; set; }

Property Value

Type
UnderlineStyle

UnderlineWeight

Gets or sets the weight that are used for underlining.

Declaration

public UnderlineWeight UnderlineWeight { get; set; }

Property Value

Type
UnderlineWeight

UseCustomControl

Gets or sets a value indicating whether custom control should be used instead of rendering text.

Declaration

public bool UseCustomControl { get; set; }

Property Value

Type
System.Boolean

UseHatchFill

Gets or sets a value indicating whether hatch style settings should be applied on background filling or background should be solid.

Declaration

public bool UseHatchFill { get; set; }

Property Value

Type
System.Boolean

WaveImage

Gets the wave image which is used for underline drawing.

Declaration

public static Image WaveImage { get; }

Property Value

Type
System.Drawing.Image

XmlBackColor

Gets or sets back color that are used while performing XmlSerialization.

Declaration

public string XmlBackColor { get; set; }

Property Value

Type
System.String

XmlBorderColor

Gets or sets the border color for XmlSerialization.

Declaration

public string XmlBorderColor { get; set; }

Property Value

Type
System.String

XmlFont

Gets or sets the font presentation for XmlSerialization.

Declaration

public string XmlFont { get; set; }

Property Value

Type
System.String

XmlFontColor

Gets or sets the font color presentation for XmlSerialization

Declaration

public string XmlFontColor { get; set; }

Property Value

Type
System.String

XmlForeColor

Gets or sets the color presentation for XmlSerialization.

Declaration

public string XmlForeColor { get; set; }

Property Value

Type
System.String

XmlLineColor

Gets or sets the LineColor presantation for XmlSerialization

Declaration

public string XmlLineColor { get; set; }

Property Value

Type
System.String

XmlStrikeOutColor

Gets or sets the strike out color presentation for XmlSerialization.

Declaration

public string XmlStrikeOutColor { get; set; }

Property Value

Type
System.String

Methods

AppendToXML(XmlElement)

Append it's data to given XML.

Declaration

public void AppendToXML(XmlElement parent)

Parameters

Type	Name	Description
System.Xml.XmlElement	parent	Parent element.

AppendToXML(XmlTextWriter)

Append it's data to given XML.

Declaration

public void AppendToXML(XmlTextWriter writer)

Parameters

Type	Name	Description
System.Xml.XmlTextWriter	writer	Xml writer.

CompleteFormattingsList(ref AdditionalFormatting[], Int32)

Return list with all given formatting.

Declaration

public IList CompleteFormattingsList(ref AdditionalFormatting[] formatting, int textLength)

Parameters

Type	Name	Description
AdditionalFormatting[]	formatting	Array of additional formatting to fill.
System.Int32	textLength	Length of text.

Returns

Type	Description
System.Collections.IList	List of formatting.

Dispose()

Releases all resources used by this Controls component.

Declaration

public void Dispose()

DrawBorder(Graphics, ref BorderInfo, Format, ref RectangleF)

Draws border on specified Graphics object using current format settings.

Declaration

public void DrawBorder(Graphics g, ref BorderInfo borderInfo, Format frm, ref RectangleF rect)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object to draw border on.
BorderInfo	borderInfo	Structure with info about border.
Format	frm	Format of border.
System.Drawing.RectangleF	rect	Rectengle to draw border around.

DrawSingleUnderline(Graphics, Single, Single, Single)

Draws single underlining line.

Declaration

protected void DrawSingleUnderline(Graphics g, float x, float y, float width)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object.
System.Single	x	X coordinate of the underline start.
System.Single	y	Y coordinate of the underline start.
System.Single	width	Width of the underlining.

DrawText(Graphics, ref TextDrawInfo, ref BorderInfo, Boolean, Int32)

Draws text on specified Graphics object using current format settings.

Declaration

public void DrawText(Graphics g, ref TextDrawInfo text, ref BorderInfo borderInfo, bool bNativeDrawing, int spaceBetweenLines)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics, the text is to be drawn on.
TextDrawInfo	text	Text, to be drawn.
BorderInfo	borderInfo	Info about bordering.
System.Boolean	bNativeDrawing	Indicates whether native drawing should be used.
System.Int32	spaceBetweenLines	Space between lines.

DrawText(Graphics, ref TextDrawInfo, ref BorderInfo, Int32, Single, Size, Boolean, Int32)

Draws text on specified Graphics object using current format settings.

Declaration

public void DrawText(Graphics g, ref TextDrawInfo text, ref BorderInfo borderInfo, int autoScrollY, float scale, Size margins, bool bNativeDrawing, int SpaceBetweenLines)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics, the text is to be drawn on.
TextDrawInfo	text	Text, to be drawn.
BorderInfo	borderInfo	Info about bordering.
System.Int32	autoScrollY	Y autoscroll position. Used for proper native drawing.
System.Single	scale	Scale value for output. Used in printing for resolving printing problems related to native methods.
System.Drawing.Size	margins	Margin offsets for text output. Used in printing.
System.Boolean	bNativeDrawing	Indicates whether native drawing should be used.
System.Int32	SpaceBetweenLines	Space between lines.

DrawTextAndStrikeOut(Graphics, String, Rectangle, Int32, Single, Size, Boolean)

Draws text and strikes it out if needed.

Declaration

protected void DrawTextAndStrikeOut(Graphics g, string text, Rectangle rect, int autoScrollY, float scale, Size margins, bool bNativeDrawing)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object.
System.String	text	Text to draw.
System.Drawing.Rectangle	rect	Rectangle, the text is to be drawn to.
System.Int32	autoScrollY	Y autoscroll position. Used for proper native drawing.
System.Single	scale	Scale value for output. Used in printing for resolving printing problems related to native methods.
System.Drawing.Size	margins	Margin offsets for text output. Used in printing.
System.Boolean	bNativeDrawing	bNativeDrawing.

DrawTextAndStrikeOut(Graphics, String, Rectangle, Int32, Single, Size, Brush, Pen, Boolean)

Draws text and strikes it out if needed.

Declaration

protected void DrawTextAndStrikeOut(Graphics g, string text, Rectangle rect, int autoScrollY, float scale, Size margins, Brush textBrush, Pen penStrikeOut, bool bNativeDrawing)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object.
System.String	text	Text to draw.
System.Drawing.Rectangle	rect	Rectangle, the text is to be drawn to.
System.Int32	autoScrollY	Y autoscroll position. Used for proper native drawing.
System.Single	scale	Scale value for output. Used in printing for resolving printing problems related to native methods.
System.Drawing.Size	margins	Margin offsets for text output. Used in printing.
System.Drawing.Brush	textBrush	Brush for text.
System.Drawing.Pen	penStrikeOut	Pen to draw striking out.
System.Boolean	bNativeDrawing	Indicates whether native drawing should be used.

DrawUnderlines(Graphics, RectangleF)

Draws underlining line for the specified rectangle that contains text.

Declaration

public void DrawUnderlines(Graphics g, RectangleF textRect)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object, underlines should be drawn on.
System.Drawing.RectangleF	textRect	Rectangle with text, that should be underlined.

DrawUnderlines(Graphics, Single, Single, Single)

Draws underlining line for the specified rectangle that contains text.

Declaration

public void DrawUnderlines(Graphics g, float x, float y, float width)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics object, underlines should be drawn on.
System.Single	x	X coordinate of the underline start.
System.Single	y	Y coordinate of the underline start.
System.Single	width	Width of the underlining.

Finalize()

Finalizer.

Declaration

protected void Finalize()

MeasureText(Graphics, String, Boolean, Boolean, Int32)

Helps to measures text using current font.

Declaration

public TextInfo MeasureText(Graphics g, string text, bool bMeasureWholeWord, bool bNativeGdi, int spaceBetweenLines)

Parameters

Type	Name	Description
System.Drawing.Graphics	g	Graphics.
System.String	text	Text.
System.Boolean	bMeasureWholeWord	Indicates whether whole word should be measured.
System.Boolean	bNativeGdi	bNativeGdi.
System.Int32	spaceBetweenLines	spaceBetweenLines.

Returns

Type	Description
TextInfo	TextInfo.

OnBackColorChanged(ValueChangedEventArgs)

call raiser for BackColor

Declaration

protected virtual void OnBackColorChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnCustomDrawNeeds(CustomSnippetDrawEventArgs)

Raise to OnCustomDraw event to user with specified parameters

Declaration

public virtual void OnCustomDrawNeeds(CustomSnippetDrawEventArgs args)

Parameters

Type	Name	Description
CustomSnippetDrawEventArgs	args	CustomSnippetDrawEventArgs

OnFontChanged(ValueChangedEventArgs)

call raiser for Font

Declaration

protected virtual void OnFontChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnFontColorChanged(ValueChangedEventArgs)

call raiser for FontColor

Declaration

protected virtual void OnFontColorChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnFontNameChanged(ValueChangedEventArgs)

call raiser for FontName

Declaration

protected virtual void OnFontNameChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnFontSizeChanged(ValueChangedEventArgs)

call raiser for FontSize

Declaration

protected virtual void OnFontSizeChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnForeColorChanged(ValueChangedEventArgs)

call raiser for ForeColor

Declaration

protected virtual void OnForeColorChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnHatchStyleChanged(ValueChangedEventArgs)

call raiser for HatchStyle

Declaration

protected virtual void OnHatchStyleChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnLineColorChanged(ValueChangedEventArgs)

Declaration

protected virtual void OnLineColorChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnNameChanged(ValueChangedEventArgs)

call raiser for Name

Declaration

protected virtual void OnNameChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnUnderlineStyleChanged(ValueChangedEventArgs)

call raiser for UnderlineStyle

Declaration

protected virtual void OnUnderlineStyleChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

OnUnderlineWeightChanged(ValueChangedEventArgs)

call raiser for UnderlineWeight

Declaration

protected virtual void OnUnderlineWeightChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseBackColorChanged(ValueChangedEventArgs)

raise property_changed event for BackColor

Declaration

protected void RaiseBackColorChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseChangedEvent()

Raises Changed event.

Declaration

protected void RaiseChangedEvent()

RaiseFontChanged(ValueChangedEventArgs)

raise property_changed event for Font

Declaration

protected void RaiseFontChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseFontColorChanged(ValueChangedEventArgs)

raise property_changed event for FontColor

Declaration

protected void RaiseFontColorChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseFontNameChanged(ValueChangedEventArgs)

raise property_changed event for FontName

Declaration

protected void RaiseFontNameChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseFontSizeChanged(ValueChangedEventArgs)

raise property_changed event for FontSize

Declaration

protected void RaiseFontSizeChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseForeColorChanged(ValueChangedEventArgs)

raise property_changed event for ForeColor

Declaration

protected void RaiseForeColorChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseHatchStyleChanged(ValueChangedEventArgs)

raise property_changed event for HatchStyle

Declaration

protected void RaiseHatchStyleChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseLineColorChanged(ValueChangedEventArgs)

Raises LineColorChanged event.

Declaration

protected void RaiseLineColorChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseNameChanged(ValueChangedEventArgs)

Raise property_changed event for Name

Declaration

protected void RaiseNameChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseOnCustomDraw(CustomSnippetDrawEventArgs)

Method raise Custom draw event

Declaration

protected void RaiseOnCustomDraw(CustomSnippetDrawEventArgs args)

Parameters

Type	Name	Description
CustomSnippetDrawEventArgs	args	Parameters of custom draw event

RaiseUnderlineStyleChanged(ValueChangedEventArgs)

raise property_changed event for UnderlineStyle

Declaration

protected void RaiseUnderlineStyleChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

RaiseUnderlineWeightChanged(ValueChangedEventArgs)

raise property_changed event for

Declaration

protected void RaiseUnderlineWeightChanged(ValueChangedEventArgs args)

Parameters

Type	Name	Description
ValueChangedEventArgs	args	ValueChangedEventArgs

SetUnderlineBrush()

Sets underline brush.

Declaration

protected void SetUnderlineBrush()

SetUnderlinePen()

Sets underline pen.

Declaration

protected void SetUnderlinePen()

ToString()

use this to see object like string

Declaration

public override string ToString()

Returns

Type	Description
System.String	object like string

Overrides

System.Object.ToString()

Events

BackColorChanged

Occurs after the BackColor has changed.

Declaration

public event ValueChangedEventHandler BackColorChanged

Event Type

Type
ValueChangedEventHandler

Changed

Occurs when some property value is changed.

Declaration

public event EventHandler Changed

Event Type

Type
System.EventHandler

FontChanged

Occurs after the Font has changed.

Declaration

public event ValueChangedEventHandler FontChanged

Event Type

Type
ValueChangedEventHandler

FontColorChanged

Occurs after the FontColor has changed.

Declaration

public event ValueChangedEventHandler FontColorChanged

Event Type

Type
ValueChangedEventHandler

FontNameChanged

Occurs after the FontName has changed.

Declaration

public event ValueChangedEventHandler FontNameChanged

Event Type

Type
ValueChangedEventHandler

FontSizeChanged

Occurs after the FontSize has changed.

Declaration

public event ValueChangedEventHandler FontSizeChanged

Event Type

Type
ValueChangedEventHandler

ForeColorChanged

Occurs after the ForeColor has changed.

Declaration

public event ValueChangedEventHandler ForeColorChanged

Event Type

Type
ValueChangedEventHandler

HatchStyleChanged

Occurs after the HatchStyle has changed.

Declaration

public event ValueChangedEventHandler HatchStyleChanged

Event Type

Type
ValueChangedEventHandler

LineColorChanged

Occurs when line color is changed.

Declaration

public event ValueChangedEventHandler LineColorChanged

Event Type

Type
ValueChangedEventHandler

NameChanged

Occurs after the name has changed.

Declaration

public event ValueChangedEventHandler NameChanged

Event Type

Type
ValueChangedEventHandler

OnCustomDraw

This event is raised by renderer when paint works started. user

Declaration

public event CustomSnippetDrawEventHandler OnCustomDraw

Event Type

Type
CustomSnippetDrawEventHandler

UnderlineStyleChanged

Occurs after the UnderlineStyle has changed.

Declaration

public event ValueChangedEventHandler UnderlineStyleChanged

Event Type

Type
ValueChangedEventHandler

UnderlineWeightChanged

Occurs after the UnderlineWeight has changed.

Declaration

public event ValueChangedEventHandler UnderlineWeightChanged

Event Type

Type
ValueChangedEventHandler

Implements

ISnippetFormat

IBackgroundFormat

IBorderFormat

IXMLDataProvider

System.IDisposable