ICardModel - интерфейс

Модель карточки, доступная в UI.

Definition

Пространство имён: Tessa.UI.Cards
Сборка: Tessa.UI (в Tessa.UI.dll) Версия: 4.0.4
C#
public interface ICardModel : IFilePreviewInfoCacheProvider, 
	IHtmlSanitizerProvider, INotifyPropertyChanged, IPreviewHandlersPoolProvider, IPreviewPageExtractorProvider, ISealable, 
	IUIContextExecutorProvider
Implements
INotifyPropertyChanged, ISealable, IPreviewHandlersPoolProvider, IFilePreviewInfoCacheProvider, IHtmlSanitizerProvider, IPreviewPageExtractorProvider, IUIContextExecutorProvider

Свойства

Binder Вспомогательный класс, используемый для выполнения действий с карточкой, требующих наличие метаинформации.
BlockBag Объект, содержащий неупорядоченный список всех блоков в карточке. При этом блоки карточки, её заданий и файлов размещаются в одном и том же объекте.
BlockInitializers Список делегатов, выполняемых после инициализации каждого из блоков (моделей представления IBlockViewModel).
Blocks Контейнер для блоков, доступных по имени.
Card Информация о карточке.
CardCache Кэш с карточками и дополнительными настройками.
CardMetadata Метаинформация по типу карточки, которая описывается моделью, и связь между идентификаторами и именами секций и полей.
CardTask Информация о задании, если модель соответствует карточке задания, или null в противном случае.
CardType Ссылка на метаинформацию по типу карточки.
ClosingRequest Последний запрос на сохранение карточки перед закрытием области с редактируемой карточкой, доступный только в расширениях на закрытие, или null, если сохранение ещё ни разу не выполнялось или проверяющий свойство код выполняется вне расширений на закрытие карточки. При установке значения свойства очистку этого значения должен выполнять тот же код, т.к. автоматического изменения значения не производится.
ContextIsInitialized Признак того, что была выполнена инициализация контекста IUIContext, связанная с текущей моделью карточки ICardModel.
ControlBag Объект, содержащий неупорядоченный список всех элементов управления в карточке. При этом элементы управления карточки, её заданий и файлов размещаются в одном и том же объекте.
ControlCreationOverrides Список делегатов для переопределения создания контрола. Если один из делегатов вернёт не null, то создания контрола стандартным способом не произойдёт и будет использован возвращённый контрол.
ControlInitializers Список делегатов, выполняемых после инициализации каждого из элементов управления.
Controls Контейнер для элементов управления, доступных по имени.
CurrentRow Модель редактируемой строки, которая была открыта непосредственно из текущей модели (без учёта вложенных дочерних секций), или null, если в данный момент отсутствуют редактируемые строки.
Digest

Digest текущей карточки или null, если Digest неизвестен. Значение свойства может быть неактуальным, т.к. по умолчанию Digest может обновляться при обращении к сервису стандартными средствами.

Для изменения свойства используйте метод SetDigestAsync(String, CancellationToken), при этом вызывается событие PropertyChanged.

EntryModel Модель представления карточки, используемая для редактирования строковых секций. Это текущий объект, если он не используется для редактирования строки коллекционной или древовидной секции.
FileContainer Контейнер с файлами карточки.
FileControlManager Объект, управляющий областями предпросмотра файлов для всей карточки, т.е. для всех её вкладок.
FilePreviewManager Объект, управляющий доступностью предпросмотра.
Flags Флаги, описывающие особенности отображения карточки в UI.
FormBag Объект, содержащий неупорядоченный список всех форм в карточке.
FormInitializers Список делегатов, выполняемых после инициализации каждого из форм (моделей представления IFormWithTabsViewModel).
Forms Формы, соответствующие вкладкам карточки.
FunctionRoles Функциональные роли для задания, которые доступны текущей сессии, если модель соответствует карточке задания, или null в противном случае.
GeneralMetadata Общая метаинформация по всем типам карточек.
HasActiveValidation Признак того, что во всех элементах управления следует включить активную валидацию. При этом элементы управления, для которых введены некорректные значения, будут уведомлять об этом рамкой валидации. Значение устанавливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false.
Info Информация для расширений UI, связанная с моделью карточки, но отсутствующая в самой карточке. Сохраняемая информация может быть несериализуемой, например, можно записать ссылки на модели представлений или любые другие объекты.
IsClosed Признак того, что все формы карточки Forms были закрыты.
IsHtmlSanitizingEnabled Признак того, что санитайзинг HTML-документов разрешено выполнять.
IsSealedПризнак того, что объект был защищён от изменений.
(Унаследован от ISealable)
LastRequest Последний запрос на сохранение карточки или null, если сохранение ещё ни разу не выполнялось.
MainForm Отображаемая форма карточки или текущая отображаемая форма задания.
MainFormWithBlocks Основная форма карточки, содержащая блоки IBlockViewModel, или null, если форма карточки не реализует интерфейс IFormWithBlocksViewModel.
MainFormWithTabs Основная форма карточки, содержащая вкладки FormViewModelCollection, или null, если форма карточки не реализует интерфейс IFormWithTabsViewModel.
MenuContext Контекст, предоставляющий средства для генерации меню.
Notifications Объект, управляющий отображением всплывающих уведомлений.
PageOptions Настройки отображения области предпросмотра документа, разделённого на страницы. Значение не равно null.
(Унаследован от IPreviewPageExtractorProvider)
ParentModel Родительская модель представления карточки или null, если родительская модель отсутствует. По умолчанию значение отлично от null только для моделей представления, созданных для карточек заданий.
SectionRows Пустые строки для коллекционных или древовидных секций карточки, доступные по имени секции.
Settings Настройки модели представления карточки.
StateIsInitialized Признак того, что состояние карточки уже было инициализировано, поэтому оно не будет перенесено автоматически из предыдущей открытой карточки в той же вкладке.
Table Информация о строке коллекционной или древовидной секции карточки, редактирование которой выполняется в отдельной форме, или null, если редактируется основная карточка.
TableStack Стек с информацией о строках коллекционных или древовидных секций карточки, редактирование которых выполняется в отдельной форме. По нулевому индексу доступна текущая редактируемая строка, по первому - её родительская строка и т.д. Если коллекция пуста, то редактирование строк не выполняется, т.е. редактируются строковые секции карточки.
TaskInitializers Список делегатов, выполняемых после создания модели карточки каждого из заданий.
UIContextExecutorAsync Делегат, выполняющий заданное действие в контексте [Tessa.UI.IUIContext].
(Унаследован от IUIContextExecutorProvider)

