AddClosingQuote

Добавить закрывающую кавычку для имени.

Синтаксис

[Public]

public static string AddClosingQuote(string name, IOfficialDocument document)

Параметры

name – Имя;

document – Документ.

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

string – Результирующая строка.

AddClosingQuoteToSubject

Добавить закрывающую кавычку для содержания.

Синтаксис

[Public]

public static string AddClosingQuoteToSubject(string subject, IOfficialDocument document)

Параметры

subject – Содержание;

document – Документ.

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

string – Результирующая строка.

AddRelatedDocumentsToAttachmentGroup

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

Синтаксис

[Public]

public virtual void AddRelatedDocumentsToAttachmentGroup(Sungero.Workflow.Interfaces.IWorkflowEntityAttachmentGroup group)

Параметры

group – Группа вложения задачи.

CanChangeRequisitesOrCancelRegistration

Проверить возможность изменения реквизитов или отмены регистрации.

Только для регистрируемых журналов.

Синтаксис

[Public]

public virtual bool CanChangeRequisitesOrCancelRegistration()

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

bool – True, если операции можно выполнить.

CanDeleteVersion

Получить признак возможности удаления версии документа.

Синтаксис

[Public]

public virtual bool CanDeleteVersion(int? versionNumber)

Параметры

versionNumber – Номер версии.

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

bool – Признак возможности удаления версии документа.

CanHideVersion

Получить признак возможности скрытия версии документа.

Синтаксис

[Public]

public virtual bool CanHideVersion(int? versionNumber)

Параметры

versionNumber – Номер версии.

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

bool – Признак возможности скрытия версии документа.

CanSignLockedDocument

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

Синтаксис

public virtual bool CanSignLockedDocument()

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

bool – Признак возможности подписания документа при заблокированной карточке.

ChangeCounterpartyPropertyAccess

Сменить доступность поля Контрагент.

Перегрузки

 

ChangeCounterpartyPropertyAccess (bool isEnabled)

Сменить доступность поля Контрагент.

Синтаксис

public virtual void ChangeCounterpartyPropertyAccess(bool isEnabled)

Параметры

isEnabled – Признак доступности поля. TRUE - поле доступно.

ChangeCounterpartyPropertyAccess (bool isEnabled, bool counterpartyCodeInNumber)

Сменить доступность поля Контрагент.

Синтаксис

public virtual void ChangeCounterpartyPropertyAccess(bool isEnabled, bool counterpartyCodeInNumber)

Параметры

isEnabled – Признак доступности поля. TRUE - поле доступно;

counterpartyCodeInNumber – Признак вхождения кода контрагента в формат номера. TRUE - входит.

ChangeCounterpartyPropertyAccess (bool isEnabled, bool counterpartyCodeInNumber, bool enabledState)

Сменить доступность поля Контрагент. Доступность зависит от статуса.

Синтаксис

public virtual void ChangeCounterpartyPropertyAccess(bool isEnabled, bool counterpartyCodeInNumber, bool enabledState)

Параметры

isEnabled – Признак доступности поля. TRUE - поле доступно;

counterpartyCodeInNumber – Признак вхождения кода контрагента в формат номера. TRUE - входит;

enabledState – Признак доступности поля в зависимости от статуса.

ChangeDocumentPropertiesAccess

Сменить доступность реквизитов документа.

Синтаксис

public virtual void ChangeDocumentPropertiesAccess(bool isEnabled, bool repeatRegister)

Параметры

isEnabled – True, если свойства должны быть доступны;

repeatRegister – Перерегистрация.

ChangeOurSigningReasonVisibility

Изменить отображение основания подписания.

Синтаксис

public virtual void ChangeOurSigningReasonVisibility()

ChangeRegistrationPaneVisibility

Изменить отображение панели регистрации.

Синтаксис

public virtual void ChangeRegistrationPaneVisibility(bool needShow, bool repeatRegister)

