FlashMovie WebControl

RonVecchi

Rate me:

4.53/5 (55 votes)

24 Apr 20054 min read

378.2K

148

147

A custom webcontrol enhancing the ability to easily add a Macromedia Flash movie to your webforms.

Download source - 25.7 Kb

Introduction

For those out there who have added Macromedia Flash movies to your dynamic web pages, you no doubt found it frustrating to make the movie itself dynamic. That is, dynamic variables and properties; or even the movie itself dynamic like a rotator. And even more frustrating what if you wanted default html in place just in case the Flash plug-in is not installed or you are going the route of enforcing that a certain version is installed through JavaScript, and in fact JavaScript has been disabled. Well, although this custom ASP.NET control does not sing and dance, it does make these tasks extremely easy to manage.

The FlashMovieControl wraps up all properties that can be pushed into a Flash movie, (i.e. scale, width, height, window mode... the list goes on). And does it all with great designer support, which proved to be a valuable learning experience for me. The current version of this control is currently up-to-date with the latest properties and output rendering of Macromedia 2004 Flash MX. You will find that the rendered content that is sent to the browser is exact to what is published directly from the Macromedia MX studio.

Features

Dynamically send variables to your Flash movie:

public class FlashMovieTest {
    protected Osmosis.Web.UI.Controls.FlashMovie FlashMovie1;
        
    private void function AddMovieVariables() {
        this.FlashMovie1 = new Osmosis.Web.UI.Controls.FlashMovie();
        this.FlashMovie1.MovieVariables.Add("MyVar1","MyValue1");
        this.FlashMovie1.MovieVariables.Add("MyVar2","MyValue2");
    }
}

-------------------------------------
Renders as:
<object classid= .... >
<PARAM NAME=movie VALUE="MyMovie.swf?MyVar1=MyValue1&MyVar2=MyValue2"> ....

Easily add HTML content just in case the Flash plug-in is unavailable on the client. (Only available with ClientScriptVersionDection). When the control is rendered, all necessary JavaScript code is rendered for version detection including the HTML content to render just in case no plug-in is available. Notice that the HTML code is wrapped up for you in the necessary document.write('') statements automatically. A huuuuuuuuuuuge time saver.

public class FlashMovieTest {
    protected Osmosis.Web.UI.Controls.FlashMovie FlashMovie1;
        
    private void function AddNoFlashPluginContent() {
        this.FlashMovie1 = new Osmosis.Web.UI.Controls.FlashMovie();
        this.FlashMovie1.FlashOutputType = 
            Osmosis.Web.UI.FlashOutputType.ClientScriptVersionDection;
        this.FlashMovie1.NoFlashContainer.Controls.Add(new Table());

    }
}

-------------------------------------
Renders as:
if ( MM_FlashCanPlay ) { ...

} else{
document.write('<table border="0" ID="Table1">');
document.write('');
document.write('</table>');
}

Almost identical to adding content to the NoFlashContainer, you can also add HTML just in case JavaScript is disabled and you are using ClientScriptVersionDection. When the control is rendered, all necessary JavaScript code is rendered for version detection. But what if the user's browser doesn't support JavaScript, you can add web controls programmatically that will render themselves within a <noscript></noscript> HTML block.

public class FlashMovieTest {
    protected Osmosis.Web.UI.Controls.FlashMovie FlashMovie1;
        
    private void function AddNoFlashPluginContent() {
        this.FlashMovie1 = new Osmosis.Web.UI.Controls.FlashMovie();
        this.FlashMovie1.FlashOutputType = 
          Osmosis.Web.UI.FlashOutputType.ClientScriptVersionDection;
        this.FlashMovie1.NoScriptContainer.Controls.Add(new Table());

    }
}

-------------------------------------
Renders as:
<NOSCRIPT>
    <table border="0" ID="Table1"></table>
</NOSCRIPT>

FS_Command support is available now. Simply specify the URI of the script tag to include in your webpage. This will render out a script tag with the SRC attribute set to your URI.

public class FlashMovieTest {
    protected Osmosis.Web.UI.Controls.FlashMovie FlashMovie1;
        
    private void Page_Load(object sender, System.EventArgs e) {
    
        this.FlashMovie1 = new Osmosis.Web.UI.Controls.FlashMovie();
        this.FlashMovie1.FSCommandScriptUrl = "../MyJavaScriptFile.js";

    }
}

-------------------------------------
Renders as:
<script language="javascript" src="../MyJavaScriptFile.js"></script>

What are the FlashOutputType's for? (Osmosis.Web.UI.FlashOutputType)

