Spread Windows Forms 16
Spread Windows Forms 16.0 Product Documentation / Developer's Guide / Cell Types / Working with Graphical Cell Types / Setting an Image Cell
In This Topic
    Setting an Image Cell
    In This Topic

    You can display a graphic image in a cell using the image cell type. An image cell shows an image as data. If the data type for a bound column is a bit array then the default cell type for that bound column would be an image cell type.

    An image object can be assigned to the Value property of a cell. The image or serialized image object must be in the data model.

    To create a cell that contains an image, use the ImageCellType class. Create an image cell using the following procedure. The result is shown in this figure.

    Image Cell Type Example

    Notice that both cells have a magenta background, but the one with the image only shows the magenta through the transparent areas specified by the transparency color property and the transparency tolerance property. The image is mostly white so blocks out most of the magenta. The lettering that is more blue is beyond the tolerance and so is not transparent. When you set a transparency color, the background behind the picture shows through in the area that originally had the color you specify. Setting the transparency tolerance to 255 will cause everything to be transparent so you may wish to use a value less than 255.

    For more information on the properties and methods of this cell type, refer to the ImageCellType class.

    Using the Properties Window

    1. At design time, in the Properties window, select the Spread component.
    2. Select the Sheets property.
    3. Click the button to display the SheetView Collection Editor.
    4. In the Members list, select the sheet in which the cells appear.
    5. In the property list, select the Cells property and then click the button to display the Cell, Column, and Row Editor.
    6. Select the cells for which you want to set the cell type.
    7. In the property list, select the CellType property and choose the Image cell type.
    8. Expand the list of properties under the CellType property. Select and set these specific properties as needed.
    9. Click OK to close the Cell, Column, and Row Editor.
    10. Click OK to close the SheetView Collection Editor.

    Using Code

    1. Define the image cell by creating an instance of the ImageCellType class.
    2. Create the image.
    3. Specify what appears in the cell by setting the Value property for the ImageCellType object.
    4. Specify the appearance of the image by setting properties such as Style.
    5. Assign the image cell type to a cell or range of cells by setting the CellType property for a cell, column, row, or style to the ImageCellType object.


    This example sets the properties of an image cell type then loads a logo image into a cell using the Value property. With background color set, the use of transparency can be seen.

    Copy Code
    FarPoint.Win.Spread.CellType.ImageCellType imgct = new FarPoint.Win.Spread.CellType.ImageCellType();
    System.Drawing.Image image = System.Drawing.Image.FromFile("D:\\Logos\\logo.jpg");
    imgct.Style = FarPoint.Win.RenderStyle.Stretch;
    imgct.TransparencyColor = Color.Black;
    imgct.TransparencyTolerance = 20;
    fpSpread1.Sheets[0].Cells[1,1,1,2].BackColor = Color.Magenta;
    fpSpread1.Sheets[0].Columns[1,2].Width = 100;
    fpSpread1.Sheets[0].Rows[1,1].Height = 50;
    fpSpread1.Sheets[0].Cells[1,1,2,2].CellType = imgct;
    fpSpread1.Sheets[0].Cells[1,1].Value = image;
    Copy Code
    Dim imgct As New FarPoint.Win.Spread.CellType.ImageCellType()
    Dim image As System.Drawing.Image = System.Drawing.Image.FromFile("D:\Logos\logo.jpg")
    imgct.Style = FarPoint.Win.RenderStyle.Stretch
    imgct.TransparencyColor = Color.Black
    imgct.TransparencyTolerance = 20
    fpSpread1.Sheets(0).Cells(1,1,1,2).BackColor = Color.Magenta
    fpSpread1.Sheets(0).Columns(1,2).Width =100
    fpSpread1.Sheets(0).Rows(1,1).Height = 50
    fpSpread1.Sheets(0).Cells(1,1,2,2).CellType = imgct
    fpSpread1.Sheets(0).Cells(1, 1).Value = image

    When loading multiple images in image cell types, you can directly assign the image file paths in cell values. This improves the memory management and Spread's performance. The below image shows multiple images added into the image cell types.


    This example loads multiple images into image cell types by assigning the image file paths in the Value property.

    Copy Code
    FarPoint.Win.Spread.CellType.ImageCellType imgct = new FarPoint.Win.Spread.CellType.ImageCellType();
    imgct.Style = FarPoint.Win.RenderStyle.Stretch;
    imgct.TransparencyColor = System.Drawing.Color.Black;
    imgct.TransparencyTolerance = 20;
    fpSpread1.Sheets[0].Columns[1, 3].Width = 100;
    fpSpread1.Sheets[0].Rows[1, 2].Height = 70;
    fpSpread1.Sheets[0].Cells[1, 1, 3, 3].CellType = imgct;
    fpSpread1.Sheets[0].Cells[1, 1].Value = "D:\\Logos\\Spread.png";
    fpSpread1.Sheets[0].Cells[1, 2].Value = "D:\\Logos\\Mescius.png";
    fpSpread1.Sheets[0].Cells[1, 3].Value = "D:\\Logos\\ActiveReports.png";
    fpSpread1.Sheets[0].Cells[2, 1].Value = "D:\\Logos\\ComponentOne.png";
    fpSpread1.Sheets[0].Cells[2, 2].Value = "D:\\Logos\\DocSol.png";
    fpSpread1.Sheets[0].Cells[2, 3].Value = "D:\\Logos\\Wijmo.png";
    Copy Code
    Dim imgct As FarPoint.Win.Spread.CellType.ImageCellType = New FarPoint.Win.Spread.CellType.ImageCellType()
    imgct.Style = FarPoint.Win.RenderStyle.Stretch
    imgct.TransparencyColor = System.Drawing.Color.Black
    imgct.TransparencyTolerance = 20
    fpSpread1.Sheets(0).Columns(1, 3).Width = 100
    fpSpread1.Sheets(0).Rows(1, 2).Height = 70
    fpSpread1.Sheets(0).Cells(1, 1, 3, 3).CellType = imgct
    fpSpread1.Sheets(0).Cells(1, 1).Value = "D:\Logos\Spread.png"
    fpSpread1.Sheets(0).Cells(1, 2).Value = "D:\Logos\Mescius.png"
    fpSpread1.Sheets(0).Cells(1, 3).Value = "D:\Logos\ActiveReports.png"
    fpSpread1.Sheets(0).Cells(2, 1).Value = "D:\Logos\ComponentOne.png"
    fpSpread1.Sheets(0).Cells(2, 2).Value = "D:\Logos\DocSol.png"
    fpSpread1.Sheets(0).Cells(2, 3).Value = "D:\Logos\Wijmo.png"

     Using the Spread Designer

    1. Select the cell or cells in the work area.
    2. In the property list, in the Misc category, select CellType. From the drop-down list, choose the Image cell type. Now expand the CellType property and various properties are available that are specific to this cell type. Select and set those properties as needed.

      Or right-click on the cell or cells and select Cell Type. From the list, select Image. In the CellType editor, set the properties you need. Click Apply.

    3. From the File menu choose Apply and Exit to apply your changes to the component and exit Spread Designer.
    See Also