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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показано 26 промежуточных версий этого же участника)
Строка 1: Строка 1:
−
* [[ FGX.AutoCompleteEdit | Вверх к родителю: FGX.AutoCompleteEdit ]]
+
* [[ FGX.Edit.TfgCustomEdit | Вверх к родителю: TfgCustomEdit ]]
 +
* [[ FGX.AutoCompleteEdit | К модулю: FGX.AutoCompleteEdit ]]
  
 
Delphi
 
Delphi
  
 
<syntaxhighlight lang="Delphi">TfgCustomAutoCompleteEdit = class (TfgCustomEdit)</syntaxhighlight>
 
<syntaxhighlight lang="Delphi">TfgCustomAutoCompleteEdit = class (TfgCustomEdit)</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.Edit.TfgCustomEdit|TfgCustomEdit]]</span> -> <span class="type-border">[[FGX.AutoCompleteEdit.TfgCustomAutoCompleteEdit|TfgCustomAutoCompleteEdit]]</span></p>
 +
 +
Прямые наследники:
 +
[[FGX.AutoCompleteEdit.TfgAutoCompleteEdit|TfgAutoCompleteEdit]], [[FGX.SearchEdit.TfgCustomSearchEdit|TfgCustomSearchEdit]]
 +
 +
Непрямые наследники:
 +
[[FGX.SearchEdit.TfgSearchEdit|TfgSearchEdit]]
  
 
== Описание ==
 
== Описание ==
  
−
Поле ввода текста с поддержкой автозавершения ввода.
+
<p>Поле ввода текста с поддержкой автозавершения ввода.</p>
−
 
 
 
== Конструкторы ==
 
== Конструкторы ==
  
Строка 14: Строка 22:
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(AOwner: [[TComponent]])</code>
 
| <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(AOwner: [[TComponent]])</code>
−
 
+
<span style="color:gray">Описание отсутствует.</span>
 
|}
 
|}
  
Строка 20: Строка 28:
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">DropDown()</code>
 +
<p>Открывает выпадающее окно, если в нем есть слова для подстановки.</p>
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">Close()</code>
 +
<p>Закрывает выпадающее окно.</p>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsFiltered(const ASuggestion: [[FGX.AutoCompleteEdit.Types.TfgAutoCompleteEditSuggestion|TfgAutoCompleteEditSuggestion]]; const AFilter: [[string]]): [[Boolean]]</code>
 
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">IsFiltered(const ASuggestion: [[FGX.AutoCompleteEdit.Types.TfgAutoCompleteEditSuggestion|TfgAutoCompleteEditSuggestion]]; const AFilter: [[string]]): [[Boolean]]</code>
−
Проверяет, подходит ли предлагаемое слово подстановки '' ASuggestion '' для отображения в выпадающем окне согласно текущим настройкам фильтрации. '' AFilter '' содержит текущий набранный текст.
+
<p>Проверяет, подходит ли предлагаемое слово подстановки <i>ASuggestion</i> для отображения в выпадающем окне согласно текущим настройкам фильтрации. <i>AFilter</i> содержит текущий набранный текст.</p>
 
|}
 
|}
  
Строка 28: Строка 42:
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>DropDownSize: [[FGX.Types.TfgSingleSize|TfgSingleSize]]</code>
 +
 +
<p>Высота выпадающего окна, отображающего слова подстановки.</p><div class="info">Значение 0 - высота вычисляется автоматически.</div>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Suggestions: [[FGX.AutoCompleteEdit.Types.TfgAutoCompleteEditSuggestions|TfgAutoCompleteEditSuggestions]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Suggestions: [[FGX.AutoCompleteEdit.Types.TfgAutoCompleteEditSuggestions|TfgAutoCompleteEditSuggestions]]</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>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Filtered: [[Boolean]]</code>
−
Нужно ли фильтровать строки подстановки '' Suggestions '' или нет на основании введенного в поле текста? Если задано значение '' False '' , тогда не зависимо от того, что введет пользователь, выпадающий список будет содержать все слова из списка '' Suggestions '' .
+
<p>Нужно ли фильтровать строки подстановки <i>Suggestions</i> или нет на основании введенного в поле текста? Если задано значение <i>False</i> , тогда не зависимо от того, что введет пользователь, выпадающий список будет содержать все слова из списка <i>Suggestions</i> .</p>
 
|-
 
|-
−
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>FilterOptions: [[.TfgFilterOptions|TfgFilterOptions]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>FilterOptions: [[FGX.AutoCompleteEdit.TfgFilterOptions|TfgFilterOptions]]</code>
−
Настройки фильтрации. Актуальны, когда '' Filtered = True '' .
+
<p>Настройки фильтрации. Актуальны, когда <i>Filtered = True</i> .</p>
 
|}
 
|}
  
