For Developers

Overview XE "Overview:For Developers"

This “For Developers” section replaces what was the Developer.chm stand-alone help file before the Summer 2005 release. In this section, you will find detailed information for developers regarding advanced web part properties and customization of your CorasWorks installation. This section also includes information about web part DWP modification, the Web Part Template Gallery, CorasWorks XML namespaces, and DWP special characters.

Last Modified: DATE \@ "MMMM yy" October 06

Web Part DWP Modification – Overview XE "DWP:Modification Overview"

This section explains how to modify the CorasWorks web part DWP files and explains the different DWP properties that are available for each of the CorasWorks web parts.

Microsoft® Windows® SharePoint™ Services uses XML documents with a .dwp extension as a way to import and export web parts so they can be shared by users. These files capture a snapshot of the property settings for a web part, and a reference to the assembly and class used to create it.

There are two ways you can modify DWP files:

· You can modify a web part's base DWP file which resides on the server – To learn about modifying base DWP files, see the Server DWP Modification topic below

· You can modify an instance of a web part's DWP file, which resides as a separate file that you import into a WSS site - To learn more about creating and using individual state web parts, see the Site DWP Modification topic

NOTE: The Summer 2005 release does not support DWP modification of LCIDXML for roll-up web parts and navigation web parts. If you want to make localization changes to any of those web parts, please use the Localization tab on the administration interface.

Server DWP Modification XE "DWP: Server DWP Modification" XE "Modify Server DWP Files"

WPResources Directory

Modifying Server DWP Files

When you modify a DWP file that resides on the server, any new web parts created from that DWP file will inherit the modified properties. Any web parts that already exist in the WSS Sites will not be updated with the modified properties. For example, if you have already dragged a web part from a web part gallery onto a site, that instance of the web part will not reflect any changes you make to its underlying DWP file. However, any new web parts that you create by dragging the web parts from a web part gallery onto a site will reflect the modified properties.

All CorasWorks DWP files are located on the server in the following directory:

C:\Inetpub\wwwroot\wpcatalog\

Before making modifications to an existing DWP file, it is recommended that you first make a backup copy of the DWP file in case the file needs to be restored in the future. Also, you may wish to give the DWP files that you modify a new, unique name, as this will keep your modified DWP files from being overwritten if you should reinstall any of the CorasWorks web parts.

Edit DWP

Editing a DWP file is easy. Simply open the file in Windows Notepad, modify the settings, and then save your changes. Since the DWP file is an XML file, you can optionally edit it with any XML-compatible editor. Whenever you edit a DWP file, ensure you are using the correct XML namespace for the web part. The XML namespaces for the CorasWorks web parts are listed in this help file in the CorasWorks XML Namespaces topic. That topic includes a listing of all the available DWP properties that you can modify for each CorasWorks web part.

Sample DWP File

Below are the contents of a sample DWP file for a Contacts Roll-Up Advanced web part. To modify the default behavior of this web part, simply modify the value of the XML node for the property you want to change. If the property is not listed, you add it to the XML.

<?xml version="1.0" encoding="utf-8"?>

<Title>Contact Roll-Up Advanced</Title>

<FrameType>Default</FrameType>

<Description>This Web Part will rollup all Contact Lists into a Tree-View form. From here users can manage, filter, and search Contact list items.</Description>

<FrameState>Normal</FrameState>

<AllowRemove>false</AllowRemove>

<HelpLink>http://central.workplace.corasworks.net/support/WebPartHelp/CWSCARST.aspx</HelpLink>

<Dir>Default</Dir>

