CardViewControlViewModel - класс

Модель-представление вью-контрола.

Definition

Пространство имён: Tessa.UI.Cards.Controls
Сборка: Tessa.UI (в Tessa.UI.dll) Версия: 4.0.4
C#
public class CardViewControlViewModel : ControlViewModelBase, 
	IContextMenuExtendedProvider, IContextMenuProvider, IMenuActionGeneratorProvider, IUIContextExecutorProvider, IPagingSource, 
	INotifyPropertyChanged, IParametersSetNameProvider, IParametersMappingContext
Inheritance
Object    NotificationObject    NotificationUIObject    SupportUnloadingViewModel    ControlViewModelBase    CardViewControlViewModel
Derived
Implements
INotifyPropertyChanged, IParametersMappingContext, IUIContextExecutorProvider, IContextMenuExtendedProvider, IContextMenuProvider, IMenuActionGeneratorProvider, IParametersSetNameProvider, IPagingSource

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

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

Свойства

ActualMargin Предпочитаемый отступ элемента управления относительно других элементов управления, расчитываемый блоком и используемый при отображении. Не рекомендуется вручную изменять это значение.
(Унаследован от ControlViewModelBase)
AddRowButton Кнопка добавления строки. Нельзя присвоить значение null. Видимость кнопки устанавливается автоматически, не рекомендуется его изменять без необходимости.
Alias Алиас представления.
AllowDrop Признак возможности обработки операций Drag-n-Drop.
AutoSaveSettings Признак того, что настройки пользователя автоматически сохраняются, если также включена настройка EnableSavingSettings.
BlockБлок, в котором размещён текущий элемент управления.
(Унаследован от ControlViewModelBase)
BottomItems Дополнительные кнопки под таблицей внизу.
CaptionЗаголовок элемента управления.
(Унаследован от ControlViewModelBase)
CaptionStyleСтиль текста для заголовка контрола.
(Унаследован от ControlViewModelBase)
CaptionVisibilityВидимость заголовка элемента управления.
(Унаследован от ControlViewModelBase)
CardIDParam Параметр представления, в которое пробрасывается ID карточки.
CardModel Модель карточки.
CardTypeControlИнформация о типе отображаемого элемента управления.
(Унаследован от ControlViewModelBase)
ClientQuickSearchText Текст, который отображается в контроле быстрого поиска.
ColumnContextMenuGenerator

Объект, выполняющий генерацию контекстного меню при клике по заголовку колонки, или null, если контекстное меню отключено.

Реализация по умолчанию доступна в классе ViewControlMenuGenerator, который можно унаследовать и переопределить.

Меню может быть доопределено объектами ContextMenuGenerators для каждой колонки индивидуально.

ColumnSpan Количество колонок, которые занимает контрол по горизонтали. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 1 и не может быть меньше. Если заданное количество колонок больше, чем общее количество колонок в блоке, то контрол растягивается на ширину строки.
(Унаследован от ControlViewModelBase)
Content Отображаемое содержимое.
ContentMaxHeight Максимальная высота контента.
ContentVisible Признак отображения основной области отображения Content.
ContextMenuGenerators Список генераторов контекстного меню.
ControlVisibilityВидимость элемента управления.
(Унаследован от ControlViewModelBase)
CreateRowFunc Функция для перегрузки создания строки.
CurrentOrderedColumns

Упорядоченный список алиасов колонок в соответствии с настройками пользователя UserSettings. Равен null, если колонки неизвестны или равны колонкам по умолчанию.

Рекомендуется изменять только при перестроении списка колонок. Получить актуальное значение можно, вызвав метод GetCurrentOrderedColumns, который возвращает DefaultOrderedColumns, когда значение равно null, или пустой список, если DefaultOrderedColumns также равны null.

CurrentPage Текущая страница.
CurrentRefreshTask 
DataProvider Источник данных
DefaultOrderedColumns

Упорядоченный список алиасов колонок по умолчанию. Обычно соответствует порядку в метаинформации представления. Равен null, если колонки неизвестны.

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