ClientScriptVersionDection: Tells the FlashMovieControl to render the necessary JavaScript code to perform plug-in version detection on the version that you specify. Also rendered in this mode is any NoScript/NoPlugin content that you assigned to the NoScriptContainer and NoFlashContainers.
FlashOnly: Tells the FlashMovieControl to only render the necessary HTML to embed your movie into the webpage. Basically, everything but the client script for detecting the plug-in version.
SWFVersionDetection: This one's a bit odd. It is the latest output type used in Macromedia's Flash Studio 2004. It uses an swf movie to detect if Flash is installed. What, it uses a Flash Movie to detect if Flash is installed on the client? It didn't make sense to me either. But in Flash MX 2004, when you publish with this flag set, it will generate an swf movie (version 4 only) that will direct you to your intended movie. Use this output method with the FlashMovieControl properties: SWF_
C#
```
///Example of using SWFVersionDetection
this.FlashMovie1.FlashOutputType = 
   Osmosis.Web.UI.FlashOutputType.SWFVersionDetection;
this.FlashMovie1.MovieName = "MyMacromediaGeneratedDetectionMovie.swf";

this.FlashMovie1.SWF_DetectionAltUrl = "IfNotDetectedUrl.aspx";
this.FlashMovie1.SWF_DetectionContentUrl = "IfDetectedUrl.aspx";
```
All other output types are not supported but default to FlashOnly. I added them into the enumeration for remembrance to add in future.

Get me started using the FlashMovieControl

Make sure to reference the .dll in your project. In the Solution Explorer, locate your project and right click on the References node. Select Add Reference. Browse for the .dll file downloaded from CodeProject and click OK. To use with the designer: when your webform is in design view, open up the Toolbox and right click. Select Add/Remove Items. Browse for the .dll file downloaded from CodeProject and click OK. Now the FlashMovieControl is added to your Toolbox. Just drag it onto your page and open up your Properties window. One thing to keep in mind is to always set the MovieName property. This is the URL of the actual .swf file. If you forget to add the actual movie, your browser will hang because it is trying to locate the file that is non-existent. In a future release, I will set the control to throw an exception if no movie has been set. Below is an example of using the FlashMovieControl with ClientScriptVersionDetection as the FlashOutputType.

using System;
using System.Collections;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Web;
using System.Web.SessionState;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.HtmlControls;

namespace FlashTest
{

    public class FlashMovieControlTest : System.Web.UI.Page
    {
        protected Osmosis.Web.UI.Controls.FlashMovie FlashMovie1;
    
        private void Page_Load(object sender, System.EventArgs e)
        { 
            this.FlashMovie1 = new Osmosis.Web.UI.Controls.FlashMovie();
            
            ///Set the output type and Movie
            this.FlashMovie1.FlashOutputType = 
              Osmosis.Web.UI.FlashOutputType.ClientScriptVersionDection;
            ///Always make sure you have a valid movie 
            ///or your browser will hang.
            this.FlashMovie1.MovieName = "MyMovie.swf";
            
            /// Set the plugin version to check for
            this.FlashMovie1.MajorPluginVersion = 7;
            this.FlashMovie1.MajorPluginVersionRevision = 0;
            this.FlashMovie1.MinorPluginVersion = 0;
            this.FlashMovie1.MinorPluginVersionRevision = 0;
            
            ///Set some other properties
            this.FlashMovie1.MovieHeight = "400px";
            this.FlashMovie1.MovieWidth = "200px";
            this.FlashMovie1.AutoLoop = false;
            this.FlashMovie1.AutoPlay = true;
            this.FlashMovie1.FlashHorizontalAlignment = 
                 Osmosis.Web.UI.FlashHorizontalAlignment.Center;
            this.FlashMovie1.FlashVerticalAlignment = 
                 Osmosis.Web.UI.FlashVerticalAlignment.Top;
            this.FlashMovie1.HtmlAlignment = 
                 Osmosis.Web.UI.FlashHtmlAlignment.Right;
            this.FlashMovie1.UseDeviceFonts = false;
            this.FlashMovie1.WindowMode = 
                 Osmosis.Web.UI.FlashMovieWindowMode.Transparent;
            this.FlashMovie1.ShowMenu = false;
            this.FlashMovie1.MovieQuality = 
                 Osmosis.Web.UI.FlashMovieQuality.AutoHigh;
            this.FlashMovie1.MovieScale = 
                 Osmosis.Web.UI.FlashMovieScale.NoScale;
            
            /// Add some variables
            this.FlashMovie1.MovieVariables.Add("MyVar1","MyValue1");
            this.FlashMovie1.MovieVariables.Add("MyVar2","MyValue2");
            this.FlashMovie1.MovieVariables.Add("MyVar3","MyValue3");
            
            ///Set the NoScript and NoFlash content.  
            ///In most situations where
            ///html will be displayed the content is the same for both
            this.FlashMovie1.NoFlashContainer.Controls.Add(
              this.GetDefaultHtmlContent());
            this.FlashMovie1.NoScriptContainer.Controls.Add(
              this.GetDefaultHtmlContent());
        }
        
        

