Saving EditableDocument to stream Leave feedback
On this page
This article shows and explains advanced techniques and approaches while working with EditableDocument, including saving its HTML markup and the accompanying resources.
The EditableDocument class is one of the most important among all types in GroupDocs.Editor. It is focused on producing HTML markup and saving it together with its resources, and it exposes several ways to do so. This article covers them.
The simplest way to persist an EditableDocument is its save() method. When invoked with only the HTML file path, it writes the HTML markup, and the accompanying resources are placed next to it automatically.
from groupdocs.editor import Editor
with Editor("document.docx") as editor:
editable = editor.edit()
# Write the HTML markup to a file
editable.save("document.html")
When the markup is needed in memory rather than on disk — for example, to push it into a stream, a database, or an HTTP response — it can be obtained as a string with get_content(), get_body_content(), or the fully self-contained get_embedded_html(). The resulting string can then be written into any binary stream, such as an io.BytesIO:
import io
from groupdocs.editor import Editor
with Editor("document.docx") as editor:
editable = editor.edit()
# All resources are embedded inside a single self-contained string
embedded_html = editable.get_embedded_html()
# Write the markup into an in-memory binary stream
stream = io.BytesIO()
stream.write(embedded_html.encode("utf-8"))
stream.seek(0)
When get_embedded_html() is used, the produced string is fully autonomous: stylesheets are embedded into the markup and images are serialized with base64 encoding directly into the src attributes, so no external resources are required.
The example below loads a document, opens it for editing, and saves its HTML markup to a file.
import os
from groupdocs.editor import Editor, License
def saving_editabledocument_to_stream():
# Optionally set a license
license_path = os.path.abspath("./GroupDocs.Editor.lic")
if os.path.exists(license_path):
License().set_license(license_path)
with Editor("./sample-document.docx") as editor:
editable = editor.edit()
# Save the HTML markup to a file
editable.save("output.html")
# The same markup is also available in memory as a string
embedded_html = editable.get_embedded_html()
print("Embedded HTML length:", len(embedded_html))
editable.dispose()
if __name__ == "__main__":
saving_editabledocument_to_stream()
sample-document.docx is the sample file used in this example. Click here to download it.
<HTML><HEAD><META charset="utf-8" /><TITLE>Sample Document ver.1</TITLE><META name="author" content="neD" /><LINK href="output_resources/style.css" rel="stylesheet" type="text/css" /></HEAD><BODY><DIV class="documentMainContent"><DIV class="Section1"><H1 class="Heading_1"><A id="_Toc465352669" ><SPAN class="Default_Paragraph_Font text001">Title of the document</SPAN></A></H1><H2 class="Heading_2"><A id="_Toc465352671" ><SPAN class="Default_Paragraph_Font text002">Subtitle #1</SPAN></A></H2><P cl
[TRUNCATED]
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.
