Autocomplete

Описание

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

Комментарии

Компонент реализован классом PP.Ui.Autocomplete.

Основные возможности:

1. Позволяет настраивать подсказки на произвольные редакторы текста (Autocomplete.addTarget);

2. Возможность изменения размеров всплывающей подсказки (Autocomplete.MaxHeight и Autocomplete.MaxWidth);

3. При выборе элемента из списка в редакторе текста этот элемент добавляется в текущую позицию курсора;

4. Возможность использования подсветки совпадающих символов в всплывающей подсказке (Autocomplete.EnableHighlight);

5. Возможность измерения цвета подсказки с помощью переопределения на странице CSS-стиля background-color для класса .PPMenuItem .PPHighlightAutocomplete.

Пример

Пример компонента TextBox, для которого настроена всплывающая подсказка:

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

Конструктор

  Имя конструктора Краткое описание
Autocomplete Конструктор Autocomplete создает экземпляр компонента Autocomplete.

Свойства

  Имя свойства Краткое описание
Active Свойство Active определяет, является ли автозавершение активным для указанного элемента управления.
EnableHighlight Свойство EnableHighlight управляет возможностью подсветки совпадающих символов в подсказке для автозавершения ввода текста.
MatchCase Свойство MatchCase определяет, нужно ли при поиске вариантов автозавершения учитывать регистр.
MaxHeight Свойство MaxHeight устанавливает и возвращает максимальную высоту меню с вариантами автозавершения для указанного элемента управления.
MaxWidth Метод MaxWidth устанавливает и возвращает максимальную ширину меню с вариантами автозавершения для указанного элемента управления.
MinAutoFindSymbolsCount Свойство MinAutoFindSymbolsCount устанавливает минимальную длину строки, для которой будет показана подсказка.
Suggestions Свойство Suggestions устанавливает список вариантов автозавершения для указанного элемента управления.

Методы

  Имя метода Краткое описание
addTarget Метод addTarget добавляет элемент управления в систему автозавершения.
getTargets Метод getTargets возвращает объект типа Targets - набор структур Target.
hideSuggestion Метод hideSuggestion скрывает меню, в котором отображаются подсказки.
removeTarget Метод removeTarget удаляет указанный элемент управления из системы автозавершения.
showSuggestion Метод showSuggestion отображает меню с подсказками, настроенными для указанного элемента управления.

События

   Имя события Краткое описание
Opened Событие Opened наступает при открытии меню для выбора подсказки.
Selected Событие Selected наступает после выбора подсказки из меню.
SelectionChanged

Событие SelectionChanged наступает при выборе варианта автозаполнения из раскрывающегося меню при помощи клавиш UP, DOWN.

Свойства, унаследованные от класса Control

  Имя свойства Краткое описание
Anchors Свойство Anchors определяет позицию компонента, размещенного внутри контейнера.
Animation Свойство Animation определяет параметры анимации для компонента.
Bottom Свойство Bottom определяет отступ снизу при размещении компонента внутри LayoutPanel.
Content Свойство Content определяет содержимое компонента.
ContextMenu Свойство ContextMenu определяет контекстное меню для компонента.
Data Свойство Data предназначено для хранения любых пользовательских данных.
Enabled Свойство Enabled определяет признак доступности компонента для использования.
Height Свойство Height определяет высоту компонента.
IsRTL Свойство IsRTL определяет признак расположения элементов компонента по правому краю.
IsVisible Свойство IsVisible определяет признак отображения компонента.
Left Свойство Left определяет отступ слева при размещении компонента внутри GridPanel.
Opacity Свойство Opacity определяет прозрачность компонента.
Parent Свойство Parent определяет родительский компонент элемента управления.
ParentNode Свойство ParentNode определяет родительскую DOM-вершину.
ResourceKey Свойство ResourceKey определяет ресурсный ключ для компонента.
Right Свойство Right определяет отступ справа при размещении компонента внутри LayoutPanel.
Rotate Свойство Rotate определяет угол поворота компонента.
ShowToolTip Свойство ShowToolTip определяет признак возможности отображения всплывающей подсказки компонента.
Style Свойство Style определяет стиль для компонента.
TabIndex Свойство TabIndex определяет последовательность перехода элемента управления внутри контейнера.
Tag Свойство Tag определяет JSON-объект, ассоциированный с компонентом.
ToolTip Свойство ToolTip определяет текст всплывающей подсказки компонента.
Top Свойство Top определяет отступ сверху при размещении компонента внутри GridPanel.
Value Свойство Value определяет значение компонента.
Width Свойство Width определяет ширину компонента.

