SftBox/OCX 5.0 - Combo Box Control

SftBoxItem.Image Property

Defines the item graphic displayed in this item.

Syntax

Get

Put

object

A SftBoxItem object.

refImageObj

Defines the item graphic displayed in this item.

Comments

The Image property defines the item graphic displayed in this item.

The Image property is used to override the default item graphic defined using the Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf properties.

In a fixed height combo box control, all item picture graphics (i.e. all bitmaps) must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum required height for all items, so graphics and text are never clipped vertically. To change the size of all item graphics used, they must be removed first using the Items.ClearItemImages method.

In a variable height combo box control, the graphics can be of varying sizes. The item height is automatically adjusted so graphics are never clipped vertically.

To remove an individual item picture, set the property to Nothing (0, null, NULL). If the default item graphics Items.ItemImageExpandable, Items.ItemImageExpanded and Items.ItemImageLeaf have been defined, this restores the default picture.

If the image object refImageObj defines a bitmap, the top, left pixel of the bitmap must contain the bitmap's background color. This color will be replaced throughout the bitmap with the actual background (see Bitmap Transparency).

The VAlignStyle property can be used to define the vertical alignment of item graphics.

Examples

VB.NET

        Img.Appearance = SftPictureImageConstants.sftImageSortAscDisabled
    End Select
End Sub

Private Sub PropagateImage(ByVal ItemIndex As Integer, ByVal Img As SftPictureObject)

    ' don't use images that are too large in the other areas
    If Img.ActualHeight <= 20 And Img.ActualWidth < 20 Then
        AxSftBox1.get_Item(ItemIndex).Image = Img
        AxSftBox1.get_Item(ItemIndex).LabelImage = Img
        AxSftBox1.get_Item(ItemIndex).RowHeader.Image = Img
    End If
End Sub

Private Sub UpdateImages(ByVal ItemIndex As Integer, ByVal Img As Image, ByVal Align As SftBoxHAlignConstants)
    Dim C As SftBoxCell

View Entire Sample Code

VB6

    Case Else
        ' nothing
    End Select
End Sub

Private Sub PropagateImage(ByVal ItemIndex As Integer, Img As SftPictureObject)
    ' don't use images that are too large in the other areas
    If Img.ActualHeight <= 20 And Img.ActualWidth < 20 Then
        SftBox1.Item(ItemIndex).Image = Img
        SftBox1.Item(ItemIndex).LabelImage = Img
        SftBox1.Item(ItemIndex).RowHeader.Image = Img
    End If
End Sub

Private Sub UpdatePictures(ByVal ItemIndex As Integer, ByVal Pic As StdPicture, ByVal Align As SftBoxHAlignConstants)
    Dim C As SftBoxCell

View Entire Sample Code

C#

        break;
    }
}

private void PropagateImage(int ItemIndex, SftPictureObject Img)
{
    // don't use images that are too large in the other areas
    if (Img.ActualHeight <= 20 && Img.ActualWidth < 20) {
        axSftBox1.get_Item(ItemIndex).Image = Img;
        axSftBox1.get_Item(ItemIndex).LabelImage = Img;
        axSftBox1.get_Item(ItemIndex).RowHeader.Image = Img;
    }
}

private void UpdateImages(int ItemIndex, System.Drawing.Image img, SftBoxHAlignConstants Align)
{

View Entire Sample Code

C++

    return TRUE;  // return TRUE  unless you set the focus to a control
}

void CPicturesDlg::PropagateImage(long ItemIndex, ISftPictureObjectPtr Img)
{
    // don't use images that are too large in the other areas
    if (Img->ActualHeight <= 20 && Img->ActualWidth < 20) {
        m_vBox->Item[ItemIndex]->Image = Img;
        m_vBox->Item[ItemIndex]->LabelImage = Img;
        m_vBox->Item[ItemIndex]->RowHeader->Image = Img;
    }
}

void CPicturesDlg::UpdateBitmap(long ItemIndex, const CBitmap& bmp, SftBoxHAlignConstants Align)
{
    ISftBoxCellPtr C = m_vBox->Cell[ItemIndex][0];

View Entire Sample Code

See Also SftBoxItem Object | Object Hierarchy