EditableDocument

EditableDocument class

Intermediate document, that contains content before and after editing

public sealed class EditableDocument : IAuxDisposable

Properties

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

Methods

Name Description
static FromFile(string, string) 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
static FromMarkup(string, IEnumerable<IHtmlResource>) Static factory, that creates an instance of EditableDocument from specified HTML markup and a set of corresponding linked resources
static FromMarkupAndResourceFolder(string, string) 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
Dispose() Disposes this Editable document instance, disposing its content and making its methods and properties non-working
GetBodyContent() Returns a body of the HTML document (inner content between opening and closing BODY tags without these tags) as a string.
GetBodyContent(string) Returns a body of the HTML document (inner content between opening and closing BODY tags without these tags) as a string, where links to the external resources contain specified template with placeholders.
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 template with placeholders.
GetContent<TStream>(TStream, Encoding) Returns overall content of the HTML document as a byte stream by writing this content into specified stream with specified text encoding
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.
Save(TextWriter, HtmlSaveOptions) Saves the content of this EditableDocument as the HTML document to the specified text writer, while the second options parameter allows to customize the saving procedure and resource saving callback

Events

Name Description
event 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.

See Also

Editor