New to Telerik UI for ASP.NET AJAXStart a free 30-day trial

Server-side Programming Overview

RadLightBox Properties

RadLightBox for ASP.NET AJAX offers the following properties:

PropertiesDescription
AppendDataBoundItemsAllows you to append a data bound items to a currently set static collection of items.
AccessKeyAllows you to quickly navigate to the LightBox control.
ModalAllows you to use a modality.
CurrentItemIndexAllows you to specify an index of an item which will be displayed when LightBox is opened.
ShowCloseButtonDetermines whether the close button will be displayed in the LightBox
ShowNextButtonDetermines whether the next button will be displayed in the LightBox
ShowPrevButtonDetermines whether the previous button will be displayed in the LightBox
ShowLoadingPanelDetermines whether the LoadingPanel will be displayed when navigating between the page/image
ShowRestoreButtonDetermines whether the restore button will be displayed in the LightBox
ShowMaximizeButtonDetermines whether the maximize button will be displayed in the LightBox
DataDescriptionFieldDetermines the description field when server data binding is used
DataImageUrlFieldDetermines the image URL field when server data binding is used
DataImageUrlFormatStringYou can combine the image URL fields by specifying a format string as the value of the this property.
DataNavigateUrlFieldDetermines the navigation URL field when server data binding is used
DataTitleFieldDetermines the image title field when server data binding is used
DataSourceIDDetermines the id of the data source
DescriptionPositionSpecify the position of the description and the title.
EnableGlowEffectWhen this property is enabled it adds an outer transparent border around the control.
ODataDataSourceIDDetermines the id of the ODataDataSource
ItemsCounterFormatStringYou could use this property to set a custom format of the items counter. It is mandatory to use one of the both placeholders -{0} for current item or {1} for the total number of items.
WidthDetermines the horizontal size of the LightBox
HeightDetermines the vertical size of the LightBox
ZIndexDetermines the Z-Index of the LightBox
PreserveCurrentItemTemplatesDetermines whether the template should be disposed after closing the LightBox or after navigating to another item. See the Templates article for more details.
ClientSettings-AllowKeyboardNavigationAllows to use a keyboard to navigate within RadLightBox
ClientSettings-AutoResizeAllows you to automatically resize the image in RadLightBox control based on the dimension of the viewport.
ClientSettings-ContentResizeModeThis property has to options: Fill and Fit . When the first one is setthat means the displayed image will fill the whole viewport, while the second one will proportionally resize the image in order to fit the container.
ClientSettings-NavigationModeAllows you to switch between two type of navigation - Button and Zone. Zone navigation mode allows you to navigatebetween the images by clicking on the left or right area of the RadLightBox, while the Button navigation is performing only byclicking on the arrow buttons.
ClientSettings-PreventOverlayCloseDetermines whether the overlay (modality) should close after you click outside the LightBox container. Applicable only with enabled Modal property.
ClientSettings-ShowItemsCounterDetermines whether the item counter will be displayed in the LightBox
ClientSettings-AnimationSettingsProperty group for the animation settings
ClientSettings-AnimationSettings-ShowAnimationAllows you to choose the type of animation that will be displayed during showing RadLigthBox
ClientSettings-AnimationSettings-HideAnimationAllows you to choose the type of animation that will be displayed during hiding RadLigthBox
ClientSettings-AnimationSettings-PrevAnimationAllows you to choose the type of animation that will be displayed during navigating to the previous item
ClientSettings-AnimationSettings-NextAnimationAllows you to choose the type of animation that will be displayed during navigating to the next item
ClientSettings-AnimationSettings-HideAnimationSettingsEasing - Gets or sets the easing function. Speed - Gets or sets the period of time(in miliseconds) in which the animation will be performed.
ClientSettings-AnimationSettings-NextAnimationSettingsEasing - Gets or sets the easing function. Speed - Gets or sets the period of time(in miliseconds) in which the animation will be performed.
ClientSettings-AnimationSettings-PrevAnimationSettingsEasing - Gets or sets the easing function. Speed - Gets or sets the period of time(in miliseconds) in which the animation will be performed.
ClientSettings-AnimationSettings-ShowAnimationSettingsEasing - Gets or sets the easing function. Speed - Gets or sets the period of time(in miliseconds) in which the animation will be performed.
ClientSettings-FullscreenMode-EmulationThis mode is an emulation of fullscreen and it's the default value.
ClientSettings-FullscreenMode-NativeThis mode uses the HTML 5 fullscreen capability.
ItemsStatic collection containing a list of images
Items-TitleThe title text of the item
Items-DescriptionThe image description of the item
Items-ImageUrlThe image URL of the item
Items-NavigateUrlGet/set the URL when using the iframe mode
Items-TargetControlIDSpecifies the control which triggers the RadLightBox
Items-WidthThe width of the item
Items-HeightThe height of the item
In this article
RadLightBox Properties
Not finding the help you need?
Contact Support