HeaderPane
Main
Hide
Share Link
Print

Header Property, SftTree Object

Returns a SftTreeHeader object for a given column.

Syntax

Get

C#SftTreeHeader refHeaderObj = object.get_Header(short ColIndex);
VB.NETrefHeaderObj = object.Header(ByVal ColIndex As Short) As SftTreeHeader
C++ISftTreeHeader* refHeaderObj = object->Header[short ColIndex];
ISftTreeHeader* refHeaderObj = object->GetHeader(short ColIndex);
CHRESULT object->get_Header(short ColIndex, ISftTreeHeader** refHeaderObj);
VBSet refHeaderObj = object.Header(ByVal ColIndex As Integer) As SftTreeHeader

object

A SftTree object.

ColIndex

The zero-based column number.

refHeaderObj

Returns a SftTreeHeader object for a given column.

Comments

The Header property returns a SftTreeHeader object for a given column.

The SftTreeHeader object represents one column header in a SftTree/OCX control. Numerous header-specific properties and methods can be accessed using the returned object refHeaderObj.

Certain default properties and behavior for all column headers can be defined using the SftTreeHeaders object.

Examples

C# View entire sample code

            itemIndex = axSftTree1.Items.Current;
            if (itemIndex < 0)
                return;

            // don't use images that are too large in the other areas
            img = axSftTree1.get_Cell(itemIndex, 0).Image;
            if (img.ActualHeight <= 20 && img.ActualWidth <= 20) {
                axSftTree1.RowColumnHeader.Image = img;
                axSftTree1.get_Header(1).Image = img;
            } else {
                axSftTree1.RowColumnHeader.Image.Clear();
                axSftTree1.get_Header(1).Image.Clear();
            }
        }

        private void ToggleImage(SftPictureObject img)

VB.NET View entire sample code

        ItemIndex = AxSftTree1.Items.Current
        If ItemIndex < 0 Then Exit Sub

        ' don't use images that are too large in the other areas
        Img = AxSftTree1.get_Cell(ItemIndex, 0).Image
        If Img.ActualHeight <= 20 And Img.ActualWidth <= 20 Then
            AxSftTree1.RowColumnHeader.Image = Img
            AxSftTree1.get_Header(1).Image = Img
        Else
            AxSftTree1.RowColumnHeader.Image.Clear()
            AxSftTree1.get_Header(1).Image.Clear()
        End If
    End Sub

    Private Sub ToggleImage(ByVal Img As SftPictureObject)

C++ View entire sample code

{
    long ItemIndex = m_vTree->Items->Current;
    if (ItemIndex < 0) return;
    
    // don't use images that are too large in the other areas
    ISftPictureObjectPtr pImg = m_vTree->Cell[ItemIndex][0]->Image;
    if (pImg->ActualHeight <= 20 && pImg->ActualWidth <= 20) {
        m_vTree->RowColumnHeader->Image = pImg;
        m_vTree->Header[1]->Image = pImg;
    } else {
        m_vTree->RowColumnHeader->Image->Clear();
        m_vTree->Header[1]->Image->Clear();
    }
}
    
void CPicturesDlg::OnItemClickSftTree1(long ItemIndex, short ColIndex, short AreaType, short Button, short Shift) 

VB6 View entire sample code

    ItemIndex = SftTree1.Items.Current
    If ItemIndex < 0 Then Exit Sub
    
    ' don't use images that are too large in the other areas
    Set Img = SftTree1.Cell(ItemIndex, 0).Image
    If Img.ActualHeight <= 20 And Img.ActualWidth <= 20 Then
        SftTree1.RowColumnHeader.Image = Img
        SftTree1.Header(1).Image = Img
    Else
        SftTree1.RowColumnHeader.Image.Clear
        SftTree1.Header(1).Image.Clear
    End If
    
End Sub
    
Private Sub ToggleImage(Img As SftPictureObject)

See Also SftTree Object | Object Hierarchy


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