NinjaScript > SharpDX SDK Reference > SharpDX.DirectWrite

Disclaimer: The SharpDX SDK Reference section was compiled from the official SharpDX Documentation and was NOT authored by NinjaTrader. The contents of this section are provided as-is and only cover a fraction of what is available from the SharpDX SDK. This page was intended only as a reference guide to help you get started with some of the 2D Graphics concepts used in the NinjaTrader.Custom assembly. Please refer to the official SharpDX Documentation for additional members not covered in this reference. For more seasoned graphic developers, the original MSDN Direct2D1 and DirectWrite unmanaged API documentation can also be helpful for understanding the DirectX/Direct2D run-time environment. For NinjaScript development purposes, we document only essential members in the structure of this page.

Definition

The TextLayout interface represents a block of text after it has been fully analyzed and formatted.

(See also unmanaged API documentation)

Note: To draw a formatted string represented by an TextLayout object, Direct2D provides the DrawTextLayout method.

Syntax

class TextLayout

Constructors

new TextLayout(Factory factory, string text, TextFormat textFormat, float maxWidth, float maxHeight)

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

Tip: For NinjaScript development purposes, when creating a TextLayout object you should use the NinjaTrader.Core.Globals.DirectWriteFactory property

Methods and Properties

Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from SharpDX.DisposeBase.)
FlowDirection	Gets or sets the direction that text lines flow. (Inherited from TextFormat.)
FontFamilyName	Gets a copy of the font family name.(Inherited from TextFormat.)
FontSize	Gets the font size in DIP unites. (Inherited from TextFormat.)
FontStretch	Gets the font stretch of the text. (Inherited from TextFormat.)
FontStyle	Gets the font style of the text. (Inherited from TextFormat.)
FontWeight	Gets the font weight of the text. (Inherited from TextFormat.)
IsDisposed	Gets a value indicating whether this instance is disposed. (Inherited from SharpDX.DisposeBase.)
MaxHeight	Gets or sets the layout maximum height.
MaxWidth	Gets or sets the layout maximum width.
Metrics	Contains the metrics associated with text after layout. All coordinates are in device independent pixels (DIPs).
ParagraphAlignment	Gets or sets the alignment option of a paragraph which is relative to the top and bottom edges of a layout box.(Inherited from TextFormat.)
ReadingDirection	Gets or sets the current reading direction for text in a paragraph. (Inherited from TextFormat.)
TextAlignment	Gets or sets the alignment option of text relative to the layout box's leading and trailing edge. (Inherited from TextFormat.)
WordWrapping	Gets or sets the word wrapping option. (Inherited from TextFormat.)