Class Renderer

A class a renderer should be derived from.

Inheritance

System.Object

Renderer

BasicRenderer

Implements

IRenderer

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.Windows.Forms.Tools.Renderers

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public abstract class Renderer : IRenderer

Constructors

Renderer()

Declaration

protected Renderer()

Methods

CompareWithDefaultValue(RendererProperty, Object)

Override this to compare with default renderer settings.

Declaration

public virtual bool CompareWithDefaultValue(RendererProperty property, object value)

Parameters

Type	Name	Description
RendererProperty	property	Property identifier.
System.Object	value	Compared value.

Returns

Type	Description
System.Boolean	True if value is equal and false in other case.

Draw(PaintEventArgs, IRendererInfo, Rectangle)

Override this to draw splitter according to renderer settings.

Declaration

public virtual void Draw(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	Paint context.
IRendererInfo	ri	An instance of RendererInfo, which should be used as datasource for painting.
System.Drawing.Rectangle	bounds	Bounds within which we should paint.

DrawBackground(PaintEventArgs, IRendererInfo, Rectangle)

Override this to draw a background.

Declaration

public abstract void DrawBackground(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	Paint context.
IRendererInfo	ri	An instance of RendererInfo, which should be used as datasource for painting.
System.Drawing.Rectangle	bounds	Bounds within which we should paint.

DrawForeground(PaintEventArgs, IRendererInfo, Rectangle)

Override this to provide foreground drawing.

Declaration

public abstract void DrawForeground(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	Paint context.
IRendererInfo	ri	An instance of RendererInfo, which should be used as datasource for painting.
System.Drawing.Rectangle	bounds	Bounds within which we should paint.

DrawHotBackground(PaintEventArgs, IRendererInfo, Rectangle)

Override this to provide hot background capabilities to your control's theme. Hot background means that control can change its background color when under mouse cursor.

Declaration

public abstract void DrawHotBackground(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	Paint context.
IRendererInfo	ri	An instance of RendererInfo, which should be used as datasource for painting.
System.Drawing.Rectangle	bounds	Bounds within which we should paint.

DrawHotForeground(PaintEventArgs, IRendererInfo, Rectangle)

Override this to provide hot foreground. Hot foreground means that control can change its hot foreground color when under mouse cursor.

Declaration

public abstract void DrawHotForeground(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	Paint context.
IRendererInfo	ri	An instance of RendererInfo, which should be used as datasource for painting.
System.Drawing.Rectangle	bounds	Bounds within which we should paint.

DrawHotThumbnail(PaintEventArgs, IRendererInfo, Rectangle)

Override this to provide hot thumbnail drawing according to your theme. Hot thumbnail means that control can change its thumbnail color when under mouse cursor.

Declaration

public abstract void DrawHotThumbnail(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	Paint context.
IRendererInfo	ri	An instance of RendererInfo, which should be used as datasource for painting.
System.Drawing.Rectangle	bounds	Bounds within which we should paint.

DrawThumbnail(PaintEventArgs, IRendererInfo, Rectangle)

Override this to provide thumbnail drawing according to your theme.

Declaration

public abstract void DrawThumbnail(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)

Parameters

Type	Name	Description
System.Windows.Forms.PaintEventArgs	e	Paint context.
IRendererInfo	ri	An instance of RendererInfo, which should be used as datasource for painting.
System.Drawing.Rectangle	bounds	Bounds within which we should paint.

GetAppropriateThemeSettings(SplitContainerAdv, Boolean)

For usage only within SplitContainerAdv class. Just point "this" to this method, so control properties will became appropriate for this theme. These properties are NOT used while drawing "default" theme. We're just blanking them.

Declaration

public virtual IRendererInfo GetAppropriateThemeSettings(SplitContainerAdv instance, bool bInit)

Parameters

Type	Name	Description
SplitContainerAdv	instance	Spliter container
System.Boolean	bInit	Bool value

Returns

Type	Description
IRendererInfo	Modified RenderInfo.

Remarks

Override this to provide custom settings saving. In overriden method initialize container properties you want to modify, with appropriate values from RendererInfo class.

GetDefaultValue(RendererProperty)

Gets default value for some property.

Declaration

public abstract object GetDefaultValue(RendererProperty property)

Parameters

Type	Name	Description
RendererProperty	property	Property identifier.

Returns

Type	Description
System.Object	Default value.

GetRenderer(Style)

Provides with an appropriate renderer instance.

Declaration

public static Renderer GetRenderer(Style style)

Parameters

Type	Name	Description
Style	style	Style by which an appropriate renderer is to be selected.

Returns

Type	Description
Renderer	An instance of Render's inheritor class, regarding to provided style.

UpdateRendererInfo(SplitContainerAdv, IRendererInfo)

Override this method to provide correct update renderer-specified information from control.

Declaration

public virtual IRendererInfo UpdateRendererInfo(SplitContainerAdv instance, IRendererInfo iri)

Parameters

Type	Name	Description
SplitContainerAdv	instance	An instance of holding container.
IRendererInfo	iri	An instance of RendererInfo, which should be updated.

Returns

Type	Description
IRendererInfo	Modified RendererInfo instance.

Implements

IRenderer