CanvasDrawContext Class

public class CanvasDrawContext : DisposableObjectBase, IDisposable

public CanvasDrawContext(ICanvas canvas, DrawingContext platformRenderer, Rect bounds)

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

public Rect Bounds { get; }

Property Value

Rect:

The bounds in which to draw.

public ICanvas Canvas { get; }

Property Value

ICanvas:

The ICanvas being drawn.

public Rect ClipBounds { get; }

Property Value

Rect:

The current clip bounds in which to draw.

See Also

• PopClip()
• PushClip(Rect)

public DrawingContext PlatformRenderer { get; }

Property Value

DrawingContext:

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(Rect bounds, Color color, LineKind lineKind, float strokeWidth)

Parameter	Type	Description
bounds	Rect	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(Rect bounds, Pen pen)

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

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

Parameter	Type	Description
location	Point	The location at which to draw the geometry.
geometry	Geometry	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, Geometry geometry, Pen pen)

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

public void DrawImage(Point location, ImageSource imageSource)

Parameter	Type	Description
location	Point	The location at which to draw the image.
imageSource	ImageSource	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(Rect bounds, Color color, LineKind lineKind, float strokeWidth)

Parameter	Type	Description
bounds	Rect	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(Rect bounds, Pen pen)

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

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

Parameter	Type	Description
bounds	Rect	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(Rect bounds, float radius, Pen pen)

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

public void DrawSquiggleLine(Rect bounds, Color color)

Parameter	Type	Description
bounds	Rect	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(Rect bounds, Brush brush)

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

public void FillEllipse(Rect bounds, Color color)

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

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

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

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

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

public void FillRectangle(Rect bounds, Brush brush)

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

public void FillRectangle(Rect bounds, Color color)

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

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

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

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

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

public void PopBounds()

public void PopClip()

public void PopScaleTransform()

public void PushBounds(Rect bounds)

Parameter	Type	Description
bounds	Rect	The new target bounds.

public void PushClip(Rect clipBounds)

Parameter	Type	Description
clipBounds	Rect	The clip bounds.

public void PushScaleTransform(double newScale)

Parameter	Type	Description
newScale	double	The scale factor.