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.
Viewed Lists	See Viewed Lists for more information.
Display View	See Display View for more information.
Display Fields	See Display Fields for more information.
Child View Display Fields	Defines the fields that should be displayed in the view for the child records. See Display Fields for more information.
Expand Child View on Load	Determines if the child view is expanded or collapsed when the listview is loaded for the first time. By default, this property is set to false which means the hierarchical listview does not expand the child view. If set to true, the entire child view expands when the listview is loaded for the first time.
Enable New Item Link in Child View	Allows you to display the New Item link in the child view.
ID HTTP Parameter Name	Allows the qListForm and several other web parts to an HTTP Parameter called ID to identify the item to be displayed or edited. This HTTP Parameter is usually generated automatically by the viewer web part, such as qListView or qCalendarView, when you select an item to be displayed or edited. NOTE: If qListForm is placed on a web part page that is contained within a document library, the page will generate an error if the value of the ID HTTP Parameter is bigger than the number of pages within the document library. To prevent this error from happening, rename the ID HTTP Parameter. By default, the value of this property is "ID". You can change the value of this property to something else, such as LID. In that case, when you select "View Properties" or "Edit Properties" in the context menu, the URL of the display or edit form becomes: http://mysite.com/EditFormURL.aspx?LID=xxx Set the same property in the qListForm to the same value.

Viewed Lists

This property defines the following:

•

The lists whose data is viewed in the listview and the manner it is aggregated. There are a few ways that you can aggregate information from multiple lists in the listview. First, you can define the lists to be aggregated one by one. Second, you can define the site URL for the aggregated lists in a Rolled-Up list. Third, you can aggregate the information from lists with a particular name from all the subsites (recursive rollup).

•	The parent list and the child list in the hierarchical listview. You can only define one child element per list. The hierarchical listview does not work when you aggregate the information using the Rolled-Up list and recursive rollup.

•	The Dependent Lists for each list. If the Dependent Lists information is provided, the listview checks whether there are child records in the Dependent Lists when the user tries to delete items from the listview. If there are any, the listview will not delete the selected items.

The Lists element can contain one or more List elements. The listview will aggregate the information from all of the List elements that you specify. To define the hierarchical listview, each List element can contain one child List element.

The following are the elements for the Viewed List attribute.

 

Table 2. Viewed List