DelayedViewRefresh Отложенное обновление представления.
DeleteRowsButton Кнопка удаления выделенных строк. Нельзя присвоить значение null. Видимость кнопки устанавливается автоматически, не рекомендуется его изменять без необходимости.
Dependencies Зависимости элемента управления "Представление".
DoubleClickCommand Команда, обрабатывающая двойной щелчок мышью.
DragDrop
Объект, производящий дополнительную обработку UI событий через ViewCardControlDropBehavior.
EmptyColumnsToTheLeft Количество пустых колонок, которые отображаются слева от контрола. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 0 и не может быть меньше. Если заданное количество колонок больше, чем количество колонок в блоке минус количество колонок, занимаемых контролом, то отрисовывается столько пустых колонок, сколько умещается в строке. Если контрол рисуется не с начала строки, и он не умещается вместе с заданным отступом, то он переносится на следующую строку.
(Унаследован от ControlViewModelBase)
EnableMouseScrollingtrue, если прокрутка колесом мыши прокручивает таблицу; false, если прокрутка колесом мыши прокручивает карточку, а для прокрутки таблицы требуется зажать Ctrl.
EnableSavingSettings Признак того, что пользователю разрешено сохранять настройки отображения (порядок и скрытие колонок, и др.).
Error Сообщение об ошибке, связанное с текущим объектом, или null, если ошибки нет.
(Унаследован от ControlViewModelBase)
FirstRowSelection Флаг, указывающий на то, что после обновления нужно автоматически выбирать первую строку.
FocusableПризнак того, что элемент управления может иметь логический фокус.
(Унаследован от ControlViewModelBase)
FocusPending Признак того, что элемент управления получит логический фокус, как только элемент управления станет доступен, т.е. его свойство [Tessa.UI.Cards.IControlViewModel.IsEnabled] будет равно true.
(Унаследован от ControlViewModelBase)
FormattingSettings Настройки форматирования. Установлены в методе инициализации InitializeAsync(CancellationToken) перед вызовом перегрузки InitializeCoreAsync(CancellationToken).
(Унаследован от ControlViewModelBase)
HasActiveValidation Признак того, что в элементе управления следует включить активную валидацию. При этом если для элемента управления введено некорректное значение, то он будет уведомлять об этом рамкой валидации. Значение устанавливливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false.
(Унаследован от ControlViewModelBase)
HasNextPage 
HasUnsavedSettings Признак того, что есть несохранённые настройки пользователя.
HelpModeСпособ отображения справочной информации.
(Унаследован от ControlViewModelBase)
HelpValueЗначение, связанное со способом отображения справки.
(Унаследован от ControlViewModelBase)
HorizontalAlignment Выравнивание контрола по горизонтали. По умолчанию контрол выравнивается по ширине Stretch.
(Унаследован от ControlViewModelBase)
Info Дополнительная информация.
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 Максимальное число отображаемых строк на странице.
MaxWidth Максимальная ширина контрола. По умолчанию значение равно double.PositiveInfinity. Значение не может быть меньше 0. При установке значения 0 в действительности устанавливается double.PositiveInfinity, т.к. в настройках контрола 0 эквивалентно отсутствию ограничения на контрол.
(Унаследован от ControlViewModelBase)
MenuActionGenerator Используемый объект [Tessa.UI.Menu.IMenuActionGenerator].
MenuContext
Контекст, предоставляющий средства для генерации меню, например, посредством интерфейса IContextMenuProvider.
MiddleClickCommand Команда, обрабатывающая нажатие средней кнопки мыши на элемент таблицы.
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 Имя набора параметров
ParentControl Родительский элемент управления.
RefreshDelay 
RequiredText Текст валидации обязательного для заполнения элемента.
(Унаследован от ControlViewModelBase)
RightButtonClickCommand Команда, обрабатывающая нажатие правой кнопки мыши на элемент таблицы.
RightItems Дополнительные элементы, отображаемые справа от основного содержимого.
RowContextMenuGenerators Список генераторов контекстного меню строки.
Rows Список строк.
SelectedCell Выбранная ячейка.
SelectedColumn Выбранный столбец.
SelectedColumnName Имя выбранного столбца.
SelectedRow Выбранная строка.
SelectedRows Список выбранных строк.
SelectedRowsData Список выбранных строк в мастер-представлении или null.
SettingsAlias Глобально уникальный алиас настроек пользователя. Может быть пустой строкой.
Sorting Текущая сортировка.
StartAtNewLineПризнак того, что текущий контрол в блоке всегда начинается с новой строки.
(Унаследован от ControlViewModelBase)
StateRestoreMode Режим восстановления состояния элемента управления. По умолчанию имеет значение [StateRestoreMode.All].
(Унаследован от ControlViewModelBase)
Table Модель таблицы данных.
ToolTip Всплывающая подсказка для элемента управления или null, если подсказка отсутствует. Пустая строка или строка, состоящая из пробелов, присваивается как null.
(Унаследован от ControlViewModelBase)
TopContent Контент, отображаемый над основным содержимым.
TopContentVisible Признак отображения верхнего контента.
TopItems Дополнительные элементы над таблицей.
UIContextExecutorAsync Делегат, выполняющий заданное действие в контексте [Tessa.UI.IUIContext].
UILockNotifier 
UserSettings Настройки пользователя.
ValidationFunc Функция валидации, проверяющая элемент управления на корректность его значения, или null, если дополнительные проверки значения отсутствуют. Проверка на незаполненное значение всё равно выполняется, если элемент управления был отмечен как обязательный для заполнения (в т.ч. посредством валидатора). Для использования функции на элементе управления должна быть включена валидация [Tessa.UI.Cards.IControlViewModel.HasActiveValidation].
(Унаследован от ControlViewModelBase)
VerticalAlignment Выравнивание контрола по вертикали. По умолчанию контрол выравнивается по высоте Stretch.
(Унаследован от ControlViewModelBase)
ViewControlIsInitialized 
ViewMapping Настройки маппинга.
ViewMetadata Метаданные представления.

