CardViewControlViewModel - класс

Модель-представление для элемента управления отображающего представление в карточках.

Definition

Пространство имён: Tessa.UI.Cards.Controls
Сборка: Tessa.UI (в Tessa.UI.dll) Версия: 3.6.0.22

[UsedImplicitlyAttribute]
public class CardViewControlViewModel : ControlViewModelBase, 
	IContextMenuExtendedProvider, IContextMenuProvider, IMenuActionGeneratorProvider, IUIContextExecutorProvider, IPagingSource, 
	INotifyPropertyChanged, IParametersSetNameProvider, IParametersMappingContext

<UsedImplicitlyAttribute>
Public Class CardViewControlViewModel
	Inherits ControlViewModelBase
	Implements IContextMenuExtendedProvider, IContextMenuProvider, IMenuActionGeneratorProvider, IUIContextExecutorProvider, 
	IPagingSource, INotifyPropertyChanged, IParametersSetNameProvider, IParametersMappingContext

C++

[UsedImplicitlyAttribute]
public ref class CardViewControlViewModel : public ControlViewModelBase, 
	IContextMenuExtendedProvider, IContextMenuProvider, IMenuActionGeneratorProvider, IUIContextExecutorProvider, IPagingSource, 
	INotifyPropertyChanged, IParametersSetNameProvider, IParametersMappingContext

[<UsedImplicitlyAttribute>]
type CardViewControlViewModel = 
    class
        inherit ControlViewModelBase
        interface IContextMenuExtendedProvider
        interface IContextMenuProvider
        interface IMenuActionGeneratorProvider
        interface IUIContextExecutorProvider
        interface IPagingSource
        interface INotifyPropertyChanged
        interface IParametersSetNameProvider
        interface IParametersMappingContext
    end

Inheritance: Object NotificationObject NotificationUIObject SupportUnloadingViewModel ControlViewModelBase CardViewControlViewModel

Derived: Tessa.Extensions.Platform.Client.UI.TableViewExtensionCardTableViewControlViewModel

Implements: INotifyPropertyChanged, IParametersMappingContext, IUIContextExecutorProvider, IContextMenuExtendedProvider, IContextMenuProvider, IMenuActionGeneratorProvider, IParametersSetNameProvider, IPagingSource

Конструкторы

CardViewControlViewModel

Инициализирует новый экземпляр класса CardViewControlViewModel

Свойства

