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