Методы

ApplyClientQuickSearch Применяет клиентский быстрый поиск.
CanGroupColumn Возвращает признак того, что по указанной колонке возможна группировка.
CanHideColumn Возвращает признак того, что указанную колонку можно скрыть.
CanResetGrouping Возвращает признак того, что группировку возможно сбросить.
ColumnsWidthSettingsAreDefault Возвращает признак того, что настройки пользователя UserSettings по ширине колонок не содержат изменений относительно значений по умолчанию.
CommitChangesAsync Подтверждает изменения для текущего элемента управления. Метод обычно вызывается перед сохранением карточки для того, чтобы элементы управления, у которых состояние ввода зависит от фокуса и других параметров, могли подтвердить введённое значение перед тем, как карточка будет сохранена. Если при выполнении этого метода возникнет исключение, то оно будет зафиксировано в результате.
(Унаследован от ControlViewModelBase)
CreateColumn Создаёт модель представления колонки в таблице TableColumnViewModel.
CreateParametersSettings 
EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
FinalizeAllows 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)
GetActualSortingSettings Возвращает список текущих колонок для сортировки.
GetColumnsWidthSettings Возвращает настройки пользователя UserSettings по изменению ширины указанных колонок: ColumnAlias - алиас колонки, ширина которой передаётся; Width - ширина колонки. Если колонка отсутствует в возвращённом списке, то её ширина должна быть рассчитана автоматически.
GetColumnWidthFromSettings Возвращает ширину указанной колонки из настроек пользователя UserSettings или null, если ширина колонки должна быть рассчитана автоматически.
GetContextMenuAsync Возвращает контекстное меню, доступное для текущей модели представления. Если возвращается null, пустая коллекция или коллекция из скрытых элементов, то меню при этом не отображается.
GetCurrentOrderedColumns Возвращает текущий упорядоченный список алиасов колонок для отображения.
GetDefaultGroupingFromMetadata Возвращает алиас колонки группировки по умолчанию в соответствии с метаинформацией или null, если по умолчанию группировка не выполняется.
GetDefaultOrderedColumnsFromMetadata Возвращает упорядоченный список алиасов колонок для отображения по умолчанию, т.е. в соответствии с метаинформацией.
GetDefaultSortingFromMetadata Возвращает список колонок для сортировки по умолчанию в соответствии с тем, как они указаны в метаинформации представления.
GetGroupingColumnSetting Возвращает алиас колонки, по которой должна выполняться группировка в соответствии с настройками пользователя UserSettings. Также возвращает признак того, что возвращённый алиас является алиасом, указанным по умолчанию в соответствии с метаинформацией (значение метода GetDefaultGroupingFromMetadata).
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetHiddenColumnsSetting Возвращает алиасы скрытых колонок в настройках пользователя UserSettings.
GetNestedVisibleBlocks Возвращает вложенные видимые блоки, принадлежащие этому контролу. Возвращает пустую коллекцию блоков в случае, если контрол не поддерживает вложенные блоки.
(Унаследован от ControlViewModelBase)
GetOrderedColumnsFromSettings Возвращает упорядоченный список алиасов колонок для отображения в соответствии с настройками UserSettings.
GetSortDirectionSetting Возвращает информацию по направлению сортировки для указанной колонки в соответствии с настройками пользователя или null, если сортировка не выполняется.
GetState Возвращает текущее состояние элемента управления. Может вернуть null, если элемент управления не имеет состояния.
(Унаследован от ControlViewModelBase)
GetTagsPosition Получает текущую позицию тегов.
GetTagsPositionFromSettings Возвращает позицию тегов в соответствии с настройками UserSettings.
GetTypeGets the Type of the current instance.
(Унаследован от Object)
HasEmptyValue Возвращает признак того, что элемент управления имеет пустое значение.
(Унаследован от ControlViewModelBase)
InitializeAsync Осуществляет инициализацию объекта.
InitializeCoreAsyncВыполняет асинхронную инициализацию объекта.
(Унаследован от ControlViewModelBase)
InitializeDefaultDoubleClickAction Инициализирует действие для двойного клика по умолчанию.
InitializeEventsSubscriptions Инициализирует подписки на события.
InitializeMasterLinks Инициализирует ссылки мастер-контрола.
InitializeOnTabAsync Отображает элементы графического интерфейса на вкладке. Используется, когда представления программное и иниициализация стратегии произошла после инициализации на вкладке стандартными средствами.
InitializeOtherViewControlsAsync Вызывает инициализацию элементов отображения представлений в карточке. По принципу кто первый встал тот и тапки греет. Необходимо для корректной инициализации ссылок на мастер представления. Т.к. мастер представление может быть не доступно на момент создания элемента отображения представления использующего его.
InitializeStrategyAsync Инициализирует стратегию создания вью-модели представления. DataProvider можно установить через свойство CardViewControlViewModel.DataProvider.
InitializeUserSettingsAsync Инициализирует настройки пользователя, применимые к данному элементу управления.
InitializeUserSettingsAsync(DictionaryString, Object)

