Wijmo UI for the Web
options type
Inheritance Hierarchy

Object
   wijmo.lightbox.wijlightbox.options

Browser Compatibility
7
5
5
Fields
 NameDescription
public OptionautoPlay

Default value: false

Determines whether pages are automatically displayed in order.

 
public OptionautoPlayMovies

Default value: true

Determines whether to turn on the autoplay option in movie player.

 
public OptionautoSize

Default value: true

A value determines whether to auto-size to keep the original width/height ratio of content.

 
public OptionclickPause

Default value: false

Determines whether to pause the auto-play when clicking the content.

 
public OptioncloseOnEscape

Default value: true

Determines whether to close the pop-up window when a user presses the ESC key.

 
public OptioncloseOnOuterClick

Default value: true

Determines whether to close the pop-up window when user clicks on the outside of content.

 
public OptioncontrolsPosition

Default value: 'inside'

Determines the position of control buttons.

 
public Optioncookie

Default value: null

Store the latest active index in a cookie. The cookie is then used to determine the initially active index

 
public OptioncounterFormat

Default value: '[i] of [n]'

Determines the text format of counter. '[i]' and '[n]' are built-in parameters represents the current page index and the number of pages.

 
public OptioncounterLimit

Default value: 10

Determines the maximum number of digit buttons in sequence counter type.

 
public OptioncounterType

Default value: 'default'

Determines the type counter style. Possible values are: 'default', 'sequence'

 
public OptionctrlButtons

Default value: ""

Determines the visibility of the control buttons. Possible values are: 'play', 'stop' separated by '|'.

 
public Optiondelay

Default value: 2000

Determines the time span in milliseconds between panels in autoplay mode.

 
public OptiondialogButtons

Default value: 'close'

Determines the visibility of the dialog buttons. Possible values are: 'close', 'fullSize' separated by '|'.

 
public OptionflashInstall

Default value: 'player\\\\expressInstall.swf'

Determines the relative path and name of the flash installation guide.

 
public OptionflashParams

Determines a hash object that contains parameters for a flash object.

 
public OptionflashVars

Determines a hash object that contains variants for a flash object.

 
public OptionflashVersion

Default value: '9.0.115'

Version of Flash object.

 
public OptionflvPlayer

Default value: 'player\\\\player.swf'

Determines the relative path and name of the flash vedio player.

 
public OptiongroupItems

Default value: null

Determines the array of data items.

 
public Optionheight

Default value: 400

Determines the maximum height of the content.

 
public OptionkeyNav

Default value: false

Determines whether to allow keyboard navigation.

 
public Optionloop

Default value: true

Determines whether start from the first page when reaching the end in autoplay mode.

 
public Optionmodal

Default value: false

Determines whether the window is modal.

 
public Optionplayer

Default value: ""

Determines the name of player to host the content. Possible values are: 'inline', 'iframe', 'img', 'swf', 'flv', 'wmp', 'qt', 'wijvideo'

 
public Optionposition

Determines the pop-up position of content window. Please see jquery.ui.position for possible options.

 
public OptionresizeAnimation

Determines the animation style when resizing.

 
public OptionrootUrl

Default value: ""

Determines the root url for each item.

 
public OptionshowControlsOnHover

Default value: true

Determines whether to display the control buttons only when hovering the mouse over the content.

 
public OptionshowCounter

Default value: true

Determines whether to display the counter.

 
public OptionshowMovieControls

Default value: true

Determines whether to turn on the movie controls in movie player.

 
public OptionshowNavButtons

Default value: true

Determines whether to display the navigation buttons.

 
public OptionshowTimer

Default value: false

Determines whether to display the time bar.

 
public OptionslideDirection

Default value: 'horizontal'

Determines the slide direction. Possible values are: 'horizontal', 'vertical'

 
public OptiontextHideOption

Determines the animation style when hidding the text.

 
public OptiontextPosition

Default value: 'overlay'

Determines the position of text description. Possible values are: 'inside', 'outside', 'overlay', 'titleOverlay' and 'none'

 
public OptiontextShowOption

Determines the animation style when showing the text.

 
public OptiontransAnimation

Determines the animation style when switching between pages. Possible values are 'slide', 'fade', 'none'

 
public Optionwidth

Default value: 600

Determines the maximum width of the content.

 
public OptionzIndex

Default value: 1000

Determines the z-index of popup container.

 
Top
Events
 NameDescription
public EventbeforeCloseThe showbeforeClose event handler. A function called before the popped up container is closed.  
public EventbeforeShowThe beforeShow event handler. A function called before a page's content is shown.  
public EventcloseThe close event handler. A function called after the popped up container is closed.  
public EventopenThe open event handler. A function called after the popped up container is opened.  
public EventshowThe show event handler. A function called after a page's content is shown.  
Top
See Also

Reference

wijmo.lightbox.wijlightbox Namespace

 

 


© 2013 All Rights Reserved.

Send comments on this topic.