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	Description
Title	Allows you to enter a title for the Web Part, or accept the default. This field is mandatory.
Catalog	See Catalog.
Display Fields	See Display Fields on page 350.
Entity Relationship	See Entity Relationship

Catalog

Entities contain the following elements:

Table 2. Catalog

Element	Description
Advanced Mode	Turn on if you want to edit Catalog in XML format.
System	Allows you to specify the system name that is defined in the System Integration configuration file. If the system name does not exist in the System Integration configuration file, you will get an error.
Service	Allows you to specify the service name that is defined in the System Integration configuration file. The service name that you specify here must belong to system that you specify in the System attribute. If the service name does not exist in the System Integration configuration file, you will get an error.
Name	Allows you to specify the name of the entity which must be unique within this Catalog. The name does not have to match with any name in your external system. However, it is recommended that you use a descriptive name for your entity. This field is mandatory.
Set Session Name	Allows you to enter name of the session variable where the edited or newly created item is stored when it is saved, or the item that is being displayed or edited is stored when it is loaded.
Reset Session Names	Allows you to reset (set to NULL) the value of the session variable whose name is specified in this attribute. Specify multiple names by separating them with commas.
Default	Allows you to define this entity as the default for the list form. If this element is not specified, the first entity that is listed in the catalog becomes the default entity. The default operation of the default entity is the operation that is used to retrieve the data when the list form is loaded for the first time in edit or display mode.

You can add operations to your entities by configuring the following elements:

Table 3. Operations

Element	Description
Name	Allows you to specify the name of the operation. This name does not have to match with any name in your external system. This name is used to refer to this operation in the Action property. This field is mandatory.
Method	Allows you to specify the real name of the operation in your external system. For example, it may refer to the name of a web service method. Or it may refer to the name of a stored procedure in your SQL Server database.
Default	Allows you to define this operation as the default. The default operation is the first operation that is called to retrieve the entity to be displayed or edited. If this attribute is not specified, the first operation listed in the entity becomes the default operation.

You can define parameters for the operation by configuring the following elements:

Table 4. Parameters

Element	Description
Name	Allows you to specify the name of the parameter.
Source	Allows you to define the source of this parameter. The source can be one of the following: • DefaultValue — the value of the parameter that is the default • NullValue — the value of the parameter is blank • FixedValue — the value of the parameter that is defined in the Value attribute • HttpRequest — the value of the parameter that is retrieved from the HTTP parameters in the page URL. The name of the HTTP parameter is defined in the SourceName attribute. As an example, say the current page URL is http://mysite.com/default.aspx?ProductType=Hardware. If the SourceName attribute is ProductType, the value of the ProductType HTTP parameter, which is Hardware, is used as the value of the parameter. • Input — the value of the parameter that is retrieved from one of the input fields in the form. You specify the name of the input field in the SourceName attribute. Additionally, you can retrieve the current user information as the value of the parameter. You can specify one of the following name in the SourceName attribute to retrieve the current user information: • RowFromAnotherWebPart — the value of the parameter that is retrieved from the row that is consumed from another web part. You specify the name of the field that is consumed in the SourceName attribute. • Session — the value of the parameter that is retrieved from the row that is stored in the session. You specify the name of the session in the SessionName attribute. You specify the name of the field that is consumed in the SourceName attribute. • ComplexType — the value of the parameter is an object based on the Type attribute and Member definition inside the Parameter. Array and nested complex types are supported. • Array — the value of the parameter is an array of values • XML — the value of the parameter that is dynamically built when the condition is execute at runtime
Usage	Allows you to define the direction for this parameter. The options are In, Out, InOut, or ReturnValue.

You can define one or more Property elements.

Table 5. Properties

Element	Description
Name	Allows you to specify the name of the property. Refer to the documentation for the DAO Provider to your external system will tell you the name of the property that you must define.
Type	Allows you to specify type of value that is specified in the Value attribute. Example: System.String.
Value	Allows you to specify the value of the property.

Entity Relationship

Allows you to create a parent-child entity relationship. The default entity from the Catalog will be considered as the Parent Entity. If no default entity is chosen in the Catalog, then the first entity in catalog is considered as default entity. Anyone of the remaining entities can be used to select as a child entity. When you select the Edit button, a dialog box opens with a list of parent and child key fields based on the list.

