Class Tooltip

Namespace

The.Web.Controls

Assembly

Instagile.Web.Client.dll

public class Tooltip : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IAsyncDisposable

Inheritance

object

ComponentBase

Tooltip

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IAsyncDisposable

Inherited Members

ComponentBase.OnInitialized()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.SetParametersAsync(ParameterView)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ChildContent

[Parameter]
public RenderFragment? ChildContent { get; set; }

Property Value

RenderFragment

Delay

[Parameter]
public TimeSpan? Delay { get; set; }

Property Value

TimeSpan?

Enabled

[Parameter]
public bool Enabled { get; set; }

Property Value

bool

Interactive

[Parameter]
public bool Interactive { get; set; }

Property Value

bool

MaxWidth

[Parameter]
public int? MaxWidth { get; set; }

Property Value

int?

OnTrigger

[Parameter]
public EventCallback OnTrigger { get; set; }

Property Value

EventCallback

Placement

[Parameter]
public TooltipPlacement Placement { get; set; }

Property Value

TooltipPlacement

ShowOnCreate

[Parameter]
public bool ShowOnCreate { get; set; }

Property Value

bool

Splat

[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object>? Splat { get; set; }

Property Value

Dictionary<string, object>

TooltipContent

[Parameter]
public RenderFragment? TooltipContent { get; set; }

Property Value

RenderFragment

TooltipText

[Parameter]
public string TooltipText { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Renders the component to the supplied RenderTreeBuilder.

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

DisposeAsync()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

public ValueTask DisposeAsync()

Returns

ValueTask

A task that represents the asynchronous dispose operation.

OnAfterRenderAsync(bool)

Method invoked after each time the component has been rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs.

This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated.

Note that the component does not automatically re-render after the completion of any returned Task, because that would cause an infinite render loop.

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Set to true if this is the first time OnAfterRender(bool) has been invoked on this component instance; otherwise false.

Returns

Task

A Task representing any asynchronous operation.

Remarks

The OnAfterRender(bool) and OnAfterRenderAsync(bool) lifecycle methods are useful for performing interop, or interacting with values received from @ref. Use the firstRender parameter to ensure that initialization work is only performed once.

OnTriggerAsync()

[JSInvokable("The.Controls")]
public Task OnTriggerAsync()

Returns

Task