IRtfBuilderService::GenerateRtf Method (NormalizedSnapshotSpanCollection^, ITextView^, String^)

 

Gets an RTF string that contains the formatted text of the spans.

Namespace:   Microsoft.VisualStudio.Text.Formatting
Assembly:  Microsoft.VisualStudio.Text.UI.Wpf (in Microsoft.VisualStudio.Text.UI.Wpf.dll)

String^ GenerateRtf(
	NormalizedSnapshotSpanCollection^ spans,
	ITextView^ textView,
	String^ delimiter
)

Parameters

spans
Type: Microsoft.VisualStudio.Text::NormalizedSnapshotSpanCollection^

The collection of snapshot spans.

textView
Type: Microsoft.VisualStudio.Text.Editor::ITextView^

The ITextView that contains the snapshot spans.

delimiter
Type: System::String^

A delimiter string to be inserted between the RTF generated code for the SnapshotSpan objects in the NormalizedSnapshotSpanCollection.

Return Value

Type: System::String^

RTF data.

The generated RTF text is based on an in-order walk of the snapshot spans, with the characteristics and formatting properties of textView. All the snapshot spans must belong to textView.

Return to top
Show: