Flash Movie Field for WSS 3.0

Download source code - 102.1 KB

Figure 1

Figure 2

Introduction

Flash Movie Field is a custom WSS field to render Flash movies and YouTube videos. It uses the excellent swfobject to render the HTML and JavaScript for maximum browser compatibility. In edit mode, authors specify the Url, Width, and Height of the Flash movie. Optional parameters can be added easily by modifying the attached source code.

Description

The Flash Movie Field is based on a new Field Type SPFieldFlashMovie. It has the following properties or column values:

Url - URL to Flash (.swf) movie or YouTube video, e.g. /media/map.swf, http://www.youtube.com/v/dMH0bHeiRNg&hl=en&fs=1.
Width - Width of Flash movie or YouTube video in pixels. For YouTube video, width includes embedded player.
Height - Height of Flash movie or YouTube video in pixels. For YouTube video, height includes embedded player.

Rendering is provided by a custom Field Control FlashMovieField with an associating Rendering Template QuestechFlashMovieFieldTemplate. All UI strings are localized and stored in resource files.

\SharePoint\ClientScripts\swfobject.js
Support JavaScript file for swfobject. Set as Embedded Resource.
\SharePoint\Fields\SPFieldFlashMovie.cs
Field Type for custom Flash Movie field. Inherits from SPFieldMultiColumn.
\SharePoint\Fields\SPFieldFlashMovieValue.cs
A class of column values for SPFieldFlashMovie. Inherits from SPFieldMultiColumnValue.
\SharePoint\Resources\Resources.resx
Project resource file for localized UI strings.
\SharePoint\RootFiles\CONFIG\Resources\QuestechCoreFlashMovie.resx
WSS provisioning resource file and application run-time resource file for localized UI strings. This sets the display name for the custom field and the label strings for properties Url, Width, and Height during authoring. Deploys to ..\12\Resources\.
\SharePoint\RootFiles\TEMPLATE\CONTROLTEMPLATES\
QuestechFlashMovieFieldTemplate.ascx
Form edit view of FlashMovieField with RenderingTemplate control.
\SharePoint\RootFiles\TEMPLATE\XML\fldtypes_SPFieldFlashMovie.xml
Field Type Definition for Field Type SPFieldFlashMovie.
\SharePoint\WebControls\FlashMovieField.cs
Field Control for SPFieldFlashMovie. Uses swfobject 2.1 to render Flash movies and YouTube videos.
\SharePoint\Utility.cs
Utility file for common methods and properties.

Feature QuestechFlashMovieColumns is required for the deployment. It is responsible for deploying the custom Field Type Definition in fldtypes_SPFieldFlashMovie.xml.

The sample Visual Studio 2008 solution includes all the support files you need to build and deploy the custom field, minus strong name key files (*.snk). It contains three projects: Deployment, Features, and SharePoint. The SharePoint project contains source code for the custom field. The Features project contains features to support the deployment. The Deployment project contains a pre-build script to aggregate all the files needed for deployment. It contains a Solution directory where a WSP file is generated and deployed by a post-build script.

This structure of Visual Studio solution and projects is designed to be scalable to full blown MOSS/WSS development and deployment. You could add additional projects like SharePoint.Publishing for MOSS Publishing development. Within your SharePoint or SharePoint.Publishing projects, you could have custom components like user controls, web controls, web parts, etc.

Installation

To deploy the custom field, follow the procedures below:

Using stsadm, install solution file QuestechFlashMovie.wsp in \Deployments\Solution\
```
stsadm -o addsolution -filename QuestechFlashMovie.wsp
```
Open SharePoint 3.0 Central Administration, go to Operations/Global Configuration/Solution Management. Deploy QuestechFlashMovie.wsp to select web application(s).
Go to the top site in the selected web application(s). Activate Site Collection feature Questech Systems Flash Movie Columns.

The custom Flash Movie Field should now be ready for use. You can go to the Site Columns gallery to verify. To use the custom field in your MOSS page layout, you would first need to add the custom site column to a content type by going to the Site content types gallery. In the gallery listing, select a content type and click Add from existing site columns.

