Editor
Editor class
Основной класс, который инкапсулирует методы преобразования. Класс Editor предоставляет методы для загрузки, редактирования и сохранения документов всех поддерживаемых форматов. Он одноразовый, поэтому используйте директиву «using» или удалите его ресурсы вручную с помощью вызова метода «Dispose()». Загрузка документа осуществляется через конструкторы. Редактирование документа - с помощью метода “Редактировать”, и сохранение обратно в результирующий документ после редактирования - с помощью метода “Сохранить”.
public sealed class Editor : IAuxDisposable
Конструкторы
Имя |
Описание |
Editor(Func<Stream>) |
Инициализирует новый экземпляр редактора с указанным входным документом (в виде потока) |
Editor(string) |
Инициализирует новый экземпляр редактора с указанным входным документом (как полный путь к файлу) |
Editor(Func<Stream>, Func<ILoadOptions>) |
Инициализирует новый экземпляр редактора с указанным входным документом (в виде потока) с параметрами загрузки |
Editor(string, Func<ILoadOptions>) |
Инициализирует новый экземпляр редактора с указанным входным документом (как полный путь к файлу) с параметрами загрузки |
Характеристики
Имя |
Описание |
IsDisposed { get; } |
Указывает, был ли этот экземпляр редактора уже удален и больше не может использоваться (true) или он еще не был удален и поэтому активен (false) |
Методы
Имя |
Описание |
Dispose() |
Удаляет этот экземпляр редактора, освобождая все внутренние ресурсы и делая его недоступным для дальнейшего использования |
Edit() |
Открывает ранее загруженный документ для редактирования с параметрами по умолчанию, создавая и возвращая экземпляр ‘EditableDocument класс, который, в свою очередь, содержит методы для создания HTML-разметки и связанных ресурсов. |
Edit(IEditOptions) |
Открывает ранее загруженный документ для редактирования с использованием указанных параметров, специфичных для формата, путем создания и возврата экземпляра ‘EditableDocument класс, который, в свою очередь, содержит методы для создания HTML-разметки и связанных ресурсов. |
GetDocumentInfo(string) |
Возвращает метаданные о документе, загруженном в этот «Редактор» instance |
Save(EditableDocument, Stream, ISaveOptions) |
Преобразует указанный отредактированный документ, представленный как экземпляр ‘EditableDocument , в результирующий документ указанного формата и сохраняет его содержимое в указанный stream |
Save(EditableDocument, string, ISaveOptions) |
Преобразует указанный отредактированный документ, представленный как экземпляр ‘EditableDocument , в результирующий документ указанного формата и сохраняет его содержимое в файл по указанному файлу path |
События
Имя |
Описание |
event Disposed |
Событие, которое происходит, когда этот экземпляр редактора удаляется со всеми его внутренними ресурсами |
Примечания
Класс Editor следует рассматривать как точку входа и корневой объект GroupDocs.Editor. Все операции выполняются с помощью этого класса. Типичное использование класса Editor для выполнения полного конвейера редактирования документа:
- Загрузите документ в экземпляр Editor через его конструктор.
- При необходимости определите тип документа с помощью
GetDocumentInfo
метод.
- Откройте документ для редактирования, вызвав
Edit
метод и получение экземпляраEditableDocument
класс от него.
- Редактирование содержимого документа на стороне клиента с помощью любого WYSIWYG HTML-редактора.
- Создание нового экземпляра
EditableDocument
из отредактированного содержимого документа.
- Сохранение отредактированного документа в каком-либо выходном формате путем вызова
Save
метод.
- Удаление экземпляра класса Editor с помощью оператора «using» или вручную.
Смотрите также