SftTree/OCX 7.5 - ActiveX Tree Control

ProgressColor Property, SftTreeCell Object

Defines the progress bar color used for this cell.

Syntax

Get

VB.NET	Clr = object.ProgressColor As UInteger
VB	Clr = object.ProgressColor As OLE_COLOR
C#.NET	uint Clr = object.ProgressColor;
VC++	OLE_COLOR Clr = object->ProgressColor; OLE_COLOR Clr = object->GetProgressColor();
C	HRESULT object->get_ProgressColor(OLE_COLOR* Clr);

Put

VB.NET	object.ProgressColor = Clr As UInteger
VB	object.ProgressColor = Clr As OLE_COLOR
C#.NET	uint object.ProgressColor = Clr;
VC++	OLE_COLOR object->ProgressColor = Clr; void object->PutProgressColor(OLE_COLOR Clr);
C	HRESULT object->put_ProgressColor(OLE_COLOR Clr);

object

A SftTreeCell object.

Clr

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

Comments

The ProgressColor property defines the progress bar color used for this cell.

The Cell.ProgressColorEnd property combined with 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.

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).ProgressStyle = SftTreeProgressStyleDefaultConstants.smallDefaultProgressStyleSftTree
        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

View Entire Sample Code

VB6

        .Cell(I, 0).ProgressStyle = smallDefaultProgressStyleSftTree
        .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

View Entire Sample Code

C#

            axSftTree1.get_Cell(I, 0).ProgressStyle = SftTreeProgressStyleDefaultConstants.smallDefaultProgressStyleSftTree;
            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;

View Entire Sample Code

C++

    m_vTree->Cell[i][0]->ProgressStyle = smallDefaultProgressStyleSftTree;
    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;

View Entire Sample Code

See Also SftTreeCell Object | Object Hierarchy