ActualMargin	Предпочитаемый отступ элемента управления относительно других элементов управления, расчитываемый блоком и используемый при отображении. Не рекомендуется вручную изменять это значение. (Унаследован от ControlViewModelBase)
AddRowButton	Кнопка добавления строки. Нельзя присвоить значение null. Видимость кнопки устанавливается автоматически, не рекомендуется его изменять без необходимости.
Alias
AllowDrop	Признак возможности обработки операций Drag-n-Drop
Block	Блок, в котором размещён текущий элемент управления. (Унаследован от ControlViewModelBase)
BottomItems	Дополнительные кнопки под таблицей внизу.
Caption	Заголовок элемента управления. (Унаследован от ControlViewModelBase)
CaptionStyle	Стиль текста для заголовка контрола. (Унаследован от ControlViewModelBase)
CaptionVisibility	Видимость заголовка элемента управления. (Унаследован от ControlViewModelBase)
CardIDParam	Параметр представления, в которые пробрасывается ID карточки.
CardModel	Модель карточки
CardTypeControl	Информация о типе отображаемого элемента управления. (Унаследован от ControlViewModelBase)
ClientQuickSearchText	Текст клиентского быстрого поиска
ColumnSpan	Количество колонок, которые занимает контрол по горизонтали. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 1 и не может быть меньше. Если заданное количество колонок больше, чем общее количество колонок в блоке, то контрол растягивается на ширину строки. (Унаследован от ControlViewModelBase)
Content	Отображаемое содержимое
ContentMaxHeight
ContentVisible	Признак отображения основной области отображения Content
ContextMenuGenerators	Gets Список генераторов контекстного меню
ControlVisibility	Видимость элемента управления. (Унаследован от ControlViewModelBase)
CreateRowFunc	Функция для перегрузки создания строки
CurrentPage	Текущая страница
CurrentRefreshTask
DataProvider	Источник данных
DelayedViewRefresh	Отложенное обновление представления
DeleteRowsButton	Кнопка удаления выделенных строк. Нельзя присвоить значение null. Видимость кнопки устанавливается автоматически, не рекомендуется его изменять без необходимости.
DoubleClickCommand	Команда обрабатывающая двойной щелчок мышью
DragDrop
EmptyColumnsToTheLeft	Количество пустых колонок, которые отображаются слева от контрола. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 0 и не может быть меньше. Если заданное количество колонок больше, чем количество колонок в блоке минус количество колонок, занимаемых контролом, то отрисовывается столько пустых колонок, сколько умещается в строке. Если контрол рисуется не с начала строки, и он не умещается вместе с заданным отступом, то он переносится на следующую строку. (Унаследован от ControlViewModelBase)
EnableMouseScrolling	true, если прокрутка колесом мыши прокручивает таблицу; false, если прокрутка колесом мыши прокручивает карточку, а для прокрутки таблицы требуется зажать Ctrl.
Error	Сообщение об ошибке, связанное с текущим объектом, или null, если ошибки нет. (Унаследован от ControlViewModelBase)
FirstRowSelection	Автоматически выбирать первую строку после обновления
Focusable	Признак того, что элемент управления может иметь логический фокус. (Унаследован от ControlViewModelBase)
FocusPending	Признак того, что элемент управления получит логический фокус, как только элемент управления станет доступен, т.е. его свойство [Tessa.UI.Cards.IControlViewModel.IsEnabled] будет равно true. (Унаследован от ControlViewModelBase)
HasActiveValidation	Признак того, что в элементе управления следует включить активную валидацию. При этом если для элемента управления введено некорректное значение, то он будет уведомлять об этом рамкой валидации. Значение устанавливливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false. (Унаследован от ControlViewModelBase)
HasNextPage
HorizontalAlignment	Выравнивание контрола по горизонтали. По умолчанию контрол выравнивается по ширине Stretch. (Унаследован от ControlViewModelBase)
Initialized	Признак того, что форма уже инициализирована вызовом InitializeAsync(CancellationToken), поэтому повторные вызовы метода будут игнорироваться. (Унаследован от ControlViewModelBase)
InitializedStrategy
InitialRefreshIsCompleted
IsChildViewControl
IsDataLoading	Признак загрузки данных
IsEmpty	Признак того, что элемент управления не содержит отображаемых данных. (Унаследован от ControlViewModelBase)
IsEnabled	Признак того, что элемент управления доступен для взаимодействия. Только доступный элемент может получить логический фокус. Свойство следует использовать только для чтения, т.е. можно проверить его значение и подписаться на его изменение в PropertyChanged, но установленное в свойстве значение будет проигнорировано. (Унаследован от ControlViewModelBase)
IsFocused	Признак того, что элемент управления имеет логический фокус. Проверка и установка значения свойства имеет смысл только в случае, если элемент управления может получить логический фокус, т.е. значение свойства [Tessa.UI.Cards.IControlViewModel.Focusable] равно true. (Унаследован от ControlViewModelBase)
IsGroupsExpanded	Признак свернутости\развернутости групп в представлении
IsReadOnly	Признак того, что элемент управления доступен только для чтения или не содержит редактируемых данных. Для контрола "Кнопка" разрешает или запрещает нажатие по кнопке. (Унаследован от ControlViewModelBase)
IsRequired	Признак того, что элемент управления отмечен, как обязательный для заполнения. (Унаследован от ControlViewModelBase)
IsSpanned	Признак того, что элемент управления должен быть растянут на ширину колонки при выводе в несколько колонок. (Унаследован от ControlViewModelBase)
IsUnloaded	Признак того, что объект был выгружен и уже не может использоваться в UI. Например, если объект является контролом карточки, то он становится выгруженным после закрытия формы редактирования строки или пре рефреше карточки. (Унаследован от SupportUnloadingViewModel)
IsVisibilityRearranged	Признак того, что видимость элемента управления была изменена в процессе перерисовки содержимого. Поле используется системой и сбрасывается в false при ручном изменении видимости. (Унаследован от ControlViewModelBase)
Item	Сообщение об ошибке, связанное со свойством текущего объекта, или null, если ошибки нет. (Унаследован от ControlViewModelBase)
KeyDownHandlers	Список методов, выполняющихся при обработке нажатия клавиши.
LeftButtonClickCommand	Команда обрабатывающая нажатие правой кнопки мыши на элемент таблицы
LeftItems	Дополнительные элементы отображаемые слева от основного содержимого.
Margin	Заданный в настройках отступ элемента управления относительно других элементов управления. По умолчанию отступ отсутствует. Если по одному из направлений (слева, сверху и пр.) задано отрицательное значение, то по этому направлению отступ не отображается (т.е. равен 0). (Унаследован от ControlViewModelBase)
MasterContext	Контекст мастер-представления
MasterControl	Мастер-контрол предствлаения
MaxResultsCount	Gets or sets the max results count.
MaxWidth	Максимальная ширина контрола. По умолчанию значение равно double.PositiveInfinity. Значение не может быть меньше 0. При установке значения 0 в действительности устанавливается double.PositiveInfinity, т.к. в настройках контрола 0 эквивалентно отсутствию ограничения на контрол. (Унаследован от ControlViewModelBase)
MenuActionGenerator	Используемый объект [Tessa.UI.Menu.IMenuActionGenerator].
MenuContext
MiddleClickCommand	Gets or sets the middle click command.
MinRowHeight	Минимальная высота создаваемой строки. По умолчанию равна 0.
MinWidth	Минимальная ширина контрола. По умолчанию значение равно 0 и не может быть меньше. (Унаследован от ControlViewModelBase)
ModifyRowActions	Список модификацией, которые будут применены к каждой строке сразу после ее инициализации
Name	Имя элемента управления, по которому он доступен в коллекции, или null, если у элемента управления не задано имя. (Унаследован от ControlViewModelBase)
OptionalPagingStatus	Gets or sets a value indicating whether Статус режима опционального пейджинга
PageCount	Gets Количество страниц в источнике данных.
PageCountStatus	Gets a value indicating whether Признак отображения количества страниц
PagingMode	Gets Возвращает поддерживаемый режим пейджинга
Parameters	Список параметров
ParametersActions	Действия над коллекцией параметров
ParametersSetName	Gets Имя набора параметров
RefreshDelay
RequiredText	Текст валидации обязательного для заполнения элемента. (Унаследован от ControlViewModelBase)
RightButtonClickCommand	Команда обрабатывающая нажатие правой кнопки мыши на элемент таблицы
RightItems	Дополнительные элементы отображаемые справа от основного содержимого.
RowContextMenuGenerators
Rows	Список строк
SelectedCell	Выбранная ячейка
SelectedColumn	Выбранный столбец
SelectedColumnName	Имя выбранного столбца
SelectedRow	Выбранная строка
SelectedRowData	Выбранная строка в мастер-представлении или null
SelectedRows	Список выбранных строк
Sorting	Текущая сортировка
StartAtNewLine	Признак того, что текущий контрол в блоке всегда начинается с новой строки. (Унаследован от ControlViewModelBase)
Table	Модель таблицы данных
ToolTip	Всплывающая подсказка для элемента управления или null, если подсказка отсутствует. Пустая строка или строка, состоящая из пробелов, присваивается как null. (Унаследован от ControlViewModelBase)
TopContent	Отображаемое содержимое над основным содержимым
TopContentVisible	Признак отображения верхнего содержимого
TopItems	Дополнительные элементы над таблицей
UIContextExecutorAsync	Делегат, выполняющий заданное действие в контексте [Tessa.UI.IUIContext].
UILockNotifier
ValidationFunc	Функция валидации, проверяющая элемент управления на корректность его значения, или null, если дополнительные проверки значения отсутствуют. Проверка на незаполненное значение всё равно выполняется, если элемент управления был отмечен как обязательный для заполнения (в т.ч. посредством валидатора). Для использования функции на элементе управления должна быть включена валидация [Tessa.UI.Cards.IControlViewModel.HasActiveValidation]. (Унаследован от ControlViewModelBase)
VerticalAlignment	Выравнивание контрола по вертикали. По умолчанию контрол выравнивается по высоте Stretch. (Унаследован от ControlViewModelBase)
ViewControlIsInitialized
ViewMapping	Настройки маппинга.
ViewMetadata	Метаданные представления

