EditableDocument Class - GroupDocs.Editor for .NET

EditableDocument Class

Intermediate document, that contains content before and after editing

Inheritance Hierarchy

SystemObject
GroupDocs.EditorEditableDocument

Namespace: GroupDocs.Editor
Assembly: GroupDocs.Editor (in GroupDocs.Editor.dll) Version: 22.7.0.0

Syntax

C++

public sealed class EditableDocument : IAuxDisposable

Public NotInheritable Class EditableDocument
	Implements IAuxDisposable

public ref class EditableDocument sealed : IAuxDisposable

[<SealedAttribute>]
type EditableDocument =  
    class
        interface IAuxDisposable
    end

The EditableDocument type exposes the following members.

Properties

	Name	Description
	AllResources	Returns a list of all existing resources: all stylesheets, images from HTML and all stylesheets, fonts
	Audio	Returns a list of audio resources
	Css	Returns a list of CSS resources
	Fonts	Allows to obtain external font resources, which are used by this HTML document
	Images	Allows to obtain external image resources (raster images), which are used by this HTML document
	IsDisposed	Determines whether this Editable document was already disposed (true) or not (false)

Methods

	Name	Description
	Dispose	Disposes this Editable document instance, disposing its content and making its methods and properties non-working
	FromBodyMarkupAndResourceFolder	Static factory, that creates an instance of EditableDocument from a specified HTML markup, that doesn't contain an HTML header, but only inner markup of HTML BODY element, and from resources, located in the folder, specified by the full path
	FromFile	Static factory, that creates an instance of EditableDocument from a HTML file, that is specified by a path to the *.html file itself and a folder with linked resources
	FromMarkup	Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources
	FromMarkupAndResourceFolder	Static factory, that creates an instance of EditableDocument from a specified HTML markup and from resources, located in the folder, specified by the full path
	GetBodyContent	Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string.
	GetBodyContent(String)	Returns a body of the HTML document (content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified prefix.
	GetContent	Returns overall content of the HTML document as a string.
	GetContent(String, String)	Returns overall content of the HTML document as a string, where links to the external resources contain specified prefix.
	GetCssContent	Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Returns empty list, if there is no CSS for this document.
	GetCssContent(String, String)	Returns content of all external stylesheets as a list of strings, where one string represents one stylesheet. Specified prefix will be applied to every link to the external resource in every resultant stylesheet. Returns empty list, if there is no CSS for this document.
	GetEmbeddedHtml	Returns all content of this HTML document with all related resources in a form of a single string, where all resources are embedded inside the HTML markup in a base64-encoded form.
	Save(String)	Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources.
	Save(String, String)	Saves this HTML document to the file on specified path, where HTML markup will be stored, and to the accompanying folder with resources, which is located on specified path.

Events

	Name	Description
	Disposed	Event, which occurs when this Editable document is disposed, right after finishing the disposing process

Remarks

Instance of EditableDocument class can be produced by the 'Edit' method or created by the user himself using static factories. EditableDocument internally stores document in its own closed format, which is compatible (convertible) with all import and export formats, that GroupDocs.Editor supports. In order to make document editable in any WYSIWYG client-side editor (like CKEditor or TinyMCE), EditableDocument provides methods for generating HTML markup and producing resources, that can be accepted by the user.

Reference

GroupDocs.Editor Namespace