Search Textbox

Search Textbox

This element is used to display a text box used for search on the page.

Attributes

NameDescriptionValue
id

Unique Identifier.

Any
nameThe search textbox name.Any
visiblemodesThe modes the search textbox should be visible.A comma-separated list of the modes (read, new, edit)
visibilityconditionsThe conditions that should be met in order to display the search textbox.'[[pagefunction, datatype, datapath ]]' operator(==,!=) 'value'
readonlyIf is true then the search textbox value cannot be changed.true or false
readonlyconditions

The conditions that should be met in order to display the search textbox in read only mode.

'[[pagefunction, datatype, datapath ]]'
datapathThe data path field name.Needs to correspond to the CRMDO object field
datatypeThe type of datapath field.alias, java.lang.Integer, java.lang.String, ...
refreshThe parts of the page that should be refreshed when the search textbox is changed.

page

mainmenu

main

details

tab,tabID

component,is_on_tab:is_on_menu:tabID:componentID

element,is_on_tab:is_on_menu:tabid:componentID:elementID

section,sectionID

area,areaID

valueThe value of the search textbox.'[[pagefunction, datatype, datapath ]]'
disabletimerIf its true then quick search starts when the user presses 'enter'.true or false
modalrefIf no modal is specified in the search textbox then modalref is mandatory.

modal name, component id

example: <modalref>AccountQuickSearch,false:false:null:toAccount</modalref>

modalThe modal to start searching for.As specified in modal
dataformattingSpecific formatting of data.

Define the minimum digits for the quick search: MINIMUMDIGITS: 6

Define the time in milliseconds between the last key pressed and the start of the quick search. A value between 500 and 10000 is allowed.

urlIf the URL is specified the text in read mode is a link.Any
searchoperatorSpecifies the search type

Supported values:  

contains

begins

ends

isautocompleteIf set to true then the textbox then previous values will be shown. By default is set to truetrue,false

Examples

 Search Textbox


Search Textbox
<searchtextbox>
	<id>stbAccountReceivable</id>
	<label>key_accounts_receivable</label>
	<value>[[getValue,java.lang.String,accountReceivable/name]]</value>
	<visiblemodes>new,edit</visiblemodes>
	<modal>
		<id>mdlAccountReceivable</id>
		<type>quicksearch</type>
		<refresh>component,false:false:null:cmpAccountReceivable;component,false:false:null:cmpContactInformation</refresh>
		<datasetname>accounts.load</datasetname>
		<datasetreturnhiddenfield>ACCRECID</datasetreturnhiddenfield>
		<datasetsearchtable>ACCOUNTSRECEIVABLE</datasetsearchtable>
		<datasetsearchfield>ACCRECNAME;ACCRECNUM;LIFECYCLESTATE</datasetsearchfield>
		<assignments>
			<assignment>
				<classname>com.crm.dataobject.accounts.CRMDOAccountReceivable</classname>
				<datapath>accountReceivable</datapath>
				<value>accRecId</value>
				<datatype>load</datatype>
			</assignment>
		</assignments>
		<onclosefunction>
			<functions>
				<function>
					<type>ejb</type>
					<classname>ejb/CRMUIAccountReceivable</classname>
					<functionname>loadForm</functionname>
					<resultaction>fieldreplace</resultaction>
					<datapath>accountReceivable</datapath>
					<parameters>
						<parameter>
							<value>[[getValue,java.lang.String,accountReceivable/id]]</value>
							<datatype>java.lang.String</datatype>
						</parameter>
					</parameters>
				</function>
			</functions>
		</onclosefunction>
	</modal>
</searchtextbox>