HeaderPane
Main
Hide
Share Link
Print

LabelImage Property, SftTreeItem Object

Defines the label graphic displayed in this item.

Syntax

Get

C#SftPictureObject refImageObj = object.LabelImage;
VB.NETrefImageObj = object.LabelImage As SftPictureObject
C++ISftPictureObject* refImageObj = object->LabelImage;
ISftPictureObject* refImageObj = object->GetLabelImage();
CHRESULT object->get_LabelImage(ISftPictureObject** refImageObj);
VBSet refImageObj = object.LabelImage As SftPictureObject

Put

C#SftPictureObject object.LabelImage = refImageObj;
VB.NETobject.LabelImage = refImageObj As SftPictureObject
C++ISftPictureObject* object->LabelImage = refImageObj;
void object->PutLabelImage(ISftPictureObject* refImageObj);
CHRESULT object->put_LabelImage(ISftPictureObject* refImageObj);
VBobject.LabelImage = refImageObj As SftPictureObject

object

A SftTreeItem object.

refImageObj

Defines the label graphic displayed in this item.

Comments

The LabelImage property defines the label graphic displayed in this item.

When using fixed height items (see Items.Style), all graphics used in a tree control as LabelImage property at the same time must be the same size (height and width). The dimensions of the graphics are used to calculate the minimum dimension for all items, so graphics used as LabelImage property are never clipped vertically. To change the label graphic size, all label graphics must be removed first using the Items.ClearLabelImages method.

When using variable height items (see Items.Style), the graphics used can be of varying size. The item height is adjusted automatically, so graphics are never clipped vertically.

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 Items.ClearLabelImages method can be used to remove all label graphics. The LabelImage property can be set to the value Nothing (NULL), which removes the graphic from the item.

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

Examples

C# View entire sample code

            }
        }

        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) {
                axSftTree1.get_Item(itemIndex).Image = img;
                axSftTree1.get_Item(itemIndex).LabelImage = img;
                axSftTree1.get_Item(itemIndex).RowHeader.Image = img;
            }
        }

        private void UpdatePictures(int itemIndex, stdole.IPictureDisp iPic, SftTreeHAlignConstants align)
        {
            SftTreeCell c = axSftTree1.get_Cell(itemIndex, 0);

VB.NET View entire sample code

        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
            AxSftTree1.get_Item(ItemIndex).Image = Img
            AxSftTree1.get_Item(ItemIndex).LabelImage = Img
            AxSftTree1.get_Item(ItemIndex).RowHeader.Image = Img
        End If
    End Sub

    Private Sub UpdatePictures(ByVal ItemIndex As Integer, ByVal IPic As stdole.IPictureDisp, ByVal Align As SftTreeHAlignConstants)
        Dim C As SftTreeCell
        C = AxSftTree1.get_Cell(ItemIndex, 0)

C++ View entire sample code

        m_Tree.MoveWindow(0, 0, cx, cy);
}

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_vTree->Item[ItemIndex]->Image = Img;
        m_vTree->Item[ItemIndex]->LabelImage = Img;
        m_vTree->Item[ItemIndex]->RowHeader->Image = Img;
    }
}

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

VB6 View entire sample code

        ' 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
        SftTree1.Item(ItemIndex).Image = Img
        SftTree1.Item(ItemIndex).LabelImage = Img
        SftTree1.Item(ItemIndex).RowHeader.Image = Img
    End If
End Sub

Private Sub UpdatePictures(ByVal ItemIndex As Integer, ByVal Pic As StdPicture, ByVal Align As SftTreeHAlignConstants)
    Dim C As SftTreeCell
    Set C = SftTree1.Cell(ItemIndex, 0)

See Also SftTreeItem Object | Object Hierarchy


Last Updated 11/03/2026 - (email)
© 2026 Softel vdm, Inc.