<MissingAssembly>This Web Part has failed to load due to a missing software file. Please contact CorasWorks (http://www.corasworks.net) and provide them with the name of the Web Part [Contact Roll-Up Adv] and the URL in your browser.</MissingAssembly>

<PartImageLarge>_WPR_/contact.gif</PartImageLarge>

<Assembly>CorasWSC.Contact.RollUp.Adv, Version=51.0.26.1, Culture=neutral, PublicKeyToken=a66eaee6d3fbdabb</Assembly>

<TypeName>CorasWSC.Contact.RollUp.Adv</TypeName>

<ShowAdmin xmlns="CorasWSC.Contact.RollUp">false</ShowAdmin>

</WebPart>

Below, we have added a new property to the DWP file called ReturnType and have set the value to los. Now any new web part that is instantiated from this DWP file will have the Return Type as Line of Site instead of the original default of Selective. Note the namespace (the xmlns tag) used must match the correct namespace for the web part being modified. In this case, it is CorasWSC.Contact.RollUp. For a list of CorasWorks namespaces, see CorasWorks XML Namespaces.

<?xml version="1.0" encoding="utf-8"?>

<Title>Contact Roll-Up Advanced</Title>

<FrameType>Default</FrameType>

<Description>This Web Part will rollup all Contact Lists into a Tree-View form. From here users can manage, filter, and search Contact list items.</Description>

<FrameState>Normal</FrameState>

<AllowRemove>false</AllowRemove>

<HelpLink>http://central.workplace.corasworks.net/support/WebPartHelp/CWSCARST.aspx</HelpLink>

<Dir>Default</Dir>

<PartImageLarge>_WPR_/contact.gif</PartImageLarge>

<Assembly>CorasWSC.Contact.RollUp.Adv, Version=51.0.26.1, Culture=neutral, PublicKeyToken=a66eaee6d3fbdabb</Assembly>

<TypeName>CorasWSC.Contact.RollUp.Adv</TypeName>

</WebPart>

When you have completed modifying the DWP file, save it back to the C:\Inetpub\wwwroot\wpcatalog directory.

NOTE: It may be necessary to reset ISS before the newly modified web part becomes available in the web part gallery.

Site DWP Modification XE "DWP: Site DWP Modification" XE "DWP:Browser DWP Modification"

Browser DWP Modification

Download DWP From Site

After the shared and personal properties for a web part are modified using the task pane, you can capture the current state of the web part as a .dwp file by selecting Export from the web part menu. You can also add elements to the .dwp file to specify additional property values, overriding the default property settings implemented in the web part code.

To export a DWP file from a WSS site:

1. Open the site and select Export from the web part menu. You will be prompted for a location where you want to save the exported web part.

2. Click the Save button and then save the DWP file to the identified location.

Edit DWP

Editing a DWP file is not difficult. Simply open the file in Windows Notepad, modify the settings, and then save your changes. Since the DWP file is an XML file, you can edit it with any XML-compatible editor.

Whenever you edit a DWP file, make sure you are using the correct XML namespace for the web part. The XML namespaces for the CorasWorks web parts are listed in this help file under the CorasWorks XML Namespaces topic. That topic also includes a listing of all the available DWP properties that you can modify for each CorasWorks web part.

Sample DWP File

<?xml version="1.0" encoding="utf-8"?>

<Title>Contact Roll-Up Advanced</Title>

<FrameType>Default</FrameType>

<Description>This Web Part will rollup all Contact Lists into a Tree-View form. From here users can manage, filter, and search Contact list items.</Description>

<FrameState>Normal</FrameState>

<AllowRemove>false</AllowRemove>

<HelpLink>http://central.workplace.corasworks.net/support/WebPartHelp/CWSCARST.aspx</HelpLink>

<Dir>Default</Dir>

<PartImageLarge>_WPR_/contact.gif</PartImageLarge>

<Assembly>CorasWSC.Contact.RollUp.Adv, Version=51.0.26.1, Culture=neutral, PublicKeyToken=a66eaee6d3fbdabb</Assembly>

<TypeName>CorasWSC.Contact.RollUp.Adv</TypeName>

<ShowAdmin xmlns="CorasWSC.Contact.RollUp">false</ShowAdmin>

</WebPart>

Below, we have added a new property to the DWP file called ReturnType and have set the value to los. Now any new web part that is instantiated from this DWP file will have the Return Type of Line of Site instead of the default of Selective. Note the namespace (the xmlns tag) used must match the correct namespace for the web part being modified. In this case, it is CorasWSC.Contact.RollUp. For a list of CorasWorks namespaces, see CorasWorks XML Namespaces.

<?xml version="1.0" encoding="utf-8"?>

<Title>Contact Roll-Up Advanced</Title>

<FrameType>Default</FrameType>

<Description>This Web Part will rollup all Contact Lists into a Tree-View form. From here users can manage, filter, and search Contact list items.</Description>

<FrameState>Normal</FrameState>

<AllowRemove>false</AllowRemove>

<HelpLink>http://central.workplace.corasworks.net/support/WebPartHelp/CWSCARST.aspx</HelpLink>

<Dir>Default</Dir>

<PartImageLarge>_WPR_/contact.gif</PartImageLarge>

<Assembly>CorasWSC.Contact.RollUp.Adv, Version=51.0.26.1, Culture=neutral, PublicKeyToken=a66eaee6d3fbdabb</Assembly>

<TypeName>CorasWSC.Contact.RollUp.Adv</TypeName>

</WebPart>

When you have finished editing the DWP file, save your changes and then use the sites Import feature to import the DWP file into a WSS site. Detailed procedures for doing this are provided below.

Upload DWP to Site

In order to use the DWP files you have modified, you must import them into a WSS site.

NOTE: The assembly for the web part must be available in the server's Global Assembly Cache (GAC) for the web part to work.

To upload a DWP file, follow these steps:

1. From either the Modify Shared Page or Modify My Page menu, select Add Web Parts and then Import.

2. In the web parts tool part pane, enter the path to the DWP file. Optionally, you can click the Browse button and navigate to the DWP file.

3. Click the Upload button. The DWP file will be uploaded and a new web part will now be displayed under the Uploaded Web Part heading.

The web part can now be used by dragging it from the Uploaded Web Part area to a web part zone.

FrontPage DWP Modification

WPP Code View

You can make modifications directly to a web part's DWP properties using FrontPage's code view. Note that when you modify DWP properties using FrontPage, the modifications only apply to the current instance for the web part. Any new web parts added to the page will not be affected by your modifications.

Follow these steps to modify the DWP properties using FrontPage:

1. Open the desired page in FrontPage 2003. The easiest way to do this is to use Internet Explorer and navigate to the page and then click the Edit with Office FrontPage toolbar button, located in the Internet Explorer toolbar.

2. You may be prompted for you login credentials. If you do not have permission to modify the page, you will not be able to open it successfully using FrontPage.

3. Once the page loads, click on top of the web part that you want to modify.

4. Switch to FrontPage's Code view for the page. You should now see the web part's DWP properties.

5. Follow the instructions listed under the Edit DWP section (below) and change the web part’s settings.

6. When you are finished modifying the DWP properties, use FrontPage to save the web page back to the server.

Edit DWP

Whenever you edit a DWP file, make sure you are using the correct XML namespace for the web part. The XML namespaces for the CorasWorks web parts are listed in this help file in the CorasWorks XML Namespaces topic. This topic also includes a listing of all the available DWP properties that you can modify for each CorasWorks web part.

Sample DWP

Below are the contents of a sample web part's DWP properties for a Contacts Roll-Up Advanced web part. To modify the default behavior of this web part, simply modify the value of the XML node for the property you want to change. If the property is not listed, add it to the XML.

<WpNs1:Adv runat="server" WebPart="true" __WebPartId="{7BADAD93-769F-4470-BE83-DAD12B65252F}" >

<Title>Contact Roll-Up Advanced</Title>

<FrameType>Default</FrameType>

<Description>This Web Part will rollup all Contact Lists into a Tree-View form. From here users can manage, filter, and search Contact list items.</Description>

<FrameState>Normal</FrameState>

<AllowRemove>false</AllowRemove>

<HelpLink>http://central.workplace.corasworks.net/support/WebPartHelp/CWSCARST.aspx</HelpLink>

<Dir>Default</Dir>

<PartImageLarge>_WPR_/contact.gif</PartImageLarge>

<ExportControlledProperties>false</ExportControlledProperties>

<ShowAdmin xmlns="CorasWSC.Contact.RollUp">false</ShowAdmin>

</WebPart>

</WpNs1:Adv>

Below, we have added a new property called ReturnType and have set the value to los. Note the namespace (the xmlns tag) used must match the correct namespace for the web part being modified. In this case it is CorasWSC.Contact.RollUp. For a list of CorasWorks namespaces, please see CorasWorks XML Namespaces.

<WpNs1:Adv runat="server" WebPart="true" __WebPartId="{7BADAD93-769F-4470-BE83-DAD12B65252F}" >

<Title>Contact Roll-Up Advanced</Title>

<FrameType>Default</FrameType>

<Description>This Web Part will rollup all Contact Lists into a Tree-View form. From here users can manage, filter, and search Contact list items.</Description>

<FrameState>Normal</FrameState>

<AllowRemove>false</AllowRemove>

<HelpLink>http://central.workplace.corasworks.net/support/WebPartHelp/CWSCARST.aspx</HelpLink>

<Dir>Default</Dir>

<PartImageLarge>_WPR_/contact.gif</PartImageLarge>

<ExportControlledProperties>false</ExportControlledProperties>

<ShowAdmin xmlns="CorasWSC.Contact.RollUp">false</ShowAdmin>

</WebPart>

</WpNs1:Adv>

DWP Special Characters XE "DWP:Special Characters" XE "Special Characters - DWP"

Overview

When modifying web parts, some of the DWP properties may require the use of a "<", ">", or "&". You must replace these characters with their encoded equivalents of "<", ">", and "&" or the modifications will not work.

Standard Character	Encoded Equivalent for DWP
<	<
>	>
&	&

CorasWorks XML Namespaces XE "XML Namespaces" XE "Namespaces"

Overview

Whenever you modify a DWP property for a CorasWorks web part, you need to ensure you are providing the proper XML Namespace attribute for the DWP property. A typical XML namespace looks like this:

CorasWSC.Contact.RollUp

When used in conjunction with the DWP property, it looks like this:

<ShowAdmin xmlns="CorasWSC.Contact.RollUp">false</ShowAdmin>

XML Namespaces

Web Part	XML Namespace
Action-Enabled Roll-Up	CorasWSC.Workplace.Web.UI.WebControls.RollUps
Action Picker	CorasWSC.Action
Actions Wizard	CorasWSC.Action
Announcement Roll-Up Advanced	CorasWSC.Announcement.RollUp
Announcement Spreadsheet Roll-Up Advanced	CorasWSC.Announcement.SpreadSheet.RollUp
Calendar Roll-Up Advanced	CorasWSC.Calendar.RollUp
Chart Display Advanced	CorasWSC.Chart.Display
Contact Roll-Up Advanced	CorasWSC.Contact.RollUp.Adv
Contact-Spreadsheet Roll-Up Advanced	CorasWSC.Contact.SpreadSheet.RollUp
Contact Summary	CorasWSC.Contact
CorasWorks Actions Wizard	CorasWSC.Action
CorasWorks Client	CorasWSC.Client
CorasWorks Roll-Up Wizard	CorasWSC.RollUp
Data Publisher	CorasWSC.Data
Document Roll-Up Advanced	CorasWSC.Document.RollUp
Document-Spreadsheet Roll-Up Advanced	CorasWSC.Document.SpreadSheet.RollUp
Event Roll-Up Advanced	CorasWSC.Event.RollUp
Event-Spreadsheet Roll-Up Advanced	CorasWSC.Event.SpreadSheet.RollUp
Event Summary	CorasWSC.Event
Link Roll-Up Advanced	CorasWSC.Link.RollUp
Link-Spreadsheet Roll-Up Advanced	CorasWSC.Link.SpreadSheet.RollUp
List Item Emailer	EmailTestWebPart
List Item Emailer Wizard	CorasWSC.List.Item.Emailer.Wizard
My Announcement Roll-Up Advanced	CorasWSC.My.Announcement.RollUp
My Contact Roll-Up Advanced	CorasWSC.My.Contact.RollUp
My Document Roll-Up Advanced	CorasWSC.My.Document.RollUp
My Event Roll-Up Advanced	CorasWSC.My.Event.RollUp
My Link Roll-Up Advanced	CorasWSC.My.Link.RollUp
My Task Roll-Up Advanced	CorasWSC.My.Task.RollUp
My Workplace for Outlook	BizboxSoftware.Molc
Special Site Navigation	CorasWSC.Special.Site
SPS WorkPlace View Advanced	CorasWSC.SPS.Workplace.View.Adv
Task Roll-Up Advanced	CorasWSC.Task.RollUp
Task-Spreadsheet Roll-Up Advanced	CorasWSC.Task.SpreadSheet.RollUp
Task Summary	CorasWSC.Task
Up To Navigation	CorasWSC.Up.To
WorkPlace View Adv	CorasWSC.WorkPlace.View
Workplace Wizard	CorasWSC.Workplace
WSS Search	CorasWSC.WSS

Web Part Template Gallery XE "Web Part Template Gallery"

Overview XE "Templates"

A web part library is a central warehouse of web parts that you can use to locate a specific web part when you are creating a web part page. You can access web part libraries at your site by clicking either Browse or Search from the Add Web Parts menu on either the Modify Shared Page menu or the Modify My Page menu.

Once you locate the web part you want, you typically drag it to your web part page. Depending on how your site administrator has configured your site, there can be up to three different web part libraries available:

· Site Library: Web parts available to a top-level Windows SharePoint Services web site.

· Virtual Server Library: This library contains web parts available to all sites and sub-sites within a virtual server.

· Online Library: By default, the Online Library contains an additional set of web parts available from Microsoft. However, a site administrator can redirect the online library to a different site.

This topic discusses how to mange a Site Library. For more information on managing Virtual Server or Online libraries, please refer to the Windows SharePoint Services or SharePoint Portal Server online help.

The Site Web Part Gallery is often the most central web part gallery for your work group. This web part gallery is typically managed by your server administrator, who decides which web parts are available and safe for your site. By default, the gallery name is the name of your site. For example, if your site is called "Boaters and Sailors," then the web part gallery name is “Boaters and Sailors Gallery.” There is only one Site Web Part Gallery for each site and any sub-sites under it.

Uploading a New Web Part to the Site Library

You can add a web part to the Site Library even if it has not been installed in the Virtual Server Library. To do this via the web browser interface, follow these steps:

1. On a top-level Web site, click Site Settings.

2. Under Administration, click Go to Site Administration.

3. Under Site Collection Galleries, click Manage Web Part gallery.

4. On the Web Part Gallery page, click Upload Web Part.

5. In the Name box, type the name of the web part (including the full path to the .dwp file), or click Browse to locate the web part.

6. If you have several web parts that you want to upload at once, click Upload Multiple Files and select the web parts to upload.

7. In the Group box, select a group or type a group name for the web part under Specify your own value.

8. Click Save and Close.

Adding a Deployed Web Part to the Site Library

To make an existing web part available in the site library, follow these steps:

NOTE: By “existing web part,” we mean web parts that have already been deployed in the Virtual Server Library on the server running Windows SharePoint Services.

1. On a top-level Web site, click Site Settings.

2. Under Administration, click Go to Site Administration.

3. Under Site Collection Galleries, click Manage Web Part Gallery.

4. On the Web Part Gallery page, click New Web Part.

5. Select the check box next to the web parts that you want to include in the gallery and then click Populate Gallery.

Removing a Web Part from the Site Library

You can remove a web part from the gallery if you want to make it unavailable to users. If a user has already used a web part in the site and you delete the web part from the site gallery, the web part will remain on the web part page and will still work. However, if an administrator removes the web part assembly that contains the web part from the server, or marks the assembly as unsafe in the Web.config file for the server, the web part will no longer run and the user will see an error message.

To remove a web part, follow these steps:

1. On a top-level web site, click Site Settings.

2. Under Administration, click Go to Site Administration.

3. Under Site Collection Galleries, click Manage Web Part Gallery.

4. On the Web Part Gallery page, next to the web part that you want to remove, click the Edit icon.

5. On the Web Part Gallery: Web Part Name page, click Delete.

6. Click OK to delete the web part.

Managing Invalid Web Part Zone IDs

This topic applies to the following web parts for the Winter 2006 and later releases:

· Action-Enabled Roll-Ups

· Action Picker

· Actions Wizard

· Special Site Navigation

· Workplace View Advanced

It also applies to Calendar Roll-Ups in the Summer 2006 and later releases.

In the past, there was an issue with Microsoft Front Page and the way it identified web part zones. This issue was resolved in Service Pack 2 (SP2). Prior to the release of SP2 for FrontPage, when new web part zones were created, they were assigned invalid web part zone IDs. So if you created any web part zones or solutions before installing SP2, the zones are invalid.

An invalid web part zone ID contains one or more of the following:

· Dashes

· Spaces

· Curly brackets { }

· Starts with something other than a letter

For example, this is an invalid web part zone ID:

· {0A057BAD-C63A-4829-A3E7-D6CA53CC990C}

These are valid web part zone IDs:

· Main

· Left

· g_735C804069194273BC6C537A9C658109

What Does This Mean?

The impact on today’s CorasWorks web parts is minimal, but there are effects:

· When an administrator drags one of the web parts listed above into an invalid web part zone, they will get an error message. The message will notify them that the web part zone ID is invalid and to use FrontPage with SP2 or greater to change the web part zone ID. It will also direct them to this help site.

· If you place an action-enabled roll-up in an invalid web part zone and then add a Delete-type action to the roll-up, your users will not receive a confirmation message before the selected item(s) are deleted. The item(s) will still be deleted, however.

· If you have one of the web parts listed above in an existing site and you upgrade to the current release, the web part will revert to the previous version; it will not automatically update to the latest version and any new capabilities will not be available.

By installing Service Pack 2, you ensure that all current and future CorasWorks web parts and SharePoint upgrades will work as expected. This site explains what was fixed in SP2: http://support.microsoft.com/kb/906341/.

Do You Have Service Pack 2?

If you aren’t sure whether or not you have SP2, open FrontPage and go to Help/About Microsoft FrontPage. At the top of the window, you will see a release number that should be followed by “SP2.” If you do not have SP2 installed, you can select Help/Check for Updates and follow the instructions.

How to Replace the Invalid Web Part Zone

Once you are sure you have Service Pack 2, CorasWorks recommends that you remove the web part zone with the invalid ID and replace it with a new one. These steps explain how to do this.

1. Open the site in FrontPage.

2. Add a new web part zone. Start by selecting View/Task Pane.

3. Access the Web Parts task pane. If you see the Getting Started task pane or another pane, select the select the down arrow to the right of Getting Started to open a drop-down menu. Then select Web Parts from the bottom of the list.

4. Click your mouse wherever you want the new web part zone to be created and then select the New Web Part Zone button at the bottom of the Web Parts task pane.

5. Drag the web part(s) out of the zone with the invalid ID and into the new zone you just created.

6. Delete the old web part zone by selecting it and pressing the Delete key.

7. Save your work and close FrontPage.

Custom Displays: Introduction XE "Custom Displays"

CorasWorks roll-ups support customization through the addition of JavaScripting to the DWP and combination with other web parts. Roll-ups that have been enhanced in this manner are called “custom displays.” The following topics provide detailed procedures for a number of custom displays utilized in CorasWorks solutions and the CorasWorks showroom. You can create an unlimited number of custom displays by making your own modifications utilizing supported features, or by referencing the examples presented here. With custom displays, you can total numeric fields, change how columns are displayed, color code them, and more.

These examples are provided for your reference to see the types of things that can be done with custom displays. They are meant to be used as a springboard for your imagination, and are not meant to be considered as “the only way” to customize roll-ups.

Modifying the DWP XE "DWP Modification"

The web parts referenced in the following sections have a number of properties that can only be modified by manually editing the DWP file associated with the web part. A DWP file can be edited by exporting the web part to a location of your choice, making the desired changes, and then uploading it back onto a site. Complete procedures for modifying DWPs are provided in the Web Part DWP Modification – Overview topic. The basic steps are as follows:

1. Go to the web page with the roll-up web part that you want to alter.

2. Go to Modify Shared Page and then choose Design this page. This will place the page into design mode.

3. Choose Export from the web part menu.

4. Save the file, placing it somewhere on your local drive where you can find it.

5. Open the exported DWP file in Notepad. You will see some XML code.

6. Make the necessary changes as described in the topics in this section.

7. Save the updated DWP file. You might want to alter the name of the file to keep the original in case there is a mistake.

8. Go back to your web page and choose Modify Shared Page/Add Web Parts/Import.

9. In the "Add Web Parts" property section, browse for the updated web part and then upload it.

IMPORTANT! This section of help includes Display HTML and JavaScript that can be copied and pasted into your DWP. However, when you copy and paste from the help into FrontPage, hard returns may be inserted. These will need to be removed to avoid any errors.

When modifying a DWP, keep in mind the XML namespace of the web part being changed, or the properties will not be enabled within the web part. XML namespaces for all CorasWorks web parts are provided in the XML Namespaces help topic.

Also note that some of the web part properties require the use of a "<", ">", or "&" symbol. If that is the case, these characters must be replaced with their encoded equivalents of "<", ">", and "&" respectively, unless utilizing the XML CDATA element. (Example <![CDATA[ HTML TEXT ]]>)

Custom Display: Event Roll-Up in Local Date/Time XE "Custom Displays:Events in Local Date/Time"

This section walks through the process of modifying a roll-up display with JavaScript to display events that are localized to the current user’s time zone.

How It Works

These procedures require the following:

o The Events with Time Zone Template, which will be used by the roll-up to display data

o An Event list

o The Event SpreadSheet Roll-Up Advanced web part – The DWP for this web part will be modified to achieve the desired functionality

o Display HTML and JavaScript, made available here, that will alter the display of the roll-up so that it shows events in the user’s local time zone

These are the items that you need to change to alter the default display of the web part.

1. JavaScript (click here)

o ShowAttachment – Returns the Paper Clip image if attachments exist for the event

o ShowWorkspace – Returns the Workspace image and URL if an Event Workspace exists for the event

o ShowRecurrence – Returns the Recurrence image if the event is of a recurring type

o ShowNext – Displays the Next link if there are more items to be displayed. Connected to Maximum Results Returned.

o ShowPrevious – Displays the Previous link if previous items exist to be displayed. Connected to Maximum Results Returned.

o ChangeDateToLocale – Changes the date entered to the local date and outputs the result

o CheckTimeZone – Checks the local time zone to look for the current Daylight Savings Time status

o FormatDate – Formats the date to a specific design

2. Display HTML (click here)

IMPORTANT! When copying and pasting from the online help into FrontPage, hard returns may be inserted. These will need to be removed to avoid any errors.

If you look at the table in Spreadsheet Roll-Up Advanced, you will see that a number of fields from the List being searched are referenced with a “%”, both before and after the item. These include both the field headers (%Title Header%, %Location Header%, %Begin Header%, %End Header%) and the field values (%DisplayItemURL%, %Workspace%, %Attachments%, %Recurrence%, %Title%, %End%, %Begin%, %Time Zone%, %Location%, %NextURL%, %PreviousURL%). When working with Events with Time Zone, these are the fields available to you while building your custom solution.

Building It

The Scenario

These procedures begin with the assumption that you have created an Events with Time Zone List with the Events with Time Zone List Template, provided to you with the Workplace Suite, in your site and have filled it in with some test data. You have a personal Dashboard at http://site/yoursite/, where you want add the Localized Events roll-up.

Step 1: Create the Localized Events Roll-Up

1. Add an Event Spreadsheet Roll-Up Advanced web part to the zone where the roll-up is to be displayed.

2. Export the roll-up as a .dwp file

o Click on the Actions menu and then Export…

o Save the file on your computer as Localized Events.dwp

3. Delete the generic Spreadsheet Roll-Up Advanced web part from your site

o Click on the Actions menu and then Delete.

o Click OK to confirm.

4. Edit Localized Events.dwp on your computer

o Change the title of the web part by replacing the text between the <Title></Title> tags with Localized Events.

o Insert the content found here (0click hereHelp_D2HPrivate(-7,677)Contents for Localized Event Roll-Up Insertion for Event Roll-Up in Local Date/Time0) between the last property tags and then save the dwp file.

5. Import your modified web part to your personal site, http://site/yoursite/.

o Click Modify Shared Page/Add Web Parts/Import

o Enter the name and location of your .dwp file or click Browse to find it on your computer

o Click Upload

6. Drag the uploaded web part to the zone where your roll-up should be displayed.

7. The administration interface is displayed so you can select the site and lists from which you want to roll up data. Once you have made these selections, close the administration interface. The Events roll-up will be displayed with items in your local time zone.

Step 2: Modify the FormatDate JavaScript to Alter the Date Output Format

1. Locate the JavaScript Function Format Date by locating the return line with the following text:
return strMonth + "/" + strDay + "/" + strYear + " " + strHour + ":" + strMinute + " " + strAMPM;

2. Change this text to output the date and time in the desired format. The default date format is: 01/01/2001 12:00 AM

For further assistance with available date output capabilities, a “How To” can be accessed at http://www.w3schools.com/js/js_obj_date.asp

JavaScript for Event Roll-Up in Local Date/Time XE "Custom Displays:Events in Local Date/Time"

function ShowAttachment(strAttachment)

{

if (strAttachment == "-1")

{

document.write('<img src=\"_layouts/images/attachhd.gif\">');

}

else

{

document.write(' ');

}

function ShowWorkspace(strWorkspace, strTarget)

{

if (strWorkspace != "")

{

var arrHoldLink = strWorkspace.split(",");

document.write('<a target=\"" + strTarget + "\" href=\"" + arrHoldLink[0] + "\"><img border=\"0\"

src=\"_layouts/images/mtgicon.gif\"></a>');

}

else

{

document.write(' ');

}

function ShowReccurence(strReccurence)

{

if (strReccurence == "-1")

{

document.write('<img src=\"_layouts/images/recur.gif\">');

}

else

{

document.write(' ');

}

function ShowNext(strNext)

{

if (strNext != "")

{

strNext = strNext.replace("javascript:\" OnClick=\"javascript:SubmitFormPost(\"","");

strNext = strNext.replace("\");return false;\"","");

document.write('<a href=\"javascript:\" OnClick=\'javascript:SubmitFormPost(\"' + strNext + '\");return false;\'>Next<img

valign=\"abs_bottom\" src=\"_layouts/images/marr.gif\" border=\"0\"></a>');

}

else

{

document.write(' ');

}

function ShowPrevious(strPrevious)

{

if (strPrevious != "")

{

strPrevious = strPrevious.replace("javascript:\" OnClick=\"javascript:SubmitFormPost(\"","");

strPrevious = strPrevious.replace("\");return false;\"","");

document.write('<a href=\"javascript:\" OnClick=\'javascript:SubmitFormPost(\"' + strPrevious + '\");return false;\'><img

valign=\"abs_bottom\" src=\"_layouts/images/marrrtl.gif\" border=\"0\">Previous</a>');

}

else

{

document.write(' ');

}

function ChangeDateToLocale(strDate, strTZ)

{

var strHoldTimeZone = strTZ;

if ((strDate != null) && (strDate != ""))

{

if (strTZ.indexOf("GMT") >= 0)

{

strTZ = strTZ.substring(4,10);

strTZ = strTZ.replace(":","");

}

else

{

strTZ = strTZ.substring(0,5);

strTZ = strTZ.replace(":","");

strTZ = "+" + strTZ;

}

var dtNewDate = new Date(strDate + " " + strTZ);

var strNewDate = dtNewDate.toLocaleString();

//document.write (new Date().toString());

if (strNewDate != "")

{

var dtNewDate = new Date(strNewDate);

if (checkTimeZone())

{

if (strHoldTimeZone.indexOf("*") >= 0)

{}

else

{

dtNewDate = dtNewDate.setHours(dtNewDate.getHours() - 1);

}

else

{

if (new Date().toString().indexOf("ST") >= 0)

{

if (strHoldTimeZone.indexOf("*") >= 0)

{}

else

{

dtNewDate = dtNewDate.setHours(dtNewDate.getHours() - 1);

}

document.write (FormatDate(dtNewDate));

}

function checkTimeZone() {

var rightNow = new Date();

var date1 = new Date(rightNow.getFullYear(), 0, 1, 0, 0, 0, 0);

var date2 = new Date(rightNow.getFullYear(), 6, 1, 0, 0, 0, 0);

var temp = date1.toGMTString();

var date3 = new Date(temp.substring(0, temp.lastIndexOf(" ")-1));

var temp = date2.toGMTString();

var date4 = new Date(temp.substring(0, temp.lastIndexOf(" ")-1));

var hoursDiffStdTime = (date1 - date3) / (1000 * 60 * 60);

var hoursDiffDaylightTime = (date2 - date4) / (1000 * 60 * 60);

if (hoursDiffDaylightTime == hoursDiffStdTime) {

return false;

} else {

return true;

}

function FormatDate(dtDate)

{

if (dtDate != "")

{

var holdDate = new Date(dtDate);

var strMonth = "";

var strDay = "";

var strYear = "";

var strHour = "";

var strMinute = "";

var strAMPM = "AM";

strHour = holdDate.getHours().toString();

if (strHour == "0") { strHour = "12"; strAMPM = "AM";}

else if (strHour == "1") { strHour = "01"; strAMPM = "AM"; }

else if (strHour == "2") { strHour = "02"; strAMPM = "AM"; }

else if (strHour == "3") { strHour = "03"; strAMPM = "AM"; }

else if (strHour == "4") { strHour = "04"; strAMPM = "AM"; }

else if (strHour == "5") { strHour = "05"; strAMPM = "AM"; }

else if (strHour == "6") { strHour = "06"; strAMPM = "AM"; }

else if (strHour == "7") { strHour = "07"; strAMPM = "AM"; }

else if (strHour == "8") { strHour = "08"; strAMPM = "AM"; }

else if (strHour == "9") { strHour = "09"; strAMPM = "AM"; }

else if (strHour == "10") { strHour = "10"; strAMPM = "AM"; }

else if (strHour == "11") { strHour = "11"; strAMPM = "AM"; }

else if (strHour == "12") { strHour = "12"; strAMPM = "PM"; }

else if (strHour == "13") { strHour = "01"; strAMPM = "PM"; }

else if (strHour == "14") { strHour = "02"; strAMPM = "PM"; }

else if (strHour == "15") { strHour = "03"; strAMPM = "PM"; }

else if (strHour == "16") { strHour = "04"; strAMPM = "PM"; }

else if (strHour == "17") { strHour = "05"; strAMPM = "PM"; }

else if (strHour == "18") { strHour = "06"; strAMPM = "PM"; }

else if (strHour == "19") { strHour = "07"; strAMPM = "PM"; }

else if (strHour == "20") { strHour = "08"; strAMPM = "PM"; }

else if (strHour == "21") { strHour = "09"; strAMPM = "PM"; }

else if (strHour == "22") { strHour = "10"; strAMPM = "PM"; }

else if (strHour == "23") { strHour = "11"; strAMPM = "PM"; }

strMinute = holdDate.getMinutes().toString();

if (strMinute == "0") { strMinute = "00"; }

else if (strMinute == "1") { strMinute = "01"; }

else if (strMinute == "2") { strMinute = "02"; }

else if (strMinute == "3") { strMinute = "03"; }

else if (strMinute == "4") { strMinute = "04"; }

else if (strMinute == "5") { strMinute = "05"; }

else if (strMinute == "6") { strMinute = "06"; }

else if (strMinute == "7") { strMinute = "07"; }

else if (strMinute == "8") { strMinute = "08"; }

else if (strMinute == "9") { strMinute = "09"; }

strMonth = holdDate.getMonth();

if (strMonth == "0") { strMonth = "01"; }

else if (strMonth == "1") { strMonth = "02"; }

else if (strMonth == "2") { strMonth = "03"; }

else if (strMonth == "3") { strMonth = "04"; }

else if (strMonth == "4") { strMonth = "05"; }

else if (strMonth == "5") { strMonth = "06"; }

else if (strMonth == "6") { strMonth = "07"; }

else if (strMonth == "7") { strMonth = "08"; }

else if (strMonth == "8") { strMonth = "09"; }

else if (strMonth == "9") { strMonth = "10"; }

else if (strMonth == "10") { strMonth = "11"; }

else if (strMonth == "11") { strMonth = "12"; }

strDay = holdDate.getDate();

if (strDay == "1") { strDay == "01"; }

else if (strDay == "2") { strDay == "02"; }

else if (strDay == "3") { strDay == "03"; }

else if (strDay == "4") { strDay == "04"; }

else if (strDay == "5") { strDay == "05"; }

else if (strDay == "6") { strDay == "06"; }

else if (strDay == "7") { strDay == "07"; }

else if (strDay == "8") { strDay == "08"; }

else if (strDay == "9") { strDay == "09"; }

strYear = holdDate.getFullYear();

return strMonth + "/" + strDay + "/" + strYear + " " + strHour + ":" + strMinute + " " + strAMPM;

}

else

{

return "";

}

</script>

Display HTML for Event Roll-Up in Local Date/Time XE "Custom Displays:Events in Local Date/Time"

<tr>

</tr>

<END>

<tr>

<td class="ms-smallsectionline" width="3%" align="center" valign="top"><script

language="javascript">ShowReccurence("<%Recurrence%>")</script></td>

<td class="ms-smallsectionline" width="3%" align="center" valign="top"><script

language="javascript">ShowAttachment("<%Attachments%>", "_self")</script></td>

<td class="ms-smallsectionline" width="4%" align="center" valign="top"><script

language="javascript">ShowWorkspace("<%Workspace%>")</script></td>

<td class="ms-smallsectionline" width="30%" align="left" valign="top"><a href="<%DisplayItemURL%>"

target="_self"><%Title%></a> </td>

<td class="ms-smallsectionline" width="22%" align="left" valign="top"><script

language="javascript">ChangeDateToLocale("<%Begin%>", "<%Time Zone%>")</script> </td>

<td class="ms-smallsectionline" width="22%" align="left" valign="top"><script

language="javascript">ChangeDateToLocale("<%End%>", "<%Time Zone%>")</script> </td>

</tr>

<END>

<td valign="abs_bottom" align="left" colspan="4"><script

language="javascript">ShowPrevious('<%PreviousURL%>')</script></td>

<td valign="abs_bottom" align="right" colspan="3"><script

language="javascript">ShowNext('<%NextURL%>')</script></td>

</tr>

</table>

Contents for Localized Event Roll-Up Insertion for Event Roll-Up in Local Date/Time XE "Custom Displays:Events in Local Date/Time"

<ListTemplates xmlns="CorasWSC.Event.SpreadSheet.RollUp"><?xml version='1.0' ?><Lists><List><ListType>Events</ListType><ListTypeName>EventTZ</ListTypeName><NumberOfFields>22</NumberOfFields><OrderBy>Title, Attachments, BeginDATE, EndDATE, Description, Location, Recurrence, Workspace,

TimeZone</OrderBy><ListFields>Title,Attachments,Begin~DATE,End~DATE,Description,Location,Recurrence,Workspace,Time

Zone</ListFields><DisplayPer>,,,,,,,,</DisplayPer><SearchFields>Title,Attachments,Begin~DATE,End~DATE,Description,Location

,Recurrence,Workspace,Time Zone</SearchFields></List></Lists></ListTemplates> <DontConvertHttp xmlns="CorasWSC.Event.SpreadSheet.RollUp">true</DontConvertHttp> <DateFormat xmlns="CorasWSC.Event.SpreadSheet.RollUp">MM/dd/yyyy, hh:mm:ss tt</DateFormat>

<![CDATA[