SearchDataSourcesBox

Иерархия наследования

Описание

Компонент SearchDataSourcesBox предназначен для запуска процесса BI-поиска и отображения его результатов.

BI-поиск - это полнотекстовый поиск данных по ключевым словам в структуре многомерных источников репозитория. Для использования BI-поиска предварительно необходимо настроить репозиторий и проиндексировать источники данных. Инструкция по настройке представлена в подразделе «Установка и настройка сервиса BI-поиска».

Для запуска процесса BI-поиска вызовите метод StartSearch, указав в нем искомый текст. Процесс поиска можно отслеживать с помощью событий OnStartSearch - OnFinishSearch. После окончания поиска общее количество найденных совпадений будет доступно в свойстве TotalCount, а в коллекцию Items будут загружены первые сто элементов с результатами. Для загрузки следующих элементов используйте метод LoadNextPage.

Пример

Свойства компонента SearchDataSourcesBox

	Имя свойства	Краткое описание
	Align	Свойство Align определяет, как поведет себя компонент при изменении размеров содержащего его родительского компонента.
	AllowDrag	Свойство AllowDrag определяет возможность взять у компонента перетаскиваемый объект.
	AllowDrop	Свойство AllowDrop определяет, будет ли возможность у компонента принять перетаскиваемый объект.
	Anchors	Свойство Anchors возвращает настройки, определяющие в процентном соотношении изменение размеров текущего компонента при изменении размеров родительского компонента.
	Brush	Свойство Brush определяет кисть, используемую для заливки области компонента.
	ClientHeight	Свойство ClientHeight используется для получения или задания высоты клиентской области компонента.
	ClientWidth	Свойство ClientWidth используется для получения или задания ширины клиентской области компонента.
	Color	Свойство Color определяет цвет фона компонента.
	ComponentCount	Свойство ComponentCount возвращает количество дочерних компонентов.
	Components	Свойство Components возвращает дочерний компонент.
	Cursor	Свойство Cursor определяет вид курсора над компонентом.
	Data	Свойство Data предназначено для хранения любых пользовательских данных.
	Enabled	Свойство Enabled определяет доступность компонента для пользователя.
	Focused	Свойство Focused возвращает True, если фокус установлен на данном компоненте.
	Font	Свойство Font определяет множество характеристик, описывающих шрифт, используемый при отображении текста.
	Height	Свойство Height определяет высоту компонента.
	HelpContext	Свойство HelpContext определяет уникальный индекс раздела контекстно-зависимой справки для данного компонента.
	Hint	Свойство Hint определяет текст подсказки для компонента.
	HintTimeout	Свойство HintTimeout определяет время отображения всплывающей подсказки.
	IsAllDataLoaded	Свойство IsAllDataLoaded возвращает флажок, указывающий все ли элементы с результатами поиска загружены в область компонента.
	Items	Свойство Items возвращает коллекцию элементов с результатами поиска.
	Left	Свойство Left определяет координату левого края компонента.
	Name	Свойство Name определяет наименование компонента.
	Parent	Свойство Parent определяет родительский компонент.
	ParentColor	Свойство ParentColor определяет, будет ли для компонента заимствован цвет родительского компонента.
	ParentFont	Свойство ParentFont определяет, будет ли для компонента использоваться шрифт родительского компонента.
	ParentShowHint	Свойство ParentShowHint определяет условие отображения всплывающей подсказки.
	PopupMenu	Свойство PopupMenu определяет контекстное меню, которое будет появляться при клике дополнительной клавишей мыши на компоненте.
	ShowHint	Свойство ShowHint включает и выключает показ всплывающего окна подсказки для компонента.
	TabOrder	Свойство TabOrder определяет позицию компонента в последовательности табуляции.
	TabStop	Свойство TabStop определяет признак необходимости компоненту получать фокус при нажатии кнопки «Tab».
	Tag	Свойство Tag не используется компилятором. Пользователь может изменить значение свойства Tag и использовать его по своему усмотрению.
	Text	Свойство Text определяет строку, идентифицирующую компонент для пользователя.
	Top	Свойство Top определяет координату верхнего края компонента.
	TotalCount	Свойство TotalCount возвращает общее количество найденных совпадений.
	Visible	Свойство Visible определяет видимость компонента во время выполнения.
	Width	Свойство Width определяет ширину компонента.