Entities contain the following elements:

 

Table 6. Entity Relationship

Element	Description
Advanced Mode	Turn on if you want to edit Entity Relationship in XML format. XML will look like the following <EntityRelations> <EntityRelation ParentEntity="parentEntityName" ParentKeyFieldName=" parentKeyFieldName" ChildEntity="childEntityName" ChildKeyFieldName="childKeyFieldName" Default="true" /> </EntityRelations>
Parent Entity Key Field Name	Allows you to select parent entity key field name.
Child Entity	Allows you to select child entity.
Child Entity Key Field Name	Allows you to select child entity key field name.

Display Fields

This property defines what fields should be displayed in the ListView and how the fields are populated.

Advanced Mode

Turn on if you want to edit Display Fields in XML format.

Data Index/Data Member

 

NOTE: This section is optional.

The Data Index allows you to define the index of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables. If the data table does not have any meaningful name, use the Data Index propertY.

The Data Member allows you to define the name of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables and those tables do not have any meaningful name. If the data table has meaningful name, you can refer to it by using the Data Member property.

If neither the Data Member or the Data Index is specified, the first data table in the data set is used.

Fields

Click Add Field to add fields to be displayed in the web part. You can add the following values for the fields to be displayed.

 

Table 7. Fields

Values	Description
Name	Displays the field name.
Title	Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. Change the displayed title, for example, when the title is too long or to make the title more descriptive.
Width	Allows you to set the width. It can be a plain string or an encoded HTML string. The Description is added below the field value.

Field Properties

You can further define properties for the fields to be displayed by configuring the following:

 

Table 8. Field Properties

