CardUIHelper - класс

Вспомогательные методы для взаимодействия с UI карточки.

Definition

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

Свойства

CardLibraryFilterForOpenDialog Строка фильтра для файлов с экспортированными карточками TESSA для диалога сохранения файла.
CardLibraryFilterForSaveDialog Строка фильтра для файлов с экспортированными карточками TESSA для диалога сохранения файла.
CardStorageFilter Строка фильтра для файлов со структурой карточек TESSA.
CardTypeFilterForOpenDialog Строка фильтра для типов карточек TESSA для диалога открытия файла.
CardTypeFilterForSaveDialog Строка фильтра для типов карточек TESSA для диалога сохранения файла.
ExportedCardFilter Строка фильтра для файлов с экспортированными карточками TESSA.
HorizontalAlignmentIntegers Выравнивание по горизонтали. В модели данных записывается как целое число int.
HorizontalAlignmentValues Выравнивание по горизонтали. В модели данных записывается как значение перечисления HorizontalAlignment.
ImportCardsAndLibrariesFilter Строка фильтра для импорта файлов с карточками и библиотеками карточек TESSA.
MergeOptionsFilter Строка фильтра для файлов с опциями слияния.
VerticalAlignmentIntegers Выравнивание по горизонтали. В модели данных записывается как целое число int.
VerticalAlignmentValues Выравнивание по горизонтали. В модели данных записывается как значение перечисления VerticalAlignment.

Методы

ColumnExistsInParentControl Возвращает признак того, что заданная колонка разрешена в дочерней форме указанного элемента управления, или текущей является форма типа карточки.
ColumnExistsInType Возвращает признак того, что заданная колонка разрешена в указанном типе карточки.
ColumnHasOrContainsType Возвращает признак того, что заданная колонка column имеет указанный тип type, либо она является комплексной колонкой, которая содержит хотя бы одну физическую колонку заданного типа.
EmptySavingFuncAsync Метод по сохранению модели представления карточки ICardModel, не выполняющее действий по сохранению. Метод можно указать посредством вызова SetSavingFunc(CardModelSavingFuncAsync).
FixOrderControlSettingsAsync Исправляет настройки контрола CardTypeTableControl, который содержит настройку OrderColumnIDSetting и опционально IsSaveOrderSetting. Исправление включает в себя отказ от настройки IsSaveOrderSetting в качестве определения того, следует ли выполнять сохранение порядка строк в секции, и определение этого по наличию идентификатора в настройке OrderColumnIDSetting.
FormIsGrid Возвращает признак того, что форма настроена через конструктор блоков. Для построения интерфейса такой формы используйте метод GenerateFormGridUI(IFormWithBlocksViewModel, Boolean).
GenerateFormGridUI Выполняет генерацию пользовательского интерфейса для отображения формы, которая настроена через конструктор блоков. Если форма не настроена через конструктор, то возвращается пустой объект. Метод не возвращает null.
GetExportedCardDesiredFileNameWithoutExtension Возращает предпочитаемое имя файла, в которую экспортируется карточка, без расширения.
GetHelpModeItems Возвращает набор вариантов режима справки для редактора карточки
GetHelpToolTip Возвращает текст всплывающей подсказки для кнопок справки в соответствии с указанными настройками или null, если всплывающая подсказка не требуется.
GetSearchModeItems Возвращает набор вариантов режима поиска для редактора карточки
GetSelectedTabT Возвращает выбранную вкладку, сохранённую по индексу посредством метода GetSelectedTabIndexT(ICollectionT, T).
GetSelectedTabIndexT Возвращает индекс выбранной вкладки.
GetSettingFromThickness Возвращает строку настроек, полученную по значению Thickness.
GetThicknessFromSettings Возвращает значение Thickness, полученное по строке из настроек.
GetWorkspaceNameAsync Получить название вкладки рабочей области для модели карточки.
HandleHelpAsync Обрабатывает действие, связанное со справкой. Не выполняет действий, если helpMode отличен от Card и Url, или если helpValue указан как пустая строка.
ModifyTemplateCardEditor Изменяем редактор карточки шаблона перед отображением. Метод требуется выполнить один раз после открытия карточки шаблона, но перед её отображением пользователю.
OnWorkspaceClosingAsync Обработчик для события закрытия рабочей области карточки.
OnWorkspaceClosingNoCancelAsync Обработчик для события закрытия рабочей области карточки без возможности отмены.
OnWorkspaceClosingWithSaveAsync Обработчик события сохранения карточки после закрытия.
ProhibitTileExecutionInLeftPanelWhenEditorInProgress Метод добавляет обработчик, запрещающий выполнение плиток, расположенных на левой боковой панели, для всех событий, кроме Default, если в текущем контексте плитки содержится редактор ICardEditorModel, выполняющий асинхронную операцию OperationInProgress. Если обработчик уже был добавлен посредством этого метода, то действий не производится.
SetCaptionStyle Устанавливает стиль заголовка контрола по метаинформации контрола.
SetTextStyle Устанавливает стиль текста из заданного объекта с настройками.
TableExistsInType Возвращает признак того, что заданная таблица разрешена в указанном типе карточки.
TryCreateFromTemplateAsync Асинхронно создаёт карточку по шаблону и открывает её. Метод выполняется асинхронно и должен либо вызываться в потоке UI с последующим await, либо поток UI не должен быть заблокирован на время выполнения этого метода (иначе это приведёт к взаимной блокировке потоков). Возвращает задачу с объектом открытой вкладки или null, если вкладку открыть не удалось.
TryCreateFromTemplateResponseAsync Обрабатывает запрос с созданной карточкой, полученный в результате создания карточки по шаблону, и открывает редактор такой карточки в отдельной вкладке. Возвращает объект открытой вкладки или null, если вкладку открыть не удалось.
TryEditCardInTemplateAsync Запускает асинхронную задачу, которая открывает карточку в шаблоне для редактирования.

