menu

WinForms

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

    Show / Hide Table of Contents

    Class BasicRenderer

    Basic Renderer.

    Inheritance
    System.Object
    Renderer
    BasicRenderer
    DefaultRenderer
    MetroRenderer
    MozillaRenderer
    Office2003Renderer
    OfficeXPRenderer
    VS2005Renderer
    Implements
    IRenderer
    Inherited Members
    Renderer.CompareWithDefaultValue(RendererProperty, Object)
    Renderer.GetRenderer(Style)
    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 class BasicRenderer : Renderer, IRenderer

    Constructors

    BasicRenderer()

    Initializes a new instance of the BasicRenderer class.

    Declaration
    protected BasicRenderer()

    Fields

    m_bUseOrientation

    If true than background orientation is autochanged.

    Declaration
    protected bool m_bUseOrientation
    Field Value
    Type
    System.Boolean

    m_defaultBackgroundColor

    storage for saving default value for BackgroundColor property

    Declaration
    protected BrushInfo m_defaultBackgroundColor
    Field Value
    Type
    BrushInfo

    m_defaultExpandFill

    storage for saving default value for ExpandFill property

    Declaration
    protected BrushInfo m_defaultExpandFill
    Field Value
    Type
    BrushInfo

    m_defaultExpandLine

    storage for saving default value for ExpandLine property

    Declaration
    protected Color m_defaultExpandLine
    Field Value
    Type
    System.Drawing.Color

    m_defaultGripDark

    storage for saving default value for GripDark property

    Declaration
    protected BrushInfo m_defaultGripDark
    Field Value
    Type
    BrushInfo

    m_defaultGripLight

    storage for saving default value for GripLight property

    Declaration
    protected BrushInfo m_defaultGripLight
    Field Value
    Type
    BrushInfo

    m_defaultHotBackgroundColor

    storage for saving default value for HotBackgroundColor property

    Declaration
    protected BrushInfo m_defaultHotBackgroundColor
    Field Value
    Type
    BrushInfo

    m_defaultHotExpandFill

    storage for saving default value for HotExpandFill property

    Declaration
    protected BrushInfo m_defaultHotExpandFill
    Field Value
    Type
    BrushInfo

    m_defaultHotExpandLine

    storage for saving default value for HotExpandLine property

    Declaration
    protected Color m_defaultHotExpandLine
    Field Value
    Type
    System.Drawing.Color

    m_defaultHotGripDark

    storage for saving default value for HotExpandGrip property

    Declaration
    protected BrushInfo m_defaultHotGripDark
    Field Value
    Type
    BrushInfo

    m_defaultHotGripLight

    storage for saving default value for HotGripLight property

    Declaration
    protected BrushInfo m_defaultHotGripLight
    Field Value
    Type
    BrushInfo

    m_nGripPadding

    Padding between grips.

    Declaration
    protected int m_nGripPadding
    Field Value
    Type
    System.Int32

    m_rendererInfo

    Declaration
    protected BasicRendererInfo m_rendererInfo
    Field Value
    Type
    BasicRendererInfo

    Properties

    DefaultBackgroundColor

    Gets default value for Background color

    Declaration
    public BrushInfo DefaultBackgroundColor { get; }
    Property Value
    Type
    BrushInfo

    DefaultExpandFill

    Gets default value for ExpandFill

    Declaration
    public BrushInfo DefaultExpandFill { get; }
    Property Value
    Type
    BrushInfo

    DefaultExpandLine

    Gets default value for ExpandLine

    Declaration
    public Color DefaultExpandLine { get; }
    Property Value
    Type
    System.Drawing.Color

    DefaultGripDark

    Gets default value for DefaultGripDark

    Declaration
    public BrushInfo DefaultGripDark { get; }
    Property Value
    Type
    BrushInfo

    DefaultGripLight

    Gets default value for GripLight

    Declaration
    public BrushInfo DefaultGripLight { get; }
    Property Value
    Type
    BrushInfo

    DefaultHotBackgroundColor

    Gets default value for HotBackgroundColor

    Declaration
    public BrushInfo DefaultHotBackgroundColor { get; }
    Property Value
    Type
    BrushInfo

    DefaultHotExpandFill

    Gets default value for ExpandFill

    Declaration
    public BrushInfo DefaultHotExpandFill { get; }
    Property Value
    Type
    BrushInfo

    DefaultHotExpandLine

    Gets default value for HotExpandLine

    Declaration
    public Color DefaultHotExpandLine { get; }
    Property Value
    Type
    System.Drawing.Color

    DefaultHotGripDark

    Gets default value for HotGripDark

    Declaration
    public BrushInfo DefaultHotGripDark { get; }
    Property Value
    Type
    BrushInfo

    DefaultHotGripLight

    Gets default value for HotGripLight

    Declaration
    public BrushInfo DefaultHotGripLight { get; }
    Property Value
    Type
    BrushInfo

    RendererInfo

    Gets renderer info

    Declaration
    public BasicRendererInfo RendererInfo { get; }
    Property Value
    Type
    BasicRendererInfo

    Methods

    Draw(PaintEventArgs, IRendererInfo, Rectangle)

    Used here just for initialize background / hot background gradient colors in respect to orientation.

    Declaration
    public override 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.

    Overrides
    Renderer.Draw(PaintEventArgs, IRendererInfo, Rectangle)

    DrawArrows(PaintEventArgs, BrushInfo, Pen, Rectangle, RendererInfo)

    Draws arrows on a thumbnail.

    Declaration
    protected void DrawArrows(PaintEventArgs e, BrushInfo brBackColorBrush, Pen penExpandLine, Rectangle rectThumbnail, RendererInfo bri)
    Parameters
    Type Name Description
    System.Windows.Forms.PaintEventArgs e

    Arguments passed to OnPaint event handler.

    BrushInfo brBackColorBrush

    A brush for drawing background.

    System.Drawing.Pen penExpandLine

    A pen which paints triangles.

    System.Drawing.Rectangle rectThumbnail

    Thumbnail rectangle.

    RendererInfo bri

    Instance of RendererInfo which is used to retrieve settings from.

    DrawBackground(PaintEventArgs, IRendererInfo, Rectangle)

    Draws background on graphics of some object.

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

    EventArgs that contains the event data.

    IRendererInfo ri

    Render Info

    System.Drawing.Rectangle bounds

    Rectangle bounds

    Overrides
    Renderer.DrawBackground(PaintEventArgs, IRendererInfo, Rectangle)

    DrawForeground(PaintEventArgs, IRendererInfo, Rectangle)

    A stub: no foreground here!

    Declaration
    public override 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.

    Overrides
    Renderer.DrawForeground(PaintEventArgs, IRendererInfo, Rectangle)

    DrawHotBackground(PaintEventArgs, IRendererInfo, Rectangle)

    Draws hotbackground on graphics of some object

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

    EventArgs that contains the event data.

    IRendererInfo ri

    Render Info

    System.Drawing.Rectangle bounds

    Rectangle bounds

    Overrides
    Renderer.DrawHotBackground(PaintEventArgs, IRendererInfo, Rectangle)

    DrawHotForeground(PaintEventArgs, IRendererInfo, Rectangle)

    A stub: no hot foreground here!

    Declaration
    public override 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.

    Overrides
    Renderer.DrawHotForeground(PaintEventArgs, IRendererInfo, Rectangle)

    DrawHotThumbnail(PaintEventArgs, IRendererInfo, Rectangle)

    A stub: no hot thumbnails here!

    Declaration
    public override 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.

    Overrides
    Renderer.DrawHotThumbnail(PaintEventArgs, IRendererInfo, Rectangle)

    DrawThumbnail(PaintEventArgs, IRendererInfo, Rectangle)

    A stub: no thumbnails!!!

    Declaration
    public override 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.

    Overrides
    Renderer.DrawThumbnail(PaintEventArgs, IRendererInfo, Rectangle)

    GetAppropriateThemeSettings(SplitContainerAdv, Boolean)

    For usage only within SplitContainerAdv class. Just point "this" to this method, so control properties will became appropriate for this theme.

    Declaration
    public override IRendererInfo GetAppropriateThemeSettings(SplitContainerAdv container, bool bInit)
    Parameters
    Type Name Description
    SplitContainerAdv container

    Spliter containeradv container

    System.Boolean bInit

    bool value

    Returns
    Type Description
    IRendererInfo

    Return render info

    Overrides
    Renderer.GetAppropriateThemeSettings(SplitContainerAdv, Boolean)

    GetDefaultValue(RendererProperty)

    Gets default value for property.

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

    Renderer property

    Returns
    Type Description
    System.Object

    Returns object

    Overrides
    Renderer.GetDefaultValue(RendererProperty)

    GetInstance()

    Retrieves an instance of DefaultRenderer

    Declaration
    public static BasicRenderer GetInstance()
    Returns
    Type Description
    BasicRenderer

    "new DefaultRenderer()"

    IncreaseBounds(ref Rectangle)

    Declaration
    protected void IncreaseBounds(ref Rectangle bounds)
    Parameters
    Type Name Description
    System.Drawing.Rectangle bounds

    MakeBottomArrow(Rectangle, Point[], Boolean)

    Fills an array of points with coordinates of the bottom arrow angles.

    Declaration
    protected Point[] MakeBottomArrow(Rectangle rectThumbnail, Point[] arrTriangle, bool isTop)
    Parameters
    Type Name Description
    System.Drawing.Rectangle rectThumbnail

    Thumbnail rectangle (a rectangle to draw thumbnail in).

    System.Drawing.Point[] arrTriangle

    Array of points which should be filled up with coordinates.

    System.Boolean isTop

    Is this a topmost arrow.

    Returns
    Type Description
    System.Drawing.Point[]

    An array of points, which are coordinates of triangle which represents an arrow.

    MakeLeftArrow(Rectangle, Point[], Boolean)

    Fills an array of points with coordinates of the left arrow angles.

    Declaration
    protected Point[] MakeLeftArrow(Rectangle rectThumbnail, Point[] arrTriangle, bool isTop)
    Parameters
    Type Name Description
    System.Drawing.Rectangle rectThumbnail

    Thumbnail rectangle (a rectangle to draw thumbnail in).

    System.Drawing.Point[] arrTriangle

    Array of points which should be filled up with coordinates.

    System.Boolean isTop

    Is this a topmost arrow.

    Returns
    Type Description
    System.Drawing.Point[]

    An array of points, which are coordinates of triangle which represents an arrow.

    MakeRightArrow(Rectangle, Point[], Boolean)

    Fills an array of points with coordinates of the right arrow angles.

    Declaration
    protected Point[] MakeRightArrow(Rectangle rectThumbnail, Point[] arrTriangle, bool isTop)
    Parameters
    Type Name Description
    System.Drawing.Rectangle rectThumbnail

    Thumbnail rectangle (a rectangle to draw thumbnail in).

    System.Drawing.Point[] arrTriangle

    Array of points which should be filled up with coordinates.

    System.Boolean isTop

    Is this a topmost arrow.

    Returns
    Type Description
    System.Drawing.Point[]

    An array of points, which are coordinates of triangle which represents an arrow.

    MakeTopArrow(Rectangle, Point[], Boolean)

    Fills an array of points with coordinates of the top arrow angles.

    Declaration
    protected Point[] MakeTopArrow(Rectangle rectThumbnail, Point[] arrTriangle, bool isTop)
    Parameters
    Type Name Description
    System.Drawing.Rectangle rectThumbnail

    Thumbnail rectangle (a rectangle to draw thumbnail in).

    System.Drawing.Point[] arrTriangle

    Array of points which should be filled up with coordinates.

    System.Boolean isTop

    Is this a topmost arrow.

    Returns
    Type Description
    System.Drawing.Point[]

    An array of points, which are coordinates of triangle which represents an arrow.

    SetDefaultSettings()

    Sets renderer info to default value

    Declaration
    public void SetDefaultSettings()

    UpdateRendererInfo(SplitContainerAdv, IRendererInfo)

    Updates renderer-specified information from control.

    Declaration
    public override 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.

    Overrides
    Renderer.UpdateRendererInfo(SplitContainerAdv, IRendererInfo)

    Implements

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