SftTree/OCX 7.5 - ActiveX Tree Control

ProgressColorEnd Property, SftTreeCell Object

Defines the progress bar color used for this cell, combined with ProgressColor creating a gradient fill.

Syntax

Get

VB.NET	Clr = object.ProgressColorEnd As UInteger
VB	Clr = object.ProgressColorEnd As OLE_COLOR
C#.NET	uint Clr = object.ProgressColorEnd;
VC++	OLE_COLOR Clr = object->ProgressColorEnd; OLE_COLOR Clr = object->GetProgressColorEnd();
C	HRESULT object->get_ProgressColorEnd(OLE_COLOR* Clr);

Put

VB.NET	object.ProgressColorEnd = Clr As UInteger
VB	object.ProgressColorEnd = Clr As OLE_COLOR
C#.NET	uint object.ProgressColorEnd = Clr;
VC++	OLE_COLOR object->ProgressColorEnd = Clr; void object->PutProgressColorEnd(OLE_COLOR Clr);
C	HRESULT object->put_ProgressColorEnd(OLE_COLOR Clr);

object

A SftTreeCell object.

Clr

Defines the progress bar color used for this cell, combined with ProgressColor creating a gradient fill. -1 indicates that there is no defined color and the default colors are used. For information about color properties, please visit the applicable section "Using SftTree/OCX with ...".

Comments

The ProgressColorEnd property defines the progress bar color used for this cell, combined with Cell.ProgressColor creating a gradient fill.

The ProgressColorEnd property combined with Cell.ProgressColor can be used to define a gradient fill for the progress bar. The orientation of the gradient fill can be defined using the Cell.ProgressColorOrientation property. If Cell.ProgressColor is not defined, ProgressColorEnd is ignored and has no effect.

A progress bar is only shown for the cell if its Cell.ProgressMax property is set to a value other than 0.

Examples

VB.NET

        AxSftTree1.get_Cell(I, 0).ProgressMax = 200  ' maximum value 0-200
        AxSftTree1.get_Cell(I, 0).ProgressValue = 33 ' current value

        I = AxSftTree1.Items.Add("Progress Bar - with gradient fill")
        AxSftTree1.get_Item(I).Level = 1
        AxSftTree1.get_Cell(I, 0).ProgressColorOrientation = SftTreeOrientationDefaultConstants.horizontalDefaultOrientationSftTree
        AxSftTree1.get_Cell(I, 0).ProgressStyle = SftTreeProgressStyleDefaultConstants.smallDefaultProgressStyleSftTree
        AxSftTree1.get_Cell(I, 0).ProgressColor = Convert.ToUInt32(ColorTranslator.ToOle(Color.FromArgb(128, 128, 0)) And &HFFFFFFFF&)
        AxSftTree1.get_Cell(I, 0).ProgressColorEnd = Convert.ToUInt32(ColorTranslator.ToOle(Color.FromArgb(255, 255, 0)) And &HFFFFFFFF&)
        AxSftTree1.get_Cell(I, 0).ProgressMax = 50   ' maximum value 0-50
        AxSftTree1.get_Cell(I, 0).ProgressValue = 40 ' current value

        I = AxSftTree1.Items.Add("Progress Bar - customizable colors")
        AxSftTree1.get_Item(I).Level = 1
        AxSftTree1.get_Cell(I, 0).ProgressColorOrientation = SftTreeOrientationDefaultConstants.verticalDefaultOrientationSftTree
        AxSftTree1.get_Cell(I, 0).ProgressStyle = SftTreeProgressStyleDefaultConstants.smallDefaultProgressStyleSftTree

View Entire Sample Code

VB6

        .Cell(I, 0).ProgressMax = 200    ' maximum value 0-200
        .Cell(I, 0).ProgressValue = 33   ' current value

        I = .Items.Add("Progress Bar - with gradient fill")
        .Item(I).Level = 1
        .Cell(I, 0).ProgressColorOrientation = horizontalDefaultOrientationSftTree
        .Cell(I, 0).ProgressStyle = smallDefaultProgressStyleSftTree
        .Cell(I, 0).ProgressColor = &H8080&
        .Cell(I, 0).ProgressColorEnd = &HFFFF&
        .Cell(I, 0).ProgressMax = 50     ' maximum value 0-50
        .Cell(I, 0).ProgressValue = 40   ' current value

        I = .Items.Add("Progress Bar - customizable colors")
        .Item(I).Level = 1
        Dim cellObj As SftTreeCell
        Set cellObj = .Cell(I, 0)

View Entire Sample Code

C#

            axSftTree1.get_Cell(I, 0).ProgressMax = 200;  // maximum value 0-200
            axSftTree1.get_Cell(I, 0).ProgressValue = 33; // current value

            I = axSftTree1.Items.Add("Progress Bar - with gradient fill");
            axSftTree1.get_Item(I).Level = 1;
            axSftTree1.get_Cell(I, 0).ProgressColorOrientation = SftTreeOrientationDefaultConstants.horizontalDefaultOrientationSftTree;
            axSftTree1.get_Cell(I, 0).ProgressStyle = SftTreeProgressStyleDefaultConstants.smallDefaultProgressStyleSftTree;
            axSftTree1.get_Cell(I, 0).ProgressColor = (uint) ColorTranslator.ToOle(Color.FromArgb(128, 128, 0));
            axSftTree1.get_Cell(I, 0).ProgressColorEnd = (uint) ColorTranslator.ToOle(Color.FromArgb(255, 255, 0));
            axSftTree1.get_Cell(I, 0).ProgressMax = 50;   // maximum value 0-50
            axSftTree1.get_Cell(I, 0).ProgressValue = 40; // current value

            I = axSftTree1.Items.Add("Progress Bar - customizable colors");
            axSftTree1.get_Item(I).Level = 1;
            axSftTree1.get_Cell(I, 0).ProgressColorOrientation = SftTreeOrientationDefaultConstants.verticalDefaultOrientationSftTree;
            axSftTree1.get_Cell(I, 0).ProgressStyle = SftTreeProgressStyleDefaultConstants.smallDefaultProgressStyleSftTree;

View Entire Sample Code

C++

    m_vTree->Cell[i][0]->ProgressMax = 200;  // maximum value 0-200
    m_vTree->Cell[i][0]->ProgressValue = 33; // current value

    i = m_vTree->Items->Add("Progress Bar - with gradient fill");
    m_vTree->Item[i]->Level = 1;
    m_vTree->Cell[i][0]->ProgressColorOrientation = horizontalDefaultOrientationSftTree;
    m_vTree->Cell[i][0]->ProgressStyle = smallDefaultProgressStyleSftTree;
    m_vTree->Cell[i][0]->ProgressColor = RGB(128,128,0);
    m_vTree->Cell[i][0]->ProgressColorEnd = RGB(255,255,0);
    m_vTree->Cell[i][0]->ProgressMax = 50;   // maximum value 0-50
    m_vTree->Cell[i][0]->ProgressValue = 40; // current value

    i = m_vTree->Items->Add("Progress Bar - customizable colors");
    m_vTree->Item[i]->Level = 1;
    m_vTree->Cell[i][0]->ProgressColorOrientation = verticalDefaultOrientationSftTree;
    m_vTree->Cell[i][0]->ProgressStyle = smallDefaultProgressStyleSftTree;

View Entire Sample Code

See Also SftTreeCell Object | Object Hierarchy