FormatCommenter.TryUncommentBlock Method (VirtualSnapshotSpan, ITextEdit, BlockCommentFormat, VirtualSnapshotSpan)

FormatCommenterTryUncommentBlock Method (VirtualSnapshotSpan, ITextEdit, BlockCommentFormat, VirtualSnapshotSpan)

Attempt to uncomment a span of text using a particular block comment format.

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 bool TryUncommentBlock(
	VirtualSnapshotSpan span,
	ITextEdit edit,
	BlockCommentFormat format,
	out VirtualSnapshotSpan result
)

Protected Overridable Function TryUncommentBlock ( 
	span As VirtualSnapshotSpan,
	edit As ITextEdit,
	format As BlockCommentFormat,
	<OutAttribute> ByRef result As VirtualSnapshotSpan
) As Boolean

protected:
virtual bool TryUncommentBlock(
	VirtualSnapshotSpan span, 
	ITextEdit^ edit, 
	BlockCommentFormat^ format, 
	[OutAttribute] VirtualSnapshotSpan% result
)

abstract TryUncommentBlock : 
        span : VirtualSnapshotSpan * 
        edit : ITextEdit * 
        format : BlockCommentFormat * 
        result : VirtualSnapshotSpan byref -> bool 
override TryUncommentBlock : 
        span : VirtualSnapshotSpan * 
        edit : ITextEdit * 
        format : BlockCommentFormat * 
        result : VirtualSnapshotSpan byref -> bool

Parameters

span: Type: Microsoft.VisualStudio.TextVirtualSnapshotSpan
The span of text to uncomment.
edit: Type: Microsoft.VisualStudio.TextITextEdit
The ITextEdit instance to use for applying changes.
format: Type: Tvl.VisualStudio.Text.CommenterBlockCommentFormat
The block comment format to use for uncommenting the code.
result: Type: Microsoft.VisualStudio.TextVirtualSnapshotSpan
Upon return, a VirtualSnapshotSpan containing the uncommented code.

Return Value

Type: Boolean

if the span of text was uncommented using the specified block comment format.

-or-

false if the span of text was not a complete block comment with the specified format.

Exceptions

Exception	Condition
ArgumentNullException	If edit is .

Reference

FormatCommenter Class

TryUncommentBlock Overload

Tvl.VisualStudio.Text.Commenter Namespace