Class CardTypeEntryControl

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

Hierarchy

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 или пустая строка, то в текстовом виде поле будет отображаться как значения всех колонок из списка physicalColumnIdList, объединённые пробелами.

flags

flags: CardTypeEntryControlFlags = 0

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

Remarks

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

name

name: null | string = null

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

requiredText

requiredText: null | string = null

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

sectionId

sectionId: string = Guid.empty

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

toolTip

toolTip: null | string = null

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

Accessors

blockSettings

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

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

controlSettings

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

Returns IStorage<unknown>
Inherited from CardTypeControl.controlSettings
- Defined in @tessa/platform/src/cards/types/cardTypeControl.ts:53
set controlSettings(value: IStorage<unknown>): void
Parameters
- value: IStorage<unknown>
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:136

deserializeFromStorage

deserializeFromStorage(storage: IStorage<unknown>, context?: StorageSerializableContext): CardTypeEntryControl
Parameters
- storage: IStorage<unknown>
- Optional context: StorageSerializableContext
Returns CardTypeEntryControl
Inherited from CardTypeControl.deserializeFromStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:54

getFieldNames

getFieldNames(metadataSection: ICardMetadataSection): {
    defaultFieldName: string;
    defaultFieldType: CardMetadataRuntimeType;
    fieldNames: string[];
}
Возвращает имена полей, с которыми связан контрол CardTypeEntryControl.

Returns
Имена полей, с которыми связан контрол.
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
Возвращает информацию об источнике данных контрола.

Returns CardControlSourceInfo
Inherited from CardTypeControl.getSourceInfo
- Defined in @tessa/platform/src/cards/_extensionsCard.ts:37

isRequired

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

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

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/storageSerializable.ts:102

isVisible

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

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

Returns boolean
Overrides CardTypeControl.isVisible
- Defined in @tessa/platform/src/cards/types/cardTypeEntryControl.ts:83

seal

seal(): CardTypeEntryControl
Returns CardTypeEntryControl
Inherited from CardTypeControl.seal
- Defined in @tessa/core/src/serialization/storageSerializable.ts:85

serializeToStorage

serializeToStorage(storage?: IStorage<unknown>, context?: StorageSerializableContext): IStorage<unknown>
Parameters
- storage: IStorage<unknown> = {}
- Optional context: StorageSerializableContext
Returns IStorage<unknown>
Inherited from CardTypeControl.serializeToStorage
- Defined in @tessa/core/src/serialization/storageSerializable.ts:44

setRequired

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

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

setVisible

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

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

Class CardTypeEntryControl

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CardTypeEntryControl

Properties

caption

complexColumnId

displayFormat

flags

Remarks

name

requiredText

sectionId

toolTip

Accessors

blockSettings

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

controlSettings

Returns IStorage<unknown>

Parameters

value: IStorage<unknown>

Returns void

physicalColumnIdList

Returns string[]

Parameters

value: string[]

Returns void

type

Returns CardControlType

Parameters

value: CardControlType

Returns void

Methods

clone

Returns CardTypeEntryControl

deserializeFromStorage

Parameters

storage: IStorage<unknown>

Optional context: StorageSerializableContext

Returns CardTypeEntryControl

getFieldNames

Returns

Parameters

metadataSection: ICardMetadataSection

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

defaultFieldName: string

defaultFieldType: CardMetadataRuntimeType

fieldNames: string[]

getSourceInfo

Returns

Returns CardControlSourceInfo

isRequired

Returns

Returns boolean

isSealed

Returns boolean

isVisible

Returns

Returns boolean

seal

Returns CardTypeEntryControl

serializeToStorage

Parameters

storage: IStorage<unknown> = {}

Optional context: StorageSerializableContext

Returns IStorage<unknown>

setRequired

Returns

Parameters

required: boolean

`Optional` context: StorageSerializableContext

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

`Optional` context: StorageSerializableContext