CanvasDrawContext Class

public class CanvasDrawContext : DisposableObject, IDisposable

public CanvasDrawContext(ICanvas canvas, Graphics platformRenderer, Rectangle bounds)

Parameter	Type	Description
canvas	ICanvas	The ICanvas being drawn.
platformRenderer	Graphics	The native object used for drawing.
bounds	Rectangle	The bounds in which to draw.

public Rectangle Bounds { get; }

Property Value

Rectangle:

The bounds in which to draw.

public ICanvas Canvas { get; }

Property Value

ICanvas:

The ICanvas being drawn.

public Rectangle ClipBounds { get; }

Property Value

Rectangle:

The current clip bounds in which to draw.

See Also

• PopClip()
• PushClip(Rectangle)

public float DpiScale { get; }

Property Value

float:

The additional scale factor caused by the monitor DPI (WinForms only).

public bool IsNativeRendering { get; set; }

Property Value

bool:

true if native rendering is currently active; otherwise, false.

public Graphics PlatformRenderer { get; }

Property Value

Graphics:

The native object used for drawing.

public double Scale { get; }

Property Value

double:

The current scale factor.

protected override void Dispose(bool disposing)

Parameter	Type	Description
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

This method is called by the public Dispose method and the Finalize method. Dispose invokes this method with the disposing parameter set to true. Finalize invokes this method with disposing set to false.

public void DrawEllipse(Rectangle bounds, Color color, LineKind lineKind, float strokeWidth)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
color	Color	The line color.
lineKind	LineKind	A LineKind that indicates the line's dash style. A common default value is Solid.
strokeWidth	float	The stroke width. A common default value is 1.0.

public void DrawEllipse(Rectangle bounds, Pen pen)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
pen	Pen	The line pen.

public void DrawGeometry(Point location, GraphicsPath geometry, Color color, LineKind lineKind, float strokeWidth)

Parameter	Type	Description
location	Point	The location at which to draw the geometry.
geometry	GraphicsPath	The geometry.
color	Color	The stroke color.
lineKind	LineKind	A LineKind that indicates the line's dash style. A common default value is Solid.
strokeWidth	float	The stroke width. A common default value is 1.0.

public void DrawGeometry(Point location, GraphicsPath geometry, Pen pen)

Parameter	Type	Description
location	Point	The location at which to draw the geometry.
geometry	GraphicsPath	The geometry.
pen	Pen	The stroke pen.

public void DrawImage(Point location, Image imageSource)

Parameter	Type	Description
location	Point	The location at which to draw the image.
imageSource	Image	The image source.

public void DrawLine(Point startLocation, Point endLocation, Color color, LineKind lineKind, float strokeWidth)

Parameter	Type	Description
startLocation	Point	The start location of the line.
endLocation	Point	The end location of the line.
color	Color	The line color.
lineKind	LineKind	A LineKind that indicates the line's dash style. A common default value is Solid.
strokeWidth	float	The stroke width. A common default value is 1.0.

public void DrawLine(Point startLocation, Point endLocation, Pen pen)

Parameter	Type	Description
startLocation	Point	The start location of the line.
endLocation	Point	The end location of the line.
pen	Pen	The line pen.

public void DrawRectangle(Rectangle bounds, Color color, LineKind lineKind, float strokeWidth)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
color	Color	The line color.
lineKind	LineKind	A LineKind that indicates the line's dash style. A common default value is Solid.
strokeWidth	float	The stroke width. A common default value is 1.0.

public void DrawRectangle(Rectangle bounds, Pen pen)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
pen	Pen	The line color.

public void DrawRoundedRectangle(Rectangle bounds, float radius, Color color, LineKind lineKind, float strokeWidth)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
radius	float	The corner radius.
color	Color	The line color.
lineKind	LineKind	A LineKind that indicates the line's dash style. A common default value is Solid.
strokeWidth	float	The stroke width. A common default value is 1.0.

public void DrawRoundedRectangle(Rectangle bounds, float radius, Pen pen)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
radius	float	The corner radius.
pen	Pen	The line color.

public void DrawSquiggleLine(Rectangle bounds, Color color)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
color	Color	The line color.

public void DrawText(Point location, ITextLayoutLine line)

Parameter	Type	Description
location	Point	The location at which to draw the text.
line	ITextLayoutLine	The ITextLayoutLine to draw.

public void FillEllipse(Rectangle bounds, Brush brush)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
brush	Brush	The fill brush.

public void FillEllipse(Rectangle bounds, Color color)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
color	Color	The fill color.

public void FillGeometry(Point location, GraphicsPath geometry, Brush brush)

Parameter	Type	Description
location	Point	The location at which to draw the geometry.
geometry	GraphicsPath	The geometry.
brush	Brush	The fill brush.

public void FillGeometry(Point location, GraphicsPath geometry, Color color)

Parameter	Type	Description
location	Point	The location at which to draw the geometry.
geometry	GraphicsPath	The geometry.
color	Color	The fill color.

public void FillRectangle(Rectangle bounds, Brush brush)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
brush	Brush	The fill brush.

public void FillRectangle(Rectangle bounds, Color color)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
color	Color	The fill color.

public void FillRoundedRectangle(Rectangle bounds, float radius, Brush brush)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
radius	float	The corner radius.
brush	Brush	The fill brush.

public void FillRoundedRectangle(Rectangle bounds, float radius, Color color)

Parameter	Type	Description
bounds	Rectangle	The bounds in which to draw.
radius	float	The corner radius.
color	Color	The fill color.

public void PopBounds()

public void PopClip()

public void PushBounds(Rectangle bounds)

Parameter	Type	Description
bounds	Rectangle	The new target bounds.

public void PushClip(Rectangle clipBounds)

Parameter	Type	Description
clipBounds	Rectangle	The clip bounds.