Edit

IDWriteTextLayout::SetInlineObject method (dwrite.h)

  • Article

Sets the inline object.

Syntax

HRESULT SetInlineObject(
  IDWriteInlineObject *inlineObject,
  DWRITE_TEXT_RANGE   textRange
);

Parameters

inlineObject

Type: IDWriteInlineObject*

An application-defined inline object.

textRange

Type: DWRITE_TEXT_RANGE

Text range to which this change applies.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

The application may call this function to specify the set of properties describing an application-defined inline object for specific range.

This inline object applies to the specified range and will be passed back to the application by way of the DrawInlineObject callback when the range is drawn. Any text in that range will be suppressed.

Requirements

Requirement Value
Minimum supported client Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | UWP apps]
Minimum supported server Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header dwrite.h
Library Dwrite.lib
DLL Dwrite.dll

See also

IDWriteTextLayout