C1.Win.C1DX.4.8 Assembly / C1.Util.DX.DirectWrite Namespace / TextRendererBase Class / DrawInlineObject Method
The application-defined drawing context passed to IDWriteTextLayout::Draw.
X-coordinate at the top-left corner of the inline object.
Y-coordinate at the top-left corner of the inline object.
The application-defined inline object set using IDWriteTextFormat::SetInlineObject.
A Boolean flag that indicates whether the object's baseline runs alongside the baseline axis of the line.
A Boolean flag that indicates whether the object is in a right-to-left context, hinting that the drawing may want to mirror the normal image.
Application-defined drawing effects for the glyphs to render. Usually this argument represents effects such as the foreground brush filling the interior of a line.

In This Topic
DrawInlineObject Method (TextRendererBase)
In This Topic
IDWriteTextLayout::Draw calls this application callback when it needs to draw an inline object.
Syntax
'Declaration
 
Public Overridable Function DrawInlineObject( _
   ByVal clientDrawingContext As System.Object, _
   ByVal originX As System.Single, _
   ByVal originY As System.Single, _
   ByVal inlineObject As InlineObject, _
   ByVal isSideways As System.Boolean, _
   ByVal isRightToLeft As System.Boolean, _
   ByVal clientDrawingEffectPtr As System.IntPtr _
) As HResult
 

Parameters

clientDrawingContext
The application-defined drawing context passed to IDWriteTextLayout::Draw.
originX
X-coordinate at the top-left corner of the inline object.
originY
Y-coordinate at the top-left corner of the inline object.
inlineObject
The application-defined inline object set using IDWriteTextFormat::SetInlineObject.
isSideways
A Boolean flag that indicates whether the object's baseline runs alongside the baseline axis of the line.
isRightToLeft
A Boolean flag that indicates whether the object is in a right-to-left context, hinting that the drawing may want to mirror the normal image.
clientDrawingEffectPtr
Application-defined drawing effects for the glyphs to render. Usually this argument represents effects such as the foreground brush filling the interior of a line.

Return Value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
See Also