DataFormatOptions.HtmlImagePath Property

Gets or sets a path to the image files linked as pictures in the copied-and-pasted document content.

Namespace: DevExpress.XtraRichEdit

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

Declaration

C#

[DefaultValue("")]
public string HtmlImagePath { get; set; }

VB.NET

<DefaultValue("")>
Public Property HtmlImagePath As String

Property Value

Type	Default	Description
String	String.Empty	A string that is the valid file path.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to HtmlImagePath
WinForms Controls	SnapControlOptions	.ClipboardFormats.HtmlImagePath
	RichEditControlOptions	.ClipboardFormats.HtmlImagePath
WPF Controls	RichEditControlOptions	.ClipboardFormats.HtmlImagePath
Office File API	RichEditControlOptionsBase	.ClipboardFormats.HtmlImagePath

Remarks

If the DataFormatOptions.AllowHtml setting is true and the DataFormatOptions.HtmlImageSourceType is set to the HtmlImageSourceType.Linked value, the images contained in the copied text are extracted to the path specified by the HtmlImagePath property. Each image file gets a unique name with a trailing sequential number. Links to those images are included in Clipboard’s HTML content.

Note

If the specified path does not exist, it will be created. A pathname should contain a trailing slash.