FormatCommenter Class

This class provides a default implementation of ICommenter that provides standard comment and uncomment handling for languages supporting one or more comment formats.

Inheritance Hierarchy

SystemObject
Tvl.VisualStudio.Text.CommenterFormatCommenter

Namespace: Tvl.VisualStudio.Text.Commenter
Assembly: Tvl.VisualStudio.Commenter.Utility.10 (in Tvl.VisualStudio.Commenter.Utility.10.dll) Version: 1.0.0.0

Syntax

C++

Copy

public class FormatCommenter : ICommenter

Public Class FormatCommenter
	Implements ICommenter

public ref class FormatCommenter : ICommenter

type FormatCommenter =  
    class
        interface ICommenter
    end

The FormatCommenter type exposes the following members.

Constructors

	Name	Description
	FormatCommenter(ITextBuffer, IEnumerableCommentFormat)	Initializes a new instance of the FormatCommenter class for the specified text buffer, undo history, and comment formats.
	FormatCommenter(ITextBuffer, CommentFormat)	Initializes a new instance of the FormatCommenter class for the specified text buffer, undo history, and comment formats.

Top

Methods

	Name	Description
	CommentBlock	Comment out a span of text using the specified block comment format. If the span is empty, the entire line containing the span's start point is commented.
	CommentLines	Comment out a span using a particular line comment format. If the span is empty, the entire line containing the span's start point is commented.
	CommentSpan	Comment out the code in a single VirtualSnapshotSpan.
	CommentSpans	Comments out spans of code.
	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.)
	ScanToNonWhitespaceChar	Gets the index of the first non-whitespace character on a line, or the length of the line if the line is empty or only contains whitespace.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	TrimSpan	Update the specified span to not include any leading or trailing whitespace characters.
	TryUncommentBlock(VirtualSnapshotSpan, ITextEdit, ReadOnlyCollectionBlockCommentFormat, VirtualSnapshotSpan)	Attempt to uncomment a span of text using any of a collection of block comment formats.
	TryUncommentBlock(VirtualSnapshotSpan, ITextEdit, BlockCommentFormat, VirtualSnapshotSpan)	Attempt to uncomment a span of text using a particular block comment format.
	TryUncommentLines	Attempt to uncomment a span of text using any of a collection of line comment formats.
	UncommentSpan	Uncomment the span of text.
	UncommentSpans	Uncomments spans of code.

Top

Properties

	Name	Description
	BlockFormats	Gets a collection of block comment formats recognized by this commenter.
	CommentFormats	Gets a collection of all comment formats recognized by this commenter.
	LineFormats	Gets a collection of line comment formats recognized by this commenter.
	PreferredBlockFormat	Gets the preferred BlockCommentFormat to use when creating new block comments.
	PreferredLineFormat	Gets the preferred LineCommentFormat to use when creating new line comments.
	TextBuffer	Gets the underlying ITextBuffer for this commenter.
	UseLineComments	Gets whether the commenter should prefer to use line comments when commenting selections of code.

Top

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.

Reference

Tvl.VisualStudio.Text.Commenter Namespace