Interface ISnippetFormat

Provides the interface that contains format which is used for rendering utility object. It holds settings needed for proper rendering one or more snippets on user screen.

Inherited Members
Namespace: Syncfusion.Windows.Forms.Edit.Interfaces
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public interface ISnippetFormat : IBackgroundFormat

Properties

BorderColor

Gets or sets the border color of line.

Declaration
Color BorderColor { get; set; }
Property Value
Type
System.Drawing.Color

BorderStyle

Gets or sets the style of border.

Declaration
FrameBorderStyle BorderStyle { get; set; }
Property Value
Type
FrameBorderStyle

BorderWeight

Gets or sets the border weight of line.

Declaration
BorderWeight BorderWeight { get; set; }
Property Value
Type
BorderWeight

Font

Gets or sets the font which must be used for rendering.

Declaration
Font Font { get; set; }
Property Value
Type
System.Drawing.Font

FontColor

Gets or sets the font color of snippet text.

Declaration
Color FontColor { get; set; }
Property Value
Type
System.Drawing.Color

LineColor

Gets or sets the color of line.

Declaration
Color LineColor { get; set; }
Property Value
Type
System.Drawing.Color

Name

Gets the unique name for the format.

Declaration
string Name { get; }
Property Value
Type
System.String

StrikeOut

Gets the text striking out.

Declaration
bool StrikeOut { get; }
Property Value
Type
System.Boolean

UnderlineStyle

Gets or sets the underline style of snippet text.

Declaration
UnderlineStyle UnderlineStyle { get; set; }
Property Value
Type
UnderlineStyle

UnderlineWeight

Gets or sets the underline weight of snippet text.

Declaration
UnderlineWeight UnderlineWeight { get; set; }
Property Value
Type
UnderlineWeight

UseCustomControl

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

Declaration
bool UseCustomControl { get; }
Property Value
Type
System.Boolean

UseHatchFill

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

Declaration
bool UseHatchFill { get; }
Property Value
Type
System.Boolean

Methods

add_OnCustomDraw(CustomSnippetDrawEventHandler)

Declaration
void add_OnCustomDraw(CustomSnippetDrawEventHandler value)
Parameters
Type Name Description
CustomSnippetDrawEventHandler value

remove_OnCustomDraw(CustomSnippetDrawEventHandler)

Declaration
void remove_OnCustomDraw(CustomSnippetDrawEventHandler value)
Parameters
Type Name Description
CustomSnippetDrawEventHandler value

Events

OnCustomDraw

Raised by renderer when paint works started. user

Declaration
event CustomSnippetDrawEventHandler OnCustomDraw
Event Type
Type
CustomSnippetDrawEventHandler