DocumentPaginator.GetPageAsync Метод

  • Ссылка

Определение

Пространство имен:
System.Windows.Documents
Сборка:
PresentationCore.dll

Асинхронно возвращает DocumentPage для указанного номера страницы.

Перегрузки

GetPageAsync(Int32, Object)

Асинхронно возвращает (через событие GetPageCompleted) DocumentPage для указанного номера страницы и назначает указанный идентификатор асинхронной задаче.
GetPageAsync(Int32)

Асинхронно возвращает (через событие GetPageCompleted) DocumentPage для указанного номера страницы.

GetPageAsync(Int32, Object)

Асинхронно возвращает (через событие GetPageCompleted) DocumentPage для указанного номера страницы и назначает указанный идентификатор асинхронной задаче.

public:
 virtual void GetPageAsync(int pageNumber, System::Object ^ userState);
public virtual void GetPageAsync (int pageNumber, object userState);
abstract member GetPageAsync : int * obj -> unit
override this.GetPageAsync : int * obj -> unit
Public Overridable Sub GetPageAsync (pageNumber As Integer, userState As Object)

Параметры

pageNumber
Int32

Отсчитываемый от нуля номер страницы DocumentPage для получения.

userState
Object

Уникальный идентификатор асинхронной задачи.

Исключения

ArgumentOutOfRangeException

pageNumber отрицательно.

Комментарии

Эта перегрузка метода позволяет отменить эту асинхронную операцию без отмены всех асинхронных операций.

Этот метод вызывает событие GetPageCompleted. DocumentPage передается в событие в качестве одного из аргументов события.

Ниже показано, как получить DocumentPage асинхронно:

  1. Создайте делегат GetPageCompletedEventHandler и добавьте его для уведомления о событиях GetPageCompleted.

  2. Вызов GetPageAsync(Int32, Object) указание требуемого pageNumber и уникальной userState, которая будет использоваться для определения завершения асинхронного события.

  3. При возникновении события и вызове делегата сравните GetPageCompletedEventArgsсобытия. свойствоUserState с исходным параметром GetPageAsync(Int32, Object)userState. (Свойство GetPageCompletedEventArgs.PageNumber также соответствует pageNumber, указанному в вызове GetPageAsync(Int32, Object).)

  4. Когда GetPageCompletedEventArgs.UserState свойство соответствует исходному GetPageAsync(Int32, Object)userState, операция завершена и страница готова.

  5. Вызов GetPage для получения форматированного DocumentPage.

Применяется к

GetPageAsync(Int32)

Асинхронно возвращает (через событие GetPageCompleted) DocumentPage для указанного номера страницы.

public:
 virtual void GetPageAsync(int pageNumber);
public virtual void GetPageAsync (int pageNumber);
abstract member GetPageAsync : int -> unit
override this.GetPageAsync : int -> unit
Public Overridable Sub GetPageAsync (pageNumber As Integer)

Параметры

pageNumber
Int32

Отсчитываемый от нуля номер страницы документа.

Исключения

ArgumentOutOfRangeException

pageNumber отрицательно.

Комментарии

Единственным способом отмены асинхронной операции этого метода является отмена всех асинхронных операций. Контрастирует с другой перегрузкой этого метода: GetPageAsync(Int32, Object).

Этот метод вызывает событие GetPageCompleted. DocumentPage передается в событие в качестве одного из аргументов события. Сведения о том, как использовать этот метод для получения страницы, см. в GetPageAsync(Int32, Object).

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых GetPage(Int32).

Применяется к