FindMyFiles.Highlighting.IHighlighter - find-my-files

A compiled query that can emphasize the slices of a displayed string it matched. Implemented by the substring/wildcard CompiledHighlighter and the whole-query RegexHighlighter; the results list and rows depend only on this seam.

public interface IHighlighter

Derived
↳ CompiledHighlighter
↳ RegexHighlighter

Properties

IHighlighter.IsEmpty Property

True when nothing will ever be highlighted — the caller can skip per-row work entirely.

bool IsEmpty { get; }

Property Value

System.Boolean

Methods

IHighlighter.Ranges(string, HighlightField) Method

The ranges of text to emphasize for field (UTF-16 units of text), sorted and merged; empty when nothing matches.

System.Collections.Generic.IReadOnlyList<FindMyFiles.Highlighting.HighlightRange> Ranges(string text, FindMyFiles.Highlighting.HighlightField field);

Parameters

text System.String

The displayed string (a name, or a full path).

field HighlightField

Which displayed string the ranges target.

Returns

System.Collections.Generic.IReadOnlyList<HighlightRange >
The sorted, merged highlight ranges; empty when nothing matches.

find-my-files — C# API

FindMyFiles