DocumentImageSource.FromFile(String) Method

Creates an image source object from the specified file.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v19.1.Core.dll

Declaration

C#

[ComVisible(false)]
public static DocumentImageSource FromFile(
    string fileName
)

VB.NET

<ComVisible(False)>
Public Shared Function FromFile(
    fileName As String
) As DocumentImageSource

Parameters

Name	Type	Description
fileName	String	A string that contains the name of the file from which to create the image.

Returns

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

Remarks

The following code sample demonstrates how the FromFile method can be used to insert an image at the cursor position in the document.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/word-processing-document-api-examples-t418535

InlinePictureActions.cs

Document document = server.Document;
DocumentPosition pos = document.Range.Start;
document.Images.Insert(pos, DocumentImageSource.FromFile("Documents\\beverages.png"));

InlinePictureActions.vb

Dim document As Document = server.Document
Dim pos As DocumentPosition = document.Range.Start
document.Images.Insert(pos, DocumentImageSource.FromFile("Documents\beverages.png"))

Note

When you use the FromFile method to create an image, the method locks the file until the application is closed. This happens because the method internally creates a file stream intended to load the image from the file, which is not disposed of together with the RichEditDocumentServer/RichEditControl instance and stays alive until you close the application.

If you require releasing the file while the program is running, you can use the DocumentImageSource.FromStream method to create an image and close the stream manually after the image is inserted into the document.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FromFile(String) 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#

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

    richEditControl1.Document.Images.Insert(pos,
        DocumentImageSource.FromFile(imageToInsert));
}

tables-simple-example-t472346/CS/TablesSimpleExample/Form1.cs#L104

//Insert the customer photo
document.Images.Insert(table[3, 0].Range.Start, DocumentImageSource.FromFile("photo.png"));

winforms-richedit-document-api-e5219/CS/RichEditAPISample/CodeExamples/InlinePictures.cs#L16

DocumentPosition pos = document.Range.Start;
document.Images.Insert(pos, DocumentImageSource.FromFile("beverages.png"));
#endregion #ImageFromFile

word-document-api-examples/CS/CodeExamples/InlinePictureActions.cs#L18

DocumentPosition pos = document.Range.Start;
document.Images.Insert(pos, DocumentImageSource.FromFile("Documents\\beverages.png"));
#endregion #ImageFromFile

word-document-api-table-examples/CS/TablesSimpleExample/Program.cs#L84

//Insert the customer photo
document.Images.Insert(table[3, 0].Range.Start, DocumentImageSource.FromFile("photo.png"));

VB.NET

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

    Dim imageToInsert As String = dialog.FileName
    richEditControl1.Document.Images.Insert(pos, DocumentImageSource.FromFile(imageToInsert))
End If

tables-simple-example-t472346/VB/TablesSimpleExample/Form1.vb#L98

'Insert the customer photo
document.Images.Insert(table(3, 0).Range.Start, DocumentImageSource.FromFile("photo.png"))

winforms-richedit-document-api-e5219/VB/RichEditAPISample/CodeExamples/InlinePictures.vb#L13

            Dim pos As DocumentPosition = document.Range.Start
            document.Images.Insert(pos, DocumentImageSource.FromFile("beverages.png"))
'            #End Region ' #ImageFromFile

word-document-api-examples/VB/CodeExamples/InlinePictureActions.vb#L15

            Dim pos As DocumentPosition = document.Range.Start
            document.Images.Insert(pos, DocumentImageSource.FromFile("Documents\beverages.png"))
'            #End Region ' #ImageFromFile

word-document-api-table-examples/VB/TablesSimpleExample/Program.vb#L66

'Insert the customer photo
document.Images.Insert(table(3, 0).Range.Start, DocumentImageSource.FromFile("photo.png"))
'Insert the customer info