Class RendrerBase
Base renderer for NavigationView control.
Inheritance
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools.Navigation.Rendering
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public abstract class RendrerBase : IRenderer, IDisposable
Constructors
RendrerBase()
Declaration
protected RendrerBase()
Fields
m_g
Declaration
protected Graphics m_g
Field Value
| Type |
|---|
| System.Drawing.Graphics |
m_layouter
Declaration
protected ILayouter m_layouter
Field Value
| Type |
|---|
| ILayouter |
m_navView
Declaration
protected NavigationView m_navView
Field Value
| Type |
|---|
| NavigationView |
m_states
Declaration
protected IAreasStateCache m_states
Field Value
| Type |
|---|
| IAreasStateCache |
PressedOffset
Declaration
public readonly int PressedOffset
Field Value
| Type |
|---|
| System.Int32 |
Methods
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
Dispose(Boolean)
Releases unmanaged and - optionally - managed resources
Declaration
protected void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | disposing |
|
Finalize()
Finalizes an instance of the RendrerBase class.
Declaration
protected void Finalize()
GetBarBackgroundBrush(Rectangle, Color, Color, Blend)
Creates background brush for a Bar.
Declaration
protected static Brush GetBarBackgroundBrush(Rectangle bounds, Color cl1, Color cl2, Blend blend)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Rectangle | bounds | The bounds. |
| System.Drawing.Color | cl1 | First color. |
| System.Drawing.Color | cl2 | Second color. |
| System.Drawing.Drawing2D.Blend | blend | The blend. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Brush | Created background brush. |
GetBarDropDownArrowBounds(BarLayoutInfo, Image)
Gets the bounds of bar's drop-down button's arrow.
Declaration
protected virtual Rectangle GetBarDropDownArrowBounds(BarLayoutInfo layout, Image image)
Parameters
| Type | Name | Description |
|---|---|---|
| BarLayoutInfo | layout | The bar's layout. |
| System.Drawing.Image | image | The image. |
Returns
| Type | Description |
|---|---|
| System.Drawing.Rectangle | The arrow bounds. |
InitRenderer(NavigationView, Graphics, ILayouter, IAreasStateCache)
Initializes the renderer.
Declaration
protected virtual void InitRenderer(NavigationView navView, Graphics g, ILayouter layouter, IAreasStateCache states)
Parameters
| Type | Name | Description |
|---|---|---|
| NavigationView | navView | NavigationView control to render. |
| System.Drawing.Graphics | g | NavigationView control's System.Drawing.Graphics. |
| ILayouter | layouter | NavigationView control's layouter. |
| IAreasStateCache | states | NavigationView control's area states. |
MetroRenderHistoryButtonImage(Rectangle, String)
Declaration
protected virtual void MetroRenderHistoryButtonImage(Rectangle bounds, string historystate)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Rectangle | bounds | |
| System.String | historystate |
RenderArrowButton(LayoutInfo)
Renders the history drop down button.
Declaration
protected virtual void RenderArrowButton(LayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| LayoutInfo | layout | The area's layout information. |
RenderBackground()
Renders control's background.
Declaration
protected virtual void RenderBackground()
RenderBar(Bar, BarLayoutInfo)
Renders the bar.
Declaration
protected virtual void RenderBar(Bar bar, BarLayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| Bar | bar | The bar to be rendered. |
| BarLayoutInfo | layout | The bar's layout info. |
RenderBarBackground(Bar, BarLayoutInfo)
Renders the bar's background.
Declaration
protected abstract void RenderBarBackground(Bar bar, BarLayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| Bar | bar | The bar to be rendered. |
| BarLayoutInfo | layout | The bar's layout info. |
RenderBarBorder(AreaStates, Boolean, Rectangle)
Renders the bar's border.
Declaration
protected virtual void RenderBarBorder(AreaStates barState, bool drawBarBorder, Rectangle bounds)
Parameters
| Type | Name | Description |
|---|---|---|
| AreaStates | barState | State of the drop-down button. |
| System.Boolean | drawBarBorder | if set to |
| System.Drawing.Rectangle | bounds | The bounds. |
RenderBarBorders(Bar, BarLayoutInfo)
Renders the bar's borders.
Declaration
protected virtual void RenderBarBorders(Bar bar, BarLayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| Bar | bar | The bar to be rendered. |
| BarLayoutInfo | layout | The bar's layout info. |
RenderBarDropDown(Bar, BarLayoutInfo)
Renders the bar's drop down button.
Declaration
protected virtual void RenderBarDropDown(Bar bar, BarLayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| Bar | bar | The bar to be rendered. |
| BarLayoutInfo | layout | The bar's layout info. |
RenderBarDropDownArrow(Bar, BarLayoutInfo)
Renders the bar drop-down button's arrow.
Declaration
protected virtual void RenderBarDropDownArrow(Bar bar, BarLayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| Bar | bar | The bar to be rendered. |
| BarLayoutInfo | layout | The bar's layout info. |
RenderBarDropDownBorder(AreaStates, Boolean, BarLayoutInfo)
Renders the border of bar's drop-down button.
Declaration
protected virtual void RenderBarDropDownBorder(AreaStates barState, bool bDrawBarBorder, BarLayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| AreaStates | barState | State of the drop-down button. |
| System.Boolean | bDrawBarBorder | if set to |
| BarLayoutInfo | layout | The bar's layout. |
RenderBarImage(LayoutInfo)
Renders the selected bar's image.
Declaration
protected virtual void RenderBarImage(LayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| LayoutInfo | layout | The layout info. |
RenderBars()
Renders the bars.
Declaration
protected virtual void RenderBars()
RenderBarsArea()
Renders the bars' area.
Declaration
protected virtual void RenderBarsArea()
RenderBarText(Bar, AreaStates, Rectangle)
Renders the bar's text.
Declaration
protected virtual void RenderBarText(Bar bar, AreaStates state, Rectangle textBounds)
Parameters
| Type | Name | Description |
|---|---|---|
| Bar | bar | The bar to be rendered. |
| AreaStates | state | The state. |
| System.Drawing.Rectangle | textBounds | The text bounds. |
RenderBarTextArea(Bar, BarLayoutInfo)
Renders the bar's text area.
Declaration
protected virtual void RenderBarTextArea(Bar bar, BarLayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| Bar | bar | The bar to be rendered. |
| BarLayoutInfo | layout | The bar's layout info. |
RenderBorder(AreaStates, Rectangle)
Renders the border within specified bounds with specified state.
Declaration
protected abstract void RenderBorder(AreaStates state, Rectangle bounds)
Parameters
| Type | Name | Description |
|---|---|---|
| AreaStates | state | The state. |
| System.Drawing.Rectangle | bounds | The bounds. |
RenderBorders()
Renders control's borders.
Declaration
protected virtual void RenderBorders()
RenderControl(NavigationView, Graphics, ILayouter, IAreasStateCache)
Renders control.
Declaration
public virtual void RenderControl(NavigationView navView, Graphics g, ILayouter layouter, IAreasStateCache states)
Parameters
| Type | Name | Description |
|---|---|---|
| NavigationView | navView | NavigationView control to render. |
| System.Drawing.Graphics | g | NavigationView control's System.Drawing.Graphics. |
| ILayouter | layouter | NavigationView control's layouter. |
| IAreasStateCache | states | NavigationView control's area states. |
RenderCustomButtonsArea()
Renders custom buttons' area.
Declaration
protected virtual void RenderCustomButtonsArea()
RenderDropDown(LayoutInfo)
Renders the drop-down button.
Declaration
protected abstract void RenderDropDown(LayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| LayoutInfo | layout | The drop-down button's layout. |
RenderEditorArea()
Renders the editor area.
Declaration
protected abstract void RenderEditorArea()
RenderHistoryBackButton(LayoutInfo)
Renders the history back button.
Declaration
protected virtual void RenderHistoryBackButton(LayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| LayoutInfo | layout | The area's layout information. |
RenderHistoryButtonsArea()
Renders the history buttons' area.
Declaration
protected virtual void RenderHistoryButtonsArea()
RenderHistoryButtonsBackground()
Renders the history buttons's background.
Declaration
protected virtual void RenderHistoryButtonsBackground()
RenderHistoryButtonsImage(Image, Rectangle)
Declaration
protected virtual void RenderHistoryButtonsImage(Image image, Rectangle bounds)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Image | image | |
| System.Drawing.Rectangle | bounds |
RenderHistoryButtonsImage(String, Rectangle)
Renders the history button's image.
Declaration
protected virtual void RenderHistoryButtonsImage(string dropdownstate, Rectangle bounds)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | dropdownstate | |
| System.Drawing.Rectangle | bounds | The bounds. |
RenderHistoryDropDownButton(LayoutInfo)
Renders the history drop down button.
Declaration
protected virtual void RenderHistoryDropDownButton(LayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| LayoutInfo | layout | The area's layout information. |
RenderHistoryForwardButton(LayoutInfo)
Renders the history forward button.
Declaration
protected virtual void RenderHistoryForwardButton(LayoutInfo layout)
Parameters
| Type | Name | Description |
|---|---|---|
| LayoutInfo | layout | The area's layout information. |
SetTextBoxBackColor(Color)
Sets the color of the text box background.
Declaration
protected void SetTextBoxBackColor(Color clrBack)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Drawing.Color | clrBack | The background color. |