Advanced Settings

Auto Complete Setup XML

Use this property to set up and configure the workplace Auto Complete field.  This is an XML string that should contain a parent node called AutoCompleteProperties.

Example:

<AutoCompleteProperties>
    <EnableMultiSelect>true</EnableMultiSelect>
</AutoCompleteProperties>

AppendSource

Indicates if the link saved for the selected value should include the source page of the list item being saved.

Default: True

BusyMessage

A text value that controls the text that is displayed when multi-select is enabled and an action such as add or remove is being performed.

Default: Working….

CharsToInitiateSearch

An integer value that controls the number of characters that must be entered before a search will be initiated.

Default: 0

CollapseAnimation

Controls the animation type that the Auto Complete drop-down will perform when an item has been selected.

Options: Linear, InQuad, OutQuad, InOutQuad, InCubic, OutCubic, InOutCubic, InQuart, OutQuart, InOutQuart, InQuint, OutQuint, InOutQuint, InSine, OutSine, InOutSine, InExpo, OutExpo, InOutExpo, InBack, OutBack, InOutBack, InBounce, OutBounce, InOutBounce, InElastic, OutElastic, InOutElastic

Default: Linear

CollapseAnimationDuration

An integer value that controls the duration in milliseconds that the collapse animation takes to perform.

Default: 300

CollapseDelay

An integer value that controls the delay time in milliseconds that the auto complete drop-down controls  will take to close once an item is selected.

Default: 500

CreateNewItemUrl

Use this property to specify the URL that will be opened so that users can create additional/new items without having to leave the current form.  As with other CorasWorks URL properties, the site URL variables <%SiteURL%> and <%HostName%> can be used. 

CssClass

Controls the css class style that will be used to display the auto complete field.

Default:

DataKeyValue

The XML node location of the value that will be used by the Workplace Lookup to assign a unique identification key to each choice item. This property can be specified in one of two ways:

1)    A simple xpath query, represented by the following:
                                :xpath=(your xpath query here)

2)    An XML string, which allows you to specify a more complex value consisting of multiple xpath queries and static text values. The XML string will contain a values root node with child value nodes representing your individual string pieces. The value nodes contain a single attribute type which tells the property whether it should treat the value as static text or an xpath query. The attribute values are type="text" or type="xpath".

Default:                empty

Example:             :xpath=NewDataSet/Table1/Title
                                <values>
                                                <value type="xpath">NewDataSet/Table1/Title</value>
                                                <value type="text"> - </value>
                                                <value type="xpath">NewDataSet/Table1/Description</value>
                                </values>

TIP: If there is no single value that you can use to uniquely identify each choice, try using the second property to join two or more values to create one unique value.

DataLinkValue

The XML node location of the value that will link the choice back to its parent details. This link is utilized on the item display form from within SharePoint. This property is optional. It can be specified in one of two ways:

1)    A simple xpath query, represented by the following:
                                :xpath=(your xpath query here)

2)    An XML string, which allows you to specify a more complex value consisting of multiple xpath queries and static text values.  The XML string will contain a values root node with child value nodes representing your individual string pieces.  The value nodes contain a single attribute type which tells the property whether it should treat the value as static text or an xpath query.  The attribute values are type="text" or type="xpath".

Default:                empty

Example:             :xpath=NewDataSet/Table1/Title
                                <values>
                                                <value type="xpath">NewDataSet/Table1/Title</value>
                                                <value type="text"> - </value>
                                                <value type="xpath">NewDataSet/Table1/Description</value>
                                </values>

DefaultValue

The text value that controls the default value.

Default:

DisplayValue

The XML node location of the display text to be presented by the lookup to users as the choices for selection.  This property can be specified in one of two ways:

1)    A simple xpath query, represented by the following:
                :xpath=(your xpath query here)

2)    An XML string, which allows you to specify a more complex value consisting of multiple xpath queries and static text values. The XML string must contain a values root node with child value nodes representing your individual string pieces.  The value nodes contain a single attribute type which tells the property whether it should treat the value as static text or an xpath query.  The attribute values are type="text" or type="xpath".

