EditSpan Class

Article
02/04/2013

Describes an edit operation.

This API is not CLS-compliant.

Inheritance Hierarchy

System.Object
Microsoft.VisualStudio.Package.EditSpan

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public Class EditSpan

[CLSCompliantAttribute(false)]
public class EditSpan

[CLSCompliantAttribute(false)]
public ref class EditSpan

[<CLSCompliantAttribute(false)>]
type EditSpan =  class end

public class EditSpan

The EditSpan type exposes the following members.

Constructors

	Name	Description
	EditSpan	Initializes a new instance of the EditSpan class.

Top

Properties

	Name	Description
	LengthOfLastLine	Returns the length of the last line in the replacement text.
	LineCount	Returns the number of lines in the replacement text.
	Span	Determines the span to be replaced.
	Text	Determines the replacement text.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

This class is used with the EditArray class to manage and apply edit operations. This class describes either a replacement or insertion operation, using a span and the new text. A deletion operation is a special case of a replacement where the replacement string is empty.

Replace Text

Set up a span that describes the text to replace and specify the text to replace with. When the edit operation is applied, the span is completely replaced by the new text.

Insert Text

Set up a span that describes the point of insertion but has no length; that is, the end point is the same as the start point. When the edit operation is applied, the new text is inserted at the specified point.

Delete Text

The delete operation is a special case of the replace operation. Set up a span that describes the text to delete and specify an empty string for the replacement text. When the edit operation is applied, the span is completely replaced by the new text, which in this case is an empty string. Since a span can describe multiple lines, whole lines can be deleted this way.

Notes to Implementers

This class contains all the functionality needed to describe an edit operation. There is no need to derive from this class.

Notes to Callers

Instantiate this class with a TextSpan object and a string to describe a single edit operation.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via