DockRenderer Class
Provides the default renderer for dock controls.
[ToolboxBitmap(typeof(DockRenderer))]
[TypeConverter(typeof(GenericExpandableNullableObjectConverter))]
public abstract class DockRenderer : UIRenderer, IDisposable, IDockRenderer, IUIRenderer
- Inheritance:
- object MarshalByRefObject DisposableObject UIRenderer object
- Derived:
- WindowsClassicDockRenderer
- Implements:
- IDisposable IDockRenderer IUIRenderer
Constructors
DockRenderer()
Initializes a new instance of the DockRenderer
class.
public DockRenderer()
Remarks
The default constructor initializes all fields to their default values.
DockRenderer(IWindowsColorScheme)
Initializes a new instance of the DockRenderer
class.
protected DockRenderer(IWindowsColorScheme colorScheme)
Parameter | Type | Description |
---|---|---|
colorScheme | IWindowsColorScheme | The IWindowsColorScheme to use as a base for the colors. |
Remarks
The default constructor initializes all fields to their default values.
Properties
AutoHideTabGroupMargin
Gets or sets the margin space that surrounds a tab group in a AutoHideTabStripPanel control.
public virtual int AutoHideTabGroupMargin { get; set; }
Property Value
- int:
The margin space that surrounds a tab group in a AutoHideTabStripPanel control.
AutoHideTabImageMargin
Gets or sets the margin space that surrounds an image in a AutoHideTab.
public virtual int AutoHideTabImageMargin { get; set; }
Property Value
- int:
The margin space that surrounds an image in a AutoHideTab.
AutoHideTabIndent
Gets or sets the amount of space that a AutoHideTab should be indented.
public virtual int AutoHideTabIndent { get; set; }
Property Value
- int:
The amount of space that a AutoHideTab should be indented.
AutoHideTabOuterMargin
Gets or sets the margin space between a AutoHideTab and the outer edge of the control.
public virtual int AutoHideTabOuterMargin { get; set; }
Property Value
- int:
The margin space between a AutoHideTab and the outer edge of the control.
AutoHideTabOverlap
Gets or sets the amount of space that sequential AutoHideTab elements overlap each other.
public virtual int AutoHideTabOverlap { get; set; }
Property Value
- int:
The amount of space that sequential AutoHideTab elements overlap each other.
AutoHideTabSelectedFont
Gets or sets the Font to use when drawing the selected tab of a AutoHideTabGroup.
public virtual Font AutoHideTabSelectedFont { get; set; }
Property Value
- Font:
The Font to use when drawing the selected tab of a AutoHideTabGroup.
AutoHideTabStripPanelMargin
Gets or sets the margin space that surrounds the outside of an AutoHideTabStripPanel.
public virtual int AutoHideTabStripPanelMargin { get; set; }
Property Value
- int:
The margin space that surrounds the outside of an AutoHideTabStripPanel.
AutoHideTabTextMargin
Gets or sets the margin space that surrounds the text in a AutoHideTab.
public virtual int AutoHideTabTextMargin { get; set; }
Property Value
- int:
The margin space that surrounds the text in a AutoHideTab.
AutoHideTabUnselectedFont
Gets or sets the Font to use when drawing the unselected tab of a AutoHideTabGroup.
public virtual Font AutoHideTabUnselectedFont { get; set; }
Property Value
- Font:
The Font to use when drawing the unselected tab of a AutoHideTabGroup.
DockContainerTitleBarButtonSize
Gets or sets the Size of a DockContainer title bar button.
public virtual Size DockContainerTitleBarButtonSize { get; set; }
Property Value
- Size:
The Size of a DockContainer title bar button.
DockContainerTitleBarFont
Gets or sets the Font to use when drawing a DockContainer title bar.
public virtual Font DockContainerTitleBarFont { get; set; }
Property Value
- Font:
The Font to use when drawing a DockContainer title bar.
ResetAllPropertiesOnSystemColorChange
Gets or sets whether to reset all properties when a system color change event occurs.
public bool ResetAllPropertiesOnSystemColorChange { get; set; }
Property Value
- bool:
true
if all properties should be reset; otherwise,false
.
SplitterExtent
Gets or sets the extent of a splitter.
TabbedMdiContainerPadding
Gets the margin space that surrounds the content in a TabbedMdiContainer.
public virtual int TabbedMdiContainerPadding { get; set; }
Property Value
- int:
The margin space that surrounds the content in a TabbedMdiContainer.
Methods
DrawAutoHideTab(PaintEventArgs, Rectangle, AutoHideTab)
Draws a AutoHideTab.
public abstract void DrawAutoHideTab(PaintEventArgs e, Rectangle bounds, AutoHideTab autoHideTab)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
autoHideTab | AutoHideTab | The AutoHideTab that is being painted. |
DrawAutoHideTabStripPanelBackground(PaintEventArgs, Rectangle, AutoHideTabStripPanel)
Draws the background of a AutoHideTabStripPanel control.
public abstract void DrawAutoHideTabStripPanelBackground(PaintEventArgs e, Rectangle bounds, AutoHideTabStripPanel autoHideTabStripPanel)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
autoHideTabStripPanel | AutoHideTabStripPanel | The AutoHideTabStripPanel being painted. |
DrawDockContainerBackground(PaintEventArgs, Rectangle, DockContainer)
Draws the background of a DockContainer.
public abstract void DrawDockContainerBackground(PaintEventArgs e, Rectangle bounds, DockContainer dockContainer)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
dockContainer | DockContainer | The DockContainer that is being painted. |
DrawDockContainerTitleBarBackground(PaintEventArgs, Rectangle, DockContainer)
Draws the background of a DockContainer title bar.
public abstract void DrawDockContainerTitleBarBackground(PaintEventArgs e, Rectangle bounds, DockContainer dockContainer)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
dockContainer | DockContainer | The DockContainer whose title bar is being painted. |
DrawDockContainerTitleBarButton(PaintEventArgs, Rectangle, DockContainerTitleBarButton)
Draws a DockContainerTitleBarButton.
public abstract void DrawDockContainerTitleBarButton(PaintEventArgs e, Rectangle bounds, DockContainerTitleBarButton button)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
button | DockContainerTitleBarButton | The DockContainerTitleBarButton that is being painted. |
DrawDockContainerTitleBarForeground(PaintEventArgs, Rectangle, DockContainer)
Draws the foreground of a DockContainer title bar.
public abstract void DrawDockContainerTitleBarForeground(PaintEventArgs e, Rectangle bounds, DockContainer dockContainer)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
dockContainer | DockContainer | The DockContainer whose title bar is being painted. |
DrawDockObjectSplitter(PaintEventArgs, Rectangle, IDockObject, Orientation)
Draws the background of a splitter for a IDockObject.
public abstract void DrawDockObjectSplitter(PaintEventArgs e, Rectangle bounds, IDockObject dockObject, Orientation orientation)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
dockObject | IDockObject | The IDockObject whose splitter is being painted. |
orientation | Orientation | The Orientation of the splitter. |
DrawTabbedMdiContainerBackground(PaintEventArgs, Rectangle, TabbedMdiContainer)
Draws the background of a TabbedMdiContainer.
public abstract void DrawTabbedMdiContainerBackground(PaintEventArgs e, Rectangle bounds, TabbedMdiContainer tabbedMdiContainer)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
tabbedMdiContainer | TabbedMdiContainer | The TabbedMdiContainer whose title bar is being painted. |
DrawTabbedMdiRootContainerBackground(PaintEventArgs, Rectangle, TabbedMdiRootContainer)
Draws the background of a TabbedMdiRootContainer.
public abstract void DrawTabbedMdiRootContainerBackground(PaintEventArgs e, Rectangle bounds, TabbedMdiRootContainer mdiRootContainer)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
mdiRootContainer | TabbedMdiRootContainer | The TabbedMdiRootContainer whose title bar is being painted. |
DrawTabbedMdiWindowBackground(PaintEventArgs, Rectangle, TabbedMdiWindow)
Draws the background of a TabbedMdiWindow.
public abstract void DrawTabbedMdiWindowBackground(PaintEventArgs e, Rectangle bounds, TabbedMdiWindow tabbedMdiWindow)
Parameter | Type | Description |
---|---|---|
e | PaintEventArgs | A PaintEventArgs that contains the event data. |
bounds | Rectangle | The bounds in which to draw. |
tabbedMdiWindow | TabbedMdiWindow | The TabbedMdiWindow that is being painted. |
MeasureAutoHideTab(Graphics, AutoHideTab)
Measures the tab for the specified AutoHideTab.
public virtual Size MeasureAutoHideTab(Graphics g, AutoHideTab autoHideTab)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
autoHideTab | AutoHideTab | The AutoHideTab whose tab is being measured. |
Returns
MeasureAutoHideTabCore(Graphics, AutoHideTab)
Measures the tab for the specified AutoHideTab using core routines.
protected Size MeasureAutoHideTabCore(Graphics g, AutoHideTab autoHideTab)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
autoHideTab | AutoHideTab | The AutoHideTab whose tab is being measured. |
Returns
MeasureDockContainerTitleBar(Graphics, Size, DockContainer)
Measures a DockContainer title bar.
public abstract Size MeasureDockContainerTitleBar(Graphics g, Size availableSize, DockContainer dockContainer)
Parameter | Type | Description |
---|---|---|
g | Graphics | The |
availableSize | Size | The available size. |
dockContainer | DockContainer | The DockContainer whose title bar is being measured. |
Returns
OnSystemUserPreferenceColorChanged()
Occurs when user preferences are changed for the color category.
protected override void OnSystemUserPreferenceColorChanged()
Remarks
This method will only be invoked if IsSystemUserPreferenceColorChangeMonitored returns true
.
ResetAll(bool)
Resets all property values to their defaults.
protected virtual void ResetAll(bool force)
Parameter | Type | Description |
---|---|---|
force | bool | Whether to force resetting. |
ResetAutoHideTabGroupMargin()
Resets the AutoHideTabGroupMargin property to its default value.
public virtual void ResetAutoHideTabGroupMargin()
ResetAutoHideTabImageMargin()
Resets the AutoHideTabImageMargin property to its default value.
public virtual void ResetAutoHideTabImageMargin()
ResetAutoHideTabIndent()
Resets the AutoHideTabIndent property to its default value.
public virtual void ResetAutoHideTabIndent()
ResetAutoHideTabOuterMargin()
Resets the AutoHideTabOuterMargin property to its default value.
public virtual void ResetAutoHideTabOuterMargin()
ResetAutoHideTabOverlap()
Resets the AutoHideTabOverlap property to its default value.
public virtual void ResetAutoHideTabOverlap()
ResetAutoHideTabSelectedFont()
Resets the AutoHideTabSelectedFont property to its default value.
public virtual void ResetAutoHideTabSelectedFont()
ResetAutoHideTabStripPanelMargin()
Resets the AutoHideTabStripPanelMargin property to its default value.
public virtual void ResetAutoHideTabStripPanelMargin()
ResetAutoHideTabTextMargin()
Resets the AutoHideTabTextMargin property to its default value.
public virtual void ResetAutoHideTabTextMargin()
ResetAutoHideTabUnselectedFont()
Resets the AutoHideTabUnselectedFont property to its default value.
public virtual void ResetAutoHideTabUnselectedFont()
ResetDockContainerTitleBarButtonSize()
Resets the DockContainerTitleBarButtonSize property to its default value.
public virtual void ResetDockContainerTitleBarButtonSize()
ResetDockContainerTitleBarFont()
Resets the DockContainerTitleBarFont property to its default value.
public virtual void ResetDockContainerTitleBarFont()
ResetResetAllPropertiesOnSystemColorChange()
Resets the ResetAllPropertiesOnSystemColorChange property to its default value.
public virtual void ResetResetAllPropertiesOnSystemColorChange()
ResetSplitterExtent()
Resets the SplitterExtent property to its default value.
public virtual void ResetSplitterExtent()
ResetTabbedMdiContainerPadding()
Resets the TabbedMdiContainerPadding property to its default value.
public virtual void ResetTabbedMdiContainerPadding()
ShouldSerializeAutoHideTabGroupMargin()
Indicates whether the AutoHideTabGroupMargin property should be persisted.
public virtual bool ShouldSerializeAutoHideTabGroupMargin()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeAutoHideTabImageMargin()
Indicates whether the AutoHideTabImageMargin property should be persisted.
public virtual bool ShouldSerializeAutoHideTabImageMargin()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeAutoHideTabIndent()
Indicates whether the AutoHideTabIndent property should be persisted.
public virtual bool ShouldSerializeAutoHideTabIndent()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeAutoHideTabOuterMargin()
Indicates whether the AutoHideTabOuterMargin property should be persisted.
public virtual bool ShouldSerializeAutoHideTabOuterMargin()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeAutoHideTabOverlap()
Indicates whether the AutoHideTabOverlap property should be persisted.
public virtual bool ShouldSerializeAutoHideTabOverlap()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeAutoHideTabSelectedFont()
Indicates whether the AutoHideTabSelectedFont property should be persisted.
public virtual bool ShouldSerializeAutoHideTabSelectedFont()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeAutoHideTabStripPanelMargin()
Indicates whether the AutoHideTabStripPanelMargin property should be persisted.
public virtual bool ShouldSerializeAutoHideTabStripPanelMargin()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeAutoHideTabTextMargin()
Indicates whether the AutoHideTabTextMargin property should be persisted.
public virtual bool ShouldSerializeAutoHideTabTextMargin()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeAutoHideTabUnselectedFont()
Indicates whether the AutoHideTabUnselectedFont property should be persisted.
public virtual bool ShouldSerializeAutoHideTabUnselectedFont()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeDockContainerTitleBarButtonSize()
Indicates whether the DockContainerTitleBarButtonSize property should be persisted.
public virtual bool ShouldSerializeDockContainerTitleBarButtonSize()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeDockContainerTitleBarFont()
Indicates whether the DockContainerTitleBarFont property should be persisted.
public virtual bool ShouldSerializeDockContainerTitleBarFont()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeResetAllPropertiesOnSystemColorChange()
Indicates whether the ResetAllPropertiesOnSystemColorChange property should be persisted.
public virtual bool ShouldSerializeResetAllPropertiesOnSystemColorChange()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeSplitterExtent()
Indicates whether the SplitterExtent property should be persisted.
public virtual bool ShouldSerializeSplitterExtent()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
ShouldSerializeTabbedMdiContainerPadding()
Indicates whether the TabbedMdiContainerPadding property should be persisted.
public virtual bool ShouldSerializeTabbedMdiContainerPadding()
Returns
- bool:
true
if the property value has changed from its default; otherwise,false
.
Inherited Members
- UIRenderer.Dispose(bool)
- UIRenderer.Equals(object)
- UIRenderer.GetHashCode()
- UIRenderer.OnColorSchemeChanged()
- UIRenderer.OnPropertyChanged(EventArgs)
- UIRenderer.ColorScheme
- UIRenderer.IsSystemUserPreferenceColorChangeMonitored
- UIRenderer.PropertyChanged
- DisposableObject.Dispose()
- DisposableObject.VerifyNotDisposed()
- DisposableObject.IsDisposed
- DisposableObject.Disposed
- MarshalByRefObject.GetLifetimeService()
- MarshalByRefObject.InitializeLifetimeService()
- MarshalByRefObject.MemberwiseClone(bool)
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object, object)
- object.ReferenceEquals(object, object)