| | 1 | [[PageOutline]] |
| | 2 | [[BR]] |
| | 3 | || '''Automatically generated page, do not modify. User Notes can be created at: [wiki:Widgets/SearchUsageNotes]'''|| |
| | 4 | [[BR]] |
| | 5 | |
| | 6 | = Widget: Search = |
| | 7 | |
| | 8 | A widget which will perform an attribute based search |
| | 9 | |
| | 10 | == Usage Notes == |
| | 11 | |
| | 12 | See: [wiki:Widgets/SearchUsageNotes] |
| | 13 | |
| | 14 | == Common Widget Properties == |
| | 15 | |
| | 16 | * '''Location''' : |
| | 17 | * '''Label''' : Search |
| | 18 | * '''Tooltip''' : Click to carry out a search on the map data |
| | 19 | * '''StatusText''' : |
| | 20 | * '''ImageUrl''' : images/icons/search.png |
| | 21 | * '''ImageClass''' : |
| | 22 | * '''StandardUi''' : true |
| | 23 | * '''ContainableBy''' : Any |
| | 24 | |
| | 25 | == Parameters == |
| | 26 | |
| | 27 | === Target === |
| | 28 | |
| | 29 | * '''Label''' : Target |
| | 30 | * '''Type''' : target |
| | 31 | * '''Description''' : The frame, window, or TaskPane in which to display any UI for the widget. If empty, a new window is used |
| | 32 | * '''IsMandatory''' : true |
| | 33 | |
| | 34 | === Prompt === |
| | 35 | |
| | 36 | * '''Description''' : The prompt to display beside the user input |
| | 37 | * '''Type''' : String |
| | 38 | * '''Label''' : Prompt |
| | 39 | * '''DefaultValue''' : |
| | 40 | * '''IsMandatory''' : false |
| | 41 | |
| | 42 | === Layer === |
| | 43 | |
| | 44 | * '''Description''' : Layer name in the map on which to carry out the search |
| | 45 | * '''Type''' : String |
| | 46 | * '''Label''' : Layer |
| | 47 | * '''DefaultValue''' : |
| | 48 | * '''IsMandatory''' : false |
| | 49 | |
| | 50 | === Filter === |
| | 51 | |
| | 52 | * '''Description''' : The search expression template to return features |
| | 53 | * '''Type''' : String |
| | 54 | * '''Label''' : Filter |
| | 55 | * '''DefaultValue''' : String |
| | 56 | * '''IsMandatory''' : false |
| | 57 | |
| | 58 | === MatchLimit === |
| | 59 | |
| | 60 | * '''Description''' : The maximum number of hits to return |
| | 61 | * '''Type''' : integer |
| | 62 | * '''Label''' : Match limit |
| | 63 | * '''Min''' : 0 |
| | 64 | * '''DefaultValue''' : 100 |
| | 65 | * '''IsMandatory''' : false |
| | 66 | |
| | 67 | === ResultColumns === |
| | 68 | |
| | 69 | * '''Description''' : An XML structure describing the columns to be returned as part of the search and their labels |
| | 70 | * '''Type''' : XML |
| | 71 | * '''Label''' : ResultColumns |
| | 72 | * '''DefaultValue''' : |
| | 73 | * '''IsMandatory''' : false |
| | 74 | |
| | 75 | === Title === |
| | 76 | |
| | 77 | * '''Description''' : The title to use for the search form |
| | 78 | * '''Type''' : String |
| | 79 | * '''Label''' : Title |
| | 80 | * '''DefaultValue''' : |
| | 81 | * '''IsMandatory''' : false |
| | 82 | |
