Property Outlining

Namespace

Alternet.Editor

Assembly

Alternet.Editor.v9.dll

Outlining

Represents an object that implements IOutlining interface that specifies appearance and behaviour of outline sections within the control.

[TypeConverter(typeof(ExpandableObjectConverter))]
public virtual IOutlining Outlining { get; set; }

Property Value

IOutlining

Examples

Here is how to use a Outlining in the C# code:

public partial class Form1 : Form
{
    private void Form1_Load(object sender, EventArgs e)
    {
        var syntaxEdit1 = new Alternet.Editor.SyntaxEdit(this.components);
        syntaxEdit1.Outlining.AllowOutlining = true;
        syntaxEdit1.Outlining.OutlineOptions = OutlineOptions.DrawOnGutter | OutlineOptions.DrawLines | OutlineOptions.DrawButtons | OutlineOptions.ShowHints;
        syntaxEdit1.Lexer = new CsParser();
    }
}

Here is how to use a Outlining in the Visual Basic code:

Partial Public Class Form1
    Inherits Form

    Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
        Dim syntaxEdit1 = New Alternet.Editor.SyntaxEdit(Me.components)
        syntaxEdit1.Outlining.AllowOutlining = True
        syntaxEdit1.Outlining.OutlineOptions = OutlineOptions.DrawOnGutter Or OutlineOptions.DrawLines Or OutlineOptions.DrawButtons Or OutlineOptions.ShowHints
        syntaxEdit1.Lexer = new CsParser()
    End Sub
End Class

Remarks

Outline regions enable you to hide text from view by collapsing a code region so that it appears under a plus sign (+). You expand a collapsed region by clicking the plus\minus sign.

The AllowOutlining property determines whether outlining is enabled in the SyntaxEdit control.

Outline sections are typically provided by the SyntaxParser object.