Element	Description
Advanced Mode	Turn on if you want to edit Viewed Lists in XML format. XML will look like the following: <Lists>   <List SiteUrl="siteUrl" ListName="listName" IncludeSubsites="true/false" IncludeThisSite="true/false" IsRollupList="true/false" SiteUrlFieldName="fieldName" RolledUpListName="listName" TargetUrl="targetUrl" SetSessionName="sessionName" ResetSessionNames="name1, name2" NewFormUrl="URL" EditFormUrl="URL" DisplayFormUrl="URL">   <!-- To define a child list in a hierarchical listview, you can add List element in the parent List element. You can only have one child list. -->   <List SiteUrl="siteUrl" ListName="listName" ParentKeyFieldName="parentKeyFieldName" ChildKeyFieldName="childkeyFieldName" TargetUrl="targetUrl" SetSessionName="sessionName" ResetSessionNames="name1, name2" NewFormUrl="URL" EditFormUrl="URL" UseUploadFormInLayoutsFolder="true/false" DisplayFormUrl="URL">   <!-- To define dependent lists, add a DependentLists element inside the List element -->   <DependentLists>      <List SiteUrl="siteUrl" ListName="listName" KeyFieldName="keyFieldName" />      <List SiteUrl="siteUrl" ListName="listName" KeyFieldName="keyFieldName" />   </DependentLists>    </List>    <List ...></List>    <List ...></List> </Lists>
Site URL	Allows you to set 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. This attribute is mandatory. When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash (/) to denote the root path. NOTE: If you want to connect the listview with another Web Part in Microsoft SharePoint Designer, the SiteUrl property must contain an absolute URL. We recommend that you keep all URLs in the Web Part configuration relative to ensure site portability. If you must, use an absolute URL temporarily, make the connection, and then change the URL to a relative one.
List Name	Allows you to enter the name of the SharePoint list that is edited or displayed. The list name is case sensitive. If the list name contains spaces, include the spaces here as well. To denote the current list, you can use a single dot (.) as the list name. NOTE: This only works if the qListView is contained in the AllItems.aspx. For example, if you are replacing the Microsoft List View in the AllItems.aspx of the Tasks list and you use a single dot as the ListName attribute, the ListName attribute of the qListView is set to Tasks. If you want to save the list as a template and then add it somewhere else, the name of the new list might not be Tasks and using this relative list name will automatically pick up the new list name for the view.
List Type	Indicates the type of the list selected. This is a read-only field and displays for all available list templates.
Include Subsites	If set to true, the listview searches all the subsites for a list whose name specified in the ListName and aggregate the information from those list. NOTE: If you have many subsites, the information may take a long time to aggregate. Use this attribute if you have only a small amount of subsites. You must test this feature in your environment to see whether or not the response comes back in a reasonable amount of time and the request does not time out.
Include This Site	Used in conjunction of the IncludeSubsites attribute. If you set this property to true, the list in the current site will not be aggregated by the listview. The current site is the site whose URL is specified in the SiteUrl attribute.
Is Rollup List	Indicates whether or not the list specified by the SiteUrl and ListName attributes contains the Site URLs of the lists to be aggregated instead of the data to be aggregated. If you set this to true, the list specified by the SiteUrl and ListName must have a field that contains the URL information. By default, the name of that field is Site URL. If you use different field name, specify the name using the SiteUrlFieldName attribute.
Rolled Up List Name	Used in conjunction with the IsRollupList property, indicates the name of the lists to be rolled up if you set the IsRollupList to true. If you want to aggregate more than one list from each site specified in the rollup list, you can define more than one List elements with the same rollup list, but different RolledUpListName.
Site URL Field Name	Used in conjunction with the IsRollupList property, indicates the field that contains the Site URLs of the lists to be aggregated. This attribute is optional if the field name is Site URL. NOTE: The Site URL field must be a single line of text field.
Active Field Name	Used in conjunction with the v IsRollupList property. The rollup list may contain a Yes/No field to indicate whether or not a particular site should be included in the rollup. This property is optional if the name of this field is Active. NOTE: The Active field must be a Yes/No field.
Reset Session Names	Resets (sets to NULL) the value of the session variables whose name is specified in this attribute. You can specify multiple names by separating them with commas; for example  TaskSession, IssueSession. You can reset the session name if a list has one or more tasks associated with it. In addition to storing the selected list in the session, you may store the dependent task information in the session as well. This means that every time you store a new list into a session, you need to reset the dependent task information from the session as well.
Set Session Name	Defines the name of the session variable where the listview stores the item whose column is being clicked by the user. The user can click the item if one of the LinkTo, LinkToTarget or the LinkToSource attributes in the Display Fields property is defined. This attribute is usually used if you have another Web Part (such as the qListForm) that can consume the stored values from the session. You can set the session name when you want to consume the item from a session variable in a qListForm later.
Target URL	When the LinkToTarget attribute of a specific column is set to true (in the Display Fields property), the data in that column becomes a hyperlink to the URL specified in this attribute. NOTE: If you using Advanced Mode, the TargetUrl can use the <%field name%> field replacement expression. But you must use the encoded form of the < and > characters, which are &lt; and &gt; respectively. Use the LinkToTargetUrl attribute if you want each list to have a different URL; for example, when you want to aggregate multiple lists from the same workspace and connect a certain column to the display form of the list. In that case, the URL to the display form of each list is different.
Create Document Form URL	When specified, the New button (and all the buttons for specific content types underneath it) will redirect the user to the URL specified by this attribute. Normally, the page pointed to by CreateDocumentFormUrl will contain a qListForm to create the new document. For more detail about this, see the Create Document section of the qListForm chapter. CreateDocumentFormUrl will affect all types of list, not just document library. There is no difference between CreateDocumentFormUrl and NewFormUrl when the list is not a document library. You can specify either to affect the target URL for the New button. But if both are specified, the CreateDocumentFormUrl will take precedence. When the list is a document library, CreateDocumentFormUrl will affect the New button and the NewFormUrl will affect the Upload button.
New Form URL	Indicates the URL where the form to create a new item resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when one of the New buttons in the toolbar is clicked. If not defined, the user is redirected to the NewForm.aspx of the list (or Upload.aspx for the document library). Redefining the New Form URL is useful if you have different way of creating an item depending on the current view. For example, in the view for external vendor, you may want to give them a new form that does not contain all the fields in the list. NOTE: The Source HTTP parameter is automatically appended to the New Form URL during redirection. This attribute is usually used in conjunction with the qListForm Web Part.
Edit Form URL	Indicates the URL where the form to edit an item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks Edit Properties in the Context Menu. If not defined, the user is redirected to the EditForm.aspx of the list. Redefining the Edit Form URL is useful if you have different ways of editing an item depending on the current view. For example, in the view for external vendor, you may want to give them an edit form that does not contain all the fields in the list. NOTE: The ID and Source HTTP parameters are automatically appended to the Edit Form URL during redirection. This attribute is usually used in conjunction with the qListForm Web Part.
Display Form URL	The URL where the form to display an item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks View Properties in the Context Menu. If not defined, the user is redirected to the DisplayForm.aspx of the list. Redefining the Display Form URL is useful if you have different way of displaying an item depending on the current view. For example, in the view for external vendor, you may want to give them a display form that does not contain all the fields in the list. NOTE: The ID and Source HTTP parameters are automatically appended to the Display Form URL during redirection. This attribute is usually used in conjunction with the qListForm Web Part.
Launch Form In	Defines how the form pages (NewForm, EditForm, DisplayForm) associated with a SharePoint list are launched. There are 3 different options: Dialog, New Window, and Current Window. This property defaults to <Empty> in which case the form dialog obeys the settings under List Settings/Advanced Settings. NOTE: If you select Dialog, you can configure the dialog width and height.
Use Upload Form in Layouts Folder	Allows you to link to the Upload.aspx page in the _Layouts folder instead of the Upload.aspx page in the Forms folder of the document library. NOTE: This option was useful with SharePoint 2007. It is still available for legacy purposes, but you no longer need to enable it.

