EditorControl.FDoIdle(UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:: Microsoft.VisualStudio.Package.LanguageService.15.0 v17.9.37000

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gives the component a chance to do idle time tasks.

public:
 override int FDoIdle(System::UInt32 grfidlef);

public:
 override int FDoIdle(unsigned int grfidlef);

 override int FDoIdle(unsigned int grfidlef);

public override int FDoIdle (uint grfidlef);

override this.FDoIdle : uint32 -> int

Public Overrides Function FDoIdle (grfidlef As UInteger) As Integer

Parameters

grfidlef: UInt32

Flags from the _OLEIDLEF enumeration.

Returns

Int32

true if more time is needed to perform the idle time tasks, false otherwise.

Remarks

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

Notes to Inheritors

grfidlef indicates the type of idle tasks to perform. The component may periodically call 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(UInt32) calls, it should remove its idle task registration via 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.

Applies to