OverlayReplacements プロパティ

レポート本体で置換／生成される辞書（System.Collections.IDictionary）を取得します。

シンタックス

Visual Basic
C#

'宣言
 
Public ReadOnly Property OverlayReplacements As System.Collections.IDictionary

public System.Collections.IDictionary OverlayReplacements {get;}

解説

このプロパティはエクスポートフィルタの実装時に役に立ちます。

ページ数やグループページ数を含むレポートは、レポート本体に特別なタグを保存します。レポート描画が終了したとき、これらのタグは実際のページ数と置き換えられる必要があります。フィルタはこの辞書を使ってタグと置き換えられる値のリストを取得することができます。辞書内のキーのペアは、タグとそれらが置き換えられる値を格納しています。

使用例

次のコードは、テキストフィルタの実装の一部を示しています。EndReport メソッドでは、オーバーレイ置換辞書を取得して、ReplaceInStream メソッドを呼び出してストリームの各行をスキャンしてキーを対応する値に置き換えます。例えば、総ページ数は "#pages#" のようなキーで表され、ストリーム中のすべてのキーは実際の総ページ数に置き換えられます。

public class MyTextFilter : ExportFilter
{
  // ...
  override public void EndReport()
  {
    // close output stream
    Layout layout = _ownerReport.GetLayout();
    ReplaceInStream(_exportStream, layout.OverlayReplacements);
    _exportStream.Close();
  }
}

参照

Layout クラス
 Layout メンバ