PublicAPI DocflowApiRoot PublicAPI.Docflow.DocumentДокументация ELMA API
Документ
Путь доступа: PublicAPI.Docflow.Document
Методы

  ИмяОписание
Открытый методAddComment(Document, Comment)
Добавить комментарий
Открытый методAddComment(Document, String)
Добавить комментарий к документу
Открытый методAddComment(Document, Comment, IEnumerable Attachment , IEnumerable DocumentAttachment )
Добавить комментарий
Открытый методAddComment(Document, String, User, IEnumerable DocumentAttachment , IEnumerable Attachment )
Добавить комментарий к документу
Открытый методAddDocumentCreatePermission(OrganizationItem, Type)
Добавление прав на создание документа определенного типа для элемента оргструктуры
Открытый методAddDocumentCreatePermission(User, Type)
Добавление прав на создание документа определенного типа для пользователя
Открытый методAddDocumentCreatePermission(UserGroup, Type)
Добавление прав на создание документа определенного типа для группы пользователей
Открытый методAddEditPermission(Document, OrganizationItem)
Метод для добавления прав на редактирование документа
Открытый методAddEditPermission(Document, User)
Метод для добавления прав на редактирование документа
Открытый методAddEditPermission(Document, UserGroup)
Метод для добавления прав на редактирование документа
Открытый методAddFullAccessPermission(Document, OrganizationItem)
Метод для добавления полного доступа к документу
Открытый методAddFullAccessPermission(Document, User)
Метод для добавления полного доступа к документу
Открытый методAddFullAccessPermission(Document, UserGroup)
Метод для добавления полного доступа к документу
Открытый методAddManageAccessPermission(Document, OrganizationItem)
Метод для добавления прав доступа к документу
Открытый методAddManageAccessPermission(Document, User)
Метод для добавления прав доступа к документу
Открытый методAddManageAccessPermission(Document, UserGroup)
Предоставить право администрирования прав данного документа
Открытый методAddQuestion(Document, Question)
Задать вопрос к документу
Открытый методAddQuestion(Document, User, String, IEnumerable Attachment , Boolean)
Задать вопрос к документу
Открытый методAddViewPermission(Document, OrganizationItem)
Предоставить пользователям элемента оргструктуры права на просмотр документа
Открытый методAddViewPermission(Document, User)
Предоставить пользователю права на просмотр документа
Открытый методAddViewPermission(Document, UserGroup)
Метод для добавления группе пользователей прав на просмотр документа
Открытый методArchive
Отправить документ в архив
Открытый методCanChangeStatus
Можно ли изменить статус жизненного цикла документа. Проверяется для текущего пользователя
Открытый методChangeStatus(Document, LifeCycleStatus)
Изменить статус документа. Статус не будет изменён, если у текущего пользователя нет соответствующих привилегий
Открытый методChangeStatus(Document, LifeCycleStatus, String)
Изменить статус документа. Статус не будет изменён, если у текущего пользователя нет соответствующих привилегий
Открытый методCount 
Возвращает количество всех объектов этого типа
Открытый методCount(IEntityFilter)
Получить количество всех объектов по фильтру
Открытый методCreate Устарело.
Создать новую сущность (без записи в БД)
Открытый методCreate(Folder, String)Устарело.
Создать документ определённого типа. Создает объект без сохранения в БД
Открытый методCreate(BinaryFile, Folder, String)Устарело.
Создать документ определенного типа
Открытый методCreateLink
Создать связь документа
Открытый методDelete
Удалить сущность в БД
Открытый методDeleteDocumentCreatePermission(OrganizationItem, Type)
Удаление прав на создание документа определенного типа у элемента оргструктуры
Открытый методDeleteDocumentCreatePermission(User, Type)
Удаление прав на создание документа определенного типа у пользователя
Открытый методDeleteDocumentCreatePermission(UserGroup, Type)
Удаление прав на создание документа определенного типа у группы пользователей
Открытый методDeleteLinks
Удалить все связи документа
Открытый методDeletePermissions(Document, OrganizationItem)
Удалить привилегии на документ у элемента оргструктуры
Открытый методDeletePermissions(Document, User)
Удалить привилегии на документ у пользователя
Открытый методDeletePermissions(Document, UserGroup)
Удалить привилегии на документ у группы пользователей
Открытый методFilter
Создает помощник для работы с фильтром объекта "Документ"
Открытый методFind(FetchOptions)
Найти объекты в соответствии с параметрами выборки
Открытый методFind(String)
Найти объекты в соответствии с фильтром на языке EQL
Открытый методFind(IEntityFilter, FetchOptions)
Найти объекты в соответствии с фильтром и параметрами выборки
Открытый методFindByIdArray
Найти все объекты по идентификаторам из массива
Открытый методGetAllLinkedDocuments
Получить все связанные документы
Открытый методGetEnableStatuses
Получить список статусов, на которые можно сменить текущий статус документа
Открытый методGetFileByDocumentId
Получить файл текущей версии документа
Открытый методIsDirty
Проверить, есть ли несохраненные изменения в объекте
Открытый методIsNew
Проверить, является ли объект новым (не сохранен в БД)
Открытый методLoad(Guid)
Загрузить по уникальному идентификатору. Если не найдена - вызывается исключение
Открытый методLoad(Int64)
Загрузить по идентификатору. Если не найдена - вызывается исключение
Открытый методLoadOrCreate(Guid)
Загрузить по идентификатору. Если не найден - возвращается новый объект
Открытый методLoadOrCreate(Int64)
Загрузить по идентификатору. Если не найден - возвращается новый объект
Открытый методLoadOrNull(Guid)
Загрузить по уникальному идентификатору. Если не найдена - возвращается null
Открытый методLoadOrNull(Int64)
Загрузить по идентификатору. Если не найдена - возвращается null
Открытый методLoadRegVariant
Загрузить регистрационный вариант по идентификатору
Открытый методMove
Переместить документ в другую папку
Открытый методRefresh
Обновить (перечитать) объект из БД
Открытый методRegister(Document, RegistrationVariant)
Регистрация документа с помощью варианта регистрации
Открытый методRegister(Document, Depository, DocumentFlowType)
Регистрация документа по делу и документопотоку
Открытый методRegister(Document, RegistrationVariant, ReservedRegNumber)
Регистрация документа с помощью варианта регистрации
Открытый методRegister(Document, Depository, DocumentFlowType, ReservedRegNumber)
Регистрация документа по делу и документопотоку
Открытый методRegister(Document, RegistrationVariant, ReservedRegNumber, Nullable DateTime )
Регистрация документа с помощью варианта регистрации
Открытый методRegister(Document, Depository, DocumentFlowType, ReservedRegNumber, Nullable DateTime )
Регистрация документа по делу и документопотоку
Открытый методSave
Сохранить объект в БД
Открытый методUnArchive
Восстановить документ из архива
В начало страницы
Свойства

  ИмяОписание
