ActionHandlers インターフェイス

ツールバーボタンのアクションとホットキーのアクションハンドラを表します。

階層

ActionHandlers

メソッド

メソッド

オプション onCreate

onCreate(): Promise<Report | undefined>

レポートを開いたときに呼び出されます。

戻り値 Promise < Report | undefined >

操作がキャンセルされた場合は、レポートの情報または「undefined」。

オプション onOpen

onOpen(): Promise<Report | undefined>

レポートを開くときに呼び出されます。

戻り値 Promise < Report | undefined >

操作がキャンセルされた場合は、レポートの情報または「undefined」。

オプション onOpenFileMenu

onOpenFileMenu(): void

カスタムのファイルメニューを開くときに呼び出されます。

戻り値 void

オプション onRender

onRender(report: ReportDefinition, resourceLocator?: Partial<ResourceLocator>): Promise<void>

現在のレポートが描画する時に呼び出されます。

引数
- report: ReportDefinition
  
  現在のレポート情報。
- オプション resourceLocator: Partial<ResourceLocator>
  
  ResourceLocatorインスタンス。
戻り値 Promise < void >

オプション onSave

onSave(options: SaveReportInfo): Promise<SaveResult | undefined>

レポートの保存時に呼び出されます。

引数
- options: SaveReportInfo
  
  現在のレポート情報。
戻り値 Promise < SaveResult | undefined >

レポートが保存された場合、「undefined」の場合、または操作がキャンセルされた場合の新しいレポート情報。

オプション onSaveAs

onSaveAs(options: SaveNewReportInfo): Promise<SaveAsResult | undefined>

レポートを新規として保存する時に呼び出されます。

引数
- options: SaveNewReportInfo
  
  現在のレポート情報。
戻り値 Promise < SaveAsResult | undefined >

レポートが保存された場合、「undefined」の場合、または操作がキャンセルされた場合の新しいレポート情報。