Windows apps
Collapse the table of content
Expand the table of content
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.

TextPointer.GetLineStartPosition Method (Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a TextPointer to the beginning of a line that is specified relative to the current TextPointer.

Namespace:   System.Windows.Documents
Assembly:  PresentationFramework (in PresentationFramework.dll)

public TextPointer GetLineStartPosition(
	int count
)

Parameters

count
Type: System.Int32

The number of start-of-line markers to skip when determining the line for which to return the starting position. Negative values specify preceding lines, 0 specifies the current line, and positive values specify following lines.

Return Value

Type: System.Windows.Documents.TextPointer

A 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.

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. Use HasValidLayout to check for a valid layout before performing operations that may regenerate the layout. For more information, see Layout.

.NET Framework
Available since 3.0
Return to top
Show:
© 2018 Microsoft