Underline Constructor (TextPointer, TextPointer)

Initializes a new instance of the Underline class, taking two TextPointer objects that indicate the beginning and end of a selection of content to be contained by the new Underline.

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

public Underline(
	TextPointer start,
	TextPointer end
)

Parameters

start
Type: System.Windows.Documents.TextPointer

A TextPointer indicating the beginning of a selection of content to be contained by the new Underline.

end
Type: System.Windows.Documents.TextPointer

A TextPointer indicating the end of a selection of content to be contained by the new Underline.

ExceptionCondition
ArgumentNullException

Raised when start or end is null.

ArgumentException

Raised when start and end do not resolve to a range of content suitable for enclosure by a Underline element, for example, if start and end indicate positions in different paragraphs.

This constructor is intended to initialize a new Underline element such that it encloses a selection of pre-existing content.

The following example demonstrates usage of this constructor.

// Create a paragraph and three text runs to serve as example content.  
Paragraph parx = new Paragraph();
Run run1 = new Run("Text run 1.");
Run run2 = new Run("Text run 2, make underlined.");
Run run3 = new Run("Text run 3.");

// Add the three text runs to the paragraph, separated by linebreaks.
parx.Inlines.Add(run1);
parx.Inlines.Add(new LineBreak());
parx.Inlines.Add(run2);
parx.Inlines.Add(new LineBreak());
parx.Inlines.Add(run3);

// After this line executes, the selection of content 
// indicated by the "start" and "end" parameters will be
// enclosed by the new Underline.  In this case, the new Underline 
// will enclose the second text run, "run2".
Underline underx = new Underline(run2.ContentStart, run2.ContentEnd);

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft