TdxDocumentSaveOptions Class

Stores general document export settings for TdxRichEditControl and TdxRichEditDocumentServer components.

Declaration

TdxDocumentSaveOptions = class(
    TdxRichEditNotificationOptions,
    IdxDocumentSaveOptions
)

Remarks

General document export settings define the target file and format for document export operations.

Affected End-User Commands

General document export settings affect the behavior of the following TdxRichEditControl end-user commands:

SaveDocumentOverwrites the current document.SaveDocumentAsDisplays the Save As dialog.

Affected API Members

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

Main API Members

The list below outlines key members of the TdxDocumentSaveOptions class. These members allow you to configure the target file and format for document export operations.

File Export Settings

CanSaveToCurrentFileNameIdentifies if the current file name is available as a document export target.DefaultFileName | DefaultFormatSpecify the default target file name and format for document export operations.CurrentFileName | CurrentFormatSpecify the current file name and format for document export operations to an existing file.ResetCurrentFileName | ResetCurrentFormatRestore default CurrentFileName and CurrentFormat property values.

General-Purpose API Members

AssignCopies general document export settings between DevExpress Rich Text components.BeginUpdate | EndUpdate | CancelUpdateAllow you to avoid excessive change notifications during batch export setting changes.ResetRestores all default property values.

Direct TdxDocumentSaveOptions Class Reference

The TdxRichEditControlOptionsBase.DocumentSaveOptions property references a TdxDocumentSaveOptions object.

Inheritance

TObject TPersistent TInterfacedPersistent TdxRichEditNotificationOptions TdxDocumentSaveOptions

See Also

TdxDocumentSaveOptions Members

dxRichEdit.Options Unit