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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
Строка 73: Строка 73:
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code>
 
<p>Видимость контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Visible|Visible]].</small></small>
 
<p>Видимость контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Visible|Visible]].</small></small>
 +
|}
 +
 +
== События ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnChanging: [[TNotifyEvent]]</code>
 +
 +
<p>Срабатывает при любом изменении строки поиска.</p><div class="info">Используйте это событие для динамического формирования списка <i>Suggestions</i> на основании введенных данных пользователем.</div><small style="color: red"><small>Описание взято от [[FGX.SearchEdit.TfgCustomSearchEdit.OnChanging|OnChanging]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnChanged: [[TNotifyEvent]]</code>
 +
 +
<p>Срабатывает в момент подтверждения/отправки запроса поиска.</p><div class="info">Для Андроида - это либо нажатия на кнопку Return, либо нажатие на кнопку Submit.</div><small style="color: red"><small>Описание взято от [[FGX.SearchEdit.TfgCustomSearchEdit.OnChanged|OnChanged]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnFilter: [[TfgSuggestionFilterEvent]]</code>
 +
 +
<p>Вызывается в момент фильтрации предлагаемых слов поиска. По умолчанию, контрол выполняет фильтрацию по <i>TfgSearchEditSuggestion.Text</i> .</p><div class="info">Используйте это событие, если вы хотите переопределить свой собственный вариант фильтрации.</div><small style="color: red"><small>Описание взято от [[FGX.SearchEdit.TfgCustomSearchEdit.OnFilter|OnFilter]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnDestroy: [[TNotifyEvent]]</code>
 +
<p>Вызывается перед удалением контрола. А именно перед вызовом деструктора.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnDestroy|OnDestroy]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnResized: [[TfgResizedEvent]]</code>
 +
<p>Вызывается когда контрол изменил свой размерм.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnResized|OnResized]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPaint: [[TfgPaintEvent]]</code>
 +
<p>Вызывается после отрисовки нативного контрола. Служит для выполнения пользовательской отрисовки поверх контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnPaint|OnPaint]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnLongTap: [[TfgLongTapEvent]]</code>
 +
<p>Срабатывает, когда пользователь долго нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnLongTap|OnLongTap]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPositionChanged: [[TfgPositionChangedEvent]]</code>
 +
<p>Вызывается когда контрол поменял свою позицию.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnPositionChanged|OnPositionChanged]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTouch: [[Boolean]]</code>
 +
<p>Вызывается в момент касания пользователем экрана устройства.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnTouch|OnTouch]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTap: [[TNotifyEvent]]</code>
 +
<p>Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnTap|OnTap]].</small></small>
 
|}
 
|}

Версия 18:17, 29 июня 2019

Delphi

TfgSearchEdit = class (TfgCustomSearchEdit)

TComponent -> TfgControl -> TfgCustomSearchEdit -> TfgSearchEdit

Описание

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

Описание взято от TfgCustomSearchEdit.

Свойства

property
Text: string

Текущий введенный текст.

Описание взято от Text.
property
TextPrompt: string

Тестовая подсказка отображаемая, когда текст еще не введен.

Описание взято от TextPrompt.
property
Suggestions: TfgSearchEditSuggestions

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

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

Нужно ли фильтровать строки подстановки Suggestions или нет на основании введенного в поле текста?

Описание взято от Filtered.
property
FilterOptions: TfgFilterOptions

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

Описание взято от FilterOptions.
property
Alignment: TfgControlAlignment

Настройки выравнивания контрола в рамках родителя.

Описание взято от Alignment.
property
AlignWithMargins: Boolean

Нужно ли использовать заданные внешние отступы Margins .

Описание взято от AlignWithMargins.
property
Locked: Boolean

Позволяет заблокировать выделение компонента мышкой в дизайн тайме.

Описание взято от Locked.
property
LookupName: string

Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.

Описание взято от LookupName.
property
PositionMode: TfgPositionMode

Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно).

Описание взято от PositionMode.
property
Position: TfgPosition

Позиция контрола в локальных логических координатах родителя Parent .

Описание взято от Position.
property
RelativePosition: TfgRelativePosition

Относительная позиция контролов относительно родителя. Актуально только для PositionMode = Relative .

Описание взято от RelativePosition.
property
Size: TfgSize

Размер контрола в логических координатах.

Описание взято от Size.
property
Constraints: TfgConstraints

Ограничение на размеры контрола.

Описание взято от Constraints.
property
Margins: TfgMargins

Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера.

Описание взято от Margins.
property
GestureKinds: TfgGestureKinds

Виды поддерживаемых жестов.

Описание взято от GestureKinds.
property
HitTest: Boolean

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

property
Opacity: Single

Прозрачность контрола.

Описание взято от Opacity.
property
Visible: Boolean

Видимость контрола.

Описание взято от Visible.

События

event
OnChanging: TNotifyEvent

Срабатывает при любом изменении строки поиска.

Используйте это событие для динамического формирования списка Suggestions на основании введенных данных пользователем.
Описание взято от OnChanging.
event
OnChanged: TNotifyEvent

Срабатывает в момент подтверждения/отправки запроса поиска.

Для Андроида - это либо нажатия на кнопку Return, либо нажатие на кнопку Submit.
Описание взято от OnChanged.
event
OnFilter: TfgSuggestionFilterEvent

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

Используйте это событие, если вы хотите переопределить свой собственный вариант фильтрации.
Описание взято от OnFilter.
event
OnDestroy: TNotifyEvent

Вызывается перед удалением контрола. А именно перед вызовом деструктора.

Описание взято от OnDestroy.
event
OnResized: TfgResizedEvent

Вызывается когда контрол изменил свой размерм.

Описание взято от OnResized.
event
OnPaint: TfgPaintEvent

Вызывается после отрисовки нативного контрола. Служит для выполнения пользовательской отрисовки поверх контрола.

Описание взято от OnPaint.
event
OnLongTap: TfgLongTapEvent

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

Описание взято от OnLongTap.
event
OnPositionChanged: TfgPositionChangedEvent

Вызывается когда контрол поменял свою позицию.

Описание взято от OnPositionChanged.
event
OnTouch: Boolean

Вызывается в момент касания пользователем экрана устройства.

Описание взято от OnTouch.
event
OnTap: TNotifyEvent

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

Описание взято от OnTap.