Параметры

needShow – Признак отображения;

repeatRegister – Признак повторной регистрации\изменения реквизитов.

CheckDeleteEntityAccessRights

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

Синтаксис

[Public]

public bool CheckDeleteEntityAccessRights()

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

bool – True, если есть права, иначе - false.

CheckRegistrationNumberUnique

Проверять рег. номер на уникальность.

Синтаксис

public virtual bool CheckRegistrationNumberUnique()

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

bool – True - проверять, False - не проверять.

ClearBusinessUnit

Очистка НОР для ненумеруемых документов.

Синтаксис

public void ClearBusinessUnit(IDocumentKind documentKind)

Параметры

documentKind – Вид документа.

CopyProjects

Копировать список проектов из ведущего документа.

Синтаксис

[Public]

public static void CopyProjects(IOfficialDocument mainDocument, IOfficialDocument document)

Параметры

mainDocument – Ведущий документ;

document – Документ.

CreateParamsCache

Создать кеш параметров.

Синтаксис

[Public]

public virtual void CreateParamsCache()

DefaultRegistrationPaneVisibility

Поведение панели по умолчанию.

Синтаксис

public virtual bool DefaultRegistrationPaneVisibility()

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

bool – True, если панель должна быть отображена при создании документа.

DocumentAttachedInMainGroup

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

Только для задач, создаваемых пользователем вручную.

Синтаксис

[Public]

public virtual void DocumentAttachedInMainGroup(Sungero.Workflow.ITask task)

Параметры

task – Задача.

EnableRegistrationNumberAndDate

Сделать доступными рег. номер и рег. дату незарегистрированного документа регистрируемого вида в процессе верификации.

Синтаксис

public virtual void EnableRegistrationNumberAndDate()

EnableRequisitesForVerification

Разблокировать реквизиты для верификации после нумерации.

Синтаксис

[Public]

public virtual void EnableRequisitesForVerification()

FillCaseFileAndDeliveryMethod

Заполнить дело и способ доставки.

Синтаксис

[Public]

public static void FillCaseFileAndDeliveryMethod(IOfficialDocument document, IDocumentRegister documentRegister)

Параметры

document – Документ;

documentRegister – Журнал регистрации.

FillCounterpartySignatory

Заполнить подписывающего.

Синтаксис

[Public]

public virtual void FillCounterpartySignatory(Parties.IContact signatory)

Параметры

signatory – Подписывающий со стороны контрагента.

FillCounterpartySigningReason

Заполнить основание со стороны контрагента.

Синтаксис

[Public]

public virtual void FillCounterpartySigningReason(string signingReason)

Параметры

signingReason – Основание контрагента.

FillDocumentNamePropertyByGenerateSetting

Заполнить свойство, содержащее имя документа, в зависимости от настройки генерации имени.

Синтаксис

[Public]

public virtual void FillDocumentNamePropertyByGenerateSetting(string name)

Параметры

name – Имя документа.

FillLeadingDocument

Заполнить свойство "Ведущий документ" в зависимости от типа документа.

Используется при смене типа.

Синтаксис

[Public]

public virtual void FillLeadingDocument(IOfficialDocument leadingDocument)

Параметры

leadingDocument – Ведущий документ.

FillName

Заполнить имя документа.

Синтаксис

[Public]

public virtual void FillName()

FillOrganizationStructure

Заполнить оргструктуру.

Синтаксис

public void FillOrganizationStructure()

FillRequiredProperties

Заполнить обязательные свойства для документа.

Синтаксис

[Public]

public virtual void FillRequiredProperties(System.Collections.Generic.IDictionary<string, object> properties)

Параметры

properties – Свойства.

GetAddenda

Получить документы, связанные типом связи "Приложение".

Синтаксис

[Public]

public virtual List<IOfficialDocument> GetAddenda()

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

List<IOfficialDocument> – Документы, связанные типом связи "Приложение".

