IDWriteTextLayout::SetInlineObject method
Sets the inline object.
Syntax
virtual HRESULT SetInlineObject(
IDWriteInlineObject * inlineObject,
DWRITE_TEXT_RANGE textRange
) = 0;
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
|
Minimum supported client |
Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps] |
|---|---|
|
Minimum supported server |
Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps] |
|
Minimum supported phone |
Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps] |
|
Header |
|
|
Library |
|
|
DLL |
|
See also