Documentation

Class MapSearchBarElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
MapSearchBarElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.RadMap.dll

Syntax

public class MapSearchBarElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

MapSearchBarElement(RadMapElement)

Initializes a new instance of the MapSearchBarElement class.

Declaration
public MapSearchBarElement(RadMapElement mapElement)
Parameters
RadMapElement mapElement

The map element.

Properties

MapElement

Gets the map element.

Declaration
public RadMapElement MapElement { get; }
Property Value
RadMapElement

The map element.

SearchBarWidth

Gets or sets the width of the search bar.

Declaration
public int SearchBarWidth { get; set; }
Property Value
System.Int32

SearchIconElement

Gets the search icon element.

Declaration
public MapSearchIconElement SearchIconElement { get; }
Property Value
MapSearchIconElement

The search icon element.

SearchMode

Gets or sets the search mode.

Declaration
public MapSearchMode SearchMode { get; set; }
Property Value
MapSearchMode

The search mode.

SearchProvider

Gets or sets the search provider.

Declaration
public IMapSearchProvider SearchProvider { get; set; }
Property Value
IMapSearchProvider

The search provider.

SearchTextBoxElement

Gets the search text box element.

Declaration
public RadTextBoxElement SearchTextBoxElement { get; }
Property Value
RadTextBoxElement

The search text box element.

ShowMessageBoxOnError

Gets or sets whether a message box will be shown upon an error when the MapSearchBarElement has no IMapSearchProvider set. In this case the search element will traverse the providers collection of RadMapElement and the provider will raise the SearchError event.

Declaration
public bool ShowMessageBoxOnError { get; set; }
Property Value
System.Boolean

The map element.

StackLayoutElement

Gets the stack layout element.

Declaration
public StackLayoutElement StackLayoutElement { get; }
Property Value
StackLayoutElement

The stack layout element.

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BuildSearchRequest(String)

Builds the search request based on the provided text.

Declaration
protected virtual SearchRequest BuildSearchRequest(string text)
Parameters
System.String text

The text.
Returns
SearchRequest

SearchRequest.

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateSearchIconElement()

Creates a search icon element.

Declaration
protected virtual MapSearchIconElement CreateSearchIconElement()
Returns
MapSearchIconElement

MapSearchIconElement.

CreateStackElement()

Creates a stack element.

Declaration
protected virtual StackLayoutElement CreateStackElement()
Returns
StackLayoutElement

StackLayoutElement.

CreateTextBoxElement()

Creates a text box element.

Declaration
protected virtual RadTextBoxElement CreateTextBoxElement()
Returns
RadTextBoxElement

RadTextBoxElement.

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

OnSearchTextBoxKeyDown(Object, KeyEventArgs)

Declaration
protected virtual void OnSearchTextBoxKeyDown(object sender, KeyEventArgs e)
Parameters
System.Object sender

System.Windows.Forms.KeyEventArgs e

OnSearchTextBoxKeyUp(Object, KeyEventArgs)

Declaration
[Obsolete("Use the OnSearchTextBoxKeyDown as now the search will be initiated on KeyDown.")]
protected virtual void OnSearchTextBoxKeyUp(object sender, KeyEventArgs e)
Parameters
System.Object sender

System.Windows.Forms.KeyEventArgs e

OnSearchTextBoxTextChanged(Object, EventArgs)

Declaration
protected virtual void OnSearchTextBoxTextChanged(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

Search(String)

Initiates a new search. First if there is an subscriber to the SearchCriteriaChanged the event is raised. Search handling is left to the user. If there is no subscriber to the event the method checks the SearchProvider property. If the property is set a new async search is started. The user should handle the search result. If the property is not set the method traverses the providers in the Providers collection of the map element. If a search provider is found a new async search is started. The user should handle the search result.

Declaration
public virtual void Search(string criteria)
Parameters
System.String criteria

The criteria.

SearchProviderSearchCompleted(Object, SearchCompletedEventArgs)

Declaration
protected virtual void SearchProviderSearchCompleted(object sender, SearchCompletedEventArgs e)
Parameters
System.Object sender

SearchCompletedEventArgs e

SearchProviderSearchError(Object, SearchErrorEventArgs)

Declaration
protected virtual void SearchProviderSearchError(object sender, SearchErrorEventArgs e)
Parameters
System.Object sender

SearchErrorEventArgs e

SubscribeToTextBoxEvents(RadTextBoxElement)

Declaration
protected virtual void SubscribeToTextBoxEvents(RadTextBoxElement textBox)
Parameters
RadTextBoxElement textBox

UnsubscribeToTextBoxEvents(RadTextBoxElement)

Declaration
protected virtual void UnsubscribeToTextBoxEvents(RadTextBoxElement textBox)
Parameters
RadTextBoxElement textBox

Events

SearchCriteriaChanged

Occurs when the search criteria changes.

Declaration
public event EventHandler<MapSearchEventArgs> SearchCriteriaChanged
Event Type
System.EventHandler<MapSearchEventArgs>

Extension Methods