BB FlashBack SDK: FBExportToSWFParams

HTMLTemplate

Description

Sets the file name of an HTML template that will be used to display the exported SWF file.

Syntax

[C#/C++]
public String HTMLTemplate;

[VB.NET]
Public Property HTMLTemplate As String

Remarks

If the property contains a ":" or "/" character, it is assumed to be the fully qualified path to an HTML template file.

If it does not, it is assumed to be the name (minus the ".html" extension) of an HTML template file in the "Blueberry\Templates" subfolder located within the Windows APPDATA folder - the folder obtained from the SHGetFolderPath Win32 API, passing in a folder ID of CSIDL_APPDATA.

On Windows XP, this folder could be:
C:\Documents and Settings\<username>\Application Data\Blueberry\Templates

About HTML Template Files

When the SDK produces an SWF export file, it also produces an HTML file that is used to view the SWF. This is for two reasons:

  1. Many PCs cannot directly open an SWF file.

  2. The SWF movie will most likely be displayed by being embedded in a web page, so its useful to have the HTML code that performs this embedding.

The HTML file produced has the same file name as the SWF file, but with a .html extension instead. If the .html and .swf files are in the same folder, when the .html file is opened, it displays and plays back the SWF movie.

By default, the HTML file is a very simple page that embeds the SWF file via an <object> tag. The HTMLTemplate tag allows you to replace this simple page with HTML of your own.

The HTMLTemplate property should contain the HTML code for a complete page, plus two special tags that will be used by the export process:

  • <SWFTITLE> - will be replaced by the filename of the .FBR file being exported.

  • <SWFOBJECT> - will be replaced by a <OBJECT> tag that displays the SWF movie.