Default:                empty

Example:             :xpath=NewDataSet/Table1/Title
                                <values>
                                                <value type="xpath">NewDataSet/Table1/Title</value>
                                                <value type="text"> - </value>
                                                <value type="xpath">NewDataSet/Table1/Description</value>
                                </values>

EnableLoadOnDemand

A Boolean value that controls if the auto complete field will automatically fetch data every time, or just when a user interacts with the auto complete control.

Default: true

EmptyMessage

A text value that controls the string that is displayed in the auto complete drop-down box when no items are present.

Default: No Items

EnableMultiSelect

A Boolean value that controls if the auto complete field is capable of storing more than one selected value.

Default: false

EnablePaging

A Boolean value that controls if the Auto Complete drop-down control will display all the items or display the item in page increments.

Default: false

EnableScreenDetectionBoundary

A Boolean value that controls if the auto complete drop-down controls will display themselves appropriately if located at the edges of the page.  For example, if enabled and the control exists at the bottom of the page and there is no room to display the items in the drop-down box, it will force the items to appear on top of the control rather than below.

Default: true

EnableVirtualScrolling

A Boolean value that controls if the auto complete drop-down box will load items on demand while scrolling the drop-down box.

Default: false

EnforcePost

When enabled, forces information to be passed into the page as a post request, rather than a get request. This disables the ability to add ?Parameter=Value to the page.

ExpandAnimation

Controls the animation type that the auto complete drop-down control will perform when the control is selected.

Options: Linear, InQuad, OutQuad, InOutQuad, InCubic, OutCubic, InOutCubic, InQuart, OutQuart, InOutQuart, InQuint, OutQuint, InOutQuint, InSine, OutSine, InOutSine, InExpo, OutExpo, InOutExpo, InBack, OutBack, InOutBack, InBounce, OutBounce, InOutBounce, InElastic, OutElastic, InOutElastic

Default: Linear

ExpandDelay

An integer value that controls the delay in milliseconds that the drop-down will wait to display items once the control is triggered.

Default: 100

IsCaseSensitive

A Boolean value that determines whether or not the value being searched in the auto complete drop-down control is case-sensitive.

Default: false

ItemsPerRequest

An integer value that controls the number of items displayed and retrieved when paging is enabled.

Default: 10

LoadingMessage

The text value that is displayed in the control while items are being loaded.

Default: Loading…

Height

An integer value that controls the height of the auto complete drop-down controls.

Default: 200

MarkFirstMatch

A Boolean value that controls if the first item in the auto complete control will be selected if any items are present.

Default: false

NoWrap

A Boolean value that controls whether or not the items in the auto complete controls can be wrapped.

Default: true

OpenDropDownOnLoad

A Boolean value that controls if the auto complete drop-down control will be open and ready for selection after the page finishes loading.

Default: false

PTParams

Use this property to pass page parameters onto the page specified in the URL to XML property (see below).

Example:

                <PassThrough>

                                <Pass>

                                                <PTType>get</PTType>

                                                <PTRequest>SearchString</PTRequest>

                                                <PTName>SearchString</PTName>

                                                <PTDefault>[Me]</PTDefault>

                                </Pass>

</PassThrough>

RadComboBoxImagePosition

Controls on which side of the drop-down box the drop-down arrow is displayed.

Options: Left, Right

Default: Right                                  

SelectedItemsEmptyMessage

A text value that controls the string that is displayed in the selected items drop-down box when no items are present.

Default:

ShowDropDownOnTextBoxClick

A Boolean value that controls if the drop-down is displayed any time a user clicks within the text area of the control.

Default: false

ShowToggleImage

A Boolean value that controls whether the drop-down image next to the drop-down control is displayed.

Default: true

ShowWhileLoading

A Boolean value that controls whether the drop-down controls are visible while the items are loading.

Default: true

Skin

Controls the theme for the Auto Complete controls.

Options:

•    Black

•    Default

•    Forest

•    Hay

•    Office2007

•    Outlook

•    Simple

•    Sitefinity

•    Sunset

•    Telerik