Инициализирует настройки пользователя. Метод может определить настройки по умолчанию, если это требуется, а также обновить устаревшие свойства.

Если настроек у этого элемента управления ещё нет, то он получает пустую хеш-таблицу settings.

InPagingMode 
InternalRefreshAsync Обновляет таблицу данных.
InvalidateAutoSize Перерассчитывает ширину колонок если включена автоширина.
IsColumnHiddenSetting Возвращает признак того, что в настройках пользователя UserSettings указанная колонка отмечена как скрытая.
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
NotifyColumnsReorderedAsync Уведомляет о том, что порядок колонок был изменён пользователем.
NotifyTabDeselectedAsync Уведомляет текущий объект и все его дочерние объекты о том, что он располагался на выбранной вкладке, после чего выбрали другую вкладку.
(Унаследован от ControlViewModelBase)
NotifyTabSelectedAsync Уведомляет текущий объект и все его дочерние объекты о том, что он расположен в текущей выбранной вкладке. Событие для выбранной вкладки вызывается после того, как было вызвано событие TabDeselected для вкладки, которая перестала быть выбранной.
(Переопределяет ControlViewModelBaseNotifyTabSelectedAsync(ITabSelectedContext, CancellationToken))
NotifyUpdateValidation Уведомляет об изменении всех свойств, связанных с валидацией в элементе управления, даже если эти свойства не были изменены.
(Унаследован от ControlViewModelBase)
NotifyUserSettingsChangedAsync

