Docsv2.2.5
Back to API Reference
Class

TextHighlighter

abstract

Base class for text highlighting and selection visualization.

Remarks

Inherit from this class to create custom highlight effects for interactive ranges, text selection, or any other visual feedback. Assign to Highlighter to enable highlighting. The two CreateHighlightRenderer overloads (one per backend) are dispatched type-safely from the owner's actual type — subclass to plug a custom visual on either or both backends without runtime cast risk. Set to null to disable.
public virtual void Initialize()

Initializes the handler with its owner.

protected abstract TextHighlightRenderer CreateHighlightRenderer(UniText owner, string name, HighlightOrder order)

Creates a Canvas-side TextHighlightRenderer for the given UniText owner. Override to plug a custom Canvas visual.

protected abstract TextHighlightRenderer CreateHighlightRenderer(UniTextWorld owner, string name, HighlightOrder order)

Creates a world-space TextHighlightRenderer for the given UniTextWorld owner. Override to plug a custom mesh-based visual.

protected TextHighlightRenderer CreateHighlightRenderer(string name, HighlightOrder order)

Creates a backend-appropriate TextHighlightRenderer for the current owner, dispatching to the correct typed overload above. Call this from event handlers when a renderer is actually needed.

public virtual void OnRangeClicked(InteractiveRange range, List<Rect> bounds)

Called when an interactive range is clicked.

public virtual void OnRangeEntered(InteractiveRange range, List<Rect> bounds)

Called when pointer enters an interactive range (desktop only).

public virtual void OnRangeExited(InteractiveRange range)

Called when pointer exits an interactive range (desktop only).

public virtual void OnSelectionChanged(int startCluster, int endCluster, List<Rect> bounds)

Called when text selection changes (for InputField).

public virtual void Update()

Called every frame for animation updates.

public virtual void Destroy()

Cleans up resources when the handler is removed or UniText is destroyed.

protected UniTextBase owner
protected bool isInitialized
Back to API Reference