FGX.SearchEdit.TfgCustomSearchEdit: различия между версиями

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
Строка 1: Строка 1:
* [[ FGX.Controls.TfgControl | Вверх к родителю: TfgControl ]]
+
* [[ FGX.AutoCompleteEdit.TfgCustomAutoCompleteEdit | Вверх к родителю: TfgCustomAutoCompleteEdit ]]
 
* [[ FGX.SearchEdit | К модулю: FGX.SearchEdit ]]
 
* [[ FGX.SearchEdit | К модулю: FGX.SearchEdit ]]
  
 
Delphi
 
Delphi
  
<syntaxhighlight lang="Delphi">TfgCustomSearchEdit = class (TfgControl)</syntaxhighlight>
+
<syntaxhighlight lang="Delphi">TfgCustomSearchEdit = class (TfgCustomAutoCompleteEdit)</syntaxhighlight>
  
<p class="class-inheritance"><span class="type-border">[[System.Classes.TComponent|TComponent]]</span> -> <span class="type-border">[[FGX.Controls.TfgControl|TfgControl]]</span> -> <span class="type-border">[[FGX.SearchEdit.TfgCustomSearchEdit|TfgCustomSearchEdit]]</span></p>
+
<p class="class-inheritance"><span class="type-border">[[System.Classes.TComponent|TComponent]]</span> -> <span class="type-border">[[FGX.Controls.TfgControl|TfgControl]]</span> -> <span class="type-border">[[FGX.Edit.TfgCustomEdit|TfgCustomEdit]]</span> -> <span class="type-border">[[FGX.AutoCompleteEdit.TfgCustomAutoCompleteEdit|TfgCustomAutoCompleteEdit]]</span> -> <span class="type-border">[[FGX.SearchEdit.TfgCustomSearchEdit|TfgCustomSearchEdit]]</span></p>
  
 
Прямые наследники:
 
Прямые наследники:
Строка 14: Строка 14:
  
 
<p>Поле ввода строки поиска с поддержкой автозавершения ввода.</p>
 
<p>Поле ввода строки поиска с поддержкой автозавершения ввода.</p>
== Конструкторы ==
 
 
{| class="wikitable sortable"
 
|-
 
| <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(AOwner: [[TComponent]])</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
|}
 
 
== Методы ==
 
 
{| class="wikitable sortable"
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsFiltered(const ASuggestion: [[FGX.SearchEdit.Types.TfgSearchEditSuggestion|TfgSearchEditSuggestion]]; const AFilter: [[string]]): [[Boolean]]</code>
 
<p>Проверяет, подходит ли <i>ASuggestion</i> в выборку под фильтра <i>AFilter</i> или нет согласно текущим настройкам фильтрации?</p>
 
|}
 
 
== Свойства ==
 
 
{| class="wikitable sortable"
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Text: [[string]]</code>
 
<p>Текущий введенный текст.</p>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>TextPrompt: [[string]]</code>
 
<p>Тестовая подсказка отображаемая, когда текст еще не введен.</p>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Suggestions: [[FGX.SearchEdit.Types.TfgSearchEditSuggestions|TfgSearchEditSuggestions]]</code>
 
 
<p>Список предлагаемых строк поиска для подстановки.</p><div class="info">Если у вас большая база предлагаемых строк поиска, то лучшим вариантом по скорости и памяти будет динамическое обновление <i>Suggestions</i> в <i>OnChanging</i> на основании того, что ввел пользователь. При этом вам, возможно, потребуется отключить дефолтную фильтрацию <i>Filtered = False</i> , поскольку вы формируете список вручную.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Filtered: [[Boolean]]</code>
 
<p>Нужно ли фильтровать строки подстановки <i>Suggestions</i> или нет на основании введенного в поле текста?</p>
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>FilterOptions: [[FGX.SearchEdit.TfgFilterOptions|TfgFilterOptions]]</code>
 
<p>Настройки фильтрации. Актуальны, когда <i>Filtered = True</i> .</p>
 
|}
 
 
== События ==
 
 
{| class="wikitable sortable"
 
|-
 
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnChanging: [[TNotifyEvent]]</code>
 
 
<p>Срабатывает при любом изменении строки поиска.</p><div class="info">Используйте это событие для динамического формирования списка <i>Suggestions</i> на основании введенных данных пользователем.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnChanged: [[TNotifyEvent]]</code>
 
 
<p>Срабатывает в момент подтверждения/отправки запроса поиска.</p><div class="info">Для Андроида - это либо нажатия на кнопку Return, либо нажатие на кнопку Submit.</div>
 
|-
 
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnFilter: [[TfgSuggestionFilterEvent]]</code>
 
 
<p>Вызывается в момент фильтрации предлагаемых слов поиска. По умолчанию, контрол выполняет фильтрацию по <i>TfgSearchEditSuggestion.Text</i> .</p><div class="info">Используйте это событие, если вы хотите переопределить свой собственный вариант фильтрации.</div>
 
|}
 
 
== Константы ==
 
 
{| class="wikitable sortable"
 
|-
 
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultFiltered: [[Boolean]]</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
|}
 

Текущая версия на 04:03, 19 ноября 2019

Delphi

TfgCustomSearchEdit = class (TfgCustomAutoCompleteEdit)

TComponent -> TfgControl -> TfgCustomEdit -> TfgCustomAutoCompleteEdit -> TfgCustomSearchEdit

Прямые наследники: TfgSearchEdit

Описание

Поле ввода строки поиска с поддержкой автозавершения ввода.