Hide

SftTree/OCX 7.5 - ActiveX Tree Control

Display
Print

LabelImage Property, SftTreeItem Object

Defines the label graphic displayed in this item.

Syntax

Get

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

Put

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

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

VB.NET

        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)

VB6

        ' 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)

C#

            }
        }

        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);

C++

        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];

See Also SftTreeItem Object | Object Hierarchy


Last Updated 08/13/2020 - (email)
© 2022 Softel vdm, Inc.