Методы, унаследованные от класса Control

  Имя метода Краткое описание

addClass

Метод addClass добавляет CSS-класс к компоненту.
addEventHandler Метод addEventHandler добавляет обработчик события на DOM-вершину.

addStateClass

Метод addStateClass добавляет CSS-класс к компоненту и удаляет прежний CSS-класс.

addToNode

Метод addToNode добавляет компонент в указанную вершину.
bindEvents Метод bindEvents подписывает элемент на все стандартные события.

getAnchorFlags

Метод getAnchorFlags возвращает JSON-объект с настройками текущей позиции компонента.

getClass

Метод getClass возвращает текущие css-классы компонента.

getCssStyle

Метод getCssStyle возвращает стили для указанной вершины.

getDomNode

Метод getDomNode возвращает главную DOM-вершину компонента.

getFocused

Метод getFocused определяет наличие фокуса у компонента.
getIsBinded Метод getIsBinded возвращает признак подписи элемента на события DOM-вершины.

hide

Метод hide скрывает элемент управления.

hideToolTip

Метод hideToolTip очищает таймаут появления подсказки и скрывает её, если она был показана.
refreshStyle Метод refreshStyle обновляет CSS-стили элемента.

removeClass

Метод removeClass удаляет CSS-класс из компонента.
removeEventHandler Метод removeEventHandler удаляет обработчик события DOM-вершины.
removeFromDOM Метод removeFromDOM удаляет вершину из DOM-структуры.

removeStateClasses

Метод removeStateClasses удаляет CSS-классы компонента.

setDraggable

Метод setDraggable устанавливает возможность перетаскивания компонента на HTML-странице.

setFocus

Метод setFocus устанавливает фокус компонента.

setIsHovered

Метод setIsHovered настраивает отображение компонента только при наведении на него курсора.

setSize

Метод setSize устанавливает размеры компонента.

show

Метод show отображает элемент управления.
unBindEvents Метод unBindEvents отписывает элемент от всех стандартных событий.

updatePosition

Метод updatePosition корректирует размер и положение при абсолютном позиционировании на основе текущих параметров.

updateSize

Метод updateSize обновляет размеры компонента подгонке размеров контейнера, в котором находится компонент.

События, унаследованные от класса Control

  Имя события Краткое описание
Drag Событие Drag наступает при нажатии и удерживании кнопки мыши.
DragEnd Событие DragEnd наступает при окончании перетаскивания компонента.
DragStart Событие DragStart наступает, когда начинается перетаскивание компонента.
OnContextMenu Событие OnContextMenu наступает при вызове контекстного меню компонента.
SizeChanged Событие SizeChanged наступает после изменения размеров компонента.
SizeChanging Событие SizeChanging наступает во время изменения размеров компонента.

Свойства, унаследованные от класса Object

  Имя свойства Краткое описание

Id

Свойство Id определяет идентификатор объекта репозитория.

Методы, унаследованные от класса Object

  Имя метода Краткое описание
clone Метод clone создает копию объекта.
dispose Метод dispose уничтожает компонент.
getHashCode Метод getHashCode возвращает хеш-код объекта репозитория.
getId Метод getId возвращает идентификатор объекта репозитория.
getSettings Метод getSettings возвращает настройки объекта репозитория.
getTypeName Метод getTypeName возвращает имя типа объекта без пространства имен, к которому он принадлежит.
isEqual Метод isEqual определяет, равен ли заданный объект текущему объекту репозитория.
isLive Метод isLive определяет действительность объекта репозитория.
removeAllEvents Метод removeAllEvents удаляет все обработчики событий объекта по заданному контексту.
setId Метод setId определяет идентификатор объекта репозитория.
setSettings Метод setSettings задает настройки объекта репозитория.
defineProps Метод defineProps создает методы get и set из массива имен для указанного класса.
keys Метод keys возвращает массив названий методов и свойств для указанного объекта.

См. также:

DHTML-компоненты