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 は自動的にバックグラウンドでコンテンツの事前ページ調整を行います (このプロセスは、 が trueの場合IsBackgroundPaginationEnabledに開始されます。これは既定の設定です)。

trueの場合IsBackgroundPaginationEnabled、コンテンツの変更や の変更PageSizeにより、レイアウトも再適用されます。

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

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

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

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

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

  1. PaginationProgress設定が = 0 および PaginationProgressEventArgsCount = 1 のStartイベント。

  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)

指定したページ番号の GetPageCompleted を (DocumentPage イベントを通じて) 返します。

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

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

(継承元 DocumentPaginator)
GetPageNumber(ContentPosition)

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

GetPageNumberAsync(ContentPosition)

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

GetPageNumberAsync(ContentPosition, Object)

指定した GetPageNumberCompleted の 0 から始まるページ番号を非同期的に返します (このメソッドを通じて、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 つ以上のコンテンツ ページに対して改ページ位置の自動修正が実行されると発生します。

適用対象