Blazorビューワを操作する場合、初期化中と実行時に設定できるオプションと、初期化した後にのみ使用できるAPIメソッドとプロパティがあります。
RenderMode
説明: Blazorビューワでページの表示モードを設定します。デフォルト値は「Paginated」です。
型: Enum: RenderMode
有効な値: 'RenderMode.Paginated', 'RenderMode.Galley'
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" RenderMode="RenderMode.Paginated"/> |
DefaultExportSettings
説明: エクスポートパネルで表示される任意のフィールドのデフォルト値と表示設定するカスタムエクスポート設定を含むオブジェクト。
型: Dictionary<string, Dictionary<string, ExportSetting>>
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DefaultExportSettings="@defaultExportSettings"/> @code{ Dictionary<string, Dictionary<string, ExportSetting>> defaultExportSettings = new Dictionary<string, Dictionary<string, ExportSetting>>() { { "xls", new Dictionary<string, ExportSetting>(){ { "FileName", new ExportSetting() {Value = "ar", Visible = true} }, { "EnableToggles", new ExportSetting() {Value = false} } } } }; } |
AutoBackgroundColor
説明:trueに設定すると、表示領域の背景色がレポートの本体の背景色で塗りつぶされます。このプロパティは、ダッシュボードでのみ使用できます。
型:bool
有効な値:'true', 'false'
Sample code |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" AutoBackgroundColor="true" /> |
AvailableExports
説明:ビューワのエクスポート機能で使用できるエクスポート形式の配列。
型: ExportTypes[]
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" AvailableExports="availableExportArr"/> @code{ ExportTypes[] availableExportArr = new ExportTypes[] { ExportTypes.Pdf, ExportTypes.Xlsx, ExportTypes.Xls, ExportTypes.Json }; } |
Locale
説明: ビューワの表示に使用するロケールを指定します。
型: String
有効な値: 'en-US'(英語)、'ja-JP'(日本語)、'zh-CN'(中国語)
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" Locale="ja-JP"/> |
LocaleData
説明: ローカライズされた文字列を含むJSON。
型: String
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" LocaleData="@_localeData" > @code{ string _localeData = "{\"viewer\": {\"toolbar\": {\"refresh\": \"Refresh\"} } }"; } |
LocaleUri
説明: ローカライズされた文字列を含むファイルのURL。
型: String
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" LocaleUri="localization.json"/> |
PanelsLocation
説明: 検索パネル、パラメータパネルなどのパネルの位置を、ビューワの左側(ツールバー)または右側(サイドバー)に設定します。デフォルト値は「ツールバー」です。
型: Enum: PanelsLocation
有効な値: 'PanelsLocation.sidebar', 'PanelsLocation.toolbar'
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" PanelsLocation="PanelsLocation.toolbar" /> |
DisplayMode
説明:単一ページ/連続ページを設定します。
型: Enum: ViewMode
有効な値: 'ViewMode.Single', 'ViewMode.Continous'
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DisplayMode="ViewMode.Single" /> |
Action
説明: ビューワがハイパーリンク、ブックマークリンク、ドリルダウンレポートを開く前、またはレポートコントロールの表示/非表示を切り替える前に呼び出されるコールバック。
型: Method (string, object[])
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" Action="actionMethod" /> @code{ public void actionMethod(string actionType , object[] actionParams) { System.Diagnostics.Debug.WriteLine(actionType); foreach(var obj in actionParams) { System.Diagnostics.Debug.WriteLine(obj); } } } |
Error
説明: レポートの表示プロセスでエラーが発生したときに呼び出されるコールバック。
型: Method(ErrorInfo obj)
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" Error="errorMethod" /> @code{ public void errorMethod(ErrorInfo obj) { System.Diagnostics.Debug.WriteLine("エラーメッセージ :" + obj.Message); } } |
HideErrors
説明: ビューワにエラーを表示するかどうかを指定します。デフォルトではfalseです。
型: bool
有効な値: 'true', 'false'
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" HideErrors="true" /> |
InitialZoomMode
説明:ビューワでレポートをプレビューするときの表示倍率を設定します。
型:String
有効な値:'FitToPage', 'FitToWidth'
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" InitialZoomMode="@ZoomMode.FitToWidth"/> |
InitialZoomPercentage
説明:ビューワでレポートをプレビューするときのズームレベルをパーセントで設定します。このプロパティを100に設定すると、InitialZoomModeプロパティは無視されます。
型:Integer
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" InitialZoomPercentage="50"/> |
パーセント値を25から300の範囲で設定できます。
DocumentLoaded
説明: サーバー上でドキュメントが完全にロードされたときに呼び出されるコールバック。
型: Method()
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="DocumentLoaded"/> @code{ public void DocumentLoaded() { System.Diagnostics.Debug.WriteLine("サーバー上でドキュメントが完全にロードされました。"); } } |
ReportService
説明: Web APIに接続するための設定を定義します。
型: ReportServiceSettings object
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" ReportService="setting" /> @{ ReportServiceSettings setting = new ReportServiceSettings() { Url = "http:example.com/api/reporting", SecurityToken = "security_Token", OnRequest = (OnRequestInfo obj) => { obj.Headers.Add("Authorization", "security_Token"); } }; } |
ViewerInitialized
説明: ビューワが初期化されるときに呼び出されるコールバック。
Type: Method()
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" ViewerInitialized="InitializedViewer"/> @code{ private void InitializedViewer() { System.Diagnostics.Debug.WriteLine("Viewer is initailized now"); } } |
ReportLoaded
説明: ビューワが要求されたレポートに関する情報を取得するときに呼び出されるコールバック。
型: Method(ReportInfo obj)
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" ReportLoaded="ReportLoaded"/> @code{ public void ReportLoaded(ReportInfo obj) { System.Diagnostics.Debug.WriteLine(" " + obj.Name + " レポートが正常に読み込まれました。"); } } |
ParametersPanelSettings
説明:パラメータパネルの設定を指定します。
型: ParametersPanelSettings object
列挙型:サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" ParametersPanelSettings="parametersPanelSetting"/> @code{ ParametersPanelSettings parametersPanelSetting = new ParametersPanelSettings() { Location = ParameterPanelLocation.Default Open = ParameterPanelOpen.Always }; } |
Sidebar
説明: サイドバーの表示を切り替えます。
戻り値: Sidebar object
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" ViewerInitialized="InitializedViewer"/> @{ private ReportViewer _viewer; private void InitializedViewer() { Sidebar obj = _viewer.Sidebar; } } |
Parameters
説明: レポートの実行に使用されるパラメータを表す{name, value}ペアの配列。
型: Parameter[]
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" Parameters="parameterArray"/> @code{ Parameter[] parameterArray = new Parameter[] { new Parameter { Name = "カテゴリ", Values = new string[]{"ビジネス" } } }; } |
ReportName
説明:ビューワに表示されるレポートの名前。
型: String
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" /> @code{ private ReportViewer _viewer; private string _currentReport = null; protected override void OnInitialized() { reportsList = ReportsService.GetReports().ToList(); _currentReport = reportsList.FirstOrDefault(); } } |
Width
説明: ビューワの幅。デフォルトでは100%です。
型: String
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" Width="50%"/> |
Height
説明: ビューワの高さ。デフォルトでは100%です。
型: String
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" Height="50%"/> |
Toolbar
説明: ビューワのツールバーインスタンス。ツールバーにカスタム項目を追加したり、既存の項目を削除したりするために使用します。
戻り値: Toolbar object
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" ViewerInitialized="InitializedViewer"/> @{ private ReportViewer _viewer; private void InitializedViewer() { Toolbar obj = _viewer.Toolbar; } } |
BackToParent
説明: ドリルダウンレポートの親レポートをビューワに表示します。
型: Method
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" ViewerInitialized="InitializedViewer"/> @code{ private ReportViewer _viewer; private void InitializedViewer() { await _viewer.BackToParrent(); } } |
CurrentPage
説明: 現在表示されているページ番号を取得します。
型: Method
戻り値: ValueTask<int>
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="@DocumentLoaded"/> @code{ private async void DocumentLoaded() { var currentPage = await _viewer.CurrentPage(); System.Diagnostics.Debug.WriteLine(currentPage); } } |
Export
説明:現在表示されているレポートをエクスポートします。
パラメータ:
型: Method(ExportTypes, Action<string> callback = null, bool = false, Dictionary<string, string> settings = null, Func<bool> isCancelRequested = null, )
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<GrapeCity.ActiveReports.Blazor.ReportViewer @ref="_viewer" ReportName="@reportId" DocumentLoaded=" @DocumentLoaded"/> @code { private ReportViewer _viewer; private string reportId = "User defined report columns.rdlx"; private async void DocumentLoaded() { await _viewer.Export(ExportTypes.Pdf, (uri) => { //結果をエクスポートするURI }, false, new Dictionary<string, string>() { { "タイトル", "Blazorビューワ" } }, () => { //エクスポートタスクの取り消し要求の確認 return false; } ); } } |
GetToc
説明: レポートの見出しを取得します。
型: Method
戻り値: ValueTask<BookmarkInfo>
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="@DocumentLoaded"/> @code{ private async void DocumentLoaded() { var toc = await _viewer.GetToc(); } } |
GoToPage
説明: ビューワに特定のページを表示します。ページ番号は1から始まります。
Type: int
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="@DocumentLoaded"/> @code{ private async void DocumentLoaded() { await _viewer.GoToPage(2); } } |
OpenReport
説明: ドリルダウンレポートの親レポートをビューワに表示します。
型: Method(string, Parameter[] = null)
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
_viewer.OpenReport("TestReport.rdlx"); OR Parameter[] parameterArray = new Parameter[] { new Parameter { Name = "Category", Values = new string[]{"Business" } } }; _viewer.OpenReport("TestReport.rdlx", parameterArray); |
PageCount
説明: 現在表示されているレポートのページ数を取得します。
型: Method
戻り値: ValueTask<int>
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="@DocumentLoaded"/> @code{ private async void DocumentLoaded() { var countPage = await _viewer.PageCount(); System.Diagnostics.Debug.WriteLine(countPage); } } |
説明: 表示されているレポートを印刷します。
型: Method()
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="@DocumentLoaded"/> @code{ private async void DocumentLoaded() { await _viewer.Print(); } } |
Refresh
説明: レポートのプレビューを更新します。
型: Method()
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="@DocumentLoaded"/> @code{ private async void DocumentLoaded() { await _viewer.Refresh(); } } |
Search
説明:特定の検索オプション(大文字と小文字を区別、単語単位で検索)を使用して特定の用語の検索を実行し、渡された検索結果を使用して特定のコールバックを呼び出します。
パラメータ:
型: Method(string, SearchOptions = null, Action<List<SearchResult>> = null)
戻り値: Void
サンプルコード |
コードのコピー
|
---|---|
<ReportViewer @ref="_viewer" ReportName="@_currentReport" DocumentLoaded="@DocumentLoaded"/> @code{ private async void DocumentLoaded() { //レポートでAcmeキーワードを検索します。 await _viewer.Search("Acme", new SearchOptions() { MatchCase = true, WholePhrase = false }, (List<SearchResult> results) => { if (results != null && results.Count > 0) { foreach (var res in results) { System.Diagnostics.Debug.WriteLine(res.DisplayText); } } }); } |