TextPointer.GetLineStartPosition メソッド

定義

現在の TextPointer の位置に対する相対位置で指定した行の先頭にある TextPointer を返します。Returns a TextPointer to the beginning of a line that is specified relative to the current TextPointer.

オーバーロード

GetLineStartPosition(Int32)

現在の TextPointer の位置に対する相対位置で指定した行の先頭にある TextPointer を返します。Returns a TextPointer to the beginning of a line that is specified relative to the current TextPointer.

GetLineStartPosition(Int32, Int32)

現在の TextPointer の位置に対する相対位置で指定した行の先頭にある TextPointer を返し、スキップされた行数を通知します。Returns a TextPointer to the beginning of a line that is specified relative to the current TextPointer, and reports how many lines were skipped.

GetLineStartPosition(Int32)

現在の TextPointer の位置に対する相対位置で指定した行の先頭にある TextPointer を返します。Returns a TextPointer to the beginning of a line that is specified relative to the current TextPointer.

public:
 System::Windows::Documents::TextPointer ^ GetLineStartPosition(int count);
public System.Windows.Documents.TextPointer GetLineStartPosition (int count);
member this.GetLineStartPosition : int -> System.Windows.Documents.TextPointer
Public Function GetLineStartPosition (count As Integer) As TextPointer

パラメーター

count
Int32

開始位置を返す対象の行を決定するときにスキップする行頭マーカーの数。The number of start-of-line markers to skip when determining the line for which to return the starting position. 負の値は以前の行、0 は現在の行、正の値は以降の行をそれぞれ指定します。Negative values specify preceding lines, 0 specifies the current line, and positive values specify following lines.

戻り値

指定した行の先頭を指す TextPointer (LogicalDirectionForward に設定されている場合)。指定した行が範囲外の場合や見つからない場合は nullA TextPointer pointing to the beginning of the specified line (with the LogicalDirection set to Forward), or null if the specified line is out of range or otherwise cannot be located.

注釈

TextPointer 2 つの行の間など、あいまいな位置を指している場合、でLogicalDirection指定された方向の行が、相対開始行として選択されます。If the TextPointer points to an ambiguous position, for example, between two lines, the line in the direction specified by LogicalDirection is selected as the relative starting line.

このメソッドによって実行される操作は、有効なレイアウトによって異なります。The operation performed by this method depends on a valid layout. 必要に応じて、このメソッドは、操作を続行する前に、有効なレイアウトを自動的に再生成しようとします。When necessary, this method attempts to automatically regenerate a valid layout before proceeding with the operation. レイアウトを再生成すると、比較的負荷のかかる操作になる可能性があります。Regenerating a layout can be a relatively expensive operation. レイアウトHasValidLayoutを再生成する可能性のある操作を実行する前に、を使用して有効なレイアウトを確認します。Use HasValidLayout to check for a valid layout before performing operations that may regenerate the layout. 詳細については、「Layout」 (レイアウト) を参照してください。For more information, see Layout.

GetLineStartPosition(Int32, Int32)

現在の TextPointer の位置に対する相対位置で指定した行の先頭にある TextPointer を返し、スキップされた行数を通知します。Returns a TextPointer to the beginning of a line that is specified relative to the current TextPointer, and reports how many lines were skipped.

public:
 System::Windows::Documents::TextPointer ^ GetLineStartPosition(int count, [Runtime::InteropServices::Out] int % actualCount);
public System.Windows.Documents.TextPointer GetLineStartPosition (int count, out int actualCount);
member this.GetLineStartPosition : int * int -> System.Windows.Documents.TextPointer
Public Function GetLineStartPosition (count As Integer, ByRef actualCount As Integer) As TextPointer

パラメーター

count
Int32

開始位置を返す対象の行を決定するときにスキップする行頭マーカーの数。The number of start-of-line markers to skip when determining the line for which to return the starting position. 負の値は以前の行、0 は現在の行、正の値は以降の行をそれぞれ指定します。Negative values specify preceding lines, 0 specifies the current line, and positive values specify following lines.

actualCount
Int32

このメソッドが終了すると、開始位置を返す対象の行を決定するときにスキップされた行頭マーカーの実際の数が格納されます。When this method returns, contains the actual number of start-of-line markers that were skipped when determining the line for which to return the starting position. 指定された行数をスキップする前にコンテンツの先頭または末尾が見つかった場合は、この値が count より少なくなることがあります。This value may be less than count if the beginning or end of content is encountered before the specified number of lines are skipped. このパラメーターは初期化せずに渡されます。This parameter is passed uninitialized.

戻り値

指定した行の先頭を指す TextPointer (LogicalDirectionForward に設定されている場合)。または指定した行が範囲外の場合は、指定した行に最も近い行の先頭を指します。A TextPointer pointing to the beginning of the specified line (with the LogicalDirection set to Forward), or to the beginning of the line closest to the specified line if the specified line is out of range.

注釈

TextPointer 2 つの行の間など、あいまいな位置を指している場合は、 LogicalDirectionプロパティで指定された方向の行が相対開始行として選択されます。If the TextPointer points to an ambiguous position, for example, between two lines, the line in the direction specified by the LogicalDirection property is selected as the relative starting line.

適用対象