TdxDocumentSaveOptions.CurrentFormat Property

Specifies the document format used to overwrite an existing file with the document opened in a Rich Edit component.

Declaration

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

Property Value

Type	Default	Description
TdxRichEditDocumentFormat	Undefined	Enumerates document formats available in Rich Edit components.

Remarks

The following end-user commands of a Rich Edit control use the current format to:

• Overwrite an existing file with the opened document (SaveDocument).

• Suggest the target document format in a Save As dialog (SaveDocumentAs).

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

• A Rich Edit control’s LoadDocument procedure.

• A document server‘s LoadDocument procedure.

• A document‘s LoadDocument procedure.

A Rich Edit component uses the DefaultFormat property value as the current document format if the CurrentFormat property is set to TdxRichEditDocumentFormat.Undefined.

Refer to the TdxRichEditDocumentFormat type description for detailed information on available formats.

Note

A Rich Edit component uses the DefaultFormat property value as the current format if the CurrentFormat property is set to TdxRichEditDocumentFormat.Undefined. A TdxRichEditControlBase.LoadDocumentTemplate or TdxRichEditCustomDocumentServer.LoadDocumentTemplate procedure call does not update the CurrentFileName and CurrentFormat properties.

The CurrentFormat property’s default value is TdxRichEditDocumentFormat.Undefined.