        private HtmlTable GetDefaultHtmlContent(){
            
            HtmlTable tbl = new HtmlTable();
            HtmlTableRow tr = new HtmlTableRow();
            HtmlTableCell td = new HtmlTableCell();
            Label lbl = new Label();
            lbl.Text = "This is my default content";
            
            td.Controls.Add(lbl);
            tr.Cells.Add(td);
            tbl.Rows.Add(tr);
            return tbl;
        }

        #region Web Form Designer generated code
        override protected void OnInit(EventArgs e)
        {
            //
            // CODEGEN: This call is required by the ASP.NET 
            // Web Form Designer.
            //
            InitializeComponent();
            base.OnInit(e);
        }
        
        /// <summary>
        /// Required method for Designer support - do not modify
        /// the contents of this method with the code editor.
        /// </summary>
        private void InitializeComponent()
        {    
            this.Load += new System.EventHandler(this.Page_Load);

        }
        #endregion
    }
}

-------------------------------------------------------------------
Renders As......
-------------------------------------------------------------------
<SCRIPT LANGUAGE=JavaScript1.1>
<!--
var MM_contentVersion = 7;
var plugin = (navigator.mimeTypes && navigator.mimeTypes[
  "application/x-shockwave-flash"]) ?
navigator.mimeTypes["application/x-shockwave-flash"].enabledPlugin : 0;
if ( plugin ) {
var words = navigator.plugins["Shockwave Flash"].description.split(" ");
for (var i = 0; i < words.length; ++i)
{
if (isNaN(parseInt(words[i])))
continue;
var MM_PluginVersion = words[i];
}
var MM_FlashCanPlay = MM_PluginVersion >= MM_contentVersion;
}
else if (navigator.userAgent && navigator.userAgent.indexOf("MSIE")>=0
&& (navigator.appVersion.indexOf("Win") != -1)) {
document.write('<SCR' + 'IPT LANGUAGE=VBScript\> \n');
document.write('on error resume next \n');
document.write('MM_FlashCanPlay = ( 
  IsObject(CreateObject("ShockwaveFlash.ShockwaveFlash." & 
  MM_contentVersion)))\n');
document.write('</SCR' + 'IPT\> \n');
}
if ( MM_FlashCanPlay ) {
document.write('<OBJECT classid=
  "clsid:d27cdb6e-ae6d-11cf-96b8-444553540000"');
document.write('  codebase=
  "http://fpdownload.macromedia.com/pub/shockwave/cabs/
  flash/swflash.cab#version=7,0,0,0" ');
document.write(' ID="FlashMovie1" WIDTH="200px" 
  HEIGHT="400px" ALIGN="right">');
document.write(' <PARAM NAME=movie 
  VALUE="MyMovie.swf?MyVar1=MyValue1&MyVar2=MyValue2&MyVar3=MyValue3"> 
  <PARAM NAME=loop VALUE=false /> <PARAM NAME=menu VALUE=false /> 
  <PARAM NAME=scale VALUE=noscale /> <PARAM NAME=wmode VALUE=transparent />
  <PARAM NAME=salign VALUE=T /> <PARAM NAME=quality VALUE=AutoHigh/> 
  <PARAM NAME=bgcolor VALUE=#ffffff/> <PARAM NAME="allowScriptAccess" 
  value="SameDomain" />  ');
document.write(' <EMBED 
  src="MyMovie.swf?MyVar1=MyValue1&MyVar2=MyValue2&MyVar3=MyValue3" 
  loop="false" menu="false" scale="noscale" wmode="transparent" 
  salign="T" quality="autohigh" bgcolor="#ffffff" 
  allowScriptAccess="SameDomain"   ');
document.write(' swLiveConnect=FALSE WIDTH="200px" 
  HEIGHT="400px" NAME="MyMovie.swf" ALIGN="right"');
document.write(' TYPE="application/x-shockwave-flash" 
  PLUGINSPAGE="http://www.macromedia.com/go/getflashplayer">');
document.write(' </EMBED>');
document.write(' </OBJECT>');
} else{
document.write('<table>');
document.write('    <tr>');
document.write('        <td><span>This is my default content</span></td>');
document.write('    </tr>');
document.write('</table>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<table ID="Table1">
    <tr>
        <td><span>This is my default content</span></td>
    </tr>
</table>
</NOSCRIPT>

HTML View example
------------------

<OSMOSIS:FLASHMOVIE id=FlashMovie1 runat="server" 
  MovieName="MyMovie.swf" AutoLoop="False" AutoPlay="False" 
MovieScale="NoScale" MovieQuality="AutoLow" FlashHorizontalAlignment="Right" 
FlashVerticalAlignment="Top" MovieHeight="222" MovieWidth="33" 
WindowMode="Transparent"></Osmosis:FlashMovie>

Thanks for all your input! Keep it coming. Feel free to contact with any questions or suggestions.

History

Initial release: Up-to-date with Macromedia 2004 properties and output methods.
2005/04/12:
- Enhancement: all properties are maintained in viewstate (except NoScript and NoFlash control properties).
- Bug fix: should be working better with MAC IE browser (went back to outputting embed tag for all browsers).
- Bug fix: when using SSL in your movie names, the Macromedia codebase, detection plugins page, and plugins page also use SSL (gets rid of the browser message asking if you want to display non-secure content in a secure page).
2004/04/13
- FSCommand support added.
- Bug fix: multiple Flash movies on a page supported now (implements INamingContainer).
- Browser detection: only outputs <embed> tag for non-IE browsers.
2005/04/15:
- Bug fix: added better support for testing for SSL use.
2004/05/07:

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Written By

RonVecchi

Web Developer

United States

This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

/// <summary> /// Flash Movie Control. /// </summary> [ ToolboxData("<{0}:FlashMovie runat=server></{0}:FlashMovie>"), Description ("Flash Movie Control."), DefaultProperty ("MovieName"), Designer(typeof(FlashMovieDesigner)), ControlBuilder(typeof(FlashMovieBuilder)) ] public class FlashMovie : System.Web.UI.Control, INamingContainer {

/// <summary> /// Designer class for FlashMovie /// </summary> public class FlashMovieDesigner : ControlDesigner { #region Private variables #endregion /// <summary> /// Build design time HTML /// </summary> /// <returns>Design time HTML</returns> public override string GetDesignTimeHtml() { // Initialize FlashMovie flashMovie = (FlashMovie)Component; StringWriter stringWriter = new StringWriter(); HtmlTextWriter htmlTextWriter = new HtmlTextWriter(stringWriter); string rtn = null; try { flashMovie.RenderControl(htmlTextWriter); rtn = stringWriter.ToString(); //rtn = base.GetDesignTimeHtml(); } catch (Exception ex) { // If something fails, report as usual rtn = GetErrorDesignTimeHtml(ex); } // If we have nothing to display, go with // the default "Empty" Html if (rtn == null || rtn.Length == 0) { rtn = GetEmptyDesignTimeHtml(); } return rtn; } /// <summary> /// HTML for empty design /// </summary> /// <returns>HTML for empty design</returns> protected override string GetEmptyDesignTimeHtml() { string message = null; FlashMovie flashMovie = (FlashMovie)Component; if(flashMovie.MovieName == string.Empty) { message = "No MovieName has been set"; } else { message = "MovieName: " + flashMovie.MovieName; } return GetIncapsulatedDesignTimeHtml(message); } /// <summary> /// /// </summary> /// <param name="ex"></param> /// <returns></returns> protected override string GetErrorDesignTimeHtml(Exception ex) { //return GetIncapsulatedDesignTimeHtml(ex.ToString()+" "+ex.InnerException.ToString()); return GetIncapsulatedDesignTimeHtml(ex.ToString()); } private string GetIncapsulatedDesignTimeHtml(string message) { return "<table width=\"200\" height=\"200\" border=\"1\"><tr><td align=\"center\" valign=\"middle\">Flash movie container "+message+"</td></tr></table>"; } /// <summary> /// Initializing the designer /// </summary> /// <param name="component">Attached control</param> public override void Initialize(System.ComponentModel.IComponent component) { // Throw an exception if the designer is attached // to a control for which it is not intended if (! (component is FlashMovie)) { throw new InvalidOperationException( this.GetType().FullName + " only supports controls derived from Osmosis.Web.UI.Controls.FlashMovie" ); } base.Initialize (component); } } /// <summary> /// Control builder class for FlashMovie /// </summary> public class FlashMovieBuilder : ControlBuilder { /// <summary> /// Treat whitespace literals as empty /// </summary> public override bool AllowWhitespaceLiterals() { return false; } /// <summary> /// When adding child controls, throw an exception /// unless child is a DataBoundLiteralControl /// </summary> /// <param name="subBuilder">Control builder of child control</param> public override void AppendSubBuilder(ControlBuilder subBuilder) { if (subBuilder.ControlType == null) { // This allows codeblocks to be added in the // inner text of the control base.AppendSubBuilder(subBuilder); } else { throw new InvalidOperationException( String.Format( "Control {0} may not contain {1}", ControlType.FullName, subBuilder.ControlType.FullName ) ); } } }

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.