GetDocumentInfo

Editor.GetDocumentInfo method

Возвращает метаданные о документе, загруженном в этот «Редактор» instance

public IDocumentInfo GetDocumentInfo(string password)
Параметр Тип Описание
password String Пользователь может указать пароль для документа, если этот документ зашифрован паролем. Может быть NULL или пустой строкой, что эквивалентно отсутствующему паролю. Для тех форматов документов, которые не имеют функции защиты паролем, этот аргумент будет проигнорирован. Если документ зашифрован, и в этом параметре не указан пароль, но он был указан ранее в параметрах загрузки при создании этогоEditor например, он будет использоваться.

Возвращаемое значение

Специфичный для формата наследникIDocumentInfo интерфейс, который указывает обнаруженный формат с метаданными, специфичными для формата, или NULL, , если документ не был распознан как поддерживаемый или поврежден.

Исключения

исключение условие
ObjectDisposedException Вызывается, когда экземпляр Editor уже был удален при вызове «GetDocumentInfo».
PasswordRequiredException Выбрасывается, когда загруженный документ защищен паролем, но пароль не был указан в параметре “password”
IncorrectPasswordException Выбрасывается, когда загруженный документ защищен паролем, пароль указан, но неверный
InvalidOperationException Возникает при возникновении неожиданной ошибки неизвестного характера

Примечания

Метод GetDocumentInfo полезен, когда неясно, какого формата входной документ, защищен ли он паролем и/или сколько страниц/рабочих листов/слайдов он содержит. На основе этих метаданных, возвращаемых GetDocumentInfo, можно правильно настроить параметры загрузки и редактирования для основного конвейера обработки.

Метод GetDocumentInfo всегда возвращает полные данные, на него не влияет пробный режим, его использование не списывает использованные байты или кредиты.

Узнать больше

Смотрите также

Edit Save