rodydavis/open_xml/open-xml-package

OpenXML Core Guide

The open_xml package is a comprehensive Dart library for generating, parsing, and verifying Office Open XML (OOXML) documents (.docx, .xlsx, .pptx). It uses package:file extensively to abstract away the file system, ensuring compatibility across different platforms (e.g. mobile, desktop, web, or memory-based file systems).

File System Abstraction

All core document types in open_xml (WordDocument, Workbook, and Presentation) require a FileSystem instance from package:file to interact with files.

Usage Example (Local File System)

import 'package:file/local.dart';
import 'package:open_xml/open_xml.dart';
 
Future<void> main() async {
  const fs = LocalFileSystem();
  
  // Create Documents using fs
  final doc = await WordDocument.create(fs);
  final wb = await Workbook.create(fs);
  final pres = await Presentation.create(fs);
}

Usage Example (Memory File System)

For environments like tests or the web, you can use the memory file system:

import 'package:file/memory.dart';
import 'package:open_xml/open_xml.dart';
 
Future<void> main() async {
  final fs = MemoryFileSystem();
  
  // Creates files entirely in memory
  final doc = await WordDocument.create(fs);
  await doc.save(fs.file('in_memory.docx'));
}

Opening Existing Files

The API allows you to open existing Office documents.

final existingDoc = await WordDocument.open(fs.file('path/to/existing.docx'));

High Level Architecture

The core of open_xml handles:

1. Archive/ZIP: All office documents are zipped archives of XML files.
2. Relationships: Managing internal connections between XML parts (e.g., slide to slide layout, document to images).
3. Namespaces: Handling verbose OOXML namespaces correctly.
4. Validation: The package integrates checks to ensure the generated structure conforms to valid OOXML standards.

For detailed usage, refer to the document-specific guides:

• Word Documents (.docx)
• Spreadsheets (.xlsx)
• Presentations (.pptx)

Examples

OUT Examples

XLSX Examples

• xlsx_to_json_example
• xlsx_high_level_example
• xlsx_comments_example
• csv_to_xlsx_example
• xlsx_json_example
• xlsx_hyperlinks_example
• xlsx_example
• xlsx_sqlite_example
• xlsx_to_csv_example
• xlsx_internal_links_formulas_example

PPTX Examples

• pptx_example
• test_gen_example
• pptx_images_example
• basic_bindings
• pptx_comments_example
• pptx_to_markdown_example
• markdown_to_pptx_example
• pptx_media_parsing_example
• pptx_hyperlinks_example
• backgrounds_example
• images_example
• pptx_notes_example
• remote_media_example
• pptx_high_level_example

DOCX 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