Методы

CancelFileDownloading Отменяет все асинхронные операции по скачиванию содержимого файлов. Обычно вызывается перед сохранением или обновлением карточки.
CloseAsync Вызывает принудительное закрытие форм карточки Forms. Не выполняет действий, если формы уже были закрыты.
CommitChangesAsync Подтверждает изменения для всех элементов управления, добавленных в ControlBag. Метод обычно вызывается перед сохранением карточки для того, чтобы элементы управления, у которых состояние ввода зависит от фокуса и других параметров, могли подтвердить введённое значение перед тем, как карточка будет сохранена. Метод возвращает результат выполнения для всех элементов управления. Если при выполнении методов у элементов управления возникли исключения, то они будут зафиксированы в результате.
CreateEmptyRow Создаёт пустую строку для коллекционной или древовидной секции с заданным именем. Такая строка может использоваться для редактирования секции.
CreateForRow Создаёт копию модели карточки для редактирования заданной строки коллекционной или древовидной секции.
ExecuteInContextAsync Выполняет делегат в текущем контексте, который передаётся через параметр и через Current.
HasChangesAsync Проверяет наличие изменений в карточке и в контенте её файлов, которые доступны для сохранения.
InvokeStateInitializedAsync Вызывает обработку события StateInitialized, которое происходит при инициализации состояния модели карточки.
RestoreFileDownloadingAfterCancel Восстанавливает возможность выполнения асинхронных операций по скачиванию содержимого файлов после того, как была выполнена их отмена. Обычно вызывается после сохранения или обновления карточки.
SaveAsync Выполняет сохранение карточки.
SealЗащищает объект от изменений.
(Унаследован от ISealable)
SetContextExecutor Устанавливает делегат, выполняющий другой делегат в текущем контексте.
SetDigestAsync Устанавливает Digest текущей карточки. Метод переносит выполнение на поток UI, если текущий поток отличается.
SetFunctionRoles Устанавливает свойство FunctionRoles.
SetSavingFunc Устанавливает функцию сохранения карточки.
ShowRowFormAsync Отображает форму строки карточки из свойства MainForm. Текущий объект должен быть создан для строки карточки.
TryGetHtmlSanitizer Возвращает объект, выполняющий санитайзинг HTML-документов, или null, если такой объект не зарегистрирован или недоступен.
(Унаследован от IHtmlSanitizerProvider)
TryGetPageExtractor Возвращает объект, выполняющий извлечение страницы для предпросмотра из многостраничного документа, или null, если такой объект не зарегистрирован или недоступен.
(Унаследован от IPreviewPageExtractorProvider)
TryGetPreviewHandlersPool Возвращает пул объектов для просмотра файлов или null, если такой объект не зарегистрирован или недоступен.
(Унаследован от IPreviewHandlersPoolProvider)
TryGetPreviewInfoCache Возвращает кэш, предоставляющий информацию по предпросмотру файлов, или null, если кэш недоступен.
(Унаследован от IFilePreviewInfoCacheProvider)

События

PropertyChangedOccurs when a property value changes.
(Унаследован от INotifyPropertyChanged)
StateInitialized Событие, происходящее при инициализации состояния модели карточки.

Методы расширения

