EditorControl.FDoIdle Method

Article
07/12/2014

Gives the component a chance to do idle time tasks.

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 (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)

Syntax

'Declaration
Public Overrides Function FDoIdle ( _
    grfidlef As UInteger _
) As Integer

public override int FDoIdle(
    uint grfidlef
)

public:
virtual int FDoIdle(
    unsigned int grfidlef
) override

abstract FDoIdle : 
        grfidlef:uint32 -> int  
override FDoIdle : 
        grfidlef:uint32 -> int

public override function FDoIdle(
    grfidlef : uint
) : int

Parameters

grfidlef
Type: System.UInt32

Flags from the _OLEIDLEF enumeration.

Return Value

Type: System.Int32
true if more time is needed to perform the idle time tasks, false otherwise.

Implements

IOleComponent.FDoIdle(UInt32)

Remarks

By default this method is not implemented, and simply returns false.

Notes to Implementers

grfidlef indicates the type of idle tasks to perform. The component may periodically call [M:Microsoft.VisualStudio.OLE.Interop.IOleComponentManager.FContinueIdle()]; if this method returns false, the component should terminate its idle time processing and return. If a component reaches a point where it has no idle tasks and does not need FDoIdle calls, it should remove its idle task registration via [M:Microsoft.VisualStudio.OLE.Interop.IOleComponentManager::FUpdateComponentRegistration]. If this method is called while the component is performing a tracking operation, the component should perform only those idle time tasks that it deems appropriate to perform during tracking.

.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.

Share via