IRtfBuilderService.GenerateRtf Method (NormalizedSnapshotSpanCollection, String)
Gets an RTF string containing the formatted text of the snapshot 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, _
delimiter As String _
) As String
string GenerateRtf(
NormalizedSnapshotSpanCollection spans,
string delimiter
)
String^ GenerateRtf(
NormalizedSnapshotSpanCollection^ spans,
String^ delimiter
)
abstract GenerateRtf :
spans:NormalizedSnapshotSpanCollection *
delimiter:string -> string
function GenerateRtf(
spans : NormalizedSnapshotSpanCollection,
delimiter : String
) : String
Parameters
spans
Type: Microsoft.VisualStudio.Text.NormalizedSnapshotSpanCollectionThe collection of snapshot spans.
delimiter
Type: System.StringA delimiter string to be inserted between the RTF generated code for the SnapshotSpan objects in the NormalizedSnapshotSpanCollection.
Return Value
Type: System.String
RTF data.
Remarks
The generated RTF text is based on an in-order walk of the snapshot spans.
.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.