TdxDocumentSaveOptions.CurrentFormat Property

Specifies the current document export format.

Declaration

property CurrentFormat: TdxRichEditDocumentFormat read; write; default TdxRichEditDocumentFormat.Undefined;

Property Value

Type	Default	Description
TdxRichEditDocumentFormat	Undefined	The current document export format.

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 CurrentFormat property’s default value is TdxRichEditDocumentFormat.Undefined.

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

Footnotes

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