Для изменения размера нажмите или перетащите

ControlViewModelBase - класс

Базовый класс для моделей представления элементов управления в автоматическом UI карточки.
Иерархия наследования
SystemObject
  Tessa.PlatformNotificationObject
    Tessa.UIViewModelEmptyModel
      Tessa.UISupportUnloadingViewModel
        Tessa.UI.Cards.ControlsControlViewModelBase
          Подробнее...

Пространство имён:  Tessa.UI.Cards.Controls
Сборка:  Tessa.UI (в Tessa.UI.dll) Версия: 3.5.0.19
Синтаксис
public abstract class ControlViewModelBase : SupportUnloadingViewModel, 
	IControlViewModel, INotifyPropertyChanged, ISupportTabNotifications, ISupportUnloading, IDataErrorInfo, 
	IAsyncInitializable

Тип ControlViewModelBase предоставляет следующие члены.

Конструкторы
  ИмяОписание
Защищённый методControlViewModelBase
Создаёт экземпляр класса с указанием метаинформации об элементе управления.
В начало страницы
Свойства
  ИмяОписание
Открытое свойствоActualMargin
Предпочитаемый отступ элемента управления относительно других элементов управления, расчитываемый блоком и используемый при отображении. Не рекомендуется вручную изменять это значение.
Открытое свойствоBlock
Блок, в котором размещён текущий элемент управления.
Открытое свойствоCaption
Заголовок элемента управления.
Открытое свойствоCaptionStyle
Стиль текста для заголовка контрола.
Открытое свойствоCaptionVisibility
Видимость заголовка элемента управления.
Открытое свойствоCardTypeControl
Информация о типе отображаемого элемента управления.
Открытое свойствоColumnSpan
Количество колонок, которые занимает контрол по горизонтали. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 1 и не может быть меньше. Если заданное количество колонок больше, чем общее количество колонок в блоке, то контрол растягивается на ширину строки.
Открытое свойствоControlVisibility
Видимость элемента управления.
Открытое свойствоEmptyColumnsToTheLeft
Количество пустых колонок, которые отображаются слева от контрола. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 0 и не может быть меньше. Если заданное количество колонок больше, чем количество колонок в блоке минус количество колонок, занимаемых контролом, то отрисовывается столько пустых колонок, сколько умещается в строке. Если контрол рисуется не с начала строки, и он не умещается вместе с заданным отступом, то он переносится на следующую строку.
Открытое свойствоError
Сообщение об ошибке, связанное с текущим объектом, или null, если ошибки нет.
Открытое свойствоFocusable
Признак того, что элемент управления может иметь логический фокус.
Открытое свойствоFocusPending
Признак того, что элемент управления получит логический фокус, как только элемент управления станет доступен, т.е. его свойство [Tessa.UI.Cards.IControlViewModel.IsEnabled] будет равно true.
Открытое свойствоHasActiveValidation
Признак того, что в элементе управления следует включить активную валидацию. При этом если для элемента управления введено некорректное значение, то он будет уведомлять об этом рамкой валидации. Значение устанавливливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false.
Открытое свойствоHorizontalAlignment
Выравнивание контрола по горизонтали. По умолчанию контрол выравнивается по ширине Stretch.
Защищённое свойствоInitialized
Признак того, что форма уже инициализирована вызовом InitializeAsync(CancellationToken), поэтому повторные вызовы метода будут игнорироваться.
Открытое свойствоIsEmpty
Признак того, что элемент управления не содержит отображаемых данных.
Открытое свойствоIsEnabled
Признак того, что элемент управления доступен для взаимодействия. Только доступный элемент может получить логический фокус. Свойство следует использовать только для чтения, т.е. можно проверить его значение и подписаться на его изменение в PropertyChanged, но установленное в свойстве значение будет проигнорировано.
Открытое свойствоIsFocused
Признак того, что элемент управления имеет логический фокус. Проверка и установка значения свойства имеет смысл только в случае, если элемент управления может получить логический фокус, т.е. значение свойства [Tessa.UI.Cards.IControlViewModel.Focusable] равно true.
Открытое свойствоIsReadOnly
Признак того, что элемент управления доступен только для чтения или не содержит редактируемых данных. Для контрола "Кнопка" разрешает или запрещает нажатие по кнопке.
Открытое свойствоIsRequired
Признак того, что элемент управления отмечен, как обязательный для заполнения.
Открытое свойствоIsSpanned
Признак того, что элемент управления должен быть растянут на ширину колонки при выводе в несколько колонок.
Открытое свойствоIsUnloaded
Признак того, что объект был выгружен и уже не может использоваться в UI. Например, если объект является контролом карточки, то он становится выгруженным после закрытия формы редактирования строки или пре рефреше карточки.
(Унаследован от SupportUnloadingViewModel.)
Открытое свойствоIsVisibilityRearranged
Признак того, что видимость элемента управления была изменена в процессе перерисовки содержимого. Поле используется системой и сбрасывается в false при ручном изменении видимости.
Открытое свойствоItem
Сообщение об ошибке, связанное со свойством текущего объекта, или null, если ошибки нет.
Открытое свойствоMargin
Заданный в настройках отступ элемента управления относительно других элементов управления. По умолчанию отступ отсутствует. Если по одному из направлений (слева, сверху и пр.) задано отрицательное значение, то по этому направлению отступ не отображается (т.е. равен 0).
Открытое свойствоMaxWidth
Максимальная ширина контрола. По умолчанию значение равно double.PositiveInfinity. Значение не может быть меньше 0. При установке значения 0 в действительности устанавливается double.PositiveInfinity, т.к. в настройках контрола 0 эквивалентно отсутствию ограничения на контрол.
Открытое свойствоMinWidth
Минимальная ширина контрола. По умолчанию значение равно 0 и не может быть меньше.
Открытое свойствоModel
Модель для текущей модели представления.
(Унаследован от ViewModelTModel.)
Открытое свойствоName
Имя элемента управления, по которому он доступен в коллекции, или null, если у элемента управления не задано имя.
Открытое свойствоRequiredText
Текст валидации обязательного для заполнения элемента.
Открытое свойствоScope (Унаследован от ViewModelTModel.)
Открытое свойствоStartAtNewLine
Признак того, что текущий контрол в блоке всегда начинается с новой строки.
Открытое свойствоToolTip
Всплывающая подсказка для элемента управления или null, если подсказка отсутствует. Пустая строка или строка, состоящая из пробелов, присваивается как null.
Открытое свойствоValidationFunc
Функция валидации, проверяющая элемент управления на корректность его значения, или null, если дополнительные проверки значения отсутствуют. Проверка на незаполненное значение всё равно выполняется, если элемент управления был отмечен как обязательный для заполнения (в т.ч. посредством валидатора). Для использования функции на элементе управления должна быть включена валидация [Tessa.UI.Cards.IControlViewModel.HasActiveValidation].
Открытое свойствоVerticalAlignment
Выравнивание контрола по вертикали. По умолчанию контрол выравнивается по высоте Stretch.
В начало страницы
Методы
  ИмяОписание
