Class MudHighlighter

Namespace

MudBlazor

Assembly

MudBlazor.dll

A component which highlights words or phrases within text.

public class MudHighlighter : MudComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMudStateHasChanged

Inheritance

object

ComponentBase

ComponentBaseWithState

MudComponentBase

MudHighlighter

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMudStateHasChanged

Inherited Members

MudComponentBase.OnAfterRender(bool)

MudComponentBase.Logger

MudComponentBase.Class

MudComponentBase.Style

MudComponentBase.Tag

MudComponentBase.UserAttributes

MudComponentBase.IsJSRuntimeAvailable

MudComponentBase.FieldId

ComponentBaseWithState.OnInitialized()

ComponentBaseWithState.SetParametersAsync(ParameterView)

ComponentBaseWithState.CreateRegisterScope()

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRenderAsync(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

EventUtil.AsNonRenderingEventHandler(ComponentBase, Action)

EventUtil.AsNonRenderingEventHandler(ComponentBase, Func<Task>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Action<TValue>)

EventUtil.AsNonRenderingEventHandler<TValue>(ComponentBase, Func<TValue, Task>)

ComponentBaseWithStateExtensions.GetState<T>(ComponentBaseWithState, string)

ComponentBaseWithStateExtensions.GetState<TComponent, T>(TComponent, Func<TComponent, T>, string?)

ObjectExtensions.As<T>(object?)

Constructors

MudHighlighter()

public MudHighlighter()

Properties

CaseSensitive

Whether highlighted text is case sensitive.

[Parameter]
[Category("Behavior")]
public bool CaseSensitive { get; set; }

Property Value

bool

Remarks

Defaults to false.

HighlightedText

The text to highlight within Text.

[Parameter]
[Category("Behavior")]
public string? HighlightedText { get; set; }

Property Value

string

HighlightedTexts

The multiple text fragments to highlight within Text.

[Parameter]
[Category("Behavior")]
public IEnumerable<string> HighlightedTexts { get; set; }

Property Value

IEnumerable<string>

Markup

Renders text as a RenderFragment.

[Parameter]
[Category("Appearance")]
public bool Markup { get; set; }

Property Value

bool

Remarks

Defaults to false.

Text

The text to consider for highlighting.

[Parameter]
[Category("Behavior")]
public string? Text { get; set; }

Property Value

string

UntilNextBoundary

Highlights text until the next RegEx boundary.

[Parameter]
[Category("Behavior")]
public bool UntilNextBoundary { get; set; }

Property Value

bool

Remarks

Defaults to false.

Methods

BuildRenderTree(RenderTreeBuilder)

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

OnParametersSet()

protected override void OnParametersSet()