IVsTextLines Interface

  • Article

Provides read and write access to the text buffer using two-dimensional coordinates.

Namespace:  Microsoft.VisualStudio.TextManager.Interop
Assembly:  Microsoft.VisualStudio.TextManager.Interop (in Microsoft.VisualStudio.TextManager.Interop.dll)

Syntax

'Declaration
<InterfaceTypeAttribute()> _
<GuidAttribute("ECF3E19D-149C-43AA-80C2-D0A46946DAA3")> _
Public Interface IVsTextLines _
    Inherits IVsTextBuffer

[InterfaceTypeAttribute()]
[GuidAttribute("ECF3E19D-149C-43AA-80C2-D0A46946DAA3")]
public interface IVsTextLines : IVsTextBuffer

[InterfaceTypeAttribute()]
[GuidAttribute(L"ECF3E19D-149C-43AA-80C2-D0A46946DAA3")]
public interface class IVsTextLines : IVsTextBuffer

[<InterfaceTypeAttribute()>]
[<GuidAttribute("ECF3E19D-149C-43AA-80C2-D0A46946DAA3")>]
type IVsTextLines =  
    interface 
        interface IVsTextBuffer 
    end

public interface IVsTextLines extends IVsTextBuffer

The IVsTextLines type exposes the following members.

Methods

  Name Description
Public method AdviseTextLinesEvents Microsoft internal use only.
Public method CanReplaceLines Tests whether a given editing operation such as copy or cut can succeed.
Public method CopyLineText Puts the specified span of text into a caller-allocated buffer (an array).
Public method CreateEditPoint Creates an EditPoint object at the given location in the text buffer.
Public method CreateLineMarker Creates a marker of a given type over the specified region.
Public method CreateTextPoint Creates a TextPoint object at the given location in the text buffer.
Public method EnumMarkers Enumerates a specific set of text line markers, based on the criteria specified.
Public method FindMarkerByLineIndex Locates a marker of a given type based on a line index.
Public method GetLanguageServiceID Returns the unique identifier of the language that is providing colorization and other attribute data to this buffer.
Public method GetLastLineIndex Returns the last line in the text buffer.
Public method GetLengthOfLine Returns the length of a line in the buffer.
Public method GetLineCount Returns the number of lines in the buffer.
Public method GetLineData Provides direct, line-oriented access to the text buffer.
Public method GetLineDataEx Provides direct, line-oriented access to the text buffer.
Public method GetLineIndexOfPosition Returns the line and column numbers in the text buffer, given a position number.
Public method GetLineText Returns the specified span of text in a BSTR.
Public method GetMarkerData Returns text marker data for the specified line range within the text buffer.
Public method GetPairExtents Method information is not provided. Do not use.
Public method GetPositionOfLine Returns the position number of a line.
Public method GetPositionOfLineIndex Returns the position number in the text buffer, given a line and column number.
Public method GetSize Returns the size in characters of the buffer.
Public method GetStateFlags Returns the state flags of the text buffer.
Public method GetUndoManager Returns the undo manager for this buffer.
Public method InitializeContent Initializes the content of the text buffer.
Public method IVsTextLinesReserved1 Method information is not provided. Do not use.
Public method LockBuffer Locks the text buffer for the purpose of access control. Deprecated.
Public method LockBufferEx Extension of the LockBuffer method. Deprecated.
Public method ReleaseLineData Releases the LINEDATA structure.
Public method ReleaseLineDataEx Releases the LINEDATAEX structure.
Public method ReleaseMarkerData Cleans up the MARKERDATA structure.
Public method Reload Reloads the text buffer.
Public method ReloadLines Replaces text without deleting markers.
Public method ReplaceLines Handles stream-like line editing, such as line breaking and line joining.
Public method ReplaceLinesEx Handles stream-like line editing, such as line breaking and line joining.
Public method Reserved1 Reserved in the Vtable for future use.
Public method Reserved10 Reserved in the Vtable for future use.
Public method Reserved2 Reserved in the Vtable for future use.
Public method Reserved3 Reserved in the Vtable for future use.
Public method Reserved4 Reserved in the Vtable for future use.
Public method Reserved5 Reserved in the Vtable for future use.
Public method Reserved6 Reserved in the Vtable for future use.
Public method Reserved7 Reserved in the Vtable for future use.
Public method Reserved8 Reserved in the Vtable for future use.
Public method Reserved9 Reserved in the Vtable for future use.
Public method SetLanguageServiceID Sets the unique identifier of the language that is providing colorization and other attribute data to the buffer.
Public method SetStateFlags Sets the state flags of the text buffer.
Public method UnadviseTextLinesEvents Not implemented. Do not use.
Public method UnlockBuffer Unlocks a buffer locked with the method LockBuffer.
Public method UnlockBufferEx Extension of the UnlockBuffer method.

Top

Remarks

The IVsTextLines interface provides the mechanism to access the contents of the text buffer in a line-oriented fashion. IVsTextLines is derived from IVsTextBuffer.

Text is defined as lines separated by end-of-line (EOL) indicators. Lines are measured using a long type. This interface provides extensive text read and write capabilities using the two-dimensional coordinate system. You can also use this interface to create text markers.

IVsTextLines calls methods in IVsTextLinesEvents to inform a listener that text or attributes in the buffer have changed. For more information about setting up event notification, see IVsTextLinesEvents.

Notes to Implementers

Implemented by text buffers in the environment.

Notes to Callers

Called by clients that want to access the text buffer. You can use the text buffer object to read or change text.

See Also

Reference

Microsoft.VisualStudio.TextManager.Interop Namespace

IVsTextLines2