IDWriteTextLayout::GetDrawingEffect method
Gets the application-defined drawing effect at the specified text position.
Syntax
virtual HRESULT GetDrawingEffect(
UINT32 currentPosition,
[out] IUnknown ** drawingEffect,
[out, optional] DWRITE_TEXT_RANGE * textRange
) = 0;
Parameters
- currentPosition
-
Type: UINT32
The position of the text whose drawing effect is to be retrieved.
- drawingEffect [out]
-
Type: IUnknown**
When this method returns, contains an address of a pointer to the current application-defined drawing effect. Usually this effect is a foreground brush that is used in glyph drawing.
- textRange [out, optional]
-
Type: DWRITE_TEXT_RANGE*
Contains the range of text that has the same formatting as the text at the position specified by currentPosition. This means the run has the exact formatting as the position specified, including but not limited to the drawing effect.
Return value
Type: HRESULT
If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.
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