Строка 43: Строка 62:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSuggestionFilter: [[TfgSuggestionFilterEvent]]</code>
+
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSuggestionFilter: [[TfgSuggestionFilterEvent|TfgSuggestionFilterEvent]]</code>
−
Вызывается в момент фильтрации предлагаемых слов поиска. По умолчанию, контрол выполняет фильтрацию по '' TfgAutoCompleteEditSuggestion.Text '' . Вызывается только, когда '' Filtered = True '' .
+
 
 +
<p>Вызывается в момент фильтрации предлагаемых слов поиска. По умолчанию, контрол выполняет фильтрацию по <i>TfgAutoCompleteEditSuggestion.Text</i> . Вызывается только, когда <i>Filtered = True</i> .</p><div class="info">Используйте это событие, если вы хотите переопределить свой собственный вариант фильтрации.</div>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSuggestionSelected: [[TfgSuggestionClickEvent|TfgSuggestionClickEvent]]</code>
 +
<p>Срабатывает, когда пользователь нажимает на предлагаемоем для подстановк слово из выпадающего списка.</p>
 +
|}
 +
 
 +
== Константы ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultFiltered: [[Boolean]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 
|}
 
|}

Текущая версия на 17:13, 23 декабря 2022

Delphi 

TfgCustomAutoCompleteEdit = class (TfgCustomEdit)

TComponent -> TfgControl -> TfgCustomEdit -> TfgCustomAutoCompleteEdit

Прямые наследники: TfgAutoCompleteEdit, TfgCustomSearchEdit

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

Описание

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

Конструкторы

constructor
Create(AOwner: TComponent)

Описание отсутствует.

Методы

procedure
DropDown()

Открывает выпадающее окно, если в нем есть слова для подстановки.

procedure
Close()

Закрывает выпадающее окно.

function
IsFiltered(const ASuggestion: TfgAutoCompleteEditSuggestion; const AFilter: string): Boolean

Проверяет, подходит ли предлагаемое слово подстановки ASuggestion для отображения в выпадающем окне согласно текущим настройкам фильтрации. AFilter содержит текущий набранный текст.

Свойства

property
DropDownSize: TfgSingleSize

Высота выпадающего окна, отображающего слова подстановки.

Значение 0 - высота вычисляется автоматически.
property
Suggestions: TfgAutoCompleteEditSuggestions

Список предлагаемых строк поиска для подстановки.

Если у вас большая база предлагаемых строк поиска, то лучшим вариантом по скорости и памяти будет динамическое обновление Suggestions в OnChanging на основании того, что ввел пользователь. При этом вам, возможно, потребуется отключить дефолтную фильтрацию Filtered = False , поскольку вы формируете список вручную.
property
Filtered: Boolean

Нужно ли фильтровать строки подстановки Suggestions или нет на основании введенного в поле текста? Если задано значение False , тогда не зависимо от того, что введет пользователь, выпадающий список будет содержать все слова из списка Suggestions .

property
FilterOptions: TfgFilterOptions

Настройки фильтрации. Актуальны, когда Filtered = True .

События

event
OnSuggestionFilter: TfgSuggestionFilterEvent

Вызывается в момент фильтрации предлагаемых слов поиска. По умолчанию, контрол выполняет фильтрацию по TfgAutoCompleteEditSuggestion.Text . Вызывается только, когда Filtered = True .

Используйте это событие, если вы хотите переопределить свой собственный вариант фильтрации.
event
OnSuggestionSelected: TfgSuggestionClickEvent

Срабатывает, когда пользователь нажимает на предлагаемоем для подстановк слово из выпадающего списка.

Константы

const
DefaultFiltered: Boolean

Описание отсутствует.

Источник — http://docs.fgx-native.com/index.php?title=FGX.AutoCompleteEdit.TfgCustomAutoCompleteEdit&oldid=27661