Открытый методCommitChangesAsync
Подтверждает изменения для текущего элемента управления. Метод обычно вызывается перед сохранением карточки для того, чтобы элементы управления, у которых состояние ввода зависит от фокуса и других параметров, могли подтвердить введённое значение перед тем, как карточка будет сохранена. Если при выполнении этого метода возникнет исключение, то оно будет зафиксировано в результате.
Открытый метод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.
Открытый методGetHashCode
Serves as the default hash function.
(Унаследован от Object.)
Открытый методGetState
Возвращает текущее состояние элемента управления. Может вернуть null, если элемент управления не имеет состояния.
Открытый методGetType
Gets the Type of the current instance.
(Унаследован от Object.)
Открытый методHasEmptyValue
Возвращает признак того, что элемент управления имеет пустое значение.
Защищённый методInitializeCoreAsync
Выполняет асинхронную инициализацию объекта.
Защищённый методMemberwiseClone
Creates a shallow copy of the current Object.
(Унаследован от Object.)
Открытый методNotifyTabDeselectedAsync
Уведомляет текущий объект и все его дочерние объекты о том, что он располагался на выбранной вкладке, после чего выбрали другую вкладку.
Открытый методNotifyTabSelectedAsync
Уведомляет текущий объект и все его дочерние объекты о том, что он расположен в текущей выбранной вкладке. Событие для выбранной вкладки вызывается после того, как было вызвано событие TabDeselected для вкладки, которая перестала быть выбранной.
Открытый методNotifyUpdateValidation
Уведомляет об изменении всех свойств, связанных с валидацией в элементе управления, даже если эти свойства не были изменены.
Защищённый методOnModelPropertyChanged (Унаследован от ViewModelTModel.)
Защищённый методOnPropertyChanged(PropertyChangedEventArgs)
Уведомляет об изменении свойства с именем, заданным в аргументах события.
(Унаследован от NotificationObject.)
Защищённый методOnPropertyChanged(String)
Уведомляет об изменении свойства с заданным именем у объекта.
(Унаследован от NotificationObject.)
Защищённый методOnPropertyChangedAsync(String, Boolean)
Уведомляет об изменении свойства с заданным именем у объекта асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationObject.)
Защищённый методOnPropertyChangedAsync(PropertyChangedEventArgs, Boolean)
Уведомляет об изменении свойства с именем, заданным в аргументах события, асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от ViewModelTModel.)
Защищённый методOnReceiveWeakEvent (Унаследован от ViewModelTModel.)
Защищённый методOnUnloadingAsync
Метод вызывается в процессе выгрузки объекта и выполняет некоторую обработку, например, отписывается от событий и выгружает дочерние объекты (например, контролы в блоке). Исключения в процесс выполнения метода будут поглощены и добавлены в лог.
(Унаследован от SupportUnloadingViewModel.)
Открытый методRearrange
Выполняет перерисовку содержимого в зависимости от состояния объекта с учётом дочерних объектов, в т.ч. от видимости дочерних вложенных форм при их наличии.
Открытый методRearrangeChildren
Выполняет перерисовку содержимого в зависимости от состояния дочерних объектов, в т.ч. от видимости дочерних вложенных форм при их наличии.
Открытый методRearrangeSelf
Выполняет перерисовку содержимого в зависимости от состояния объекта без учёта дочерних объектов.
Защищённый методSetT (Унаследован от ViewModelTModel.)
Открытый методSetBlock
Устанавливает блок, в котором размещён элемент управления.
Открытый методSetStateAsync
Устанавливает заданное состояние элемента управления.
Открытый методToString
Returns a string that represents the current object.
(Унаследован от Object.)
Открытый методUnloadAsync
Выполняет выгрузку объекта. Если объект уже был выгружен, то повторная выгрузка не выполняется.
(Унаследован от SupportUnloadingViewModel.)
В начало страницы
События
  ИмяОписание
