Manager of marking information which is to indicate attributes apart from syntax or grammar.

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

Syntax

C#
public static class Marking
Visual Basic
Public NotInheritable Class Marking

Remarks

The 'marking' feature is provided for putting additional (meta) information on text ranges which is not related to syntax or grammar of document type such as XML file or C/C++ source file. One of the typical usages is to mark (put meta information on) misspelled words as 'this word seems to be misspelled.' Another typical usage is to mark words at where compile error was detected as 'compile error has been occurred here.'

Multiple markings can be put on any text part independently. To mark up text parts or remove already marked IDs from text parts, use Document.Mark method and Document.Unmark method. Once a text part was marked, it will graphically be decorated as specified by ColorScheme class. To get or set how marked text will be decorated, use methods next.

Internally, marking IDs set for each character are stored as bit mask (currently 32-bit). Although all operations can be done without minding it, in some cases, using internal bit mask directly is more efficient than using array of IDs. To handle bit mask directly, use Document.GetMarkingBitMaskAt method and ColorScheme.GetMarkingDecorations(uint) method.

Note that marking ID '31' is used by built-in URI marker to mark URIs. Although the meaning of ID 31 can be overwritten with Register method, doing so is discouraged unless the programmer wants to create and use URI marker by his/her own.

Inheritance Hierarchy

System..::..Object
  Sgry.Azuki..::..Marking

See Also