IDWriteTextLayout::GetUnderline method
Gets the underline presence of the text at the specified position.
Syntax
virtual HRESULT GetUnderline(
UINT32 currentPosition,
[out] BOOL * hasUnderline,
[out, optional] DWRITE_TEXT_RANGE * textRange
) = 0;
Parameters
- currentPosition
-
Type: UINT32
The current text position.
- hasUnderline [out]
-
Type: BOOL*
A Boolean flag that indicates whether underline is present at the position indicated by currentPosition.
- textRange [out, optional]
-
Type: DWRITE_TEXT_RANGE*
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 underline.
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