GetAddressees

Получить адресатов.

Синтаксис

[Public]

public virtual List<Company.IEmployee> GetAddressees()

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

List<Company.IEmployee> – Список адресатов.

GetCancelRegistrationDialogDescription

Получить описание для диалога отмены регистрации.

Синтаксис

public virtual string GetCancelRegistrationDialogDescription(Enumeration? settingType)

Параметры

settingType – Тип настройки.

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

string – Описание.

GetChangedTrackingRecordsWithTasksInProcess

Получить строки выдачи с задачами, которые необходимо выполнить.

Синтаксис

public static System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> GetChangedTrackingRecordsWithTasksInProcess(IOfficialDocument entity)

Параметры

entity – Документ.

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

System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> – Возвращенная выдача.

GetCounterparties

Получение контрагентов по документу.

Синтаксис

[Public]

public virtual List<Parties.ICounterparty> GetCounterparties()

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

List<Parties.ICounterparty> – Контрагенты.

GetCounterpartyCode

Получить код контрагента.

Синтаксис

[Public]

public virtual string GetCounterpartyCode()

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

string – Код контрагента либо пустая строка.

GetCounterpartySigningReason

Получить основание подписания со стороны контрагента.

Синтаксис

[Public]

public virtual string GetCounterpartySigningReason()

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

string – Основание подписания со стороны контрагента.

GetDeletedTrackingRecords

Получить удаленные строки выдачи.

Синтаксис

public static System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> GetDeletedTrackingRecords(IOfficialDocument entity)

Параметры

entity – Документ.

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

System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> – Удаленная выдача.

GetDocumentGroup

Получение группы документа.

Синтаксис

[Public]

public virtual IDocumentGroupBase GetDocumentGroup()

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

IDocumentGroupBase – Группа документа.

GetDocumentRegistersByDocument

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

Синтаксис

public static List<long> GetDocumentRegistersByDocument(IOfficialDocument document)

Параметры

document – Документ.

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

List<long> – Журналы по документу.

GetDocumentRegistersIdsByDocument

Получить ИД отфильтрованных журналов регистрации по документу.

Синтаксис

[Public]

public static List<long> GetDocumentRegistersIdsByDocument(IOfficialDocument document, Enumeration? settingType)

Параметры

document – Документ;

settingType – Тип регистрации.

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

List<long> – Журналы.

GetDocumentResponsibleEmployee

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

Синтаксис

[Public]

public virtual Sungero.Company.IEmployee GetDocumentResponsibleEmployee()

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

Sungero.Company.IEmployee – Пользователь, ответственный за документ.

GetEmailAddressees

Получить список адресатов с электронной почтой для отправки письма.

Синтаксис

[Public]

public virtual List<Structures.OfficialDocument.IEmailAddressee> GetEmailAddressees()

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

List<Structures.OfficialDocument.IEmailAddressee> – Список адресатов.

GetExtensionValidationError

Получить сообщение об ошибке для неподдерживаемых форматов.

Синтаксис

public virtual Sungero.Docflow.Structures.OfficialDocument.ConversionToPdfResult GetExtensionValidationError(string extension)

Параметры

extension – Расширение.

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

Sungero.Docflow.Structures.OfficialDocument.ConversionToPdfResult – Результат преобразования.

GetGeneratedDocumentName

Получить автоматически сформированное имя документа.

Синтаксис

[Public]

public virtual string GetGeneratedDocumentName()

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

string – Имя документа.

GetLeadDocumentId

Получить ИД ведущего документа.

Синтаксис

public virtual long GetLeadDocumentId()

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

long – ИД документа либо 0.

GetLeadDocumentNumber

Получить номер ведущего документа.

Синтаксис

public virtual string GetLeadDocumentNumber()

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

string – Номер документа либо пустая строка.

GetProject

Получить проект из документа.

Синтаксис

[Public]

public virtual IProjectBase GetProject()

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

