Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

cxExportSchedulerToText(string,TcxCustomScheduler,Boolean,Boolean,TDateTime,TDateTime,string,TObject,TEncoding) Method

In This Article

Exports user events from a scheduler control to a file in plain text format.

#Declaration

Delphi
procedure cxExportSchedulerToText(const AFileName: string; AScheduler: TcxCustomScheduler; AsTable: Boolean; AShowDialog: Boolean = False; const AStart: TDateTime = NullDate; const AFinish: TDateTime = NullDate; const AFileExt: string = 'txt'; AHandler: TObject = nil; AEncoding: TEncoding = nil);

#Parameters

Name Type Description
AFileName string

The full path to the resulting plain text file. You can omit the file name extension because it is automatically updated from the AFileExt parameter value.

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

Optional. 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.

AStart TDateTime

Optional. 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

Optional. 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.

AFileExt string

Optional. Specifies the file name extension for the resulting plain text 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 plain text file. If nil (in Delphi) or nullptr (in C++Builder) is passed as the AEncoding parameter, the procedure uses the TEncoding.Default encoding.

See Also