Метод WebPart.RegisterWorkItemCallback

Статья
05/13/2015

Примечание. Этот API устарел.

Ставит в очередь рабочий элемент веб-части в пул потоков, вызывает заданный делегат и указывает объект, передаваемый делегату при вызове из пула.

Пространство имен: Microsoft.SharePoint.WebPartPages
Сборка: Microsoft.SharePoint (в Microsoft.SharePoint.dll)

Синтаксис

'Декларация
<ObsoleteAttribute("Use Page.RegisterAsyncTask instead.")> _
Protected Function RegisterWorkItemCallback ( _
    beginCallBack As WaitCallback, _
    state As Object _
) As Boolean
'Применение
Dim beginCallBack As WaitCallback
Dim state As Object
Dim returnValue As Boolean

returnValue = Me.RegisterWorkItemCallback(beginCallBack, _
    state)

[ObsoleteAttribute("Use Page.RegisterAsyncTask instead.")]
protected bool RegisterWorkItemCallback(
    WaitCallback beginCallBack,
    Object state
)

Параметры

beginCallBack
Тип: System.Threading.WaitCallback

System.Threading.WaitCallback объект, представляющий делегат, вызываемый при поток в пул потоков принимает рабочего элемента.

state
Тип: System.Object

Объект, передаваемый делегату при вызове из пула.

Возвращаемое значение

Тип: System.Boolean
true , если метод выполнен успешно; в противном случае — false.

Замечания

Веб-части следует использовать асинхронный поток для любой операции, которая может занять значительное время. Например если базы данных или HTTP-запрос необходимо выполнить, выполнение этой операции на асинхронный поток позволяет другими частями продолжать работать, не блокируются. Базовый класс WebPart предоставляет методы для создания отдельного потока для выборки данных веб-части и управления ими этих потоков, убедитесь, что они не слишком много времени выполнения и блокировать страницы из визуализации. Метод RegisterWorkItemCallback может вызываться в любое время до RenderWebPart вызова метода. Этот метод работает так же, как System.Threading.ThreadPool.QueueUserWorkItem, но реализуется для работы с модели событий в пределах страницы веб-частей.

Если при возникновении тайм-аута незаконченный потоков, метод RenderWorkItemTimeout вызывается вместо метода RenderWebPart . Параметр времени ожидания задается значение атрибута Timeout тега < WebPartWorkItem >, содержащаяся в теге < SharePoint > в файле web.config.

См. также

Справочные материалы

WebPart класс

Элементы WebPart

Пространство имен Microsoft.SharePoint.WebPartPages

Поделиться через