ToolBar.AddBand Method (Typed) | |
Use this method to add a band to the ToolBar.
Namespace:
XSharp.VO.SDK
Assembly:
XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21
Syntax VIRTUAL METHOD AddBand(
sBandName,
oControl,
iPos,
iMinWidth,
iMinHeight,
sText,
oForeColor,
oBackColor,
iImageIndex,
oBackBitmap
) AS USUAL CLIPPER
[ClipperCallingConventionAttribute(new string[] { ... })]
public virtual Usual AddBand(
Usual sBandName = default,
Usual oControl = default,
Usual iPos = default,
Usual iMinWidth = default,
Usual iMinHeight = default,
Usual sText = default,
Usual oForeColor = default,
Usual oBackColor = default,
Usual iImageIndex = default,
Usual oBackBitmap = default
)
Request Example
View SourceParameters
- sBandName (Optional)
- Type: Usual
A symbol naming the band. - oControl (Optional)
- Type: Usual
A window or control descendant to be included in the new band. - iPos (Optional)
- Type: Usual
Position of the band. The default is the last position (-1). - iMinWidth (Optional)
- Type: Usual
Minimum width of the band. - iMinHeight (Optional)
- Type: Usual
Minimum height of the band. - sText (Optional)
- Type: Usual
Text to be displayed on the band. - oForeColor (Optional)
- Type: Usual
A Color object specifying the foreground color of the band. - oBackColor (Optional)
- Type: Usual
A Color object specifying the background color of the band. - iImageIndex (Optional)
- Type: Usual
An index into the image list specifying an image to be displayed. - oBackBitmap (Optional)
- Type: Usual
A Bitmap object specifying a bitmap to be displayed as the band's background.
Return Value
Type:
Usual
TRUE, if the operation was successful; otherwise, FALSE.
Remarks
The ToolBar:AddBand() method adds a new band to the toolbar. Bands are separate areas of a toolbar control, or window, which that can be resized and moved by the end user. Each band can hold a text, an image, and a control. Additionally, foreground and background colors, as well as a background bitmap, can be specified. If you want to create a band holding a sub-toolbar as a control, use ToolBar:AddSubToolBarBand().
Examples
For an example of a band-style toolbar, see the Private Eye sample application.
See Also