Методы компонента SearchDataSourcesBox

	Имя метода	Краткое описание
	BringToFront	Метод BringToFront располагает компонент на передний план.
	CancelSearch	Метод CancelSearch прерывает процесс BI-поиска.
	ClientToScreen	Метод ClientToScreen преобразовывает координаты точки, указанные относительно системы координат компонента, в экранные координаты.
	DoDragDrop	Метод DoDragDrop позволяет начать операцию перетаскивания.
	GetImage	Метод GetImage возвращает изображение компонента со всеми дочерними компонентами.
	LoadNextPage	Метод LoadNextPage осуществляет продолжение поиска и загружает в область компонента следующий набор элементов с результатами поиска.
	ScreenToClient	Метод ScreenToClient преобразовывает экранные координаты точки в координаты, указываемые относительно системы координат компонента.
	SendToBack	Метод SendToBack располагает компонент на задний план.
	SetFocus	Метод SetFocus устанавливает фокус на данный компонент.
	StartSearch	Метод StartSearch запускает процесс BI-поиска.

События компонента SearchDataSourcesBox

	Имя события	Краткое описание
	OnAfterSelectionChange	Событие OnAfterSelectionChange наступает после выделения элемента с результатом поиска в области компонента.
	OnBeforeSelectionChange	Событие OnBeforeSelectionChange наступает перед выделением элемента с результатом поиска в области компонента.
	OnBeginDrag	Событие OnBeginDrag для компонента наступает, когда пользователь начинает перетаскивать объект от компонента.
	OnCancelSearch	Событие OnCancelSearch наступает в момент принудительной остановки процесса BI-поиска.
	OnClick	Событие OnClick наступает, если пользователь осуществил щелчок основной кнопкой мыши в области компонента.
	OnControlMove	Событие OnControlMove наступает при перемещении компонента.
	OnControlResize	Событие OnControlResize наступает при изменении размеров у компонента.
	OnDblClick	Событие OnDblClick наступает, если пользователь осуществил двойной щелчок кнопкой мыши в области компонента.
	OnDragDrop	Событие OnDragDrop для компонента наступает, когда пользователь отпускает над ним перетаскиваемый объект.
	OnDragEnter	Событие OnDragEnter наступает, когда перетаскиваемый объект входит в границы данного компонента.
	OnDragLeave	Событие OnDragLeave наступает, когда перетаскиваемый объект выходит за границы данного компонента.
	OnDragOver	Событие OnDragOver для компонента наступает, когда пользователь протаскивает над ним перетаскиваемый объект.
	OnEnter	Событие OnEnter наступает в момент получения фокуса компонентом.
	OnExit	Событие OnExit наступает в момент потери фокуса компонентом.
	OnFinishSearch	Событие OnFinishSearch наступает в момент завершения процесса BI-поиска.
	OnHScroll	Событие OnHScroll наступает при изменении положения ползунка горизонтальной полосы прокрутки.
	OnKeyDown	Событие OnKeyDown наступает, если компонент находится в фокусе и производится нажатие клавиши на клавиатуре.
	OnKeyPress	Событие OnKeyPress наступает, если компонент находится в фокусе, при нажатии пользователем символьной клавиши.
	OnKeyPreview	Событие OnKeyPreview наступает перед каждым событием, связанным с нажатием клавиш.
	OnKeyUp	Событие OnKeyUp наступает, если компонент находится в фокусе, при отпускании пользователем любой, ранее нажатой клавиши.
	OnMouseDown	Событие OnMouseDown наступает, если компонент находится в фокусе и на компоненте произведено нажатие любой из кнопок мыши.
	OnMouseEnter	Событие OnMouseEnter наступает в момент входа курсора мыши в область компонента.
	OnMouseHover	Событие OnMouseHover наступает при задержке курсора мыши в области компонента.
	OnMouseLeave	Событие OnMouseLeave наступает в момент выхода курсора мыши за пределы области компонента.
	OnMouseMove	Событие OnMouseMove наступает при перемещении пользователем курсора мыши над компонентом.
	OnMouseUp	Событие OnMouseUp наступает, если компонент находится в фокусе и на компоненте, была отпущена любая из ранее нажатых кнопок мыши.
	OnMouseWheel	Событие OnMouseWheel наступает, если компонент находится в фокусе при вращении колеса мыши.
	OnStartSearch	Событие OnStartSearch наступает в момент запуска процесса BI-поиска.
	OnVScroll	Событие OnVScroll наступает при изменении положения ползунка вертикальной полосы прокрутки.

См. также:

Дополнительные компоненты