Keyoti RapidFindReplace WPF API Docs
HighlightHandler Class
API DocumentationKeyoti.RapidFindReplace.WPF.FindHandlers.HighlightHandlersHighlightHandler
Keyoti RapidFindReplace WPF
Default highlight handler for UIElements, used unless a more suitable handler class is registered.
Declaration Syntax
C#Visual BasicVisual C++F#
public class HighlightHandler : DependencyObject
Public Class HighlightHandler
	Inherits DependencyObject
public ref class HighlightHandler : public DependencyObject
type HighlightHandler =  
    class
        inherit DependencyObject
    end
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
HighlightHandler(DependencyObject, Brush, Pen, Brush, Pen)
New instance.

AddHighlight(Run, Int32, Int32)
Overrides should call RegisterHighlight to ensure proper registration of the Highlight.

AdornerLayer
AdornerLayer hosting the highlight.

BodyHighlightAdornerBrush
Brush used for highlights.

BodyHighlightAdornerPen
Pen used to draw highlight border.

BodyIterativeHighlightAdornerBrush
Brush used for iterative highlights.

BodyIterativeHighlightAdornerPen
Pen used to draw highlight border, for iterative highlights.

CheckAccess()()()()
Determines whether the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)
ClearHighlighting()()()()
Clears all the highlighting.

ClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
ClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
CoerceValue(DependencyProperty)
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
CurrentMatch
When the user iterates over matches, this property returns the current match that is highlighted.

DependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Dispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
DoesHandle(DependencyObject)
Whether this HighlightHandler can handle the DependencyObject.

ElementToHighlight
The element to highlight.

ElementToHighlightGotFocus
Fired when the UIElement gets focus.

Equals(Object)
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
FindHighlightAt(Int32, Int32, Int32%, Boolean)
Returns a highlight at specified position.

GetHashCode()()()()
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
GetLocalValueEnumerator()()()()
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
GetValue(DependencyProperty)
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
highlightComparer
Highlight position comparer, used for binary searching.

highlights
Collection of Highlight objects being handled.

HitCount
Number of hits that this object is handling.

InvalidateProperty(DependencyProperty)
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
IsRegistered(Highlight)
Determines whether a Highlight is registered.

IsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MoveHighlight(Highlight, Int32, Int32)
Moves the underline due to user operations (typing)

NewSearchNeeded
Fired when a new search is needed, typically because an option or the text has changed.

OnNewSearchNeeded()()()()
Raises the NewSearchNeeded event.

OnNewSearchNeeded(List<(Of <<'(Run>)>>))
Raises the NewSearchNeeded event.

OnPropertyChanged(DependencyPropertyChangedEventArgs)
Invoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data.
(Inherited from DependencyObject.)
ReadLocalValue(DependencyProperty)
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
RegisterHighlight(Highlight)
Registers a Highlight

RemoveAdorner(HighlightAdorner)
Removes an adorner when it is no longer used.

RemoveHighlight(Highlight)
Removes an existing underline

RemoveHighlight(Int32, Int32)
Removes a highlight specified by it's character index.

ResetIterator()()()()
Resets the match iterator

SetCurrentValue(DependencyProperty, Object)
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
SetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
SetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
ShouldSerializeProperty(DependencyProperty)
Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.
(Inherited from DependencyObject.)
Shutdown()()()()
Shutdown the handler when no longer needed.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
track
Scrollbar track, if it exists in the UIElement that is being highlighted.

VerifyAccess()()()()
Enforces that the calling thread has access to this DispatcherObject.
(Inherited from DispatcherObject.)
Inheritance Hierarchy

Assembly: Keyoti4.RapidFindReplace.WPF (Module: Keyoti4.RapidFindReplace.WPF.dll) Version: 1.0.14.531 (1.0.14.531)