Scintilla.NET

To find all text ranges tagged with a specific indicator, use Indicator.Start(position) and Indicator.End(position).

Important Logic Note: These methods can be counter-intuitive. Depending on whether the starting position is currently tagged with the indicator, they might return the start/end of a filled range or the start/end of an empty range.

To reliably iterate only through filled ranges, combine these methods with Scintilla.IndicatorAllOnFor(position). This method returns a bitmap where each bit corresponds to an indicator index. You can check if a specific indicator is present by performing a bitwise AND with a flag created via (1 << indicator.Index).

var textLength = scintilla.TextLength;
var indicator = scintilla.Indicators[8];
var bitmapFlag = (1 << indicator.Index);

var startPos = 0;
var endPos = 0;

do
{
    startPos = indicator.Start(endPos);
    endPos = indicator.End(startPos);

    // Check if the range is actually filled with our specific indicator
    var bitmap = scintilla.IndicatorAllOnFor(startPos);
    var filled = ((bitmapFlag & bitmap) == bitmapFlag);
    
    if (filled)
    {
        // Process the range
        Debug.WriteLine(scintilla.GetTextRange(startPos, (endPos - startPos)));
    }

} while (endPos != 0 && endPos < textLength);

Scintilla.NET aims to remain consistent with the native Scintilla API to ensure native documentation remains relevant. It follows these mapping conventions:

• Properties: Calls with both a 'get' and 'set' (e.g., SCI_GETTEXT and SCI_SETTEXT) are mapped to .NET properties (e.g., Text).
• Indexers: Calls requiring a numeric argument to access an item (e.g., SCI_INDICSETFORE(indicatorNumber, ...)) are accessed via indexers (e.g., Indicators[0].ForeColor).
• Line Management: Lines are not treated as a standard .NET collection. There are no Add, Insert, or Remove methods for lines specifically. Instead, line modifications are handled as text changes.
• Value Clamping: Following native Scintilla behavior, many methods clamp input values to valid ranges instead of throwing exceptions. For example, GotoPosition(position) will clamp position to 0 or TextLength if the provided value is out of bounds.

Indicators are used to overlay information (like syntax errors or warnings) on top of text styling using underlines or boxes.

Configuration

Indicators are managed via the Scintilla.Indicators collection, which supports up to 32 definitions (indexes 0-31). Warning: Indexes 0-7 are often reserved for lexers. It is best to use indexes 8-31 unless you are certain your lexer does not require the lower range.

Common Indicator properties:

• Style: Defines the appearance (e.g., IndicatorStyle.Squiggle).
• ForeColor: The color of the indicator.
• Alpha / OutlineAlpha: Transparency for box-style indicators.
• Under: Determines if the indicator is drawn over or under the text.
• HoverForeColor: Color used when the caret is in range or the mouse is over the text. (Note: Cannot be used simultaneously with HoverStyle).
• HoverStyle: A style definition index from Scintilla.Styles used during hover. (Note: Cannot be used simultaneously with HoverForeColor).

Application Workflow

1. Define the indicator properties in Scintilla.Indicators[index].
2. Set Scintilla.IndicatorCurrent to that index.
3. Call Scintilla.IndicatorFillRange(start, length) to apply it to specific text ranges.
4. Use Scintilla.IndicatorClearRange(start, length) to remove it.

// Define an indicator
scintilla.Indicators[8].Style = IndicatorStyle.Squiggle;
scintilla.Indicators[8].ForeColor = Color.Red;

// Get ready for fill
scintilla.IndicatorCurrent = 8;

// Fill ranges
scintilla.IndicatorFillRange(2, 5);
scintilla.IndicatorFillRange(25, 33);