Задача возвращает null, если при выполнении возникли ошибки. Возвращённая задача не может быть равна null.

TryGetOrderColumnIDAsync Возвращает идентификатор колонки, в которой содержится порядок строк в секции, с которой связан заданный контрол CardTypeTableControl. Настройки контрола должны содержать настройку OrderColumnIDSetting и опционально IsSaveOrderSetting.
TryOpenTemplateFromCardAsync Запускает асинхронную задачу, которая создаёт и открывает вкладку с редактором карточки шаблона из карточки, которая редактируется в шаблоне.

Изменения из редактируемой карточки сериализуются в карточке шаблона перед открытием вкладки с шаблоном.

Задача возвращает null, если при выполнении возникли ошибки. Возвращённая задача не может быть равна null.

Поля

CardTypeDefaultExt Расширение по умолчанию для экспорта типов карточек.
DefaultDialogName Название стандартного диалога, в котором открывается карточка.
EditTemplateCardModelFlags Флаги, которые устанавливаются для редактируемых в шаблоне карточек.
ExportedCardDefaultExt Расширение по умолчанию для экспортированных карточек.
FileControlContextCardModelKey Ключ, по которому объект ICardModel содержится в контексте IFileControlExtensionContext в свойстве Info.
ImportCardDefaultExt Расширение по умолчанию для импортирования карточек.
MergeOptionsDefaultExt Расширение по умолчанию для файлов с опциями слияния.
MoveToTabModifierFuncAsyncKey

Ключ, по которому находится функция, изменяющая модель карточки и опции открытия карточки при переносе ее из диалога во вкладку. Если возвращает false, то перенос будет отменен.

Имеет тип: Func<ICardEditorModel, OpenCardOptions, ValueTask<bool>>.

SpecialCardModelFlags Флаги, установка любого из которых в Flags означает, что карточка открыта в специальном режиме, в котором необходимо включить или отключить некоторые функции.
TemplateWasRepairedKey Признак того, что структура карточки шаблона была исправлена после изменения схемы данных. Устанавливается для карточки, редактируемой в шаблоне, в её Info.
ToolbarHiddenActions Ключ, по которому в Info редактора карточки хранится список кнопок, скрываемых с тулбара редактора карточки.
ValidationObjectsKey Ключ в ICardModel.Info, в котором хранятся объекты валидации.

См. также