Picture Interface

An image embedded in a worksheet.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v17.2.Core.dll

Declaration

C#

public interface Picture :
    Shape,
    FloatingObject

VB.NET

Public Interface Picture
    Inherits Shape,
             FloatingObject

Related API Members

The following members accept/return Picture objects:

Show 22 links

Library	Related API Members
Cross-Platform Class Library	PictureCollection.AddPicture(Image, Cell)
	PictureCollection.AddPicture(Image, Range)
	PictureCollection.AddPicture(Image, Range, Boolean)
	PictureCollection.AddPicture(Image, Single, Single)
	PictureCollection.AddPicture(Image, Single, Single, Single, Single)
	PictureCollection.AddPicture(Image, Single, Single, Single, Single, Boolean)
	PictureCollection.AddPicture(SpreadsheetImageSource, Cell)
	PictureCollection.AddPicture(SpreadsheetImageSource, Range)
	PictureCollection.AddPicture(SpreadsheetImageSource, Range, Boolean)
	PictureCollection.AddPicture(SpreadsheetImageSource, Single, Single)
	PictureCollection.AddPicture(SpreadsheetImageSource, Single, Single, Single, Single)
	PictureCollection.AddPicture(SpreadsheetImageSource, Single, Single, Single, Single, Boolean)
	PictureCollection.AddPicture(String, Cell)
	PictureCollection.AddPicture(String, Range)
	PictureCollection.AddPicture(String, Range, Boolean)
	PictureCollection.AddPicture(String, Single, Single)
	PictureCollection.AddPicture(String, Single, Single, Single, Single)
	PictureCollection.AddPicture(String, Single, Single, Single, Single, Boolean)
	PictureCollection.GetPictureById(Int32)
	Worksheet.SelectedPicture
WinForms Controls	SpreadsheetControl.SelectedPicture
WPF Controls	SpreadsheetControl.SelectedPicture

Remarks

Use the PictureCollection.AddPicture method to insert an image in a worksheet. All pictures in a worksheet are contained within the PictureCollection accessible via the Worksheet.Pictures method. Each picture is assigned a default name (Picture0, Picture1 etc.) when you add it to the Shapes collection. To give the picture a more meaningful name, use the Shape.Name property.

To obtain a picture from a collection, use either the PictureCollection.GetPictureById, or the PictureCollection.GetPicturesByName method.

A Picture object possesses the functionality of a Shape object, and provides you with characteristics of an original image, such as Picture.OriginalHeight, Picture.OriginalWidth, Picture.ImageFormat.

Related GitHub Examples

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

winforms-spreadsheetcontrol-api-part-2-e4832/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/PictureActions.cs#L47

// Find the Picture by its name. The method returns a collection of Pictures with the same name.
Picture pic = worksheet.Pictures.GetPicturesByName("Picture 4")[0];
pic.Delete();

spreadsheet-document-api-examples-part-2-t217615/CS/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.cs#L28

// Find the shape by its name. The method returns a collection of shapes with the same name.
Picture picShape = worksheet.Pictures.GetPicturesByName("Picture 3")[0];
picShape.Delete();

wpf-spreadsheetcontrol-api-part-2-e4944/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/ShapeActions.cs#L88

// Insert pictures from the file.
Picture pic = worksheet.Pictures.AddPicture("Pictures\\chart.png", worksheet.Cells["A1"]);
worksheet.Pictures.AddPicture("Pictures\\candles.png", worksheet.Cells["D5"]);

snap-report-api-how-to-bind-a-snap-report-to-worksheet-data-and-export-it-to-pdf-t518437/CS/SnapAndSpreadsheetDocumentServerExample/XPictureProvider.cs#L32

Dictionary<string, Bitmap> employeePictures = new Dictionary<string, System.Drawing.Bitmap>();
foreach (Picture pic in sheet.Pictures) {
    employeePictures.Add(pic.Name, new Bitmap(new MemoryStream(pic.Image.GetImageBytes(OfficeImageFormat.Bmp))));

spreadsheet-document-api-how-to-use-a-worksheet-as-a-data-source-for-the-snap-report-t518070/CS/SpreadsheetDocumentServerAsDataSourceExample/MyPictureProvider.cs#L32

Dictionary<string, Bitmap> employeePictures = new Dictionary<string, System.Drawing.Bitmap>();
foreach (Picture pic in sheet.Pictures) {
    employeePictures.Add(pic.Name, new Bitmap(new MemoryStream(pic.Image.GetImageBytes(OfficeImageFormat.Bmp))));

VB.NET

winforms-spreadsheetcontrol-api-part-2-e4832/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/PictureActions.vb#L48

' Find the Picture by its name. The method returns a collection of Pictures with the same name.
Dim pic As Picture = worksheet.Pictures.GetPicturesByName("Picture 4")(0)
pic.Delete()

spreadsheet-document-api-examples-part-2-t217615/VB/SpreadsheetDocServerAPIPart2/CodeExamples/PictureActions.vb#L28

' Find the shape by its name. The method returns a collection of shapes with the same name.
Dim picShape As Picture = worksheet.Pictures.GetPicturesByName("Picture 3")(0)
picShape.Delete()

wpf-spreadsheetcontrol-api-part-2-e4944/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/ShapeActions.vb#L81

' Insert pictures from the file.
Dim pic As Picture = worksheet.Pictures.AddPicture("Pictures\chart.png", worksheet.Cells("A1"))
worksheet.Pictures.AddPicture("Pictures\candles.png", worksheet.Cells("D5"))

snap-report-api-how-to-bind-a-snap-report-to-worksheet-data-and-export-it-to-pdf-t518437/VB/SnapAndSpreadsheetDocumentServerExample/XPictureProvider.vb#L35

Dim employeePictures As Dictionary(Of String, Bitmap) = New Dictionary(Of String, System.Drawing.Bitmap)()
For Each pic As Picture In sheet.Pictures
    employeePictures.Add(pic.Name, New Bitmap(New MemoryStream(pic.Image.GetImageBytes(OfficeImageFormat.Bmp))))

spreadsheet-document-api-how-to-use-a-worksheet-as-a-data-source-for-the-snap-report-t518070/VB/SpreadsheetDocumentServerAsDataSourceExample/MyPictureProvider.vb#L35

Dim employeePictures As Dictionary(Of String, Bitmap) = New Dictionary(Of String, System.Drawing.Bitmap)()
For Each pic As Picture In sheet.Pictures
    employeePictures.Add(pic.Name, New Bitmap(New MemoryStream(pic.Image.GetImageBytes(OfficeImageFormat.Bmp))))