SearchEdit

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

Описание

Компонент SearchEdit предназначен для указания текста, по которому может быть осуществлен BI-поиск.

Компонент представляет собой редактор текста, аналогичный компоненту EditBox. В области компонента реализована кнопка для очистки указанного текста. Для запуска процесса BI-поиска вызовите метод Search. Компонент не возвращает какой-либо результат поиска, указание в свойстве Timeout предельного времени поиска позволяет отследить его превышение. При превышении заданного времени для компонента будет сгенерировано событие OnSearch.

Для получения результатов BI-поиска используйте компонент SearchEdit в комбинации с компонентом SearchDataSourcesBox.

Пример

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

	Имя свойства	Краткое описание
	Align	Свойство Align определяет, как поведет себя компонент при изменении размеров содержащего его родительского компонента.
	AllowDrag	Свойство AllowDrag определяет возможность взять у компонента перетаскиваемый объект.
	AllowDrop	Свойство AllowDrop определяет, будет ли возможность у компонента принять перетаскиваемый объект.
	Anchors	Свойство Anchors возвращает настройки, определяющие в процентном соотношении изменение размеров текущего компонента при изменении размеров родительского компонента.
	AutoSelect	Свойство AutoSelect определяет, будет ли выделяться текст компонента, при получении компонентом фокуса.
	BorderStyle	Свойство BorderStyle определяет стиль границы компонента.
	Brush	Свойство Brush определяет кисть, используемую для заливки области компонента.
	CanUndo	Свойство CanUndo возвращает True, если существует возможность отменить изменения текста в компоненте.
	CharacterCasing	Свойство CharacterCasing определяет регистр вводимых символов компонента.
	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 определяет уникальный индекс раздела контекстно-зависимой справки для данного компонента.
	HideSelection	Свойство HideSelection определяет, будет ли выделенный текст компонента оставаться таковым, при передаче фокуса другому компоненту.
	Hint	Свойство Hint определяет текст подсказки для компонента.
	Left	Свойство Left определяет координату левого края компонента.
	MaxLength	Свойство MaxLength определяет максимальную длину вводимого текста.
	Modified	Свойство Modified возвращает True, если производилось изменение текста компонента.
	Name	Свойство Name определяет наименование компонента.
	Parent	Свойство Parent определяет родительский компонент.
	ParentColor	Свойство ParentColor определяет, будет ли для компонента заимствован цвет родительского компонента.
	ParentFont	Свойство ParentFont определяет, будет ли для компонента использоваться шрифт родительского компонента.
	ParentShowHint	Свойство ParentShowHint определяет условие отображения всплывающей подсказки.
	PasswordChar	Свойство PasswordChar определяет символ, который замещает фактические символы, вводимые пользователем.
	PopupMenu	Свойство PopupMenu определяет контекстное меню, которое будет появляться при щелчке дополнительной клавишей мыши на компоненте.
	Scrolls	Свойство Scrolls возвращает параметры полос прокрутки компонента.
	ReadOnly	Свойство ReadOnly определяет, может ли пользователь изменять текст компонента.
	SelLength	Свойство SelLength определяет количество символов, выделенных в тексте компонента.
	SelStart	Свойство SelStart определяет позицию, в которой расположен курсор и начинается выделение текста в компоненте.
	SelText	Свойство SelText определяет текст, выделенный в компоненте.
	ShowHint	Свойство ShowHint включает и выключает показ всплывающего окна подсказки для компонента.
	TabOrder	Свойство TabOrder определяет позицию компонента в последовательности табуляции.
	TabStop	Свойство TabStop определяет признак необходимости компоненту получать фокус при нажатии кнопки «TAB».
	Tag	Свойство Tag не используется компилятором. Пользователь может изменить значение свойства Tag и использовать его по своему усмотрению.
	Text	Свойство Text определяет строку, идентифицирующую компонент для пользователя.
	Timeout	Свойство Timeout определяет допустимое время поиска.
	Top	Свойство Top определяет координату верхнего края компонента.
	Visible	Свойство Visible определяет видимость компонента во время выполнения.
	Width	Свойство Width определяет ширину компонента.

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

	Имя метода	Краткое описание
	BringToFront	Метод BringToFront располагает компонент на передний план.
	Clear	Метод Clear удаляет весь текст, содержащийся в компоненте.
	ClearSelection	Метод ClearSelection удаляет весь текст, который был выделен в компоненте.
	ClearUndo	Метод ClearUndo используется для фиксации изменений свойства Text.
	CopyToClipboard	Метод CopyToClipboard осуществляет копирование выделенных данных в буфер обмена.
	CutToClipboard	Метод CutToClipboard осуществляет вырезание выделенных данных и помещает их в буфер обмена.
	ClientToScreen	Метод ClientToScreen преобразовывает координаты точки, указанные относительно системы координат компонента, в экранные координаты.
	DoDragDrop	Метод DoDragDrop позволяет начать операцию перетаскивания.
	GetImage	Метод GetImage возвращает графическое изображение компонента со всеми дочерними компонентами.
	PasteFromClipboard	Метод PasteFormClipboard осуществляет вставку данных из буфера обмена.
	SelectAll	Метод SelectAll осуществляет выделение текста компонента.
	SetFocus	Метод SetFocus устанавливает фокус на данный компонент.
	ScreenToClient	Метод ScreenToClient преобразовывает экранные координаты точки в координаты, указываемые относительно системы координат компонента.
	Search	Метод Search запускает процесс BI-поиска.
	SendToBack	Метод SendToBack располагает компонент на задний план.
	Undo	Метод Undo осуществляет отмену последнего изменения текста в компоненте.

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

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

См. также:

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