Editor Leave feedback

Inheritance: java.lang.Object

All Implemented Interfaces: com.groupdocs.editor.htmlcss.resources.IAuxDisposable

public final class Editor implements IAuxDisposable

Main class, which encapsulates conversion methods. Editor class provides methods for loading, editing, and saving documents of all supportable formats. It is disposable, so use a ‘using’ directive or dispose its resources manually via ‘Dispose()’ method call. Document loading is performed through constructors. Document editing - through method ‘Edit’, and saving back to the resultant document after edit - through method ‘Save’.

Editor class should be considered as an entry point and the root object of the GroupDocs.Editor. All operations are performed using this class. Typical usage of the Editor class for performing a full document editing pipeline is the next:

• Load a document into the Editor instance through its constructor.
• Optionally, detect a document type using a method.
• Open a document for editing by calling an method and obtaining an instance of class from it..
• Editing a document content on client-side using any WYSIWYG HTML-editor.
• Creating a new instance of from edited document content.
• Saving an edited document to some output format by calling a method.
• Disposing an instance of Editor class via ‘using’ operator or manually.

public Editor(DocumentFormatBase format)

Initializes a new instance of the Editor class and creates a new empty document based on the specified format.

IDocumentFormat format = WordProcessingFormats.Docx;
 Editor editor = new Editor(format);
 {
     // Use the editor instance to edit and save documents
 }

Parameters:

• More about file types supported by GroupDocs.Editor: Document formats supported by GroupDocs.Editor
• More about GroupDocs.Editor for Java features: Developer Guide

Developer Guide: https://docs.groupdocs.com/editor/java/developer-guide/ |

public Editor(InputStream document)

Initializes new Editor instance with specified input document (as a stream)

Parameters:

• More about file types supported by GroupDocs.Editor: Document formats supported by GroupDocs.Editor
• More about GroupDocs.Editor for Java features: Developer Guide

Developer Guide: https://docs.groupdocs.com/editor/java/developer-guide/ |

public Editor(InputStream document, ILoadOptions loadOptions)

Initializes new Editor instance with specified input document (as a stream) with its load options and Editor settings

Parameters:

public Editor(String filePath)

Initializes new Editor instance with specified input document (as a full file path)

Parameters:

• More about file types supported by GroupDocs.Editor: Document formats supported by GroupDocs.Editor
• More about GroupDocs.Editor for Java features: Developer Guide

Developer Guide: https://docs.groupdocs.com/editor/java/developer-guide/ |

public Editor(String filePath, ILoadOptions loadOptions)

Initializes new Editor instance with specified input document (as a full file path) with its load options

Parameters:

• More about file types supported by GroupDocs.Editor: Document formats supported by GroupDocs.Editor
• More about GroupDocs.Editor for Java features: Developer Guide
• More about how to open and edit password-protected documents and document from different storages: [Load and edit documents using GroupDocs.Editor][]

[Load and edit documents using GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/load-document/ |

public final EditableDocument edit(IEditOptions editOptions)

Opens a previously loaded document for editing using specified format-specific options by generating and returning an instance of ’’ class, that, in turn, contains methods for producing HTML markup and associated resources.

Parameters:

When input original document is loaded to the ‘Editor’ instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of ‘EditableDocument’ class. ‘EditableDocument’, returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload obtains edit options, which are specific for family formats.

Learn more

• More about editing documents using GroupDocs.Editor: How to edit document using GroupDocs.Editor

How to edit document using GroupDocs.Editor: https://docs.groupdocs.com/display/editornet/Edit+document |

Returns: EditableDocument

public final EditableDocument edit()

Opens a previously loaded document for editing using default options by generating and returning an instance of ‘EditableDocument’ class, that, in turn, contains methods for producing HTML markup and associated resources.

Returns: EditableDocument - Instance of the ‘EditableDocument’ class, which encapsulates overall input document with all its resources in intermediate format. This method, if successfully finished, never returns NULL.

When input original document is loaded to the ‘Editor’ instance through the constructor, this method allows to open document for editing by converting it to intermediate format, which is encapsulated within instance of ‘EditableDocument’ class. ‘EditableDocument’, returned from this method, contains all necessary methods and properties for producing HTML markup and corresponding resources (like images, fonts and stylesheets) in all necessary configurations for subsequent passing them into any WYSIWYG HTML-editor. This overload applies edit options, which are default for the format, to which the input document belongs.

Learn more

• More about editing documents using GroupDocs.Editor: How to edit document using GroupDocs.Editor

public final void save(EditableDocument inputDocument, OutputStream outputDocument, ISaveOptions saveOptions)

Converts specified edited document, represented as instance of ‘EditableDocument’, to the resultant document of specified format and saves its content to specified stream

Parameters:

• More about saving document after edit using GroupDocs.Editor: [How to save edited document using GroupDocs.Editor][]

[How to save edited document using GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Save+document |

public final void save(EditableDocument inputDocument, String filePath, ISaveOptions saveOptions)

Converts specified edited document, represented as instance of ‘’, to the resultant document of specified format and saves its content to file by specified file path

Parameters:

• More about saving document after edit using GroupDocs.Editor: [How to save edited document using GroupDocs.Editor][]

[How to save edited document using GroupDocs.Editor]: https://docs.groupdocs.com/display/editornet/Save+document |

public final OutputStream save(OutputStream outputDocument, WordProcessingSaveOptions saveOptions)

Converts the original document after modification (for example, FormFieldManager (#getFormFieldManager.getFormFieldManager)), to the resultant document of the specified format and saves its content to the provided stream.

Parameters:

If the outputDocument or saveOptions is null, an NullPointerException will be thrown. If the document to save is missing, an NullPointerException will be thrown.

Learn more:

• |

Returns: java.io.OutputStream - The stream containing the saved document content.

public final OutputStream save(OutputStream outputDocument)

Save the current document content to the specified output stream.

Parameters:

This method copies the content from the internal document representation to the provided output stream. The stream’s original position is preserved after the save operation. |

Returns: java.io.OutputStream - The stream with the saved document content.

public final IDocumentInfo getDocumentInfo(String password)

Returns metadata about the document, that was loaded to this ‘Editor’ instance

Parameters:

• Learn more about obtaining document specific properties in code: [How to get document info using GroupDocs.Editor][]

[How to get document info using GroupDocs.Editor]: https://docs.groupdocs.com/editor/java/extracting-document-metainfo/ |

Returns: IDocumentInfo

public final void dispose()

Disposes this instance of Editor, so that it releases all internal resources and becomes unavailable for further usage

public final boolean isDisposed()

Indicates whether this Editor instance was already disposed and cannot be used anymore (true) or not and is active (false)

Returns: boolean