Property	Description
Field Name	Displays the field name.
Title	Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. Change the displayed title, for example, when the title is too long or to make the title more descriptive.
Title Resource ID	If supporting a multi-lingual site, you may want to display a different Title for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The TitleResourceID 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 is not found, the default Title is used.
Horizontal Align	Allows you to set the horizontal alignment.
Vertical Align	Allows you to set the vertical alignment.
Hidden	Allows you to hide the field. If the field is hidden, the qSIListView will not modify that field at all. If you hide the field using the Hidden attribute, the field is processed according to the way it is defined, but it does not display.
Width	Allows you to set the width of the control in pixels. NOTE: Some controls, such as the Rich Text Editor, have minimum width and it will not honor the specified width if it is smaller than its minimum width.
Item Style	Allows you to define a distinct style for the item. You should define the style as you would define the style in CSS file.
Item CSS Style	Allows you to define a distinct style for the column and you already have defined the style in an external CSS file. This attribute takes precedence over the Item Style attribute.
Fixed Value	Allows you to enter the text that is displayed as a value for this field. This is useful when you want static text such as Edit displayed in a field. You can then make this text a hyperlink using either the LinkTo or LinkToSource attributes. NOTE: If you are using Advanced Mode, you can configure Fixed Value as in the following example: <Field Name="EditColumn" FixedValue="Edit" LinkTo="Lists/ListName/EditForm.aspx?ID=&lt;%ID%&gt;" /> To display an icon instead of a text, you can do the following (it assumes that you have pencil.gif in the images folder in your site: <Field Name="EditColumn" FixedValue="&lt;img src=&quot;images/edit.gif&quot; border=0&gt;" LinkTo="Lists/ListName/EditForm.aspx?ID=&lt;%ID%&gt;" />
Calculated Value	Recognizes the field replacement expression <%Field%> to refer to a field. The listview replaces the field replacement expression with the value of the field for each row of data. When using this attribute, you must use the Name of a field that does not exist in the list. It is because the listview constructs this field dynamically instead of using an existing field in the list. If you use the name of an existing field, you will get an error that the field already exists. NOTE: If you are using Advanced Mode, you must use the encoded form of the < and > characters, which are &lt; and &gt;, respectively, unless you type in the value in the Display Fields editor in the List View Editor, where the Editor will encode the characters automatically for you. This attribute helps you: • Display a full name by concatenating the first name and last name as follows: <Field Name="CalculatedFullName" Title="Full Name" CalculatedValue="&lt;%First Name%&gt; &lt;%Last Name%&gt;" /> • Display the status of your project with different colors depending on its value. In order to do this, you can write a JavaScript function and then call that JavaScript function using this attribute. <Field Name="CalculatedProjectStatus" Title="Status" CalculatedValue="&lt;script&gt;FormatProjectStatus('&lt;%Status%&gt;');&lt;/script&gt;" /> This assumes you have a JavaScript method called DisplayProjectStatus defined on your page or in a JavaScript file that is included in your page. That JavaScript method looks like: <script language="javascript"> function FormatProjectStatus(status) {    var displayedStatus = status;    if (status = 'Behind')    {       displayedStatus = '<font color="red">' + status + '</font>';    }    return displayedStatus;  } </script> You can format the value of the field in virtually any way you want. For example, you can replace the text value with different images to give the user a pleasant look in the presentation. NOTE: You can only call one JavaScript function in the CalculatedValue attribute and the JavaScript function must return a string.
Link To	The listview turns the field into a hyperlinked column to the specified URL. The URL can be an absolute or relative URL. The LinkTo can use the <%field name%> field replacement expression. NOTE: If you are using Advanced Mode, you must use the encoded form of the < and > characters, which are &lt; and &gt;, respectively unless you type in the value in the Display Fields editor in the List View Editor, where the Editor will encode the characters automatically for you. Every field that you refer to in the field replacement expression must be specified in the Display Fields property. If you do not want to show that field to the user, you can use the Hidden attribute to hide the field. If you use a relative URL, the URL is appended to the URL of the current page. Here is an example on how to make the Title field a hyperlink column to the edit form of the Tasks list: <Field Name="ProjectName" LinkTo="ProjectDetail.aspx?ID=&lt;%Projec tID%&gt;&Source=default.aspx" />
Link To Source	The listview will make the field value a hyperlink to the URL specified in the Source HTTP parameter of the current request. For this option to work, the current page URL must look like: http://.....?Source=.... The LinkToSource is useful when you want to make the URL in the link dynamic. In that case, you can pass in the URL for the link into the HTTP parameter of your page. For example, say that we have a page where the user can select a particular contact from the Contacts list. This page might be useful for several cases in your application and you cannot hard code the URL because you may want the user to be redirected to different URL depending where they are in the application. In that case, you can specify the URL for the hyperlink in the URL of the page.
Open Link In	Allows you to define how the Link To Field opens. NOTE: If you select Dialog, you can configure the dialog width and height. NOTE: For Internet Explorer 9, the "NewWindow" option requires the user to set the following: Internet Options | General |Tabs | Settings > When a pop-up is encountered > 'Always open pop-ups in a new window'.
HTML Encode	Allows the value in the field to be encoded first prior to being displayed. You need to set this to true if this field contains values that are surrounded by < and >, such as <abc>. Without the encoding, the value will not be displayed properly.
Show User Groups	Allows you to show groups where the user is a member of one of the SharePoint groups listed. Separate site group names with commas.
Hide User Groups	Allows you to hide groups where the user is a member of one of the SharePoint groups listed. Separate site group names with commas.
Display Format	Specifies how the field value is formatted when displayed. For more detail about the syntax of the DisplayFormat attribute, see Display Format. The Field element can contain one or more Aggregate elements if its Grouped attribute is set to true. The following are the attributes of the Aggregate element: • Text — The text that will precede the aggregated value when it is displayed. • Aggregate Function — These are the choices for the aggregate function: Sum, Min, Max, Last, First, Count. • Field Name — The name of the field where the aggregation is performed. • Format String — This attribute defines how the aggregated value is displayed. See the syntax of the format string in the DisplayFormat attribute.
Type	Allows you to select the type of field to edit.
Allow Edit	Select to make the field editable.
Grouped	Allows the data to be grouped by this field. You can set the Grouped attribute of multiple fields to true if you want to have a subgroup. • Group Sort Direction — This attribute determines whether the values in the header of the grouped field must be displayed in ascending or descending order. The options are asc for ascending order or desc for descending order. The default value is asc. • Group Expanded — If set to true, the group is initially expanded. Otherwise, it is collapsed. If not specified, the default value is true. When you select Grouped, you can add aggregate elements. • Text — allows you set the text that precedes the aggregated value when displayed • Aggregate Value — allows you to choose an aggregate function • Field Name — allows you to enter the name of the field where the aggregation will happen • Format String — defines how the aggregated value is displayed