Collapse All Expand All Code: All Code: Multiple Code: C# Code: Visual Basic

C#
Visual Basic

Azuki 1.7 Documentation
HighlightHook Delegate
See Also Send Feedback

The type of the hook to override default procedure to highlight a token.

Namespace: Sgry.Azuki.Highlighter
Assembly: Azuki (in Azuki.dll) Version: 1.7.13.40248

# Syntax

C#
    public delegate bool HighlightHook(
    	Document doc,
    	string token,
    	int index,
    	CharClass klass
    )

Visual Basic
    Public Delegate Function HighlightHook (
    	doc As Document,
    	token As String,
    	index As Integer,
    	klass As CharClass
    ) As Boolean

#### Parameters

doc
  Type: Sgry.Azuki..::..Document
  The document to be highlighted.

token
  Type: System..::..String
  The substring to be highlighted.

index
  Type: System..::..Int32
  The index of where the token is at.

klass
  Type: Sgry.Azuki..::..CharClass
  The character class which the token is to be classified as, by the highlighter.

#### Return Value

Type: Boolean
Return true if default behavior of the highlighter should be suppressed, otherwise return false.

# Remarks

Please refer to the document of IHighlighter.HookProc property about hook mechanism.

# See Also

Sgry.Azuki.Highlighter Namespace
IHighlighter.HookProc property