Hide

SftBox/OCX 5.0 - Combo Box Control

Display
Print

SftBox.ButtonPicture Property

Defines the graphic used to display expand/collapse buttons.

Syntax

Get

VB.NETrefPictureObj = object.ButtonPicture As System.Drawing.Image
VBSet refPictureObj = object.ButtonPicture As IPictureDisp
C#.NETSystem.Drawing.Image refPictureObj = object.ButtonPicture;
VC++IPictureDisp* refPictureObj = object->GetButtonPicture();
CHRESULT object->get_ButtonPicture(IPictureDisp** refPictureObj);

Put

VB.NETobject.let_ButtonPicture(ByVal refPictureObj As System.Drawing.Image)
VBobject.ButtonPicture = refPictureObj As IPictureDisp
C#.NETvoid object.let_ButtonPicture(System.Drawing.Image refPictureObj);
VC++void object->PutButtonPicture(IPictureDisp* refPictureObj);
CHRESULT object->put_ButtonPicture(IPictureDisp* refPictureObj);

PutRef

VB.NETobject.ButtonPicture = refPictureObj As System.Drawing.Image
VBSet object.ButtonPicture = refPictureObj As IPictureDisp
C#.NETSystem.Drawing.Image object.ButtonPicture = refPictureObj;
VC++void object->PutRefButtonPicture(IPictureDisp* refPictureObj);
CHRESULT object->putref_ButtonPicture(IPictureDisp* refPictureObj);

object

A SftBox object.

refPictureObj

A Picture object. This Picture object contains the graphic used to display the expand/collapse buttons. The refPictureObj object must represent a bitmap and cannot represent an icon or a metafile. For information about picture properties, please visit the applicable section "Using SftBox/OCX with ...".

Comments

The ButtonPicture property defines the graphic used to display expand/collapse buttons.

The ButtonPicture and ButtonPictureH properties are synonyms, but accept different value types (Picture object reference or Windows bitmap handle).

The ButtonPicture property can be used to override the default expand/collapse buttons provided by a combo box control. The refPictureObj object must represent a bitmap and cannot represent an icon or a metafile.

The bitmap represented by the refPictureObj object must contain four equal-sized images of an expand/collapse button in the following 4 states:

  • up, expandable item. The default is a 12 x 11 button with a '+' image.
  • up, expanded item. The default is a 12 x 11 button with a '-' image.
  • down, expandable item. The default is a 12 x 11 button with a '+' image.
  • down, expanded item. The default is a 12 x 11 button with a '-' image.

The buttons are arranged horizontally in the bitmap, so the height of the bitmap is the height of one button and the width of the bitmap is four times the width of one button. The top, left pixel of each button bitmap must contain the background color. This color will be replaced by the actual item background color when the bitmap is displayed.

All items use the same expand/collapse button graphic. Expand/collapse buttons are only shown if the ButtonStyle property is set accordingly. Only parent items with dependents receive an expand/collapse button. Leaf items never have an expand/collapse button.

The ButtonPicture property can be set to the value Nothing (NULL), which restores the combo box control's default, built-in expand/collapse button bitmap.

The ButtonStyle property can be used to define the presence of expand/collapse buttons.

The height of the items displayed is adjusted if necessary so the complete button graphic can be displayed vertically and horizontally.

Sample button bitmaps can be found in the directory \Program Files\Softelvdm\SftBox OCX 5.0\Samples\Bitmaps. E.g., Buttons4.bmp contains the button image as used by Windows Explorer.

Using PutRef (see Syntax above) the control will use the reference to the Picture object. If the Picture object is later changed, this will also affect the image used by the control. Using Put instead causes the control to create a copy of the Picture object. If the Picture object is later changed, this will not affect the image used by the control as it uses a copy of the object. Because of the additional overhead and the increased resource use of Put, PutRef is the preferred method.

See Also SftBox Object | Object Hierarchy


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