cxExportSchedulerToFile(string,TcxCustomScheduler,Boolean,Boolean,string,TDateTime,TDateTime,Integer,string[],string,TObject,TEncoding) Method

Exports user events from a scheduler control to a file in the specified format.

Declaration

procedure cxExportSchedulerToFile(AFileName: string; AScheduler: TcxCustomScheduler; AsTable: Boolean; AShowDialog: Boolean; const AHeader: string; AStart: TDateTime; AFinish: TDateTime; AExportType: Integer; const ASeparators: array of string; const AFileExt: string; AHandler: TObject = nil; AEncoding: TEncoding = nil);

Parameters

Name	Type	Description
AFileName	string	The full path to the resulting file. You can omit the file name extension because it is automatically updated from the AFileExt parameter value. The AExportType parameter value defines the target export format.
AScheduler	TcxCustomScheduler	The source scheduler control.
AsTable	Boolean	If True, content of user events is exported as a table. If False, user events are exported as cards.
AShowDialog	Boolean	If True, the data export procedure ignores the AStart and AFinish parameter values and invokes the Set Date Range dialog that allows a user to specify the time period before the data export operation starts. If False, the data export operation starts without user interaction.
AHeader	string	Specifies the card header. The data export procedure ignores this parameter if the AsTable parameter value is False.
AStart	TDateTime	Specifies the beginning of the export time period that limits exported user events. If the AStart parameter is omitted, the data export procedure uses the first date displayed in the Date Navigator. The AStart parameter value or the first date in the Date Navigator is ignored if the AShowDialog parameter value is True.
AFinish	TDateTime	Specifies the end of the export time period that limits exported user events. If the AFinish parameter is omitted, the data export procedure uses the last date displayed in the Date Navigator. The AFinish parameter value or the last date in the Date Navigator is ignored if the AShowDialog parameter value is True.
AExportType	Integer	Specifies the target export format. You can pass one of the following public constants as this parameter: cxExportToBinary, cxExportToCSV, cxExportToHtml, cxExportToXml, cxExportToText, cxExportToXlsx. These public constants are declared in the cxExport unit.
ASeparators	string	Specifies the value separator character as well as the prefix and postfix strings. The ASeparators parameter is in effect only if you pass cxExportToCSV or cxExportToText as the AExportType parameter.
AFileExt	string	Specifies the file name extension of the resulting file. This parameter value always replaces the file name extension passed as a part of the AFileName parameter value.
AHandler	TObject	Optional. Specifies a handler object that should implement the IcxExportBeforeSave and/or IcxExportProgress interfaces to allow you to perform specific actions before an export operation and track its progress. Refer to the following topic for detailed information on how to create and use handler objects: How to: Track Data Export Progress.
AEncoding	TEncoding	Optional. Specifies the character encoding format of the resulting file. If nil (in Delphi) or nullptr (in C++Builder) is passed as the AEncoding parameter, the procedure uses the TEncoding.Default encoding. The AEncoding parameter is in effect only if you pass cxExportToText or cxExportToCSV as the AExportType parameter.

Remarks

The following example demonstrates how to create a report file named “Sport Events.txt” as a table in text format:

// ...
uses
  cxExportSchedulerLink, cxExport;
// ...
const
  ATabChar = #9;
  AQuoteChar = #34;
begin
  cxExportSchedulerToFile('Sport Events',
  <Scheduler>, True, False, '',
  StrToDateTime('09/01/2010 12:00:01 AM'),
  StrToDateTime('10/31/2010 11:59:00 PM'),
  cxExportToText, [ATabChar, AQuoteChar, AQuoteChar], 'txt');
end;

The following image shows the code execution result: