Differences

This shows you the differences between two versions of the page.

Link to this comparison view

web:slideshow [2018/04/14 16:09]
web:slideshow [2019/10/23 05:53] (current)
Line 1: Line 1:
 +==== Enumerations ====
 +^ Name      ^ Values ​      ^
 +|  | This class exposes no enumerations. |
  
 +==== Constants ====
 +^ Name      ^ Type     ^ Value       ^
 +| NavStyleNone | Integer | 0 |
 +| NavStyleCentered | Integer | 1 |
 +| NavStyleTransparent | Integer | 2 |
 +| NavStyleLarge | Integer | 3 |
 +
 +==== Events ====
 +^ Definition ​     ^ Description ​      ^
 +| SlideChanged() | This event is fired when the slideshow has finished changing slides. |
 +
 +==== Methods ====
 +^ Definition ​     ^ Description ​      ^
 +| AddSlide( theSlide as Variant, theCaption as String = ""​ ) | Adds a new slide to the rotation. |
 +| GetSlideByCaption( theCaption as String ) as Integer) | Returns the index of a slide by using the caption. |
 +| GetSlideByURL( theURL as String ) as Integer | Returns the index of a slide by using the URL. |
 +| GetSlideCaption( theIndex as Integer ) as String | Returns the caption of the slide at the specified index. |
 +| GetSlideURL( theIndex as Integer ) as String | Returns the image URL of the slide at the specified index. |
 +| RemoveSlide( theSlide as Integer ) | Removes a slide by index. |
 +
 +==== Properties ====
 +^ Name      ^ Type       ^ Default Value       ^ Description ​      ^
 +| AnimationSpeed | Integer | 300 | How long each animation takes to complete in milliseconds.|
 +| Captions() | String | Nil | The captions to be displayed for each corresponding slide. The contents of this array should match up with the contents of the SlideImages() array, and an empty value (“”) will not display the caption area. |
 +| CurrentSlide | Integer | 0 | The index of the slide currently being displayed. |
 +| NavigationStyle | Integer | NavStyleNone | Determines how the user will be allowed to navigate between the slides. |
 +| PauseOnHover | Boolean | False | When set to true, hovering the mouse over the slideshow will pause progression through the slides. |
 +| SlideImages() | String | Nil | This string array should contain URLs to the images you wish to display within the IMG tag. Alternatively,​ BASE64 encoded images will work if formatted to be displayed within the SRC attribute of an IMG tag. |
 +| SlideTimeout | Integer | 5000 | How long each slide will be displayed before moving to the next one, in milliseconds. |
 +
 +==== Examples ====
 +There are currently no examples for this class.
 +
 +====== Changes to this Page ======
 +^ Date ^ Edit ^ Editor ^
 +| 08/01/2017 | Release 24 | Anthony G. Cyphers
 +
 +|