CardUIExtensions - класс

Методы-расширения для пространства имён Tessa.UI.Cards.

Definition

Пространство имён: Tessa.UI.Cards
Сборка: Tessa.UI (в Tessa.UI.dll) Версия: 4.0.4
C#
public static class CardUIExtensions
Inheritance
Object    CardUIExtensions

Методы

CreateAndInitializeModelAsync Создаёт и инициализирует модель представления карточки с заданными параметрами. Созданная модель представления защищается от изменений посредством вызова Seal перед тем, как будет возвращена. Сразу после этого её можно присвоить в свойстве CardModel.
CreateBlockAsync Создаёт модель представления блока для использования в автоматическом UI карточки по его метаинформации для заданных модели карточки и контейнера Unity.
CreateControlAsync Создаёт модель представления элемента управления для использования в автоматическом UI карточки по его метаинформации для заданных модели карточки, контейнера Unity и реестра типов элементов управления.
CreateFormAsync Создаёт модель представления формы для использования в автоматическом UI карточки с указанием модели карточки и контейнера Unity.
CreateMainFormAsync Создаёт модель представления основной формы карточки для использования в автоматическом UI карточки с указанием модели карточки и контейнера Unity.
GetCaptionVisibility(CardTypeBlock) Возвращает отображаемое состояние для заголовка блока, заданного по указанной метаинформации.
GetCaptionVisibility(CardTypeControl) Возвращает отображаемое состояние для заголовка элемента управления, заданного по указанной метаинформации.
GetControlSpan Возвращает отображаемое состояние для заголовка элемента управления, заданного по указанной метаинформации.
GetFunctionRolesForCompletionOption Метод определяет характерные для варианта завершения функциональные роли из доступных для CardTask в ICardModel.
GetFunctionRolesNamesWithDeputyInfoForCompletionOption Возвращает список отображаемых имён функциональных ролей с признаком замещения, относящихся к варианту завершения.
GetOrUpdateDigestAsync Возвращает Digest карточки или вычисляет его, если он неизвестен, т.е. свойство Digest равно null.
Has(CardModelFlags, CardModelFlags)Возвращает признак того, что заданный флаг установлен.
Has(FormCreationOptions, FormCreationOptions)Возвращает признак того, что заданный флаг установлен.
Has(StateRestoreMode, StateRestoreMode)Возвращает признак того, что заданный флаг установлен.
HasAny(CardModelFlags, CardModelFlags)Возвращает признак того, что один из заданных флагов установлен.
HasAny(FormCreationOptions, FormCreationOptions)Возвращает признак того, что один из заданных флагов установлен.
HasAny(StateRestoreMode, StateRestoreMode)Возвращает признак того, что один из заданных флагов установлен.
HasNot(CardModelFlags, CardModelFlags)Возвращает признак того, что заданный флаг не установлен.
HasNot(FormCreationOptions, FormCreationOptions)Возвращает признак того, что заданный флаг не установлен.
HasNot(StateRestoreMode, StateRestoreMode)Возвращает признак того, что заданный флаг не установлен.
InSpecialMode(CardModelFlags) Возвращает признак того, что в флагах модели представления карточки установлен хотя бы один флаг из перечисления SpecialCardModelFlags, и это означает, что карточка открыта в специальном режиме, в котором необходимо включить или отключить некоторые функции. Например, карточка открыта как просмотр удалённой карточки или редактируется карточка в шаблоне.
InSpecialMode(ICardModel) Возвращает признак того, что в модели представления карточки установлен хотя бы один флаг из перечисления SpecialCardModelFlags, и это означает, что карточка открыта в специальном режиме, в котором необходимо включить или отключить некоторые функции. Например, карточка открыта как просмотр удалённой карточки или карточка создана из шаблона.
InvalidateTileVisibility Сбрасывает кэш видимости плиток. Рекомендуется вызывать метод после изменения видимости плиток в карточке Card.
InvokeDialogClosingActionAsync Выполняет действие при закрытии окна Advanced диалога.
InvokeDialogClosingBeforeSavingActionAsync Выполнить событие при закрытии окна Advanced диалога перед его сохранением.
IsTopLevelForm Возвращает признак того, что форма является формой верхнего уровня карточки, т.е. это не форма дочерних элементов управления.
ModifyOnStateInitializedAsync Задает действие при инициализации состояния модели карточки, либо выполняет его немедленно, если состояние модели уже было инициализировано.
ModifyTasksAsync Изменяет модели представлений для тех заданий карточки, которые либо присутствуют в UI в текущий момент, либо являются скрытыми и могут быть восстановлены (например, заданий автора). Возвращает признак того, что хотя бы одно задание присутствовало в карточке, возможно, как скрытое.
ModifyTopicsAsync Изменяет модели представлений для тех топиков карточки, которые либо присутствуют в UI в текущий момент, либо добавятся позже, например, после отправки сообщения. Возвращает признак того, что хотя бы один топик присутствовал в карточке.
ModifyWorkspaceAsync Изменяет модель или UI задания с учётом каждого перехода между формами задания [!:TaskViewModel.Workspace].
PutNamedViewModels(IViewModelContainerIBlockViewModel, IEnumerableIBlockViewModel) Сохраняет в контейнере все именованные блоки из заданного списка. Если контейнер уже содержит блоки с совпадающими именами, то они будут перезаписаны.
PutNamedViewModels(IViewModelContainerIControlViewModel, IEnumerableIControlViewModel) Сохраняет в контейнере все именованные элементы управления из заданного списка. Если контейнер уже содержит элементы управления с совпадающими именами, то они будут перезаписаны.
RegisterCardsAndUI Выполняет регистрацию всех сервисов, типов и фабрик, необходимых для построения автоматического UI карточки.
RegisterCardUI Выполняет регистрацию всех типов и фабрик, необходимых для построения автоматического UI карточки.
RegisterCardUIExtensionTypes Выполняет регистрацию стандартных типов расширений для плиток.
RegisterCardUITraceListeners Выполняет регистрацию объектов, отслеживающих события, происходящие при выполнении расширений карточек в UI, и записывающие результат выполнения в ValidationResult как информационное сообщение. Это полезно при отладке расширений, но сильно нагружает любое взаимодействие с плитками, поэтому рекомендуется не выполнять такую регистрацию в среде, с которой работают конечные пользователи.
RemoveCardUITraceListeners Удаляет объекты, зарегистрированные методом RegisterCardUITraceListeners(IExtensionContainer, ExtensionTraceListenerType, NullableInt64). Частая регистрация с последующим удалением объектов значительно нагружает память и CPU.
RestoreCardAsync Выполняет асинхронное восстановление карточки по её удалённой карточке, причём удалённая карточка окончательно удаляется. В качестве текущей карточки заданный editor должен содержать удалённую карточку.
SelectAll Выделяет весь текст в контроле, если контрол поддерживает выделение текста посредством интерфейса ISupportSelectAll. Возвращает признак того, что текст действительно был выделен.
SelectAllWhenFocused Устанавливает, что для контрола будет выделен весь текст, если он получает фокус. Возвращает признак того, что тип контрола совместим с методом выделением текста. Метод можно вызывать несколько раз для одного и того же контрола.
SetActiveValidation Устанавливает значение свойства HasActiveValidation для текущей и всех дочерних моделей ICardModel. При изменении значения свойства все элементы управления в списке ControlBag обновляют своё значение HasActiveValidation.
SetCardCreationInfo Устанавливает информацию по созданию карточки в контексте IUIContext.
SetCardInTemplateType Устанавливает тип карточки в шаблоне для редактируемой карточки шаблона.
SetDialogClosingAction Устанавливает действие, выполняемое при закрытии окна Advanced диалога.
SetDialogClosingBeforeSavingAction Устанавливает действие, выполняемое при закрытии окна Advanced диалога перед его сохранением. Возникает, когда есть изменения в карточке, пользователю отобразился диалог с сохранением изменений и пользователь нажал сохранить.
SetPreviousPermissions Устанавливает исходные разрешения для редактируемой карточки, которые были изменены для текущего редактирования. Например, это разрешения карточки в шаблоне.
SetTaskHistoryVisible Показывает или скрывает вкладку с историей заданий, если она существовала при инициализации карточки (обычно это верно для всех типов карточек с флажком "Разрешить задания" AllowTasks).
SetTemplateCard Устанавливает исходную карточку шаблона для редактируемой карточки.
SetTemplateOriginalCardID Устанавливает идентификатор исходной карточки в шаблоне для редактируемой карточки.
SetTemplateSectionRows Устанавливает исходную карточку шаблона для редактируемой карточки.
SetupFrom Устанавливает информацию по стилю текста по значениям из сериализованных настроек. Возвращает признак того, что хотя бы одно свойство было изменено.
TileIsVisible Возвращает признак того, что плитка с заданным именем должен быть видимым на основании данных в карточке, т.е. видимости, которая рассчитана в запросе на создание или загрузку карточки. Этот метод использует кэш для получения информации. При изменении информации в карточке рекомендуется вызвать метод InvalidateTileVisibility(ICardModel).
ToLocalizedString Возвращает локализованную строку, представляющую значение перечисления CardPreviewMode.
ToTextAlignment Возвращает значение свойства по выравниванию текста в WPF TextAlignment по значению в метаинформации карточек CardTypeColumnAlignment.
TryGetCardCreationInfo Возвращает информацию по созданию карточки в контексте IUIContext или null, если такая информация не установлена.
TryGetCardInTemplateType Возвращает тип карточки в шаблоне для редактируемой карточки шаблона или null, если тип карточки в шаблоне не был установлен или были установлен как null.
TryGetCardModel Возвращает объект ICardModel для карточки, в рамках которой доступен элемент управления, или null, если элемент управления расположен не в карточке или значение не доступно. Значение доступно в методе Initialized(IFileControlExtensionContext), InitializedFinally(IFileControlExtensionContext). В методе OpeningMenu(IFileControlExtensionContext) используйте текущий контекст UIContext.Current.Editor?.CardModel.
TryGetPreviousPermissions Возвращает исходные разрешения для редактируемой карточки, которые были изменены для текущего редактирования, или null, если разрешения не были установлены или были установлены как null.
TryGetTaskHistory Возвращает модель представления для истории заданий, если в карточке присутствует вкладка "История заданий", или null в противном случае.
TryGetTaskItems Возвращает коллекцию моделей представления для заданий, по которым можно модифицировать UI или модель заданий, или null, если в карточке отсутствуют доступные задания.
TryGetTemplateCard Возвращает исходную карточку шаблона для редактируемой карточки или null, если исходная карточка не была установлена или была установлена как null.
TryGetTemplateOriginalCardID Возвращает идентификатор исходной карточки в шаблоне для редактируемой карточки или null, если идентификатор не был установлен или был установлен как null.
TryGetTemplateSectionRows Возвращает исходную карточку шаблона для редактируемой карточки или null, если исходная карточка не была установлена или была установлена как null.
ValidateAsync(ICardSchemeInfoProvider, IValidationResultBuilder, Guid, Object, String, CancellationToken) Выполняет проверку наличия таблицы с идентификатором tableID в схеме.
ValidateAsync(ISchemeService, IValidationResultBuilder, Guid, Object, String, CancellationToken) Выполняет проверку наличия таблицы с идентификатором tableID в схеме.
ValidateAsync(ICardSchemeInfoProvider, IValidationResultBuilder, Guid, Guid, Object, String, Boolean, CancellationToken) Выполняет проверку наличия колонки с идентификатором columnID в таблице с идентификатором tableID.
ValidateAsync(ISchemeService, IValidationResultBuilder, Guid, Guid, Object, String, Boolean, CancellationToken) Выполняет проверку наличия колонки с идентификатором columnID в таблице с идентификатором tableID.
WhenAnyDialog Регистрирует политику фильтрации выполнения методов расширений для любого диалога. Для карточек в основном окне расширения выполняться не будут.
WhenCardUIFunc Регистрирует политику фильтрации выполнения методов расширений ICardUIExtension в соответствии с функцией isAllowedFunc, которая проверяет контекст расширений. Если зарегистрировано несколько политик, то должны выполняться все из них.
WhenDefaultDialog Регистрирует политику фильтрации выполнения методов расширений для карточек в диалоге по умолчанию.
WhenDialog(IExtensionPolicyContainer, IReadOnlyCollectionString) Регистрирует политику фильтрации выполнения методов расширений по названию диалога, который входит в заданный список имен диалогов.
WhenDialog(IExtensionPolicyContainer, String) Регистрирует политику фильтрации выполнения методов расширений по названию диалога, который входит в заданный список имен диалогов.
WhenMySettingsFunc Регистрирует политику фильтрации выполнения методов расширений IMySettingsExtension в соответствии с функцией isAllowedFunc, которая проверяет контекст расширений. Если зарегистрировано несколько политик, то должны выполняться все из них.
WhenNoDialog Регистрирует политику фильтрации выполнения методов расширений только для карточек в основном окне. Для карточек в диалогах расширения выполняться не будут.
WhenNoDialogOrDefault Регистрирует политику фильтрации выполнения методов расширений для карточек в основном окне и в диалоге по умолчанию.
WithCardModelTypeFilter Регистрирует политику фильтрации выполнения методов расширений UI по типам карточек, указанных посредством политики ICardTypePolicy.

Поля

DialogClosingActionKey Ключ, по которому в Info, содержится действие, выполняемое при закрытии окна Advanced диалога. Тип значения: Func<IUIContext, CancelEventArgs, Task<bool>>.
DialogClosingBeforeSavingActionKey Ключ, по которому в Info, содержится действие, выполняемое при закрытии окна Advanced диалога перед его сохранением. Тип значения: Func<IUIContext, CancelEventArgs, Task<bool>>.

См. также