The List element for the child list must contain these additional attributes:

 

Table 3. List element for child list

Element	Description
Parent Key Field Name	Allows you to enter a name in the field in the parent list that will act as the filter for the child records. In other words, this is the primary key field in the parent list.
Child Key Field Name	Allows you to enter a name in the field in the child list that is filtered by the value from the parent key field. In other words, this is the foreign key field in the child list.

The List element can contain only one DependentLists element. The DependentLists element can contain one or more List element. The List element inside the DependentList can contain the following attribute:

 

Table 4. List element inside Dependent Lists

Element	Description
Site URL	Allows you to enter the URL to the site that contains the dependent list.
List Name	Allows you to enter the name of the dependent list. The list name is case sensitive. This property along with the SiteUrl defines the dependent list.
Key Field Name	Allows you to enter the name of the field in the dependent list that contains the ID of the parent item. In another word, the KeyFieldName is the foreign key in the dependent list. The key field is usually a single line of text that contains the parent item ID or a cross-site lookup field to the parent list. The name is case sensitive

Display View

This property enables you to define list view fields in single view or multiple views.

This property is related to the Display Fields property. In order to place a certain field in a specific view, you will select the required Views option in the Display Fields property.

NOTE: The view drop-down will only display in List View if more than one view has been configured.

The Display View section contains the following elements:

 

Table 5. Display View

Element	Description
Advanced Mode	Turn on if you want to edit Display View in XML format. XML will look like the following: <View Type="DisplayView"> <Container Type="View" ID="1" Label="View 1" /> <Container Type="View" ID="2" Label="View 2" /> </View>
ID	The identifier for the view. This ID must be unique for each view that is defined in the Display View. This identifier is referred to in the Views attribute in the Display Fields Property.
Label	The label for the view.
Show User Groups	The view is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas.
Hide User Groups	The view is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas.

 

