TextFormatter.FormatLine メソッド

定義

ドキュメント コンテンツの書式設定および表示に使用される TextLine を作成します。Creates a TextLine that is used for formatting and displaying document content.

オーバーロード

FormatLine(TextSource, Int32, Double, TextParagraphProperties, TextLineBreak)

ドキュメント コンテンツの書式設定および表示に使用される TextLine を作成します。Creates a TextLine that is used for formatting and displaying document content.

FormatLine(TextSource, Int32, Double, TextParagraphProperties, TextLineBreak, TextRunCache)

ドキュメント コンテンツの書式設定および表示に使用される TextLine を作成します。Creates a TextLine that is used for formatting and displaying document content.

FormatLine(TextSource, Int32, Double, TextParagraphProperties, TextLineBreak)

ドキュメント コンテンツの書式設定および表示に使用される TextLine を作成します。Creates a TextLine that is used for formatting and displaying document content.

public:
 abstract System::Windows::Media::TextFormatting::TextLine ^ FormatLine(System::Windows::Media::TextFormatting::TextSource ^ textSource, int firstCharIndex, double paragraphWidth, System::Windows::Media::TextFormatting::TextParagraphProperties ^ paragraphProperties, System::Windows::Media::TextFormatting::TextLineBreak ^ previousLineBreak);
public abstract System.Windows.Media.TextFormatting.TextLine FormatLine (System.Windows.Media.TextFormatting.TextSource textSource, int firstCharIndex, double paragraphWidth, System.Windows.Media.TextFormatting.TextParagraphProperties paragraphProperties, System.Windows.Media.TextFormatting.TextLineBreak previousLineBreak);
abstract member FormatLine : System.Windows.Media.TextFormatting.TextSource * int * double * System.Windows.Media.TextFormatting.TextParagraphProperties * System.Windows.Media.TextFormatting.TextLineBreak -> System.Windows.Media.TextFormatting.TextLine

パラメーター

textSource
TextSource

行のテキスト ソースを表す TextSource 値。A TextSource value that represents the text source for the line.

firstCharIndex
Int32

行の先頭の文字の文字インデックスを指定する Int32 値。An Int32 value that specifies the character index of the starting character in the line.

paragraphWidth
Double

行が表示される段落の幅を指定する Double 値。A Double value that specifies the width of the paragraph that the line fills.

paragraphProperties
TextParagraphProperties

フロー方向、配置、インデントなど、段落のプロパティを表す TextParagraphProperties 値。A TextParagraphProperties value that represents paragraph properties, such as flow direction, alignment, or indentation.

previousLineBreak
TextLineBreak

テキスト書式設定プロセスによって改行された段落の前の行の改行位置に関して、テキスト フォーマッタの状態を指定する TextLineBreak 値。A TextLineBreak value that specifies the text formatter state, in terms of where the previous line in the paragraph was broken by the text formatting process.

戻り値

表示可能なテキスト行を表す TextLine 値。A TextLine value that represents a line of text that can be displayed.

次の例では、FormatLine メソッドを使用して、書式設定された TextLineを返す方法を示します。The following example shows how to use the FormatLine method to return a formatted TextLine.

// Create a textline from the text store using the TextFormatter object.
TextLine myTextLine = formatter.FormatLine(
    customTextSource,
    0,
    400,
    customTextParagraphProperties,
    null);

// Draw the formatted text into the drawing context.
myTextLine.Draw(drawingContext, new Point(0, 0), InvertAxes.None);
' Create a textline from the text store using the TextFormatter object.
Dim myTextLine As TextLine = formatter.FormatLine(customTextSource, 0, 400, customTextParagraphProperties, Nothing)

' Draw the formatted text into the drawing context.
myTextLine.Draw(drawingContext, New Point(0, 0), InvertAxes.None)

FormatLine(TextSource, Int32, Double, TextParagraphProperties, TextLineBreak, TextRunCache)

ドキュメント コンテンツの書式設定および表示に使用される TextLine を作成します。Creates a TextLine that is used for formatting and displaying document content.

public:
 abstract System::Windows::Media::TextFormatting::TextLine ^ FormatLine(System::Windows::Media::TextFormatting::TextSource ^ textSource, int firstCharIndex, double paragraphWidth, System::Windows::Media::TextFormatting::TextParagraphProperties ^ paragraphProperties, System::Windows::Media::TextFormatting::TextLineBreak ^ previousLineBreak, System::Windows::Media::TextFormatting::TextRunCache ^ textRunCache);
public abstract System.Windows.Media.TextFormatting.TextLine FormatLine (System.Windows.Media.TextFormatting.TextSource textSource, int firstCharIndex, double paragraphWidth, System.Windows.Media.TextFormatting.TextParagraphProperties paragraphProperties, System.Windows.Media.TextFormatting.TextLineBreak previousLineBreak, System.Windows.Media.TextFormatting.TextRunCache textRunCache);
abstract member FormatLine : System.Windows.Media.TextFormatting.TextSource * int * double * System.Windows.Media.TextFormatting.TextParagraphProperties * System.Windows.Media.TextFormatting.TextLineBreak * System.Windows.Media.TextFormatting.TextRunCache -> System.Windows.Media.TextFormatting.TextLine

パラメーター

textSource
TextSource

行のテキスト ソースを表す TextSource オブジェクト。A TextSource object that represents the text source for the line.

firstCharIndex
Int32

行の先頭の文字の文字インデックスを指定する Int32 値。An Int32 value that specifies the character index of the starting character in the line.

paragraphWidth
Double

行が表示される段落の幅を指定する Double 値。A Double value that specifies the width of the paragraph that the line fills.

paragraphProperties
TextParagraphProperties

フロー方向、配置、インデントなど、段落のプロパティを表す TextParagraphProperties オブジェクト。A TextParagraphProperties object that represents paragraph properties, such as flow direction, alignment, or indentation.

previousLineBreak
TextLineBreak

テキスト書式設定プロセスによって改行された段落の前の行の改行位置に関して、テキスト フォーマッタの状態を指定する TextLineBreak オブジェクト。A TextLineBreak object that specifies the text formatter state, in terms of where the previous line in the paragraph was broken by the text formatting process.

textRunCache
TextRunCache

テキストのレイアウトのキャッシュ機構を表す TextRunCache オブジェクト。A TextRunCache object that represents the caching mechanism for the layout of text.

戻り値

表示可能なテキスト行を表す TextLine 値。A TextLine value that represents a line of text that can be displayed.

注釈

このメソッドは、TextLine がパフォーマンスに大きな影響を与えるアプリケーションのパフォーマンスを向上させるために使用されます。This method is used to improve performance in applications where the TextLine has significant performance implications.

適用対象