menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Interface IRenderer - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Interface IRenderer

    Create a class derived from Renderer, implementing this interface, to make your own renderers for custom splitter styles and behavior.

    Namespace: Syncfusion.Windows.Forms.Tools.Renderers
    Assembly: Syncfusion.Tools.Windows.dll
    Syntax
    public interface IRenderer

    Methods

    CompareWithDefaultValue(RendererProperty, Object)

    Compare current value with default value

    Declaration
    bool CompareWithDefaultValue(RendererProperty property, object value)
    Parameters
    Type Name Description
    RendererProperty property

    property identifier

    System.Object value

    current value

    Returns
    Type Description
    System.Boolean

    true if value is equal and false in other case

    Draw(PaintEventArgs, IRendererInfo, Rectangle)

    Draws splitter according to settings specified in RendererInfo.

    Declaration
    void Draw(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Drawing context

    IRendererInfo ri

    An instance of the needed RendererInfo to retrieve drawing settings from.

    System.Drawing.Rectangle bounds

    Bounds to draw within.

    DrawBackground(PaintEventArgs, IRendererInfo, Rectangle)

    Draws a background.

    Declaration
    void DrawBackground(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Current paint context.

    IRendererInfo ri

    An instance of RendererInfo, which is responsible for this SplitContainerAdv drawing.

    System.Drawing.Rectangle bounds

    Within these bounds we should draw.

    DrawForeground(PaintEventArgs, IRendererInfo, Rectangle)

    Draws a foreground.

    Declaration
    void DrawForeground(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Current paint context.

    IRendererInfo ri

    An instance of RendererInfo, which is responsible for this SplitContainerAdv drawing.

    System.Drawing.Rectangle bounds

    Within these bounds we should draw.

    DrawHotBackground(PaintEventArgs, IRendererInfo, Rectangle)

    Draws a background while under mouse cursor.

    Declaration
    void DrawHotBackground(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Current paint context.

    IRendererInfo ri

    An instance of RendererInfo, which is responsible for this SplitContainerAdv drawing.

    System.Drawing.Rectangle bounds

    Within these bounds we should draw.

    DrawHotForeground(PaintEventArgs, IRendererInfo, Rectangle)

    Draws a foreground while under mouse cursor.

    Declaration
    void DrawHotForeground(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Current paint context.

    IRendererInfo ri

    An instance of RendererInfo, which is responsible for this SplitContainerAdv drawing.

    System.Drawing.Rectangle bounds

    Within these bounds we should draw.

    DrawHotThumbnail(PaintEventArgs, IRendererInfo, Rectangle)

    Draws a thumbnail while under mouse cursor.

    Declaration
    void DrawHotThumbnail(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Current paint context.

    IRendererInfo ri

    An instance of RendererInfo, which is responsible for this SplitContainerAdv drawing.

    System.Drawing.Rectangle bounds

    Within these bounds we should draw.

    DrawThumbnail(PaintEventArgs, IRendererInfo, Rectangle)

    Draws a thumbnail.

    Declaration
    void DrawThumbnail(PaintEventArgs e, IRendererInfo ri, Rectangle bounds)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Current paint context.

    IRendererInfo ri

    An instance of RendererInfo, which is responsible for this SplitContainerAdv drawing.

    System.Drawing.Rectangle bounds

    Within these bounds we should draw.

    GetAppropriateThemeSettings(SplitContainerAdv, Boolean)

    Gets theme settings appropriate to the current theme.

    Declaration
    IRendererInfo GetAppropriateThemeSettings(SplitContainerAdv instance, bool bInit)
    Parameters
    Type Name Description
    SplitContainerAdv instance

    An instance of SplitContainerAdv container, which owns this renderer.

    System.Boolean bInit

    Flag of current mode. If mode is initialization than properties will not be set.

    Returns
    Type Description
    IRendererInfo

    Returns renderer info

    GetDefaultValue(RendererProperty)

    Gets default value for some property

    Declaration
    object GetDefaultValue(RendererProperty property)
    Parameters
    Type Name Description
    RendererProperty property

    Rendererer property

    Returns
    Type Description
    System.Object

    Returns default value

    UpdateRendererInfo(SplitContainerAdv, IRendererInfo)

    Creates RendererInfo instance and initializes it with default values.

    Declaration
    IRendererInfo UpdateRendererInfo(SplitContainerAdv instance, IRendererInfo ri)
    Parameters
    Type Name Description
    SplitContainerAdv instance

    An instance to initialize

    IRendererInfo ri

    A RendererInfo instance to take parameters from

    Returns
    Type Description
    IRendererInfo

    returns render info

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved