TdxDocumentSaveOptions.CurrentFileName Property

Specifies the full path used to overwrite the current target document file.

Declaration

property CurrentFileName: string read; write;

Property Value

Type	Description
string	The path to the current target document file.

Remarks

Use CurrentFileName and CurrentFormat properties to specify the target file name and format for document export operations.

Related API Members

The following export methods update^[1] CurrentFileName and CurrentFormat property values with the full name and format of a successfully loaded document:

IdxRichEditDocument

IdxRichEditDocument.LoadDocument(System.String,dxRichEdit.NativeApi.TdxRichEditDocumentFormat)

Imports a document from the specified file.

IdxRichEditDocument.LoadDocument(System.String,dxRichEdit.NativeApi.TdxRichEditDocumentFormat,System.String)

Imports a document from a file (in any supported format).

TdxRichEditControl

TdxRichEditControlBase.LoadDocument(System.String)

Imports a document from a file (in any supported format).

TdxRichEditControlBase.LoadDocument(System.String,dxRichEdit.NativeApi.TdxRichEditDocumentFormat)

Imports a document from a file (in any supported format).

TdxRichEditDocumentServer

TdxRichEditCustomDocumentServer.LoadDocument(System.String)

Imports a document from a file (in any supported format).

TdxRichEditCustomDocumentServer.LoadDocument(System.String,dxRichEdit.NativeApi.TdxRichEditDocumentFormat)

Imports a document from a file (in any supported format).

Related End-User Save Commands

The following TdxRichEditControl end-user commands use the CurrentFileName property value:

SaveDocument

To overwrite an existing document file.

SaveDocumentAs

To suggest a file name in the displayed Save As dialog.

Note

A TdxRichEditControlBase.LoadDocumentTemplate or TdxRichEditCustomDocumentServer.LoadDocumentTemplate procedure call does not update the CurrentFileName and CurrentFormat properties.

Default Value

The CurrentFileName property’s default value is an empty string.

The default CurrentFileName property value indicates that document export methods and commands use the DefaultFileName property value instead of CurrentFileName.

A ResetCurrentFileName procedure call restores the default CurrentFileName property value.

Footnotes

1. TdxRichEditControlBase.LoadDocumentTemplate and TdxRichEditCustomDocumentServer.LoadDocumentTemplate procedures do not update CurrentFileName and CurrentFormat property values.