Skip to main content

DocxSerializer Class

Definition

Assembly:Avalonia.Controls.Documents.Serialization.Docx
Package:Avalonia.Controls.Documents.Serialization.Docx

Serializer for Office Open XML (.docx) documents.

public class DocxSerializer

Inheritance: object -> DocxSerializer

Implements: IDocumentSerializer

Remarks

Supports reading and writing DOCX documents with:

  • Character formatting: bold, italic, underline, strikethrough, font, size, colors, super/subscript
  • Paragraph formatting: alignment, indentation, spacing, borders, background, tab stops
  • Lists: bullet and numbered with multi-level support
  • Tables: column widths, cell formatting
  • Hyperlinks

This serializer is thread-safe for concurrent operations.

Constructors

NameDescription
DocxSerializerInitializes a new instance of Avalonia.Controls.Documents.Serialization.Docx.DocxSerializer with optional serialization options.

DocxSerializer Constructor

Initializes a new instance of Avalonia.Controls.Documents.Serialization.Docx.DocxSerializer with optional serialization options.

public DocxSerializer(Avalonia.Controls.Documents.Serialization.DocumentSerializerOptions options)

Parameters

options Avalonia.Controls.Documents.Serialization.DocumentSerializerOptions

Serialization options; defaults are used when .

Methods

NameDescription
CanDeserializeNo summary available.
DeserializeNo summary available.
DeserializeAsyncNo summary available.
SerializeNo summary available.
SerializeAsyncNo summary available.

CanDeserialize Method

public bool CanDeserialize(System.IO.Stream stream)

Parameters

stream System.IO.Stream

Returns

bool

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

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 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

NameDescription
FileExtensionNo summary available.
FormatNameNo summary available.
MimeTypeNo summary available.

FileExtension Property

public string FileExtension { get; set; }

FormatName Property

public string FormatName { get; set; }

MimeType Property

public string MimeType { get; set; }