Primary Content

qCalendarView : qCalendar Pages : Content Page : Primary Content

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.

ID HTTP Parameter

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 qListForm or qCalendarView, when you select an item to be displayed or edited.

NOTE: If qCalendar 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

NOTE: Set the same property in the qListForm to the same value.

Display Field Name

Allows you to select the name of the field in the SharePoint list that contains the title for the item. If you want to display the information from more than one fields, then specify the format in the Display Format property.

For more information, see Display Format

Begin Date Field Name

Allows you to select the name of the field in the SharePoint list that contains the begin date information. This drop down will only display date and time type of fields.

End Date Field Name

Allows you to select the name of the field in the SharePoint list that contains the end date information. This drop down will only display date and time type of fields.

Viewed Lists

The Viewed Lists section defines:

•

the lists whose data is aggregated in the calendar

•

the Dependent Lists for each list. If the Dependent Lists information is provided, the Calendar View checks whether or not there are child records in the Dependent Lists when the user tries to delete an item from the calendar. If there are, the Calendar View does not delete the selected item.

Viewed List contains the following list attributes:

Table 2. Viewed Lists

List Attributes

Description

Advanced Mode

Turn on if you want to edit Viewed Lists in XML format. For example:

<Lists>

<List SiteUrl="." ListName="wfpub" IncludeSubsites="false" IncludeThisSite="false" IsRollUpList="false" RolledUpListName="Public Library" UseUploadFormInLayoutsFolder="false">

<DependentLists />

</List>

</Lists>

Site URL

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.

List Name

The name of the SharePoint list that is edited or displayed by this Calendar View. 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 qCalendarView is contained in the AllItems.aspx. For example, if you are replacing the Microsoft Calendar View in the AllItems.aspx of the Tasks list and you use a single dot as the ListName attribute, the ListName attribute of the qCalendarView ise set to Tasks. If you want to save the list as a template and then use it somewhere else, the name of the new list might not be Tasks and using this relative list name automatically picks 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 selected, the Calendar View 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 few 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 is not aggregated by the Calendar View. 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 below.

Rolled Up List Name

Used in conjunction with the Is Rollup List property, indicates the name of the lists to be rolled up if you check the Is Rollup List check box.

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 Rolled Up List Name. For example, if you want to aggregate Public Library and Private Library document libraries from each site, you can specify the following:

Site URL Field Name

Used in conjunction with the Is Rollup List 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 Is Rollup List 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.

You can reset the session name if you have Multi Persistent Selectors in the target page. Usually, you must reset all but the last persistent selector session values. This ensures that the item that you want to pre-select in the last persistent selector is not filtered out by the previous persistent selector.

Set Session Name

Allows the calendar to store the selected item in the session under the name specified in the attribute. The item is selected when the user clicks a hyperlink created by using the Link To, Link To Target URL, or the Link To Source properties.

You can specify this attribute when you have a Persistent Selector web part in the target page and you want that persistent selector to pre-select the item the user chose in this calendar.

Target URL

When the LinktoTargetUrl attribute of a specific column is selected (in the Primary Content page), the data in that column becomes a hyperlink to the URL specified in this attribute.

NOTE: The Target Url can use the <%field name%> field replacement expression. If you are using Advanced Mode, you must use the encoded form of the < and > characters, which are < and > respectively.

NOTE: 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 can be different.

New Form URL

Indicates the URL where the form to create a new 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 New Item button 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).

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

Indicates where 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.

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.
ID HTTP Parameter	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 qListForm or qCalendarView, when you select an item to be displayed or edited. NOTE: If qCalendar 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 NOTE: Set the same property in the qListForm to the same value.
Display Field Name	Allows you to select the name of the field in the SharePoint list that contains the title for the item. If you want to display the information from more than one fields, then specify the format in the Display Format property. For more information, see Display Format
Begin Date Field Name	Allows you to select the name of the field in the SharePoint list that contains the begin date information. This drop down will only display date and time type of fields.
End Date Field Name	Allows you to select the name of the field in the SharePoint list that contains the end date information. This drop down will only display date and time type of fields.

List Attributes	Description
Advanced Mode	Turn on if you want to edit Viewed Lists in XML format. For example: <Lists> <List SiteUrl="." ListName="wfpub" IncludeSubsites="false" IncludeThisSite="false" IsRollUpList="false" RolledUpListName="Public Library" UseUploadFormInLayoutsFolder="false"> <DependentLists /> </List> </Lists>
Site URL	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.
List Name	The name of the SharePoint list that is edited or displayed by this Calendar View. 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 qCalendarView is contained in the AllItems.aspx. For example, if you are replacing the Microsoft Calendar View in the AllItems.aspx of the Tasks list and you use a single dot as the ListName attribute, the ListName attribute of the qCalendarView ise set to Tasks. If you want to save the list as a template and then use it somewhere else, the name of the new list might not be Tasks and using this relative list name automatically picks 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 selected, the Calendar View 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 few 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 is not aggregated by the Calendar View. 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 below.
Rolled Up List Name	Used in conjunction with the Is Rollup List property, indicates the name of the lists to be rolled up if you check the Is Rollup List check box. 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 Rolled Up List Name. For example, if you want to aggregate Public Library and Private Library document libraries from each site, you can specify the following:
Site URL Field Name	Used in conjunction with the Is Rollup List 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 Is Rollup List 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. You can reset the session name if you have Multi Persistent Selectors in the target page. Usually, you must reset all but the last persistent selector session values. This ensures that the item that you want to pre-select in the last persistent selector is not filtered out by the previous persistent selector.
Set Session Name	Allows the calendar to store the selected item in the session under the name specified in the attribute. The item is selected when the user clicks a hyperlink created by using the Link To, Link To Target URL, or the Link To Source properties. You can specify this attribute when you have a Persistent Selector web part in the target page and you want that persistent selector to pre-select the item the user chose in this calendar.
Target URL	When the LinktoTargetUrl attribute of a specific column is selected (in the Primary Content page), the data in that column becomes a hyperlink to the URL specified in this attribute. NOTE: The Target Url can use the <%field name%> field replacement expression. If you are using Advanced Mode, you must use the encoded form of the < and > characters, which are < and > respectively. NOTE: 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 can be different.
New Form URL	Indicates the URL where the form to create a new 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 New Item button 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).
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	Indicates where 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.