Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

IDWriteFactory::CreateTextLayout method

Takes a string, text format, and associated constraints, and produces an object that represents the fully analyzed and formatted result.

Syntax


virtual HRESULT CreateTextLayout(
  [in]   const WCHAR * string,
  UINT32  stringLength,
  IDWriteTextFormat * textFormat,
  FLOAT  maxWidth,
  FLOAT  maxHeight,
  [out]  IDWriteTextLayout ** textLayout
) = 0;

Parameters

string [in]

Type: const WCHAR*

An array of characters that contains the string to create a new IDWriteTextLayout object from. This array must be of length stringLength and can contain embedded NULL characters.

stringLength

Type: UINT32

The number of characters in the string.

textFormat

Type: IDWriteTextFormat*

A pointer to an object that indicates the format to apply to the string.

maxWidth

Type: FLOAT

The width of the layout box.

maxHeight

Type: FLOAT

The height of the layout box.

textLayout [out]

Type: IDWriteTextLayout**

When this method returns, contains an address of a pointer to the resultant text layout object.

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

Dwrite.h

Library

Dwrite.lib

DLL

Dwrite.dll

See also

IDWriteFactory

 

 

Community Additions

Show:
© 2014 Microsoft