|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > Docflow – документооборот > Иерархия документов > OfficialDocument – официальный документ Клиентские функции типа сущности OfficialDocument |
|
|
<< Click to Display Table of Contents >> Объектная модель > Базовое решение Directum RX > Docflow – документооборот > Иерархия документов > OfficialDocument – официальный документ Клиентские функции типа сущности OfficialDocument |
|
Имя функции |
Модификатор |
Атрибут |
Описание |
virtual |
– |
Добавить область выделения в предпросмотре |
|
– |
– |
Присвоить номер |
|
virtual |
– |
Дополнительное условие доступности действия "Сменить тип" |
|
– |
[Public] |
Проверить возможность выполнения действия отправки |
|
virtual |
[Public] |
Сменить тип документа |
|
virtual |
[Public] |
Проверить, что версии не заблокированы |
|
virtual |
[Public] |
Проверить, что версии имеют корректное расширение для сравнения |
|
virtual |
[Public] |
Проверить, что версии не нулевого размера |
|
static |
[Public] |
Выбрать главный документ |
|
virtual |
[Public] |
Отобразить диалог создания поручений по документу |
|
virtual |
– |
Создание письма с вложенными документами |
|
static |
– |
Получение информации о блокировке последней версии документа |
|
static |
– |
Проверить информацию о блокировках тела и карточки документа |
|
virtual |
– |
Получить параметры отображения фокусировки подсветки |
|
virtual |
– |
Получить список распознанных свойств документа |
|
virtual |
– |
Получить связанные документы, имеющие версии |
|
static |
[Public] |
Получение списка документов, к которым применимо действие |
|
virtual |
[Public] |
Получить список поддерживаемых расширений для сравнения документов |
|
virtual |
– |
Получить текст для отметки документа устаревшим |
|
virtual |
– |
Получить список типов документов, доступных для смены типа |
|
virtual |
[Public] |
Получить наименования версий документа для сравнения |
|
– |
– |
Проверить наличие блокировок последних версий документов |
|
virtual |
– |
Подсветить записи свойства-коллекции в карточке документа и факты в предпросмотре |
|
HighlightFactInPreview + перегрузки |
virtual |
– |
Подсветить факт в предпросмотре |
virtual |
– |
Пометить документ как устаревший |
|
– |
[Public] |
Если по документу уже были запущены задачи на согласование по регламенту,то с помощью диалога определить, нужно ли создавать ещё одну |
|
– |
[Public] |
Если по документу уже были запущены задачи на рассмотрение,то с помощью диалога определить, нужно ли создавать ещё одну |
|
virtual |
– |
Определить необходимость подсветки свойств в карточке и фактов |
|
static |
[Public] |
Определить, нужно ли добавлять документ во вложения задачи |
|
virtual |
[Public] |
Показывать сводку по документу в заданиях на согласование и подписание |
|
– |
– |
Зарегистрировать документ |
|
– |
– |
Зарегистрировать документ с зарезервированным номером |
|
– |
– |
Зарезервировать номер |
|
RunComparison + перегрузки |
virtual |
– |
Запустить сравнение документов |
static |
– |
Вызвать диалог регистрации |
|
virtual |
– |
Выбор связанных документов для отправки и создания письма |
|
virtual |
– |
Дополнительная подсветка |
|
virtual |
– |
Управление подсветкой |
|
virtual |
– |
Подсветить указанные свойства в карточке документа и факты в теле |
|
virtual |
– |
Показать диалог сравнения документов |
|
virtual |
– |
Показать диалог сравнения версий документа |
|
virtual |
– |
Показать диалог создания соглашения об аннулировании с указанием причины и подписанта |
|
virtual |
[Public] |
Включить режим верификации |
|
static |
– |
Получить цвет по коду |
Добавить область выделения в предпросмотре.
Синтаксис
public virtual Sungero.Domain.Shared.IPreviewHighlight AddHighlightArea(Sungero.Domain.Shared.IPreviewControlState previewControl, string position, Sungero.Core.Color color, IHighlightActivationStyle highlightActivationStyle)
Параметры
previewControl – Контрол предпросмотра;
position – Позиции;
color – Цвет;
highlightActivationStyle – Параметры отображения фокусировки подсветки.
Возвращаемое значение
Sungero.Domain.Shared.IPreviewHighlight – Область выделения в предпросмотре.
Присвоить номер.
Синтаксис
public void AssignNumber(Sungero.Domain.Client.ExecuteActionArgs e)
Параметры
e – Аргумент действия.
Дополнительное условие доступности действия "Сменить тип".
Синтаксис
public virtual bool CanChangeDocumentType()
Возвращаемое значение
bool – True - если действие "Сменить тип" доступно, иначе - false.
Проверить возможность выполнения действия отправки.
Синтаксис
[Public]
public bool CanExecuteSendAction(Domain.Shared.IActionInfo actionInfo)
Параметры
actionInfo – Действие.
Возвращаемое значение
bool – Признак доступности действия.
Сменить тип документа.
Синтаксис
[Public]
public virtual Sungero.Docflow.IOfficialDocument ChangeDocumentType(List<Domain.Shared.IEntityInfo> types)
Параметры
types – Типы документов, на которые можно сменить.
Возвращаемое значение
Sungero.Docflow.IOfficialDocument – Сконвертированный документ.
Проверить, что версии не заблокированы.
Синтаксис
[Public]
public virtual string CheckIfVersionsAreLocked(IElectronicDocumentVersions versionToCompare, IElectronicDocumentVersions etalonVersion)
Параметры
versionToCompare – Сравниваемая версия;
etalonVersion – Эталон.
Возвращаемое значение
string – Текст ошибки или null, если ошибок нет.
Проверить, что версии имеют корректное расширение для сравнения.
Синтаксис
[Public]
public virtual string CheckVersionsExtension(IElectronicDocumentVersions versionToCompare, IElectronicDocumentVersions etalonVersion)
Параметры
versionToCompare – Сравниваемая версия;
etalonVersion – Эталон.
Возвращаемое значение
string – Текст ошибки или null, если ошибок нет.
Проверить, что версии не нулевого размера.
Синтаксис
[Public]
public virtual string CheckVersionsMinSize(IElectronicDocumentVersions versionToCompare, IElectronicDocumentVersions etalonVersion)
Параметры
versionToCompare – Сравниваемая версия;
etalonVersion – Эталон.
Возвращаемое значение
string – Текст ошибки или null, если ошибок нет.
Выбрать главный документ.
Синтаксис
[Public]
public static Sungero.Domain.Shared.IEntity ChooseMainDocument(List<Content.IElectronicDocument> documents, List<Content.IElectronicDocument> probablyMainDocuments)
Параметры
documents – Документы;
probablyMainDocuments – Документы, которые вероятнее всего могут оказаться главными.
Возвращаемое значение
Sungero.Domain.Shared.IEntity – Документ.
CreateActionItemsFromDocumentDialog
Отобразить диалог создания поручений по документу.
Синтаксис
[Public]
public virtual void CreateActionItemsFromDocumentDialog(Sungero.Core.IValidationArgs e)
Параметры
e – Аргументы действия, чтобы показывать ошибки валидации.
Создание письма с вложенными документами.
Синтаксис
public virtual void CreateEmail(string email, List<IOfficialDocument> attachments)
Параметры
email – Почта для отправки письма;
attachments – Список вложений.
GetDocumentLastVersionLockInfo
Получение информации о блокировке последней версии документа.
Синтаксис
public static Domain.Shared.LockInfo GetDocumentLastVersionLockInfo(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
Domain.Shared.LockInfo – Информация о блокировке.
Проверить информацию о блокировках тела и карточки документа.
Синтаксис
public static Domain.Shared.LockInfo GetDocumentLockInfo(IOfficialDocument document)
Параметры
document – Документ.
Возвращаемое значение
Domain.Shared.LockInfo – Информация о блокировке.
Получить параметры отображения фокусировки подсветки.
Синтаксис
public virtual IHighlightActivationStyle GetHighlightActivationStyle()
Возвращаемое значение
IHighlightActivationStyle – Параметры.
Получить список распознанных свойств документа.
Синтаксис
public virtual List<RecognizedProperty> GetRecognizedProperties(IEntityRecognitionInfo documentRecognitionInfo)
Параметры
documentRecognitionInfo – Результат распознавания документа.
Возвращаемое значение
List<RecognizedProperty> – Список распознанных свойств документа.
GetRelatedDocumentsWithVersions
Получить связанные документы, имеющие версии.
Синтаксис
public virtual List<IOfficialDocument> GetRelatedDocumentsWithVersions()
Возвращаемое значение
List<IOfficialDocument> – Список связанных документов.
Получение списка документов, к которым применимо действие.
Синтаксис
[Public]
public static List<Content.IElectronicDocument> GetSuitableDocuments(List<Content.IElectronicDocument> documents, Domain.Shared.IActionInfo currentAction)
Параметры
documents – Все вложения;
currentAction – Выбранное действие.
Возвращаемое значение
List<Content.IElectronicDocument> – Список документов, к которым применимо действие.
GetSupportedExtensionsForDocumentComparison
Получить список поддерживаемых расширений для сравнения документов.
Включает все расширения, которые обрабатываются в Aspose и Ario, кроме таблиц.
Синтаксис
[Public]
public virtual List<string> GetSupportedExtensionsForDocumentComparison()
Возвращаемое значение
List<string> – Список поддерживаемых расширений.
GetTextToMarkDocumentAsObsolete
Получить текст для отметки документа устаревшим.
Синтаксис
public virtual string GetTextToMarkDocumentAsObsolete()
Возвращаемое значение
string – Текст для диалога прекращения согласования.
Получить список типов документов, доступных для смены типа.
Синтаксис
public virtual List<Domain.Shared.IEntityInfo> GetTypesAvailableForChange()
Возвращаемое значение
List<Domain.Shared.IEntityInfo> – Список типов документов, доступных для смены типа.
Получить наименования версий документа для сравнения.
Синтаксис
[Public]
public virtual List<string> GetVersionNamesForCompare(IElectronicDocument document)
Параметры
document – Документ.
Возвращаемое значение
List<string> – Список наименований версий в формате {Номер версии}. {Примечание} ({Расширение}).
Проверить наличие блокировок последних версий документов.
Синтаксис
public bool HaveLastVersionLocks(List<IOfficialDocument> documents)
Параметры
documents – Документы.
Возвращаемое значение
bool – Если заблокированы - True, свободны - False.
Подсветить записи свойства-коллекции в карточке документа и факты в предпросмотре.
Синтаксис
public virtual void HighlightCollection(Sungero.Domain.Shared.IPreviewControlState previewControl, IEntityRecognitionInfo documentRecognitionInfo, Sungero.Domain.Shared.IChildEntityCollection<Sungero.Domain.Shared.IChildEntity> collection, IHighlightActivationStyle highlightActivationStyle)
Параметры
previewControl – Контрол предпросмотра;
documentRecognitionInfo – Результат распознавания документа;
collection – Коллекция;
highlightActivationStyle – Параметры отображения фокусировки подсветки.
Подсветить факт в предпросмотре.
Перегрузки
Имя функции |
Описание |
Подсветить факт в предпросмотре |
|
Подсветить факт в предпросмотре с фокусировкой по нажатию на свойство в табличной части |
|
Подсветить факт в предпросмотре с фокусировкой по нажатию на свойство |
HighlightFactInPreview (Sungero.Domain.Shared.IPreviewControlState previewControl, string position, Sungero.Core.Color color)
Подсветить факт в предпросмотре.
Синтаксис
public virtual void HighlightFactInPreview(Sungero.Domain.Shared.IPreviewControlState previewControl, string position, Sungero.Core.Color color)
Параметры
previewControl – Контрол предпросмотра;
position – Позиция;
color – Цвет.
HighlightFactInPreview (Sungero.Domain.Shared.IPreviewControlState previewControl, string position, Sungero.Core.Color color, Sungero.Domain.Shared.IChildEntity childEntity, Sungero.Domain.Shared.IPropertyInfo childPropertyInfo, IHighlightActivationStyle highlightActivationStyle)
Подсветить факт в предпросмотре с фокусировкой по нажатию на свойство в табличной части.
Синтаксис
public virtual void HighlightFactInPreview(Sungero.Domain.Shared.IPreviewControlState previewControl, string position, Sungero.Core.Color color, Sungero.Domain.Shared.IChildEntity childEntity, Sungero.Domain.Shared.IPropertyInfo childPropertyInfo, IHighlightActivationStyle highlightActivationStyle)
Параметры
previewControl – Контрол предпросмотра;
position – Позиция;
color – Цвет;
childEntity – Свойство-коллекция;
childPropertyInfo – Информация о свойстве в коллекции;
highlightActivationStyle – Параметры отображения фокусировки подсветки.
HighlightFactInPreview (Sungero.Domain.Shared.IPreviewControlState previewControl, string position, Sungero.Core.Color color, Sungero.Domain.Shared.IPropertyInfo propertyInfo, IHighlightActivationStyle highlightActivationStyle)
Подсветить факт в предпросмотре с фокусировкой по нажатию на свойство.
Синтаксис
public virtual void HighlightFactInPreview(Sungero.Domain.Shared.IPreviewControlState previewControl, string position, Sungero.Core.Color color, Sungero.Domain.Shared.IPropertyInfo propertyInfo, IHighlightActivationStyle highlightActivationStyle)
Параметры
previewControl – Контрол предпросмотра;
position – Позиция;
color – Цвет;
propertyInfo – Информация о свойстве;
highlightActivationStyle – Параметры отображения фокусировки подсветки.
Пометить документ как устаревший.
Используется для отметки документа устаревшим в диалоге запроса причины прекращения задачи согласования.
Синтаксис
public virtual bool MarkDocumentAsObsolete()
Возвращаемое значение
bool – True, если документ надо пометить как устаревший, иначе False.
Если по документу уже были запущены задачи на согласование по регламенту,то с помощью диалога определить, нужно ли создавать ещё одну.
Синтаксис
[Public]
public bool NeedCreateApprovalTask()
Возвращаемое значение
bool – True, если нужно создать еще одну задачу на согласование. Иначе false.
Если по документу уже были запущены задачи на рассмотрение,то с помощью диалога определить, нужно ли создавать ещё одну.
Синтаксис
[Public]
public bool NeedCreateReviewTask()
Возвращаемое значение
bool – True, если нужно создать еще одну задачу на рассмотрение. Иначе false.
NeedHighlightPropertiesAndFacts
Определить необходимость подсветки свойств в карточке и фактов.
Синтаксис
public virtual bool NeedHighlightPropertiesAndFacts()
Возвращаемое значение
bool – Признак необходимости подсветки.
Определить, нужно ли добавлять документ во вложения задачи.
Синтаксис
[Public]
public static bool NeedToAttachDocument(Content.IElectronicDocument attachment, Docflow.IOfficialDocument mainOfficialDocument)
Параметры
attachment – Вложения;
mainOfficialDocument – Выбранный главный документ.
Возвращаемое значение
bool – True, если нужно.
Показывать сводку по документу в заданиях на согласование и подписание.
Синтаксис
[Public]
public virtual bool NeedViewDocumentSummary()
Возвращаемое значение
bool – True, если в заданиях нужно показывать сводку по документу.
Зарегистрировать документ.
Синтаксис
public void Register(Sungero.Domain.Client.ExecuteActionArgs e)
Параметры
e – Аргумент действия.
Зарегистрировать документ с зарезервированным номером.
Синтаксис
public void RegisterWithReservedNumber(Sungero.Domain.Client.ExecuteActionArgs e)
Параметры
e – Аргумент действия.
Зарезервировать номер.
Синтаксис
public void ReserveNumber(Sungero.Domain.Client.ExecuteActionArgs e)
Параметры
e – Аргумент действия.
Запустить сравнение документов.
Перегрузки
Имя функции |
Описание |
Запустить сравнение документов |
|
Запустить сравнение версий |
RunComparison (IElectronicDocumentVersions versionToCompare, IElectronicDocument etalonDocument, IElectronicDocumentVersions etalonVersion)
Запустить сравнение документов.
Синтаксис
public virtual void RunComparison(IElectronicDocumentVersions versionToCompare, IElectronicDocument etalonDocument, IElectronicDocumentVersions etalonVersion)
Параметры
versionToCompare – Сравниваемая версия;
etalonDocument – Эталонный документ;
etalonVersion – Эталонная версия.
RunComparison (IElectronicDocumentVersions versionToCompare, IElectronicDocumentVersions etalonVersion)
Запустить сравнение версий.
Синтаксис
public virtual void RunComparison(IElectronicDocumentVersions versionToCompare, IElectronicDocumentVersions etalonVersion)
Параметры
versionToCompare – Сравниваемая версия;
etalonVersion – Эталонная версия.
Вызвать диалог регистрации.
Синтаксис
public static DialogResult RunRegistrationDialog(IOfficialDocument document, IDialogParamsLite dialogParams)
Параметры
document – Документ;
dialogParams – Параметры диалога.
Возвращаемое значение
DialogResult – Результаты диалога регистрации.
SelectRelatedDocumentsAndCreateEmail
Выбор связанных документов для отправки и создания письма.
Синтаксис
public virtual void SelectRelatedDocumentsAndCreateEmail(List<IOfficialDocument> relatedDocuments)
Параметры
relatedDocuments – Связанные документы.
Дополнительная подсветка.
Синтаксис
public virtual void SetAdditionalHighlight(IEntityRecognitionInfo documentRecognitionInfo, IHighlightActivationStyle highlightActivationStyle)
Параметры
documentRecognitionInfo – Результат распознавания документа;
highlightActivationStyle – Параметры отображения фокусировки подсветки.
Управление подсветкой.
Синтаксис
public virtual void SetHighlight()
SetHighlightPropertiesAndFacts
Подсветить указанные свойства в карточке документа и факты в теле.
Синтаксис
public virtual void SetHighlightPropertiesAndFacts(IHighlightActivationStyle highlightActivationStyle)
Параметры
highlightActivationStyle – Параметры отображения фокусировки подсветки.
Показать диалог сравнения документов.
Синтаксис
public virtual void ShowCompareDocumentsDialog()
Показать диалог сравнения версий документа.
Синтаксис
public virtual void ShowCompareVersionsDialog()
ShowCreateCancellationAgreementDialog
Показать диалог создания соглашения об аннулировании с указанием причины и подписанта.
Синтаксис
public virtual void ShowCreateCancellationAgreementDialog()
Включить режим верификации.
Синтаксис
[Public]
public virtual void SwitchVerificationMode()
Получить цвет по коду.
Синтаксис
public static Sungero.Core.Color TryParseColorCode(string colorCode)
Параметры
colorCode – Код цвета.
Возвращаемое значение
Sungero.Core.Color – Цвет.
| © Компания Directum, 2024 |