Методы

ApplyClientQuickSearch
CommitChangesAsync	Подтверждает изменения для текущего элемента управления. Метод обычно вызывается перед сохранением карточки для того, чтобы элементы управления, у которых состояние ввода зависит от фокуса и других параметров, могли подтвердить введённое значение перед тем, как карточка будет сохранена. Если при выполнении этого метода возникнет исключение, то оно будет зафиксировано в результате. (Унаследован от ControlViewModelBase)
CreateParametersSettings
Equals	Determines whether the specified object is equal to the current object. (Унаследован от Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Унаследован от Object)
Focus	Устанавливает логический фокус на текущий элемент управления, если он поддерживает логический фокус, т.е. значение свойства [Tessa.UI.Cards.IControlViewModel.Focusable] равно true. Если элемент управления недоступен или не поддерживает логический фокус, то метод возвращает значение false. (Унаследован от ControlViewModelBase)
GetContextMenuAsync	Возвращает контекстное меню, доступное для текущей модели представления. Если возвращается null, пустая коллекция или коллекция из скрытых элементов, то меню при этом не отображается.
GetHashCode	Serves as the default hash function. (Унаследован от Object)
GetState	Возвращает текущее состояние элемента управления. Может вернуть null, если элемент управления не имеет состояния. (Унаследован от ControlViewModelBase)
GetType	Gets the Type of the current instance. (Унаследован от Object)
HasEmptyValue	Возвращает признак того, что элемент управления имеет пустое значение. (Унаследован от ControlViewModelBase)
InitializeAsync	Осуществляет инициализацию объекта
InitializeCoreAsync	Выполняет асинхронную инициализацию объекта. (Унаследован от ControlViewModelBase)
InitializeEventsSubscriptions	Осуществляет инициализацию подписки на события
InitializeMasterLinks	The initialize master links.
InitializeOnTabAsync	Отображает элементы графического интерфейса на вкладке. Используется, когда представления программное и иниициализация стратегии произошла после инициализации на вкладке стандартными средствами.
InitializeOtherViewControlsAsync	Осуществляет вызов инициализации элементов отображения представлений в карточке. По принципу кто первый встал тот и тапки греет. Необходимо для корректной инициализации ссылок на мастер представления. Т.к. мастер представление может быть не доступно на момент создания элемента отображения представления использующего его.
InitializeStrategyAsync	Инициализирует стратегию создания ViewModelи представления. DataProvider можно установить через свойство CardViewControlViewModel.DataProvider.
InPagingMode
InternalRefreshAsync	Вызывает обновление таблицы данных.
InvalidateAutoSize	Перерассчитывает ширину колонок если включена автоширина.
MemberwiseClone	Creates a shallow copy of the current Object. (Унаследован от Object)
NotifyTabDeselectedAsync	Уведомляет текущий объект и все его дочерние объекты о том, что он располагался на выбранной вкладке, после чего выбрали другую вкладку. (Унаследован от ControlViewModelBase)
NotifyTabSelectedAsync	Уведомляет текущий объект и все его дочерние объекты о том, что он расположен в текущей выбранной вкладке. Событие для выбранной вкладки вызывается после того, как было вызвано событие TabDeselected для вкладки, которая перестала быть выбранной. (Переопределяет ControlViewModelBaseNotifyTabSelectedAsync(ITabSelectedContext, CancellationToken))
NotifyUpdateValidation	Уведомляет об изменении всех свойств, связанных с валидацией в элементе управления, даже если эти свойства не были изменены. (Унаследован от ControlViewModelBase)
OnPropertyChanged(PropertyChangedEventArgs)	Уведомляет об изменении свойства с именем, заданным в аргументах события. (Унаследован от NotificationObject)
OnPropertyChanged(String)	Уведомляет об изменении свойства с заданным именем у объекта. (Унаследован от NotificationObject)
OnPropertyChangedAsync(PropertyChangedEventArgs, Boolean)	Уведомляет об изменении свойства с именем, заданным в аргументах события, асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно. (Унаследован от NotificationUIObject)
OnPropertyChangedAsync(String, Boolean)	Уведомляет об изменении свойства с заданным именем у объекта асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно. (Унаследован от NotificationObject)
OnRefreshCompletedAsync	Метод, вызываемый после обновления представления вместе с объектами UI (колонками и строками). Реализация по умолчанию вызывает обработчики события Refreshed.
OnUnloadingAsync	Метод вызывается в процессе выгрузки объекта и выполняет некоторую обработку, например, отписывается от событий и выгружает дочерние объекты (например, контролы в блоке). Исключения в процесс выполнения метода будут поглощены и добавлены в лог. (Унаследован от SupportUnloadingViewModel)
Rearrange	Выполняет перерисовку содержимого в зависимости от состояния объекта с учётом дочерних объектов, в т.ч. от видимости дочерних вложенных форм при их наличии. (Унаследован от ControlViewModelBase)
RearrangeChildren	Выполняет перерисовку содержимого в зависимости от состояния дочерних объектов, в т.ч. от видимости дочерних вложенных форм при их наличии. (Унаследован от ControlViewModelBase)
RearrangeSelf	Выполняет перерисовку содержимого в зависимости от состояния объекта без учёта дочерних объектов. (Унаследован от ControlViewModelBase)
RefreshAsync	Вызывает обновление данных из представления
SetBlock	Устанавливает блок, в котором размещён элемент управления. (Унаследован от ControlViewModelBase)
SetSorting	Устанавливает режим сортировки для списка столбцов columns
SetStateAsync	Устанавливает заданное состояние элемента управления. (Унаследован от ControlViewModelBase)
SortColumnAsync	Вызывается при сортировке по указанному столбцу
ToString	Returns a string that represents the current object. (Унаследован от Object)
UnloadAsync	Выполняет выгрузку объекта. Если объект уже был выгружен, то повторная выгрузка не выполняется. (Унаследован от SupportUnloadingViewModel)
UpdatePageCount	Обновляет количество страниц

