Документация для разработчиков
Темная тема

GetTextFilter

Описание и параметры

string
CForm::GetTextFilter(
 int filter_sid,
 int size = 45,
 string add_to_text = "class=\"inputtext\"",
 string add_to_checkbox = "class=\"inputcheckbox\""
)

Возвращает HTML код поля фильтра, предназначенного для фильтрации результатов по текстовым значениям ответов на вопросы веб-формы или текстовым значениям полей веб-формы. Возвращаемый HTML код включает в себя однострочное текстовое поле и флаг для установки точности фильтрации. Метод нестатический.

Примечание
Имена результирующих HTML полей будут сформированы по следующим маскам:
find_filter_sid - однострочное текстовое поля
find_filter_sid_exact_match - флаг для установки точности фильтрации

Параметры метода

Параметр Описание С версии
filter_sid Идентификатор поля фильтра. Формируется по следующему шаблону:
FSID_QSID_PTYPE_text,
где:
  • FSID - символьный идентификатор веб-формы;
  • QSID - символьный идентификатор вопроса/поля веб-формы;
  • PTYPE - тип параметра по которому будет фильтрация, возможны следующие значения:
    • ANSWER_TEXT - параметр ANSWER_TEXT вопроса веб-формы;
    • ANSWER_VALUE - параметр ANSWER_VALUE вопроса веб-формы;
    • USER - для вопроса веб-формы - вводимое с клавиатуры значение, для полей веб-формы - значение этого поля веб-формы.
Примеры:
  • ANKETA_USER_NAME_USER_text;
  • ANKETA_TEST_FIELD_USER_text.
size Ширина однострочного текстового поля:
<input type="text" size="size" ...>

Параметр необязательный. По умолчанию - "45".
add_to_text Произвольный HTML, который будет добавлен в тег однострочного текстового поля:
<input type="text" add_to_text ...>

Параметр необязательный. По умолчанию - "class='typeinput'". С версии 4.0.4 - "class=\"inputtext\""
3.2.5
add_to_checkbox Произвольный HTML, который будет добавлен в тег флага для установки точности фильтрации:
<input type="checkbox" add_to_checkbox ...>

Параметр необязательный. По умолчанию - "class=\"inputcheckbox\"".
3.3.10

Примеры использования

<form action="" method="POST">
<table>
    <tr>
        <td>Фамилия:</td>
        <td><?
            echo CForm::GetTextFilter(
                "ANKETA_USER_NAME_USER_text", 
                45, 
                "class=\"inputtext\"", 
                "class=\"inputcheckbox\""
                );
            ?></td>
    </tr>
</table>
<input type="submit" value="Фильтр">
</form>


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх