open-xml-docx

name	open-xml-docx
description	Guide and examples for using OpenXML Docx features in the open_xml package.

OpenXML Word Documents (.docx)

The open_xml package allows for generating, editing, and parsing .docx documents.

Creating a Document

To create a new Word Document:

import 'package:open_xml/open_xml.dart';
import 'package:file/local.dart';

Future<void> main() async {
  const fs = LocalFileSystem();
  final doc = await WordDocument.create(fs);
  
  // Save the document
  await doc.save(fs.file('example.docx'));
}

Adding Paragraphs and Text Runs

A WordDocument contains a sequence of elements, most commonly Paragraphs. A Paragraph contains a sequence of Runs.

  // Add a simple paragraph
  doc.addParagraph(
    Paragraph()
      ..addRun(Run(text: 'Hello, '))
      ..addRun(Run(
        text: 'World!', 
        bold: true, 
        color: 'FF0000', 
        fontSize: 24,
      )),
  );

Run Formatting Options

• bold: Boolean (true/false)
• italic: Boolean (true/false)
• underline: Boolean (true/false)
• color: Hex color string (e.g. '00FF00')
• fontSize: Integer representing half-points.
• fontFamily: String representing font face.

Hyperlinks

Hyperlinks can be added to paragraphs easily:

doc.addParagraph(
  Paragraph()
    ..addHyperlink(
      'Visit Google',
      'https://google.com',
    ),
);

Comments

You can insert comments on a specific text range:

doc.addParagraph(
  Paragraph()
    ..addComment(
      author: 'Author Name',
      text: 'This is a comment on the text',
      initials: 'AN',
      run: Run(text: 'commented text'),
    ),
);

Markdown Conversion

You can generate a .docx document directly from Markdown, or extract Markdown from an existing .docx.

Markdown to Docx

final markdown = '''
# Heading 1
This is a paragraph with **bold** and *italic* text.
''';

await doc.addMarkdown(markdown);

Docx to Markdown

final existingDoc = await WordDocument.open(fs.file('my_doc.docx'));
final markdownText = existingDoc.toMarkdown();
print(markdownText);

Parsing Docx Files

You can extract text nodes or navigate through paragraphs in existing documents:

final existingDoc = await WordDocument.open(fs.file('my_doc.docx'));

// Iterate over text runs
for (final text in existingDoc.parseText()) {
  print(text);
}

Examples

• docx_to_markdown_example
• docx_markdown_example
• docx_images_example
• docx_comments_example
• docx_example
• docx_hyperlinks_example
• docx_parser_example
• docx_high_level_example