IUriProviderService Interface

Represents a service that calls the registered IUriProvider interface when required.

Namespace: DevExpress.Office.Services

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

Declaration

C#

[ComVisible(true)]
public interface IUriProviderService

VB.NET

<ComVisible(True)>
Public Interface IUriProviderService

Remarks

To be able to specify custom locations for exported images and styles, you should create a class that implements the IUriProvider interface and register it via the IUriProviderService.RegisterProvider method.

Tip

A complete sample project is available in the DevExpress Code Examples database at http://www.devexpress.com/example=E1726.

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 IUriProviderService 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/Form1.cs#L105

    return;
IUriProviderService svc = (IUriProviderService) richEditControl1.GetService(typeof(IUriProviderService));
svc.RegisterProvider(new MyUriProvider(Path.GetDirectoryName(fileName)));

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

{
    IUriProviderService service = richEditControl1.GetService<IUriProviderService>();
    if (service != null)

VB.NET

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

End If
Dim svc As IUriProviderService = CType(richEditControl1.GetService(GetType(IUriProviderService)), IUriProviderService)
svc.RegisterProvider(New MyUriProvider(Path.GetDirectoryName(fileName)))

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

Private Sub richEditControl1_DocumentLoaded(ByVal sender As Object, ByVal e As EventArgs)
    Dim service As IUriProviderService = richEditControl1.GetService(Of IUriProviderService)()
    If service IsNot Nothing Then