Class ProvideGraphicsItemsEventArgs

Custom event argument class used for obtaining the Graphics objects used for rendering the caption of docked windows.

Inheritance

System.Object

System.EventArgs

ProvideGraphicsItemsEventArgs

Inherited Members

System.EventArgs.Empty

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

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public class ProvideGraphicsItemsEventArgs : EventArgs

Remarks

The DockingManager uses the ProvideGraphicsItems event to obtain custom Graphics objects from the application to be used for drawing the caption area of docked windows.

NOTE: The main caption for floating windows is rendered by the Win32 system and cannot be customized.

ProvideGraphicsItemsEventHandler

Constructors

ProvideGraphicsItemsEventArgs(Control, Rectangle, Boolean)

Creates a new instance of the ProvideGraphicsItemsEventArgs class.

Declaration

public ProvideGraphicsItemsEventArgs(Control ctrl, Rectangle bounds, bool active)

Parameters

Type	Name	Description
System.Windows.Forms.Control	ctrl	The dockable control for which the caption is being drawn.
System.Drawing.Rectangle	bounds	The caption bounds.
System.Boolean	active	Indicates the active/inactive state of the control.

Fields

bActiveCaption

Declaration

protected bool bActiveCaption

Field Value

Type
System.Boolean

brBackground

Declaration

protected Brush brBackground

Field Value

Type
System.Drawing.Brush

clrForeground

Declaration

protected Color clrForeground

Field Value

Type
System.Drawing.Color

ctrlDocked

Declaration

protected Control ctrlDocked

Field Value

Type
System.Windows.Forms.Control

ftCaption

Declaration

protected Font ftCaption

Field Value

Type
System.Drawing.Font

rcBounds

Declaration

protected Rectangle rcBounds

Field Value

Type
System.Drawing.Rectangle

Properties

CaptionBackground

Gets / sets the Brush to be used for drawing the caption background.

Declaration

public Brush CaptionBackground { get; set; }

Property Value

Type	Description
System.Drawing.Brush	An instance of the System.Drawing.Brush class.

CaptionBounds

Returns the bounds of the caption.

Declaration

public Rectangle CaptionBounds { get; }

Property Value

Type
System.Drawing.Rectangle

Remarks

A System.Drawing.Rectangle value.

CaptionFont

Gets / sets the Font to be used for the caption text.

Declaration

public Font CaptionFont { get; set; }

Property Value

Type	Description
System.Drawing.Font	An instance of the System.Drawing.Font class.

CaptionForeground

Gets / sets the Color to be used for drawing the caption text and buttons.

Declaration

public Color CaptionForeground { get; set; }

Property Value

Type	Description
System.Drawing.Color	A System.Drawing.Color value.

Control

Returns the dockable control for which the caption is being drawn.

Declaration

public Control Control { get; }

Property Value

Type	Description
System.Windows.Forms.Control	A System.Windows.Forms.Control instance.

IsActiveCaption

Returns the active/inactive state of the docking window.

Declaration

public bool IsActiveCaption { get; }

Property Value

Type	Description
System.Boolean	TRUE if the window is active.