Уведомляет систему о том, что настройки изменены. Реализация по умолчанию отмечает их для отправки на сервер, при этом сама отправка выполняется позже.

Метод не проверяет возможность для пользователя сохранить настройки EnableSavingSettings.

OnColumnWidthChangedAsync Метод, вызываемый при изменении ширины колонок. Изменения могут быть накоплены для нескольких колонок.
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)
OrderColumnsFromSettings Упорядочивает колонки в соответствии с алиасами колонок orderedColumns.
OrderedColumnsSettingsAreDefault Возвращает признак того, что настройки порядка колонок соответствуют значениям по умолчанию в UserSettings.
Rearrange Выполняет перерисовку содержимого в зависимости от состояния объекта с учётом дочерних объектов, в т.ч. от видимости дочерних вложенных форм при их наличии.
(Унаследован от ControlViewModelBase)
RearrangeChildren Выполняет перерисовку содержимого в зависимости от состояния дочерних объектов, в т.ч. от видимости дочерних вложенных форм при их наличии.
(Унаследован от ControlViewModelBase)
RearrangeSelf Выполняет перерисовку содержимого в зависимости от состояния объекта без учёта дочерних объектов.
(Унаследован от ControlViewModelBase)
RefreshAsync Вызывает обновление данных из представления.
ResetColumnsOrderingAsync

Восстанавливает порядок следования колонок в соответствии с текущим порядком GetCurrentOrderedColumns. Переключает выполнение в поток UI, если текущий поток не является таковым.

Вызовите метод после отображения скрытых колонок вследствие сброса группировки, отображения колонки через контекстное меню или сброса настроек пользователя.

ResetColumnsWidthSettings Сбрасывает настройки пользователя UserSettings по ширине колонок. При этом все колонки согласно настройкам должны иметь ширину по умолчанию. Возвращает признак того, что настройки пользователя были изменены.
ResetGroupingAsync Сбрасывает группировку. Возвращает признак того, что настройки пользователя были изменены (необязательно сохранены, это определяется свойствами EnableSavingSettings, AutoSaveSettings, и параметром skipAutoSave).
ResetGroupingColumnSetting Сбрасывает группировку в настройках пользователя UserSettings так, что отсутствуют группирующие колонки. При этом группировка по умолчанию GetDefaultGroupingFromMetadata не учитывается. Возвращает признак того, что настройки были изменены.
ResetSortingSettings Сбрасывает настройки пользователя по сортировке в соответствии с текущим состоянием элемента управления. Возвращает признак того, что настройки были изменены.
ResetUserSettingsAsync Сбрасывает все настройки пользователя к значениям по умолчанию. Возвращает признак того, что настройки пользователя были изменены (необязательно сохранены, это определяется свойствами EnableSavingSettings, AutoSaveSettings, и параметром skipAutoSave).
SaveUserSettingsAsync

Отмечает настройки пользователя UserSettings для текущего элемента управления как изменённые и отправляет их для сохранения на сервере, если установлен флаг EnableSavingSettings или параметр force, в противном случае настройки не будут сохранены.

Фактическое сохранение настроек будут выполнено позже в фоновом обработчике.

