TextBoxViewModel - класс

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

Definition

Пространство имён: Tessa.UI.Cards.Controls
Сборка: Tessa.UI (в Tessa.UI.dll) Версия: 3.6.0.22
C#
public sealed class TextBoxViewModel : TextBoxViewModelBase
Inheritance
Object    NotificationObject    NotificationUIObject    SupportUnloadingViewModel    ControlViewModelBase    SupportSelectAllControlViewModelBase    TextBoxViewModelBase    TextBoxViewModel

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

TextBoxViewModelСоздаёт экземпляр класса с указанием метаинформации по элементу управления и модели карточки.

Свойства

ActualMargin Предпочитаемый отступ элемента управления относительно других элементов управления, расчитываемый блоком и используемый при отображении. Не рекомендуется вручную изменять это значение.
(Унаследован от ControlViewModelBase)
BlockБлок, в котором размещён текущий элемент управления.
(Унаследован от ControlViewModelBase)
CanResizeFont Признак того, что включено изменение размера шрифта для контрола с использованием Ctrl+колеса мыши. По умолчанию значение true.
(Унаследован от TextBoxViewModelBase)
CaptionЗаголовок элемента управления.
(Унаследован от ControlViewModelBase)
CaptionStyleСтиль текста для заголовка контрола.
(Унаследован от ControlViewModelBase)
CaptionVisibilityВидимость заголовка элемента управления.
(Унаследован от ControlViewModelBase)
CardTypeControlИнформация о типе отображаемого элемента управления.
(Унаследован от ControlViewModelBase)
ColumnSpan Количество колонок, которые занимает контрол по горизонтали. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 1 и не может быть меньше. Если заданное количество колонок больше, чем общее количество колонок в блоке, то контрол растягивается на ширину строки.
(Унаследован от ControlViewModelBase)
ControlVisibilityВидимость элемента управления.
(Унаследован от ControlViewModelBase)
DefaultFieldName Имя редактируемого поля.
(Унаследован от TextBoxViewModelBase)
DefaultFieldType Тип редактируемого поля.
(Унаследован от TextBoxViewModelBase)
DisplayFormat Формат поля. Применяется только в случае, когда контрол доступен только для чтения. Значение null или пустая строка определяют отсутствие дополнительного форматирования.
(Унаследован от TextBoxViewModelBase)
EmptyColumnsToTheLeft Количество пустых колонок, которые отображаются слева от контрола. Неактуально для контролов, растягиваемых по ширине всей строки. По умолчанию значение равно 0 и не может быть меньше. Если заданное количество колонок больше, чем количество колонок в блоке минус количество колонок, занимаемых контролом, то отрисовывается столько пустых колонок, сколько умещается в строке. Если контрол рисуется не с начала строки, и он не умещается вместе с заданным отступом, то он переносится на следующую строку.
(Унаследован от ControlViewModelBase)
Error Сообщение об ошибке, связанное с текущим объектом, или null, если ошибки нет.
(Унаследован от ControlViewModelBase)
ExpandButtonCommand Команда, выполняемая при нажатии кнопки разворачивания строки для редактирования в отдельном окне. Для изменения поведения команды используйте свойства объекта ExpandButtonCommandClosure.
(Унаследован от TextBoxViewModelBase)
ExpandButtonCommandClosure Объект, через свойства которого можно изменить поведение команды ExpandButtonCommand.
(Унаследован от TextBoxViewModelBase)
Fields Поля строковой секции или поля строки коллекционной секции.
(Унаследован от TextBoxViewModelBase)
FocusableПризнак того, что элемент управления может иметь логический фокус.
(Унаследован от TextBoxViewModelBase)
FocusPending Признак того, что элемент управления получит логический фокус, как только элемент управления станет доступен, т.е. его свойство [Tessa.UI.Cards.IControlViewModel.IsEnabled] будет равно true.
(Унаследован от ControlViewModelBase)
HasActiveValidation Признак того, что в элементе управления следует включить активную валидацию. При этом если для элемента управления введено некорректное значение, то он будет уведомлять об этом рамкой валидации. Значение устанавливливается равным true обычно после неудачного сохранения карточки. По умолчанию значение равно false.
(Унаследован от ControlViewModelBase)
HorizontalAlignment Выравнивание контрола по горизонтали. По умолчанию контрол выравнивается по ширине Stretch.
(Унаследован от ControlViewModelBase)
Initialized Признак того, что форма уже инициализирована вызовом InitializeAsync(CancellationToken), поэтому повторные вызовы метода будут игнорироваться.
(Унаследован от ControlViewModelBase)
IsEmptyПризнак того, что элемент управления не содержит отображаемых данных.
(Унаследован от ControlViewModelBase)
IsEnabled Признак того, что элемент управления доступен для взаимодействия. Только доступный элемент может получить логический фокус. Свойство следует использовать только для чтения, т.е. можно проверить его значение и подписаться на его изменение в PropertyChanged, но установленное в свойстве значение будет проигнорировано.
(Унаследован от ControlViewModelBase)
IsFocused Признак того, что элемент управления имеет логический фокус. Проверка и установка значения свойства имеет смысл только в случае, если элемент управления может получить логический фокус, т.е. значение свойства [Tessa.UI.Cards.IControlViewModel.Focusable] равно true.
(Унаследован от ControlViewModelBase)
IsReadOnly Признак того, что элемент управления доступен только для чтения или не содержит редактируемых данных. Для контрола "Кнопка" разрешает или запрещает нажатие по кнопке.
(Унаследован от ControlViewModelBase)
IsRequired Признак того, что элемент управления отмечен, как обязательный для заполнения.
(Унаследован от ControlViewModelBase)
IsSpanned Признак того, что элемент управления должен быть растянут на ширину колонки при выводе в несколько колонок.
(Унаследован от ControlViewModelBase)
IsUnloaded Признак того, что объект был выгружен и уже не может использоваться в UI. Например, если объект является контролом карточки, то он становится выгруженным после закрытия формы редактирования строки или пре рефреше карточки.
(Унаследован от SupportUnloadingViewModel)
IsVisibilityRearranged Признак того, что видимость элемента управления была изменена в процессе перерисовки содержимого. Поле используется системой и сбрасывается в false при ручном изменении видимости.
(Унаследован от ControlViewModelBase)
Item Сообщение об ошибке, связанное со свойством текущего объекта, или null, если ошибки нет.
(Унаследован от ControlViewModelBase)
KeyDownCommand Команда, вызываемая при нажатии на клавишу для элемента управления.
(Унаследован от TextBoxViewModelBase)
Margin Заданный в настройках отступ элемента управления относительно других элементов управления. По умолчанию отступ отсутствует. Если по одному из направлений (слева, сверху и пр.) задано отрицательное значение, то по этому направлению отступ не отображается (т.е. равен 0).
(Унаследован от ControlViewModelBase)
MaxLength Максимальная длина введённой текстовой строки.
(Унаследован от TextBoxViewModelBase)
MaxRows Максимальнное количество строк.
(Унаследован от TextBoxViewModelBase)
MaxWidth Максимальная ширина контрола. По умолчанию значение равно double.PositiveInfinity. Значение не может быть меньше 0. При установке значения 0 в действительности устанавливается double.PositiveInfinity, т.к. в настройках контрола 0 эквивалентно отсутствию ограничения на контрол.
(Унаследован от ControlViewModelBase)
MinRows Минимальное количество строк.
(Унаследован от TextBoxViewModelBase)
MinWidth Минимальная ширина контрола. По умолчанию значение равно 0 и не может быть меньше.
(Унаследован от ControlViewModelBase)
Name Имя элемента управления, по которому он доступен в коллекции, или null, если у элемента управления не задано имя.
(Унаследован от ControlViewModelBase)
RequiredText Текст валидации обязательного для заполнения элемента.
(Унаследован от ControlViewModelBase)
SelectAllCommand Команда, при выполнении которой выделяется весь текст в контроле. Не рекомендуется изменять и использовать свойство. Оно необходимо для корректного функционирования контрола.
(Унаследован от SupportSelectAllControlViewModelBase)
SetupExpandedControlAction Метод, вызываемый для настройки контрола, отображаемого в режиме разворачивания для редактирования в отдельном окне, т.е. при нажатии на кнопку разворачивания ExpandButtonCommand. Модель представления полученного контрола можно модифицировать любым подходящим образом.
(Унаследован от TextBoxViewModelBase)
ShowExpandButton Признак того, что необходимо показать кнопку сворачивания/разворачивания окна редактирования.
(Унаследован от TextBoxViewModelBase)
SpellCheck Признак необходимости проверки орфографии при редактировании.
StartAtNewLineПризнак того, что текущий контрол в блоке всегда начинается с новой строки.
(Унаследован от ControlViewModelBase)
Text
(Переопределяет TextBoxViewModelBaseText)
TextStyle Стиль текста, который вводится пользователем или выводится для пользователя.
(Унаследован от TextBoxViewModelBase)
TextWrap Признак необходимости переноса строк.
(Унаследован от TextBoxViewModelBase)
ToolTip Всплывающая подсказка для элемента управления или null, если подсказка отсутствует. Пустая строка или строка, состоящая из пробелов, присваивается как null.
(Унаследован от ControlViewModelBase)
ValidationFunc Функция валидации, проверяющая элемент управления на корректность его значения, или null, если дополнительные проверки значения отсутствуют. Проверка на незаполненное значение всё равно выполняется, если элемент управления был отмечен как обязательный для заполнения (в т.ч. посредством валидатора). Для использования функции на элементе управления должна быть включена валидация [Tessa.UI.Cards.IControlViewModel.HasActiveValidation].
(Унаследован от ControlViewModelBase)
VerticalAlignment Выравнивание контрола по вертикали. По умолчанию контрол выравнивается по высоте Stretch.
(Унаследован от ControlViewModelBase)

