FormatCommenter.TryUncommentLines Method

FormatCommenterTryUncommentLines Method

Attempt to uncomment a span of text using any of a collection of line 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

C++

Copy

protected virtual bool TryUncommentLines(
	VirtualSnapshotSpan span,
	ITextEdit edit,
	ReadOnlyCollection<LineCommentFormat> formats,
	out VirtualSnapshotSpan result
)

Protected Overridable Function TryUncommentLines ( 
	span As VirtualSnapshotSpan,
	edit As ITextEdit,
	formats As ReadOnlyCollection(Of LineCommentFormat),
	<OutAttribute> ByRef result As VirtualSnapshotSpan
) As Boolean

protected:
virtual bool TryUncommentLines(
	VirtualSnapshotSpan span, 
	ITextEdit^ edit, 
	ReadOnlyCollection<LineCommentFormat^>^ formats, 
	[OutAttribute] VirtualSnapshotSpan% result
)

abstract TryUncommentLines : 
        span : VirtualSnapshotSpan * 
        edit : ITextEdit * 
        formats : ReadOnlyCollection<LineCommentFormat> * 
        result : VirtualSnapshotSpan byref -> bool 
override TryUncommentLines : 
        span : VirtualSnapshotSpan * 
        edit : ITextEdit * 
        formats : ReadOnlyCollection<LineCommentFormat> * 
        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.
formats: Type: System.Collections.ObjectModelReadOnlyCollectionLineCommentFormat
The line 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 one or more lines of the span of text were successfully uncommented using one of the specified line comment formats.

-or-

if none of the lines in the span of text could be uncommented using any of the specified formats.

Exceptions

Exception	Condition
ArgumentNullException	If edit is . -or- If formats is .
ArgumentException	If formats contains any values.

Exception

Condition

ArgumentNullException

If edit is .

-or-

If formats is .

ArgumentException

If formats contains any values.

Reference

FormatCommenter Class

Tvl.VisualStudio.Text.Commenter Namespace