Share via


LanguageService.OnIdle Method

Called when no other events need to be handled.

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 Overridable Sub OnIdle ( _
    periodic As Boolean _
)
public virtual void OnIdle(
    bool periodic
)
public:
virtual void OnIdle(
    bool periodic
)
abstract OnIdle : 
        periodic:bool -> unit  
override OnIdle : 
        periodic:bool -> unit
public function OnIdle(
    periodic : boolean
)

Parameters

  • periodic
    Type: System.Boolean

    [in] true if this call is one of a periodic series of idle calls, typically triggered by a timer.

Remarks

Note

This method is not called unless you set up your own timer and call this method from the timer handler.

The base method calls OnCaretMoved if the caret has moved since last time OnIdle was called. The base method then calls the OnIdle method on the Source object for the current view. If the current Source object cannot be obtained, the base method does nothing at all, including not calling OnCaretMoved.

.NET Framework Security

See Also

Reference

LanguageService Class

Microsoft.VisualStudio.Package Namespace