Открытое событиеPropertyChanged
Событие, уведомляющее об изменении свойства с определённым именем у модели представления.
(Унаследован от NotificationObject.)
Открытое событиеTabDeselected
Событие, происходящее для объекта, который располагался на выбранной вкладке, после чего выбрали другую вкладку.
Открытое событиеTabSelected
Событие, происходящее при переходе объекта на выбранную вкладку. Событие для выбранной вкладки вызывается после того, как было вызвано событие TabDeselected для вкладки, которая перестала быть выбранной.
Открытое событиеUnloaded
Событие, возникающее после того, как объект был выгружен и уже не может использоваться в UI. Если на некоторые свойства объекта, связанные с UI, выполнялась подписка, то в обработчике события можно выполнить отписку, а также удалить сам обработчик.
(Унаследован от SupportUnloadingViewModel.)
В начало страницы
Поля
  ИмяОписание
Защищённое полеActualMarginInternal
Предпочитаемый отступ элемента управления относительно других элементов управления, расчитываемый блоком и используемый при отображении. Не рекомендуется вручную изменять это значение.
Защищённое полеBlockInternal
Блок, в котором размещён текущий элемент управления.
Защищённое полеCaptionInternal
Заголовок элемента управления.
Защищённое полеCaptionVisibilityInternal
Видимость заголовка элемента управления.
Защищённое полеColumnSpanInternal
Количество колонок, которые занимает контрол по горизонтали. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 1 и не может быть меньше. Если заданное количество колонок больше, чем общее количество колонок в блоке, то контрол растягивается на ширину строки.
Защищённое полеControlVisibilityInternal
Видимость элемента управления.
Защищённое полеEmptyColumnsToTheLeftInternal
Количество пустых колонок, которые отображаются слева от контрола. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 0 и не может быть меньше. Если заданное количество колонок больше, чем количество колонок в блоке минус количество колонок, занимаемых контролом, то отрисовывается столько пустых колонок, сколько умещается в строке. Если контрол рисуется не с начала строки, и он не умещается вместе с заданным отступом, то он переносится на следующую строку.
Защищённое полеHasActiveValidationInternal
Признак того, что в элементе управления следует включить активную валидацию. При этом если для элемента управления введено некорректное значение, то он будет уведомлять об этом рамкой валидации. Значение устанавливливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false.
Защищённое полеHorizontalAlignmentInternal
Выравнивание контрола по горизонтали. По умолчанию контрол выравнивается по ширине Stretch.
Защищённое полеIsReadOnlyInternal
Признак того, что элемент управления доступен только для чтения или не содержит редактируемых данных. Для контрола "Кнопка" разрешает или запрещает нажатие по кнопке.
Защищённое полеIsRequiredInternal
Признак того, что элемент управления отмечен, как обязательный для заполнения.
Защищённое полеIsSpannedInternal
Признак того, что элемент управления должен быть растянут на ширину колонки при выводе в несколько колонок.
Защищённое полеMarginInternal
Заданный в настройках отступ элемента управления относительно других элементов управления. По умолчанию отступ отсутствует. Если по одному из направлений (слева, сверху и пр.) задано отрицательное значение, то по этому направлению отступ не отображается (т.е. равен 0).
Защищённое полеMaxWidthInternal
Максимальная ширина контрола. По умолчанию значение равно double.PositiveInfinity. Значение не может быть меньше 0. При установке значения 0 в действительности устанавливается double.PositiveInfinity, т.к. в настройках контрола 0 эквивалентно отсутствию ограничения на контрол.
Защищённое полеMinWidthInternal
Минимальная ширина контрола. По умолчанию значение равно 0 и не может быть меньше.
Защищённое полеStartAtNewLineInternal
Признак того, что текущий контрол в блоке всегда начинается с новой строки.
Защищённое полеToolTipInternal
Всплывающая подсказка для элемента управления или null, если подсказка отсутствует. Пустая строка или строка, состоящая из пробелов, присваивается как null.
Защищённое полеValidationFuncInternal
Признак того, что в элементе управления следует включить активную валидацию. При этом если для элемента управления введено некорректное значение, то он будет уведомлять об этом рамкой валидации. Значение устанавливливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false.
Защищённое полеVerticalAlignmentInternal
Выравнивание контрола по вертикали. По умолчанию контрол выравнивается по высоте Stretch.
В начало страницы
Методы расширения
  ИмяОписание
