IDWriteTextLayout1::GetCharacterSpacing method

Gets the spacing between characters.

Syntax


virtual HRESULT GetCharacterSpacing(
  UINT32 currentPosition,
  [out]            FLOAT *leadingSpacing,
  [out]            FLOAT *trailingSpacing,
  [out]            FLOAT *minimumAdvanceWidth,
  [out, optional]  DWRITE_TEXT_RANGE *textRange = NULL
) = 0;

Parameters

currentPosition

Type: UINT32

The current text position.

leadingSpacing [out]

Type: FLOAT*

The spacing before each character, in reading order.

trailingSpacing [out]

Type: FLOAT*

The spacing after each character, in reading order.

minimumAdvanceWidth [out]

Type: FLOAT*

The minimum advance of each character, to prevent characters from becoming too thin or zero-width. This must be zero or greater.

textRange [out, optional]

Type: DWRITE_TEXT_RANGE*

The position range of the current format.

Return value

Type: HRESULT

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

Requirements

Minimum supported client

Windows 8 and Platform Update for Windows 7 [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2012 and Platform Update for Windows Server 2008 R2 [desktop apps | Windows Store apps]

Minimum supported phone

Windows Phone 8.1 [Windows Phone Silverlight 8.1 and Windows Runtime apps]

Header

Dwrite_1.h

Library

Dwrite.lib

DLL

Dwrite.dll

See also

IDWriteTextLayout1

 

 

Community Additions

ADD
Show:
© 2014 Microsoft