Create(Factory,String,TextFormat,Single,Single,Single,Boolean) Method

In This Topic

Create a Gdi Compatible TextLayout. Takes a string, format, and associated constraints, and produces an object representing the result, formatted for a particular display resolution and measuring mode.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Shared Function Create( _
   ByVal factory As Factory, _
   ByVal text As String, _
   ByVal textFormat As TextFormat, _
   ByVal layoutWidth As Single, _
   ByVal layoutHeight As Single, _
   ByVal pixelsPerDip As Single, _
   ByVal useGdiNatural As Boolean _
) As TextLayout

public static TextLayout Create( 
   Factory factory,
   string text,
   TextFormat textFormat,
   float layoutWidth,
   float layoutHeight,
   float pixelsPerDip,
   bool useGdiNatural
)

Parameters

factory: an instance of Factory
text: An array of characters that contains the string to create a new C1.Win.DX.DirectWrite.TextLayout object from. This array must be of length stringLength and can contain embedded NULL characters.
textFormat: The text formatting object to apply to the string.
layoutWidth: The width of the layout box.
layoutHeight: The height of the layout box.
pixelsPerDip: The number of physical pixels per DIP (device independent pixel). For example, if rendering onto a 96 DPI device pixelsPerDip is 1. If rendering onto a 120 DPI device pixelsPerDip is 1.25 (120/96).
useGdiNatural: Instructs the text layout to use the same metrics as GDI bi-level text when set to FALSE. When set to TRUE, instructs the text layout to use the same metrics as text measured by GDI using a font created with CLEARTYPE_NATURAL_QUALITY.

Remarks

The resulting text layout should only be used for the intended resolution, and for cases where text scalability is desired {{CreateTextLayout}} should be used instead.

Reference

TextLayout Class
TextLayout Members
Overload List