IDocumentService — интерфейс

Представляет сервис для работы с документами.

Синтаксис

public interface IDocumentService

Методы

Имя Описание

AddAdditionalFile(Document, String)

Добавляет в документ дополнительный файл.

AddAdditionalFile(Document, VersionedFileCard)

Добавляет в документ дополнительный файл.

AddAdditionalFiles(Document, IEnumerable<string>)

Добавляет дополнительные файлы в документ.

AddMainFile(Document, String)

Добавляет в документ основной файл.

AddMainFileComment(Document, DocumentFile, String)

Добавляет комментарий к основному файлу документа.

AddMainFiles(Document document, IEnumerable<String>)

Добавляет несколько основных файлов в документ.

AddMainFileVersionComment(Document, DocumentFile, Guid, String)

Добавляет комментарий к указанной версии основного файла документа.

AddSignature(Document, X509Certificate2, Boolean, ICollection<CardFieldSetting>)

Добавляет новую подпись в список подписей карточки и устанавливает ЭП на поля, основные и дополнительные файлы документа.

AddSignature(Document, X509Certificate2, SignatureLabel, StaffEmployee, String, Boolean, ICollection<CardFieldSetting>)

Данный метод предназначен для выполнения подписания операции в документе.

AddSignatures(Document, `SignedCms)`

Данный метод добавляет коллекцию новых подписей в список подписей карточки, и устанавливает ЭП на поля, основные и дополнительные файлы документа. Позволяет использовать для подписания криптографическое сообщение типа SignedCms.

AddSignatures — метод (Document, DocumentFile, `SignedCms)`

Добавляет коллекцию новых подписей в список подписей карточки. Определяет, к какому файлу будет добавлена подпись. Позволяет использовать для подписания криптографическое сообщение типа SignedCms.

AddSignatures — метод (Document, DocumentFile, `SignedCms, bool)`

Добавляет коллекцию новых подписей в список подписей карточки. Определяет, к какому файлу будет добавлена подпись. Позволяет использовать для подписания криптографическое сообщение типа SignedCms. Позволяет проверять срок действия добавляемых подписей.

AddSignatures — метод (Document, `SignedCms, bool)`

Добавляет коллекцию новых подписей в список подписей карточки. Устанавливает ЭП на поля, основные и дополнительные файлы документа. Позволяет использовать для подписания криптографическое сообщение типа SignedCms. Позволяет проверять срок действия добавляемых подписей.

ApplyKindSettings(Document, DocumentSetting)

Устанавливает у документа определённые настройки вида карточки.

ApplyKindSettings(Document, KindsCardKind)

Устанавливает у документа настройки указанного вида карточки.

AttachMainFile(Document, String)

Загружает в документ основной файл.

AttachMainFile(Document, VersionedFileCard)

Добавляет в документ карточку версионного файла в качестве основного файла документа.

AttachMainFile(Document, string, `SignedCms, bool)`

Добавляет в документ подпись в качестве основного файла документа, проверяет срок действия подписи.

CanAttachMainFile(Document, VersionedFileCard)

Определяет возможность добавления основного файла в документ.

CanAttachMainFile(Document, VersionedFileCard, `SignedCms)`

Определяет возможность добавления основного файла в документ.

CanCancelLockAnyMainFile(Document)

Определяет возможность снятия блокировки с основных файлов.

CanCancelLockMainFile(DocumentFile)

Определяет возможность снятия блокировки с основного файла.

CancelLockMainFile(Document, DocumentFile)

Снимает блокировку с основного файла документа.

CancelLockMainFileIfNeeded(Document, DocumentFile)

Снимает блокировку с основного файла документа, если это необходимо.

CanEditAnyMainFile(Document)

Определяет наличие в документе основного файла, который может быть открыт для редактирования.

CanEditMainFile(Document, DocumentFile, Boolean)

Определяет возможность выгрузки указанного основного файла для редактирования.

CanLockAnyMainFile(Document)

Определяет наличие по меньшей мере одного основного файла документа, который может быть заблокирован.

CanLockMainFile(Document, DocumentFile, Boolean)

Определяет возможность блокировки указанного основного файла документа.

CanRemoveMainFile(Document, DocumentFile)

Определяет возможность удаления указанного основного файла.

CanRemoveMainFiles(Document document, IEnumerable<DocumentFile>)

Определяет возможность удаления указанных основных файлов.

CanUnlockAnyMainFile(Document)

Определяет наличие в документе основных файлов, которые могут быть разблокированы.

CanUnlockMainFile(Document, DocumentFile)

Определяет возможность разблокировки определённого основного файла документа.

CanUnlockMainFile(Document, DocumentFile, LockStatus)

Определяет возможность разблокировки определённого основного файла документа.

CanUnlockMainFile(Document, DocumentFile, String)

Определяет возможность разблокировки определённого основного файла документа.

CheckActualSignature(Document, ICollection<CardFieldSetting>, BaseCardSignature)

Определяет актуальность ЭП по отношению к данным документа.

CheckAllMainFilesSigned(Document, BaseCardSignature)

Определяет корректность ЭП, установленной на основных файлах документа.

CheckMainFileSigned(Document, DocumentFile)

Определяет наличие подписи у указанного основного файла документ.

ComputeAttachmentSignature(Document, BaseCardSignature, X509Certificate2)

Подписывает дополнительные файлы документа.

ComputeFieldsSignature(Document, BaseCardSignature, X509Certificate2, ICollection<CardFieldSetting>)

Подписывает атрибуты документа.

ComputeMainFileSignature(Document, BaseCardSignature, X509Certificate2)

Подписывает основные файлы документа.

CreateDocument

Создаёт экземпляр нового документа.

CreateDocument(String)

Создаёт экземпляр нового документа с основным файлом.

CreateDocument(String, KindsCardKind)

Создаёт экземпляр нового документа с указанным видом, с основным файлом.

CreateDocument(String, KindsCardKind, DocumentVersioningType)

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

CreateListCards(Document)

Инициализирует списки, используемые документом.

CreateSignatureList

Инициализирует новый экземпляр списка подписей документа.

DecodeSignedDocument(String, Document, `SignedCms)`

Расшифровывает сообщение CMS/PKCS 7, которое содержится в файле, расположенном по указанному пути.

DownloadAdditionalFile(Document, DocumentFile)

Выгружает в файловую систему указанный дополнительный файл документа.

DownloadAdditionalFile(Document, DocumentFile, String)

Выгружает дополнительный файл документа в указанный каталог.

DownloadFile(Guid)

Сохраняет файл с указанным идентификатором на файловую систему.

DownloadMainFile(Document, DocumentFile)

Выгружает основной файл документа на диск.

DownloadMainFile(Document, DocumentFile, String)

Выгружает основной файл документа в указанный каталог.

DownloadMainFileVersion(Document, DocumentFile, Guid)

Выгружает определённую версию основного файла документа.

DownloadMainFileVersion(Document, DocumentFile, Guid, String)

Выгружает указанную версию основного файла документа в заданный каталог.

EditMainFile(Document, DocumentFile)

Устанавливает временную блокировку и выгружает файл в файловую систему.

EditMainFile(Document, DocumentFile, String)

Устанавливает временную блокировку и выгружает файл в заданный каталог.

EditMainFileComment(Document, DocumentFile, FileComment, String)

Редактирует комментарий к основному файлу.

Export(Document, DocumentExportTransformSetting)

Экспортирует документ в формате XML.

ExportFromTransform(Document, Stream, DocumentExportTransformSetting)

Экспортирует документ в указанный поток.

ExportToHtml(Document)

Экспортирует документ и возвращает сформированный HTML.

ExportToHtmlFile(Document)

Экспортирует документ в формате HTML и возвращает путь к сформированному файлу.

ExportToPDF(String, Document)

Отправляет на печать основные файлы.

ExportToPDF(String, Document, DocumentFile)

Отправляет на печать указанный файл документа.

ExportToPDF(String, Document, IEnumerable<DocumentFile>)

Отправляет на печать коллекцию файлов документа.

ExportToZip(String, Dictionary<String, Stream>)

Архивирует файлы, представленные в виде потока, в формате zip.

GetAdditionalFile(DocumentFile)

Возвращает карточку файл с версиями из дополнительного файла документа.

GetAdditionalFiles(Document)

Получает все дополнительные файлы заданного документа.

GetFiles(Document)

Получает все файлы документа.

GetFileTypeLocalizedName(DocumentFile)

Возвращает локализованное название типа файла документа (основной, дополнительный).

GetKindSettings(KindsCardKind)

Возвращает настройки заданного вида карточки Документ.

GetMainFile(DocumentFile)

Возвращает карточку файл с версиями из основного файла документа.

GetMainFileChanged(DocumentFile)

Возвращает признак того, что в указанном файле есть несохранённые изменения.

GetMainFileLockStatus(DocumentFile, LockStatus)

Возвращает статус блокировки основного файла.

GetMainFileLockStatus(DocumentFile, LockStatus, String)

Возвращает статус блокировки основного файла и учетную запись заблокировавшего сотрудника.

GetMainFiles(Document)

Возвращает все основные файлы документа.

GetMainFileVersionNumber(DocumentFile, Guid)

Возвращает строковое представление указанной версии основного файла.

HasAnyMainFileChanged(Document)

Определяет наличие основного файла карточки с несохранёнными изменениями.

HasEditedMainFile(DocumentFile)

Определяет наличие редактируемого основного файла карточки.

HasEditedMainFile(DocumentFile, LockStatus)

Определяет наличие редактируемого основного файла карточки. Текущий статус блокировки файла указывается принудительно.

HasFreeMainFile(DocumentFile)

Возвращает true, если указанный основной файл свободен.

HasFreeMainFiles(IEnumerable<DocumentFile>)

Возвращает true, если все основное файлы не заблокированы.

HasLockedMainFile(DocumentFile)

Возвращает true, если основной файл выгружен для редактирования, либо заблокирован владельцем сессии.

HasLockedMainFile(DocumentFile, LockStatus)

Возвращает true, если основной файл выгружен для редактирования, либо заблокирован владельцем сессии. Текущий статус блокировки файла указывается принудительно.

HasMainFile(DocumentFile)

Определяет, что указанный файл документа является основным файлом.

IsDocumentSignaturePartAttachments(BaseCardSignaturePart)

Возвращает true, если переданной частью ЭП подписан дополнительный файл.

IsDocumentSignaturePartFields(BaseCardSignaturePart)

Возвращает true, если переданной частью ЭП подписаны поля карточки.

IsDocumentSignaturePartMainFile(BaseCardSignaturePart)

Возвращает true, если переданной частью ЭП подписан основной файл.

IsEncodedSignedDocument(String)

Определяет соответствие указанного файла криптографическому сообщению CMS/PKCS 7.

IsFileNotEmpty(Document, DocumentFile)

Возвращает true, если файл документа не нулевой.

LockMainFile(Document, DocumentFile)

Выгружает файл карточки и ставит постоянную блокировку.

LockMainFile(Document, DocumentFile, String)

Выгружает файл из документа на диск с установкой постоянной блокировки.

MakeCurrentMainFileVersion(Document, DocumentFile, Guid)

Задаёт последнюю версию файла.

MakeLockedMainFileForceChanged(Document, DocumentFile)

Устанавливает признака наличия изменений для выгруженного основного файла документа.

PrepareToVerifySignature(Document, IDictionary<BaseCardSignaturePart, Stream>, IEnumerable<BaseCardSignaturePart>, Boolean, Boolean, ICollection<CardFieldSetting>)

Заполняет коллекцию IDictionary<BaseCardSignaturePart, Stream>, где ключ соответствует части ЭП, а значение коллекции — сопоставленные частям ЭП значения полей, основных или дополнительных файлов.

PurgeFileCache(Document)

Очищает кэш файлов документ.

RemoveAdditionalFile(Document, DocumentFile)

Удаляет заданный дополнительный файл из документа.

RemoveMainFile(Document, DocumentFile)

Удаляет заданный основной файл из документа.

RemoveMainFile(Document, DocumentFile)

Удаляет заданный основной файл из документа. Если файл заблокирован, то блокировка отменяется.

RemoveMainFileComments(Document, DocumentFile, FileCommentCollection, IEnumerable<FileComment>)

Удаляет комментарии к файлу документа.

RemoveMainFileVersion(Document, DocumentFile, Guid)

Удаляет указанную версию файла документа.

RemoveMainFileVersionComments(Document, DocumentFile, Guid, IEnumerable<FileComment>)

Удаляет комментарии к заданной версии файла.

RenameAdditionalFile(Document, DocumentFile, String)

Переименовывает дополнительный файл документа.

RenameMainFile(Document, DocumentFile, String)

Переименовывает основной файл документа.

ReplaceMainFile(Document, DocumentFile, String, `SignedCms)`

Заменяет основной файл документа. Новый файл должен иметь название аналогичное старому.

SignatureInfo GetPartSignatureInfo(BaseCardSignaturePart signaturePart)

Возвращает информацию о части подписи документа.

SyncPropertiesFromFile(Document, IList<IDocumentPropertySetting>, String)

Загружает свойства документа из файла.

SyncPropertiesFromFiles(Document, IList<IDocumentPropertySetting>, IEnumerable<string>)

Загружает свойства документа из нескольких файлов.

SyncPropertiesToFile(Document, DocumentFile, IList<IDocumentPropertySetting>)

Выполняет синхронизацию значений полей карточки Документ со свойствами основного файла данного документа. Передача осуществляется в сторону вложенного файла.

UnlockMainFile(Document, DocumentFile)

Разблокирует указанный файл. При наличии изменений в файле документа, номер версии будет увеличен.

UnlockMainFile(Document, DocumentFile, String)

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

UnlockMainFile(Document, DocumentFile, Int32, String, Boolean)

Разблокирует файл. В случае наличия изменений в файле документа, увеличивает номер версии. К файлу или версии файла добавляется комментарий.

UnlockMainFile(Document, DocumentFile, Int32, String, Boolean, String)

Разблокирует файл, расположенный по заданному пути. В случае наличия изменений в файле документа, увеличивает номер версии. К файлу или версии файла добавляется комментарий.

VerifySignature(Document, BaseCardSignature, X509Certificate2, Boolean, Boolean, ICollection<CardFieldSetting>)

Выполняет проверку ЭП, установленной на документе, файлах документа или полях, и возвращает результат проверки.

События

Имя Описание

AdditionalFileAdded

Событие срабатывает после добавлении дополнительного файла.

AdditionalFileRemoved

Событие срабатывает после удаления дополнительного файла.

MainFileAdded

Событие срабатывает после добавлении основного файла.

MainFileCancelLocked

Событие срабатывает после отмены блокировки основного файла.

MainFileCurrentVersionChanged

Событие срабатывает после изменения текущей версии основного файла.

MainFileLocked

Событие срабатывает после блокировки основного файла.

MainFileRemoved

Событие срабатывает после удаления основного файла.

MainFileUnlocked

Событие срабатывает после разблокировки основного файла.

MainFileUnlocking

Вызывается до разблокировки основного файла.

SignatureAdded

Событие срабатывает после подписания документ ЭП.

SynchronizationFromFileCompleted

Событие срабатывает после синхронизации данных карточки со свойствами основного файла.