RtfSerializer Class
Definition
Serializer for Rich Text Format (RTF) documents.
public class RtfSerializer
Remarks
Supports reading and writing RTF documents with:
- Character formatting: bold, italic, underline, strikethrough, font, size, colors
- Paragraph formatting: alignment, indentation
- Unicode text
This serializer is thread-safe for concurrent operations.
Constructors
| Name | Description |
|---|---|
| RtfSerializer | Initializes a new instance of Avalonia.Controls.Documents.Serialization.Rtf.RtfSerializer with optional serialization options. |
RtfSerializer Constructor
Initializes a new instance of Avalonia.Controls.Documents.Serialization.Rtf.RtfSerializer with optional serialization options.
public RtfSerializer(Avalonia.Controls.Documents.Serialization.DocumentSerializerOptions options)
Parameters
options Avalonia.Controls.Documents.Serialization.DocumentSerializerOptions
Serialization options; defaults are used when .
Methods
| Name | Description |
|---|---|
| CanDeserialize | No summary available. |
| Deserialize (2 overloads) | No summary available. |
| DeserializeAsync | No summary available. |
| Serialize (2 overloads) | Serializes a document snapshot to an RTF string. |
| SerializeAsync | No summary available. |
CanDeserialize Method
public bool CanDeserialize(System.IO.Stream stream)
Parameters
stream System.IO.Stream
Returns
bool
Deserialize overloads
Deserialize Method
public Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot Deserialize(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
Parameters
stream System.IO.Stream
cancellationToken System.Threading.CancellationToken
Returns
Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot
Deserialize Method
Deserializes a document from an RTF string.
public Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot Deserialize(string rtf)
Parameters
rtf string
The RTF content string.
Returns
Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot
A new Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot containing the parsed content.
DeserializeAsync Method
public System.Threading.Tasks.Task<Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot> DeserializeAsync(System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
Parameters
stream System.IO.Stream
cancellationToken System.Threading.CancellationToken
Returns
System.Threading.Tasks.Task<Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot>
Serialize overloads
Serialize Method
Serializes a document snapshot to an RTF string.
public string Serialize(Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot snapshot)
Parameters
snapshot Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot
The document snapshot to serialize.
Returns
string
The RTF content string.
Serialize Method
public void Serialize(Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot snapshot, System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
Parameters
snapshot Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot
stream System.IO.Stream
cancellationToken System.Threading.CancellationToken
SerializeAsync Method
public System.Threading.Tasks.Task SerializeAsync(Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot snapshot, System.IO.Stream stream, System.Threading.CancellationToken cancellationToken)
Parameters
snapshot Avalonia.Controls.Documents.Serialization.Snapshot.DocumentSnapshot
stream System.IO.Stream
cancellationToken System.Threading.CancellationToken
Returns
System.Threading.Tasks.Task
Properties
| Name | Description |
|---|---|
| FileExtension | No summary available. |
| FormatName | No summary available. |
| MimeType | No summary available. |
FileExtension Property
public string FileExtension { get; set; }
FormatName Property
public string FormatName { get; set; }
MimeType Property
public string MimeType { get; set; }