События

PropertyChanged	Событие, уведомляющее об изменении свойства с определённым именем у модели представления. (Унаследован от NotificationObject)
Refreshed	Событие, вызываемое после обновления представления. В нём можно изменять модели представлений строк и колонок.
Refreshing	Событие обновления
TabDeselected	Событие, происходящее для объекта, который располагался на выбранной вкладке, после чего выбрали другую вкладку. (Унаследован от ControlViewModelBase)
TabSelected	Событие, происходящее при переходе объекта на выбранную вкладку. Событие для выбранной вкладки вызывается после того, как было вызвано событие TabDeselected для вкладки, которая перестала быть выбранной. (Унаследован от ControlViewModelBase)
Unloaded	Событие, возникающее после того, как объект был выгружен и уже не может использоваться в UI. Если на некоторые свойства объекта, связанные с UI, выполнялась подписка, то в обработчике события можно выполнить отписку, а также удалить сам обработчик. (Унаследован от SupportUnloadingViewModel)

Поля

ActualMarginInternal	Предпочитаемый отступ элемента управления относительно других элементов управления, расчитываемый блоком и используемый при отображении. Не рекомендуется вручную изменять это значение. (Унаследован от ControlViewModelBase)
BlockInternal	Блок, в котором размещён текущий элемент управления. (Унаследован от ControlViewModelBase)
CaptionInternal	Заголовок элемента управления. (Унаследован от ControlViewModelBase)
CaptionVisibilityInternal	Видимость заголовка элемента управления. (Унаследован от ControlViewModelBase)
ColumnSpanInternal	Количество колонок, которые занимает контрол по горизонтали. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 1 и не может быть меньше. Если заданное количество колонок больше, чем общее количество колонок в блоке, то контрол растягивается на ширину строки. (Унаследован от ControlViewModelBase)
ControlVisibilityInternal	Видимость элемента управления. (Унаследован от ControlViewModelBase)
EmptyColumnsToTheLeftInternal	Количество пустых колонок, которые отображаются слева от контрола. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 0 и не может быть меньше. Если заданное количество колонок больше, чем количество колонок в блоке минус количество колонок, занимаемых контролом, то отрисовывается столько пустых колонок, сколько умещается в строке. Если контрол рисуется не с начала строки, и он не умещается вместе с заданным отступом, то он переносится на следующую строку. (Унаследован от ControlViewModelBase)
HasActiveValidationInternal	Признак того, что в элементе управления следует включить активную валидацию. При этом если для элемента управления введено некорректное значение, то он будет уведомлять об этом рамкой валидации. Значение устанавливливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false. (Унаследован от ControlViewModelBase)
HorizontalAlignmentInternal	Выравнивание контрола по горизонтали. По умолчанию контрол выравнивается по ширине Stretch. (Унаследован от ControlViewModelBase)
IsReadOnlyInternal	Признак того, что элемент управления доступен только для чтения или не содержит редактируемых данных. Для контрола "Кнопка" разрешает или запрещает нажатие по кнопке. (Унаследован от ControlViewModelBase)
IsRequiredInternal	Признак того, что элемент управления отмечен, как обязательный для заполнения. (Унаследован от ControlViewModelBase)
IsSpannedInternal	Признак того, что элемент управления должен быть растянут на ширину колонки при выводе в несколько колонок. (Унаследован от ControlViewModelBase)
MarginInternal	Заданный в настройках отступ элемента управления относительно других элементов управления. По умолчанию отступ отсутствует. Если по одному из направлений (слева, сверху и пр.) задано отрицательное значение, то по этому направлению отступ не отображается (т.е. равен 0). (Унаследован от ControlViewModelBase)
MaxWidthInternal	Максимальная ширина контрола. По умолчанию значение равно double.PositiveInfinity. Значение не может быть меньше 0. При установке значения 0 в действительности устанавливается double.PositiveInfinity, т.к. в настройках контрола 0 эквивалентно отсутствию ограничения на контрол. (Унаследован от ControlViewModelBase)
MinWidthInternal	Минимальная ширина контрола. По умолчанию значение равно 0 и не может быть меньше. (Унаследован от ControlViewModelBase)
StartAtNewLineInternal	Признак того, что текущий контрол в блоке всегда начинается с новой строки. (Унаследован от ControlViewModelBase)
ToolTipInternal	Всплывающая подсказка для элемента управления или null, если подсказка отсутствует. Пустая строка или строка, состоящая из пробелов, присваивается как null. (Унаследован от ControlViewModelBase)
ValidationFuncInternal	Признак того, что в элементе управления следует включить активную валидацию. При этом если для элемента управления введено некорректное значение, то он будет уведомлять об этом рамкой валидации. Значение устанавливливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false. (Унаследован от ControlViewModelBase)
VerticalAlignmentInternal	Выравнивание контрола по вертикали. По умолчанию контрол выравнивается по высоте Stretch. (Унаследован от ControlViewModelBase)

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

Get	(Определяется ComHelper)
InternalMarkerCanvas	Возвращает маркер аннотации (Определяется AnnotationInternalsAccessor)
Invoke	(Определяется ComHelper)
Set	(Определяется ComHelper)

См. также

Ссылки

Tessa.UI.Cards.Controls - пространство имён