Table of Contents

TExcelFile.Save Method

Overloads

TExcelFile.Save(string)

Saves the file to disk, on native format.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.Save(const fileName: string); overload;

Parameters

<-> Parameter Type Description
const fileName string File to save. If AllowOverwritingFiles is false, then fileName MUST NOT exist.

See also

TExcelFile.Save(TStream)

Saves the file to a stream, on native format.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.Save(const aStream: TStream); overload;

Parameters

<-> Parameter Type Description
const aStream TStream Stream where to save the file. Must be a seekable stream.

See also

TExcelFile.Save(string, TFileFormats)

Saves the file to a disk.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.Save(const fileName: string; const fileFormat: TFileFormats); overload;

Parameters

<-> Parameter Type Description
const fileName string File to save. If AllowOverwritingFiles is false, then fileName MUST NOT exist.
const fileFormat TFileFormats File format. If file format is text, a tab will be used as delimiter. Automatic will try to guess it from the filename, if present.

See also

TExcelFile.Save(TStream, TFileFormats)

Saves the file to a stream.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.Save(const aStream: TStream; const fileFormat: TFileFormats); overload;

Parameters

<-> Parameter Type Description
const aStream TStream Stream where to save the file. Must be a seekable stream.
const fileFormat TFileFormats File format. If file format is text, a tab will be used as delimiter. Automatic will try to guess it from the filename, if present.

See also

TExcelFile.Save(string, TFileFormats, Char)

Saves the file to a disk.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.Save(const fileName: string; const fileFormat: TFileFormats; const delimiter: Char); overload;

Parameters

<-> Parameter Type Description
const fileName string File to save. If AllowOverwritingFiles is false, then fileName MUST NOT exist.
const fileFormat TFileFormats File format. Automatic will try to guess it from the filename, if present.
const delimiter Char Delimiter to use if FileFormat is TFileFormats.Text

See also

TExcelFile.Save(TStream, TFileFormats, Char)

Saves the file to a stream.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.Save(const aStream: TStream; const fileFormat: TFileFormats; const delimiter: Char); overload;

Parameters

<-> Parameter Type Description
const aStream TStream Stream where to save the file. Must be a seekable stream.
const fileFormat TFileFormats File format. Automatic will try to guess it from the filename, if present.
const delimiter Char Delimiter to use if FileFormat is TFileFormats.Text

See also

TExcelFile.Save(string, TFileFormats, Char, TEncoding)

Saves the file to a disk.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.Save(const fileName: string; const fileFormat: TFileFormats; const delimiter: Char; const fileEncoding: TEncoding); overload; virtual; abstract;

Parameters

<-> Parameter Type Description
const fileName string File to save. If AllowOverwritingFiles is false, then fileName MUST NOT exist.
const fileFormat TFileFormats File format. Automatic will try to guess it from the filename, if present.
const delimiter Char Delimiter to use if FileFormat is TFileFormats.Text
const fileEncoding TEncoding Encoding for the generated file, when writing a Text-delimited file (csv or txt).
This parameter has no effect on xls/x files. If omitted, TUTF8EncodingNoBom.Instance will be used. Note that to create a file with BOM (byte order marker) you need to specify an encoding here, the same as you do with a StreamWriter.

See also

TExcelFile.Save(TStream, TFileFormats, Char, TEncoding)

Saves the file to a stream.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.Save(const aStream: TStream; const fileFormat: TFileFormats; const delimiter: Char; const fileEncoding: TEncoding); overload; virtual; abstract;

Parameters

<-> Parameter Type Description
const aStream TStream Stream where to save the file. Must be a seekable stream.
const fileFormat TFileFormats File format. Automatic will try to guess it from the filename, if present.
const delimiter Char Delimiter to use if FileFormat is TFileFormats.Text
const fileEncoding TEncoding Encoding for the generated file, when writing a Text-delimited file (csv or txt).
This parameter has no effect on xls files. If omitted, TUTF8EncodingNoBom.Instance will be used. Note that to create a file with BOM (byte order marker) you need to specify an encoding here, the same as you do with a StreamWriter.

See also