IWpfTableControl.ForceUpdateAsync Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.TableControl

Assembly:

Microsoft.VisualStudio.Shell.Framework.dll

Package:

Microsoft.VisualStudio.Shell.Framework v17.11.40262

Force the table control to begin an update (which may not happen immediately).

public:
 System::Threading::Tasks::Task<Microsoft::VisualStudio::Shell::TableControl::EntriesChangedEventArgs ^> ^ ForceUpdateAsync();

public System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.TableControl.EntriesChangedEventArgs> ForceUpdateAsync ();

abstract member ForceUpdateAsync : unit -> System.Threading.Tasks.Task<Microsoft.VisualStudio.Shell.TableControl.EntriesChangedEventArgs>

Public Function ForceUpdateAsync () As Task(Of EntriesChangedEventArgs)

Returns

Task<EntriesChangedEventArgs>

The version number of the pending update.

Remarks

There should be no need to call this method (updates will happen automatically if there is a change). It is exposed here primarily to simplify testing.

To avoid deadlocks you should use something similar to the following when calling this method:

var r =  ThreadHelper.JoinableTaskFactory.Run<EntriesChangedEventArgs>(async delegate
          {
            return await this.TableControl.ForceUpdateAsync();
          });