Открытое свойствоTypeUid
Возвращает уникальный идентификатор объекта "Документ"
В начало страницы
Заметки

Раздел содержащий методы работы с документом
Примеры

Создадим документ, с которым будем работать. Документ будет лежать в папке, созданной тут

var myDocument = PublicAPI.Docflow.Types.File.Create(context.File, myFolder, "Новый документ для примера");
context.File - файл, который будет по умолчанию версией документа

После добавления версий документа и изменения их статусов, зарегистрируем документ

//загружаем регистрационный вариант, необходимый для регистрации документа 
var regVariant = PublicAPI.Docflow.Document.LoadRegVariant(1);
//регистрируем документ
PublicAPI.Docflow.Document.Register(myDocument, regVariant);
Функция регистрации будет работать только при настроенной номенклатуре и регистрацонном варианте

Добавим пользователю привелегию на редактирование документа

PublicAPI.Docflow.Document.AddEditPermission(myDocument, context.User);
context.User - пользователь, которому добавляется привелегия. Если пользователь уже имеют данную привелегию, функция ничего не добавит

Не забываем сохранить объект в базу для его корректной работы

Можно заархивировать документ и восстановать из архива документ

//архивируем документ
PublicAPI.Docflow.Document.Archive(myDocument);
//восстанавливаем документ из архива
PublicAPI.Docflow.Document.UnArchive(myDocument);

Добавим комментарий к документу

PublicAPI.Docflow.Document.AddComment(myDocument, "Документ был успешно восстановлен из архива");

Информацию по отправке документа на согласование, ознакомление и рассмотрение смотри тут

См. также