GetFileViewExtensionInitializationStrategyHandlers Get not null list of strategy selection handlers for files in view extension for adding a new one for given card model.
(Определяется CardFilesExtensions)
GetFunctionRolesForCompletionOption Метод определяет характерные для варианта завершения функциональные роли из доступных для CardTask в ICardModel.
(Определяется CardUIExtensions)
GetFunctionRolesNamesWithDeputyInfoForCompletionOption Возвращает список отображаемых имён функциональных ролей с признаком замещения, относящихся к варианту завершения.
(Определяется CardUIExtensions)
GetOrUpdateDigestAsync Возвращает Digest карточки или вычисляет его, если он неизвестен, т.е. свойство Digest равно null.
(Определяется CardUIExtensions)
InSpecialMode Возвращает признак того, что в модели представления карточки установлен хотя бы один флаг из перечисления SpecialCardModelFlags, и это означает, что карточка открыта в специальном режиме, в котором необходимо включить или отключить некоторые функции. Например, карточка открыта как просмотр удалённой карточки или карточка создана из шаблона.
(Определяется CardUIExtensions)
InvalidateTileVisibility Сбрасывает кэш видимости плиток. Рекомендуется вызывать метод после изменения видимости плиток в карточке Card.
(Определяется CardUIExtensions)
ModifyOnStateInitializedAsync Задает действие при инициализации состояния модели карточки, либо выполняет его немедленно, если состояние модели уже было инициализировано.
(Определяется CardUIExtensions)
ModifyTasksAsync Изменяет модели представлений для тех заданий карточки, которые либо присутствуют в UI в текущий момент, либо являются скрытыми и могут быть восстановлены (например, заданий автора). Возвращает признак того, что хотя бы одно задание присутствовало в карточке, возможно, как скрытое.
(Определяется CardUIExtensions)
ModifyTopicsAsync Изменяет модели представлений для тех топиков карточки, которые либо присутствуют в UI в текущий момент, либо добавятся позже, например, после отправки сообщения. Возвращает признак того, что хотя бы один топик присутствовал в карточке.
(Определяется CardUIExtensions)
SetActiveValidation Устанавливает значение свойства HasActiveValidation для текущей и всех дочерних моделей ICardModel. При изменении значения свойства все элементы управления в списке ControlBag обновляют своё значение HasActiveValidation.
(Определяется CardUIExtensions)
SetCardInTemplateType Устанавливает тип карточки в шаблоне для редактируемой карточки шаблона.
(Определяется CardUIExtensions)
SetPreviousPermissions Устанавливает исходные разрешения для редактируемой карточки, которые были изменены для текущего редактирования. Например, это разрешения карточки в шаблоне.
(Определяется CardUIExtensions)
SetTaskHistoryVisible Показывает или скрывает вкладку с историей заданий, если она существовала при инициализации карточки (обычно это верно для всех типов карточек с флажком "Разрешить задания" AllowTasks).
(Определяется CardUIExtensions)
SetTemplateCard Устанавливает исходную карточку шаблона для редактируемой карточки.
(Определяется CardUIExtensions)
SetTemplateOriginalCardID Устанавливает идентификатор исходной карточки в шаблоне для редактируемой карточки.
(Определяется CardUIExtensions)
SetTemplateSectionRows Устанавливает исходную карточку шаблона для редактируемой карточки.
(Определяется CardUIExtensions)
TileIsVisible Возвращает признак того, что плитка с заданным именем должен быть видимым на основании данных в карточке, т.е. видимости, которая рассчитана в запросе на создание или загрузку карточки. Этот метод использует кэш для получения информации. При изменении информации в карточке рекомендуется вызвать метод InvalidateTileVisibility(ICardModel).
(Определяется CardUIExtensions)
TryGetCardInTemplateType Возвращает тип карточки в шаблоне для редактируемой карточки шаблона или null, если тип карточки в шаблоне не был установлен или были установлен как null.
(Определяется CardUIExtensions)
TryGetFileViewExtensionInitializationStrategyHandlers Get nullable list of strategy selection handlers for files in view extension for given card model.
(Определяется CardFilesExtensions)
TryGetPreviousPermissions Возвращает исходные разрешения для редактируемой карточки, которые были изменены для текущего редактирования, или null, если разрешения не были установлены или были установлены как null.
(Определяется CardUIExtensions)
TryGetTaskHistory Возвращает модель представления для истории заданий, если в карточке присутствует вкладка "История заданий", или null в противном случае.
(Определяется CardUIExtensions)
TryGetTaskItems Возвращает коллекцию моделей представления для заданий, по которым можно модифицировать UI или модель заданий, или null, если в карточке отсутствуют доступные задания.
(Определяется CardUIExtensions)
TryGetTemplateCard Возвращает исходную карточку шаблона для редактируемой карточки или null, если исходная карточка не была установлена или была установлена как null.
(Определяется CardUIExtensions)
TryGetTemplateOriginalCardID Возвращает идентификатор исходной карточки в шаблоне для редактируемой карточки или null, если идентификатор не был установлен или был установлен как null.
(Определяется CardUIExtensions)
TryGetTemplateSectionRows Возвращает исходную карточку шаблона для редактируемой карточки или null, если исходная карточка не была установлена или была установлена как null.
(Определяется CardUIExtensions)

См. также