EditPoint2 Interface

  • Article

Allows you to manipulate text as data in text buffers.

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

Syntax

'Declaration
<GuidAttribute("136AFA9F-F243-4ABB-A8F8-4C2D26C47163")> _
Public Interface EditPoint2 _
    Inherits EditPoint

[GuidAttribute("136AFA9F-F243-4ABB-A8F8-4C2D26C47163")]
public interface EditPoint2 : EditPoint

[GuidAttribute(L"136AFA9F-F243-4ABB-A8F8-4C2D26C47163")]
public interface class EditPoint2 : EditPoint

[<GuidAttribute("136AFA9F-F243-4ABB-A8F8-4C2D26C47163")>]
type EditPoint2 =  
    interface 
        interface EditPoint 
    end

public interface EditPoint2 extends EditPoint

The EditPoint2 type exposes the following members.

Properties

  Name Description
Public property AbsoluteCharOffset Gets the one-based character offset from the beginning of the document to the EditPoint2 object.
Public property AtEndOfDocument Gets a value indicating whether or not the object is at the end of the document.
Public property AtEndOfLine Gets a value indicating whether or not the object is at the end of a line.
Public property AtStartOfDocument Gets a value indicating whether or not the object is at the beginning of the document.
Public property AtStartOfLine Gets a value indicating whether or not the EditPoint object is at the beginning of a line.
Public property CodeElement Gets the code element at the EditPoint location.
Public property DisplayColumn Gets the number of the currently displayed column containing the EditPoint object.
Public property DTE Returns the top-level extensibility object.
Public property Line Gets the line number of the EditPoint object.
Public property LineCharOffset Gets the character offset of the EditPoint object.
Public property LineLength Gets the number of characters in a line containing the EditPoint object, excluding the new line character.
Public property Parent Gets the immediate parent object of the EditPoint object.

Top

Methods

  Name Description
Public method ChangeCase Changes the case of the selected text.
Public method CharLeft Moves the edit point the specified number of characters to the left.
Public method CharRight Moves the edit point the specified number of characters to the right.
Public method ClearBookmark Clears all unnamed bookmarks in the current text buffer line.
Public method Copy Copies the specified range of text to the clipboard.
Public method CreateEditPoint Creates and returns an EditPoint object at the location of the calling object.
Public method Cut Copies the specified range of text to the clipboard and deletes it from the document.
Public method Delete Deletes the specified range of text.
Public method DeleteWhitespace Deletes the empty characters (white space) horizontally or vertically around the current location in the text buffer.
Public method EndOfDocument Moves the edit point to the end of the document.
Public method EndOfLine Moves the edit point to the end of the current line in the buffer.
Public method EqualTo Returns a value indicating whether the value of the given point object's AbsoluteCharOffset is equal to that of the calling EditPoint object.
Public method FindPattern Finds a given matching pattern in the selected text.
Public method GetLines Returns a string representing the text between two given lines.
Public method GetText Returns the text between the current location and the specified location in the buffer.
Public method GreaterThan Returns whether the value of the EditPoint object's AbsoluteCharOffset property is greater than that of the given TextPoint object.
Public method Indent Indents the selected lines by the given number of indentation levels.
Public method Insert Inserts the given string at the edit point's current position in the buffer.
Public method InsertFromFile Inserts the contents of the specified file at the current location in the buffer.
Public method InsertNewLine Detects the line break type used at the line where EditPoint2 is located (carriage return, line feed, and so on) and will insert Count new lines at the location of the EditPoint2.
Public method LessThan Returns whether the value of the called EditPoint object's AbsoluteCharOffset is less than that of the given TextPoint object.
Public method LineDown Moves the edit point down the specified number of lines.
Public method LineUp Moves the edit point up the specified number of lines.
Public method MoveToAbsoluteOffset Moves the active point to the given 1-based absolute character offset of the document.
Public method MoveToLineAndOffset Moves the document to the specified line and character offset position in that line.
Public method MoveToPoint Moves the active point to the given position.
Public method NextBookmark Moves to the location of the next bookmark in the document.
Public method OutlineSection Creates an outlining section based on an edit point and the given text point or value.
Public method PadToColumn Fills the current line in the buffer with empty characters (white space) to the given column.
Public method Paste Inserts the clipboard contents at the current location.
Public method PreviousBookmark Moves the edit point to the location of the previous bookmark in the document.
Public method ReadOnly Returns a value indicating whether any of the specified range contains read-only text.
Public method ReplacePattern Finds a pattern in the specified range of text and replaces it with the specified text.
Public method ReplaceText Replaces the selected text with the given text.
Public method SetBookmark Sets an unnamed bookmark on the current line in the buffer.
Public method SmartFormat Formats the specified range of text based on the current language.
Public method StartOfDocument Moves the object to the beginning of the document.
Public method StartOfLine Moves the edit point to the beginning of the current line in the buffer.
Public method TryToShow Attempts to display the text point's location.
Public method Unindent Removes the indent characters from the selected lines by the given number of indentation levels.
Public method WordLeft Moves the object the specified number of words to the left.
Public method WordRight Moves the object the specified number of words to the right.

Top

Remarks

EditPoint2 objects are similar to TextSelection objects, except that they operate on data in the text buffer rather than on text displayed in a code editor. The difference is that text in the buffer is not affected by global editor states, such as word wrapping and virtual spaces.

Any operation that attempts to modify a text document fails if it affects any characters that are contained in a read-only block, or if the document itself is read-only.

Examples

Sub EditPointExample()
  'Before running this example, open a text document.
  Dim objTD As TextDocument
  Dim objEP As EditPoint

  objTD = DTE.ActiveDocument.Object("TextDocument")
  objEP = objTD.StartPoint.CreateEditPoint
  objEP.Insert "Hello"
End Sub

See Also

Reference

EnvDTE80 Namespace