DocumentImageSource.FromStream(Stream) Method

Creates an image source object from the specified data stream.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

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.

This example illustrates how to insert inline pictures in a rich text document. The image can be obtained from a file, from a stream or from a URI.

View Example

Program.cs

using System.IO;
using System.Reflection;
using DevExpress.XtraRichEdit;
using DevExpress.XtraRichEdit.API.Native;
RichEditDocumentServer server = new RichEditDocumentServer();

server.LoadDocument("Texts\\InlinePictures.rtf", DocumentFormat.Rtf);
Document doc = server.Document;

// Insert an image from a file.
DocumentRange rangeFound = doc.FindAll("Visual Studio Magazine", SearchOptions.CaseSensitive)[0];
DocumentPosition pos = doc.Paragraphs[doc.Paragraphs.Get(rangeFound.End).Index + 2].Range.Start;
doc.Images.Insert(pos, DocumentImageSource.FromFile("Pictures\\ReadersChoice.png"));

// Insert an image from a stream.
pos = doc.Paragraphs[4].Range.Start;
string imageToInsert = "information.png";
Assembly a = Assembly.GetExecutingAssembly();
Stream imageStream = a.GetManifestResourceStream("InlinePictures.Resources." + imageToInsert);
doc.Images.Insert(pos, DocumentImageSource.FromStream(imageStream));

// Insert an image using its URI.
string imageUri = "http://i.gyazo.com/798a2ed48a3535c6c8add0ea7a4fc4e6.png";
SubDocument docHeader = doc.Sections[0].BeginUpdateHeader();
docHeader.Images.Append(DocumentImageSource.FromUri(imageUri, server));
doc.Sections[0].EndUpdateHeader(docHeader);


// Insert a barcode.
DevExpress.BarCodes.BarCode barCode = new DevExpress.BarCodes.BarCode();
barCode.Symbology = DevExpress.BarCodes.Symbology.QRCode;
barCode.CodeText = "https://www.devexpress.com/";
barCode.CodeBinaryData = System.Text.Encoding.Default.GetBytes(barCode.CodeText);
barCode.Module = 0.5;
SubDocument docFooter = doc.Sections[0].BeginUpdateFooter();
docFooter.Images.Append(barCode.BarCodeImage);
doc.Sections[0].EndUpdateFooter(docFooter);

Program.vb

Imports System.IO
Imports System.Reflection
Imports DevExpress.XtraRichEdit
Imports DevExpress.XtraRichEdit.API.Native
Dim server As New RichEditDocumentServer()
server.LoadDocument("Texts\InlinePictures.rtf", DocumentFormat.Rtf)
Dim doc As Document = server.Document

' Insert an image from a file.
Dim rangeFound As DocumentRange = doc.FindAll("Visual Studio Magazine", SearchOptions.CaseSensitive)(0)
Dim pos As DocumentPosition = doc.Paragraphs(doc.Paragraphs.Get(rangeFound.End).Index + 2).Range.Start
doc.Images.Insert(pos, DocumentImageSource.FromFile("Pictures\ReadersChoice.png"))

' Insert an image from a stream.
pos = doc.Paragraphs(4).Range.Start
Dim imageToInsert As String = "information.png"
Dim a As System.Reflection.Assembly = System.Reflection.Assembly.GetExecutingAssembly()
Dim imageStream As Stream = a.GetManifestResourceStream("Resources." & imageToInsert)
doc.Images.Insert(pos, DocumentImageSource.FromStream(imageStream))

' Insert an image using its URI.
Dim imageUri As String = "http://i.gyazo.com/798a2ed48a3535c6c8add0ea7a4fc4e6.png"
Dim docHeader As SubDocument = doc.Sections(0).BeginUpdateHeader()
docHeader.Images.Append(DocumentImageSource.FromUri(imageUri, server))
doc.Sections(0).EndUpdateHeader(docHeader)


' Insert a barcode.
Dim barCode As New DevExpress.BarCodes.BarCode()
barCode.Symbology = DevExpress.BarCodes.Symbology.QRCode
barCode.CodeText = "https://www.devexpress.com/"
barCode.CodeBinaryData = System.Text.Encoding.Default.GetBytes(barCode.CodeText)
barCode.Module = 0.5
Dim docFooter As SubDocument = doc.Sections(0).BeginUpdateFooter()
docFooter.Images.Append(barCode.BarCodeImage)
doc.Sections(0).EndUpdateFooter(docFooter)

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/CS/DXRichEditControlAPISample/CodeExamples/InlinePicturesActions.cs#L24

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

wpf-richedit-embed-a-live-chart-into-a-document/CS/RichEdit_InsertChart/ChartImage.cs#L194

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

word-document-api-insert-inline-pictures/CS/InlinePictures/Program.cs#L35

 Stream imageStream = a.GetManifestResourceStream("InlinePictures.Resources." + imageToInsert);
Shape imageFromStream =  document.Shapes.InsertPicture(pos, DocumentImageSource.FromStream(imageStream));
 imageFromStream.TextWrapping = TextWrappingType.InLineWithText;

VB.NET

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

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

wpf-richedit-embed-a-live-chart-into-a-document/VB/RichEdit_InsertChart/ChartImage.vb#L201

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

word-document-api-insert-inline-pictures/VB/InlinePictures/Program.vb#L30

Dim imageStream As Stream = a.GetManifestResourceStream("InlinePictures.Resources." & imageToInsert)
Dim imageFromStream As Shape = document.Shapes.InsertPicture(pos, DocumentImageSource.FromStream(imageStream))
imageFromStream.TextWrapping = TextWrappingType.InLineWithText