Открытый метод расширенияGet (Определяется ComHelper.)
Открытый метод расширенияInternalMarkerCanvas
Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor.)
Открытый метод расширенияInvoke (Определяется ComHelper.)
Открытый метод расширенияSelectAll
Выделяет весь текст в контроле, если контрол поддерживает выделение текста посредством интерфейса ISupportSelectAll. Возвращает признак того, что текст действительно был выделен.
(Определяется CardUIExtensions.)
Открытый метод расширенияSelectAllWhenFocused
Устанавливает, что для контрола будет выделен весь текст, если он получает фокус. Возвращает признак того, что тип контрола совместим с методом выделением текста. Метод можно вызывать несколько раз для одного и того же контрола.
(Определяется CardUIExtensions.)
Открытый метод расширенияSet (Определяется ComHelper.)
Открытый метод расширенияUnloadAsync
Выполняет выгрузку объекта. Если объект уже был выгружен, то повторная выгрузка не выполняется. Возвращает объект, содержащий сообщения, возникшие в процессе выгрузки, в т.ч. ошибки.
(Определяется UIExtensions.)
В начало страницы
См. также
Иерархия наследования
SystemObject
  Tessa.PlatformNotificationObject
    Tessa.UIViewModelEmptyModel
      Tessa.UISupportUnloadingViewModel
        Tessa.UI.Cards.ControlsControlViewModelBase
          Tessa.UI.Cards.ControlsButtonViewModel
          Tessa.UI.Cards.ControlsCardViewControlViewModel
          Tessa.UI.Cards.ControlsCheckBoxViewModel
          Tessa.UI.Cards.ControlsContainerViewModel
          Tessa.UI.Cards.ControlsDateTimeViewModel
          Tessa.UI.Cards.ControlsFileListViewModel
          Tessa.UI.Cards.ControlsFilePreviewViewModel
          Tessa.UI.Cards.ControlsGridViewModel
          Tessa.UI.Cards.ControlsTabControlViewModel
          Tessa.UI.Cards.ControlsTaskInfoViewModel
          Tessa.UI.Cards.ControlsTextBlockViewModelBase
          Tessa.UI.Cards.ControlsUnknownControlViewModel
          Tessa.UI.Cards.Controls.WorkflowParametrizedControlViewModel
          Tessa.UI.CardsSupportSelectAllControlViewModelBase
          Tessa.UI.Controls.CustomRichTextBoxCtrlCustomRichTextBoxViewModel
          Tessa.UI.Controls.ForumsForumControlViewModel