18
qSelector
•
Overview
•
qSelector Pages
Overview
qSelector displays data from a SharePoint list in a drop-down control. qSelector remembers the last item selected, even after you leave the page.
Using qSelector, you can:
• keep the context of your work. For example, you can manage multiple projects in one workspace easily by using qSelector. You can place a selector that displays the project information on every page in your application and use that selector to filter the data in the qListView or any other view on the page.
Because the selector remembers the last item selected even as you move from page to page, you only see the data for the same project until you switch to another project.
• place a selector above a qListForm to select a certain item and then feed that item to the list form because the qSelector is a row provider.
• support dynamic language switching and Flash and JavaScript (HTML5)
VIDEO:
If you would like to learn more, click here to watch the training video.
qSelector supports multiple languages. You can define a different Title for different languages using the
Resource List and the Title Resource ID properties. The culture for the page can be defined by appending the
Culture HTTP parameter to the page URL. For example: http://hostname/sites/sitename/default.aspx?Culture=en-US qSelector implements the following web part connection interfaces:
• IRowProvider interface, which provides a row to another Row Consumer web part or a filter to another
Filter Consumer web part.
NOTE:
The IRowProvider interface is obsolete. It is provided here only for backward compatibility reason. When you establish the web part connection, this interface is labeled
Provide Row To (Obsolete) in the web part Connections menu. Use the IWebPartRow implementation that is labeled with Send Row To.
• IWebPartRow interface, which provides a row to another web part, such as qListView.
NOTE:
The IWebPartRow implementation is labeled with Send Row To in the web part
Connection menu. This interface cannot be connected with the obsolete IRowConsumer or
IFilterConsumer implementation. Do not connect this new interface with the old interface that is marked obsolete.
• IFilterConsumer interface, which consumes a filter from another web part that implements IRowProvider or IFilterProvider interface.
Dell Quick Apps for SharePoint 6.3
User Guide
255
NOTE:
The IFilterConsumer interface is obsolete. It is provided here only for backward compatibility reason. When you establish the web part connection, this interface is labeled
Consume Filter From (Obsolete) in the web part Connections menu. Use the
IWebPartParameter consumer implementation that is labeled with Get Filter From.
• IWebPartParameter interface, which enables the selector to consume a filter from another web part that implements IWebPartRow or IWebPartParameter interface.
NOTE:
The IWebPartParameter consumer implementation is labeled with Get Filter From in the web part Connection menu. This interface cannot be connected with the obsolete
IFilterProvider or IRowProvider implementation. Do not connect this new interface with the old interface that is marked obsolete.
qSelector Pages
You can configure this web part through its pages that are accessible through ezEdit. qMultiSelector contains the following pages:
•
Content Page
•
Appearance Page
•
Advanced Page
Content Page
The Content page allows you to enter the content for your web part. It contains the following:
•
Primary Content
•
Filtering
•
Sorting
•
Selection
Primary Content
The Primary Content page is default category. You need to configure one or more elements in this page to get started using this web part.
Primary Content contains the following:
Table 1. Primary Content
Element
Title
Search Session
Name
Site URL
List Name
Display Field
Name
Description
Allows you to enter a title for the web part.
Allows you to define the search session variable name where the qSelector stores the last selected item. If you want to associate several selectors, you must define the same Search
Session Name property for all of them.
Allows you to enter the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL.
Allows you to enter a list name
Allows to enter the name of the field that you want to display in the selector.If you want to display information from multiple fields, use the Display Format properties. The Display
Field Name property is ignored if the Display Format property is defined.
Dell Quick Apps for SharePoint 6.3
User Guide
256
Table 1. Primary Content
Element
Display Format
Display Fields
Eliminate
Duplicate Values
Description
Allows you to define the format of the items that are displayed in the selector. You can
use field replacement expression (<%field name %>) to refer to a field name. For more information, see Display Format on page 15 .
Allows you to define the fields that are displayed in the drop-down menu of the web part.
If defined, the choices in the drop-down menu are displayed in a grid.
This property is an XML string in this format:
<Fields>
<Field Name="fieldName" Width="width" />
<Field Name="fieldName" Width="width" />
</Fields>
The <Fields> element may contain one or more <Field> elements.
• Name - The name of the field. The field name is case-sensitive.
• Width - The display width of the field. The value can be in pixel (for example:
200px) or percent (for example: 30%).
Allows you to define whether or not you want to eliminate duplicate values in the dropdown menu. This is useful in case you want to use the selector as a filter to another Web
Part.
Filtering
The Filtering page allows you to use CAML filters to dynamically filter records or use Complex Filters to define static filter for the data.
The Filtering page contains the following:
Table 2. Filtering
Element
CAML Filter
Complex Filter
Description
Allows you to specify the CAML (Collaboration Application Markup Language) query expression to filter your data. CAML is an XML-based query language. The CAML Filter will only be applied to the data. The filter will not be applied to the responses.
For more information, see CAML Filters on page 19 .
Allows you to use the Complex Filter expression to define a static filter for the data. The complex filter is applied to the data after the CAML Filter is applied.
NOTE:
The Complex Filter is provided here only for backward compatibility reason. In the past, Complex filter was used to support date functions.
For more information, see Complex Filters on page 22 .
Sorting
The Sorting page allows you to define the sorting criteria.
The Sorting page contains the following elements:
Table 3. Sorting/Paging
Element
Sort Fields
Sort in Ascending
Order
Description
Allows you to enter a value that is used to sort the entries. This property accepts a single field name.
Allows you to sort the entries in the ascending order. Deselect this check box if you want the entries in descending order. This field is ignored if the Sort Field property is not defined.
Dell Quick Apps for SharePoint 6.3
User Guide
257
Selection
The Selection page allows you to configure what do with empty selections. This page contains the following:
Table 4. Selection
Element Description
Show Empty Selection Allows you to display the value of Empty Selection Item Name property as the first item.
You should check this property if you want the user to be able to select nothing.
Selecting nothing returns the entire unfiltered list. Another case is when the qSelector acts as a filter to another web part and you want the ability to pass an empty filter. This means the other web part will display all its data unfiltered.allow customer to select the behavior of the empty selection. And this option is only valid for the "Get Filter From" connection type.
Turn Off Filtering When
Empty Selection is
Chosen
Allows you to turn filtering on or off if Show Empty Selection is selected. This option is only valid for the "Get Filter From" connection type.
Empty Selection Item
Name
Empty Drop-Down Item
Name
Refresh Page When
Selection Changed
Allows you to display a specified value as the first item in the Selector when the
Show Empty Selection is checked. The default is - Select One -.
Allows you to display specified text that is displayed in the drop-down menu when it contains no list items. The default is <Empty>.
Allows you to determine whether the page should be refreshed when you select another item in the selector. By default, the value is false, which means that the page is only posted back.
Appearance Page
The Appearance page allows you to set the overall look and feel of the web part. This page contains the following:
•
Ribbon
•
Selector
•
Layout
•
Other
Ribbon
The Ribbon page allows you to set the display name of the Ribbon.
Table 5. Ribbon
Element
SharePoint Ribbon Tab
Name
Description
Allows you to edit the display name of the Ribbon tab.
Selector
The Selector page allows you to configure the appearance of the selector. It contains the following:
Dell Quick Apps for SharePoint 6.3
User Guide
258
Table 6. Toolbar
Element
Skin Name
Description
Allows you to select the skin name for the grid. If you have a custom skin, you can add it to the following folder for SharePoint 2010:C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32013SP1\Skins or for
SharePoint 2013: C:\Program Files\Common Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32013SP1\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Persistent Selector Width Allows you to specify the width of the input part for the selector.
Drop Down Width Allows you to specify the width of the drop-down menu for the selector in pixels. If you specify the width for each field in the Display Fields property in pixels, the value of this property is usually the total width of all fields.
Drop Down Height Allows you to specify the height of the drop-down menu for the selector.
Layout
The Layout page allows you to set the overall layout of the web part. It contains the following:
Table 7. Layout
Element
Width
Height
Chrome State
Chrome Type
Hidden
Direction
Description
Allows you to set the web part to a fixed width
Allows you to set the web part to a fixed height
Allows you to select if the web part can be minimized or not when you open the web part.
If Minimized is selected, then only the Title Bar displays.
Allows you to select the kind of border to display around the web part.
Select this check box if you want the web part hidden
Allows you to set how the text in the web part displays depending on the language, either from Left to Right or Right to Left
Other
The Other page allows you to set the appearance of other elements in the web part. It contains the following:
Table 8. Other
Element
Allow Minimize
Allow Close
Allow Hide
Description
Select this check box if you want the web part minimized
Select this check box if you want the web part removed from the page
Select this check box if you want the web part hidden
Allow Zone Change
Allow Connections
Select this check box if you want the web part moved to a different zone
Select this check box if you want the web part to participate in connections to other web parts
Allow Editing in Personal View Select this check box if you want the web part modified in a personal view
Export Mode
Title URL
Description
Allows you to select the level of data that can be exported for this web part
Allows you to add the title of a URL as extra information about the web part
Allows you to enter a description of the web part that is displayed as a Tooltip when you hover your mouse over the web part title or icon.
Dell Quick Apps for SharePoint 6.3
User Guide
259
Table 8. Other
Element
Help URL
Help Mode
Catalog Icon Image URL
Title Icon Image URL
Import Error Message
Description
Allows you to enter the location of a file containing Help information about the web part.
Allows you to specify how a browser displays Help content for the web part, either in a separate window which you must close before returning to the Web
Page (Mode), in a separate window that you do not need to close before returning to the Web Page (Modeless), or in the current browser window
(Navigate)
Allows you to specify the location of a file containing an image to be used as the web part icon in the Web Part List. The image size must be 16 by 16 pixels.
Allows you to specify the location of a file containing an image to be used in the web part title bar. The image size must be 16 by 16 pixels.
Allows you to specify a message that appears if there is a problem importing the web part
Advanced Page
The Advanced page allows you to set advanced features of the web part, such as the following:
•
Security
•
Resources
Security
The Security page allows you to set which users are allowed to view the web part. It contains the following:
Table 9. Security
Element
Target
Audiences
Description
Allows you to have the Web Part to appear only to people who are members of a particular group or audience.
An audience can be identified by using a SharePoint group, a distribution list, a security group, or a global audience.
Resources
The Resources page allows you to enable Localization in the web part using resource lists.
Localization
Localization contains the following elements.
NOTE:
While this feature is still available to use, we recommend using ezLocalizer. For more information, see ezLocalizer on page 385 .
Dell Quick Apps for SharePoint 6.3
User Guide
260
Table 10. Localization
Element
Resource List
Title Resource ID
Description
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string. You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
Dell Quick Apps for SharePoint 6.3
User Guide
261
