| Package | com.globfx.showroom |
| Class | public class SlideShow |
| Inheritance | SlideShow 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
| Property | Defined 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 | ||
| Method | Defined By | ||
|---|---|---|---|
endSlideShow():void
Ends the slide show. | SlideShow | ||
gotoFirstSlide():void
Jump to the first slide of the slide show. | SlideShow | ||
gotoLastSlide():void
Jump to the last slide of the slide show. | SlideShow | ||
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.
| SlideShow | ||
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.
| 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 | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the slide show is paused and resumed. | SlideShow | |||
| Constant | Defined By | ||
|---|---|---|---|
| PLAY_STATE_CHANGED : String = playStateChanged [static] | SlideShow | ||
| currentSlide | property |
currentSlide:Slide [read-only] Returns the current slide.
public function get currentSlide():Slide| endingSlide | property |
endingSlide:Slide [read-only] Returns the ending slide of the slide show.
public function get endingSlide():Slide| history | property |
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.
public function get history():ArraySee also
| numSlides | property |
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.
public function get numSlides():int| paused | property |
paused:Boolean [read-only] A flag that indicates whether the slide show is paused or playing.
public function get paused():Boolean| startDate | property |
startDate:Date [read-only] Returns the date and time the slide show was first started.
public function get startDate():Date| startingSlide | property |
startingSlide:Slide [read-only] Returns the starting slide of the slide show.
public function get startingSlide():Slide| endSlideShow | () | method |
public function endSlideShow():voidEnds the slide show.
| gotoFirstSlide | () | method |
public function gotoFirstSlide():voidJump to the first slide of the slide show.
| gotoLastSlide | () | method |
public function gotoLastSlide():voidJump 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():voidExecutes 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():voidJump to the beginning of the previous effect or jump to the previous slide if there is no more effect to unroll before.
| playStateChanged | Event |
flash.events.Eventcom.globfx.showroom.PLAY_STATE_CHANGEDDispatched when the slide show is paused and resumed.
| PLAY_STATE_CHANGED | Constant |
public static const PLAY_STATE_CHANGED:String = playStateChanged