SetBlockУстанавливает блок, в котором размещён элемент управления.
(Унаследован от ControlViewModelBase)
SetColumnIsHiddenSetting Определяет в настройках пользователя UserSettings, что указанная колонка является или не является скрытой. Возвращает признак того, что настройки были изменены.
SetColumnVisibilityAsync Отображает или скрывает указанную колонку. Возвращает признак того, что настройки пользователя были изменены (необязательно сохранены, это определяется свойствами EnableSavingSettings, AutoSaveSettings, и параметром skipAutoSave).
SetGroupingColumnAsync Выполняет группировку по указанной колонке. Возвращает признак того, что настройки пользователя были изменены (необязательно сохранены, это определяется свойствами EnableSavingSettings, AutoSaveSettings, и параметром skipAutoSave).
SetGroupingColumnSetting Определяет в настройках пользователя UserSettings, что по указанной колонке выполняется группировка. Возвращает признак того, что настройки были изменены.
SetHasUnsavedSettingsAsync Устанавливает значение свойства HasUnsavedSettings. Уведомление об изменении значения может быть выполнено после переключения в поток UI.
SetSorting Устанавливает режим сортировки для списка столбцов columns
SetSortingFromSettings Устанавливает значение объекта Sorting и колонок сортировки в соответствии с текущим состоянием объекта настроек.
SetStateAsyncУстанавливает заданное состояние элемента управления.
(Унаследован от ControlViewModelBase)
SetTagsPositionAsync Меняет положение тегов. Возвращает признак того, что настройки пользователя были изменены (необязательно сохранены, это определяется свойствами EnableSavingSettings, AutoSaveSettings, и параметром skipAutoSave).
SetTagsPositionSetting Определяет в настройках пользователя UserSettings позицию тегов. Возвращает признак того, что настройки были изменены.
SortColumnAsync Вызывается при сортировке по указанному столбцу.
SortingSettingsAreDefault Возвращает признак того, что настройки сортировки соответствуют значениям по умолчанию в UserSettings.
ToStringReturns a string that represents the current object.
(Унаследован от Object)
UnloadAsync Выполняет выгрузку объекта. Если объект уже был выгружен, то повторная выгрузка не выполняется.
(Унаследован от SupportUnloadingViewModel)
UpdateColumnsWidthSettings Обновляет настройки пользователя UserSettings по изменению ширины указанных колонок. Возвращает признак того, что настройки пользователя были изменены.
UpdateColumnsWidthSettingsWithSavingCheckAsync Обновляет настройки пользователя UserSettings по изменению ширины указанных колонок. Устанавливает признак того, что в элементе управления имеются несохранённые настройки. Возвращает признак того, что настройки пользователя были изменены (необязательно сохранены, это определяется свойствами EnableSavingSettings, AutoSaveSettings, и параметром skipAutoSave).
UpdateOrderedColumnsSettings Обновляет настройки пользователя UserSettings по указанному порядку следования алиасов колонок. Возвращает признак того, что настройки пользователя были изменены.
UpdateOrderedColumnsSettingsWithSavingCheckAsync Обновляет настройки пользователя UserSettings по указанному порядку следования алиасов колонок. Устанавливает признак того, что в элементе управления имеются несохранённые настройки. Возвращает признак того, что настройки пользователя были изменены (необязательно сохранены, это определяется свойствами EnableSavingSettings, AutoSaveSettings, и параметром skipAutoSave).
UpdatePageCount Обновляет количество страниц
UpdateSortingSettings Обновляет настройки пользователя по сортировке UserSettings в соответствии с текущим состоянием элемента управления. Возвращает признак того, что настройки были изменены.
UpdateSortingSettingsWithSavingCheckAsync Обновляет настройки пользователя UserSettings по сортировке в соответствии с текущим состоянием элемента управления. Устанавливает признак того, что в элементе управления имеются несохранённые настройки. Возвращает признак того, что настройки пользователя были изменены (необязательно сохранены, это определяется свойствами EnableSavingSettings, AutoSaveSettings, и параметром skipAutoSave).
UserSettingsAreDefault Возвращает признак того, что в элементе управления отсутствуют применённые настройки пользователя.

События

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

Поля

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

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

Get
(Определяется ComHelper)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)

См. также