DynamicDocumentPaginator クラス

定義

独自の基底クラスのメソッドとプロパティに加えて、改ページの自動バックグラウンド改ページと追跡コンテンツの位置をサポートする抽象基本クラスを提供します。

public ref class DynamicDocumentPaginator abstract : System::Windows::Documents::DocumentPaginator
public abstract class DynamicDocumentPaginator : System.Windows.Documents.DocumentPaginator
type DynamicDocumentPaginator = class
    inherit DocumentPaginator
Public MustInherit Class DynamicDocumentPaginator
Inherits DocumentPaginator
継承
DynamicDocumentPaginator

注釈

既定では、 DynamicDocumentPaginator はコンテンツをバックグラウンドで自動的に事前にページ分割します (このプロセスは、既定の設定である IsBackgroundPaginationEnabledtrueされたときに開始されます)。

IsBackgroundPaginationEnabledtrueされると、コンテンツの変更やPageSizeの変更により、レイアウトも再表示されます。

PaginationProgress イベントは、次のような 1 つ以上のページの改ページ (または改ページ) が完了したときに発生します。

  • PaginationProgress イベントは、コンテンツがバックグラウンドでページ分割されるときに発生します。 実装によっては、1 つまたは複数のページのページ分割時にイベントが発生する可能性があります (PaginationProgressEventArgs は、ページ分割されたページを指定します)。

  • GetPageまたはGetPageAsyncを呼び出すと、指定したページがページ分割されていない場合、PaginationProgress イベントが発生する可能性があります。 たとえば、バックグラウンド改ページが有効になっている (IsBackgroundPaginationEnabled = true) が、3 ページ目までしか改ページが完了していない場合、引数が 6 の GetPage を呼び出すと、ページ 4、5、6、および 7 がページ分割されます。 完了すると、PaginationProgress = 4、PaginationProgressEventArgs = 4 のStart設定でCountイベントが発生します。

  • バックグラウンド改ページ位置の変更 (IsBackgroundPaginationEnabled = true) を有効にすると、フロー形式のコンテンツ (PageSizeなど) のFlowDocumentが変更されると、復帰および関連するPaginationProgress イベントが発生する可能性があります。 PageSizeは、FixedDocumentなどの固定形式のコンテンツに対する復帰には影響しません。ビジュアル ページ サイズはレイアウトに影響しません。

PaginationCompleted イベントは、バックグラウンドの改ページ位置が無効になっている場合にも発生します。 たとえば、コンテンツと IsBackgroundPaginationEnabled = false) のページが 1 ページしかない場合、引数 0 で GetPage を呼び出すと、次の 2 つのイベントが発生します。

  1. PaginationProgress = 0 と PaginationProgressEventArgs = 1 のStart設定を持つCount イベント。

  2. PaginationCompleted イベント。

コンストラクター

名前 説明
DynamicDocumentPaginator()

DynamicDocumentPaginator クラスの新しいインスタンスを初期化します。

プロパティ

名前 説明
IsBackgroundPaginationEnabled

ページ サイズの変更など、特定のイベントに応答して、改ページがバックグラウンドで自動的に実行されるかどうかを示す値を取得または設定します。

IsPageCountValid

派生クラスでオーバーライドされた場合、 PageCount がページの合計数であるかどうかを示す値を取得します。

(継承元 DocumentPaginator)
PageCount

派生クラスでオーバーライドされると、現在書式設定されているページ数のカウントを取得します。

(継承元 DocumentPaginator)
PageSize

派生クラスでオーバーライドされた場合、各ページの推奨される幅と高さを取得または設定します。

(継承元 DocumentPaginator)
Source

派生クラスでオーバーライドされると、ページ分割されている要素を返します。

(継承元 DocumentPaginator)

メソッド

名前 説明
CancelAsync(Object)

前の GetPageAsync または GetPageNumberAsync 操作を取り消します。

(継承元 DocumentPaginator)
ComputePageCount()

コンテンツの改ページを強制し、新しい合計で PageCount 更新し、 IsPageCountValidtrueに設定します。

(継承元 DocumentPaginator)
ComputePageCountAsync()

非同期的に、コンテンツの改ページを強制し、新しい合計で PageCount を更新し、 IsPageCountValidtrueに設定します。

(継承元 DocumentPaginator)
ComputePageCountAsync(Object)

非同期的に、コンテンツの改ページを強制し、新しい合計で PageCount 更新し、 IsPageCountValidtrueに設定します。

(継承元 DocumentPaginator)
Equals(Object)

指定したオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetObjectPosition(Object)

派生クラスでオーバーライドされると、指定したContentPositionObjectを返します。

GetPage(Int32)

派生クラスでオーバーライドされると、指定したページ番号の DocumentPage を取得します。

(継承元 DocumentPaginator)
GetPageAsync(Int32, Object)

指定したページ番号のGetPageCompletedを非同期的に (DocumentPage イベントを介して) 返し、指定した ID を非同期タスクに割り当てます。

(継承元 DocumentPaginator)
GetPageAsync(Int32)

指定したページ番号のGetPageCompletedを非同期に (DocumentPage イベントを介して) 返します。

(継承元 DocumentPaginator)
GetPageNumber(ContentPosition)

派生クラスでオーバーライドされた場合は、指定した ContentPositionの 0 から始まるページ番号を返します。

GetPageNumberAsync(ContentPosition, Object)

非同期的に、指定したGetPageNumberCompletedの 0 から始まるページ番号を (This メソッドを使用してContentPosition イベントを発生させます) を返します。

GetPageNumberAsync(ContentPosition)

非同期的に、指定したGetPageNumberCompletedの 0 から始まるページ番号を (This メソッドを使用してContentPosition イベントを発生させます) を返します。

GetPagePosition(DocumentPage)

派生クラスでオーバーライドされると、ドキュメントのコンテンツ内の指定したページの位置を取得します。

GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
OnComputePageCountCompleted(AsyncCompletedEventArgs)

ComputePageCountCompleted イベントを発生させます。

(継承元 DocumentPaginator)
OnGetPageCompleted(GetPageCompletedEventArgs)

GetPageCompleted イベントを発生させます。

(継承元 DocumentPaginator)
OnGetPageNumberCompleted(GetPageNumberCompletedEventArgs)

GetPageNumberCompleted イベントを発生させます。

OnPagesChanged(PagesChangedEventArgs)

PagesChanged イベントを発生させます。

(継承元 DocumentPaginator)
OnPaginationCompleted(EventArgs)

PaginationCompleted イベントを発生させます。

OnPaginationProgress(PaginationProgressEventArgs)

PaginationProgress イベントを発生させます。

ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)

イベント

名前 説明
ComputePageCountCompleted

ComputePageCountAsync操作が完了したときに発生します。

(継承元 DocumentPaginator)
GetPageCompleted

GetPageAsyncが完了したときに発生します。

(継承元 DocumentPaginator)
GetPageNumberCompleted

GetPageNumberAsyncが完了したときに発生します。

PagesChanged

ドキュメントの内容が変更されたときに発生します。

(継承元 DocumentPaginator)
PaginationCompleted

すべてのドキュメント コンテンツがページ分割されたときに発生します。

PaginationProgress

1 つ以上のコンテンツ ページがページ分割されたときに発生します。

適用対象