HtmlDocumentExporterOptions.CssPropertiesExportType Property

Gets or sets how the style sheets properties are exported.

Namespace: DevExpress.XtraRichEdit.Export

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

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

public CssPropertiesExportType CssPropertiesExportType { get; set; }

VB.NET

Public Property CssPropertiesExportType As CssPropertiesExportType

Property Value

Type	Description
CssPropertiesExportType	A CssPropertiesExportType enumeration value specifying the export type.

Available values:

Name	Description
ExportToCurrentFile	Obsolete. Saves style sheets incorporated in the main document.
ExportToSeparateFile	Obsolete. Saves style sheets in a separate CSS file.
Style	CSS is included in a <STYLE> tag.
Link	CSS is included as a link to an external CSS-file.
Inline	CSS is embedded by placing it as an attribute to an HTML tag.

Property Paths

You can access this nested property as listed below:

Object Type	Path to CssPropertiesExportType
RichEditDocumentExportOptions	.Html .CssPropertiesExportType

Remarks

Handle the RichEditControl.BeforeExport or RichEditDocumentServer.BeforeExport event and specify the css export type - that is, the location of stylesheets - via the BeforeExportEventArgs.Options property of the event arguments.

The following code snippet illustrates this:

View Example

C#

private void richEditControl_BeforeExport(object sender, DevExpress.XtraRichEdit.BeforeExportEventArgs e) {
    DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions options = e.Options as DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions;
    if (options != null) 
{
        options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link;
        options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat;
        options.TargetUri = Path.GetFileNameWithoutExtension(this.fileName);
    }
}

VB.NET

Private Sub richEditControl_BeforeExport(ByVal sender As Object, ByVal e As DevExpress.XtraRichEdit.BeforeExportEventArgs)
    Dim options As DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions = TryCast(e.Options, DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions)
    If options IsNot Nothing Then
        options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link
        options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat
        options.TargetUri = Path.GetFileNameWithoutExtension(Me.fileName)
    End If
End Sub

Related GitHub Examples

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

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#

winforms-richedit-export-export-only-body-tag-content-and-specify-location-of-css-styles/CS/ExportOnlyBodyContent/Form1.cs#L118

options.ExportRootTag = htmlExportType;
options.CssPropertiesExportType = cssExportType;
options.TargetUri = Path.GetFileNameWithoutExtension(fileName);

winforms-richedit-save-text-from-a-range-in-different-formats/CS/GetTextMethodsExample/Form1.cs#L250

{
    options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link;
    options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat;

how-to-customize-copy-and-paste-commands/CS/RichEditCustomCopyPaste/CustomCommands.cs#L44

if (exporterOptions != null) {
    exporterOptions.CssPropertiesExportType = CssPropertiesExportType.Inline;
    exporterOptions.ExportRootTag = ExportRootTag.Body;

word-document-api-examples/CS/CodeExamples/ExportActions.cs#L148

{
    options.CssPropertiesExportType = CssPropertiesExportType.Link;
    options.HtmlNumberingListExportFormat = HtmlNumberingListExportFormat.HtmlFormat;

VB.NET

winforms-richedit-export-export-only-body-tag-content-and-specify-location-of-css-styles/VB/ExportOnlyBodyContent/Form1.vb#L122

options.ExportRootTag = htmlExportType
options.CssPropertiesExportType = cssExportType
options.TargetUri = Path.GetFileNameWithoutExtension(fileName)

winforms-richedit-save-text-from-a-range-in-different-formats/VB/GetTextMethodsExample/Form1.vb#L190

If options IsNot Nothing Then
    options.CssPropertiesExportType = DevExpress.XtraRichEdit.Export.Html.CssPropertiesExportType.Link
    options.HtmlNumberingListExportFormat = DevExpress.XtraRichEdit.Export.Html.HtmlNumberingListExportFormat.HtmlFormat

how-to-customize-copy-and-paste-commands/VB/CustomCommands.vb#L45

If exporterOptions IsNot Nothing Then
    exporterOptions.CssPropertiesExportType = CssPropertiesExportType.Inline
    exporterOptions.ExportRootTag = ExportRootTag.Body

word-document-api-examples/VB/CodeExamples/ExportActions.vb#L132

If options IsNot Nothing Then
    options.CssPropertiesExportType = Html.CssPropertiesExportType.Link
    options.HtmlNumberingListExportFormat = Html.HtmlNumberingListExportFormat.HtmlFormat