Class
TelerikCarousel<TItem>

The class for the TelerikCarousel component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

cs-api-definition
public class TelerikCarousel<TItem> : DataBoundComponent<TItem>, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDataBoundComponent<TItem>TelerikCarousel<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataBoundComponent<TItem>.Dispose()DataBoundComponent<TItem>.Rebind()DataBoundComponent<TItem>.DataBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.OnAfterRenderAsync(bool)BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikCarousel()

Declaration

cs-api-definition
public TelerikCarousel()

Properties

Arrows

Defines whether the arrows should be visible. Default value is true.

Declaration

cs-api-definition
[Parameter]
public bool Arrows { get; set; }

Property Value

bool

AutomaticPageChange

Defines whether automatic page change should be enabled. Default value is true.

Declaration

cs-api-definition
[Parameter]
public bool AutomaticPageChange { get; set; }

Property Value

bool

AutomaticPageChangeInterval

Defines the interval between automatic page changes. Default value is 5000.

Declaration

cs-api-definition
[Parameter]
public int AutomaticPageChangeInterval { get; set; }

Property Value

int

Height

Defines the height of the component.

Declaration

cs-api-definition
[Parameter]
public string Height { get; set; }

Property Value

string

HeightStyle

Declaration

cs-api-definition
public string HeightStyle { get; }

Property Value

string

LoopPages

Defines whether looping pages should be enabled. Default value is true.

Declaration

cs-api-definition
[Parameter]
public bool LoopPages { get; set; }

Property Value

bool

Page

Defines the current page of the Carousel. Default value is 1.

Declaration

cs-api-definition
[Parameter]
public int Page { get; set; }

Property Value

int

PageChanged

Triggers when the page has changed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<int> PageChanged { get; set; }

Property Value

EventCallback<int>

Pageable

Defines whether the pager should be visible. Default value is true.

Declaration

cs-api-definition
[Parameter]
public bool Pageable { get; set; }

Property Value

bool

StyleToRender

Declaration

cs-api-definition
public string StyleToRender { get; }

Property Value

string

Template

Defines the default template of the Carousel.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<TItem> Template { get; set; }

Property Value

RenderFragment<TItem>

ThemeColor

Defines the pager overlay. Default value is Light.

Declaration

cs-api-definition
[Parameter]
public string ThemeColor { get; set; }

Property Value

string

ThemeColorClass

Declaration

cs-api-definition
public string ThemeColorClass { get; }

Property Value

string

Width

Defines the width of the component.

Declaration

cs-api-definition
[Parameter]
public string Width { get; set; }

Property Value

string

WidthStyle

Declaration

cs-api-definition
public string WidthStyle { get; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRender(bool)

Declaration

cs-api-definition
protected override void OnAfterRender(bool firstRender)

Parameters

firstRender

bool

Overrides ComponentBase.OnAfterRender(bool)

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides DataBoundComponent<TItem>.OnParametersSetAsync()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition
public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides DataBoundComponent<TItem>.SetParametersAsync(ParameterView)