ASPNetFlash WebControl Object Reference
The ASPNetFlash allows you to add Adobe Flash media (.swf files) into your ASP.NET web forms.
Object Reference for ASPNetFlash.Flash in resource ASPNetFlash.NET2.dll, ASPNetFlash.NET2.AJAX.dll or ASPNetFlash.NET1.dll
These properties can be accessed programmatically (e.g. in C# or VB.Net) or by using the properties editor. In Visual Studio 2005 you can also access the properties using Smart Tags.
Appearance
|
BackColor
|
Color of the background of the control.
|
|
CssClass
|
CSS Class name applied to the control.
|
Behavior
|
DebugMode
|
When DebugMode is set to true, the ASPNetFlash control runs in debug mode. During debug mode, a console is shown that displays information about what is sent into Flash, what it receives, and other data for use when debugging or integrating ActionScript and .NET development. The runtime debugger console makes coordination and communication between Flash and .NET developers clearer and more direct.
|
|
Enabled
|
If Enabled is set to false, only the HTMLAlternative content will be rendered.
True by default. |
|
EnableViewState
|
Whether the control automatically saves its state for use in round-trips.
True by default. |
|
Visible
|
If Visible is set to false, the control will not be rendered.
True by default
|
Data
DataMember |
The table of view used for binding against. Not available in Visual Studio 2002/2003. |
DataSource |
The IDataSource object bound to the WebControl. In Visual Studio 2002/2003, only XmlReader, TextReader and XmlDocument types are supported. |
DataSourceID |
The control ID of an IDataSource that will be used as the data source. Not available in Visual Studio 2002/2003. |
FlashVariables |
Defines a set of variables which are passed into the Flash Movie to be read by ActionScript. FlashVariables can be set programmatically, as follows:
FlashVarsItemCollection Methods:
string FlashVariables[string name] |
Allows indexing Flash Variables by name. Set or return the string Value of Flash Variable named name. Not available in Visual Studio 2002/2003. |
FlashVariable FlashVariables[int index] |
Allows indexing Flash Variables by index. Set or return the FlashVariable object at index index. |
void FlashVariables.Add(FlashVariable flashVar) |
Adds FlashVariable flashVar to the collection. |
void FlashVariables.Insert(int index, FlashVariable flashVar) |
Inserts FlashVariable flashVar to the collection at index. |
void FlashVariables.Remove(FlashVariable flashVar) |
Remove FlashVariable flashVar from the collection. |
bool FlashVariables.Contains(FlashVariable flashVar) |
Returns true if the FlashVariable flashVar exists in the collection. |
string FlashVariables.GetValueByName(string name) |
Returns the string value of the Flash Variable called name. |
void FlashVariables.SetValueByName(string name, string value) |
Sets the string value of the Flash Variable called name. |
FlashVariable Properties:
string FlashVariable.Name |
Get or set the name of the Flash Variable. |
string FlashVariable.Value |
Get or set the value of the Flash Variable. |
|
Flash
|
Alignment
|
Sets the 'align' attribute of the control, which works exactly as it does on a div tag.
Default - Does not set the 'align' attribute for the control.
Center - Set the 'align' attribute for the control to 'center'.
Left - Set the 'align' attribute for the control to 'left'.
Right - Set the 'align' attribute for the control to 'right'. |
|
AllowScriptAccess
|
Allow Flash Movie to read external scripts, such as XML and ASPX data files.
Always - Allows access to read and send data from any external script or file.
SameDomain - Allows is limited to within your website.
Never - No access is given to read external or send data.
|
|
EolasFixEnabled
|
If desired, you may set this false to turn off the Eolas Fix and allow the 'Click to activate and use this Control' message to be displayed in Opera and Internet Explorer browsers.
True by default. |
|
MovieURL
|
The URL of the Flash Movie (.swf format).
This can be a local URL (e.g. ~/movie.swf ) or a complete remote URL (e.g. http://www.mysite.com/movie.swf).
If a remote URL is specified then PlayerVersionAutoDetect, HeightAutoDetect & WidthAutoDetect will not work.
|
|
PlayerVersion
|
The minimum Flash Plug-In version required to display the Flash Movie. Please use only Numerals and periods in your version definition. (Ex: 10.1).
If this condition is not met then the HTMLAlternative content will be displayed instead.
|
|
PlayerVersionAutoDetect
|
Allow ASPNetFlash to detect your Flash Movie's Player Version at runtime. Only works for .swf files that are on your webserver.
|
|
Quality
|
Set to a higher quality for smoother, higher quality graphics and text. Set lower for faster performance.
Best - provides the best display quality and does not consider playback speed. All output is anti-aliased and bitmaps are always smoothed.
High (default) - favors appearance over playback speed and always uses anti-aliasing. If the SWF file does not contain animation, bitmaps are smoothed; if the SWF file has animation, bitmaps are not smoothed.
AutoHigh - emphasizes playback speed and appearance equally at first but sacrifices appearance for playback speed if necessary. Playback begins with anti-aliasing turned on. If the actual frame rate drops below the specified frame rate, anti-aliasing is turned off to improve playback speed.
Medium - applies some anti-aliasing but does not smooth bitmaps. It produces a better quality than the Low setting but lower quality than the High setting.
AutoLow - emphasizes speed at first but improves appearance whenever possible. Playback begins with anti-aliasing turned off. If Flash Player detects that the processor can handle it, anti-aliasing is automatically turned on.
Low - favors playback speed over appearance and does not use anti-aliasing.
|
|
ScaledAlignment
|
ScaledAlignment of Flash Movie. Translates to the 'salign' property in the Flash object.
Center (default) - Does not set the 'salign' property.
Left - Set the 'salign' attribute for the object to 'l'.
Right - Set the 'salign' attribute for the object to 'r'.
Top - Set the 'salign' attribute for the object to 't'.
Bottom - Set the s'align' attribute for the object to 'b'.
TopLeft - Set the 'salign' attribute for the object to 'tl'.
TopRight - Set the 'salign' attribute for the object to 'tr'.
BottomLeft - Set the 'salign' attribute for the object to 'bl'.
BottomRight - Set the 'salign' attribute for the object to 'br'.
|
|
ScaleMode
|
Defines how the Flash Movie scales within your height and width definitions.
ShowAll (Default) - makes the entire Flash content visible in the specified area without distortion while maintaining the original aspect ratio of the movie. Borders can appear on two sides of the application.
NoBorder - scales the Flash content to fill the specified area, without distortion but possibly with some cropping, while maintaining the original aspect ratio of the application.
ExactFit - makes the entire Flash content visible in the specified area without trying to preserve the original aspect ratio. Distortion can occur.
NoScale - makes the size of the Flash content fixed, so that it remains unchanged even as the size of the player window changes. Cropping may occur if the player window is smaller than the Flash content.
|
|
SwLiveConnect
|
Enables the SwLiveConnect Javascript interface for SWF movies.
|
|
WindowMode
|
Defines how the Flash Movie is played in reference to objects in front or behind it.
Window (default) - does not embed any window-related attributes in the object and embed tags. The background of the Flash content is opaque and uses the HTML background color. The HTML cannot render above or below the Flash content.
Opaque - sets the background of the Flash content to opaque, obscuring anything underneath the Flash content. Opaque Windowless lets HTML content appear above or on top of Flash content.
Transparent - sets the background of the Flash content to transparent. This allows the HTML content to appear above and below the Flash content.
|
Flash 9
|
AllowFullScreen
|
Enables full screen option for web browsers using Flash Player 9.
|
Layout
|
Height
|
Height of the Flash Movie.
|
|
HeightAutoDetect
|
Allow ASPNetFlash to detect your Flash Movie's Height at runtime. Only works for .swf files that are on your webserver.
|
|
Width
|
Width of the Flash Movie.
|
|
WidthAutoDetect
|
Allow ASPNetFlash to detect your Flash Movie's Width at runtime. Only works for .swf files that are on your webserver.
|
Playback
|
LoopAtEnd
|
Loops the Flash Movie to the beggining when it plays to the end of its timeline.
|
|
PausedAtStart
|
Starts the Flash Movie paused in its first frame.
|
|
ShowFullMenu
|
Display a full context menu (when users right click the Flash Movie). Set false to display an abbreviated context menu.
|
Parts of this reference are direct excerpts from the Adobe Flash online manual.
http://livedocs.macromedia.com/flash/8/