Keyoti RapidFindReplace WPF API Docs
Highlight Class
API DocumentationKeyoti.RapidFindReplace.WPF.FindHandlers.HighlightHandlersHighlight
Keyoti RapidFindReplace WPF
Hit Highlight base class.
Declaration Syntax
C#Visual BasicVisual C++F#
public class Highlight
Public Class Highlight
public ref class Highlight
type Highlight =  class end
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
Highlight(Int32, Int32, HighlightAdorner, Run)
New instance, with Run relative to zero index (ie no other Runs in container).

Highlight(Int32, Int32, HighlightAdorner, Run, Int32)
New instance

AbsoluteEnd
The end index of the Highlight, as measured from the start of the Document.

AbsoluteStart
The start index of the Highlight, as measured from the start of the Document.

Deselect()()()()
Deselects the highlight.

End
End

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the Type of the current instance.
(Inherited from Object.)
Hidden
Whether the underline is hidden

HighlightedElement
The UIElement that this highlight is inside

IsBeforeOrAt(Highlight)
Whether this Highlight is before or at the same position of highlight.

IsReplaceable
Whether ReplaceText can be called or not. When false this is because the control where the highlight exist is readonly or disabled.

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MoveTo(Int32, Int32)
Move highlight to a different part of the current run.

MoveTo(Run, Int32, Int32)
Move the highlight to a new run.

ReplaceText(String)
Default implementation of ReplaceText, changes the hit instance in the Run to the replacement

run
The Run the Highlight is in.

Run
The Run where the highlight occurs.

runStartIndex
The absolute start of the Run where the Highlight is.

Select()()()()
Selects the highlight as the current highlight when iterating through hits, bringing the control to focus.

Start
Start

Text
The highlighted text.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Inheritance Hierarchy

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