IRtfBuilderService.GenerateRtf Method

Definition

Namespace:

Microsoft.VisualStudio.Text.Formatting

Assembly:

Microsoft.VisualStudio.Text.UI.dll

Package:

Microsoft.VisualStudio.Text.UI v17.12.215

Overloads

GenerateRtf(NormalizedSnapshotSpanCollection)	Gets an RTF string containing the formatted text of the snapshot spans.
GenerateRtf(NormalizedSnapshotSpanCollection, ITextView)	Gets an RTF string that contains the formatted text of the spans.
GenerateRtf(NormalizedSnapshotSpanCollection, String)	Gets an RTF string containing the formatted text of the snapshot spans.
GenerateRtf(NormalizedSnapshotSpanCollection, ITextView, String)	Gets an RTF string that contains the formatted text of the spans.

GenerateRtf(NormalizedSnapshotSpanCollection)

Gets an RTF string containing the formatted text of the snapshot spans.

public:
 System::String ^ GenerateRtf(Microsoft::VisualStudio::Text::NormalizedSnapshotSpanCollection ^ spans);

public string GenerateRtf (Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection spans);

abstract member GenerateRtf : Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection -> string

Public Function GenerateRtf (spans As NormalizedSnapshotSpanCollection) As String

Parameters

spans

NormalizedSnapshotSpanCollection

The collection of snapshot spans.

Returns

String

A String containing RTF data.

Remarks

The generated RTF text is based on an in-order walk of the snapshot spans. A new line "\par" rtf keyword will be placed between the provided SnapshotSpans.

GenerateRtf(NormalizedSnapshotSpanCollection, ITextView)

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

public:
 System::String ^ GenerateRtf(Microsoft::VisualStudio::Text::NormalizedSnapshotSpanCollection ^ spans, Microsoft::VisualStudio::Text::Editor::ITextView ^ textView);

public string GenerateRtf (Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection spans, Microsoft.VisualStudio.Text.Editor.ITextView textView);

abstract member GenerateRtf : Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection * Microsoft.VisualStudio.Text.Editor.ITextView -> string

Public Function GenerateRtf (spans As NormalizedSnapshotSpanCollection, textView As ITextView) As String

Parameters

spans

NormalizedSnapshotSpanCollection

The collection of snapshot spans.

textView

ITextView

The ITextView that contains the snapshot spans.

Returns

String

A String containing 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.

GenerateRtf(NormalizedSnapshotSpanCollection, String)

Gets an RTF string containing the formatted text of the snapshot spans.

public:
 System::String ^ GenerateRtf(Microsoft::VisualStudio::Text::NormalizedSnapshotSpanCollection ^ spans, System::String ^ delimiter);

public string GenerateRtf (Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection spans, string delimiter);

abstract member GenerateRtf : Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection * string -> string

Public Function GenerateRtf (spans As NormalizedSnapshotSpanCollection, delimiter As String) As String

Parameters

spans

NormalizedSnapshotSpanCollection

The collection of snapshot spans.

delimiter

String

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

Returns

String

A String containing RTF data.

Remarks

The generated RTF text is based on an in-order walk of the snapshot spans.

GenerateRtf(NormalizedSnapshotSpanCollection, ITextView, String)

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

public:
 System::String ^ GenerateRtf(Microsoft::VisualStudio::Text::NormalizedSnapshotSpanCollection ^ spans, Microsoft::VisualStudio::Text::Editor::ITextView ^ textView, System::String ^ delimiter);

public string GenerateRtf (Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection spans, Microsoft.VisualStudio.Text.Editor.ITextView textView, string delimiter);

abstract member GenerateRtf : Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollection * Microsoft.VisualStudio.Text.Editor.ITextView * string -> string

Public Function GenerateRtf (spans As NormalizedSnapshotSpanCollection, textView As ITextView, delimiter As String) As String

Parameters

spans

NormalizedSnapshotSpanCollection

The collection of snapshot spans.

textView

ITextView

The ITextView that contains the snapshot spans.

delimiter

String

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

Returns

String

A String containing 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.