Tessa.Platform.Placeholders - пространство имён

API для поиска и замены плейсхолдеров.

Классы

AliasPlaceholderContext Часть контекста операции, содержащая информацию по алиасам плейсхолдеров.
AliasPlaceholderParser Объект, выполняющий распознание найденного в документе плейсхолдера с алиасом {*Alias}.
AliasPlaceholderReplacer Базовый класс для объекта, выполняющего замену плейсхолдера определённого типа, работающего в режиме "замена по алиасу".
AliasPlaceholderReplacerNames Название объекта, зарегистрированного по интерфейсу IAliasPlaceholderReplacer.
AliasPlaceholderType Тип плейсхолдера, определяющего замену для плейсхолдера по алиасу.
AlignPlaceholderFormatter Объект, выполняющий выравнивание строки текста с пробельными отступами и выравниванием по левому краю, правому краю или по центру. Значения, отличные от текстовых, считает пустой строкой.

Пример: {f:DocumentCommonInfo.Subject:#align(left=16)}

Допустимы значения выравнивания: left, right, center.

BarcodePlaceholderFormatter Объект, выполняющий форматирование значения поля из строки в штрих-код определённого формата, представленный в виде изображения в формате PNG.

Пример: {fv:Content:#barcode}

Пример: {fv:Content:#barcode(w=250;h=80;t=ISBN)}

CardLinkPlaceholderFormatter Заменяет уникальный идентификатор на ссылку на карточку с этим идентификатором для web-клиента.
ContainerPlaceholderParser 
DefaultAliasPlaceholderReplacer Объект, выполняющий замену плейсхолдера типа {*Alias}, работающего в режиме "замена по алиасу".
DefaultFieldPlaceholderReplacer Объект, выполняющий замену плейсхолдера типа {f:...}, работающего в режиме "поле".
DefaultPlaceholderFormatter Объект, выполняющий форматирование значений для плейсхолдеров с выполнением нестандартных форматтеров.
DefaultTablePlaceholderReplacer Объект, выполняющий замену плейсхолдера типа {t:...}, работающего в режиме "таблица".
DefinitionPlaceholderParser Объект, выполняющий распознание найденного в документе плейсхолдера описания {#alias ...}.
DefinitionPlaceholderType Базовый класс для типа плейсхолдера.
EditablePlaceholderTable Редактируемая таблица с данными плейсхолдера таблиц ITablePlaceholderType.
FieldPlaceholderReplacer Базовый класс для объекта, выполняющего замену плейсхолдера определённого типа, работающего в режиме "поле".
FieldPlaceholderReplacerCachedReplacement Элемент кэша, по которому может быть выполнена замена плейсхолдера без обращения к внешним источникам (к базе данных, представлению и др.).
FieldPlaceholderReplacerNames Название объекта, зарегистрированного по интерфейсу IFieldPlaceholderReplacer.
FieldPlaceholderType Тип плейсхолдера с режимом работы "поле" Field.
FilePlaceholderFormatter Заменяет уникальный идентификатор на содержимое файла или версии файла с этим идентификатором.

Пример: {t:Files.VersionRowID:#file(version);image}

FormatPlaceholderFormatter Форматтер, выполняющий стандартное форматирование значения, полученного как: #format(f=dd.MM.yyyy) или #format(localize)
HtmlPlaceholderDocument Объект, определяющий способы хранения и изменения текста в формате HTML с заменяемыми плейсхолдерами для строки String.
ImagePlaceholderFormatter Объект, выполняющий форматирование значения поля из массива байт или из строки Base64 в изображение. Если тип данных значения несовместим или не конвертируется из строки Base64, то будет выполнено стандартное форматирование значения в строку.

Пример: {fv:Content:#image}

Пример: {fv:Content:#image(w=640;h=480;png;reformat)}

InfoFieldPlaceholderReplacer Объект, выполняющий замену плейсхолдера типа {info:...}, работающего в режиме "поле".
LocalizePlaceholderParser Объект, выполняющий распознание найденного в документе плейсхолдера со строкой локализации {$StringAlias}.
NoEncodePlaceholderFormatter Форматер, который определяет необходимость запрета вызова методов encode при обработке плейсхолдера (в частности, для Html)
NumberPlaceholderParser Объект, выполняющий распознание найденного в документе плейсхолдера с номером {0000n}. Если в контексте присутствует числовой номер по ключу NumberKey, то плейсхолдер сразу заменяется на отформатированный вариант этого номера. В противном случае плейсхолдер работает в режиме таблицы аналогично плейсхолдеру: {tn:00000}.
NumberTablePlaceholderReplacer Объект, выполняющий замену плейсхолдера типа {tn:...}, работающего в режиме "таблица". Плейсхолдер возвращает отформатированный номер строки Number.
Placeholder Информация по распознанному плейсхолдеру.
PlaceholderAggregateParser Объект, выполняющий распознание найденного в документе плейсхолдера на основании последовательного вызова нескольких добавленных объектов IPlaceholderParser.
PlaceholderCollection Коллекция объектов IPlaceholder.
PlaceholderContainer Контейнер, содержащий регистрации типов плейсхолдеров.
PlaceholderContext Базовый класс для контекста операции, связанной с плейсхолдерами.
PlaceholderCustomFormat Настройки нестандартного форматирования.
PlaceholderCustomFormatParser Объект, выполняющий разбор настроек нестандартного форматирования по строке.
PlaceholderDocument Базовый объект, определяющий способы хранения и изменения текста с заменяемыми плейсхолдерами.
PlaceholderExecutableQuery Запрос плейсхолдера к базе данных, подготовленный для выполнения.
PlaceholderExecutor Базовый класс для объектов, выполняющих выполнение запросов и получение значений из базы данных, представлений или других внешних источников.
PlaceholderExtensions Методы-расширения для пространства имён Tessa.Platform.Placeholders.
PlaceholderFindingContext Контекст операции, связанной с поиском плейсхолдеров.
PlaceholderFormatRequest Запрос на выполнение форматирования для значения плейсхолдера.
PlaceholderFormatResult Результат выполненного форматирования для поля или набора полей.
PlaceholderFormatSettings Настройки форматирования для вывода значений.
PlaceholderFormatterBase Базовый объект, выполняющий форматирование значений для плейсхолдеров. Определяет стандартный способ агрегации значений, но не форматирования.
PlaceholderFormatterContainer Контейнер, содержащий регистрации, выполняющих нестандартное форматирование значений для плейсхолдеров.
PlaceholderGroup Коллекция объектов, для которой доступны уведомление об изменениях и клонирование.
PlaceholderGroupCollection Коллекция объектов, для которой доступны уведомление об изменениях и клонирование.
PlaceholderGrouping Объект с информацией по группировки данных в таблице, строки которой наполняются через плейсхолдер в режиме "таблица".
PlaceholderGroupingCollection Коллекция объектов IPlaceholderGrouping, используемых для группировки строк в таблицах в запросах плейсхолдеров к базе данных.
PlaceholderHelper Вспомогательные средства для API плейсхолдеров.
PlaceholderImageParameters Параметры, связанные с выводом плейсхолдеров-изображений.
PlaceholderImageTypes Типы изображений, допустимые для свойства ImageType. Также могут быть использованы другие типы MIME-содержимого.
PlaceholderInfoQueryExecutor Объект, выполняющий построение и выполнение запроса по объекту IPlaceholderQuery.
PlaceholderInfoQueryParser Объект, выполняющий разбор выражения для запроса к базе данных для Info Dictionary<string, object>.
PlaceholderJoin Объект с информацией по объединению таблиц, который строится по плейсхолдеру. Обычно соответствует выражению: -(Join)->Section.Field. Свойство Join равно null для первого элемента в списке и не равно null для всех прочих.
PlaceholderJoinCollection Коллекция объектов IPlaceholderJoin, используемых для объединения таблиц в запросах плейсхолдеров к базе данных.
PlaceholderManager Объект, управляющий операциями с плейсхолдерами.
PlaceholderParserTContext Базовый класс для объекта, выполняющего разбор выражения плейсхолдера для запроса данных.
PlaceholderParsingContext Базовый класс для контекста операции, выполняющей разбор выражения плейсхолдера.
PlaceholderParsingEventArgs Аргументы событий, связанных с операцией по разбору плейсхолдера.
PlaceholderPatternBuilder Объект, выполняющий построение шаблона регулярного выражения, выполняющего разбор текста в параметрах плейсхолдера на составные части.
PlaceholderQuery Запрос к базе данных, который строится по плейсхолдеру.
PlaceholderQueryBuilder Объект, выполняющий формирование текста запроса по объекту IPlaceholderQuery.
PlaceholderQueryBuilderBuildContext Контекст метода Build(IPlaceholderReplacementContext, IQueryBuilderFactory, IPlaceholder, IPlaceholderQuery, PlaceholderQueryBuilderFlags, IEditablePlaceholderTable), выполняющего построение запроса по объекту IPlaceholderQuery.
PlaceholderQueryExecutor Объект, выполняющий построение и выполнение запроса по объекту IPlaceholderQuery. Запрос может не выполняться на базе данных, например, если требуемые данные содержатся в карточке.
PlaceholderQueryObject Базовый класс для объекта запроса к базе данных, который строится по плейсхолдеру.
PlaceholderQueryParser Объект, выполняющий разбор выражения для запроса к базе данных.
PlaceholderQueryParsingContext Контекст операции, выполняющей разбор выражения плейсхолдера для объекта IPlaceholderQueryParser.
PlaceholderRegexes Регулярные выражения, используемые при анализе некоторых видов плейсхолдеров, таких как {f:...} или {t:...}.
PlaceholderReplacement Объект с информацией по способу замены плейсхолдера.
PlaceholderReplacementContext Контекст операции, связанной с заменой плейсхолдеров.
PlaceholderReplacementEventArgs Аргументы событий, связанных с операцией по замене плейсхолдера.
PlaceholderRow Строка с данными для плейсхолдера таблиц ITablePlaceholderType.
PlaceholderRowKey Ключ, по которому осуществляется группировка строк IPlaceholderRow в таблице IPlaceholderTable.
PlaceholderSorting Объект с информацией по сортировке результатов запроса, который строится по плейсхолдеру.
PlaceholderSortingCollection Коллекция объектов IPlaceholderSorting, используемых для сортировки результатов в запросах плейсхолдеров к базе данных.
PlaceholderTable Таблица с данными плейсхолдера таблиц ITablePlaceholderType.
PlaceholderTaskQueryExecutor Объект, выполняющий построение и выполнение запроса по объекту IPlaceholderQuery. Запрос может не выполняться на базе данных, например, если требуемые данные содержатся в карточке.
PlaceholderTaskQueryParser Объект, выполняющий разбор выражения для запроса к базе данных для задания CardTask.
PlaceholderText Информация по плейсхолдеру, найденная в документе.
PlaceholderType Базовый класс для типа плейсхолдера.
PlaceholderValue Значение, на которое заменяется плейсхолдер. Содержит текст и опциональный список полей, по которым был построен текст, с указанием типов каждого поля. Любое строковое значение String может быть неявно преобразовано к типу PlaceholderValue.
PlaceholderValueType Тип значения плейсхолдера. Нестандартное форматирование может вернуть тип, отличный от строки.
PlaceholderValueTypeRegistry Реестр типов значений плейсхолдеров PlaceholderValueType. Класс является синглтоном.
PlaceholderValueTypes Стандартные типы значений плейсхолдеров.
PlaceholderViewExecutor Объект, выполняющий построение и выполнение представления по запросу IPlaceholderViewRequest.
PlaceholderViewParser Объект, выполняющий разбор выражения для запроса к представлению.
PlaceholderViewParsingContext Контекст операции, выполняющей разбор выражения плейсхолдера для объекта IPlaceholderViewParser.
PlaceholderViewQueryBuilder Объект, выполняющий формирование текста запроса по объекту IPlaceholderQuery, построенному по запросу к представлению IPlaceholderViewRequest.
PlaceholderViewRequest Запрос к представлению, который строится по плейсхолдеру.
PlaceholderViewRequestParameter Параметре для запроса к представлению, который строится по плейсхолдеру.
QRCodePlaceholderFormatter Объект, выполняющий форматирование значения поля из строки в текстовый QR-код, представленный в виде изображения в формате PNG.

Пример: {fv:Content:#qrcode}

Пример: {fv:Content:#qrcode(w=100;h=100;px=10;t=url;ecc=q;utf8;bom)}

ReplacePlaceholderParser Выполняет функцию, расположенную в контексте IPlaceholderContext по ключу ReplaceFuncKey и возвращающую строку с заменой плейсхолдера или null, если плейсхолдер нельзя заменить.
StringPlaceholderDocument Объект, определяющий способы хранения и изменения текста с заменяемыми плейсхолдерами для строки String.
StringPlaceholderDocumentMatchInfo Группа _group или отдельная строка _row.
StringPlaceholderDocumentGroup Группа в текстовом документе.
StringPlaceholderDocumentGroupParser Объект, который занимается построением структуры групп по тексту документа.
StringWithScriptsPlaceholderDocument Объект, определяющий способы хранения и изменения текста с заменяемыми плейсхолдерами для строки String. Поддерживает скрипты.
TablePlaceholderContext Часть контекста операции, связанная с плейсхолдерами для таблиц ITablePlaceholderType.
TablePlaceholderReplacer Базовый класс для объекта, выполняющего замену плейсхолдера определённого типа, работающего в режиме "таблица".
TablePlaceholderReplacerNames Название объекта, зарегистрированного по интерфейсу ITablePlaceholderReplacer.
TablePlaceholderType Тип плейсхолдера, предоставляющего данные для таблицы.
TaskFieldPlaceholderReplacer Объект, выполняющий замену плейсхолдера типа {task:...}, работающего в режиме "поле".
TextPlaceholderDocument Объект, определяющий способы хранения и изменения текста с заменяемыми плейсхолдерами для строки String.
TextPlaceholderFormatter Объект, выполняющий форматирование значения поля из массива байт в строку текста в заданной кодировке. Если плейсхолдер получает на входе строку вместо массива байт, то он возвращает её же.

Пример: {fv:Content:#text(t=utf-16)}

UnknownPlaceholderParser 
ViewFieldPlaceholderReplacer Объект, выполняющий замену плейсхолдера типа {fv:...}, обращающегося к представлению и работающего в режиме "поле".
ViewPlaceholderContext Часть контекста операции, связанная с плейсхолдерами для представлений.
ViewPlaceholderInfo Информация по представлению, выполняемому из плейсхолдеров.
ViewTablePlaceholderReplacer Объект, выполняющий замену плейсхолдера типа {tv:...}, обращающегося к представлению и работающего в режиме "таблица".
WebCardLinkPlaceholderFormatter Заменяет уникальный идентификатор на ссылку на карточку с этим идентификатором для web-клиента.
WrapPlaceholderFormatter Объект, выполняющий разбиение текста по строкам с выравниванием. При превышении лимита производит перенос текста на следующую строку.

Пример: {f:DocumentCommonInfo.Subject:#wrap(left=16)}

Допустимы значения переноса: left, right, center.

WrapPlaceholderInfo 

Структуры

PlaceholderField Значение поля в строке таблицы IPlaceholderRow при замене плейсхолдеров, работающих в режиме "таблица", или любая строка при замене плейсхолдеров, работающих в "режиме поля".

Интерфейсы

IAliasPlaceholderContext Часть контекста операции, содержащая информацию по алиасам плейсхолдеров.
IAliasPlaceholderReplacer Объект, выполняющий замену плейсхолдера определённого типа, работающего в режиме "замена по алиасу".
IAliasPlaceholderType Тип плейсхолдера, определяющего замену для плейсхолдера по алиасу.
IDefinitionPlaceholderType Тип плейсхолдера для установки плейсхолдеру алиаса. Используют режим замены Definition Сами такие плейсхолдеры всегда заменяются на Empty.
IEditablePlaceholderTable Редактируемая таблица с данными плейсхолдера таблиц ITablePlaceholderType.
IFieldPlaceholderReplacer Объект, выполняющий замену плейсхолдера определённого типа, работающего в режиме "поле".
IFieldPlaceholderType Тип плейсхолдера с режимом работы "поле" Field.
IPlaceholder Информация по распознанному плейсхолдеру.
IPlaceholderCollection Коллекция объектов IPlaceholder.
IPlaceholderContainer Контейнер, содержащий регистрации типов плейсхолдеров.
IPlaceholderContext Контекст операции, связанной с плейсхолдерами.
IPlaceholderCustomFormat Настройки нестандартного форматирования.
IPlaceholderCustomFormatParser Объект, выполняющий разбор настроек нестандартного форматирования по строке.
IPlaceholderDocument Объект, определяющий способы хранения и изменения текста с заменяемыми плейсхолдерами.
IPlaceholderExecutableQuery Запрос плейсхолдера к базе данных, подготовленный для выполнения.
IPlaceholderExtension Расширение для плейсхолдеров в карточке.
IPlaceholderFindingContext Контекст операции, связанной с поиском и распознанием плейсхолдеров.
IPlaceholderFormatRequest Запрос на выполнение форматирования для значения плейсхолдера.
IPlaceholderFormatResult Результат выполненного форматирования для поля или набора полей.
IPlaceholderFormatSettings Настройки форматирования для вывода значений.
IPlaceholderFormatter Объект, выполняющий форматирование значений для плейсхолдеров.
IPlaceholderFormatterContainer Контейнер, содержащий регистрации, выполняющих нестандартное форматирование значений для плейсхолдеров.
IPlaceholderGroup Группа плейсхолдеров, определяющих группировку таблицы IPlaceholderTable
IPlaceholderGroupCollection Коллекция объектов IPlaceholderGroup, используемых для группировки строк в таблицах IPlaceholderTable.
IPlaceholderGrouping Объект с информацией по группировки данных в таблице, строки которой наполняются через плейсхолдер в режиме "таблица".
IPlaceholderGroupingCollection Коллекция объектов IPlaceholderGrouping, используемых для группировки строк в таблицах в запросах плейсхолдеров к базе данных или к другим внешним источникам данных (таким как представления).
IPlaceholderImageParameters Параметры, связанные с выводом плейсхолдеров-изображений.
IPlaceholderJoin Объект с информацией по объединению таблиц, который строится по плейсхолдеру. Обычно соответствует выражению: -(Join)->Section.Field. Свойство Join равно null для первого элемента в списке и не равно null для всех прочих.
IPlaceholderJoinCollection Коллекция объектов IPlaceholderJoin, используемых для объединения таблиц в запросах плейсхолдеров к базе данных.
IPlaceholderManager Объект, управляющий операциями с плейсхолдерами.
IPlaceholderParser Объект, выполняющий распознание найденного в документе плейсхолдера.
IPlaceholderQuery Запрос к базе данных, который строится по плейсхолдеру.
IPlaceholderQueryBuilder Объект, выполняющий формирование текста запроса по объекту IPlaceholderQuery.
IPlaceholderQueryExecutor Объект, выполняющий построение и выполнение запроса по объекту IPlaceholderQuery. Запрос может не выполняться на базе данных, например, если требуемые данные содержатся в карточке.
IPlaceholderQueryObject Объект запроса к базе данных, который строится по плейсхолдеру.
IPlaceholderQueryParser Объект, выполняющий разбор выражения для запроса к базе данных.
IPlaceholderReplacement Объект с информацией по способу замены плейсхолдера.
IPlaceholderReplacementContext Контекст операции, связанной с заменой плейсхолдеров.
IPlaceholderRow Строка с данными для плейсхолдера таблиц ITablePlaceholderType.
IPlaceholderSorting Объект с информацией по сортировке результатов запроса, который строится по плейсхолдеру.
IPlaceholderSortingCollection Коллекция объектов IPlaceholderSorting, используемых для сортировки результатов в запросах плейсхолдеров к базе данных.
IPlaceholderTable Таблица с данными плейсхолдера таблиц ITablePlaceholderType.
IPlaceholderText Информация по плейсхолдеру, найденная в документе.
IPlaceholderType Тип плейсхолдера.
IPlaceholderValueTypeRegistry Реестр типов значений плейсхолдеров PlaceholderValueType.
IPlaceholderViewExecutor Объект, выполняющий построение и выполнение представления по запросу IPlaceholderViewRequest.
IPlaceholderViewParser Объект, выполняющий разбор выражения для запроса к представлению.
IPlaceholderViewRequest Запрос к представлению, который строится по плейсхолдеру.
IPlaceholderViewRequestParameter Параметре для запроса к представлению, который строится по плейсхолдеру.
ITablePlaceholderContext Часть контекста операции, связанная с плейсхолдерами для таблиц ITablePlaceholderType.
ITablePlaceholderReplacer Объект, выполняющий замену плейсхолдера определённого типа, работающего в режиме "таблица".
ITablePlaceholderType Тип плейсхолдера, предоставляющего данные для таблицы.
IViewPlaceholderContext Часть контекста операции, связанная с плейсхолдерами для представлений.
IViewPlaceholderInfo Информация по представлению, выполняемому из плейсхолдеров.

Делегаты

CreateAliasPlaceholderContextFuncAsync Функция, создающая часть контекста операции, содержащую информацию по алиасам плейсхолдеров.
CreatePlaceholderEditableTableFunc Создаёт редактируемую таблицу с данными плейсхолдеров по заданному имени name для использования в контексте context.
CreateTablePlaceholderContextFuncAsync Функция, создающая часть контекста операции, связанную с плейсхолдерами таблиц.
CreateViewPlaceholderContextFuncAsync Функция, создающая часть контекста операции, связанную с плейсхолдерами представлений.
GetPlaceholderValueFuncT Метод, возвращающий значение для операции с плейсхолдером.
PlaceholderReplaceFuncAsync Функция, которая заменяет плейсхолдер данного типа на возвращаемую строку. Возвращает null, если замену провести невозможно. Возвращает пустую строку, если плейсхолдер всегда должен быть заменён на пустую строку.

Перечисления

BarcodePlaceholderLabelType Расположение метки с текстом штрих-кода, который выводится рядом с изображением.
FindingOptions Опции по поиску и распознанию плейсхолдеров.
PlaceholderFieldFlags Флаги, связанные со значением PlaceholderField.
PlaceholderMode Режим работы плейсхолдера.
PlaceholderQueryBuilderFlags Флаги, влияющие на формирование текста запроса по объекту IPlaceholderQuery.
QRCodePlaceholderType Тип QR-кода для вывода в плейсхолдерах.
ReplacementOptions Опции по замене плейсхолдеров.
StringPlaceholderDocumentGroupType 
ViewRequestParameterSourceType Тип источника данных для параметра запроса к представлению.
WrapPlaceholderAlignment Выравнивание текста в плейсхолдерах при переносе.