Export (0) Print
Expand All

TextRange Interface

Represents a single, contiguous section of text in a text document.

Namespace:  EnvDTE
Assembly:  EnvDTE (in EnvDTE.dll)

[GuidAttribute("72767524-E3B3-43D0-BB46-BBE1D556A9FF")]
public interface TextRange

The TextRange type exposes the following members.

  NameDescription
Public propertyCollectionGets the collection containing the TextRange object supporting this property.
Public propertyDTEGets the top-level extensibility object.
Public propertyEndPointGets an EditPoint that is the location of the end of the range.
Public propertyStartPointGets the EditPoint object representing the beginning of the text document, or the first displayed character of the pane.
Top

The section of text is enclosed by a pair of EditPoint objects.

TextRange objects are used when you have regular expressions with tagged subexpressions. A collection of ranges is returned, one for each matched subexpression, and their properties are read-only.

For general text manipulation, it is recommended that you instead use objects such as TextSelection or EditPoint, because the TextSelection object relates directly to the selection visible on the screen. When the selection area changes, the object's coordinates change, and vice-versa. As a result, a text selection cannot be used to represent an arbitrary range of text without disrupting that text selection.

public void TextRangeExample(_DTE dte)
{
    TextSelection ts;
    TextRanges trs;

    ts = (TextSelection)dte.ActiveDocument.Selection;
    trs = ts.TextRanges;
    MessageBox.Show (trs.Count.ToString ());
    foreach (TextRange tr in trs)
    {
        tr.StartPoint.Insert ("/*");
        tr.EndPoint.Insert ("*/");
    }
}
Show:
© 2014 Microsoft