[[PageOutline]]
[wiki:Documentation] > [wiki:Widgets]
[[BR]][[BR]]
|| '''Automatically generated page, do not modify.  User-contributed notes can be created at: [wiki:Widgets/SearchUsageNotes]'''||
[[BR]]

= Widget: Search =

A widget which will perform an attribute based search

== Usage Notes ==

See: [wiki:Widgets/SearchUsageNotes]

== Common Widget Properties ==

 * '''Location''' : 
 * '''Label''' : Search
 * '''Tooltip''' : Click to carry out a search on the map data
 * '''StatusText''' : 
 * '''ImageUrl''' : images/icons/search.png
 * '''ImageClass''' : 
 * '''StandardUi''' : true
 * '''ContainableBy''' : Any

== Parameters ==

=== Target ===

 * '''Label''' : Target
 * '''Type''' : target
 * '''Description''' : The frame, window, or TaskPane in which to display any UI for the widget. If empty, a new window is used
 * '''IsMandatory''' : true

=== Prompt ===

 * '''Description''' : The prompt to display beside the user input
 * '''Type''' : String
 * '''Label''' : Prompt
 * '''DefaultValue''' : 
 * '''IsMandatory''' : false

=== Layer ===

 * '''Description''' : Layer name in the map on which to carry out the search
 * '''Type''' : String
 * '''Label''' : Layer
 * '''DefaultValue''' : 
 * '''IsMandatory''' : false

=== Filter ===

 * '''Description''' : The search expression template to return features
 * '''Type''' : String
 * '''Label''' : Filter
 * '''DefaultValue''' : String
 * '''IsMandatory''' : false

=== MatchLimit ===

 * '''Description''' : The maximum number of hits to return
 * '''Type''' : integer
 * '''Label''' : Match limit
 * '''Min''' : 0
 * '''DefaultValue''' : 100
 * '''IsMandatory''' : false

=== ResultColumns ===

 * '''Description''' : An XML structure describing the columns to be returned as part of the search and their labels
 * '''Type''' : XML
 * '''Label''' : ResultColumns
 * '''DefaultValue''' : 
 * '''IsMandatory''' : false

=== Title ===

 * '''Description''' : The title to use for the search form
 * '''Type''' : String
 * '''Label''' : Title
 * '''DefaultValue''' : 
 * '''IsMandatory''' : false