In your page layout ASPX file, modify the code as follows:

...
<%@ Register Tagprefix="QuestechWebControls" 
    Namespace="QuestechSystems.SharePoint.WebControls"
    Assembly="QuestechSystems.SharePoint.FlashMovie, Version=1.0.0.0, 
    Culture=neutral, PublicKeyToken=f268fd4f0f42524c" %>

...
...
<QuestechWebControls:FlashMovieField FieldName="FlashMovieFile" runat="server" />
...

References

Create custom field type in WSS V3 - Jim Yang
SharePoint Resources, Types, Use and Deployment - Mikhail Dikov
swfobject
Features for SharePoint - MSDN Magazine
SharePoint 2007 Features - Creating Site Columns and Content types - Share This Point
Solution Deployment with SharePoint 2007 - MSDN Magazine

History

V1.2 - 2009.05.22
- Converted Visual Studio solution projects to version 2008
- New SharePoint Solution QuestechFlashMovie.wsp and assembly QuestechSystems.SharePoint.FlashMovie.dll. This allows my other sample solutions in CodeProject to co-exist with this custom field.
- Renamed feature from QuestechColumns to QuestechFlashMovieColumns
- Removed feature QuestechAppGlobalResources
V1.1 - 2008.08.12
- Added support of YouTube videos
- Modified form view layout
- Upgraded swfobject to V2.1
V1.0 - 2008.04.26 - Base

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Stephen Huen

Web Developer
Questech Systems

Canada

Member

Article Top

Poor

Excellent

Add a reason or comment to your vote: x
Votes of 3 or less require a comment

Comments and Discussions

You must Sign In to use this message board. (secure sign-in)

Search this forum
	Profile popups Noise Layout Per page

Flash Movie Field for WSS 3.0 not visible

Stan_Stevens

12:38 28 Feb '12

I did the stsadm command an it worked. SP CenAdmin shows that it is doployed to my site. However, I did not have to select it. It had already been done automatically. When I go to site Activate Site Collection feature, the FMField is not there. There are other previously installed features. I assume that when i deplay the feature, it should go to my site. What am i missing? Thanks.
Sign In·View Thread·Permalink

Error: The given key was not present in the dictionary.

Jingmei Li

9:14 8 Feb '09

I deployed the wsp from the download directly into my MOSS environment and it worked once. Later I removed it and now I would like to see it again, but kept getting error "The given key was not present in the dictionary. " when I tried to add the site column to the built-in Article Page site content type. Have you seen this error before? Any ideas? thanks Jingmei
Sign In·View Thread·Permalink	1.50/5 (2 votes)

Error when select the Flash Movie Filed button in WSS 3.0

oconnortj

3:12 18 Sep '08

This field type cannot be edited from most client programs and might block the programs from saving documents to this library. Any ideas? TJ
Sign In·View Thread·Permalink	2.00/5 (1 vote)

Re: Error when select the Flash Movie Filed button in WSS 3.0

Stephen Huen

18:33 20 Sep '08

Unless you will be editing the page in Office, which this custom field does not support, you can ignore this message.
Sign In·View Thread·Permalink	1.00/5 (1 vote)

Modify what?

roryschmitz

6:37 15 Jul '08

In your page layout aspx file, modify the code as follows:

