Property Settings -- IToolBarButton

Use the following properties to define initial characteristics of an IToolBarButton* part.

IToolBarButton properties

activeColor
The active color of the button. This is defined as a color property.

allowsDragDelete
Sets the noDragDelete style. If this property is true, the style is set to off.

allowsMouseClickFocus
Sets the noPointerFocus style. If this property is true, the style is set to off.

autoDeleteObject
Specifies whether the C++ object is deleted when the user closes the window. The default is false. This property should be true only for objects that are created dynamically using a Factory.

autoDestroyWindow
Specifies whether the system destroys the presentation object when the C++ object is deleted. The default is false. This inherited property is not appropriate for objects created from VisualAge user interface parts. It is applicable when a C++ class is a wrapper for a presentation object that it did not create.

autoLatchEnabled
Sets the autoLatch style. If this property is true, the style is set to on.

backgroundColor
The background color of the button. This is defined as a color property.

borderColor
The border color of the button. This is defined as a color property.

defaultTransparentColor
The default transparent color for this and subsequently created buttons. The shipped default transparent color is pink. This is defined as a color property.

disabledBackgroundColor
The background color of the button when it is disabled. This is defined as a color property.

disabledForegroundColor
The foreground color of the button when it is disabled. This is defined as a color property.

enabled
Specifies whether the button is enabled for selection.

enabledForNotification
Specifies whether the button is enabled for event notification. The default is true. Visual composition connections depend on event notification.

Fly-over long text
Text that is displayed in a text control when the mouse pointer hovers over the button. To display the fly-over text, you must add an IVBFlyText* part to the composite part for the window and specify a text control for the IVBFlyText* part.

Fly-over short text
Text that is displayed in a pop-up caption box when the mouse pointer hovers over the button. To display the fly-over text, you must add an IVBFlyText* part to the composite part for the window.

font
Specifies the text font for the button. This is defined as a font property.

foregroundColor
The foreground color of the button. This is defined as a color property.

handlers
The list of attached handlers for the button. This is defined as a handlers property.

helpId
The ID of the help panel for the button. To display the help, you must add an IHelpWindow* part to the composite part for the primary application window.

hiliteBackgroundColor
The background color of the button when it is highlighted. This is defined as a color property.

hiliteForegroundColor
The foreground color of the button when it is highlighted. This is defined as a color property.

id
The window ID of the button.

inactiveColor
The inactive color of the button. This is defined as a color property.

itemProvider
Specifies a direct manipulation item provider for drag-drop operations. This is defined as a code property. Enter a pointer to an IDMItemProvider object, or code that produces this pointer. A connection can be used instead of setting the code property.

latched
Specifies whether the button is latched down. If this is true, the button appears to be locked in a pushed state.

latchedBackgroundColor
The background color of the button when it is latched. This is defined as a color property.

latchedBitmap
Specifies a latched bitmap for the button. This is defined as a resource property.

latchedForegroundColor
The foreground color of the button when it is latched. This is defined as a color property.

latchingEnabled
Sets the latchable style. If this property is true, the style is set to on.

minimumSize
Specifies the minimum size of the button. Multicell canvases and set canvases use the minimum size to lay out controls. This is defined as an IVBMinSize property.

partName
The composition name of the part. This name is used for the class instance in generated code.

resourceId
Specifies a bitmap for the button. This is defined as a resource property.

shadowColor
The shadow color of the button. This is defined as a color property.

Size and position
The size and position of the button. This is defined as a framing property.

standardBitmapSize
The bitmap size for tool bar buttons that have the standardFormat style on. This is defined as an ISize property. The shipped ISize width is 20; the shipped height is 17.

standardTextLines
The number of lines for tool bar buttons that have the standardFormat style on. The shipped value is 1.

standardTextWidth
The text width for tool bar buttons that have the standardFormat style on. The shipped value is 50.

style
The style settings for the button. This is defined as a style property. The individual styles are described as IToolBarButton style properties.

text
Text for the button.

transparentColor
The transparent color of the button. If nothing is specified, the defaultTransparentColor value is used. This is defined as a color property.

userData
Program data for the button. This unsigned long property is generally set by code functions rather than in a property sheet.

view
Sets styles for tool bar button bitmaps and text.

IToolBarButton style properties

add default bits
Specifies whether the default style settings are used as a base for part styles. The initial value is true. The default style is shipped with the following styles on:

autoLatch
Specifies whether latching is tied to the latched state of other buttons in a control group. All buttons in the group must be latchable and have automatic latching enabled.

bitmapAndTextVisible
Specifies whether both bitmaps and text are displayed. This style is mutually exclusive with the bitmapVisible and textVisible styles. Ensure that only one of these styles is on, either explicitly or by default.

bitmapVisible
Specifies whether only bitmaps are displayed. This style is mutually exclusive with the bitmapAndTextVisible and textVisible styles. Ensure that only one of these styles is on, either explicitly or by default.

clipChildren
Specifies whether areas occupied by child windows are painted by this window object. If this style is on, child areas are not painted by this window object. This inherited window style is most useful for frame windows and composer parts.

clipSiblings
Specifies whether areas occupied by sibling windows are painted by this window object. If this style is on, sibling areas are not painted by this window object. This inherited window style is most useful for frame windows.

clipToParent
Specifies whether a window object paints only within the bounds of its parent window. If this style is on, painting is restricted to the bounds of the parent.

group
Specifies whether the button is the first control in a control group.

latchable
Specifies whether the button is latchable. If this style is on, the button toggles between the latched and unlatched state each time the user selects it.

noDragDelete
Specifies whether the button can be dragged to a shredder for deletion. If this style is on, the button cannot be dropped on a shredder.

noPointerFocus
Specifies whether the button gets the input focus when the user selects it with a mouse. If this style is on, the focus does not shift to this button when it is selected with a mouse.

saveBits
Specifies whether the area under the window object is saved as a bitmap to enable faster repainting.

standardFormat
Specifies whether the button uses a standard format for consistency and effeciency. If this style is on, the standardBitmapSize, standardTextLines, and standardTextWidth property values are used for the button.

synchPaint
Specifies whether the window object is painted synchronously rather than waiting for other system events to processed.

tabStop
Specifies whether the button is a tab stop.

textVisible
Specifies whether only text is displayed. This style is mutually exclusive with the bitmapAndTextVisible and bitmapVisible styles. Ensure that only one of these styles is on, either explicitly or by default.

useIdForBitmap
Specifies whether the button's window ID is used as the resource ID for a button bitmap.

useIdForText
Specifies whether the button's window ID is used as the resource ID for button text.

visible
Specifies whether the button is visible.


Related procedures
Working with IToolBarButton Parts
Editing Part Properties

Related references
Property Settings -- IVBMinSize
Property Settings -- ISize
Style Properties
Color Properties
Font Properties
Handler Properties
Size and Position Properties
Code Properties
Resource Properties
IToolBarButton
Portability -- IToolBarButton
VisualAge User Interface Part Properties