Class CardTypeCustomControl

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

Hierarchy

Implements

Constructors

constructor

Properties

caption flags name requiredText toolTip

Accessors

blockSettings controlSettings type

Methods

clone deserializeFromStorage getSourceInfo isRequired isSealed isVisible seal serializeToStorage setRequired setVisible

Constructors

constructor

Properties

caption

caption: null | string = null

Отображаемое имя объекта.

flags

flags: CardTypeCustomControlFlags = 0

Флаги, определяющие дополнительные атрибуты.

Remarks

Настройки, связанные с UI.

name

name: null | string = null

Имя элемента управления или null, если имя не задано. Рекомендуется задавать имя, уникальное для формы.

requiredText

requiredText: null | string = null

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

toolTip

toolTip: null | string = null

Текст всплывающей подсказки для элемента управления или null, если текст не был задан.

Accessors

blockSettings

  • get blockSettings(): IStorage<unknown>

  • Настройки блока CardTypeBlock, которые задаются для каждого включённого в его состав объекта.

    Returns IStorage<unknown>

  • set blockSettings(value: IStorage<unknown>): void

  • Parameters

    Returns void

controlSettings

  • get controlSettings(): IStorage<unknown>

  • Настройки используемого элемента управления, тип которого задан в свойстве type.

    Returns IStorage<unknown>

  • set controlSettings(value: IStorage<unknown>): void

  • Parameters

    Returns void

type

  • get type(): CardControlType

  • Тип используемого элемента управления.

    Returns CardControlType

  • set type(value: CardControlType): void

  • Parameters

    Returns void

Methods

clone

  • Создает новый объект, который является копией текущего экземпляра.

    Returns CardTypeCustomControl

deserializeFromStorage

getSourceInfo

  • Метод для получения информации об источнике данных контрола с учетом возможной регистрации кастомного метода для получения источника данных в CardControlTypeRegistry.

    Returns

    Возвращает информацию об источнике данных контрола.

    Returns CardControlSourceInfo

isRequired

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

    Returns

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

    Returns boolean

isSealed

  • Returns boolean

isVisible

  • Возвращает признак того, что элемент управления является видимым в интерфейсе.

    Returns

    Признак того, что элемент управления является видимым в интерфейсе.

    Returns boolean

seal

serializeToStorage

setRequired

  • Устанавливает признак того, что значение, редактируемое элементом управления, является обязательным для заполнения. Если элемент управления не поддерживает установку такого признака, то действий не выполняется.

    Returns

    Текущий объект для цепочки вызовов.

    Parameters

    • required: boolean

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

    Returns CardTypeCustomControl

setVisible

  • Устанавливает признак того, что элемент управления является видимым в интерфейсе. Если элемент управления не поддерживает установку такого признака, то действий не выполняется.

    Returns

    Текущий объект для цепочки вызовов.

    Parameters

    • visible: boolean

      Признак того, что элемент управления является видимым в интерфейсе.

    Returns CardTypeCustomControl

Generated using TypeDoc