GalleryBuilder Methods
A Gallery control.| Name | Description |
|---|---|
| AccessKey(JS) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| AccessKey(String) | Specifies the shortcut key that sets focus on the UI component. Mirrors the client-side accessKey option. |
| AnimationDuration(JS) | The time, in milliseconds, spent on slide animation. Mirrors the client-side animationDuration option. |
| AnimationDuration(Double) | The time, in milliseconds, spent on slide animation. Mirrors the client-side animationDuration option. |
| AnimationEnabled(JS) | Specifies whether or not to animate the displayed item change. Mirrors the client-side animationEnabled option. |
| AnimationEnabled(Boolean) | Specifies whether or not to animate the displayed item change. Mirrors the client-side animationEnabled option. |
| DataSource(JS) | Mirrors the client-side dataSource option. |
| DataSource(IEnumerable, String[]) |
Binds a Gallery control to a collection: Array, List, or IEnumerable.
|
| DataSource(Func<DataSourceFactory, OptionsOwnerBuilder>) | Binds a Gallery control to data, allows you to configure data access from different sources: API controllers, Razor page handlers, OData services, arrays, and more. |
| DataSource(String, String[]) | Binds a Gallery control to read-only data in JSON format. |
| DataSourceOptions(Action<DataSourceOptionsBuilder>) | Provides access to methods that mirror client-side data source options. |
| Disabled(JS) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| Disabled(Boolean) | Specifies whether the UI component responds to user interaction. Mirrors the client-side disabled option. |
| ElementAttr(JS) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Dictionary<String, Object>) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| ElementAttr(String, Object) | Mirrors the client-side elementAttr option, specifies attributes for the control’s root HTML element. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| FocusStateEnabled(JS) | Mirrors the client-side focusStateEnabled option. |
| FocusStateEnabled(Boolean) | Mirrors the client-side focusStateEnabled option. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| Height(JS) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(Double) | Specifies the UI component's height. Mirrors the client-side height option. |
| Height(String) | Specifies the UI component's height. Mirrors the client-side height option. |
| Hint(JS) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| Hint(String) | Specifies text for a hint that appears when a user pauses on the UI component. Mirrors the client-side hint option. |
| HoverStateEnabled(JS) | Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option. |
| HoverStateEnabled(Boolean) | Specifies whether the UI component changes its state when a user pauses on it. Mirrors the client-side hoverStateEnabled option. |
| ID(JS) |
Specifies the id attribute for the control’s HTML element (used for nested controls within templates).
|
| ID(String) |
Specifies the id attribute for the control’s HTML element.
|
| IndicatorEnabled(JS) | A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. Mirrors the client-side indicatorEnabled option. |
| IndicatorEnabled(Boolean) | A Boolean value specifying whether or not to allow users to switch between items by clicking an indicator. Mirrors the client-side indicatorEnabled option. |
| InitialItemWidth(JS) | Specifies the width of an area used to display a single image. Mirrors the client-side initialItemWidth option. |
| InitialItemWidth(Double) | Specifies the width of an area used to display a single image. Mirrors the client-side initialItemWidth option. |
| ItemHoldTimeout(JS) | The time period in milliseconds before the onItemHold event is raised. Mirrors the client-side itemHoldTimeout option. |
| ItemHoldTimeout(Double) | The time period in milliseconds before the onItemHold event is raised. Mirrors the client-side itemHoldTimeout option. |
| Items(Action<CollectionFactory<GalleryItemBuilder>>) | Provides access to the client-side items option that represents a Gallery item collection. |
| Items(IEnumerable<String>) | Mirrors the client-side items option. |
| ItemTemplate(JS) | Specifies the client-side itemTemplate. |
| ItemTemplate(RazorBlock) | Specifies the client-side itemTemplate. |
| ItemTemplate(TemplateName) | Specifies the client-side itemTemplate. |
| ItemTemplate(String) | Specifies the client-side itemTemplate. |
| Loop(JS) | A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. Mirrors the client-side loop option. |
| Loop(Boolean) | A Boolean value specifying whether or not to scroll back to the first item after the last item is swiped. Mirrors the client-side loop option. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| NoDataText(JS) | Mirrors the client-side noDataText option. |
| NoDataText(String) | Mirrors the client-side noDataText option. |
| OnContentReady(RazorBlock) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnContentReady(String) | A function that is executed when the UI component is rendered and each time the component is repainted. Mirrors the client-side onContentReady option. |
| OnDisposing(RazorBlock) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnDisposing(String) | A function that is executed before the UI component is disposed of. Mirrors the client-side onDisposing option. |
| OnInitialized(RazorBlock) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnInitialized(String) | A function used in JavaScript frameworks to save the UI component instance. Mirrors the client-side onInitialized option. |
| OnItemClick(RazorBlock) | A function that is executed when a collection item is clicked or tapped. Mirrors the client-side onItemClick option. |
| OnItemClick(String) | A function that is executed when a collection item is clicked or tapped. Mirrors the client-side onItemClick option. |
| OnItemContextMenu(RazorBlock) | A function that is executed when a collection item is right-clicked or pressed. Mirrors the client-side onItemContextMenu option. |
| OnItemContextMenu(String) | A function that is executed when a collection item is right-clicked or pressed. Mirrors the client-side onItemContextMenu option. |
| OnItemHold(RazorBlock) | A function that is executed when a collection item has been held for a specified period. Mirrors the client-side onItemHold option. |
| OnItemHold(String) | A function that is executed when a collection item has been held for a specified period. Mirrors the client-side onItemHold option. |
| OnItemRendered(RazorBlock) | A function that is executed after a collection item is rendered. Mirrors the client-side onItemRendered option. |
| OnItemRendered(String) | A function that is executed after a collection item is rendered. Mirrors the client-side onItemRendered option. |
| OnOptionChanged(RazorBlock) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnOptionChanged(String) | A function that is executed after a UI component property is changed. Mirrors the client-side onOptionChanged option. |
| OnSelectionChanged(RazorBlock) | A function that is executed when a collection item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option. |
| OnSelectionChanged(String) | A function that is executed when a collection item is selected or selection is canceled. Mirrors the client-side onSelectionChanged option. |
| Option(String, Object) | Specifies an option by its name. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| Render() | Inherited from WidgetBuilder. |
| RtlEnabled(JS) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| RtlEnabled(Boolean) | Switches the UI component to a right-to-left representation. Mirrors the client-side rtlEnabled option. |
| SelectedIndex(JS) | The index of the currently active gallery item. Mirrors the client-side selectedIndex option. |
| SelectedIndex(Int32) | The index of the currently active gallery item. Mirrors the client-side selectedIndex option. |
| SelectedItem(Object) | The selected item object. Mirrors the client-side selectedItem option. |
| ShowIndicator(JS) | A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. Mirrors the client-side showIndicator option. |
| ShowIndicator(Boolean) | A Boolean value specifying whether or not to display an indicator that points to the selected gallery item. Mirrors the client-side showIndicator option. |
| ShowNavButtons(JS) | A Boolean value that specifies the availability of the 'Forward' and 'Back' navigation buttons. Mirrors the client-side showNavButtons option. |
| ShowNavButtons(Boolean) | A Boolean value that specifies the availability of the 'Forward' and 'Back' navigation buttons. Mirrors the client-side showNavButtons option. |
| SlideshowDelay(JS) | The time interval in milliseconds, after which the gallery switches to the next item. Mirrors the client-side slideshowDelay option. |
| SlideshowDelay(Double) | The time interval in milliseconds, after which the gallery switches to the next item. Mirrors the client-side slideshowDelay option. |
| StretchImages(JS) | Specifies if the UI component stretches images to fit the total gallery width. Mirrors the client-side stretchImages option. |
| StretchImages(Boolean) | Specifies if the UI component stretches images to fit the total gallery width. Mirrors the client-side stretchImages option. |
| SwipeEnabled(JS) | A Boolean value specifying whether or not to allow users to switch between items by swiping. Mirrors the client-side swipeEnabled option. |
| SwipeEnabled(Boolean) | A Boolean value specifying whether or not to allow users to switch between items by swiping. Mirrors the client-side swipeEnabled option. |
| TabIndex(JS) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| TabIndex(Int32) | Specifies the number of the element when the Tab key is used for navigating. Mirrors the client-side tabIndex option. |
| ToString() | Inherited from WidgetBuilder. |
| ToTemplate() | Renders the control as a template string for use in another control’s template. Inherited from WidgetBuilder. |
| Visible(JS) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Visible(Boolean) | Specifies whether the UI component is visible. Mirrors the client-side visible option. |
| Width(JS) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(Double) | Specifies the UI component's width. Mirrors the client-side width option. |
| Width(String) | Specifies the UI component's width. Mirrors the client-side width option. |
| WrapAround(JS) | Specifies whether or not to display parts of previous and next images along the sides of the current image. Mirrors the client-side wrapAround option. |
| WrapAround(Boolean) | Specifies whether or not to display parts of previous and next images along the sides of the current image. Mirrors the client-side wrapAround option. |
See Also