Class CardTypeEntryControl

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

Hierarchy (View Summary)

CardTypeControl
- CardTypeEntryControl

Implements

ICloneable<CardTypeEntryControl>

Index

Constructors

constructor

new CardTypeEntryControl(): CardTypeEntryControl
Returns CardTypeEntryControl
Overrides CardTypeControl.constructor
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:18

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: null | string = null

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

Accessors

blockSettings

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

Returns IStorage
Inherited from CardTypeControl.blockSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:63
set blockSettings(value: IStorage): void
Parameters
- value: IStorage
Returns void
Inherited from CardTypeControl.blockSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:66

controlSettings

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

Returns IStorage
Inherited from CardTypeControl.controlSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:53
set controlSettings(value: IStorage): void
Parameters
- value: IStorage
Returns void
Inherited from CardTypeControl.controlSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:56

physicalColumnIdList

get physicalColumnIdList(): string[]
Список идентификаторов физических колонок, которые определяют значение поля.

Returns string[]
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:42
set physicalColumnIdList(value: string[]): void
Parameters
- value: string[]
Returns void
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:45

type

get type(): CardControlType
Тип используемого элемента управления.

Returns CardControlType
Inherited from CardTypeControl.type
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:43
set type(value: CardControlType): void
Parameters
- value: CardControlType
Returns void
Inherited from CardTypeControl.type
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:46

Methods

clone

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

Returns CardTypeEntryControl
Implementation of ICloneable.clone
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:145

deserializeFromStorage

deserializeFromStorage(
storage: IStorage,
context?: StorageSerializableContext,
): this
Parameters
- storage: IStorage
- Optionalcontext: StorageSerializableContext
Returns this
Inherited from CardTypeControl.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:41

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[]
  Имена полей, с которыми связан контрол.
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:73

getSourceInfo

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

Returns CardControlSourceInfo
Возвращает информацию об источнике данных контрола.
Inherited from CardTypeControl.getSourceInfo
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:37

isReadOnly

isReadOnly(): boolean
Returns boolean
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:87

isRequired

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

Returns boolean
Признак того, что значение, редактируемое элементом управления, является обязательным для заполнения.
Overrides CardTypeControl.isRequired
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:79

isSealed

isSealed(): boolean
Returns boolean
Inherited from CardTypeControl.isSealed
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:89

isVisible

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

Returns boolean
Признак того, что элемент управления является видимым в интерфейсе.
Overrides CardTypeControl.isVisible
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:83

seal

seal(): this
Returns this
Inherited from CardTypeControl.seal
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:72

serializeToStorage

serializeToStorage(
storage?: IStorage,
context?: StorageSerializableContext,
): IStorage
Parameters
- storage: IStorage = {}
- Optionalcontext: StorageSerializableContext
Returns IStorage
Inherited from CardTypeControl.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializableObject.ts:28

setReadOnly

setReadOnly(readOnly: boolean): this
Parameters
- readOnly: boolean
Returns this
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:101

setRequired

setRequired(required: boolean): this
Устанавливает признак того, что значение, редактируемое элементом управления, является обязательным для заполнения. Если элемент управления не поддерживает установку такого признака, то действий не выполняется.
Parameters
- required: boolean
  Признак того, что значение, редактируемое элементом управления, является обязательным для заполнения.
Returns this
Текущий объект для цепочки вызовов.
Overrides CardTypeControl.setRequired
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:91

setVisible

setVisible(visible: boolean): this
Устанавливает признак того, что элемент управления является видимым в интерфейсе. Если элемент управления не поддерживает установку такого признака, то действий не выполняется.
Parameters
- visible: boolean
  Признак того, что элемент управления является видимым в интерфейсе.
Returns this
Текущий объект для цепочки вызовов.
Overrides CardTypeControl.setVisible
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:96

Class CardTypeEntryControl

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CardTypeEntryControl

Properties

caption

complexColumnId

displayFormat

flags

Remarks

name

requiredText

sectionId

toolTip

Accessors

blockSettings

Returns IStorage

Parameters

Returns void

controlSettings

Returns IStorage

Parameters

Returns void

physicalColumnIdList

Returns string[]

Parameters

Returns void

type

Returns CardControlType

Parameters

Returns void

Methods

clone

Returns CardTypeEntryControl

deserializeFromStorage

Parameters

Returns this

getFieldNames

Parameters

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

defaultFieldName: string

defaultFieldType: CardMetadataRuntimeType

fieldNames: string[]

getSourceInfo

Returns CardControlSourceInfo

isReadOnly

Returns boolean

isRequired

Returns boolean

isSealed

Returns boolean

isVisible

Returns boolean

seal

Returns this

serializeToStorage

Parameters

Returns IStorage

setReadOnly

Parameters

Returns this

setRequired

Parameters

Returns this

setVisible

Parameters

Returns this

Settings

On This Page

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