DocumentImageSource.FromStream(Stream) Method

Creates an image source object from the specified data stream.

Namespace: DevExpress.XtraRichEdit.API.Native

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

Declaration

C#

[ComVisible(false)]
public static DocumentImageSource FromStream(
    Stream stream
)

VB.NET

<ComVisible(False)>
Public Shared Function FromStream(
    stream As Stream
) As DocumentImageSource

Parameters

Name	Type	Description
stream	Stream	A Stream containing image data.

Returns

Type	Description
DocumentImageSource	A DocumentImageSource object representing the image in the document.

Remarks

The following code sample illustrates how the FromStream can be used to insert an image at the cursor position from the data stream.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/inline-pictures-in-richeditcontrol-e1525

Form1.vb

Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
' ...
Dim pos As DocumentPosition = richEditControl1.Document.CaretPosition
Dim imageToInsert As String = "information.png"
Dim a As System.Reflection.Assembly = System.Reflection.Assembly.GetExecutingAssembly()
Dim imageStream As Stream = a.GetManifestResourceStream(imageToInsert)
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromStream(imageStream))

Form1.cs

using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
// ...
DocumentPosition pos = richEditControl1.Document.CaretPosition;
string imageToInsert = "information.png";
Assembly a = Assembly.GetExecutingAssembly();

Stream imageStream = a.GetManifestResourceStream("InlinePictures.Resources." + imageToInsert);
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromStream(imageStream));

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FromStream(Stream) method.

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#

wpf-richedit-document-api-t213968/CS/DXRichEditControlAPISample/CodeExamples/InlinePicturesActions.cs#L24

{
    document.Images.Insert(pos, DocumentImageSource.FromStream(s));
}

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

Stream imageStream = a.GetManifestResourceStream("InlinePictures.Resources." + imageToInsert);
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromStream(imageStream));
#endregion #fromstream

how-to-embed-a-live-chart-into-a-document-using-a-docvariable-field-e3914/CS/RichEdit_InsertChart/ChartImage.cs#L194

{
    return DocumentImageSource.FromStream(CreateChart());
}

VB.NET

wpf-richedit-document-api-t213968/VB/DXRichEditControlAPISample/CodeExamples/InlinePicturesActions.vb#L19

Using s As Stream = streamResInfo.Stream
    document.Images.Insert(pos, DocumentImageSource.FromStream(s))
End Using

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

Dim imageStream As Stream = a.GetManifestResourceStream(imageToInsert)
richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromStream(imageStream))
'#End Region ' #fromstream

how-to-embed-a-live-chart-into-a-document-using-a-docvariable-field-e3914/VB/RichEdit_InsertChart/ChartImage.vb#L201

Public Function CreateImage() As DocumentImageSource
    Return DocumentImageSource.FromStream(CreateChart())
End Function