Методы

CommitChangesAsync Подтверждает изменения для текущего элемента управления. Метод обычно вызывается перед сохранением карточки для того, чтобы элементы управления, у которых состояние ввода зависит от фокуса и других параметров, могли подтвердить введённое значение перед тем, как карточка будет сохранена. Если при выполнении этого метода возникнет исключение, то оно будет зафиксировано в результате.
(Унаследован от ControlViewModelBase)
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)
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetLocalizedValueText Возвращает локализованую строку в соответствии с форматом поля.
(Унаследован от TextBoxViewModelBase)
GetState Возвращает текущее состояние элемента управления. Может вернуть null, если элемент управления не имеет состояния.
(Унаследован от ControlViewModelBase)
GetTypeGets the Type of the current instance.
(Унаследован от Object)
HasEmptyValue Возвращает признак того, что элемент управления имеет пустое значение.
(Унаследован от TextBoxViewModelBase)
InitializeCoreAsync
(Переопределяет TextBoxViewModelBaseInitializeCoreAsync(CancellationToken))
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
NotifyTabDeselectedAsync Уведомляет текущий объект и все его дочерние объекты о том, что он располагался на выбранной вкладке, после чего выбрали другую вкладку.
(Унаследован от ControlViewModelBase)
NotifyTabSelectedAsync Уведомляет текущий объект и все его дочерние объекты о том, что он расположен в текущей выбранной вкладке. Событие для выбранной вкладки вызывается после того, как было вызвано событие TabDeselected для вкладки, которая перестала быть выбранной.
(Унаследован от ControlViewModelBase)
NotifyUpdateValidation Уведомляет об изменении всех свойств, связанных с валидацией в элементе управления, даже если эти свойства не были изменены.
(Унаследован от TextBoxViewModelBase)
OnPropertyChanged(PropertyChangedEventArgs) Уведомляет об изменении свойства с именем, заданным в аргументах события.
(Унаследован от NotificationObject)
OnPropertyChanged(String) Уведомляет об изменении свойства с заданным именем у объекта.
(Унаследован от NotificationObject)
OnPropertyChangedAsync(PropertyChangedEventArgs, Boolean) Уведомляет об изменении свойства с именем, заданным в аргументах события, асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationUIObject)
OnPropertyChangedAsync(String, Boolean) Уведомляет об изменении свойства с заданным именем у объекта асинхронно, в соответствии с принятым для текущего объекта поведением. Если есть возможность вызвать событие синхронно, то оно вызывается синхронно. Если объект является моделью представления WPF и текущий поток отличен от потока диспетчера WPF для приложения (основной поток UI), то выполнение асинхронно переключается в этот поток. Если это не так, то событие выполняется синхронно.
(Унаследован от NotificationObject)
OnTextChanged Метод, вызываемый при изменении текста из модели карточки. Для актуального значения требуется запросить свойство [TextBoxViewModelBase.Text].
(Переопределяет TextBoxViewModelBaseOnTextChanged)
OnUnloadingAsync Метод вызывается в процессе выгрузки объекта и выполняет некоторую обработку, например, отписывается от событий и выгружает дочерние объекты (например, контролы в блоке). Исключения в процесс выполнения метода будут поглощены и добавлены в лог.
(Унаследован от TextBoxViewModelBase)
Rearrange Выполняет перерисовку содержимого в зависимости от состояния объекта с учётом дочерних объектов, в т.ч. от видимости дочерних вложенных форм при их наличии.
(Унаследован от ControlViewModelBase)
RearrangeChildren Выполняет перерисовку содержимого в зависимости от состояния дочерних объектов, в т.ч. от видимости дочерних вложенных форм при их наличии.
(Унаследован от ControlViewModelBase)
RearrangeSelf Выполняет перерисовку содержимого в зависимости от состояния объекта без учёта дочерних объектов.
(Унаследован от ControlViewModelBase)
SetBlockУстанавливает блок, в котором размещён элемент управления.
(Унаследован от ControlViewModelBase)
SetStateAsyncУстанавливает заданное состояние элемента управления.
(Унаследован от ControlViewModelBase)
ToStringReturns a string that represents the current object.
(Унаследован от Object)
UnloadAsync Выполняет выгрузку объекта. Если объект уже был выгружен, то повторная выгрузка не выполняется.
(Унаследован от SupportUnloadingViewModel)

События

KeyDown Обработчик нажатия клавиши для элемента управления.
(Унаследован от TextBoxViewModelBase)
PropertyChangedСобытие, уведомляющее об изменении свойства с определённым именем у модели представления.
(Унаследован от NotificationObject)
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)

См. также