TdxCustomReportControl.ExportToText(TStream) Method

Exports report content to a stream in the plain text (TXT) format.

Declaration

procedure ExportToText(AStream: TStream); overload;

Parameters

Name	Type	Description
AStream	TStream	The target stream.

Remarks

Call the ExportToText procedure to export report content to a stream in the plain text format.

Code Example: Export Report Content to TXT File

The following code example exports content of a configured TdxReportControl component to a file in the plain text (TXT) format using an intermediary TMemoryStream object:

Delphi
C++

uses
  dxReport.Control,  // Declares the TdxReportControl component
  dxSplashForms,     // Declares the TdxSplashFormManager class and related types
  dxShellDialogs;    // Declares the TdxSaveFileDialog component
// ...

procedure TMyForm.cxButtonExportToTXTClick(Sender: TObject);
var
  AStream: TMemoryStream;
begin
  if not dxSaveFileDialog1.Execute(Handle) then Exit;  // Displays the "Save File" dialog
  AStream := TMemoryStream.Create;       // Creates a stream as an intermediary container
  // Displays a Wait Form before the export operation
  TdxSplashFormManager.WaitForm.Show(dxReportControl1.Parent);
  try
    dxReportControl1.ExportToText(AStream);   // Exports content to a stream in the TXT format
    AStream.SaveToFile(dxSaveFileDialog1.FileName);    // Saves TXT stream content to a file
  finally
    AStream.Free;                        // Releases the intermediary memory stream
    TdxSplashFormManager.WaitForm.Hide;  // Hides the Wait Form once the operation is complete
  end;
end;

#include "dxReport.Control.hpp"  // Declares the TdxReportControl component
#include "dxSplashForms.hpp"     // Declares the TdxSplashFormManager class and related types
#include "dxShellDialogs.hpp"    // Declares the TdxSaveFileDialog component

// Add the following linker directives to the corresponding CPP source file:
#pragma link "dxReport.Control"  // Required to use dxReport.Control.hpp declarations
#pragma link "dxSplashForms"     // Required to use dxSplashForms.hpp declarations
#pragma link "dxShellDialogs"    // Required to use dxShellDialogs.hpp declarations
// ...

void __fastcall TMyForm::cxButtonExportToTXTClick(TObject *Sender)
{
  if(!dxSaveFileDialog1->Execute(Handle)) { return; }  // Displays the "Save File" dialog
  TMemoryStream *AStream = new TMemoryStream();  // Creates a stream as an intermediary container
  // Displays a Wait Form before the export operation
  TdxSplashFormManager::WaitForm()->Show(dxReportControl1->Parent);
  try
  {
    dxReportControl1->ExportToText(AStream);  // Exports content to a stream in the TXT format
    AStream->SaveToFile(dxSaveFileDialog1->FileName);  // Saves TXT stream content to a file
  }
  __finally
  {
    delete AStream;                              // Releases the intermediary memory stream
    TdxSplashFormManager::WaitForm()->Hide();    // Hides the Wait Form once the operation is complete
  }
}

To see the report export functionality in action, run the Report Designer/Viewer demo in the VCL Demo Center installed with compiled DevExpress VCL demos. Select any demo in the sidebar on the left, click the Export button, and use any export option listed in the menu.

Download: Compiled VCL Demos

Tip

You can find full source code for the installed compiled Report demo in the following folder:

%PUBLIC%\Documents\DevExpress VCL Demos\MegaDemos\Product Demos\ExpressReports\