LanguageService.BeginParse Method

Starts a parse operation on a background thread.

Namespace: Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)

Syntax

'Declaration
Public Function BeginParse ( _
    request As ParseRequest, _
    handler As ParseResultHandler _
) As IAsyncResult

public IAsyncResult BeginParse(
    ParseRequest request,
    ParseResultHandler handler
)

public:
IAsyncResult^ BeginParse(
    ParseRequest^ request, 
    ParseResultHandler^ handler
)

member BeginParse : 
        request:ParseRequest * 
        handler:ParseResultHandler -> IAsyncResult

public function BeginParse(
    request : ParseRequest, 
    handler : ParseResultHandler
) : IAsyncResult

Parameters

request
Type: Microsoft.VisualStudio.Package.ParseRequest

[in] The ParseRequest object containing the parameters of the parse operation.

handler
Type: Microsoft.VisualStudio.Package.ParseResultHandler

[in] The ParseResultHandler that is called when the parsing is complete.

Return Value

Type: System.IAsyncResult

Remarks

This method is used to initiate all parsing operations other than those needed for colorization (which are handled directly by the Colorizer class).

Examples

using Microsoft.VisualStudio.Package;

namespace MyLanguage
{
    class MyLanguageService : LanguageService
    {
        private LanguagePreferences preferences;

        public override LanguagePreferences GetLanguagePreferences()
        {
            if (this.preferences == null)
            {
                this.preferences = new LanguagePreferences(this.Site,
                                                            typeof(MyLanguageService).GUID,
                                                            this.Name);
                if (this.preferences != null)
                {
                    this.preferences.Init();  // Must do this first!

                    // Temporarily enable the following properties.
                    this.preferences.EnableMatchBraces = true;
                }
            }
            return this.preferences;

        } 
    }
}

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.