IUriProvider Interface

Defines the provider of the locations for external objects in a document export.

Namespace: DevExpress.Office.Services

Assembly: DevExpress.Office.v18.2.Core.dll

Declaration

C#

[ComVisible(true)]
public interface IUriProvider

VB.NET

<ComVisible(True)>
Public Interface IUriProvider

Remarks

When the document is exported to a format that implies that a part of the document’s content is located externally, such as HTML format, the IUriProvider interface provides Uniform Resource Identifiers (URI) for the external objects. The IUriProvider.CreateCssUri method processes the style information , and the IUriProvider.CreateImageUri processes images.

Tip

The SubDocument.GetHtmlText method has a parameter that is an object with the IUriProvider interface.

Example

This example demonstrates how to use the DocumentImage.Uri property to set the image’s src attribute when a document is saved in HTML format. You can switch on the HtmlDocumentExporterOptions.EmbedImages option to observe that the custom URI provider is idle for emdedded images.

Note

The complete sample project How to retain the original image URI in an HTML document is available in the DevExpress Examples repository.

Form1.cs

using DevExpress.Office.Services;
using DevExpress.XtraRichEdit.API.Native;
using System;
// ...
        private void richEditControl1_DocumentLoaded(object sender, EventArgs e)
        {
            IUriProviderService service = richEditControl1.GetService<IUriProviderService>();
            if (service != null) {
                service.RegisterProvider(new CustomUriProvider());
            }
        }
        private void richEditControl1_ContentChanged(object sender, EventArgs e) {
            ReloadHtml();
        }

        private void ReloadHtml() {
            DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions exportOptions = new DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions();
            exportOptions.EmbedImages = embedImagesCheck.Checked;
            string sText = richEditControl1.Document.GetHtmlText(richEditControl1.Document.Range, new CustomUriProvider(), exportOptions);
            memoEdit1.Text = sText;
        }

CustomUriProvider.cs

using DevExpress.Office.Services;
using DevExpress.Office.Utils;
using System;
// ...
     public class CustomUriProvider : IUriProvider {
        public string CreateCssUri(string rootUri, string styleText, string relativeUri) {
            return String.Empty;
        }

        public string CreateImageUri(string rootUri, OfficeImage image, string relativeUri) {
            return image.Uri;
        }
    }

Form1.vb

Imports DevExpress.Office.Services
Imports DevExpress.XtraRichEdit.API.Native
Imports System
' ...
        Private Sub richEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs) Handles richEditControl1.DocumentLoaded
            Dim service As IUriProviderService = richEditControl1.GetService(Of IUriProviderService)()
            If service IsNot Nothing Then
                service.RegisterProvider(New CustomUriProvider())
            End If
        End Sub

        Private Sub richEditControl1_ContentChanged(ByVal sender As Object, ByVal e As EventArgs)
            ReloadHtml()
        End Sub

        Private Sub ReloadHtml()
            Dim exportOptions As New DevExpress.XtraRichEdit.Export.HtmlDocumentExporterOptions()
            exportOptions.EmbedImages = embedImagesCheck.Checked
            Dim sText As String = richEditControl1.Document.GetHtmlText(richEditControl1.Document.Range, New CustomUriProvider(), exportOptions)
            memoEdit1.Text = sText
        End Sub

CustomUriProvider.vb

Imports DevExpress.Office.Services
Imports DevExpress.Office.Utils
Imports System
' ...
    Public Class CustomUriProvider
        Implements IUriProvider

        Public Function CreateCssUri(ByVal rootUri As String, ByVal styleText As String, ByVal relativeUri As String) As String Implements IUriProvider.CreateCssUri
            Return String.Empty
        End Function

        Public Function CreateImageUri(ByVal rootUri As String, ByVal image As OfficeImage, ByVal relativeUri As String) As String Implements IUriProvider.CreateImageUri
            Return image.Uri
        End Function
    End Class

Related GitHub Examples

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

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#

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/CS/ExportOnlyBodyContent/MyUriProvider.cs#L13

namespace ExportOnlyBodyContent {
    public class MyUriProvider : IUriProvider {
        string rootDirecory;

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

#region #uriprovider
public class CustomUriProvider : DevExpress.Office.Services.IUriProvider
{

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

namespace Retain_Img_Src {
    public class CustomUriProvider : IUriProvider {
        public string CreateCssUri(string rootUri, string styleText, string relativeUri) {

VB.NET

export-to-html-how-to-export-only-body-tag-content-and-specify-the-location-of-css-styles-e1726/VB/ExportOnlyBodyContent/MyUriProvider.vb#L15

Public Class MyUriProvider
    Implements IUriProvider
    Private rootDirecory As String

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

Public Class CustomUriProvider
    Implements DevExpress.Office.Services.IUriProvider

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

Public Class CustomUriProvider
    Implements IUriProvider