Display Fields

This property defines the fields that should be displayed.

This property is optional if the properties in the Custom Display section is specified. In that case, the default display is turned off and the custom display is used. You can also combine the custom display with the Display Fields. A good example is when you want to display data in a grid and provide a summary of the data or a disclaimer using a custom display.

The Display Field contains the following elements:

 

NOTE: In addition to the fields in the list, the listview recognizes several special fields. You can display the following fields, group the fields or use it as a field replacement expression in the CalculatedValue attribute.

•	Item Location — The format of the Item Location value is ListName in SiteUrl. This field is useful when you aggregate multiple values into the listview to tell you where a particular item comes from.

•	Workspace URL — This field contains the URL of the site that contains the containing list.

•	List Name — This field contains the name of the containing list.

•	Folder — The server relative URL of the folder that contains this item.

•	File Path — The complete URL for a file in the document library. This variable is only available for document library.

 

Table 6. Display Field

Element	Description
Advanced Mode	Turn on if you want to edit Display Fields or Child View Display Fields in XML format. In XML, Displayed Fields look like: <Fields LookupThresholdControlSettings=”On”> <Field Name="fieldName" [optional attributes]/> <!-- For a grouped field, you can specify one or more aggregated values --> <Field Name="fieldName" Grouped="true" SortDirection="asc|desc" GroupExpanded="true|false"> <Aggregate Function="aggregateFunction" FieldName="fieldName" Text="text"/> <Aggregate Function="aggregateFunction" FieldName="fieldName" Text="text"/> </Field> </Fields>
Views	Allows you to select the views specified in Display View property. If no view is created then the default option will be Default.
Query All Fields	Controls how Web Parts behave in relation to the List View Lookup Threshold in SharePoint Resource Throttling. The options are: • Default — uses the level set in the Configuration Editor. If you have selected Query All Fields check box in the Configuration Editor, the Web Part will query only those fields that are not included in the List View Lookup Threshold. If the Query All Fields check box is cleared, the Web Part will query all fields. • On — If the Web Part level is On, the Web Part queries all fields in lists, except Lookup fields. • Off — If the Web Part level is Off, the Web Part queries all fields in lists, including Lookup fields. • Explicit — If the Web Part level is Explicit, the Web Part queries only those fields selected in the Display Fields. This option renders the best performance for your Web Part.
Add Field	Allows you to add custom fields to be displayed in the web part. NOTE: If you are using a CalculatedValue or FixedValue attribute, you must first add and configure at least one custom field.
Field Name	Indicates the name of the field selected. If you select Custom, you can change the field name. NOTE: If you configure Calculated Value, Fixed Value, Display Field Name, and Display Format, ensure the custom field name does not contain spaces. If the name contains spaces, an error message is returned.
Field Type	Indicates the type of the field selected. This is a read-only field and displays for all available list templates.
Title	Indicates the title of the field. This is useful if the real field name is too long and you want to abbreviate the title in the field header, or if you simply want to display a different title in the field header. If this attribute is not specified, the value specified in the Name attribute is used in the field header. For example: <Field Name="Created By" Title="Author" />
Title Resource ID	Indicates 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) is used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default Title is used.
Width	Indicates the width of the field. You can specify the value in pixels (Width="20px") or percentage (Width="20%"). We recommend leaving at least one field where you do not specify this property. That field will take up the remaining width of the page. For example: <Field Name="Subject" Width="100px" />
Align	Indicates the horizontal alignment for the field. The values is one of the following: left, right, or center. For example: <Field Name="Created" Align="right" />
Item Style	Indicates the style for the item in the row. You can define the style as you would in a CSS class; for example, color: red; font-weight: bold
Item CSS Class	Indicates the distinct style for the column and you already have defined the style in an external CSS file.
Fixed Value	Fixed Value appears if you have selected Custom as a Display Field. This allows you to display text 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 Link To, Link To Target or Link To Source attributes. NOTE: If you are using Advanced Mode, you can configured 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	Calculated Value appears if you have selected Custom as a Display Field. NOTE: If you are using Advanced Mode, this attribute recognizes the field replacement expression <%Field%> to refer to a field. The listview will replace the field replacement expression with the value of the field for each row of data. 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. You can use this attribute to: • Display the values from multiple fields in one grid column. For example, to display a full name, you can concatenate the first name and last name as follows: <Field Name="CalculatedFullName" Title="Full Name" CalculatedValue="&lt;%First Name%&gt; &lt;%Last Name%&gt;" /> • Reformat the values of another field, using the Display Format. You can specify the Display Format in the Field replacement expression as follow: <%{DisplayFormat}FieldName%> For example, if you have a Date Time Field called "Start Date" and you want to display it in a short date format, you can use the following field replacement expression: <%{0:d}Start Date%>. To see the available display format, see Display Format. • Format the display of a certain column in the grid. For example, you can 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;" /> The above example 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.. NOTE: You can only call one JavaScript function in the CalculatedValue attribute and the JavaScript function must return a string.
Display Field Name	If specified, indicates a cross-site lookup field. It contains the name of the field in the cross-site list that contains the value to be displayed. The field name is case sensitive. A cross-site lookup field enables you to lookup a list that resides in another site, another site collection, or another web application as long as it is in the same configuration database. You need the qListForm Web Part to create a cross-site lookup field.
Display Format	If specified, indicates a cross-site lookup field. It contains the format of the value that is displayed. Define this attribute if you want to display values from multiple fields. NOTE: If you are using Advanced Mode, you can use the field replacement expression <%Field%> to refer to a field. 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. NOTE: For more information, see Display Format
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.
Hyperlink Field Target	If this field is a SharePoint Hyperlink or Picture field, indicates the target window for the hyperlink. For example, use "_blank" if you want to open the target URL in a new window. If this attribute is left blank, the target URL will open in the current window. This attribute will not affect the hyperlink column created with the LinkTo, LinkToSource or LinkToTargetURL attributes.
Link To	Indicates that the list view turns the field into a hyperlinked column to the specified URL. The URL can be an absolute or relative URL. NOTE: If you are using Advanced Mode, the LinkTo can use the <%field name%> field replacement expression. 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. If you use a relative URL, the URL is appended to the site URL of the target site. For example, specify "Lists/TeamDiscussion/EditForm.aspx?ID=&lt;%ID%&gt;" as the value of this property. If you click a customer record that comes from the Customers list in Workspace A, whose site URL is "http://mydomain/sites/mysite", you are directed to http://mydomain/sites/mysite/Lists/TeamDiscussion/EditForm.aspx?ID=23 (assuming you click the discussion with ID=23).
Link To Target	Allows the list view to make the field value a hyperlink to the URL specified in the Target Url attribute in the Viewed Lists property. The LinkToTarget URL is used when you aggregate lists with different names. You can specify a different TargetUrl for each list in the Viewed Lists property and the list view will redirect the user to the correct URL depending on the list from where the clicked item comes.
Link To Source	The list view 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=.... Use this element when the URL for the hyperlink is dynamic. This could be because it contains dynamic parameters or the URL is different depending on the referral page. Also, 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.
Open Link In	Allows you to define how the Link To Field opens. There are 3 different options: Dialog, NewWindow, and CurrentWindow. NOTE: If you select Dialog, you can configure the dialog width and height. NOTE: If you are using 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	If selected, the value in the field is 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.
Do Not Render as Hyperlink	If selected, the value of Lookup fields is rendered as plain text instead of hyperlink.
Grouped	Allows you to group data by: • 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 false. NOTE: Grouping is not supported on any field that has "Allow Multiple Values" enabled.

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:

 

Table 7. Aggregate element attributes

Element	Description
Text	Allows you to enter the text that will precede the aggregated value when displayed.
Aggregate Function	Allows you to select a function.
Field Name	Allows you to enter a field name where the aggregation is performed.