IProjectBase – Проект, указанный в карточке документа.

GetRegistrationGroup

Получить группу регистрации.

Синтаксис

[Public]

public virtual Docflow.IRegistrationGroup GetRegistrationGroup()

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

Docflow.IRegistrationGroup – Список групп регистрации.

GetRegistrationOperation

Получить операцию истории "Регистрация".

Синтаксис

[PublicAttribute]

public static string GetRegistrationOperation()

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

string – Операция Регистрация.

GetSettingType

Получить тип настроек.

Синтаксис

public static Enumeration? GetSettingType(IOfficialDocument document)

Параметры

document – Документ.

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

Enumeration? – Тип настроек.

GetShowOurSigningReasonParam

Получить значение параметра, отвечающего за показ/скрытие основания подписания документа.

Синтаксис

public virtual bool GetShowOurSigningReasonParam()

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

bool – True - если нужно показать основание подписания документа.

GetTrackingRecordsWithDeadlineChanged

Получить строки выдачи с измененным сроком возврата.

Синтаксис

public static System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> GetTrackingRecordsWithDeadlineChanged(IOfficialDocument entity)

Параметры

entity – Документ.

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

System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> – Выдача с измененным сроком.

GetTrackingRecordsWithEmployeeChanged

Получить строки выдачи с измененным сотрудником.

Синтаксис

public static System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> GetTrackingRecordsWithEmployeeChanged(IOfficialDocument entity)

Параметры

entity – Документ.

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

System.Collections.Generic.IEnumerable<IOfficialDocumentTracking> – Выдача с измененным сотрудником.

HasDocumentRegistersByDocument

Имеются ли подходящие журналы регистрации по документу.

Синтаксис

[Public]

public virtual bool HasDocumentRegistersByDocument(Enumeration? settingType)

Параметры

settingType – Тип регистрации.

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

bool – True - если есть подходящие журналы.

HasEmptyRequiredProperties

Проверка, заполнены ли обязательные и псевдообязательные свойства.

Синтаксис

[Public]

public virtual bool HasEmptyRequiredProperties()

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

bool – True - если обязательные и псевдообязательные свойства не заполнены, иначе - false.

IsLifeCycleMustBeActive

Проверка необходимости установки статуса Действующий для документопотока.

Синтаксис

public static bool IsLifeCycleMustBeActive(Enumeration? direction, Enumeration? approvalState, Enumeration? counterpartyApprovalState)

Параметры

direction – Документопоток;

approvalState – Статус согласования;

counterpartyApprovalState – Статус согласования с контрагентом.

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

bool – Признак необходимости смены ЖЦ документа на действующий.

IsNumerationSucceed

Определить, пронумерован ли документ.

Если документ зарегистрирован, а не пронумерован, то вернет false.

Синтаксис

[Public]

public virtual bool IsNumerationSucceed()

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

bool – True - документ успешно пронумерован, False - иначе.

IsObsolete

Проверяет, является ли документ недействующим.

Перегрузки

 

IsObsolete ()

Проверяет, является ли документ недействующим.

Синтаксис

[Public]

public virtual bool IsObsolete()

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

bool – Признак того, является ли документ недействующим.

IsObsolete (Enumeration? lifeCycleState)

Проверяет, является ли документ недействующим.

Синтаксис

public virtual bool IsObsolete(Enumeration? lifeCycleState)

Параметры

lifeCycleState – Статус ЖЦ.

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

bool – Признак того, является ли документ недействующим.

IsProjectDocument

Проверка на то, что документ является проектным.

Синтаксис

[Public]

public virtual bool IsProjectDocument(List<long> leadingDocumentIds)

Параметры

leadingDocumentIds – ИД ведущих документов.

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

bool – True - если документ проектный, иначе - false.

IsVerificationModeSupported

Проверка, поддерживается ли режим верификации для документа.

Синтаксис

[Public]

