Class
TelerikPopover

Represents the Telerik UI Popover component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class TelerikPopover : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikPopover

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()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.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikPopover()

Declaration

cs-api-definition
public TelerikPopover()

Properties

ActionsLayout

Defines the layout of the actions button in the footer. Default value is Stretch. The possible options are Stretch, Start, End, Center.

Declaration

cs-api-definition
[Parameter]
public PopoverActionsLayoutAlign ActionsLayout { get; set; }

Property Value

PopoverActionsLayoutAlign

AnchorSelector

Specifies the selector of the element that will be used as an anchor. The popover will open next to that element.

Declaration

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

Property Value

string

AnimationDuration

The duration of the open/close animation in milliseconds.

Declaration

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

Property Value

int

AnimationType

The effect to use for playing the open/close animation.

Declaration

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

Property Value

AnimationType

Collision

Specifies the behavior of the Popover when it does not fit in the viewport. Valid values are: Flip - the popover will flip if there is sufficient available space on the opposite side. Fit - the popover will be shifted (moved) until it is fully visible. By default, the Popover flips vertically when there is a collision.

Declaration

cs-api-definition
[Parameter]
public PopoverCollision Collision { get; set; }

Property Value

PopoverCollision

Height

The height of the popover.

Declaration

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

Property Value

string

Offset

Specifies the offset value, in pixels, to be added to the popover position, creating a blank space between the popover and the anchor.

Declaration

cs-api-definition
[Parameter]
public double Offset { get; set; }

Property Value

double

PopoverActions

Container tag for the popover action buttons.

Declaration

cs-api-definition
[Parameter]
public RenderFragment PopoverActions { get; set; }

Property Value

RenderFragment

PopoverContent

The body content of the popover.

Declaration

cs-api-definition
[Parameter]
public RenderFragment PopoverContent { get; set; }

Property Value

RenderFragment

PopoverHeader

The header content of the popover.

Declaration

cs-api-definition
[Parameter]
public RenderFragment PopoverHeader { get; set; }

Property Value

RenderFragment

Position

The position that is relative to the target element at which the Popover will be shown. The supported values are: TopBottomLeftRight The default value is Top.

Declaration

cs-api-definition
[Parameter]
public PopoverPosition Position { get; set; }

Property Value

PopoverPosition

ShowCallout

Defines whether the Popover callout will be displayed.

Declaration

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

Property Value

bool

ShowOn

Define the event that triggers the opening of the popover. The supported values are: ClickMouseEnter If the value is set to Click the popover will close when the user clicks outside the popover. If the value is set to MouseEnter the popover will close when the pointer leaves the popover.

Declaration

cs-api-definition
[Parameter]
public PopoverShowOn? ShowOn { get; set; }

Property Value

PopoverShowOn?

Width

The widht of the popover.

Declaration

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

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

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

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Declaration

cs-api-definition
public override void Dispose()

Overrides BaseComponent.Dispose()

Hide()

Closes the popup.

Declaration

cs-api-definition
public void Hide()

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

Refresh()

Refreshes the popup element and its position.

Declaration

cs-api-definition
public void Refresh()

SetParametersAsync(ParameterView)

Declaration

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

Parameters

parameters

ParameterView

Returns

Task

Overrides ComponentBase.SetParametersAsync(ParameterView)

Show()

Opens the popup.

Declaration

cs-api-definition
public void Show()