Class CardTypeEntryControl

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

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties

caption complexColumnId displayFormat flags name requiredText sectionId toolTip

Accessors

blockSettings controlSettings physicalColumnIdList type

Methods

clone deserializeFromStorage getFieldNames getSourceInfo isReadOnly isRequired isSealed isVisible seal serializeToStorage setReadOnly setRequired setVisible

Constructors

constructor

Properties

caption

caption: null | string = null

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

complexColumnId

complexColumnId: null | string = null

Идентификатор комплексной колонки, в которой содержится значение поля, или null, если поле содержится в физической колонке или составлено из нескольких физических колонок.

displayFormat

displayFormat: null | string = null

Формат отображаемого в текстовом виде поля. Если задано null или пустая строка, то в текстовом виде поле будет отображаться как значения всех колонок из списка CardTypeEntryControl.physicalColumnIdList, объединённые пробелами.

flags

flags: CardTypeEntryControlFlags = 0

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

Remarks

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

name

name: null | string = null

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

requiredText

requiredText: null | string = null

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

sectionId

sectionId: string = Guid.empty

Идентификатор секции, содержащей колонку с полем CardTypeEntryControl.complexColumnId.

toolTip

toolTip: null | string = null

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

Accessors

blockSettings

  • get blockSettings(): IStorage

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

    Returns IStorage

  • set blockSettings(value: IStorage): void

    Parameters

    Returns void

controlSettings

  • get controlSettings(): IStorage

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

    Returns IStorage

  • set controlSettings(value: IStorage): void

    Parameters

    Returns void

physicalColumnIdList

  • get physicalColumnIdList(): string[]

    Список идентификаторов физических колонок, которые определяют значение поля.

    Returns string[]

  • set physicalColumnIdList(value: string[]): void

    Parameters

    • value: string[]

    Returns void

type

  • get type(): CardControlType

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

    Returns CardControlType

  • set type(value: CardControlType): void

    Parameters

    Returns void

Methods

clone

  • clone(): CardTypeEntryControl

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

    Returns CardTypeEntryControl

deserializeFromStorage

getFieldNames

  • getFieldNames(
        metadataSection: ICardMetadataSection,
    ): {
        defaultFieldName: string;
        defaultFieldType: CardMetadataRuntimeType;
        fieldNames: string[];
    }

    Возвращает имена полей, с которыми связан контрол CardTypeEntryControl.

    Parameters

    • metadataSection: ICardMetadataSection

      Секция в метаинформации по типу карточки, с которой связан контрол.

    Returns {
        defaultFieldName: string;
        defaultFieldType: CardMetadataRuntimeType;
        fieldNames: string[];
    }

    Имена полей, с которыми связан контрол.

    • defaultFieldName: string

      Имя поля по умолчанию, используемое при отсутствии форматирования в контроле.

    • defaultFieldType: CardMetadataRuntimeType

      Тип поля по умолчанию.

    • fieldNames: string[]

      Имена полей, с которыми связан контрол.

getSourceInfo

  • getSourceInfo(): CardControlSourceInfo

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

    Returns CardControlSourceInfo

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

isReadOnly

  • isReadOnly(): boolean

    Returns boolean

isRequired

  • isRequired(): boolean

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

    Returns boolean

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

isSealed

  • isSealed(): boolean

    Returns boolean

isVisible

  • isVisible(): boolean

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

    Returns boolean

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

seal

  • seal(): this

    Returns this

serializeToStorage

setReadOnly

  • setReadOnly(readOnly: boolean): this

    Parameters

    • readOnly: boolean

    Returns this

setRequired

  • setRequired(required: boolean): this

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

    Parameters

    • required: boolean

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

    Returns this

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

setVisible

  • setVisible(visible: boolean): this

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

    Parameters

    • visible: boolean

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

    Returns this

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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR