ICanvasTextInlineObject.Draw Method

ICanvasTextInlineObjectDraw Method

Signals to the app that it should draw the inline object.

Namespace: Microsoft.Graphics.Canvas.Text
Assembly: Microsoft.Graphics.Canvas (in Microsoft.Graphics.Canvas.dll) Version: 0.0.0.0

Syntax

Copy

void Draw(
	ICanvasTextRenderer textRenderer,
	Vector2 point,
	bool isSideways,
	bool isRightToLeft,
	Object brush
)

Parameters

textRenderer: Type: Microsoft.Graphics.Canvas.TextICanvasTextRenderer
point: Type: System.NumericsVector2
isSideways: Type: SystemBoolean
isRightToLeft: Type: SystemBoolean
brush: Type: SystemObject

Remarks

The ICanvasTextRenderer object is only passed through as non-null if the app is using a custom renderer. In this case, it is recommended that the app's implementation of Draw avoids calling DrawInlineObject, if it will lead to recursion.

An inline object's Draw method may be called whenever a text layout containing that inline object:

Is drawn to a drawing session
Is drawn to an app's custom text renderer
Is used to produce geometry for CreateText(CanvasTextLayout)

As such, an inline object may be implemented to draw to a drawing session, or add to a geometry, for example.

Reference

ICanvasTextInlineObject Interface

Microsoft.Graphics.Canvas.Text Namespace