DocumentFormat Struct

A document format.

Namespace: DevExpress.XtraRichEdit

Assembly: DevExpress.RichEdit.v23.1.Core.dll

NuGet Package: DevExpress.RichEdit.Core

Declaration

C#

[TypeConverter(typeof(DocumentFormatTypeConverter))]
[ComVisible(true)]
public struct DocumentFormat :
    IConvertToInt<DocumentFormat>,
    IEquatable<DocumentFormat>

VB.NET

<TypeConverter(GetType(DocumentFormatTypeConverter))>
<ComVisible(True)>
Public Structure DocumentFormat
    Implements IConvertToInt(Of DocumentFormat),
               IEquatable(Of DocumentFormat)

Related API Members

The following members return DocumentFormat objects:

Show 15 links

Library	Related API Members
WinForms Controls	RepositoryItemRichTextEdit.DocumentFormat
WPF Controls	DXRichEditDocumentImportOptions.FallbackFormat
	DXRichEditDocumentSaveOptions.CurrentFormat
	DXRichEditDocumentSaveOptions.DefaultFormat
	IRichEditDocumentLoader.Format
	RichEditDocumentContent.Format
	RichEditDocumentSource.Format
Office File API	BeforeExportEventArgs.DocumentFormat
	BeforeImportEventArgs.DocumentFormat
	DocumentSaveOptions.CurrentFormat
	DocumentSaveOptions.DefaultFormat
	IFormatDetectorService.DetectFormat(Stream)
	PasteSelectionCommand.Format
	RichEditDocumentImportOptions.FallbackFormat
ASP.NET Web Forms Controls	RichEditDocumentInfo.DocumentFormat

Related API Members

The following members return DocumentFormat objects:

Show 15 links

Library	Related API Members
WinForms Controls	RepositoryItemRichTextEdit.DocumentFormat
WPF Controls	DXRichEditDocumentImportOptions.FallbackFormat
	DXRichEditDocumentSaveOptions.CurrentFormat
	DXRichEditDocumentSaveOptions.DefaultFormat
	IRichEditDocumentLoader.Format
	RichEditDocumentContent.Format
	RichEditDocumentSource.Format
Office File API	BeforeExportEventArgs.DocumentFormat
	BeforeImportEventArgs.DocumentFormat
	DocumentSaveOptions.CurrentFormat
	DocumentSaveOptions.DefaultFormat
	IFormatDetectorService.DetectFormat(Stream)
	PasteSelectionCommand.Format
	RichEditDocumentImportOptions.FallbackFormat
ASP.NET Web Forms Controls	RichEditDocumentInfo.DocumentFormat

Remarks

The DocumentFormat structure contains the fields to specify the file format of the document.

The following methods use the DocumentFormat enumeration:

Action	Method
Save	Document.SaveDocument RichEditControl.SaveDocument RichEditControl.SaveDocument RichEditDocumentServer.SaveDocument ASPxRichEdit.SaveCopy RichEditExtension.SaveCopy RichEditDocumentInfo.SaveCopy
Load	Document.LoadDocument RichEditControl.LoadDocument RichEditDocumentServer.LoadDocument ASPxRichEdit.Open RichEditExtension.Open
Mail Merge	Document.MailMerge RichEditDocumentServer.MailMerge RichEditControl.MailMerge RichEditControl.MailMerge ASPxRichEdit.MailMerge RichEditExtension.MailMerge
Add Document Content	SubDocument.InsertDocumentContent SubDocument.AppendDocumentContent Document.Paste
Specify Property Values	DocumentSaveOptions.DefaultFormat DocumentSaveOptions.CurrentFormat BeforeExportEventArgs.DocumentFormat BeforeImportEventArgs.DocumentFormat RichEditDocumentInfo.DocumentFormat

Note

We do not recommend that you use the DocumentFormat.Undefined field as the SaveDocument or SaveCopy method parameter. Otherwise, the document is saved with invalid format.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DocumentFormat struct.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

associate-an-application-with-a-particular-file-extension-to-open-it-by-this-application-e3207/CS/Form1.cs#L19

try {
    richEditControl1.LoadDocument(commandLineArguments[1], DocumentFormat.Rtf);
}

using-the-search-and-replace-api-functionality-e1677/CS/SearchAndReplaceExample/Form1.cs#L21

InitializeComponent();
richEditControl1.LoadDocument("RichEditAbout.rtf", DocumentFormat.Rtf);

inline-pictures-in-richeditcontrol-e1525/CS/InlinePictures/Form1.cs#L21

    InitializeComponent();
    richEditControl1.LoadDocument("Texts\\Lorem.rtf", DocumentFormat.Rtf);
}

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/CS/GetTextMethodsExample/Form1.cs#L16

    InitializeComponent();
    richEditControl.LoadDocument("sample_document.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml);
}

how-to-retain-original-image-uri-in-html-document-e3189/CS/HTML_Export_ImageSourceExample/Form1.cs#L59

{
    richEditControl1.SaveDocument("test.html", DevExpress.XtraRichEdit.DocumentFormat.Html);
    System.Diagnostics.Process.Start("test.html");

VB.NET

associate-an-application-with-a-particular-file-extension-to-open-it-by-this-application-e3207/VB/Form1.vb#L21

Try
    richEditControl1.LoadDocument(commandLineArguments(1), DocumentFormat.Rtf)
Catch ex As System.Exception

using-the-search-and-replace-api-functionality-e1677/VB/SearchAndReplaceExample/Form1.vb#L23

InitializeComponent()
richEditControl1.LoadDocument("RichEditAbout.rtf", DocumentFormat.Rtf)

inline-pictures-in-richeditcontrol-e1525/VB/InlinePictures/Form1.vb#L23

    InitializeComponent()
    richEditControl1.LoadDocument("Texts\Lorem.rtf", DocumentFormat.Rtf)
End Sub

how-to-save-the-text-of-a-document-range-in-different-formats-e1604/VB/GetTextMethodsExample/Form1.vb#L15

    InitializeComponent()
    richEditControl.LoadDocument("sample_document.docx", DevExpress.XtraRichEdit.DocumentFormat.OpenXml)
End Sub

how-to-retain-original-image-uri-in-html-document-e3189/VB/HTML_Export_ImageSourceExample/Form1.vb#L55

Private Sub btnSave_Click(ByVal sender As Object, ByVal e As EventArgs) Handles btnSave.Click
    richEditControl1.SaveDocument("test.html", DevExpress.XtraRichEdit.DocumentFormat.Html)
    System.Diagnostics.Process.Start("test.html")