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 |
---|---|---|
AFile |
string | The full path to the resulting file. You can omit the file name extension because it is automatically updated from the |
AScheduler | Tcx |
The source scheduler control. |
As |
Boolean | If |
AShow |
Boolean | If |
AHeader | string | Specifies the card header. The data export procedure ignores this parameter if the |
AStart | TDate |
Specifies the beginning of the export time period that limits exported user events. If the |
AFinish | TDate |
Specifies the end of the export time period that limits exported user events. If the |
AExport |
Integer | Specifies the target export format. You can pass one of the following public constants as this parameter: cx |
ASeparators | string | Specifies the value separator character as well as the prefix and postfix strings. The |
AFile |
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 |
AHandler | TObject | Optional. Specifies a handler object that should implement the Icx |
AEncoding | TEncoding | Optional. Specifies the character encoding format of the resulting file. If |
#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: