API Reference
RtfReadResult
Result of reading RTF into syntax and semantic models.
Inheritance
- Object
- RtfReadResult
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method RtfDocument.LoadResult
- Method RtfDocument.LoadResult
- Method RtfDocument.LoadResult
- Method RtfDocument.LoadResultAsync
- Method RtfDocument.LoadResultAsync
- Method RtfDocument.ParseResult
- Method RtfDocument.Read
- Method RtfDocument.Read
- Method RtfLosslessEditor.ToReadResult
Accepted by parameters
- Constructor RtfLosslessEditor.RtfLosslessEditor
Methods
public RtfLosslessEditor EditLossless() #RtfLosslessEditorCreates an editor for targeted syntax-preserving changes.
public virtual RtfDocument RequireValue() #RtfDocumentpublic Void SaveLossless(String path) #VoidSaves the original RTF stream to a file without semantic normalization.
Parameters
- path System.String
public Void SaveLossless(Stream stream) #VoidSaves the original RTF stream to a stream without semantic normalization.
Parameters
- stream System.IO.Stream
public Task SaveLosslessAsync(String path, CancellationToken cancellationToken = default) #TaskSaves the original RTF stream to a file without semantic normalization.
Parameters
- path System.String
- cancellationToken System.Threading.CancellationToken = default
public Task SaveLosslessAsync(Stream stream, CancellationToken cancellationToken = default) #TaskSaves the original RTF stream to a stream without semantic normalization.
Parameters
- stream System.IO.Stream
- cancellationToken System.Threading.CancellationToken = default
public Byte[] ToBytesLossless() #Byte[]Serializes the original syntax tree to source-preserving bytes without semantic normalization.
public String ToRtfLossless() #StringSerializes the original syntax tree without semantic normalization.
public Boolean TryGetLosslessBytes(out Byte[] bytes) #BooleanAttempts to return source-preserving bytes without throwing for character-only input.
Parameters
- bytes System.Byte[]@
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public RtfDocument Document { get; } #Semantic document model.
public virtual RtfDocument Value { get; } #public virtual Boolean Succeeded { get; } #public RtfSyntaxTree SyntaxTree { get; } #Loss-preserving syntax tree.
public IReadOnlyList<RtfDiagnostic> Diagnostics { get; } #Combined parser and binder diagnostics.
public Boolean HasOriginalBytes { get; } #Gets whether the read API retained the exact original source bytes.
public Boolean CanWriteLosslessBytes { get; } #Gets whether ToBytesLossless can return bytes without character transcoding.