Samples.Word.cs

using DocumentFormat.OpenXml.Wordprocessing;

[TestFixture]
public partial class Samples
{
    [Test]
    public void MinimalWord()
    {
        using var stream = new MemoryStream();

        #region minimal-word
        using var writer = new OpenXmlPackageWriter(stream, leaveOpen: true);

        writer.AddRelationship(
            new("/word/document.xml", UriKind.Relative),
            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument",
            "rId1");

        writer.WritePart(
            new("/word/document.xml", UriKind.Relative),
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml",
            new Document(new Body(new Paragraph(new Run(new Text("Hello!"))))));
        #endregion
    }

    [Test]
    public void StreamingDocumentFactory()
    {
        using var stream = new MemoryStream();

        #region streaming-document-factory
        using var writer = StreamingDocument.CreateWord(stream, leaveOpen: true);

        writer.WritePart(
            new("/word/document.xml", UriKind.Relative),
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml",
            new Document(new Body(new Paragraph(new Run(new Text("Forward-only!"))))));
        #endregion
    }

    [Test]
    public void StreamingPartContent()
    {
        using var stream = new MemoryStream();
        using var writer = new OpenXmlPackageWriter(stream, leaveOpen: true);

        writer.AddRelationship(
            new("/word/document.xml", UriKind.Relative),
            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument",
            "rId1");

        #region streaming-part-content
        using var entry = writer.CreatePart(
            new("/word/document.xml", UriKind.Relative),
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml");

        using var xmlWriter = OpenXmlWriter.Create(entry.Stream);
        xmlWriter.WriteStartDocument();
        xmlWriter.WriteStartElement(new Document());
        xmlWriter.WriteStartElement(new Body());
        xmlWriter.WriteElement(new Paragraph(new Run(new Text("Streamed!"))));
        xmlWriter.WriteEndElement();
        xmlWriter.WriteEndElement();
        #endregion
    }

    [Test]
    public void ExternalRelationship()
    {
        using var stream = new MemoryStream();
        using var writer = new OpenXmlPackageWriter(stream, leaveOpen: true);

        writer.AddRelationship(
            new("/word/document.xml", UriKind.Relative),
            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument",
            "rId1");

        using var entry = writer.CreatePart(
            new("/word/document.xml", UriKind.Relative),
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml");

        #region external-relationship
        entry.AddRelationship(
            new("https://example.com", UriKind.Absolute),
            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
            TargetMode.External,
            "rId1");
        #endregion
    }

    [Test]
    public void ConstructionVariants()
    {
        using var stream = new MemoryStream();

        #region construction-variants
        // Direct construction
        using var direct = new OpenXmlPackageWriter(stream, leaveOpen: true);

        // Typed factories (pre-register the officeDocument relationship)
        using var word = StreamingDocument.CreateWord(stream, leaveOpen: true);
        using var spreadsheet = StreamingDocument.CreateSpreadsheet(stream, leaveOpen: true);
        using var presentation = StreamingDocument.CreatePresentation(stream, leaveOpen: true);
        #endregion
    }

    [Test]
    public void PartRelationshipStruct()
    {
        #region part-relationship-struct
        var relationship = new PartRelationship(
            targetUri: new("styles.xml", UriKind.Relative),
            relationshipType: "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
            // required — the part body almost always references its own
            // relationships by id, so the caller must know it up front
            id: "rId1",
            // default
            targetMode: TargetMode.Internal);
        #endregion

        _ = relationship;
    }

    [Test]
    public async Task AsyncUsage()
    {
        using var stream = new MemoryStream();

        #region async-usage
        await using var writer = StreamingDocument.CreateWord(stream, leaveOpen: true);

        writer.WritePart(
            new("/word/document.xml", UriKind.Relative),
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml",
            new Document(new Body(new Paragraph(new Run(new Text("Streamed async!"))))));

        // DisposeAsync (triggered by `await using`) asynchronously flushes
        // the final buffer — including the ZIP central directory — so remote
        // sinks like SQL BLOB streams don't block the thread on network I/O.
        #endregion
    }

    [Test]
    public void CustomBufferSize()
    {
        using var stream = new MemoryStream();

        #region custom-buffer-size
        // Bigger buffer = fewer, larger writes hit the sink — good for
        // remote streams where per-write overhead is high. Pass 0 to
        // disable buffering entirely and write straight to the sink.
        using var writer = new OpenXmlPackageWriter(
            stream,
            leaveOpen: true,
            // 1 MB
            bufferSize: 1024 * 1024);
        #endregion
    }

    [Test]
    public async Task WordDocumentBuilderSample()
    {
        using var stream = new MemoryStream();

        #region word-document-builder
        await using var word = new StreamingWordDocumentBuilder(stream, leaveOpen: true);

        // Add an optional styles part — referenced by paragraphs via StyleId.
        word.AddStyles(
            new(
            new Style(
                new StyleName
                {
                    Val = "Heading 1"
                },
                new BasedOn
                {
                    Val = "Normal"
                },
                new StyleRunProperties(
                    new Bold(),
                    new FontSize
                    {
                        Val = "32"
                    }))
            {
                Type = StyleValues.Paragraph,
                StyleId = "Heading1"
            }));

        // AddFooter returns the relationship id — plug it into SectionProperties
        // in the document body below so the body-level FooterReference resolves.
        var footerId = word.AddFooter(
            new(
                new Paragraph(new Run(new Text("— Confidential —")))));

        // Last step: write the main document body. The builder wires up all
        // the accumulated sub-part relationships (styles + footer) for you.
        word.WriteDocument(
            new(
                new Body(
                    new Paragraph(
                        new ParagraphProperties(
                            new ParagraphStyleId
                            {
                                Val = "Heading1"
                            }),
                        new Run(
                            new Text("Quarterly Report"))),
                    new Paragraph(
                        new Run(
                            new Text(
                                "Revenue grew 15% year-over-year."))),
                    new SectionProperties(
                        new FooterReference
                        {
                            Type = HeaderFooterValues.Default,
                            Id = footerId
                        }))));
        #endregion
    }
}