Packagecom.globfx.showroom
Classpublic class SlideShow
InheritanceSlideShow Inheritance flash.events.EventDispatcher

The SlideShow class represents the PowerPoint slide show that is currently playing.

It can be retrieved through the ShowRoom.slideShow property.

See also

com.globfx.showroom.ShowRoom
com.globfx.showroom.ShowRoom.slideShow


Public Properties
 PropertyDefined By
  currentSlide : Slide
[read-only] Returns the current slide.
SlideShow
  endingSlide : Slide
[read-only] Returns the ending slide of the slide show.
SlideShow
  history : Array
[read-only] Returns the slide show history. The slide show history contains the list of all previously visited slides.
SlideShow
  numSlides : int
[read-only] Returns the total number of slides of the slide show. This number does not necessarily equals the number of slides of the presentation.
SlideShow
  paused : Boolean
[read-only] A flag that indicates whether the slide show is paused or playing.
SlideShow
  startDate : Date
[read-only] Returns the date and time the slide show was first started.
SlideShow
  startingSlide : Slide
[read-only] Returns the starting slide of the slide show.
SlideShow
Public Methods
 MethodDefined By
  
Ends the slide show.
SlideShow
  
Jump to the first slide of the slide show.
SlideShow
  
Jump to the last slide of the slide show.
SlideShow
  
Jump to the next slide of the slide show. Does nothing if the current slide is the starting slide of the slide show.
SlideShow
  
Jump to the previous slide of the slide show. Does nothing if the current slide is the ending slide of the slide show.
SlideShow
  
gotoSlideNumber(number:int):void
Jump to the specified slide number. If the specified slide cannot be reached (for example, not in the slide show), the function does nothing. For example, the first slide number of the slide show is ShowRoom.slideShow.startSlide.number.
SlideShow
  
next():void
Executes the next PowerPoint effect or jump to the next slide if there is no more effect to run in the current slide.
SlideShow
  
previous():void
Jump to the beginning of the previous effect or jump to the previous slide if there is no more effect to unroll before.
SlideShow
Events
 Event Summary Defined By
  Dispatched when the slide show is paused and resumed.SlideShow
Public Constants
 ConstantDefined By
  PLAY_STATE_CHANGED : String = playStateChanged
[static]
SlideShow
Property Detail
currentSlideproperty
currentSlide:Slide  [read-only]

Returns the current slide.


Implementation
    public function get currentSlide():Slide
endingSlideproperty 
endingSlide:Slide  [read-only]

Returns the ending slide of the slide show.


Implementation
    public function get endingSlide():Slide
historyproperty 
history:Array  [read-only]

Returns the slide show history.

The slide show history contains the list of all previously visited slides. Also recorded are the date and time the slide was entered as well as the elapsed time on the slide.

The first item of the array (index 0) represents the current slide, the next item (index 1) is the previously visited slide in the past, etc.


Implementation
    public function get history():Array

See also

numSlidesproperty 
numSlides:int  [read-only]

Returns the total number of slides of the slide show.

This number does not necessarily equals the number of slides of the presentation. It can be a subset.


Implementation
    public function get numSlides():int
pausedproperty 
paused:Boolean  [read-only]

A flag that indicates whether the slide show is paused or playing.


Implementation
    public function get paused():Boolean
startDateproperty 
startDate:Date  [read-only]

Returns the date and time the slide show was first started.


Implementation
    public function get startDate():Date
startingSlideproperty 
startingSlide:Slide  [read-only]

Returns the starting slide of the slide show.


Implementation
    public function get startingSlide():Slide
Method Detail
endSlideShow()method
public function endSlideShow():void

Ends the slide show.

gotoFirstSlide()method 
public function gotoFirstSlide():void

Jump to the first slide of the slide show.

gotoLastSlide()method 
public function gotoLastSlide():void

Jump to the last slide of the slide show.

gotoNextSlide()method 
public function gotoNextSlide():void

Jump to the next slide of the slide show.

Does nothing if the current slide is the starting slide of the slide show.

gotoPreviousSlide()method 
public function gotoPreviousSlide():void

Jump to the previous slide of the slide show.

Does nothing if the current slide is the ending slide of the slide show.

gotoSlideNumber()method 
public function gotoSlideNumber(number:int):void

Jump to the specified slide number.

If the specified slide cannot be reached (for example, not in the slide show), the function does nothing.

For example, the first slide number of the slide show is ShowRoom.slideShow.startSlide.number.

Parameters

number:int — The slide number to jump to.

See also

next()method 
public function next():void

Executes the next PowerPoint effect or jump to the next slide if there is no more effect to run in the current slide.

previous()method 
public function previous():void

Jump to the beginning of the previous effect or jump to the previous slide if there is no more effect to unroll before.

Event Detail
playStateChanged Event
Event Object Type: flash.events.Event
Event.type property = com.globfx.showroom.PLAY_STATE_CHANGED

Dispatched when the slide show is paused and resumed.

Constant Detail
PLAY_STATE_CHANGEDConstant
public static const PLAY_STATE_CHANGED:String = playStateChanged