...
<![CDATA[<%@ Register Tagprefix="QuestechWebControls" 
    Namespace="QuestechSystems.SharePoint.WebControls"
    Assembly="QuestechSystems.SharePoint, Version=1.0.0.0, 
    Culture=neutral, PublicKeyToken=f1874fca2a9b1c17" %>]]>
...
...
<questechwebcontrols:flashmoviefield fieldname="FlashMovieFile"  runat="server" xmlns:questechwebcontrols="#unknown" />
...

Is there an example of an original code, then the modified code? I'm confused. I try adding this code, but receive errors. Here is one error I am getting:

An error occurred during the processing of /Picture Library/Forms/Flash View.aspx. Only Content controls are allowed directly in a content page that contains Content controls.

Here is my code:

<![CDATA[<%@ Page language="C#" MasterPageFile="~masterurl/default.master"    Inherits="Microsoft.SharePoint.WebPartPages.WebPartPage,Microsoft.SharePoint,Version=12.0.0.0,Culture=neutral,PublicKeyToken=71e9bce111e9429c" meta:webpartpageexpansion="full" meta:progid="SharePoint.WebPartPage.Document" %>]]>
<![CDATA[<%@ Register Tagprefix="SharePoint" Namespace="Microsoft.SharePoint.WebControls" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>]]> <%@ Register Tagprefix="Utilities" Namespace="Microsoft.SharePoint.Utilities" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %> <%@ Import Namespace="Microsoft.SharePoint" %> <%@ Register Tagprefix="WebPartPages" Namespace="Microsoft.SharePoint.WebPartPages" Assembly="Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<![CDATA[<%@ Register Tagprefix="QuestechWebControls" 
    Namespace="QuestechSystems.SharePoint.WebControls"
    Assembly="QuestechSystems.SharePoint, Version=1.0.0.0, 
    Culture=neutral, PublicKeyToken=f1874fca2a9b1c17" %>]]>
<questechwebcontrols:flashmoviefield fieldname="FlashMovieFile"  runat="server" xmlns:questechwebcontrols="#unknown" />
<asp:content contentplaceholderid="PlaceHolderPageTitle" runat="server" xmlns:asp="#unknown">
	<sharepoint:listproperty property="Title"  runat="server" xmlns:sharepoint="#unknown" /></asp:content>
<asp:content contentplaceholderid="PlaceHolderPageTitleInTitleArea" runat="server" xmlns:asp="#unknown">
	<sharepoint:listproperty property="Title"  runat="server" xmlns:sharepoint="#unknown" />
</asp:content>
<asp:content contentplaceholderid="PlaceHolderAdditionalPageHead" runat="server" xmlns:asp="#unknown">
	<sharepoint:rsslink  runat="server" xmlns:sharepoint="#unknown" />
</asp:content>
<asp:content contentplaceholderid="PlaceHolderSearchArea" runat="server" xmlns:asp="#unknown">
	<sharepoint:delegatecontrol  runat="server" xmlns:sharepoint="#unknown">
		ControlId="SmallSearchInputBox"/>
</sharepoint:delegatecontrol></asp:content>
<asp:content contentplaceholderid="PlaceHolderPageImage" runat="server" xmlns:asp="#unknown">
	<sharepoint:viewicon width="145" height="54"  runat="server" xmlns:sharepoint="#unknown" /></asp:content>
<asp:content contentplaceholderid="PlaceHolderMain" runat="server" xmlns:asp="#unknown">
		<webpartpages:webpartzone  runat="server" frametype="None" id="Main" title="loc:Main" xmlns:webpartpages="#unknown"><zonetemplate></zonetemplate></webpartpages:webpartzone></asp:content>

Re: Modify what?

Stephen Huen

11:12 16 Jul '08

You can't insert content outside content placeholders, within but not outside.
Sign In·View Thread·Permalink

Re: Modify what?

CurtisG

6:16 19 Aug '08

Do you have and example of some modified code and the original code... I am having the same problem.
Sign In·View Thread·Permalink

Re: Modify what?

Stephen Huen

8:35 27 Aug '08

If you are modifying a page layout page, you would do something like:

<%@ Register Tagprefix="QuestechWebControls"
      Namespace="QuestechSystems.SharePoint.WebControls"
      Assembly="QuestechSystems.SharePoint, Version=1.0.0.0,
      Culture=neutral, PublicKeyToken=f1874fca2a9b1c17" %>
...

<asp:Content ContentPlaceholderID="PlaceHolderMain" runat="server">
...
     <QuestechWebControls:FlashMovieField FieldName="FlashMovieFile" runat="server" />
...
</asp:Content>
...

It couldn't open in vs2005

vinoinfozone

18:47 18 Jun '08

Hi Stephen, I download the project and open it is vs 2005. It cant open it will show the error the project type not support by this installation. Do u installed any addon. Thanks Vinoth
Sign In·View Thread·Permalink

Re: It couldn't open in vs2005

Stephen Huen

14:18 23 Jun '08

Please make sure you have VS 2005 SP1. It makes use of the Web Application project type.
Sign In·View Thread·Permalink	2.00/5 (1 vote)

Re: It couldn't open in vs2005 Xmen 18:28 6 Dec '08

Microsoft Visual Studio 2005
Version 8.0.50727.42  (RTM.050727-4200)
Microsoft .NET Framework
Version 2.0.50727 SP1
 
Installed Edition: Professional
 
Microsoft Visual Basic 2005   77626-009-0000007-41650
Microsoft Visual Basic 2005
 
Microsoft Visual C# 2005   77626-009-0000007-41650
Microsoft Visual C# 2005
 
Microsoft Visual C++ 2005   77626-009-0000007-41650
Microsoft Visual C++ 2005
 
Microsoft Visual J# 2005   77626-009-0000007-41650
Microsoft Visual J# 2005
 
Microsoft Visual Studio 2005 Tools for Applications   77626-009-0000007-41650
Microsoft Visual Studio 2005 Tools for Applications
 
Microsoft Visual Web Developer 2005   77626-009-0000007-41650
Microsoft Visual Web Developer 2005
 
Crystal Reports    AAC60-G0CSA4B-V7000AY
Crystal Reports for Visual Studio 2005
 

Security Update for Microsoft Visual Studio 2005 Professional Edition - ENU (KB925674)   
This Security Update is for Microsoft Visual Studio 2005 Professional Edition - ENU. \n
If you later install a more recent service pack, this Security Update will be uninstalled automatically. \n
For more information, visit http://support.microsoft.com/kb/925674

Security Update for Microsoft Visual Studio 2005 Professional Edition - ENU (KB937060)   
This Security Update is for Microsoft Visual Studio 2005 Professional Edition - ENU. 
If you later install a more recent service pack, this Security Update will be uninstalled automatically. 
For more information, visit http://support.microsoft.com/kb/937060

No, couldn't open

TVMU^P[[IGIOQHG^JSH`A#@`RFJ\c^JPL>;"[,*/|+&WLEZGc`AFXc!L
%^]*IRXD#@GKCQ`R\^SF_WcHbORY87֦ʻ6ϣN8ȤBcRAV\Z^&SU~%CSWQ@#2
W_AD`EPABIKRDFVS)EVLQK)JKSQXUFYK[M`UKs*$GwU#(QDXBER@CBN%
Rs0~53%eYrd8mt^7Z6]iTF+(EWfJ9zaK-iTV.C\y<pjxsg-b$f4ia>
--------------------------------------------------------
128 bit encrypted signature, crack if you can

Re: It couldn't open in vs2005

Stephen Huen

17:00 4 Jan '09

I believe you have .Net SP1 but not Visual Studio 2005 SP1. Mine says Microsoft Visual Studio 2005 Version 8.0.50727.762 (SP.050727-7600)
Sign In·View Thread·Permalink

File not found error message

CheGueVerra

12:21 6 Jun '08

When I select the radio for my custom field, I get the message file not found. Looking at the log, I had a SPRequest failure. Obviously, there is something wrong, I followed this blog sample http://www.sharepointblogs.com/jimyang/archive/2006/07/10/create-custom-field-type-in-wss-v3.aspx[^] With the exact same results. Any tips as to what to look for?
Sign In·View Thread·Permalink

Could I get some more details...

CurtisG

10:15 4 Jun '08

this looks really neat...
My initial thought would be to have tutorial flash files linked to items in a list.
Users could watch any thay wanted based on the list item they clicked.
What content type would you suggest you add this custom site column too?
An example would be good.
Also... what should the url target file look like to play a flash file?
An example of this would be good.
I can't seem to get one to play.

Do I have to use MOSS

vincemus

5:57 4 May '08

Hi There, thanks for a great article. I wish to avoid having to use MOSS because of the massive MS Licencing costs. Do I have to use MOSS in order for this to work on my Sharepoint servers in my company? Thanks Rob
Sign In·View Thread·Permalink