Class PdfViewerTextSearchColorSettings

Represents the text search color settings for the PDF Viewer component.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
PdfViewerTextSearchColorSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.SfPdfViewer
Assembly: Syncfusion.Blazor.SfPdfViewer.dll
Syntax
public class PdfViewerTextSearchColorSettings : SfBaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Remarks

This class allows configuring the colors used for highlighting search results and other occurrences in the PDF Viewer.

Examples

Below is an example of how to configure PdfViewerTextSearchColorSettings in a Blazor component:

Constructors

PdfViewerTextSearchColorSettings()

Declaration
public PdfViewerTextSearchColorSettings()

Properties

ChildContent

Gets or sets the child content to be rendered inside the text search color settings component.

Declaration
[Parameter]
[JsonIgnore]
public RenderFragment ChildContent { get; set; }
Property Value
Type
RenderFragment

SearchColor

Gets or Sets the color of the other occurrence of the text searched string.By default it is '#8b4c12'

Declaration
[Parameter]
[JsonPropertyName("searchColor")]
public string SearchColor { get; set; }
Property Value
Type
string

SearchHighlightColor

Gets or Sets the color of the current occurrence of the text searched string.By default it is '#fdd835'

Declaration
[Parameter]
[JsonPropertyName("searchHighlightColor")]
public string SearchHighlightColor { get; set; }
Property Value
Type
string

jsProperty

The JS interop property name used internally.

Declaration
protected string jsProperty { get; set; }
Property Value
Type
string

mainParent

Reference to the parent base component in the hierarchy.

Declaration
protected SfBaseComponent mainParent { get; set; }
Property Value
Type
SfBaseComponent

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

OnInitializedAsync()

Performs asynchronous initialization for the component, registers it with the parent viewer, and initializes backing fields from current parameter values.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

A task that represents the asynchronous initialization operation.
Overrides

OnParametersSetAsync()

Applies parameter changes and updates child properties when needed. Synchronizes backing fields and notifies property changes.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
Task

A task that represents the asynchronous parameter-set operation.
Overrides

Implements