ClassPdfViewerSearchPanel
Definition
Namespace:Telerik.Blazor.Components.PdfViewer.Search
Assembly:Telerik.Blazor.dll
Syntax:
public class PdfViewerSearchPanel : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentPdfViewerSearchPanel
Implements:
Inherited Members
Constructors
PdfViewerSearchPanel()
Declaration
public PdfViewerSearchPanel()
Properties
ActiveMatchIndex
Gets or sets the index of the currently active search match, with -1 indicating no active match. Used internally by the PDF Viewer to track and highlight the current search result position. Enables navigation between search results using next/previous controls. Updates when users navigate through search results or when new searches are performed.
Declaration
[Parameter]
public int ActiveMatchIndex { get; set; }
Property Value
DebounceDelay
Controls the delay between user typing and search execution to improve performance during fast typing. Use lower values like 100ms for immediate search or higher values like 500ms to reduce search frequency. Default is 300ms, providing a balance between responsiveness and performance. Helps prevent excessive search operations while users are still typing their search terms.
MatchesCount
Gets or sets the total number of search matches found in the current document. Used internally by the PDF Viewer to display match count information and enable navigation controls. Updates automatically when search terms change or when the document content is modified. Provides users with context about search result quantity for better navigation experience.
OnCommandExecute
Handles command execution for search panel operations like initiating searches, navigating results, and clearing search terms. Use this to respond to user search interactions and implement custom search behaviors or result processing. Commands include search execution, match navigation, case-sensitive toggling, and search panel visibility control. Essential for integrating search functionality with application logic and tracking user search patterns.
Placeholder
Sets the placeholder text displayed in the search input field when empty. Use descriptive text like "Search document..." or "Find text" to guide users. Default shows a localized search placeholder based on the current culture. Helps users understand the search functionality and encourages interaction.
Declaration
[Parameter]
public string Placeholder { get; set; }
Property Value
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
Dispose()
Declaration
public override void Dispose()
Overrides