•    Web20

•    WebBlue

•    Windows7

•    Vista

Default:  Vista

UpdateFields

An XML string property that allows a user to configure the lookup so that when a value is selected, additional fields in the list are updated with content configured from the data source.

The Additional Update Fields property accepts an XML string that should contain the following schema:

<UpdateFields>
     <Field>
         <Title InternalName="true/false">FieldName</Title>
        <FieldValue>
                1):xpath=xpath value
               2)<values>
                        <value type="xpath/text">xpath value or text</value>
                  </values>
        </FIeldValue>
   </Field>
</UpdateFields>

For each field to be updated, there should be a Field node that contains two child nodes: a Title node and FieldValue node. You can specify an internal field name by providing an InternalName attribute set to true in the Title Node.  For the FieldValue node, you can provide a single xpath statement in the following format ": xpath=" with the right side of the equation being your query value.

In addition to the xpath query, users can specify a more complex value by utilizing the Values XML fragment as seen in the other properties. The XML should contain a parent node of values and child nodes of value. Each value node should have an attribute type set to either text or xpath.  If text is specified, static text should be provided. Otherwise, if you have specified xpath, a valid xpath statement should be provided.  The FieldValue node represents the data that will be stored to the field specified in the Title node.  

Below is a sample of the property in use.

<UpdateFields>
                <Field>
                                <Title InternalName="false">Description</Title>
                                <FieldValue>
                                                <values>
                                                                <value type="xpath">CorasWorks/NewDataSet/Table1/Status</value>
                                                                <value type="text"> -</value>
                                                                <value type="xpath">CorasWorks/NewDataSet/Table1/ListID</value>
                                                </values>
                                </FieldValue>
                </Field>
                <Field>
                                <Title>test</Title>
                                <FieldValue>:xpath=CorasWorks/NewDataSet/Table1/Priority</FieldValue>
                </Field>
</UpdateFields>

URLToXML

The URL of the data source referenced by the Workplace Lookup to populate its choices. This property also supports the use of the variables <%SiteURL%> and <%HostName%>. However, the special characters must be encoded as &lt;%SiteURL%&gt; OR &lt;%HostName%&gt;

Default:              empty

Examples:          http://domain.com/LookupDataSources/Contacts
                            &lt;%SiteURL%&gt /LookupDataSources/Contacts

 

URLToXMLFilter

This is a required setting; if left blank, no data will be returned. It establishes a connection to the filtered data source connection.

 Note: The Workplace Auto Complete will pass a query string parameter "filter=" with the value of the search filter on the right side of the equation.  If using the External Data Provider, you will need to make sure you have provided this parameter as part of the values nodes.

This property can be entered in standard URL format (http://www.yoursite.com/tasks.aspx) or using shortcuts such as:

•    <%SiteUrl%>

•    <%HostName%>

 

UseBeginsWith

Indicates whether the filter should search the beginning of the text only, rather than the entire text.

ValueMember

The XML node location of the value that will be stored in the SharePoint list when the item is selected and the list item is saved.  This property is optional; if no value is provided, the lookup will utilize the value represented by the URL to XML . This property can be specified in one of two ways:

1)    A simple xpath query, represented by the following:
                                :xpath=(your xpath query here)

2)    An XML string, which allows you to specify a more complex value consisting of multiple xpath queries and static text values. The XML string will contain a values root node with child value nodes representing your individual string pieces. The value nodes contain a single attribute type which tells the property whether it should treat the value as static text or an xpath query. The attribute values are type="text" or type="xpath".

Default:  The value of the URL to XML property

Example:             :xpath=NewDataSet/Table1/Title
                                <values>
                                                <value type="xpath">NewDataSet/Table1/Title</value>
                                                <value type="text"> - </value>
                                                <value type="xpath">NewDataSet/Table1/Description</value>
                                </values>

 

Width

An integer value that controls the width of the auto complete drop-down controls.

Default: 200

 

Back to Top

Sequence Number

Controls the sequence for which all AutoComplete fields in the list will execute. Specify any number greater than 10,000.

Back to Top