Packagecom.globfx.showroom
Classpublic class ShowRoom
InheritanceShowRoom Inheritance Object

The ShowRoom class represents the main ShowRoom API object.

It should be created once at startup to establish the bridge between the Flash and PowerPoint.



Public Properties
 PropertyDefined By
  background : SwiffPlayerBackground
[read-only] The background bitmap behind the Swiff Player PowerPoint Shape during the slide show. This bitmap can be used only if the Flash is transparent in the slide.
ShowRoom
  pptRelease : int
[read-only] The release number of PowerPoint that plays the slide show.
ShowRoom
  pptVersion : String
[read-only] The version of PowerPoint that plays the slide show.
ShowRoom
  presentation : Presentation
[read-only] The PowerPoint Presentation that is displayed by the Slide Show.
ShowRoom
  shape : SwiffPlayerShape
[read-only] The PowerPoint Shape that represents this Flash in the slide.
ShowRoom
  slideShow : SlideShow
[read-only] The PowerPoint Slide Show that is currently playing.
ShowRoom
  version : String
[read-only] The version of ShowRoom that plays this Flash.
ShowRoom
Public Methods
 MethodDefined By
  
create(root:Sprite):ShowRoom
[static] Creates a ShowRoom object and initializes the bridge between Flash and PowerPoint. If the Flash is not running in PowerPoint, returns null.
ShowRoom
  
dispose():void
Disposes a ShowRoom object.
ShowRoom
Property Detail
backgroundproperty
background:SwiffPlayerBackground  [read-only]

The background bitmap behind the Swiff Player PowerPoint Shape during the slide show.

This bitmap can be used only if the Flash is transparent in the slide. To make a Flash transparent, check the "Transparent" check box in the shape properties. If the shape is not transparent, this property returns null.


Implementation
    public function get background():SwiffPlayerBackground
pptReleaseproperty 
pptRelease:int  [read-only]

The release number of PowerPoint that plays the slide show. Release 11 is PowerPoint 2003. Release 12 is PowerPoint 2007. Release 14 is PowerPoint 2010.


Implementation
    public function get pptRelease():int
pptVersionproperty 
pptVersion:String  [read-only]

The version of PowerPoint that plays the slide show. Sample version string is "12.0.6500.5000" for PowerPoint 2007 SP2 for instance.


Implementation
    public function get pptVersion():String
presentationproperty 
presentation:Presentation  [read-only]

The PowerPoint Presentation that is displayed by the Slide Show.


Implementation
    public function get presentation():Presentation
shapeproperty 
shape:SwiffPlayerShape  [read-only]

The PowerPoint Shape that represents this Flash in the slide.


Implementation
    public function get shape():SwiffPlayerShape
slideShowproperty 
slideShow:SlideShow  [read-only]

The PowerPoint Slide Show that is currently playing.


Implementation
    public function get slideShow():SlideShow
versionproperty 
version:String  [read-only]

The version of ShowRoom that plays this Flash. ShowRoom version strings include major, minor, build and revision values, separated by dots, e.g. "2.0", or "2.1", or "2.0.1"


Implementation
    public function get version():String
Method Detail
create()method
public static function create(root:Sprite):ShowRoom

Creates a ShowRoom object and initializes the bridge between Flash and PowerPoint.

If the Flash is not running in PowerPoint, returns null.

Parameters

root:Sprite

Returns
ShowRoom — A ShowRoom object or null if the Flash is not running into PowerPoint.

Throws
Error — If a ShowRoom object has already been created.
dispose()method 
public function dispose():void

Disposes a ShowRoom object.