IRtfBuilderService.GenerateRtf Method (NormalizedSnapshotSpanCollection, ITextView)

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


Type: Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection

The collection of snapshot spans.

Type: Microsoft.VisualStudio.Text.Editor.ITextView

The ITextView that contains the snapshot spans.

Return Value

Type: 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.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2015 Microsoft