FormatCommenter.CommentBlock Method

FormatCommenterCommentBlock Method

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.

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

protected virtual VirtualSnapshotSpan CommentBlock(
	VirtualSnapshotSpan span,
	ITextEdit edit,
	BlockCommentFormat format
)

Protected Overridable Function CommentBlock ( 
	span As VirtualSnapshotSpan,
	edit As ITextEdit,
	format As BlockCommentFormat
) As VirtualSnapshotSpan

protected:
virtual VirtualSnapshotSpan CommentBlock(
	VirtualSnapshotSpan span, 
	ITextEdit^ edit, 
	BlockCommentFormat^ format
)

abstract CommentBlock : 
        span : VirtualSnapshotSpan * 
        edit : ITextEdit * 
        format : BlockCommentFormat -> VirtualSnapshotSpan 
override CommentBlock : 
        span : VirtualSnapshotSpan * 
        edit : ITextEdit * 
        format : BlockCommentFormat -> VirtualSnapshotSpan

Parameters

span: Type: Microsoft.VisualStudio.TextVirtualSnapshotSpan
The span of text to comment.
edit: Type: Microsoft.VisualStudio.TextITextEdit
The ITextEdit to use for applying changes.
format: Type: Tvl.VisualStudio.Text.CommenterBlockCommentFormat
The block comment format.

Return Value

Type: VirtualSnapshotSpan
A VirtualSnapshotSpan containing the commented code.

Exceptions

Exception	Condition
ArgumentNullException	If edit is . -or- If format is .

Exception

Condition

ArgumentNullException

If edit is .

-or-

If format is .

Reference

FormatCommenter Class

Tvl.VisualStudio.Text.Commenter Namespace