Table of Contents

Class XmlParser

Namespace
Alternet.Syntax.Parsers.Lsp.Xml
Assembly
Alternet.Syntax.Parsers.Xml.v9.dll

Represents a class that performs syntax and lexical analysis of specified Xml code text.

[ToolboxBitmap(typeof(XmlParser), "Images.XmlParser.Icon.bmp")]
public class XmlParser : LspParser, IComponent, IDisposable, ISyntaxParser, IParser, ILexer, INotify, IUpdate, IImport, ILspDocumentProvider
Inheritance
XmlParser
Implements
Derived

Examples

Here is how to declare a XmlParser and assign it to the edit control from the C# code:

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();
    }

    private void Form1_Load(object sender, EventArgs e)
    {
        var parser = new Alternet.Syntax.Parsers.Lsp.Xml.XmlParser();
        var edit = new Alternet.Editor.SyntaxEdit();
        edit.Parent = this;
        edit.Lexer = parser;

        string fileName = "myfile.xml";
        if (System.IO.File.Exists(fileName))
        {
            parser.FileName = fileName;
            edit.LoadFile(fileName);
        }
    }
}

Here is how to declare a XmlParser and assign it to the edit control from the Visual Basic code:

Partial Public Class Form1
    Inherits Form

    Public Sub New()
        InitializeComponent()
    End Sub

    Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
        Dim parser = New Alternet.Syntax.Parsers.Lsp.Xml.XmlParser()
        Dim edit = New Alternet.Editor.SyntaxEdit()
        edit.Parent = Me
        edit.Lexer = parser
        Dim fileName As String = "myfile.xml"

        If System.IO.File.Exists(fileName) Then
            parser.FileName = fileName
            edit.LoadFile(fileName)
        End If
    End Sub
End Class

Remarks

XmlParser is a non-visual component designed to perform syntax highlighting for XML language.� This LangServer-based parser relies on the XML Language Server to provide features like full syntax and analysis of the XML code. When linked to the SyntaxEdit or TextEditor controls, this parser drives additional features such as code completion, code outlining, and underlying syntax errors and warnings.

Here are some of the essential features provided by the XmlParser:

  • Syntax Highlighting
  • IntelliSense (Code completion)
  • Code Outlining

Constructors

XmlParser()

Initializes a new instance of the XmlParser class with default settings.

XmlParser(IContainer)

Initializes a new instance of the XmlParser class with specified container.

Fields

DefaultXmlCodeCompletionChars

Represents a default collection of characters that initializes a code completion procedure when typing.

DefaultXmlDelimiters

Represents a default collection of delimiter characters.

DefaultXmlSyntaxOptions

Represents default set of flags determining syntax parsing and formatting behavior.

Properties

Repository

Gets a XmlRepository that holds methods for code completion purposes.

Workspace

Methods

CreateRepository()

Creates ICodeCompletionRepository to perform code completion functionality for this parser.

CreateWorkspace()
InitLanguage()
IsCodeCompletionChar(char, byte, ref int)

Returns boolean value indicating that given character initializes a code completion procedure when typing.

ResetCodeCompletionChars()

Resets CodeCompletionChars to the default value.

ResetOptions()

Resets Options to the default value.

ShouldSerializeCodeCompletionChars()

Indicates whether the CodeCompletionChars property should be persisted.

ShouldSerializeOptions()

Indicates whether the Options property should be persisted.