public virtual bool IsVerificationModeSupported()

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

bool – True - если поддерживается, иначе - false.

NeedClearProject

Признак необходимости очистки поля Проект.

Синтаксис

public virtual bool NeedClearProject(Sungero.Docflow.Shared.OfficialDocumentDocumentKindChangedEventArgs e)

Параметры

e – Аргументы смены вида документа.

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

bool – True - нужно очистить, false - не нужно.

NeedCounterpartySign

Проверить требование подписи контрагента.

Для основного документа возвращается переданное в метод значение. Для приложения дополнительно проверяется:

не требуется подпись для счет-фактур и исх. счетов. Исключение СБИС - подпись на счет-фактуру требуется.

Синтаксис

[Public]

public virtual bool NeedCounterpartySign(ExchangeCore.IBusinessUnitBox senderBox, bool isPrimaryDocument, bool needSign)

Параметры

senderBox – Абонентский ящик отправителя;

isPrimaryDocument – Признак, что документ основной;

needSign – Признак Требуется подписание.

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

bool – True - требуется подписание, иначе - false.

NeedDisableBusinessUnit

Определить необходимость защиты от редактирования НОР.

Синтаксис

[Public]

public virtual bool NeedDisableBusinessUnit()

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

bool – True - нужно. False - не нужно.

NeedDisableDepartment

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

Синтаксис

[Public]

public virtual bool NeedDisableDepartment()

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

bool – True - нужно. False - не нужно.

NeedDisableLeadingDocument

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

Синтаксис

[Public]

public virtual bool NeedDisableLeadingDocument()

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

bool – True - нужно. False - иначе.

NeedDisablePropertyByRegistration

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

Синтаксис

[Public]

public virtual bool? NeedDisablePropertyByRegistration()

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

bool? – True - нужно. False - иначе. Null - невозможно окончательно определить.

NeedShowRegistrationPane

Признак необходимости отображения панели регистрации.

Синтаксис

public virtual bool NeedShowRegistrationPane(bool additionalCondition)

Параметры

additionalCondition – Дополнительное условие при наследовании.

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

bool – True, если надо показать панель.

RefreshDocumentForm

Обновить карточку документа.

Синтаксис

public virtual void RefreshDocumentForm()

RegisterDocument

Зарегистрировать документ.

Синтаксис

[Public]

public static void RegisterDocument(IOfficialDocument document, IDocumentRegister documentRegister, DateTime? registrationDate, string registrationNumber, bool? numberReservation, bool needSaveDocument)

Параметры

document – Документ;

documentRegister – Журнал;

registrationDate – Дата;

registrationNumber – Номер регистрации;

numberReservation – Признак резервирования;

needSaveDocument – Признак необходимости сохранения документа.

RemoveRelatedDocumentsFromAttachmentGroup

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

Синтаксис

[Public]

public virtual void RemoveRelatedDocumentsFromAttachmentGroup(Sungero.Workflow.Interfaces.IWorkflowEntityAttachmentGroup group)

Параметры

group – Группа вложения задачи.

SetLifeCycleState

Изменение состояния документа для ненумеруемых документов.

Синтаксис

public virtual void SetLifeCycleState()

SetObsolete

Сменить тип документа на недействующий.

Синтаксис

[Public]

public virtual void SetObsolete(bool isActive)

Параметры

isActive – True, если документ действующий.

SetRequiredProperties

Установить обязательность свойств в зависимости от заполненных данных.

Синтаксис

public virtual void SetRequiredProperties()

UpdateLifeCycle

Обновить жизненный цикл документа.

Синтаксис

public virtual void UpdateLifeCycle(Enumeration? registrationState, Enumeration? approvalState, Enumeration? counterpartyApprovalState)

Параметры

registrationState – Статус регистрации;

approvalState – Статус согласования;

counterpartyApprovalState – Статус согласования с контрагентом.

© Компания Directum, 2024