Click or drag to resize
FormatCommenterTryUncommentBlock Method (VirtualSnapshotSpan, ITextEdit, ReadOnlyCollectionBlockCommentFormat, VirtualSnapshotSpan)
Attempt to uncomment a span of text using any of a collection of block comment formats.

Namespace: Tvl.VisualStudio.Text.Commenter
Assembly: Tvl.VisualStudio.Commenter.Utility.10 (in Tvl.VisualStudio.Commenter.Utility.10.dll) Version: 1.0.0.0
Syntax
protected virtual bool TryUncommentBlock(
	VirtualSnapshotSpan span,
	ITextEdit edit,
	ReadOnlyCollection<BlockCommentFormat> formats,
	out VirtualSnapshotSpan result
)

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.
formats
Type: System.Collections.ObjectModelReadOnlyCollectionBlockCommentFormat
The block comment formats to use for attempting to uncomment 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 successfully uncommented using one of the specified block comment formats.

-or-

if the span of text was not a complete block comment using any of the specified formats.

Exceptions
ExceptionCondition
ArgumentNullException

If edit is .

-or-

If formats is .

ArgumentExceptionIf formats contains any values.
See Also