バージョン

BeginExport イベント

グリッドのエクスポートが始まる前に発生します。
シンタックス
'宣言
 
Public Event BeginExport As BeginExportEventHandler
public event BeginExportEventHandler BeginExport
イベント データ

イベント ハンドラが、このイベントに関連するデータを含む、BeginExportEventArgs 型の引数を受け取りました。次の BeginExportEventArgs プロパティには、このイベントの固有の情報が記載されます。

プロパティ解説
CurrentColumnIndex Infragistics.Win.UltraWinGrid.ExcelExport.ExcelExportEventArgsから継承されます。Excel ワークシート内の、現在エクスポート中の列の0から始まるインデックス。
CurrentOutlineLevel Infragistics.Win.UltraWinGrid.ExcelExport.ExcelExportEventArgsから継承されます。グループ化に使用されている現在のアウトラインレベル。
CurrentRowIndex Infragistics.Win.UltraWinGrid.ExcelExport.ExcelExportEventArgsから継承されます。Excel ワークシート内の、現在エクスポート中の行の0から始まるインデックス。
CurrentWorksheet Infragistics.Win.UltraWinGrid.ExcelExport.ExcelExportEventArgsから継承されます。現在エクスポート中のワークシート。
Layout グリッドのレイアウト。
Rows 最上位バンドの行コレクション。
Workbook Infragistics.Win.UltraWinGrid.ExcelExport.ExcelExportEventArgsから継承されます。エクスポート中のワークブック。
解説

Layout 引数は、Excel 形式のエクスポート処理に使用される UltraGridLayout のクローンへの参照を返します。このレイアウトを変更すると、その変更は元のグリッドレイアウトではなく、エクスポートされたファイルに反映されます。

Rows 引数は、一番上のバンドにある元の行コレクションへの参照を返します。

また、このイベントには、ExcelExportEventArgs から継承された Workbook、CurrentWorksheet、CurrentRowIndex、CurrentColumnIndex、CurrentOutlineLevel などの引数もあります。

このイベントは、他のどのイベントよりも前に発生します。このイベントを使用すれば、エクスポートプロセスが始まる前の前処理を行うことができます。たとえば、クローンされたレイアウトのプロパティを設定したり、Excelワークブックにカスタムヘッダーを書き込んだりすることが可能です。

使用例
Private Sub MyGridExporter_BeginExport(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.ExcelExport.BeginExportEventArgs) Handles MyGridExporter.BeginExport
    Dim ws As Worksheet
    ws = e.CurrentWorksheet.Workbook.Worksheets.Add("InfoSheet")

    ws.Columns(1).Width = 20 * 256
    ws.Columns(2).Width = 20 * 256

    ws.Rows(1).Cells(1).Value = "Export started at:"
    ws.Rows(1).Cells(2).Value = DateTime.Now

    e.CurrentWorksheet.Workbook.ActiveWorksheet = ws
End Sub

Private Sub MyGridExporter_EndExport(ByVal sender As Object, ByVal e As Infragistics.Win.UltraWinGrid.ExcelExport.EndExportEventArgs) Handles MyGridExporter.EndExport
    Dim ws As Worksheet
    ws = e.CurrentWorksheet.Workbook.Worksheets("InfoSheet")

    ws.Rows(2).Cells(1).Value = "Export successful!"
End Sub
public void BeginExportEH(object sender, BeginExportEventArgs e)
{
	Worksheet ws = e.CurrentWorksheet.Workbook.Worksheets.Add("InfoSheet");

	ws.Columns[1].Width = 20*256;
	ws.Columns[2].Width = 20*256;

	ws.Rows[1].Cells[1].Value = "Export started at:";
	ws.Rows[1].Cells[2].Value = DateTime.Now;

	e.CurrentWorksheet.Workbook.ActiveWorksheet = ws;

}

public void EndExportEH(object sender, EndExportEventArgs e)
{
	Worksheet ws = e.CurrentWorksheet.Workbook.Worksheets["InfoSheet"];
	
	ws.Rows[2].Cells[1].Value = "Export successful!";
}
参照