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)

Syntax

'Declaration
Function GenerateRtf ( _
    spans As NormalizedSnapshotSpanCollection, _
    textView As ITextView _
) As String

string GenerateRtf(
    NormalizedSnapshotSpanCollection spans,
    ITextView textView
)

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

abstract GenerateRtf : 
        spans:NormalizedSnapshotSpanCollection * 
        textView:ITextView -> string

function GenerateRtf(
    spans : NormalizedSnapshotSpanCollection, 
    textView : ITextView
) : String

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.

Return Value

Type: String
RTF data.

Remarks

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.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

IRtfBuilderService Interface

GenerateRtf Overload

Microsoft.VisualStudio.Text.Formatting Namespace