Specify OOXML Compliance Level for Word Documents Leave feedback
GroupDocs.Assembly for Python via .NET allows you to control the OOXML compliance level when saving Word documents to OOXML formats (DOCX, DOCM, DOTX, DOTM, FlatOpc, etc.). You can explicitly specify the compliance level or let the report keep the template’s compliance level.
The main classes involved are:
- LoadSaveOptions - contains the
ooxml_complianceproperty - OoxmlCompliance - enumeration specifying compliance levels
- DocumentAssembler - assembles documents with specified compliance
Here are the steps to specify OOXML compliance:
- Create LoadSaveOptions for your output format
- Set the
ooxml_complianceproperty to the desired compliance level (or leave itNoneto keep the template’s level) - Pass the LoadSaveOptions to
assemble_document, before the data sources - The output document will be saved with the specified compliance level
NoteTheooxml_complianceproperty only applies to OOXML formats (DOCX, DOCM, DOTX, DOTM, FlatOpc, etc.) and is ignored for other file formats. When it isNone(the default), the report keeps the compliance level of the template: measured with Ecma, Transitional and Strict templates, each report kept its template’s level.
The OoxmlCompliance enumeration provides three compliance levels:
- ECMA: Specifies ECMA-376 compliance level
- TRANSITIONAL: Specifies ISO/IEC 29500:2008 Transitional compliance level (commonly used for compatibility)
- STRICT: Specifies ISO/IEC 29500:2008 Strict compliance level (fully compliant with the standard)
You can explicitly set the OOXML compliance level when assembling a document:
from groupdocs.assembly import DataSourceInfo, DocumentAssembler, FileFormat, LoadSaveOptions, OoxmlCompliance
assembler = DocumentAssembler()
# Create LoadSaveOptions with explicit OOXML compliance
options = LoadSaveOptions(FileFormat.DOCX)
options.ooxml_compliance = OoxmlCompliance.STRICT # or ECMA, TRANSITIONAL
data = {"CompanyName": "Harbor Lane Provisions", "Year": 2015}
assembler.assemble_document("annual-summary.docx", "annual-summary-report.docx", options,
DataSourceInfo(data, "company"))
The following sample file is used in this example: annual-summary.docx
Binary file (DOCX, 8 KB)
For maximum compatibility with older Office versions, use Transitional compliance:
from groupdocs.assembly import DataSourceInfo, DocumentAssembler, FileFormat, LoadSaveOptions, OoxmlCompliance
assembler = DocumentAssembler()
options = LoadSaveOptions(FileFormat.DOCX)
options.ooxml_compliance = OoxmlCompliance.TRANSITIONAL
data = {"CustomerName": "Quayside Bistro", "OrderNumber": "HLP-10001"}
assembler.assemble_document("order-acknowledgement.docx", "order-acknowledgement-report.docx", options,
DataSourceInfo(data, "order"))
The following sample file is used in this example: order-acknowledgement.docx
Binary file (DOCX, 8 KB)
For ECMA-376 standard compliance:
from groupdocs.assembly import DataSourceInfo, DocumentAssembler, FileFormat, LoadSaveOptions, OoxmlCompliance
assembler = DocumentAssembler()
options = LoadSaveOptions(FileFormat.DOCX)
options.ooxml_compliance = OoxmlCompliance.ECMA
data = {"ReportTitle": "Monthly Bulletin", "Month": "January 2015"}
assembler.assemble_document("monthly-bulletin.docx", "monthly-bulletin-report.docx", options,
DataSourceInfo(data, "report"))
The following sample file is used in this example: monthly-bulletin.docx
Binary file (DOCX, 7 KB)
When ooxml_compliance is not set (default None), the report keeps the compliance level of the template:
from groupdocs.assembly import DataSourceInfo, DocumentAssembler, FileFormat, LoadSaveOptions
assembler = DocumentAssembler()
# ooxml_compliance is None by default - the template's compliance is kept
options = LoadSaveOptions(FileFormat.DOCX)
data = {"Title": "Delivery Schedule", "Content": "Deliveries to Port Ellery run on Tuesdays and Fridays."}
# The report keeps the compliance level of status-notice.docx
assembler.assemble_document("status-notice.docx", "status-notice-report.docx", options,
DataSourceInfo(data, "document"))
The following sample file is used in this example: status-notice.docx
Binary file (DOCX, 7 KB)
The ooxml_compliance property works with all OOXML formats. The template below is a DOCX; LoadSaveOptions saves the report as DOCX, as macro-enabled DOCM and as a DOTX template:
from groupdocs.assembly import DataSourceInfo, DocumentAssembler, FileFormat, LoadSaveOptions, OoxmlCompliance
assembler = DocumentAssembler()
data = {"Name": "Cold-pressed olive oil", "Value": 320}
# DOCX format
docx_options = LoadSaveOptions(FileFormat.DOCX)
docx_options.ooxml_compliance = OoxmlCompliance.STRICT
assembler.assemble_document("stock-card.docx", "stock-card-report.docx", docx_options,
DataSourceInfo(data, "item"))
# DOCM format (macro-enabled)
docm_options = LoadSaveOptions(FileFormat.DOCM)
docm_options.ooxml_compliance = OoxmlCompliance.TRANSITIONAL
assembler.assemble_document("stock-card.docx", "stock-card-report.docm", docm_options,
DataSourceInfo(data, "item"))
# DOTX format (template)
dotx_options = LoadSaveOptions(FileFormat.DOTX)
dotx_options.ooxml_compliance = OoxmlCompliance.STRICT
assembler.assemble_document("stock-card.docx", "stock-card-report.dotx", dotx_options,
DataSourceInfo(data, "item"))
The following sample file is used in this example: stock-card.docx
stock-card-report.docm (8 KB)
stock-card-report.docx (8 KB)
stock-card-report.dotx (8 KB)
You can also specify OOXML compliance when working with streams:
import io
from groupdocs.assembly import DataSourceInfo, DocumentAssembler, FileFormat, LoadSaveOptions, OoxmlCompliance
assembler = DocumentAssembler()
options = LoadSaveOptions(FileFormat.DOCX)
options.ooxml_compliance = OoxmlCompliance.STRICT
data = {"CompanyName": "Harbor Lane Provisions", "Year": 2015}
with open("annual-summary.docx", "rb") as template_stream, io.BytesIO() as output_stream:
assembler.assemble_document(template_stream, output_stream, options,
DataSourceInfo(data, "company"))
with open("annual-summary-from-stream.docx", "wb") as f:
f.write(output_stream.getvalue())
The following sample file is used in this example: annual-summary.docx
Binary file (DOCX, 8 KB)
Understanding how compliance levels work:
- When explicitly set: The specified compliance level is used when saving to OOXML formats
- When
None(default): The report keeps the template’s compliance level (Ecma, Transitional or Strict) - For non-OOXML formats: The property is ignored (e.g., PDF, HTML, RTF)
from groupdocs.assembly import DataSourceInfo, DocumentAssembler, FileFormat, LoadSaveOptions, OoxmlCompliance
assembler = DocumentAssembler()
data = {"Title": "Price List", "Content": "Smoked gouda is 15.20 and Smoked sea salt is 3.95."}
# Explicit Strict compliance
strict_options = LoadSaveOptions(FileFormat.DOCX)
strict_options.ooxml_compliance = OoxmlCompliance.STRICT
assembler.assemble_document("compliance-demo.docx", "compliance-demo-strict.docx", strict_options,
DataSourceInfo(data, "doc"))
# Automatic preservation (None)
auto_options = LoadSaveOptions(FileFormat.DOCX)
# auto_options.ooxml_compliance is None - the template's level is kept
assembler.assemble_document("compliance-demo.docx", "compliance-demo-auto.docx", auto_options,
DataSourceInfo(data, "doc"))
# Note: For PDF output, ooxml_compliance is ignored
pdf_options = LoadSaveOptions(FileFormat.PDF)
pdf_options.ooxml_compliance = OoxmlCompliance.STRICT # Ignored for PDF
assembler.assemble_document("compliance-demo.docx", "compliance-demo.pdf", pdf_options,
DataSourceInfo(data, "doc"))
The following sample file is used in this example: compliance-demo.docx
compliance-demo-auto.docx (7 KB)
compliance-demo-strict.docx (8 KB)
compliance-demo.pdf (19 KB)
WarningTheooxml_complianceproperty only affects OOXML formats. When saving to other formats like PDF, HTML, or RTF, this property is ignored. The compliance level is determined by the output format, not the template format.
To learn more about format-specific options, document conversion settings, and advanced compliance handling, please refer to the advanced usage section.
You may easily run the code above and see the feature in action in our GitHub examples:
- GroupDocs.Assembly for .NET examples, plugins, and showcase
- GroupDocs.Assembly for Java examples, plugins, and showcase
- GroupDocs.Assembly for Python via .NET examples, plugins, and showcase
Along with the full-featured library, we provide simple but powerful free online apps.
To assemble documents from templates and data sources, you can use the online apps from the GroupDocs.Assembly App Product Family.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
