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

Visual Studio 2015

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)

Syntax

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

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.

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. A new line "\par" rtf keyword will be placed between the provided SnapshotSpans.