Copyright: Copyright © 1995 Sheridan Software Systems, Inc.


(About) Property

Applies To

Description

Displays version information about the control.

Usage

Click on the ellipses ('...') button next to the property text to activate the about dialog box.

Remarks

Available only at design time.


(Custom) Property

Applies To

Description

Displays the property pages for the control.

Usage

Right-click on the object and choose 'Property Pages' from the pop-up menu, or click on the ellipses ('...') button next to the property text to activate the property pages dialog box.

Remarks

Available only at design time. The property pages dialog provides access to the properties of the control in design environments which do not have a property sheet. Property Pages also provide access to certain properties at design-time which are not available from the property sheet.


(TemplateManager) Property

Applies To

Description

This property lets the developer invoke the Template Manager in order to create, apply, modify and delete control templates at design time.

Usage

Click on the ellipses ('...') button next to the property text to activate the Template Manager.

Remarks

Refer to the Working With Templates  section for a detailed explanation of this tool.

Available only at design time.


(ToolbarDesigner) Property

Applies To

Description

This property lets the developer invoke the Toolbar Designer in order to create and maintain toolbars and toolsets at design time.

Usage

Click on the ellipses ('...') button next to the property text to activate the Toolbar Designer. When using the OCX version of the control, you can click on the control with the secondary mouse button and choose 'Toolbar Designer' from the pop-up menu.

Remarks

Refer to Using the Toolbar Designer   for a detailed explanation of this tool.

Available only at design time.


ActiveControl Property

Applies To

Description

Specifies if this control is the active control.

Syntax

object  .ActiveControl [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the state of the control, as described in Settings.

Settings

Setting	Description

True	This control is the active control.

False	(Default) This control is not active.

Remarks

Multiple FormFX controls can be used on the same form.  Since only one control can be active at a time, all other (inactive) controls will be displayed as follows:


ActivePage3D Property

See Also	Applies To

Description

Determines if the active page will have a 3-D look.

Syntax

object  .ActivePage3D [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the 3-D state of the active page, as described in Settings.

Settings

Setting	Description

0	2-D - The active page will not be displayed in 3-D.

1	3-D - The active page will be displayed in 3-D.

2	(Default) Match Pages3D - The active page  will use the setting of the Pages3D property.

Remarks

If this property is set to display the active page in 3-D, the BackColor and ActivePageBackColor properties are ignored and ActivePage3DBackColor is used.


ActivePage3DBackColor Property

See Also	Applies To

Description

Returns or sets the background and/or foreground color of the active Page when it is 3-D.

Syntax

object  .ActivePage3DBackColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the active page's background color when the page is in 3-D mode.


ActivePageBackColor, ActivePageForeColor Properties

See Also	Applies To

Description

Returns or sets the background and/or foreground color of the active page.

Syntax

object  .ActivePageBackColor [= color  ]

object  .ActivePageForeColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the active page's color.


ActivePageFont Object

See Also	Applies To

Description

Contains the information used to format the display of text in the caption of currently selected page.

Properties

Bold

Italic

Name (default)

Size

Strikethrough

Weight

Underline

Remarks

This object is equivalent to the standard Font object and has the same properties; however it applies only to the active page.


ActivePageFont Property

See Also	Applies To	Example

Description

Returns or sets the properties of the ActivePageFont object at design time and run time.

Syntax

object  .ActivePageFont

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

Remarks

This setting provides access to the properties of the ActivePageFont object. At design time, you can choose this setting to invoke the Font dialog box and set the font attributes of the object. At run time, specify a property setting of the object that you want to change or return.


ActivePageFontBold Property

See Also	Applies To

Description

Returns or sets the font style of the ActivePageFont object to either bold or non-bold.

Syntax

object  .ActivePageFontBold [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on bold formatting.

False	Turns off bold formatting.

Remarks

The ActivePageFont object is not directly available at design time.  Instead you set the Bold property through a page's Font property.

At run time, however, you can set Bold directly by specifying its setting for the ActivePageFont object.

In Visual Basic 3.0 you set the Bold property for the active page by selecting a control's ActivePageFontBold property in the Visual Basic Properties window.


ActivePageFontItalic Property

See Also	Applies To

Description

Returns or sets the font style of the ActivePageFont object to either italicized or non-italicized.

Syntax

object  .ActivePageFontItalic [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on italic formatting.

False	Turns off italic formatting.

Remarks

The ActivePageFont object is not directly available at design time.  Instead you set the Italic property through a page's Font property.

At run time, however, you can set Italic directly by specifying its setting for the ActivePageFont object.

In Visual Basic 3.0 you set the Italic property for the active page by selecting a control's ActivePageFontItalic property in the Visual Basic Properties window.


ActivePageFontName Property

See Also	Applies To

Description

Returns or sets the name of the font used by the ActivePageFont object.

Syntax

object  .ActivePageFontName [= font  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

font	A string expression specifying the font name to use.

Remarks

The ActivePageFont object is not directly available at design time.  Instead you set the Name property through a page's Font property.

At run time, however, you can set Name directly by specifying its setting for the ActivePageFont object.

In Visual Basic 3.0 you set the Name property for the active page by selecting a control's ActivePageFontName property in the Visual Basic Properties window.


ActivePageFontSize Property

See Also	Applies To

Description

Returns or sets the font size used in the ActivePageFont object.

Syntax

object  .ActivePageFontSize [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the size of the font in points.

Remarks

Use this property to format text in the font size you want.  The default font size is determined by the operating system.  To change the default, specify the size of the font in points.

The ActivePageFont object is not directly available at design time.  Instead you set the Size property through a page's Font property.

At run time, however, you can set Size directly by specifying its setting for the ActivePageFont object.

In Visual Basic 3.0 you set the Size property for the active page by selecting a control's ActivePageFontSize property in the Visual Basic Properties window.


ActivePageFontStrikethru Property

See Also	Applies To

Description

Returns or sets the font style of the ActivePageFont object to either strikethrough or non-strikethrough.

Syntax

object  .ActivePageFontStrikethru [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on strikethrough formatting.

False	Turns off strikethrough formatting.

Remarks

The ActivePageFont object is not directly available at design time.  Instead you set the Strikethrough property through a page's Font property.

At run time, however, you can set Strikethrough directly by specifying its setting for the ActivePageFont object.

In Visual Basic 3.0 you set the Strikethrough property for the active page by selecting a control's ActivePageFontStrikethru property in the Visual Basic Properties window.


ActivePageFontUnderline Property

See Also	Applies To

Description

Returns or sets the font style of the ActivePageFont object to either underlined or not underlined.

Syntax

object  .ActivePageFontUnderline [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean  are:

Setting	Description

True	(Default) Turns on underlining.

False	Turns off underlining.

Remarks

The ActivePageFont object is not directly available at design time.  Instead you set the Underline property through a page's Font property.

At run time, however, you can set Underline directly by specifying its setting for the ActivePageFont object.

In Visual Basic 3.0 you set the Underline property for the active page by selecting a control's ActivePageFontUnderline property in the Visual Basic Properties window.


ActivePagePicture Property

See Also	Applies To	Example

Description

Specifies the picture that will be displayed in the caption area of the active page.

Syntax

object  .ActivePagePicture [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap, icon, metafile)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap, icon or metafile.

Remarks

Page pictures will only be visible if the PageNavigation property is set to "2 - Page Tabs." The picture specified in this property will override the picture set in the page's PagePicture property. If no picture is specified for this property, the picture from the PagePicture property, if any, is used.

If you specify a metafile for this property, you must also set the ActivePagePictureMetaHeight and ActivePagePictureMetaWidth properties to indicate the size of the picture.


ActivePagePictureMetaHeight, ActivePagePictureMetaWidth Properties

See Also	Applies To	Example

Description

Returns or sets the height and/or width of the metafile, if specified in the ActivePagePicture property.

Syntax

object  .ActivePagePictureMetaHeight [= number  ]

object  .ActivePagePictureMetaWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the height or width of a metafile picture in the caption area of the active Page.

Remarks

The units specified are based on the scale mode of the form.


ActivePagePropertiesUsed Property

Applies To

Description

Determines whether ActivePage properties will apply to the active page.

Syntax

object  .ActivePagePropertiesUsed [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the how the properties of the active page will be determined, as described in Settings.

Settings

Setting	Description

True	(Default) Properties relating to the active page will be used to determine its appearance.

False	The appearance of the active page will not differ from that of the other pages.

Remarks

Set this property to False to effectively disable all customization related to the active page. If this setting is False, the following properties are ignored:

•	ActivePage3D

•	ActivePage3DBackColor

•	ActivePageBackColor

•	ActivePageForeColor

•	ActivePageFont (and ActivePageFont related properties)

•	ActivePagePicture

•	ActivePagePictureMetaHeight

•	ActivePagePictureMetaWidth


ActiveTab3D Property

See Also	Applies To

Description

Determines if the active tab will have a 3-D look.

Syntax

object  .ActiveTab3D [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the 3-D state of the active tab, as described in Settings.

Settings

Setting	Description

0	2-D - The active tab will not be displayed in 3-D.

1	3-D - The active tab will be displayed in 3-D.

2	(Default) Match Tabs3D - The active page  will use the setting of the Tabs3D property.

Remarks

If this property is set to display the active tab in 3-D, the BackColor and ActiveTabBackColor properties are ignored and ActiveTab3DBackColor  is used.


ActiveTab3DBackColor Property

Applies To

Description

Returns or sets the background color of the active tab when it is 3-D.

Syntax

object  .ActiveTab3DBackColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the active page's background color when the page is in 3-D mode.


ActiveTabBackColor, ActiveTabForeColor Properties

See Also	Applies To

Description

Returns or sets the background and/or foreground color of the active tab.

Syntax

object  .ActiveTabBackColor [= color  ]

object  .ActiveTabForeColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the active tab's color.

Remarks

 If the Tabs3D property is set to True, the ActiveTabBackColor property is ignored and ActiveTab3DBackColor is used. Otherwise, the ActiveTabBackColor property is used for the entire area of the active tab.


ActiveTabFont Object

See Also	Applies To

Description

Contains the information used to format the display of text in the caption of currently selected tab.

Properties

Bold

Italic

Name (default)

Size

Strikethrough

Weight

Underline

Remarks

This object is equivalent to the standard Font object and has the same properties; however it applies only to the active tab.


ActiveTabFont Property

See Also	Applies To	Example

Description

Returns or sets the properties of the ActiveTabFont object at design time and run time.

Syntax

object  .ActiveTabFont

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

Remarks

This setting provides access to the properties of the ActiveTabFont object. At design time, you can choose this setting to invoke the Font dialog box and set the font attributes of the object. At run time, specify a property setting of the object that you want to change or return.


ActiveTabFontBold Property

See Also	Applies To

Description

Returns or sets the font style of the ActiveTabFont object to either bold or non-bold.

Syntax

object  .ActiveTabFontBold [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean  are:

Setting	Description

True	(Default) Turns on bold formatting.

False	Turns off bold formatting.

Remarks

The ActiveTabFont object is not directly available at design time.  Instead you set the Bold property through a tab's Font property.

At run time, however, you can set Bold directly by specifying its setting for the ActiveTabFont object.

In Visual Basic 3.0 you set the Bold property for the active tab by selecting a control's ActiveTabFontBold property in the Visual Basic Properties window.


ActiveTabFontItalic Property

See Also	Applies To

Description

Returns or sets the font style of the ActiveTabFont object to either italicized or non-italicized.

Syntax

object  .ActiveTabFontItalic [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on italic formatting.

False	Turns off italic formatting.

Remarks

The ActiveTabFont object is not directly available at design time.  Instead you set the Italic property through a tab's Font property.

At run time, however, you can set Italic directly by specifying its setting for the ActiveTabFont object.

In Visual Basic 3.0 you set the Italic property for the active tab by selecting a control's ActiveTabFontItalic property in the Visual Basic Properties window.


ActiveTabFontName Property

See Also	Applies To

Description

Returns or sets the name of the font used by the ActiveTabFont object.

Syntax

object  .ActiveTabFontName [= font  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

font	A string expression specifying the font name to use.

Remarks

The ActiveTabFont object is not directly available at design time.  Instead you set the Name property through a page's Font property.

At run time, however, you can set Name directly by specifying its setting for the ActiveTabFont object.

In Visual Basic 3.0 you set the Name property for the active page by selecting a control's ActiveTabFontName property in the Visual Basic Properties window.


ActiveTabFontSize Property

See Also	Applies To

Description

Returns or sets the font size used in the ActiveTabFont object  .

Syntax

object  .ActiveTabSize [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the size of the font in points.

Remarks

Use this property to format text in the font size you want.  The default font size is determined by the operating system.  To change the default, specify the size of the font in points.

The ActiveTabFont object is not directly available at design time.  Instead you set the Size property through a tab's Font property.

At run time, however, you can set Bold directly by specifying its setting for the ActiveTabFont object.

In Visual Basic 3.0 you set the Bold property for the active tab by selecting a control's ActiveTabFontSize property in the Visual Basic Properties window.


ActiveTabFontStrikethru Property

See Also	Applies To

Description

Returns or sets the font style of the ActiveTabFont object to either strikethrough or non-strikethrough.

Syntax

object  .ActiveTabFontStrikethru [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on strikethrough formatting.

False	Turns off strikethrough formatting.

Remarks

The ActiveTabFont object is not directly available at design time.  Instead you set the Strkethrough property through a tab's Font property.

At run time, however, you can set Bold directly by specifying its setting for the ActiveTabFont object.

In Visual Basic 3.0 you set the Bold property for the active tab by selecting a control's ActiveTabFontStrikethru property in the Visual Basic Properties window.


ActiveTabFontUnderline Property

See Also	Applies To

Description

Returns or sets the font style of the ActiveTabFont object to either underlined or not underlined.

Syntax

object  .ActiveTabFontUnderline [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on underlining.

False	Turns off underlining.

Remarks

The ActiveTabFont object is not directly available at design time.  Instead you set the Underline property through a tab's Font property.

At run time, however, you can set Bold directly by specifying its setting for the ActiveTabFont object.

In Visual Basic 3.0 you set the Bold property for the active tab by selecting a control's ActiveTabFontUnderline property in the Visual Basic Properties window.


ActiveTabPicture Property

See Also	Applies To

Description

Specifies the picture that will be displayed on the active tab.

Syntax

object  .ActiveTabPicture [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap, icon, metafile)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap, icon or metafile.

Remarks

The picture specified in this property will override the picture set in the tab object's Picture property.


ActiveTabPictureMetaHeight, ActiveTabPictureMetaWidth Properties

See Also	Applies To	Example

Description

Returns or sets the height and/or width of the metafile, if specified in the ActiveTabPicture property.

Syntax

object  .ActiveTabPictureMetaHeight [= number  ]

object  .ActiveTabPictureMetaWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the height or width of a metafile picture in the caption area of the active tab.

Remarks

The units specified are based on the scale mode of the form.


ActiveTabPropertiesUsed Property

Applies To

Description

Determines whether ActiveTab properties will apply to the active tab.

Syntax

object  .ActiveTabPropertiesUsed [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the how the properties of the active tab will be determined, as described in Settings.

Settings

Setting	Description

True	(Default) Properties relating to the active tab will be used to determine its appearance.

False	The appearance of the active tab will not differ from that of the other tabs.

Remarks

Set this property to False to effectively disable all customization related to the active tab. If this setting is False, the following properties are ignored:

•	ActiveTab3D

•	ActiveTab3DBackColor

•	ActiveTabBackColor

•	ActiveTabForeColor

•	ActiveTabFont (and ActiveTabFont related properties)

•	ActiveTabPicture

•	ActiveTabPictureMetaHeight

•	ActiveTabPictureMetaWidth


AddControl Method

See Also	Applies To	Example

Description

This method is used to add a control to a page object.

Syntax

object  .AddControl controlname

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

controlname	The name of an existing control.

Remarks

Although it seems that you can place controls on tabs in the Index Tab and Notebook controls, you cannot actually place any controls directly on a tab. When you position controls on a tab, you are actually placing them on page zero for that tab. Each tab has at least this one page associated with it, regardless of any other page settings. Page zero does not appear as separate page, it is not affected by the PagesVisible property or other page settings, and it cannot be removed.

Therefore, when you wish to add a control to a tab through code, you must add the control to the zero page of the tab.


Adding Custom Buttons to the Caption Area

You can also use the FormFX control to place custom  buttons in the caption area of the form.  The CaptionButtonsLeft and CaptionButtonsRight areas contain the custom caption buttons for the left and right side of the caption area.  Each added button will fire a Click event when clicked.

Custom caption buttons can be created, hidden, disabled or removed at run-time. In addition, each button can have one of two states - push-button or toggle. Pictures for the left and right groups of buttons are specified by assigning bitmaps to the CaptionButtonPicLeft and CaptionButtonPicRight properties, respectively. Each bitmap contains the up and down states of all the buttons, and is divided into equal segments based on the value of CaptionButtonsLeft or CaptionButtonsRight properties. Other properties are set and retrieved using a property index that uniquely identifies each button.

Properties that define caption buttons for the left/right side of the caption area include:

•	CaptionButtonsLeft, CaptionButtonsRight

•	CaptionButtonEnabledLeft, CaptionButtonEnabledRight

•	CaptionButtonPicLeft, CaptionButtonPicRight

•	CaptionButtonPicDisLeft, CaptionButtonPicDisRight

•	CaptionButtonTypeLeft, CaptionButtonTypeRight

•	CaptionButtonValueLeft, CaptionButtonValueRight

•	CaptionButtonVisibleLeft, CaptionButtonVisibleRight


AlignmentCaption Property

See Also	Applies To	Example

Description

Determines how the caption will be aligned on the form or tab.

Syntax

object  .AlignmentCaption [= number  ]

Settings

Setting	Description

0	Left Justify - Top

1	Left Justify - Middle

2	Left Justify - Bottom

3	Right Justify - Top

4	Right Justify - Middle

5	Right Justify - Bottom

6	Center - Top

7	(Default) Center - Middle

8	Center - Bottom


AlignmentPicture Property

See Also	Applies To	Example

Description

Determines how the picture will be aligned on the form or tab caption.

Syntax

object  .AlignmentPicture[= number  ]

Settings

Settings marked with an asterisk(*) are available only in SSFormFX.

Setting	Description

0	Left Justify - Top

1	(Default) Left Justify - Middle

2	Left Justify - Bottom

3	Right Justify - Top

4	Right Justify - Middle

5	Right Justify - Bottom

6	Center - Top

7	Center - Middle

8	Center - Bottom

9	Left of Text

10	Right of Text

11	Above Text

12	Below Text

13	Fit to Tab/Caption

14	*	Fixed from Left - The picture will be positioned on the caption using the CaptionPictureX and CaptionPictureY properties relative to the top left of the caption.

15	*	Fixed from Right - The picture will be positioned on the caption using the CaptionPictureX and CaptionPictureY properties relative to the top right of the caption.


All Collections
Collection Summary	See Also

B

Buttons

P

Pages

T

Tabs

Templates

ToolsetTools


All Events
Event Summary	See Also

C

CaptionButtonsLeftClick

CaptionButtonsRightClick

Click (SSIndexTab, SSNotebook)

Click (SSToolbar)

ClickAfter

ClickBefore

D

DblClick

DragDrop

DragOver

DockStatusChanged

G

GotFocus

H

Help

K

KeyDown

KeyPress

KeyUp

L

LostFocus

M

MouseDown

MouseEnter

MouseExit

MouseMove

MouseUp

T

ToolbarClosed

ToolbarResized


All Methods
Method Summary	See Also

A

AddControl

D

Drag

I

Insert

R

Refresh

Remove

RemoveControl

S

SetFocus


All Objects
Object Summary	See Also

A

ActivePageFont

ActiveTabFont

B

Button

F

Font

P

Page

PageFont

Picture

T

Tab

Template

ToolsetTool


All Properties
Property Summary	See Also

(About)

(Custom)

(TemplateManager)

(ToolbarDesigner)

A

ActiveControl

ActivePage3D

ActivePage3DBackColor

ActivePageBackColor

ActivePageFont

ActivePageFontBold

ActivePageFontItalic

ActivePageFontName

ActivePageFontSize

ActivePageFontStrikethru

ActivePageFontUnderline

ActivePageForeColor

ActivePagePicture

ActivePagePictureMetaHeight

ActivePagePictureMetaWidth

ActivePagePropertiesUsed

ActiveTab3D

ActiveTab3DBackColor

ActiveTabBackColor

ActiveTabFont

ActiveTabFontBold

ActiveTabFontItalic

ActiveTabFontName

ActiveTabFontSize

ActiveTabFontStrikethru

ActiveTabFontUnderline

ActiveTabForeColor

ActiveTabPicture

ActiveTabPictureMetaHeight

ActiveTabPictureMetaWidth

ActiveTabPropertiesUsed

AlignmentCaption

AlignmentPicture

AllowAllUp

AllowToolbarDockLeft

AllowToolbarDockRight

AllowToolbarDockTop

AllowToolbarDockBottom

AllowToolbarFloat

AllowToolbarMove

AlwaysOnTop

B

BackColor

BackColorActive

BackColorDock

BackColorHelp

BackColorInactive

BalloonHelp

BalloonHelpDelay

BevelColorFace

BevelColorHighlight

BevelColorOutline

BevelColorScheme

BevelColorShadow

BevelInner

BevelOuter

BevelWidth

Bold

Bookmark

Border3D

BorderWidth

BtnEnabled

BtnGroupSpacing

BtnHeight

BtnMarginX

BtnMarginY

Btns

BtnSpacing

BtnToolNum

BtnWidth

BtnValue

BtnVisible

C

Caption

Caption3D

CaptionBevelInner

CaptionBevelOuter

CaptionBevelWidth

CaptionBorderWidth

CaptionButtonEnabledLeft

CaptionButtonEnabledRight

CaptionButtonPicDisLeft

CaptionButtonPicDisRight

CaptionButtonPicLeft

CaptionButtonPicRight

CaptionButtonsLeft

CaptionButtonsPic

CaptionButtonsRight

CaptionButtonTypeLeft

CaptionButtonTypeRight

CaptionButtonValueLeft

CaptionButtonValueRight

CaptionButtonVisibleLeft

CaptionButtonVisibleRight

CaptionHeight

CaptionMultiLine

CaptionPicture

CaptionPictureMetaHeight

CaptionPictureMetaWidth

CaptionPictureX

CaptionPictureY

Client3D

ClientBevelInner

ClientBevelOuter

ClientBevelWidth

ClientBorderWidth

ClientHeight

ClientLeft

ClientMove

ClientTop

ClientWidth

CompatibilityMode

ControlBox3D

ControlBoxWidth

Count

CoverAlignmentPicture

CoverAllowClose

CoverBackColor

CoverCornerStyle

CoverCreaseColor

CoverCreaseStyle

CoverGuardStyle

CoverMarginX

CoverMarginY

CoverPicture

CoverShadow

CoverShadowColor

CoverShadowSize

CoverVisible

D

DataField

DataSourceHwnd

DeferDocking

Desc

DockRank

DockRankSeq

DockStatus

E

Enabled

Exclusive

F

FloatingCaption

FloatingCaptionType

FloatingControlBox

FloatingLeft

FloatingSizable

FloatingTop

FloatingWidthInBtns

Font

Font3D

ForeColor

ForeColorActive

ForeColorHelp

ForeColorInactive

G

Group

H

Help

HideInactiveControls

HwndToolbar

I

ID

InstantClose

Italic

L

LockCtlKeyOverride

LockMove

LockSize

M

MaximizeHeight

MaximizeLeft

MaximizeTop

MaximizeWidth

Mnemonic

N

Name

Name (Font object)

NotebookOrientation

NumBtnStates

O

Outline

P

Page

PageAlignmentCaption

PageAlignmentPicture

PageAnimation

PageAnimationResolution

PageBackColor

PageCaption

PageCaptionRotation

PageCount

PageEarmarkPos

PageFont

PageFont3D

PageFontBold

PageFontItalic

PageFontName

PageFontSize

PageFontStrikethru

PageFontUnderline

PageForeColor

PageGutterMargin

PageMargin

PageNavigation

PagePicture

PagePictureMetaHeight

PagePictureMetaWidth

Pages3D

PageStyle

PagesVisible

PageTabEarmark

PageTabHeight

PageTabOrientation

PageTabsPerRow

PageTurnSound

PageTurnSoundFile

PageWordWrap

Picture

PictureDn

PictureDnDis

PictureMetaHeight

PictureMetaWidth

PictureUp

PictureUpDis

Placeholder

PlaceholderWidth

R

Redraw

RingBackColor

RingCount

RingGroups

RingHighlightColor

RingHoleColor

RingHoleOutlineColor

RingHolesVisible

RingMarginBottom

RingMarginTop

RingOutlineColor

RingSize

RingSpacing

RingType

RingWidth

S

ShowFocusRect

Size

SizeMaxHeight

SizeMaxWidth

SizeMinHeight

SizeMinWidth

SpineBackColor

SpineHighlightColor

SpineOutlineColor

SpineStyle

SpineVisible

StdButtonHeight

StdCaption

StdCaptionHeight

Strikethrough

T

Tab

TabBackColorDefault

TabBookmark

TabCaption

TabCaptionRotation

TabCount

TabCutSize

TabEnabled

TabForeColorDefault

TabGutterMargin

TabHeight

TabLeftMargin

TabMaxRows

TabMaxWidth

TabOrientation (Index Tab control)

TabOrientation (Notebook control)

TabPicture

TabPictureMetaHeight

TabPictureMetaWidth

TabRightMargin

TabRowOffset

Tabs3D

TabScrollType

TabSelectType

TabShape

TabSpacing

TabsPerRow

TabStart

TabTopOffset

TabVariableSize

TabVisible

TabVisibleFirst

TabVisibleLast

TemplateName

Toolbar3D

ToolbarFloating

ToolbarOrientation

ToolNum

ToolsetName

ToolsetNumBtnStates

ToolsetNumTools

ToolsetPicture

ToolsetToolAllowAllUp

ToolsetToolDesc

ToolsetToolExclusive

ToolsetToolGroup

ToolsetToolHelp

ToolsetToolID

ToolsetToolMnemonic

ToolsetToolPicDn

ToolsetToolPicDnDis

ToolsetToolPicUp

ToolsetToolPicUpDis

TransparentBack

Type (ToolsetTool object)

U

Underline

UseSystemColors

V

Value

W

WindowLook

WordWrap


AllowAllUp Property

See Also	Applies To

Description

This property determines whether or not all buttons in a group can be in the 'up' position.

Syntax

object  .AllowAllUp[= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying state of the toolset, as described in Settings.

Settings

Setting	Description

True	All buttons in the current picture group may be in the 'up' position.

False	(Default) At least one button in the current picture group must be depressed.

Note	When this property is set for a button in a group, then the property is automatically set to the same value for all the other buttons in the group.

Remarks

The toolbar does not verify that a button in each group is depressed when the control first loads, even if the AllowAllUp property is set to False for a button. It is up to you to initially set the Value property to True for one of the buttons in the group.

This property is ignored if the Exclusive property for the same group is set to False or the Type property for this tool is set to 'Push'.

This property supersedes the ToolsetToolAllowAllUp property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTool object and not the control itself.

This property is only available at run time.  However, it can be initially set at design time using the Toolbar Designer.


AllowToolbarDockLeft, AllowToolbarDockRight, AllowToolbarDockTop, AllowToolbarDockBottom Properties

See Also	Applies To	 Example

Description

Determines where a toolbar is allowed to dock at run time.

Syntax

object  .AllowToolbarDockLeft [= boolean  ]

object  .AllowToolbarDockRight [= boolean  ]

object  .AllowToolbarDockTop [= boolean  ]

object  .AllowToolbarDockBottom [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying ability of the toolbar to dock in an area, as described in Settings.

Settings

Setting	Description

True	(Default) The toolbar can dock in this area.

False	The toolbar cannot dock in this area.

Remarks

These properties only have meaning for SSToolbar controls that are placed directly on MDI forms, not on standard (SDI) forms or containers.

The docking areas are outside of the MDI client area so they do not interfere with MDI child forms.


AllowToolbarFloat Property

See Also	Applies To

Description

Determines if a toolbar is allowed to float at run time.

Syntax

object  .AllowToolbarFloat [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the toolbar can float, as described in Settings.

Setting	Description

True	(Default) The toolbar can be dragged off a docking area.

False	The toolbar cannot float.

Remarks

The AllowToolbarFloat property controls whether or not the toolbar can be dragged off a docking area and remain as a floating toolbar.


AllowToolbarMove Property

See Also	Applies To

Description

Determines if a toolbar is allowed to move at run time.

Syntax

object  .AllowToolbarMove [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the toolbar can move, as described in Settings.

Settings

Setting	Description

True	(Default) The toolbar can moved.

False	The toolbar cannot be moved.

Remarks

This property, if set to False, is used to create a 'fixed' toolbar which cannot be moved off a docking area at run time.  When a toolbar is fixed, it is initially placed onto the docking area determined by the DockStatus property setting.


AlwaysOnTop Property

Applies To	Example

Description

Specifies if the form will always remain as the top-most window.

Syntax

object  .AlwaysOnTop [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the state of the form, as described in Settings.

Settings

Setting	Description

True	The form will always be the top-most window.

False	(Default) The form will only be the top-most window when it is the active window.

Remarks

When a form is the top-most window, it remains at the top of the Z-order even when it is deactivated.


An Introduction to OCX Controls

What is an OCX control?

An OCX control is a specific type of program that makes use of Object Linking and Embedding  (OLE) to provide functions to other programs. Because it gives programs something they did not originally have, an OCX control is known as an OLE server, and the program that uses its services is an OLE client.  OCX controls can provide a nearly unlimited range of functions to their clients.

How is an OCX control different from a VBX control?

The VBX control specification was designed exclusively for use with Visual Basic. Although some other languages offer limited VBX support, the majority of VBX controls function only in Visual Basic. VBX controls are also limited in other ways. Their 16-bit architecture restricts their ability to use memory and to function in a 32-bit operating system, such as Windows NT.

The difference between OCX and VBX controls may not even be apparent to you if you program exclusively in Visual Basic. You access the properties of an OCX control at design time and through code just as you do the properties of a VBX. The process of including both types of controls in your project and distributing them is very similar. The similarities end when you move outside of the Visual Basic programming environment.

OCX controls are supported by a much wider range of platforms, including other languages, database management systems, and productivity applications. OCX controls can be used as the building blocks in a modular software environment, where a complete project might include your own code, custom controls and commercial applications all working together. OCX controls also have the ability to make full use of the newest 32-bit operating systems, taking advantage of improved memory access, better multi-tasking and increased performance.

When should I use OCX controls?

OCX controls come in two varieties: 16-bit and 32-bit. 16-bit controls offer compatibility with Windows and Windows for Workgroups 3.1 and 3.11. 32-bit controls work with systems running Windows NT. In general, you should use the most advanced version of the control that is available and is supported by your host environment.

Note	Visual Basic 3.0 only supports the VBX version of the controls.

If you are using a 32-bit programming system to develop an application that will run exclusively on a 32-bit platform, use the 32-bit OCX. If you are developing an application that must run on a mixed platform, you can use a 16-bit OCX, although you will obtain better performance if you develop separate 16-bit and 32-bit versions of your program, using the appropriate OCX controls. If you are developing exclusively for a 16-bit platform, use the 16-bit OCX.


BackColor, ForeColor Properties

See Also	Applies To	Example

Description

Returns or sets the background and foreground (text) color of each page, tab or of the entire control.

Syntax

object  .BackColor [= color  ]

object  .ForeColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the color of the specified object.

Remarks

If the Tabs3D property is set to True, the BackColor property is ignored and the BevelColorFace property is used.  To set the background color of the area behind the cover in the Notebook control, or outside of the tabs in the Index Tab control, use the standard BackColor property.


BackColorActive, ForeColorActive Properties

See Also	Applies To	Example

Description

Returns or sets the background and foreground colors used in the caption area of the form when it is the active window.

Syntax

object  .BackColorActive [= color  ]

object  .ForeColorActive [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the form caption's color when active.

Remarks

If the Caption3D property is True, the BackColorActive property is ignored and the BevelColorFace property is used.  These properties default to the colors set in the Windows Control Panel.

The StdCaption property must be set to False for this property to be active.


BackColorDock Property

See Also	Applies To

Description

Returns or sets the background color of all docking areas.

Syntax

object  .BackColorDock [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the docking area's background color.

Remarks

The docking areas are only used for SSToolbar controls that are placed directly on MDI forms (not on containers).


BackColorHelp, ForeColorHelp Properties

See Also	Applies To

Description

Returns or sets the background color and foreground color for balloon help.

Syntax

object  ..BackColorHelp [= color  ]

object  .ForeColorHelp [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the color of balloon help.

Remarks

A balloon help window is displayed when the user pauses over a button that has its Help property set.


BackColorInactive, ForeColorInactive Properties

See Also	Applies To	Example

Description

Returns or sets the background and foreground colors used in the caption area of the form when it is an inactive window.

Syntax

object  .BackColorInactive [= color  ]

object  .ForeColorInactive [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the form caption's color when inactive.

Remarks

If the Caption3D property is True, the BackColorInactive property is ignored and the BevelColorFace property is used.  These properties default to the colors set in the Windows Control Panel.

The StdCaption property must be set to False for this property to be active.


BalloonHelp Property

See Also	Applies To	Example

Description

Determines if balloon help will appear when the mouse pointer is paused over a tool on the toolbar.

Syntax

object  .BalloonHelp [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether to display balloon help, as described in Settings.

Settings

Setting	Description

True	(Default) A balloon help window will appear when the mouse pointer is paused long enough (based on the BalloonHelpDelay property) over a tool that has text in its Help property.

False	A balloon help window will not appear.

Remarks

When balloon help is activated, a 'balloon help' window will be displayed just below the cursor.  This window will contain the text that was set in the tool's Help property.  The balloon help window is only displayed after the mouse stops moving over the tool for the duration specified in the BalloonHelpDelay property.


BalloonHelpDelay Property

See Also	Applies To	Example

Description

Returns or sets the amount of time (in milliseconds) that the mouse has to pause over a tool before balloon help window appears.

Syntax

object  .BalloonHelpDelay [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An long integer specifying the number of milliseconds that will elapse before balloon help is displayed.

Remarks

The help window will not appear for the following reasons:

•	The mouse pointer does not pause over the tool long enough.

•	The BalloonHelp property is set to False.

•	There is no text in the tool's Help property.

The range of the delay is from 0 to 5000 milliseconds (1000 milliseconds equals 1 second ).  The default is 500 milliseconds (one-half second.)


BevelColorFace, BevelColorHighlight, BevelColorOutline, BevelColorShadow Properties

See Also	Applies To

Description

Returns or sets the colors used to draw 3-D bevels.

Syntax

object  .BevelColorFace[= color  ]

object  .BevelColorHighlight[= color  ]

object  .BevelColorOutline[= color  ]  (Not applicable to FormFX)

object  .BevelColorShadow[= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A value or constant that determines the 3-D effect color.

Remarks

When the control needs to draw a bevel, it uses the colors specified in these properties.  These properties refer to the different parts of the bevels as shown in the diagram.


BevelColorScheme Property

See Also	Applies To

Description

Returns or sets the color scheme for the bevel colors.

Syntax

object  .BevelColorScheme [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the color scheme for the 3-D bevels, as specified in Settings.

Settings

Setting	Description

0	Gray Colors - uses white, black, light gray and dark gray from the standard Windows VGA palette.

1	System Colors - uses the system color values specified in the Windows Control Panel

2	(Default) Custom Colors - uses the color values specified in the BevelColorFace, BevelColorHighlight, BevelColorOutline and BevelColorShadow properties.

Remarks

This is how the preset color schemes are applied:

Gray Colors:	Outline = Black
Face = Light Gray
Shadow = Dark Gray
Highlight = White

System Colors:	Outline = Window Frame
Face = Button Face
Shadow = Button Shadow
Highlight = Button Highlight

Custom Colors:	Uses the colors set in the BevelColor properties.


BevelInner Property

See Also	Applies To

Description

Specifies the type of inside beveling for the toolbar.

Syntax

object  .BevelInner [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the type of inner bevel to use.

Settings

Setting	Description

0	(Default) None.  No inner bevel is drawn.

1	Inset.  The inner bevel appears as if it is inset into the screen.

2	Raised.  The inner bevel appears as if it is raised from the screen.

Remarks

This property is ignored if the Toolbar3D property is False.


BevelOuter Property

See Also	Applies To

Description

Specifies the type of outside beveling for the toolbar.

Syntax

object  .BevelOuter [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the type of outer bevel to use.

Settings

Setting	Description

0	None.  No outer bevel is drawn.

1	Inset.  The outer bevel appears as if it is inset into the screen.

2	(Default) Raised.  The outer bevel appears as if it is raised from the screen.

Remarks

This property is ignored if the Toolbar3D property is False.


BevelWidth Property

See Also	Applies To

Description

Returns or sets the width (in pixels) of both inner and outer bevels on the toolbar, which determines the amount of the 3-D shadow effect.

Syntax

object  .BevelWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the toolbar beveling.

Remarks

The valid range for this property is 0 to 30.  This property is ignored if the Toolbar3D property is False.


Binding Across Forms

When using the VBX version of the Designer Widgets controls to bind across forms, you use the DataSourceHwnd property.

The following code binds an Index Tab control on Form2 to a Visual Basic data control on Form1:

Sub Form2_Load( )

SSIndexTab1.DataSourceHwnd = SSGetControlHwnd(Form1.Data1)

End Sub

The following code illustrates the binding of a Notebook control on Form2 to a Visual Basic data control that is bound to an Index Tab control on another form:

Sub Form2_Load( )

SSNotebook1.DataSourceHwnd = Form1.SSIndexTab1.DataSourceHwnd

End Sub

Consult you host environment's documentation and the README.TXT file for more information on how to bind across forms when using the OCX version of the controls.

(See the DataSourceHwnd property for more information.)


Bold Property

See Also	Applies To

Description

Returns or sets the font style of the specified Font object to either bold or non-bold.

Syntax

object  .Bold [= boolean  ]

The Bold property syntax has these parts:

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on bold formatting.

False	Turns off bold formatting.

Remarks

The Font object is not directly available at design time. Instead you set the Bold property through a control's Font property.

At run time, however, you can set Bold directly by specifying its setting for the appropriate Font object.

In Visual Basic 3.0 you set the Bold property by selecting a control's ActiveTabFontBold, ActivePageFontBold or FontBold property in the Visual Basic Properties window.


Bookmark Property

See Also	Applies To	Example

Description

Returns the recordset bookmark property for the specified tab.

Syntax

object  .Bookmark [= variant  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

variant	A variant expression specifying a bookmark in the recordset to which the control is bound.

Remarks

When an Index Tab or Notebook control is in data bound mode (values have been specified for the DataSource and DataField properties) this property allows you to return the unique bookmark value that identifies the record in the recordset to which the tab is bound. This value can be saved to a variable and later used to reposition the control so that the bookmarked tab becomes the active tab.

This property is available only when the control is in data bound mode. If the control is not in bound mode, this property returns Null.


Border3D Property

See Also	Applies To	Example

Description

This property determines whether or not the border of the form will be displayed in 3-D.

Syntax

object  .Border3D [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the appearance of the form border, as described in Settings.

Settings

Setting	Description

True	The border of the form will be beveled.

False	(Default) The border of the form will not be beveled.


BorderWidth Property

See Also	Applies To

Description

Returns or sets the width (in pixels) of the space between the outer and inner bevels.

Syntax

object  .BorderWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the toolbar border.

Remarks

The valid range for this property is 0 to 30.


BtnEnabled Property

See "Enabled Property"


BtnGroupSpacing Property

See Also	Applies To	Example

Description

Returns or sets the number of pixels between button groups.

Syntax

object  .BtnGroupSpacing [= number  ]

Remarks

This value is applied to all button groups within a toolbar.


BtnHeight Property

See Also	Applies To

Description

Returns the height (in pixels) of the buttons on the toolbar.

Syntax

object  .BtnHeight [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the height of toolbar buttons.

Remarks

The control will calculate this value by dividing the height of the entire bitmap specified in the ToolsetPicture property by the number of button states specified in the NumBtnStates property.

This property is read-only and is only available at run time.


BtnMarginX BtnMarginY Properties

See Also	Applies To

Description

Specifies the distance (in pixels) between the toolbar buttons and the inside bevels of the toolbar.  If the toolbar has no bevels (Toolbar3D = False) then the distance is calculated from the left and top of the toolbar respectively.

Syntax

object  .BtnMarginX [= number  ]

object  .BtnMarginY [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the distance surrounding toolbar buttons.

Remarks

These properties are available at both design time and run time.


BtnSpacing Property

See Also	Applies To	Example

Description

Returns or sets how much space (in pixels) will separate each button within the same button group, as defined by the group number.

Syntax

object  .BtnSpacing [= number  ]

Remarks

Setting this to -1 will draw the buttons overlapped by one pixel so that only one border will appear between each button.  The valid range for this property is -1 to 30.


BtnToolNum Property

See "ToolNum Property"


BtnValue Property

See "Value Property"


BtnVisible Property

This property has been superseded by the standard Visible property as applied to the Button object. See "Button Object" and Important Information for Users of Version 1.0   for more information.


BtnWidth Property

See Also	Applies To

Description

Returns the width of all buttons in a toolbar.

Syntax

object  .BtnWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the common button width.

Remarks

The control will calculate this value by dividing the width of the entire bitmap specified in the ToolsetPicture property by the number of tools specified in the Count property.

This property is read-only and is only available at run time.


Btns Property

See Also	Applies To	Example

Description

Specifies the number of buttons on the toolbar.

Syntax

object  .Btns [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of buttons.

Remarks

This property is set automatically when a toolbar is defined using the Toolbar Designer.  However, you may set this property to increase or decrease the number of buttons on the toolbar.  If you increase the number of buttons, you must supply a value for the ToolNum property of each new button.  If the ToolNum property is not set for a button, it will be -1 and the following bitmap is displayed instead:

This property is only available at run time.


Button Object

See Also	Applies To

Description

A Button object represents a button that you can place on the toolbar.  A collection of related buttons is referred to as a Buttons collection.

Properties

Enabled

Placeholder

PlaceholderWidth

ToolNum

Value

Visible

Remarks

Two types of buttons are provided; a Push button which performs a specific function and always returns to the 'up' state, and a Toggle button which toggles between the 'up' and 'down' state.

•	When using the VBX version of the control, this object must be accessed via the X object. See Compatibility Issues  for more information.


Buttons Collection

See Also	Applies To

Description

A Buttons collection is a collection of Button objects.  Each button represents a specific function.

Properties

Count

Item

Remarks

•	When using the VBX version of the control, this object must be accessed via the X object. See Compatibility Issues  for more information.


Caption Property

See Also	Applies To	Example 1	Example 2

Description

Returns or sets the caption for the form or of the currently selected tab at design time, or of an individual form, page object or tab object at run time.

Syntax

object  .Caption [= text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that evaluates to the text displayed as the caption.

Remarks

When used with SSFormFX, this property sets the caption of the form. If this property is used, the form's Caption property should be left blank

If you want to set the caption of the form at run time, set this property and not the form's caption property. However, if you leave this property blank, it will default to the form's caption.

When used with the Notebook or Index Tab at design time, this property sets the caption for the currently selected tab. This property supersedes the TabCaption property from the previous version of the control. It applies at both the control level and the object level.

When used with the Notebook or Index Tab Control at run time, this property sets the caption of the active or specified Page or Tab.

The appearance of the caption is based on the Font and Font3D properties. If a TrueType font is specified, the caption will automatically be rotated to match orientation of the tab.


Caption3D Property

See Also	Applies To	Example

Description

This property determines whether or not the caption area of the form will be 3-D.

Syntax

object  .Caption3D [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the 3-D state of the form caption, as described in Settings.

Settings

Setting	Description

True	The caption area will be displayed in 3-D.

False	(Default) The caption area will not be 3-D.

Remarks

The StdCaption property must be set to False for this property to be active.


CaptionBevelInner, CaptionBevelOuter Properties

See Also	Applies To	Example

Description

Specifies the type of  bevel for the inside and outside of the caption area of the form.

Syntax

object  .CaptionBevelInner [= number  ]

object  .CaptionBevelOuter [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the bevel type, as described in Settings.

Settings

Setting	Description

0	(Default) None.  No bevel is drawn.

1	Inset.  The bevel appears as if it is inset into the screen.

2	Raised.  The bevel appears as if it is raised from the screen.

Remarks

CaptionBevelInner sets the type of beveling for the inside of the caption; CaptionBevelOuter determines the beveling for the outside. They are ignored if the Caption3D property is False.

The StdCaption property must be set to False for these properties to be active.


CaptionBevelWidth Property

See Also	Applies To	Example

Description

Returns or sets the width (in pixels) of the outer and inner bevel of the caption area of the form, which determines the amount of the 3-D effect.

Syntax

object  .CaptionBevelWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the caption bevel.

Remarks

The valid range for this property is 0 to 30.  This property is ignored if the Caption3D property is False.

The StdCaption property must be set to False for this property to be active.


CaptionBorderWidth Property

See Also	Applies To	Example

Description

Returns or sets the width (in pixels) of the space between the outer and inner bevels in the caption area of the form.

Syntax

object  .CaptionBorderWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the caption border.

Remarks

The valid range for this property is 0 to 30.  This property is ignored if the Caption3D property is False.

The StdCaption property must be set to False for this property to be active.


CaptionButtonEnabledLeft, CaptionButtonEnabledRight Properties

See Also	Applies To

Description

Determines if an individual button in the left/right set of custom caption buttons will be enabled or disabled.

Syntax

object  .CaptionButtonEnabledLeft(index  ) [= boolean  ]

object  .CaptionButtonEnabledRight(index  ) [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

index	An integer expression specifying the individual button for which to set the property.

boolean	A boolean expression specifying the state of a button, as described in Settings.

Settings

Setting	Description

True	(Default) Enabled.

False	Disabled.

Remarks

When the caption buttons are disabled, they are grayed out and the user can no longer select them.

The value of this property also determines which bitmap will be used to draw the buttons; CaptionButtonPicLeft and CaptionButtonPicRight will be used if the button is enabled, CaptionButtonPicDisLeft and CaptionButtonPicDisRight if disabled.

The index of the first (left-most or right-most) button is 0 and the index of the last button is CaptionButtonsLeft - 1 or CaptionButtonsRight - 1.

This property is available only at run time.


CaptionButtonPicDisLeft, CaptionButtonPicDisRight Properties

See Also	Applies To	Example

Description

Specifies a bitmap containing the pictures to use for each disabled button in the left/right set of custom caption buttons.

Syntax

object  .CaptionButtonPicDisLeft [= picture  ]

object  .CaptionButtonPicDisRight [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap.

Remarks

These properties are ignored if the button's Enabled property is set to True.

The bitmap specified will be divided into an even number of equal segments. Each segment will contain the picture (excluding any bevels) for either the 'up' or 'down' state of the disabled button. The first two segments contain the up and down pictures for the left-most or right-most custom caption button. The next two segments contain the up and down pictures for the following button, and so on. The number of segments needed will be equal to double the value of CaptionButtonsLeft or CaptionButtonsRight.


CaptionButtonPicLeft, CaptionButtonPicRight Properties

See Also	Applies To	Example

Description

Specifies a bitmap containing the pictures to use for each button in the left/right set of custom caption buttons.

Syntax

object  .CaptionButtonPicLeft [= picture  ]

object  .CaptionButtonPicRight [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap.

Remarks

The bitmap specified will be divided into an even number of  equal segments. Each segment will contain the picture (excluding any bevels) for either the 'up' or 'down' state of the button. The first two segments contain the up and down pictures for the left-most or right-most custom caption button. The next two segments contain the up and down pictures for the following button, and so on. The number of segments needed will be equal to double the value of CaptionButtonsLeft or CaptionButtonsRight.


CaptionButtonTypeLeft, CaptionButtonTypeRight Properties

See Also	Applies To	Example

Description

Returns or sets the type of an individual button in the left/right set of custom caption buttons. This can be either a push button or toggle button.

Syntax

object  .CaptionButtonTypeLeft(index  ) [= number  ]

object  .CaptionButtonTypeRight(index  ) [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

index	An integer expression specifying the individual button for which to set the property.

number	An integer expression specifying the button state, as described in Settings.

Settings

Setting	Description

0	(Default) Push.  This button will depress and automatically return to the 'up' position when clicked.

1	Toggle.  This button will toggle between 'up' and 'down' states when clicked.

Remarks

The value of the index determines the button to which the property will apply. The index of the first (left-most or right-most) button is 0 and the index of the last button is CaptionButtonsLeft - 1 or CaptionButtonsRight - 1.

This property is available only at run time.


CaptionButtonValueLeft, CaptionButtonValueRight Properties

See Also	Applies To	Example

Description

Determines the current status (up or down) of an individual button in the left/right set of custom caption buttons.

Syntax

object  .CaptionButtonValueLeft(index  ) [= boolean  ]

object  .CaptionButtonValueRight(index  ) [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

index	An integer expression specifying the individual button for which to set the property.

boolean	A boolean expression specifying the button status, as described in Settings.

Settings

Setting	Description

True	The button is in the 'down' position.

False	(Default) The button is in the 'up' position.

Remarks

The index of the first (left-most or right-most) button is 0 and the index of the last button is CaptionButtonsLeft - 1  or CaptionButtonsRight - 1.

This property is available only at run time.


CaptionButtonVisibleLeft, CaptionButtonVisibleRight Properties

See Also	Applies To	Example

Description

Determines if an individual button in the left/right set of custom caption buttons will be visible.

Syntax

object  .CaptionButtonVisibleLeft(index) [= boolean  ]

object  .CaptionButtonVisibleRight(index) [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

index	An integer expression specifying the individual button for which to set the property.

boolean	A boolean expression specifying the button's visibility, as described in Settings.

Settings

Setting	Description

True	(Default) Visible.

False	Not visible.

Remarks

The value of the index determines the button to which the property will apply. The index of the first (left-most or right-most) button is 0 and the index of the last button is CaptionButtonsLeft - 1 or CaptionButtonsRight - 1.

This property is available only at run time.


CaptionButtonsLeft, CaptionButtonsRight Properties

See Also	Applies To	Example

Description

Specifies the count of buttons for the left or right set of custom caption buttons.

Syntax

object  .CaptionButtonsLeft [= number  ]

object  .CaptionButtonsRight [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of buttons to display.

Remarks

These properties specify the count of custom caption buttons that appear on the left or right side of the caption area, respectively.  The valid setting for this property is 0 or greater.

Changing these values at run-time will alter the number of custom caption buttons. The values of these properties affect the display of  any bitmaps selected by the CaptionButtonPicDisLeft, CaptionButtonPicDisRight, CaptionButtonPicLeft and CaptionButtonPicRight properties.

Setting the value to zero removes all custom caption buttons for the left or right side. You can also hide custom caption buttons without removing them by using the CaptionButtonVisibleLeft and CaptionButtonVisibleRight properties.

Custom caption buttons are numbered in order from the outside of the form toward the center:


CaptionButtonsLeftClick, CaptionButtonsRightClick Events

Applies To	See Also	Example

Description

Occurs when the user presses a mouse button in the left or right set of custom caption buttons.

Syntax

Sub control_CaptionButtonLeftClick(ByVal ButtonNumber  As Integer)

Sub control_CaptionButtonRightClick(ByVal ButtonNumber  As Integer)

The event parameters are:

Parameter	Description

ButtonNumber	An integer expression that evaluates to the index of the button that was clicked, with 0 being the first (left-most or right-most) button in the group.

Remarks

This event will occur when a user clicks a mouse button in either the left or right group of custom caption buttons.


CaptionButtonsPic Property

See Also	Applies To	Example

Description

Specifies a bitmap containing the pictures to use for each standard button in the caption.

Syntax

object  .CaptionButtonsPic [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap.

Remarks

This property contains a single bitmap that contains eight equal segments.  Each segment contains the picture (excluding any bevels) for each of the standard caption buttons on a form, and for its 'up' and 'down' state.  The first two segments of the bitmap represent the control box up and down, respectively, followed by an up and down picture for the Minimize button, the Maximize button and the Restore button.  A sample bitmap is included with the control in the SAMPLES directory and it is called buttons.bmp:


CaptionHeight Property

See Also	Applies To	Example

Description

Returns or sets the height of the caption area of a form.

Syntax

object  .CaptionHeight [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the caption height.

Remarks

This property is based on the scale mode of the form. If you set this property to zero, the control will calculate the height of the caption based on the FontSize property. Setting this property to -1 removes the caption.

If the StdCaptionHeight property is set to True, this property is ignored.

The StdCaption property must be set to False for this property to be active.


CaptionMultiLine Property

See Also	Applies To	Example

Description

Determines whether or not the caption text on a form can be more than one line.

Syntax

object  .CaptionMultiLine [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the state of the caption area, as described in Settings.

Settings

Setting	Description

True	The caption can be more than one line.

False	(Default) The caption can only be a single line.

Remarks

Setting this property to True will cause a long caption to wrap to the next line.  You can also break up a line into multiple lines by separating the caption text with a carriage return/line feed sequence (Chr$(13) + Chr$(10)).

The StdCaption property must be set to False for this property to be active.


CaptionPicture Property

See Also	Applies To	Example

Description

Returns or sets the picture to be drawn in the caption area on the form.

Syntax

object  .CaptionPicture [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap, icon, metafile)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap, icon or metafile.

Remarks

Valid pictures are bitmaps, icons and Windows metafiles.  If you specify a Windows metafile, you must also set the height and width to display the picture via the CaptionPictureMetaHeight and CaptionPictureMetaWidth properties.


CaptionPictureMetaHeight, CaptionPictureMetaWidth Properties

See Also	Applies To	Example

Description

Returns or sets the height and/or width of the metafile, if specified in the CaptionPicture property.

Syntax

object  .CaptionPictureMetaHeight [= number  ]

object  .CaptionPictureMetaWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the height or width of a metafile picture in the caption area..

Remarks

The units specified are based on the scale mode of the form.


CaptionPictureX, CaptionPictureY Properties

See Also	Applies To	Example

Description

Determines the X/Y-position of the caption picture, relative to the left or right (depending upon the setting of the AlignmentPicture property) and top of the caption area.

Syntax

object  .CaptionPictureX [= number  ]

object  .CaptionPictureY [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the beginning coordinate of the picture.

Remarks

These properties are used in conjunction with the AlignmentPicture property to determine the fixed positions of the picture in the caption area.  These properties are only used when AlignmentPicture is set to 'Fixed from Right' or 'Fixed from Left'.

The CaptionPictureY property specifies the distance from the top of the caption area.  The CaptionPictureX property specifies the distance from either the left or right of the caption area.  The X-coordinate is relative to the left of the caption area if the AlignmentPicture property is set to 'Fixed from Left' and relative to the right if 'Fixed from Right'.

The units specified are based on the scale mode of the form.


Click Event (SSIndexTab, SSNotebook)

Applies To	See Also

Description

Occurs when the user selects a tab.

Syntax

Sub control_Click ([Index As Integer] PreviousTab As Integer)

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

PreviousTab	An integer expression that evaluates to the index of the tab that was previously active.

Remarks

When the user clicks on a tab, that tab becomes the active tab and all controls placed on that tab at design time become visible. The Click event notifies you when the user clicks on a tab to make it the active tab.

The ClickAfter and ClickBefore events can also be used to determine when the control has been clicked, signaling a change of page or tab.


Click Event (SSToolbar)

Applies To	Example

Description

Occurs when the user presses a button on the toolbar or a button tool's associated mnemonic character (see Mnemonic) is entered via the keyboard.

Syntax

Sub control_Click ([Index  As Integer] ID  As String, ToolNum  As Integer, Btn  As Integer, Value  As Integer)

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

ID	An string expression that evaluates to the ID string of the tool that is associated with the button that was clicked.  This is specified in the ID property of the tool.

ToolNum	An integer expression that evaluates to the index of the button's tool in the toolset.

Btn	An integer expression that evaluates to he button's index number (0 is the leftmost button on toolbar).

Value	An integer expression that reflects the button's state after  the click.

Setting	Description

True 	The button remains pressed (down) after the click.

False	The button returns to the raised (up) position after the click.


ClickAfter Event

Applies To	See Also

Description

Occurs when the user selects a tab and after the control has changed.

Syntax

Sub control_ClickAfter ([Index As Integer] PreviousTab As Integer, PreviousPage As Integer)

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

PreviousTab	An integer expression that evaluates to the index of the tab that was previously active.

PreviousPage	An integer expression that evaluates to the index of the page that was previously active.

Remarks

The ClickAfter event occurs immediately after the control has changed in response to a Click event. This ususally indicates that the active page or tab has changed.


ClickBefore Event

Applies To	See Also

Description

Occurs when the user selects a tab, but before the control changes.

Syntax

Sub control_ClickBefore ([Index As Integer] SelectedTab  As Integer, SelectedPage  As Integer)

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

SelectedTab	An integer expression that evaluates to the index of the tab that has been selected and is about to become active.

SelectedPage	An integer expression that evaluates to the index of the page that has been selected and is about to become active.

Remarks

The ClickBefore event occurs immediately before the control has changed in response to a Click event. This ususally indicates that the active page or tab is about to change.


Client3D Property

See Also	Applies To

Description

This property determines if the client area of the form will have a 3-D bevel around its edge.

Syntax

object  .Client3D [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying beveling of the client area, as described in Settings.

Settings

Setting	Description

True	The client area will be beveled.

False	(Default) The client area will not have a bevel.

Remarks

If you use this property to draw a 3-D bevel around the client area of a form, be sure to set the BackColor property of the form to the same color as the BevelColorFace property to complete the 3-D look.


ClientBevelInner, ClientBevelOuter Properties

See Also	Applies To	Example

Description

Specifies the type of bevel for the client area of the form.

Syntax

object  .ClientBevelInner [= number  ]

object  .ClientBevelOuter [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying beveling of the client area, as described in Settings.

Setting	Description

0	(Default) None.  No bevel is drawn.

1	Inset.  The bevel appears as if it is inset into the screen.

2	Raised.  The bevel appears as if it is raised from the screen.

Remarks

ClientBevelInner sets the type of beveling for the inside of the client area; ClientBevelOuter determines the beveling for the outside. They are ignored if the Client3D property is False.


ClientBevelWidth Property

See Also	Applies To	Example

Description

Returns or sets the width (in pixels) of the inner and outer bevel of the client area of the form, which determines the amount of the 3-D effect.

Syntax

 object  .ClientBevelWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the beveling of the client area.

Remarks

The valid range for this property is 0 to 30.  This property is ignored if the Client3D property is False.


ClientBorderWidth Property

See Also	Applies To	Example

Description

Returns or sets the width (in pixels) of the space between the outer and inner bevels in the client area of the form.

Syntax

object  .ClientBorderWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the border of the client area.

Remarks

The valid range for this property is 0 to 30.  This property is ignored if the Client3D property is False.


ClientHeight Property

See Also	Applies To

Description

Returns the height of the client area within the tab.  The client area is defined as the empty area outside of the tab caption area where child controls may be placed.

Syntax

object.ClientHeight [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the height of the client area.

Remarks

This property is read-only and its value is based on the scale mode of its container.


ClientLeft Property

See Also	Applies To

Description

Returns the left coordinate of the client area within the tab. The client area is defined as the empty area outside of the tab caption area where child controls may be placed.

Syntax

object.ClientLeft [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the left coordinate of the client area.

Remarks

This property is read-only and is based on the scale mode of its container.


ClientMove Property

See Also	Applies To	Example

Description

This property determines whether or not the form can be moved by clicking on the client area.

Syntax

object  . ClientMove [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying how the form can be moved, as described in Settings.

Settings

Setting	Description

True	The form can be moved by clicking on the client area and dragging the mouse.

False	(Default) The form can only be moved only by clicking in the caption area.

Remarks

When this property is True, the user can move the form by clicking anywhere in its client area. Normally, the form can be moved only by clicking on the title bar in the caption area.

The inside areas of container controls such as the Frame, 3-D Frame and 3-D Panel are not part of the client area. Therefore, the form cannot be moved if the mouse is clicked inside one of these controls.

Setting this property to True will prevent certain controls in the client area from receiving mouse events. This behavior affects only controls that do not have a window handle, most notably the Label and Image controls. Placing these controls inside a container control will allow them to receive mouse events normally.


ClientTop Property

See Also	Applies To

Description

Returns the top coordinate of the client area within the tab. The client area is defined as the empty area outside of the tab caption area where child controls may be placed.

Syntax

object.ClientTop [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the top coordinate of the client area.

Remarks

This property is read-only and is based on the scale mode of its container.


ClientWidth Property

See Also	Applies To

Description

Returns the width of the client area within the tab. The client area is defined as the empty area outside of the tab caption area where child controls may be placed.

Syntax

object.ClientWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the width of the client area.

Remarks

This property is read-only and is based on the scale mode of its container.


Compatibility Issues

An Introduction to OCX Controls

What is an OCX control?

How is an OCX control different from a VBX control?

When Should I Use OCX controls?

Object Concepts

Sub-Objects and Collections

The X object

Compatibility with OCX controls

Property Pages

The Property Pages Interface

Accessing Property Pages

Fonts

Pictures

Binding Across Forms


CompatibilityMode Property

Applies To	Example

Description

Determines whether the display of  multiple rows of tabs will be compatible with earlier versions of the Index Tab control.

Syntax

object  .CompatibilityMode [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the display of the control, as described in Settings.

Settings

Setting	Description

True	The display of the control will be compatible with earlier versions of the Index Tab control.

False	(Default) The control will use the new display mode.

Remarks

To provide a consistent look, the earlier version of the Index Tab control altered the stacking order of all tab rows after the first one. In the first row, the left-most tab is on the top of the stack. In the second row, the tab furthest to the right is on the top of the stack.  When this property is set to True, the Index Tab control retains compatibility with the earlier version.

When this property is False, the stacking order of the tabs is the same in each row of the control; the left-most tab is on the top, with succeeding tabs being displayed underneath it.


Control Limitations

Although the FormFX control provides you with extensive flexibility to customize forms in Visual Basic, there are some limitations you should be aware of when using the control.  The limitations are:

1.	The form cannot have scroll bars. If you are using a custom control to provide scroll bars on a form (such as VBAssist's Form Scroll Control), place a picture box on the form and size it so that it is the same size as the form's client area.  Then, place the scroll control and all other controls you want to scroll inside the picture box.

2.	The form cannot have a menu.

3.	If FormFX is used on an MDI Parent form, only the properties relating to sizing and positioning will work. Customization of the border, caption or client areas will have no effect.

If the SSFormFX control is used under any of the above circumstances, properties used to customize the form's appearance will be ignored.


ControlBox3D Property

See Also	Applies To	Example

Description

This property determines if the control box on the form will be 3-D.

Syntax

object  .ControlBox3D [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the appearance of the control box, as described in Settings.

Settings

Setting	Description

True	The control box will be 3-D.

False	(Default) The control box will not be 3-D.

Remarks

This property adds bevels to a standard or customized control box, giving it a 3-D look.

The StdCaption property must be set to False for this property to be active.


ControlBoxWidth Property

See Also	Applies To	Example

Description

Returns or sets the width (in pixels) of the form's control box.

Syntax

object  .ControlBoxWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the control box..

Remarks

By setting this property, the width of the control box can be different than that of a normal control box.  If this property is set to 0, then the control will use the standard control box width.

The StdCaption property must be set to False for this property to be active.


Copyright Notice
Copyright © 1994-1995 Sheridan Software Systems, Inc. All rights reserved.

Information in this document is subject to change without notice and does not represent a commitment on the part of Sheridan Software Systems, Inc.  The software described in this document is furnished under a license agreement or nondisclosure agreement.  The software may be used or copied only in accordance with the terms of the agreement.  It is against the law to copy the software on any medium except as specifically allowed in the license or nondisclosure agreement.  No part of this manual may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose without the express written permission of Sheridan Software Systems, Inc.

Designer Widgets, the Sheridan logo, VBAssist, the Sheridan Reusable Components logo and Sheridan Reusable Components are trademarks of Sheridan Software Systems, Inc.

Microsoft, Visual Basic and Windows are registered trademarks of Microsoft Corporation.

All other trademarks and registered trademarks are the property of their respective owners.

This help file was produced using Microsoft Word for Windows from Microsoft Corporation and ForeHelp from ForeFront, Incorporated.


Count Property

See Also	Applies To	Example

Description

Returns or sets the total number of tabs or pages in the specified collection.

Syntax

object  .Count [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of items in the collection.

Remarks

At design time, the Count property of the Tabs and Pages collections can be changed using the TabCount and PageCount properties, respectively.

When applied to the ToolsetTools collection, this property supersedes the ToolsetNumTools property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTools collection and not the control itself.


CoverAlignmentPicture Property

See Also	Applies To

Description

Determines how the picture will be aligned on the cover.

Syntax

object  .CoverAlignmentPicture [= setting]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the alignment of the picture on the Notebook's cover, as described in Settings.

Settings

Setting	Description

0	Left Justify - Top

1	(Default) Left Justify - Middle

2	Left Justify - Right

3	Right Justify - Top

4	Right Justify - Middle

5	Right Justify - Right

6	Center - Top

7	Center - Middle

8	Center - Right


CoverAllowClose Property

Applies To

Description

Determines whether the cover will close when clicked.

Syntax

object  .CoverAllowClose [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the cover will close, as described in Settings.

Settings

Setting	Description

True	(Default) Cover will close when clicked.

False	Cover will not close when clicked.


CoverBackColor Property

See Also	Applies To

Description

Returns or sets the background color of the cover.

Syntax

object  .CoverBackColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the cover color.

Remarks

For the cover to be visible, the CoverVisible property must be set to True.


CoverCornerStyle Property

See Also	Applies To

Description

Returns or sets the style of the cover corners.

Syntax

object  .CoverCornerStyle [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the cover corner style, as described in Settings.

Settings

Setting	Description

0	(Default) Rounded

1	Square

2	Chamfered


CoverCreaseColor Property

See Also	Applies To

Description

Returns or sets the color of the cover creases.

Syntax

object  .CoverCreaseColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the cover crease color.

Remarks

For this property to be active, the CoverCreaseStyle property must be set to either '1 -  Single', or '2 -  Double'.


CoverCreaseStyle Property

See Also	Applies To

Description

Returns or sets the style of the cover's creases.

Syntax

object  .CoverCreaseStyle [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the style of the cover creases, as described in Settings.

Settings

Setting	Description

0	None

1	(Default) Single

2	Double


CoverGuardStyle Property

See Also	Applies To

Description

Returns or sets the style of the cover's corner guards.

Syntax

object  .CoverGuardStyle [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the style of the cover guards, as described in Settings.

Settings

Setting	Description

0	(Default) None

1	Gold

2	Chrome

3	3-D


CoverMarginX, CoverMarginY Properties

See Also	Applies To

Description

Specifies the horizontal or vertical distance between the cover's edge and the tabs.

Syntax

object  .CoverMarginX [= number  ]

object  .CoverMarginY [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the distance from the edge of the cover to the edge of the tabs.

Remarks

CoverMarginY also affects the distance between the edge of the cover and the spine.

The units specified are based on the scale mode of the form.  Valid settings for these properties are 0 or greater.


CoverPicture Property

See Also	Applies To

Description

Specifies the picture for the front cover.

Syntax

object  .CoverPicture [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap, icon, metafile)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap, icon or metafile.

Remarks

If a metafile is used, the picture will be stretched to the full height and width of the cover.


CoverShadow Property

See Also	Applies To

Description

Determines whether or not to display the cover shadow.

Syntax

object  .CoverShadow [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the visibility of the cover shadow, as described in Settings.

Settings

Setting	Description

True	(Default) Cover shadow will be displayed.

False	Cover shadow will not be displayed.


CoverShadowColor Property

See Also	Applies To

Description

Returns or sets the color of the cover's shadow.

Syntax

object  .CoverShadowColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the cover shadow color.

Remarks

For this property to be active, the CoverShadow property must be set to True. The size of the shadow is determined by the CoverShadowSize property.


CoverShadowSize Property

See Also	Applies To

Description

Returns or sets the size of the cover's shadow.

Syntax

object  .CoverShadowSize [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the cover shadow.

Remarks

For this property to be active, the CoverShadow property must be set to True. The value of this property is based on the scale mode of the form.


CoverVisible Property

See Also	Applies To

Description

Determines whether or not the cover will be visible.

Syntax

object  .CoverVisible [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the visibility of the cover, as described in Settings.

Settings

Setting	Description

True	(Default) Cover will be visible.

False	Cover will not be visible.


Creating Runtime TB Example 1
Creating a Toolbar at Runtime - Example 1

The following code template shows how to create a toolset from individual pictures. It would normally be placed in the Load event of the form, but could also be executed at any time. In this example, the Name of the SSToolbar control is 'Tb1'. The variables that you need to supply are enclosed in brackets [ ].

Dim I As Integer

'first clear any previous toolset picture

Tb1.ToolsetTools.Picture = LoadPicture("")

'set the name for toolset (optional)

Tb1.ToolsetTools.Name = [descriptive name]

'then create the toolset using individual pictures

Tb1.ToolsetTools.NumBtnStates = [# of states(2, 3 or 4)]

Tb1.ToolsetTools.NumTools = [# of tools in toolset]

For i = 0 to Tb1.ToolsetTools.NumTools - 1

Tb1.ToolsetTool(i).ID = [unique 16 char ID]

Tb1.ToolsetTool(i).Type = [0 = push, 1 = toggle]

Tb1.ToolsetTool(i).Desc = [status bar desc]

Tb1.ToolsetTool(i).Help = [balloon help text]

Tb1.ToolsetTool(i).Mnemonic = [accelerator char]

Tb1.ToolsetTool(i).Group = [group #]

Tb1.ToolsetTool(i).Exclusive = [True/False]

Tb1.ToolsetTool(i).AllowAllUp = [True/False]

' Individual tool pictures

' see text below about

' picture properties

Tb1.ToolsetTool(i).PictureUp = [up bitmap]

Tb1.ToolsetTool(i).PictureDn = [down bitmap]

'if NumBtnStates > 2

Tb1.ToolsetTool(i).PictureUpDis = [up disabled bitmap]

'if NumBtnStates > 3

Tb1.ToolsetTool(i).PictureDnDis = [down disabled bitmap]

Next i

'attach the tools to buttons

Tb1.Btns = [# of buttons in toolbar]	'does not have to be

'the same as the #

'of tools in the toolset

For i = 0 to Tb1.Btns - 1

Tb1.Button(i).ToolNum = [index of tool in toolset array]

Tb1.Button(i).Visible = [True/False]

Tb1.Button(i).Enabled = [True/False]

Tb1.Button(i).Value = [False is up, True is down]

Next I


Creating Runtime TB Example 2
Creating a Toolbar at Runtime - Example 2

Suppose you had a toolbar ('Tb1') on one form ('F1') and you wanted to let the user add a tool to it from another toolbar ('Tb2') on another form ('F2'), and the tool that you wanted to add was the fourth button from the left on Tb2.

Here is how you would do it:

Dim ExistingTool as Integer

Dim NewTool as Integer

Dim NewButton as Integer

ExistingTool = F2!Tb2.Button(3).ToolNum	'get tool index of

'4th button in Tb2

'add a button to the toolbar on Form 1

NewTool = F1!Tb1.ToolsetTools.NumTools	'total tools in Tb1

F1!Tb1.ToolsetTools.NumTools = NewTool + 1	'add a tool to 	'Tb1

'set up and down tool images

F1!Tb1.ToolsetTool(NewTool).PictureUp = F2!Tb2.ToolsetTool(ExistingTool).PictureUp

F1!Tb1.ToolsetTool(NewTool).PictureDn = F2!Tb2.ToolsetTool(ExistingTool).PictureDn

'if NumBtnStates > 2 set up disabled tool image

If (F1!Tb1.ToolsetTools.NumBtnStates > 2) And (F2!Tb2.ToolsetTools.NumBtnStates > 2) Then

F1!Tb1.ToolsetTool(NewTool).PictureUpDis = F2!Tb2.ToolsetTool(ExistingTool).PictureUpDis

End If

'if NumBtnStates > 3 set down disabled tool image

If (F1!Tb1.ToolsetTools.NumBtnStates > 3) And (F2!Tb2.ToolsetTools.NumBtnStates > 3) Then

F1!Tb1.ToolsetTool(NewTool).PictureDnDis = F2!Tb2.ToolsetTool(ExistingTool).PictureDnDis

End If

'set remaining properties

F1!Tb1.ToolsetTool(NewTool).ID = F2!Tb2.ToolsetTool(ExistingTool).ID

F1!Tb1.ToolsetTool(NewTool).Type = F2!Tb2.ToolsetTool(ExistingTool).Type

F1!Tb1.ToolsetTool(NewTool).Desc = F2!Tb2.ToolsetTool(ExistingTool).Desc

F1!Tb1.ToolsetTool(NewTool).Help = F2!Tb2.ToolsetTool(ExistingTool).Help

F1!Tb1.ToolsetTool(NewTool).Mnemonic = F2!Tb2.ToolsetTool(ExistingTool).Mnemonic

F1!Tb1.ToolsetTool(NewTool).Group = F2!Tb2.ToolsetTool(ExistingTool).Group

F1!Tb1.ToolsetTool(NewTool).Exclusive = F2!Tb2.ToolsetTool(ExistingTool).Exclusive

F1!Tb1.ToolsetTool(NewTool).AllowAllUp = F2!Tb2.ToolsetTool(ExistingTool).AllowAllUp

'add a button to the toolbar on Form 1

NewButton = F1!Tb1.Btns	'total buttons in Tb1

F1!Tb1.Btns = NewButton + 1	'add a button to Tb1

F1!Tb1.Button(NewButton).ToolNum = NewTool

F1!Tb1.Button(NewButton).Visible = True

F1!Tb1.Button(NewButton).Enabled = True

F1!Tb1.Button(NewButton).Value = False

Note	The above example assumes that the dimensions of all the tools (BtnWidth and BtnHeight) in both toolsets are the same. If they are not, the new tool may not look right. Therefore, if you plan to provide this type of facility in your applications (moving or copying tools between toolbars), you will need to standardize the size of the buttons.


Creating a Toolbar at Run Time

Example 1	Example 2

Creating toolsets and toolbars at design time using the Toolbar Designer requires no coding on your part. However, there are situations where it might be necessary to dynamically create a toolbar and its underlying toolset. For example, suppose you wanted to give the user the flexibility of building a custom toolbar at run time. You might want to offer the user a choice of tools from a number of toolsets. This is possible since all of the properties that relate to toolsets and toolbars are modifiable by code.

There are two ways of creating the toolset picture at run time:

•	Set the individual pictures for each state of every tool via the PictureUp, PictureDn, PictureUpDis and PictureDnDis properties.

•	Set ToolsetPicture to a bitmap containing all the states for every tool.

Note that either method requires that Count and NumBtnStates also be set.

After setting NumBtnStates and Count properties, the first individual tool picture you set will cause BtnWidth and BtnHeight to be automatically calculated by the control, based on the picture's size. To subsequently change BtnWidth and BtnHeight, you must first reset the ToolsetPicture property using the LoadPicture("") statement.

Remember that instead of setting the individual pictures for each state of every button, as in Example 1, you can set the ToolsetPicture property to a single bitmap that contains all of these images.

Actually, the individual picture properties PictureUp, PictureDn, PictureUpDis and PictureDnDis are not kept as separate bitmaps by the toolbar. They are used just like the GraphicCell() property in the Picture Clip control (included in the Visual Basic Professional Edition) except that they are not read-only properties.

Keep in mind that when you set any of these individual picture properties, you are in fact updating an area of the larger (all inclusive) ToolsetPicture bitmap. By taking this segmented approach, the impact on system resources is greatly minimized.

If you would like to see more sample code, look at the projects that are prefixed with TBAR in the samples directory.


Credits 1
Return to help


Credits 2
Return to help


Customizing the Standard Caption Buttons

You can use FormFX to customize the standard buttons that appear in the caption (control box, minimize, maximize and restore buttons).  To customize these buttons, you must assign a bitmap to the CaptionButtonsPic property.

The CaptionButtonsPic property is used to specify a bitmap that contains both the up and down states for all four standard caption buttons.  The bitmap is a standard Windows bitmap, created by any bitmap editor (such as the Toolset Bitmap Editor).  It is broken up into eight equal segments.  Each segment represents the picture to use for a state (up or down) of one of the buttons.  The first segment contains an image for the control box's up position, the second contains the image for its down position, and so on.  Shown below is a sample bitmap (supplied with Designer Widgets in the SAMPLES directory) that illustrates the different segments:

The FormFX control uses this bitmap to display the buttons in the caption area. The control divides the bitmap evenly into eight segments, then assigns each segment of the bitmap to a button. The segments do not have to be a specific width or size, as long as they are equal in size.

If a segment is smaller than a button, the FormFX control will center the image and fill the rest of the area with the color defined in the BevelColorFace property.  If it is larger than the button, the control will center the image over the button, eliminating any edges that fall outside of the button's dimensions.


DataField Property

See Also	Applies To

Description

Returns or sets a value that binds the tab captions to a field in the current database record.

Syntax

object  .DataField [= value  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

value	A string expression that evaluates to the name of one of the fields in the Recordset object specified by the Data control named in the DataSource property, to which the captions of the control will be bound.

Remarks

The captions of a Tab or Notebook control can be bound to a database field, giving you the power to transform the control into an intuitive database front end. Binding the control to a database changes it's behavior in several significant ways. For more information , see Using the Control in Data Bound Mode .


DataSourceHwnd Property

Applies To

Description

Returns the window handle (hWnd) of a data control used to bind the control at run time.

Syntax

object  .DataSourceHwnd [= hWnd  ]

The DataSourceHwnd property syntax has these parts:

Part	Description

object	An object expression that evaluates to an object in the Applies To list.

hWnd	A Long integer expression (when using 32-bit OCX version) or integer expression (when using VBX or 16-bit OCX version)  that evaluates to the window handle of the data control to bind the control to at run time.

Remarks

The purpose of this property is to allow you to set the data source of the control at run time.  Set this property to the window handle of the data control to bind the control.  If you set the DataSource property at design time, this property will automatically be set to the hWnd of the data control at run time and will be read-only.

The main benefit of this property is to be able to set the data source to a data control on a different form.

Note	Visual Basic 3.0 does not supply the hWnd property for the data control.  To get the hWnd for a data contol, you can either use the DataSourceHwnd property of any Sheridan data-aware control that exposes the hWnd of a data control, or call an API function called SSGetControlHwnd in any of Sheridan's data-aware OCX or VBX files.  See the Declare statement for this API in the SSDESWDG.BAS file that comes with Designer Widgets.

This property is only available at run time.


DeferDocking Property

See Also	Applies To	Example

Description

Disables changes to the docking status of the toolbar.

Syntax

object .  DeferDocking [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression that determines how the dock status of the toolbar will be changed, as described in Settings.

Settings

Setting	Description

True	The docking status of the toolbar will not be changed.

False	The docking status of the toolbar will change normally in response to user or program activity.

Remarks

This property is available only at run-time.

DeferDocking is used to temporarily disable the toolbar while changes that affect the docking status are made in code. Using this property, you can make several changes to the toolbar in code without having its appearance change unexpectedly, which may distract the user. Properties affected by the DeferDocking property are:

DockRank

DockRankSeq

DockStatus

Visible

To apply a batch of changes to a toolbar control in code, you would set DeferDocking to True, make the changes, then set DeferDocking to False, which will cause the changes to be applied

DeferDocking property affects all of the toolbars in a particular docking area. Setting it for a single toolbar defers changes to all the toolbars that are docked in the same area.


Desc Property

See Also	Applies To	Example

Description

Contains a description of the Tool object.

Syntax

object  .Desc [= text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that evaluates to the text displayed as the tool description.

Remarks

This property supersedes the ToolsetToolDesc property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTool object and not the control itself.

This property is only available at run time. However, it can be initially set at design time using the Toolbar Designer.


Designer Widgets CONTENTS
Version 2.02	Copyright Notice	Credits

	The Designer Widgets Controls Description of the Designer Widgets controls and how to use them.
	What's New A summary of features that have been added or changed since version 1.0
	Guided Tours A step-by-step guide to using Designer Widgets
	Control Reference An alphabetical listing of all programming language topics
	Properties	Objects
	Events	Collections
	Methods
	Compatibility Issues A list of considerations when using the VBX or OCX versions of the controls.
	Technical Specifications A list of system requirements and included files.
	Technical Support Obtaining technical and product support for Sheridan products.


Designer Widgets Controls

Using Designer Widgets
Explains how to use the Designer Widgets custom controls in your development environment.  A brief overview of the significant differences between the VBX and OCX custom controls is also provided.

Dockable Toolbar control
Gives your applications a floating, docakable toolbar that you design.

Index Tab control
Organizes controls in your application using tabbed dividers and pages.

Notebook control
Provides a virtual notebook interface for your programs.

Form FX control
Customize the appearance and behavior of your application's windows.


Distribution Notes

In order to take advantage of the latest OLE technology, the following Microsoft® files must be distributed with your Designer Widgets application.

The following files are required for 16-bit components only (VBX and 16-bit OCX). They should be  placed in the \WINDOWS\SYSTEM directory:

Filename(s)	Description

COMPOBJ.DLL	2.02 or later

OLE2.DLL	2.02 or later

OLE2DISP.DLL	2.03 or later

OLE2NLS.DLL	2.03 or later

STORAGE.DLL	2.02 or later

VBOA300.DLL	3.00.0525 or later (for Visual Basic 3.0 applications)

VBRUN300.DLL	(for Visual Basic 3.0 applications)

When using the VBX version of the Designer Widgets controls you must also ship the following file:

Filename(s)

MFCOLEUI.DLL

When using the 16-bit OCX version of the Designer Widgets controls you must also ship the following files:

Filename(s)

OC25.DLL

TYPELIB.DLL

When using the 32-bit OCX version of the Designer Widgets controls you must ship the following files. (The above files are not required for 32-bit only applications):

Filename(s)

MSVCRT.DLL

MFC42.DLL

OLEAUT32.DLL

OLEPRO32.DLL

STDOLE2.TLB

Each system should contain the appropriate OLE support files in addition to the VBX and/or OCX version(s) of the Designer Widgets controls.  All of the above files are included with Designer Widgets.

Depending upon your development environment, you may need to distribute other files with your application. Consult the manual or on-line help system of your environment for further details.


DockRank Property

See Also	Applies To

Description

Returns or sets the position of the toolbar relative to other toolbars when positioned in the same docking area.

Syntax

object  .DockRank [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying rank of the toolbar when docked.

Remarks

When a toolbar is docked at the top or bottom of a form, DocRank indicates the row which the toolbar occupies.  When docked at the left or right of a form, DocRank indicates which column the toolbar occupies. If two or more toolbars have the same setting for the DockRank property, the toolbar will use the DockRankSeq property to determine the order with the same rank.

When a toolbar is initially displayed in a docked position, the control will search for other toolbars that are also docked in the same area.  The control will then compare the DockRank property to that of the other toolbars and position it either before or after the others.

At run time, the value of the DocRank property changes dynamically to reflect the docked status of the toolbars.

This property is useful when saving the docked positions of the toolbars in an application.  The next time the application is run, you can set this property to its previous setting to restore a toolbar to its previously docked position.  Also refer to the DocRankSeq, FloatingLeft, FloatingTop and FloatingWidthInBtns  properties for more information on how to save and restore floating toolbars between program executions.


DockRankSeq Property

See Also	Applies To

Description

Returns or sets the position of the toolbar relative to other toolbars in the same docking area with the same DocRank setting.

Syntax

object  .DockRankSeq [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the sequence of the toolbar when docked.

Remarks

If two or more toolbars in the same docking area have the same setting for the DockRank property, the toolbar will position them based on the DockRankSeq property.  For toolbars docked at the top and bottom of a form, DocRankSeq determines the left-to-right order of toolbars in the same row. For toolbars docked on the left or right of a form, DocRankSeq determines the top-to-bottom order of toolbars in the same column.

When a toolbar is initially displayed in a docked position, the control will search for other toolbars that are also docked in the same area and have the same DocRank setting.  The control will then compare the DockRankSeq property to that of the other toolbars and position it either before or after the others.

At run time, the value of the DocRankSeq property changes dynamically to reflect the docked status of the toolbars.

This property is useful when saving the docked positions of the toolbars in an application.  The next time the application is run, you can set this property to its previous setting to restore a toolbar to its previously docked position.  Also refer to the DocRank, FloatingLeft, FloatingTop and FloatingWidthInBtns properties for more information on how to save and restore floating toolbars between program executions.


DockStatus Property

See Also	Applies To	Example

Description

Returns or sets the docked or floating status of the toolbar.

Syntax

object  .DockStatus [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the docking status of the toolbar, as described in Settings.

Settings

Setting	Description

0	(Default) Top - the toolbar will be docked along the top.

1	Left - the toolbar will be docked along the left side.

2	Bottom - the toolbar will be docked along the bottom.

3	Right - the toolbar will be docked along the right side.

4	None (Floating) - the toolbar will not be docked.

Remarks

If you set this property to '4 - None (Floating)', the toolbar will appear in a separate window. If the toolbar was not previously in a floating state, the new window will appear at the coordinates specified by the FloatingLeft and FloatingTop properties. If the toolbar was floating before in the current instance of the application, it will appear at its previous location.

Setting this property to any other value will cause the toolbar to dock in one of the docking areas.  The toolbar will then be positioned based on the DockRank and DockRankSeq properties.

You can set this property at design time to specify where the toolbar will initially be positioned at run time. At run time, this property changes dynamically to reflect the status of the toolbar.


DockStatusChanged Event

Applies To	Example

Description

Occurs after the toolbar has changed its docked position.

Syntax

Sub control_DockStatusChanged ([Index As Integer] PreviousDock As Integer)

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

PreviousDock	An integer expression that identifies the previous dock status of the toolbar.

Setting	Description

0	Top - The toolbar was previously docked in the top docking area.

1	Left - The toolbar was previously docked in the left docking area.

2	Bottom - The toolbar was previously docked in the bottom docking area.

3	Right - The toolbar was previously docked in the right docking area.

4	None (Floating) - The toolbar was previously floating.

Remarks

This event will also occur when the toolbar becomes a floating toolbar.  To get the new dock status, use the DockStatus property.


Dockable Toolbar Collections

Objects marked with a · are only accessible via the X object when using the VBX version of the control.

Buttons Collection

ToolsetTools Collection


Dockable Toolbar Control
The Dockable Toolbar control

Properties	Events	Methods	Objects	Collections

The Dockable Toolbar is a custom control that gives you the power to easily add fully functional toolbars to an application while using a minimum of system resources. Toolbars can be made to float freely or be docked to the top, bottom, left or right of the form. This is the same interface used by many of today's 'state-of-the-art' commercial applications.

Toolbars & Buttons

Docked & Floating Toolbars

ToolsetTools Collection

Using the Toolset Bitmap Editor

Using the Toolbar Designer

Creating a Toolbar at Run Time

Using a Child Control on the Toolbar

Considerations

Procedure

Important for users of Version 1.0

Back to list of all controls


Dockable Toolbar Events
Dockable Toolbar Control Events

Click Event

DblClick Event

DockStatusChanged Event

DragDrop Event

DragOver Event

Help Event

MouseDown Event

MouseEnter Event

MouseExit Event

MouseMove Event

MouseUp Event

ToolbarClosed Event

ToolbarResized Event


Dockable Toolbar Exercise 1:Creating a Toolbar on an MDI Form
Exercise 1:Creating a Toolbar on an MDI Form

See Also

In this exercise, you will add a single toolbar to an MDI form.

1.	First, create an MDI form (by choosing 'New MDI Form' from the File menu.)

2.	Place an SSToolbar control directly on the MDI form by double clicking on the [image] tool in the Visual Basic toolbox.

3.	In the Visual Basic properties window, set the following properties:

FloatingCaption 	= 'Standard'

Name 	= 'Tb1'

4.	Double click on the (ToolbarDesigner) property. This will invoke the Toolbar Designer.  For a complete explanation of the Toolbar Designer, refer to Using the Toolbar Designer.

5.	Press the 'Select Toolset...' button. This will bring up a File Open dialog. Locate the TOOLSETS subdirectory, which was created during installation as a subdirectory of your main Designer Widgets directory. Select the file named TSBASIC.BMP.

6.	Now, drag each tool from the 'Available Tools' box into the area labeled 'Toolbar', or press the 'Add All Tools' button.

7.	The Toolbar Designer should now look like this:

8.	You can experiment with arranging the tools in different order, until you have the toolbar you want. Then press the 'OK' button.

9.	Bring up the Visual Basic 'Project Options' dialog  (via the 'Options', 'Project...' menu items) locate the 'Start Up Form' option and choose your MDI form as the start-up form.

10.	At this point you should save the project.

11.	Now run the project by pressing F5.  You will see the toolbar in the top docking area.

12.	Click on an area of the toolbar where there is no button and drag the toolbar off of the top docking area.  When you see the outline of the toolbar change, release the mouse button. The toolbar will be in a small floating window with a caption of 'Standard'.

13.	Try resizing the floating toolbar with the mouse.  Notice how it resizes itself in button increments, automatically adjusting the button locations.

14.	Now, drag the toolbar over to the left side of the form.  As you move over the docking area, the outline will change to a vertical orientation.  When it does, release the mouse button. The toolbar will dock along the left side of the form, with the buttons in a vertical arrangement. Try dragging and dropping the toolbar onto the bottom and right docking areas as well.

15.	Now, double click on the toolbar (not on one of its buttons).  The toolbar will leave the docking area and float in a window.  Double click on it again and it will return to its previous docking location.


Dockable Toolbar Exercise 2: Creating a Second Toolbar
Exercise 2: Creating a Second Toolbar

See Also

Creating a second toolbar is easy.  Just place another SSToolbar control on the same MDI form that you created in Exercise 1.

1.	In the Visual Basic properties window, set the following properties:

FloatingCaption 	= 'Format'

Name 	= 'Tb2'

2.	Double click on the (ToolbarDesigner) property.

3.	Press the 'Select Toolset...' button, but this time select the file named TSFORMAT.BMP in the TOOLSETS subdirectory.

4.	Press the 'Add All Tools' button to populate the toolset.

5.	Press the 'OK' button.

6.	At this point you should save the project.

7.	Now, run the project by pressing F5. Notice that the two toolbars can share docking areas, or they can float independently.


Dockable Toolbar Exercise 3: Providing Status Bar Help
Exercise 3: Providing Status Bar Help

See Also

The following exercise assumes you have the 3-D custom control (threed.vbx) supplied with the Visual Basic Professional Edition.  If you do not, you can create a 2-D status bar by substituting a picture box for the first panel control and a label for second panel control.

1.	Add the 3-D control to the project that you have saved in Exercises 1 and 2.

2.	On the MDI form, place a panel control using the [image] tool.

3.	Set its properties as follows:

Align	= '2 - Align Bottom'

BevelOuter 	= '2 - Raised'

BevelInner 	= '0 - None'

BevelWidth 	= 1

Caption 	= " "

4.	Now, carefully draw another panel on top of the first so that it is slightly shorter than the first panel.

5.	Set its properties as follows:

Align	= '0 - None'

BevelOuter 	= '1 - Inset'

BevelInner 	= '0 - None'

BevelWidth 	= 1

Caption 	= " "

Name	= 'pnlStatus'

6.	Position this child panel so that it looks like a section of a status bar:

7.	In the MouseEnter event of both SSToolbar controls, place the following code (where Tbx is the name of the toolbar; Tb1 or Tb2):

Sub Tbx_MouseEnter(ToolID As String, ToolNum As Integer,Btn As Integer)

pnlStatus.Caption = Tbx.X.ToolsetTools(ToolNum).Desc

End Sub

8.	In the MouseExit event of both SSToolbar controls, place the following code:

Sub Tbx_MouseExit(ToolID As String, ToolNum As Integer, Btn As Integer)

pnlStatus.Caption = ""

End Sub

9.	At this point you should save the project.

10.	Run the project. As you move the cursor over each button, you will see the status bar display a description of that button's function.

11.	You may have already noticed that when you pause the cursor over a button in one of the toolbars, balloon help for that button is displayed.  The help text for each tool is accessed via the Help property. This behavior can be controlled with the BalloonHelp and BalloonHelpDelay properties.

Also, you can delay the display of the status bar help to coincide with the display of balloon help. In Step 7 above, instead of placing the code in the MouseEnter event, place it in the Help event.


Dockable Toolbar Exercise 4: Putting Code Behind the Buttons
Exercise 4: Putting Code Behind the Buttons

See Also

You add your own code to each button on the toolbar to define the function of each tool.  The following sample code demonstrates one way you might write code to handle toolbar button events. Since this is a sample, some of the buttons are assigned to a generic function.

1.	In the Click event of the toolbar that you created in Exercise 1, place the following code:

Sub Tb1_Click (ToolID As String, ToolNum As Integer, Btn As Integer, Value As Integer)

Select Case ToolID

Case "ID_NEW"

MsgBox "This invokes the File New function"

Case "ID_OPEN"

MsgBox "This invokes the File Open function"

Case "ID_SAVE"

MsgBox "This invokes the File Save function"

Case "ID_PRINT"

MsgBox "This invokes the File Print function"

Case Else

MsgBox "This button is not yet programmed"

End Select

End Sub

2.	At this point you should save the project.

3.	Run the project and click on any of the buttons in the toolbar.  The appropriate message should be displayed.


Dockable Toolbar Exercise 5: Creating a Stationary Toolbar
Exercise 5: Creating a Stationary Toolbar

See Also

In this exercise you will add a stationary toolbar to an MDI form.  The toolbar will behave as it would on a standard Visual Basic non-MDI form.

This exercise also assumes you have the 3-D custom control (threed.vbx) supplied with the Visual Basic Professional Edition.  If not, you can substitute a picture box for the Panel control.

1.	Create a new project, making sure the 3-D and Dockable Toolbar custom controls are included.

2.	Next, create an MDI form by choosing 'New MDI Form' from the 'File' menu.

3.	Place a Panel control directly on the MDI form by double clicking on the [image] tool in the Visual Basic toolbox.

4.	In the Visual Basic properties window, set the following properties:

AutoSize	= '3 - AutoSize Child to Panel'

BevelOuter 	= '0 - None'

BevelInner 	= '0 - None'

BevelWidth 	= 0

BorderWidth 	= 0

Caption 	= " "

5.	Select the [image] tool in the Visual Basic Toolbox and draw the toolbar on top of the panel.  Do not double click on the tool to create the control since this will create the toolbar as a child of the form instead of a child of the panel.

6.	Now, set the Outline property of the toolbar control to False.

7.	Run the project.  Now the toolbar is fixed, and you won't be able to drag it as you did in Exercise 1.


Dockable Toolbar Exercise 6: Adding a Child Control to the Toolbar
Exercise 6: Adding a Child Control to the Toolbar

See Also

In this exercise you will add a child control (in the form of a combo box) to the toolbar.

1.	First, create an MDI form (by choosing 'New MDI Form' from the File menu.)

2.	Place an SSToolbar control directly on the MDI form by double clicking on the [image] tool in the Visual Basic toolbox.

3.	In the Visual Basic properties window, set the following properties:

FloatingCaption 	= 'Format'

Name 	= 'Tb1'

4.	Double click on the (ToolbarDesigner) property. This will invoke the Toolbar Designer.  For a complete explanation of the Toolbar Designer, refer to Using the Toolbar Designer.

5.	On the Toolbar Designer, press the 'Select Toolset...' button.  This will bring up a File Open dialog.  Select the file named TSFORMAT.BMP in the TOOLSETS subdirectory provided with Designer Widgets.

6.	Now, press the button labeled 'Add All Tools'.

7.	The Toolbar Designer should now look like this:

8.	Click on the [image] button, and then click on the check box labeled 'Placeholder'.

9.	Notice that the [image] button is now displayed with a handle.  Drag the handle to the right, resizing the control to the width of a typical combo box.

10.	Press the 'OK' button to close the Toolbar Designer.

11.	Now, select the [image] tool and draw a Picture control over the sized area where you are going to place the child control. Be sure to position the Picture box directly on the toolbar itself. Change the BorderStyle property of the Picture control to '0 - None.' Change the BackColor of the control to light gray. This picture box is necessary for the combo box to work correctly. See Considerations / Limitations on Child Controls.

12.	Choose the [image] tool and draw a Combo Box on top of the Picture control you just created. It should fit within the sized area.

13.	Bring up the Visual Basic 'Project Options' dialog (via the 'Options', 'Project...' menu) and set this MDI form as the start-up form.

14.	At this point you should save the project.

15.	Now run the project by pressing the F5 key.  The toolbar should be in the top docking area with the Combo Box displayed.

16.	Move the toolbar to its other docking positions.  Notice that when the toolbar is docked in the top, bottom, or floating position, the combo box is displayed normally.  However, when the toolbar is docked left or right the combo box is replaced with the placeholder button.

Exercise Notes

Both toolsets used in Exercise 1 and 2 contain button images of equal size (24 pixels wide by 22 pixels high), and none of the buttons contain any text.  You can make the button images larger or smaller, as long as all images within a single toolset are of equal size.

If you want to include text in the buttons, you will need to make a bitmap with larger buttons and place the text in the bitmap.  This can be easily done with the Toolset Bitmap Editor.  Refer to the Toolset Tools  section for a complete discussion of toolset bitmaps. The Visual Design Guide which ships with the Visual Basic 3.0 Professional Edition also offers helpful advice on designing buttons and toolsets. If you have this application installed, it will be located in your Visual Basic 3.0 program group.

You can specify an accelerator character for each tool via the Mnemonic property. However, you should be aware that accelerator characters only work within the currently active form.  Therefore, if an MDI child form is active, the accelerator characters for toolbars that are on the MDI parent will not operate.

Also note that if you have more than one toolbar on an MDI form and the buttons in the toolbars are of different sizes, the size of the docking area will be computed based on the largest button in any toolbar on the form.  This includes toolbars that are not visible.

All the properties that relate to toolsets, including Help and Desc, can be set at design time using the Toolbar Designer (see Using the Toolbar Designer )  However, all the toolset properties can also be set by code (see Creating a Toolbar at Run Time. )


Dockable Toolbar Methods

Drag Method

Move Method

Refresh Method


Dockable Toolbar Objects

Objects marked with a · are only accessible via the X object when using the VBX version of the control.

Button Object

ToolsetTool Object


Dockable Toolbar Properties

(About) Property

(Custom) Property

(ToolbarDesigner) Property

Align Property

AllowAllUp Property

AllowToolbarDockBottom Property

AllowToolbarDockLeft Property

AllowToolbarDockRight Property

AllowToolbarDockTop Property

AllowToolbarFloat Property

AllowToolbarMove Property

BackColor Property

BackColorDock Property

BackColorHelp Property

BalloonHelp Property

BalloonHelpDelay Property

BevelColorFace Property

BevelColorHighlight Property

BevelColorOutline Property

BevelColorShadow Property

BevelInner Property

BevelOuter Property

BevelWidth Property

BorderWidth Property

BtnGroupSpacing Property

BtnHeight Property

BtnMarginX Property

BtnMarginY Property

BtnSpacing Property

BtnWidth Property

Count Property

DeferDocking Property

Desc Property

DockRank Property

DockRankSeq Property

DockStatus Property

DragIcon Property

DragMode Property

Enabled Property

Exclusive Property

FloatingCaption Property

FloatingCaptionType Property

FloatingControlBox Property

FloatingLeft Property

FloatingSizable Property

FloatingTop Property

FloatingWidthInBtns Property

Font Property

FontBold Property

FontItalic Property

FontName Property

FontSize Property

FontStrikethru Property

FontUnderline Property

ForeColorHelp Property

Group Property

Help Property

HelpContextID Property

HwndToolbar Property

ID Property

Index Property

Item Property

Left Property

Mnemonic Property

MouseIcon Property

MousePointer Property

Name Property

NumBtnStates Property

Outline Property

Parent Property

Picture Property

PictureDn Property

PictureDnDis Property

PictureUp Property

PictureUpDis Property

Placeholder Property

PlaceholderWidth Property

Tag Property

Toolbar3D Property

ToolbarFloating property

ToolbarOrientation Property

ToolNum Property

Top Property

Type Property

UseSystemColors Property

Value Property

Visible Property


Docked and Floating Toolbars

When placed on a standard (non-MDI) Visual Basic form or on a container control such as a picture box, the toolbar control is stationary. It has the standard Align property so that it can resize itself automatically when its container is resized. Although a toolbar is fixed, it can be made to float in its own window if the ToolbarFloating property is set to True.

When placed directly on an MDI form, the toolbar can either float independently or be docked to the top, bottom, left or right side of the MDI form. In addition, multiple toolbars can share the same docking area. The four docking areas (top, bottom, left and right) are outside the MDI form's client area, so they do not interfere with MDI child forms.

The following properties control docking and floating behavior:

•	AllowToolbarDockTop

•	AllowToolbarDockBottom

•	AllowToolbarDockLeft

•	AllowToolbarDockRight

•	AllowToolbarFloat

•	AllowToolbarMove

•	DockStatus - Tells whether the toolbar is docked at the top, left, bottom, right or is not docked (floating).

•	DockRank - Determines the relative position of docked toolbars in terms of rows and columns.

•	DockRankSeq - Determines the position of a toolbar relative to other toolbars that are docked in the same row or column.


Enabled Property

Applies To

Description

Determines whether the object can be selected by the user.

Syntax

object  .Enabled [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the state of the object, as described in Settings.

Settings

Setting	Description

True	(Default) The object can be selected by the user using the mouse or keyboard.

False	The object cannot be selected

Remarks

When applied to the Button object, his property supersedes the BtnEnabled property from the previous version.

When applied to the Tab object, his property supersedes the TabEnabled property from the previous version.


Exclusive Property

See Also	Applies To

Description

Determines if only one button in the same group should be toggled down at any time.

Syntax

object  .Exclusive [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the toggle setting of the tool, as described in Settings.

Settings

Setting	Description

True	Only one button in the same group can be toggled down (have a Value equal to True) at any time.

False	(Default) Buttons within the same group toggle independently.

Remarks

Note	When this property is set for a button in a group, then the property is automatically set to the same value for all the other buttons in the group.

When a button is pressed and this property is set to True, the control will toggle all other 'toggle' buttons in the same logical group (based on the Group property) to their 'up' positions.  If this property is set to False then the AllowAllUp property is ignored.

This property supersedes the ToolsetToolExclusive property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTool object and not the control itself.

This property is only available at run time.  However, it can be initially set at design time using the Toolbar Designer.


FloatingCaption Property

See Also	Applies To

Description

Specifies the caption text of a toolbar when it is floating.

Syntax

object  .FloatingCaption [= text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that evaluates to the text displayed as the caption for the toolbar.


FloatingCaptionType Property

See Also	Applies To

Description

Determines the look of the floating toolbar's caption area.

Syntax

object  .FloatingCaptionType [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the type of toolbar caption, as described in Settings.

Settings

Setting	Description

0	None.  No caption will be displayed when the toolbar is floating.  The user can still move the toolbar by clicking on any area not occupied by a button.

1	(Default) Small Caption.  A small caption is used.  The font name and size for the text on this type of caption is selected by the control.

2	Normal Caption.  A normal caption is used.

3	Use Font.  The caption will be sized based on the size of the font provided in the FontName property.


FloatingControlBox Property

See Also	Applies To

Description

Determines whether a control box will be displayed on a floating toolbar, to allow the user to close it.

Syntax

object  .FloatingControlBox [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the visibility of the toolbar control box, as described in Settings.

Settings

Setting	Description

True	(Default) A control box is displayed in the caption area of the floating toolbar.

False	A control box is not displayed.  (User cannot close the floating toolbar.)

Remarks

When a floating toolbar is closed via a single click on the control box, the Visible property is set to False.  A toolbar can only be re-opened by setting the Visible property back to True.


FloatingLeft, FloatingTop Properties

See Also	Applies To

Description

Determines the X-coordinate / Y-coordinate of the floating toolbar relative to the left/top of the client area.

Syntax

object  .FloatingLeft  [= number  ]

object  .FloatingTop  [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the coordinate of the floating toolbar.

Remarks

These properties will set the X-coordinate and Y-coordinate for the toolbar when floating.  Changing these properties at run time while the toolbar is floating will cause the toolbar to reposition itself in a new location.  You can also use these properties to initially set the coordinates of the floating toolbar.

The units specified are based on the scale mode of the form on which the toolbar is placed.

These properties are useful when saving the floating positions of the toolbars in an application after the user has exited.  The next time the application is run, you can set these properties to their previous settings to restore the toolbar to its previous floating position.


FloatingSizable Property

See Also	Applies To

Description

This property determines whether or not the size of the floating toolbar can be changed by the user.

Syntax

object  .FloatingSizable [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the floating toolbar can be resized, as described in Settings.

Settings

Setting	Description

True	(Default) The floating toolbar can be resized.  The control will display the floating toolbar with sizable borders.

False	The floating toolbar cannot be resized.  The control will display a single line border around the floating toolbar.


FloatingWidthInBtns Property

See Also	Applies To

Description

Determines the width of the toolbar in number of buttons when the toolbar is floating.

Syntax

object  .FloatingWidthInBtns [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the toolbar in buttons.

Remarks

The floating toolbar will automatically size itself to the number of buttons specified in this property.

This property is very useful when saving the floating size of the toolbars in an application after the user has exited.  The next time the application is run, you can set this property to its previous setting to restore the toolbar to its previous floating size.


Font Object

See Also	Applies To	Example

Description

The Font object contains information needed to format text on the control.

Properties

Bold

Italic

Name (default)

Size

Strikethrough

Weight

Underline

Remarks

You frequently identify a Font object using the Font property of an object that displays text.


Font Property

See Also	Applies To	Example

Description

Returns a Font object.

Syntax

object  .Font

Part	Description

object	An object expression that evaluates to an object in the Applies To list.

Remarks

Use the Font property of an object to identify a specific Font object whose properties you want to use.

This property is not available at design time in Visual Basic 3.0.


Font3D Property

See Also	Applies To	Example

Description

Returns or sets the 3-D style of the caption text for the form or tab.

Syntax

object  .Font3D [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the 3-D font style, as described in Settings.

Settings

Setting	Description

0	(Default) None.  Caption is displayed flat (not 3-dimensional).

1	Raised w/light shading. Caption appears as if it is raised slightly off the screen.

2	Raised w/heavy shading. Caption appears even more raised.

3	Inset w/light shading. Caption appears as if it is inset slightly into the screen.

4	Inset w/heavy shading. Caption appears even more inset.

Remarks

The Font3D property works in conjunction with all the other Font Properties.  Settings 2 and 4 (heavy shading) look best with larger, bolder fonts.  Dramatic effects can be created by combining the different Font3D setting with the other font properties.


Fonts (Appendix C)
Fonts

Fonts are supported both through font properties such as FontBold and FontItalic as well as the Font object . Both the VBX and OCX versions of the controls support the Font object.

At design time, when you use the VBX version of the control, fonts are set using the individual font properties (For example: FontBold, FontItalic, ActiveTabFontBold, ActivePageFontItalic, etc.).

At design time, when you use the OCX version of the control, fonts are set through one of the font properties (For example: Font, ActiveTabFont). Depending on the development environment you are using, a dialog box containing font information may be available so that you can set properties of the Font object. If not, you can set the font properties through the Property Pages (See Appendix E - 'Property Pages').  The following properties are supported by the Font object:

Properties

Bold	Size	Underline
Italic	StrikeThrough	Weight
Name
Whether you use the VBX or OCX version of the control, fonts can be set either through the individual font properties or by setting properties of the Font object at run time. For example, the following sets of code are equivalent:

Refer to the 'Font Object' section in 'Chapter 13 - Control Reference' for more information.

Note	The Font, ActiveTabFont and ActivePageFont properties are not available at design time in Visual Basic 3.0. See 'Font Property,' 'ActiveTabFont Property,' 'ActivePageFont Property,' and 'Font Object' in 'Chapter 13 - Control Reference' for more information.


ForeColor Property

See "BackColor, ForeColor Properties"


ForeColorActive Property

See "BackColorActive, ForeColorActive Properties"


ForeColorInactive Property

See "BackColorInactive, ForeColorIncative Properties"


Form FX Exercise 1: Creating a 3-D Dialog BoxUsing FormFX
Exercise 1: Creating a 3-D Dialog BoxUsing FormFX

See Also

Using the FormFX control, 3-D effects can be applied to several parts of the form such as the caption area, the window border and even the client area. This exercise will show the various properties of the FormFX control that help you to create a dialog box similar to those found in the latest versions of today’s commercial applications.

1.	Start a new project and open a form.

2.	Set the Form’s BorderStyle property to ‘3 - Fixed Double’, and its BackColor property to light gray.

3.	Place a single FormFX control [image] anywhere on the form.

4.	Set FormFX control’s StdCaption property and its Border3D property to True. Now run the program, this is the effect you should have:


Form FX Exercise 2: Adding More 3-D Effects to a Form
Exercise 2: Adding More 3-D Effects to a Form

See Also

As you saw in the previous exercise, 3-D effects can be applied to several parts of the form using the FormFX. This exercise will show various other properties of the FormFX control that allow you to further define 3-D effects on a form.

1.	Using the same form as in the previous exercise, set the StdCaption property of the FormFX control back to False. This enables you to customize the caption area.

2.	Set the Caption3D property to True. This will cause the FormFX control to apply beveling to the caption area. To specify the type of beveling to use, set the CaptionBevelInner and CaptionBevelOuter properties. For this example, set the CaptionBevelInner property to ‘Inset’ and the CaptionBevelOuter property to ‘Raised’.

3.	Now you can adjust the caption so that it is large enough to accommodate the 3-D bevels. There are two ways to do this. You can either set the CaptionHeight property or let the control adjust the caption automatically based on the font.

4.	To see the latter method, first set the CaptionHeight to zero. Now select a font in the FontName property and adjust its size via the FontSize property. For this exercise, set the FontName to ‘MS Sans Serif’ and FontSize to 18.

5.	Now run the program. This is how it should look:

6.	Now add one more finishing touch. Notice the control box in the caption. Currently, it is only 2-D and doesn’t seem to fit with the rest of the form. You can make it 3-D by setting the ControlBox3D property to True.


Form FX Exercise 3: Adding Custom Buttons to the Caption Area
Exercise 3: Adding Custom Buttons to the Caption Area

See Also

So far, you have been able to change several characteristics of a form, using the FormFX control. In this exercise you will add custom buttons to the caption area of the form. The CaptionButtonsLeft and CaptionButtonsRight properties specify how many buttons are to appear on the left and right side of the caption area, respectively. The CaptionPictureLeft and CaptionPictureRight properties specify the picture (bitmap) to be used for the buttons on the left and right side of the caption area, respectively.

1.	Start with a new form and place the FormFX control anywhere on it.

2.	On the FormFX control, set the CaptionButtonsLeft property to 3. Set the CaptionButtonPicLeft property to CAPBTNL1.BMP (this file can be found in the SAMPLES\CHAPTER8 directory). CAPBTNL1.BMP is a bitmap file that contains sample images for the caption area picture buttons. Furthermore, it contains the images for the up and down state of each button. You can create your own bitmap using a bitmap editor, such as Windows Paintbrush, but you may want to use this bitmap as a guide.

3.	Set CaptionButtonsRight to 2 and CaptionButtonPicRight to CAPBTNR1.BMP from in the SAMPLES\CHAPTER8 directory.

4.	Now run the program. As you can see, the added caption buttons now appear on the left and right side of the caption area.


Form FX Exercise 4: Creating a Form with a Small Caption
Exercise 4: Creating a Form with a Small Caption

See Also

In this exercise you will change the size of the caption to create a small caption (similar to the caption size of the Visual Basic toolbox and that of the custom property dialogs in Sheridan Software’s VBAssist [image].)

1.	Start with a new form.

2.	To follow the style of Visual Basic’s toolbox, set the form’s BorderStyle property to ‘1 - Fixed Single’ and set the MinButton and MaxButton properties to False. Also, size the form so that it has a shape similar to the Visual Basic toolbox

3.	Place a FormFX control anywhere on it.

4.	Now set FormFX control’s FontName property to ‘Small Fonts’ and the FontSize property to 6. Be sure that the CaptionHeight property is set to zero so that the FormFX control will automatically set the height of the caption area to the size of the font.

5.	Now run the program, you should see a form similar to this:

6.	This looks fine except for the control box; it is too wide. You can even adjust the width of that. To do so, set the ControlBoxWidth property to 10 (this property is specified in pixels). Notice that the previous setting of zero automatically sizes the control box to the standard size. Now, when you run the project the form should look just like the Visual Basic toolbox:


Form FX Exercise 5: Changing the Look of the Caption Buttons
Exercise 5: Changing the Look of the Caption Buttons

See Also

So far you have changed certain characteristics of a form using the FormFX control. In this exercise you will change the standard buttons that appear in the caption area.

1.	Start with a new form and place the FormFX control anywhere on it.

2.	On the FormFX control, set the CaptionButtonsPic property to buttons.bmp (this file can be found in the samples\chapter7 directory). buttons.bmp is a bitmap file that contains the images for all of the standard caption buttons including the control box and the minimize, maximize and restore buttons. Furthermore, it contains the images for the up and down state of each button. You can create your own bitmap using the Windows Paintbrush accessory, but you may want to use this bitmap as a guide.

3.	Now run the program. The caption buttons will look like the ones from the bitmap.


Form FX Exercise 6: Custom Caption with Multi-line Text and a Picture
Exercise 6: Custom Caption with Multi-line Text and a Picture

See Also

Normally, a form can only have a single line of text centered in its caption area, and there is no way of putting a picture in the caption area. The FormFX control gives you the ability to have multi-line form captions as well as pictures.

1.	Start with a new form and place the FormFX control anywhere on it.

2.	Delete the default caption of the form ("Form1".)

3.	Now in the Caption property of the FormFX control type ‘This is a FormFX Sample Showing MultiLine Captions’.

4.	Set CaptionMultiLine property to True. This will cause the FormFX control to wrap text in the caption if necessary. If you want to force a line break at run time, separate each line in the FormFX control’s Caption with carriage return/line feeds (Chr$(13) + Chr$(10)). For example:

Sub Form_Load ()

Dim crlf As String

crlf = Chr$(13) + Chr$(10)

Fx1.Caption = "Line 1" + crlf + "Line 2"

End Sub

5.	Set the AlignmentCaption property to ‘1 - Left Justify - MIDDLE’ so that the caption starts at the left of the caption area.

6.	Now try setting an icon for display to the left of the text. First, select an icon in the CaptionPicture property (this exercise uses the bullseye.ico icon found in the \vb\icons\misc directory).

7.	To get the icon to appear left of the text, set the AlignmentPicture property to ‘9 - Left of Text’.

8.	Now you just need to make the caption area large enough to show multi-line text and the icon. Set the CaptionHeight property to 1000.

9.	Run the program. Adjust the width of the form and watch how the caption automatically ‘wraps’ to fit within the caption area.


Form FX Exercise 7: Changing Run Time Behavior
Exercise 7: Changing Run Time Behavior

See Also

This exercise will show you how to use FormFX to restrict the behavior of a form. This includes setting limits on sizing and maximizing the form, locking the form’s size and preventing the form from moving. Also, you will see an example of a form with no caption that can still be moved with the mouse!

1.	Start with a new form and place the FormFX control anywhere on it.

2.	First set the FormFX control’s properties that control the minimum size of a form. Set both the SizeMinWidth and SizeMinHeight properties to 2500. Now run the program and use the mouse to adjust the size of the form to its smallest size. You will see that the FormFX control has restricted the sizing of the form to no less than 2500 by 2500 twips.

Setting a maximum width and height is just as easy. Set the SizeMaxWidth and SizeMaxHeight properties to 3500. Then run the program and see how large you can size the form.

3.	You can prevent the form from being resized at all by setting the LockSize property to True. When you run the program, you will see that you can no longer size the form at all. In addition to the LockSize property, the LockMove property disables movement of the form. Set the LockMove property to True, run the program and try to move the form.

4.	Now even though you have set the LockSize and LockMove properties to True, you can hold down the CTRL key to override the lock and resize or move the form. Give it a try. If you want, you can disable the CTRL key override by setting the LockCtlKeyOverride property to False.

5.	Finally, you can change the form so that it has no caption area but can still be moved. First, set the Form’s ControlBox, MinButton, and MaxButton properties all to False. Then, set the Caption property on both the Form and FormFX control to blank. This will eliminate the caption area altogether.

6.	Now if you run the program you will see that, by default, there is no way to move this form. Stop the program by pressing the [image] button on the Visual Basic toolbar. Now, set the FormFX’s ClientMove property to True. Run the program again. You can now move the window by clicking anywhere on the client area of the form and dragging the mouse.


FormFX Control

Properties	Events

 FormFX is a custom control that you can use to customize the appearance and behavior of your forms.  It gives you the ability to customize the size of the caption area, and display multi-line text and pictures in the caption.  In addition, you can add 3-D effects to the caption, borders and/or client area.

There are also several properties that you can use to customize the behavior of a form, such as restricting its size and movement.

Parts of a Form

Customizing The Standard Caption Buttons

Adding Custom Buttons to the Caption Area

Setting the Caption of a Form

Control Limitations

Back to list of all controls


FormFX Events
FormFX Control Events

CaptionButtonLeftClick Event

CaptionButtonRightClick Event


FormFX Properties
FormFX Control Properties

(About) Property

(Custom) Property

ActiveControl Property

AlignmentCaption Property

AlignmentPicture Property

AlwaysOnTop Property

BackColorActive Property

BackColorInactive Property

BevelColorFace Property

BevelColorHighlite Property

BevelColorShadow Property

Border3D Property

Caption Property

Caption3D Property

CaptionBevelInner Property

CaptionBevelOuter Property

CaptionBevelWidth Property

CaptionBorderWidth Property

CaptionButtonEnabledLeft Property

CaptionButtonEnabledRight Property

CaptionButtonPicDisLeft Property

CaptionButtonPicDisRight Property

CaptionButtonPicLeft Property

CaptionButtonPicRight Property

CaptionButtonsLeft Property

CaptionButtonsPic Property

CaptionButtonsRight Property

CaptionButtonTypeLeft Property

CaptionButtonTypeRight Property

CaptionButtonValueLeft Property

CaptionButtonValueRight Property

CaptionButtonVisibleLeft Property

CaptionButtonVisibleRight Property

CaptionHeight Property

CaptionMultiLine Property

CaptionPicture Property

CaptionPictureMetaHeight Property

CaptionPictureMetaWidth Property

CaptionPictureX Property

CaptionPictureY Property

Client3D Property

ClientBevelInner Property

ClientBevelOuter Property

ClientBevelWidth Property

ClientBorderWidth Property

ClientMove Property

ControlBox3D Property

ControlBoxWidth Property

Font Property

Font3D Property

FontBold Property

FontItalic Property

FontName Property

FontSize Property

FontStrikethru Property

FontUnderline Property

ForeColorActive Property

ForeColorInactive Property

Height Property

Index Property

InstantClose Property

Left Property

LockCtlKeyOverride Property

LockMove Property

LockSize Property

MaximizeHeight Property

MaximizeLeft Property

MaximizeTop Property

MaximizeWidth Property

Name Property

Parent Property

Redraw Property

SizeMaxHeight Property

SizeMaxWidth Property

SizeMinHeight Property

SizeMinWidth Property

StdButtonHeight Property

StdCaption Property

StdCaptionHeight Property

Tag Property

Top Property

Width Property

WindowLook Property


Group Property

See Also	Applies To

Description

Returns or sets the group to which the tool belongs.

Syntax

object  .Group [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of the tool's group.

Remarks

The amount of space between buttons in a group is defined by the BtnGroupSpacing property.  Certain properties apply only to buttons in groups:

•	Exclusive

•	AllowAllUp

•	BtnGroupSpacing

This property supersedes the ToolsetToolGroup property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTool object and not the control itself.

This property is only available at run time.  However, it can be initially set at design time using the Toolbar Designer.


Guided Tours

	Dockable Toolbar Control Sample programs using the Dockable Toolbar (Chapter 5)
	Exercise 1: Creating a toolbar on an MDI form Exercise 2: Creating a second toolbar Exercise 3: Providing status bar help Exercise 4: Putting code behind the buttons Exercise 5: Creating a stationary toolbar Exercise 6: Adding a child control to the toolbar Exercise Notes
	Index Tab control Sample programs using the Index Tab (Chapter 6)
	Exercise 1: Setting the number of tabs and rows Exercise 2: Further defining the look of the tabs Exercise 3: Adding captions and pictures to tabs Exercise 4: Changing the look of the active tab Exercise 5: Adding controls to the tabs at design time Exercise 6: Working with pages Exercise 7: Using control templates Exercise 8: Binding to a Data Control
	Notebook Control Sample programs using the Notebook (Chapter 7)
	Exercise 1: Creating a Notebook Exercise 2: Changing the look of the Notebook Exercise 3: Changing tabs and adding controls Exercise 4: Using page tabs and properties Exercise 5: Setting margins and borders Exercise 6: Binding to a Data control
	FormFX Control Sample programs using FormFX (Chapter 8)
	Exercise 1: Creating a 3-D dialog box Exercise 2: Adding more 3-D effects to a form Exercise 3: Adding custom buttons to the caption area Exercise 4: Creating a form with a small caption Exercise 5: Changing the look of the caption buttons Exercise 6: Custom caption with multi-line text and a picture Exercise 7: Changing run-time behavior


Help Event

Applies To	Example

Description

This event is triggered when the balloon help is activated.

Syntax

Sub control_Help ([Index  As Integer], ToolID  As String, ToolNum  As Integer, Btn  As Integer, X   As Long, Y   As Long, RtnCancelDisplay  As Integer)

Remarks

This event occurs when the balloon help is about to be displayed. You can bypass the display by setting the RtnCancelDisplay parameter to True.  This event only occurs if the BalloonHelp property is set to True.

The balloon help text will disappear when a key is pressed or the user moves the mouse off the button.

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

ToolID	A string expression that evaluates to the ID of the tool that is associated with this button. This is the 16-character ID specified in the ID property of the tool.

ToolNum	An integer expression that evaluates to the index of the tool in the toolset.

Btn	An integer expression that evaluates to the button's index number (0 is the left-most button on toolbar).

X	A long integer expression that evaluates to the X-coordinate of the window that will display the balloon help. Use this coordinate to display your own balloon help window.  The coordinate is specified in pixels relative the entire screen.

Y	A long integer expression that evaluates to the Y-coordinate of the window that will display the balloon help. Use this coordinate to display your own balloon help window.  The coordinate is specified in pixels relative the entire screen.

RtnCancelDisplay	An integer parameter that is used when bypassing the display of the balloon help text.

Setting	Description

True	Display of balloon help will be bypassed.

False	Balloon help will be displayed.


Help Property

See Also	Applies To

Description

Returns or sets the help text for the tool (which is used to display balloon help).

Syntax

object  .Help [= text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that evaluates to the text displayed in balloon help.

Remarks

When the BalloonHelp property is set to True, the string in Help property will appear when the mouse pointer pauses over a button.  If this property is not defined for a tool, no balloon help will appear.

This property supersedes the ToolsetToolHelp property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTool object and not the control itself.

This property is only available at run time. However, it can be initially set at design time using the Toolbar Designer.


HideInactiveControls Property

Applies To

Description

Makes controls that are not on the active tab invisible.

Syntax

object  .HideInactiveControls [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying how to manage controls that are not on the active tab, as described in Settings.

Settings

Setting	Description

True	Top-level controls on a tab will have their Visible property set to FALSE when the tab becomes inactive.

False	(Default) Top-level contrls on a tab will have their TabStop property set to FALSE when the tab becomes inactive..

Remarks

This property can be used to restrict access to controls inside a container control on a non-active tab. When this property is false, controls inside a container (such as a Frame control) do not have their TabStop property set to false when the tab becomes inactive, and are therefore still selectable using the tab key.

By setting this property to true, the top level controls (including containers) will be made invisible when the tab becomes inactive, which automatically prevents access to them and their child controls via the tab key.


HwndToolbar Property

Applies To

Description

Specifies the window handle of the toolbar.

Syntax

object  .HwndToolbar

Remarks

This property may be different than the standard Hwnd property of the control, so use this when you need the handle of the actual toolbar displayed on the screen.

Note	The value of this property can change at any time during execution.

This property is read-only and is only available at run time.


ID Property

See Also	Applies To

Description

Returns or sets a unique ID for a tool.

Syntax

object  .ID [= text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that evaluates to the text that uniquely identifies the tool.

Remarks

The string in this property can be a maximum of 16 characters.  This string is passed to you in the Click, Help, MouseEnter and MouseExit events.

This property supersedes the ToolsetToolID property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTool object and not the control itself.

This property is only available at run time.  However, it can be initially set at design time using the Toolbar Designer.


Important for Users of Version 1.0

Although the new versions of the Designer Widgets controls contain many powerful new features, they retain backwards compatibility with the previous versions. Therefore, programs you have written using previous versions of the controls should run with no modifications using the new controls.

However, due to the number of new properties and the inclusion of the new OCX format, there are significant changes to how the controls are used, particularly at design time. For full coverage of the differences between versions, and compatibility issues, please see Compatibility Issues.

Compiled programs must be re-compiled using the new controls. See the README.TXT file for further information regarding substitution of controls in Visual Basic projects.


Included Files

Included Files

The following table page gives a brief description of the files that are installed on your hard disk during the Setup process.

Files installed in the \WINDOWS\SYSTEM directory (optional):

Filename(s)	Description

SSDOCKTB.VBX	VBX file which contains the Dockable Toolbar control.

SSIDXTAB.VBX	VBX file which contains the Index Tab and Notebook controls.

SSFORMFX.VBX	VBX file which contains the FormFX control.

COMPOBJ.DLL	OLE support file

MFCOLEUI.DLL	OLE support file

OC25.DLL	OLE support file

OLE2.DLL	OLE support file

OLE2DISP.DLL	OLE support file

OLENLS.DLL	OLE support file

STORAGE.DLL	OLE support file

TYPELIB.DLL	OLE support file

VBOA300.DLL	VBX support file (for Visual Basic 3.0 applications)

VBRUN300.DLL	VBX support file (for Visual Basic 3.0 applications)

Files installed in the \WINDOWS\SYSTEM32 directory:

Filename(s)	Description

MSVCRT.DLL	32-bit OLE support file

MFC42.DLL	32-bit OLE support file

OLEAUT32.DLL	32-bit OLE support file

OLEPRO32.DLL	32-bit OLE support file

STDOLE2.TLB	32-bit OLE support file

Files installed in the \SSDESWDG directory (or whatever directory you specified during installation):

Filename(s)	Description

README.TXT 	Contains updated information not found in this manual.

TSEDITOR.EXE	Toolset Bitmap Editor application for creating custom toolset bitmaps to be used with the Dockable Toolbar control.

TSEDITOR.HLP	Help file for the Toolset Bitmap Editor.

SSDESWDG.BAS	The declarations for the Designer Widgets API functions and the constant declarations for various Designer Widgets settings.

SSDESWDG.HLP	The Designer Widgets on-line Help file.

SSTBAR16.OCX	16-bit OCX file for which contains the Dockable Toolbar control.

SSTBAR32.OCX	32-bit OCX file for which contains the Dockable Toolbar control.

SSDOCKTB.VBX	VBX file which contains the Dockable Toolbar control.

SSTABS16.OCX	16-bit OCX file for which contains the Index Tab and Notebook controls.

SSTABS32.OCX	32-bit OCX file for which contains the Index Tab and Notebook controls.

SSIDXTAB.VBX	VBX file which contains the Index Tab and Notebook controls.

SSFORM16.OCX	16-bit OCX file for which contains the FormFX control.

SSFORM32.OCX	32-bit OCX file for which contains the FormFX control.

SSFORMFX.VBX	VBX file which contains the FormFX control.

SSTOOLPP.EXE	Property Pages for the Dockable Toolbar control.

SSTABPP.EXE	Property Pages for the Index Tab control.

SSNOTEPP.EXE	Property Pages for the Notebook control.

SSFORMPP.EXE	Property Pages for the FormFX control.

Sample projects directories installed under the \SSDESWDG\SAMPLES directory:

Filename(s)	Description

CHAPTER?\*.*	Contains the chapter examples.

TOOLSETS\*.BMP	Contains sample toolsets.

TOOLSETS\*.BM$


Index Tab Collections
Index Tab Control Collections

Objects marked with a · are only accessible via the X object when using the VBX version of the control.

Pages Collection

Tabs Collection

Templates Collection


Index Tab Control

Properties	Events	Methods	Objects	Collections

The Index Tab Control is a custom control that you can use to provide the same 'state of the art' interface adopted by many of today's commercial Windows applications. This interface is based on an index card metaphor. It allows the presentation of several dialogs or screens of information on a single form. In addition, since this is a metaphor that everyone is familiar with, users feel comfortable with it immediately.

Tabs are selected (in design and run modes) by clicking on the tab with the left mouse button. When a tab is selected at run time, the controls associated with it appear and the user can then view or modify the information. Since the tabs are also active at design time, creating and arranging the controls for each tab is a snap.

Placing Controls on the Index Tab

Setting Captions and Pictures at Design Time

How To Set Up the Number of Tabs or Pages

Using the Control in Data Bound Mode

The Scrolling Interface

Working With Templates

Important for Users of Version 1.0

Back to list of all controls


Index Tab Events
Index Tab Control Events

Click Event

DragOver Event

LostFocus Event

ClickAfter Event

GotFocus Event

ClickBefore Event

KeyDown Event

MouseDown Event

DblClick Event

KeyPress Event

MouseMove Event

DragDrop Event

KeyUp Event

MouseUp Event


Index Tab Exercise 1: Setting the Number of Tabs and Rows
Exercise 1: Setting the Number of Tabs and Rows

See Also

1.	Using the [image] tool, draw an Index Tab control on the form so that it occupies most of the form.

2.	The first step when using the Index Tab Control is to set up the basic look of the control. This is done based on the number of tabs you will be using, how wide you want each tab to be, and the type of text and/or picture you will use on each tab.

When you create the control on the form, it defaults to a single row of three tabs. You can start to set the look you want using three basic properties. They are TabCount, TabsPerRow, and TabMaxWidth. Here's how you can change the appearance of the control using these properties:

3.	Set the TabCount property to 8. You will notice that eight tabs appear and they are arranged in three rows.

4.	Set the TabsPerRow property to 4. You will now see that there are still eight tabs, but the number of rows has changed to two.

5.	Notice that the tab widths are all the same and that they are automatically sized to fit exactly on the Index Tab control. You may want to adjust the width of the control with the mouse to see this effect better.

6.	You can override this behavior so that the tab widths always remain a specific size. This is done with the TabMaxWidth property. Try setting this property to different values to see its effects. A setting of 800 produces the following effect:

Values are in the scale mode of the form or container, which in this case is twips. Setting this property to 0 (the default) will cause the control to automatically size the tabs.

In addition to the three basic properties (TabCount, TabsPerRow, and TabMaxWidth) there are many other properties that affect the appearance of the control. Properties such as TabRowOffset, TabHeight, and TabCutSize give you a great deal of control over the look of your application


Index Tab Exercise 2: Further Defining the Look of the Tabs
Exercise 2: Further Defining the Look of the Tabs

See Also

Using the form created in the previous exercise, you can explore setting more properties to further define the look of the control.

1.	By default, the control sets the height of the tabs to accommodate a single line of text. However, you may want to adjust the height if you specify a larger font or place pictures on the tabs. To adjust the height of each tab on the control, set the TabHeight property. Try setting this property to different values to see its effects. Remember these values are in the scale mode of the form. When you are done, set the TabHeight property to 300.

2.	By default, the control displays all tabs with chamfered corners, which appear angled or cut. If you want, you can adjust the size of the angle by setting the TabCutSize property (in pixels). Experiment with different values to see how this affects the look of your control, then set TabCutSize to 15.

3.	An even more dramatic way to change the look of the tabs is to use the TabShape property. Tab shape provides a number of distinctive appearances for the tabs. Try the various settings and see what your options are. The following is an illustration of the 'S-Curve' setting, which is similar in shape to the tabs found on manila file folders:

TabCutSize and TabShape work together to produce the appearance of the tab. A larger value for TabCutSize adds more emphasis to the effect selected by TabShape.

4.	Notice that the top row of tabs has been indented to the right of the bottom row. To adjust the amount of this indent, set the TabRowOffset property. If you want to change the spacing between rows of tabs (for example, the distance from the top of Tab 0 to the top of Tab 4) you would use the TabTopOffset property. Increase the TabRowOffset value to 500, and decrease the TabTopOffset value to 100. Your control should look something like this:

Reset both values to 300 (the same as TabHeight) when you are done.

5.	The TabOrientation property determines where the tabs are placed. This property defaults to displaying the tabs along the top of the control. However, they can also be shown on the bottom, left or right. Experiment with different settings for this property get the look you want.

When you have finished this exercise, return TabOrientation to '0 - Tabs on Top,' set the value of TabCutSize back to 5, and the value of TabShape back to '0 - Chamfered' to prepare your control for the next exercise. You may want to save your project at this point.


Index Tab Exercise 3: Adding Captions and Pictures to Tabs
Exercise 3: Adding Captions and Pictures to Tabs

See Also

The Index Tab Control allows you to specify a different caption and/or picture for each tab in the control. The Index Tab Control uses the Caption and Picture properties to set these attributes.

1.	First, select a tab by clicking on it with the left mouse button.

2.	Now set the Caption property to the text you want to appear on that tab. Remember that if you want mnemonic (accelerator key) support, include an ampersand ('&') in the text before the mnemonic character.

3.	If you want to include a picture on that tab, set the Picture property as well.

4.	Repeat steps one, two and/or three for each tab. Your final result could look something like this:

5.	Now that you have defined what will appear on each tab, you may want to specify how that information will be aligned. This is done using two properties called AlignmentCaption and AlignmentPicture. Try different settings for each of these properties to see how they work.


Index Tab Exercise 4: Changing the Look of the Active Tab
Exercise 4: Changing the Look of the Active Tab

See Also

When a user selects a tab, that tab becomes the "active tab". When a tab becomes active, all controls associated with that tab will appear. The Index Tab control optionally lets you distinguish the look of the active tab through several properties. With these properties, you can define different fonts, colors or a specific picture to set the active tab apart.

1.	You can adjust the font of the active tab by setting the ActiveTabFontName, ActiveTabFontSize, ActiveTabFontBold, ActiveTabFontItalic and ActiveTabFontUnderline properties. Experiment with different variations to get the look you want.

2.	You can also set the color of the text in the active tab. This is done using the ActiveTabForeColor property. Try setting this property to dark blue.

3.	Setting the background color of the ActiveTab is also possible. In this exercise the tab is in 3-D mode, so you can use the ActiveTab3DBackColor property to set the background color for the active tab. Try setting the background color to light cyan.

Note	If the control were not in 3-D mode, you would use the ActiveTabBackColor property to set the background color of the active tab. ActiveTabBackColor is ignored when the tab is in 3-D mode.

4.	Now to finish defining the look of the active tab, specify a picture to use. Use the ActiveTabPicture property to select a bitmap that will distinguish the active tab.

5.	In addition to all the properties that control the look of the active tab, there is an ActiveTabPropertiesUsed property that acts as a "master switch" for active tab customization. The default value for this property is True, which causes the active tab to use your customized settings. Setting ActiveTabPropertiesUsed to False disables all customization and makes the active tab look the same as the rest of the tabs. Try both settings for this property.


Index Tab Exercise 5: Adding Controls to the Tabs at Design Time
Exercise 5: Adding Controls to the Tabs at Design Time

See Also

Now that the look of the form is defined, you can move ahead to the most important aspect of the Index Tab control; placing other controls on each tab. At design time, you can select any tab by clicking on it with the left mouse button.

When you first select a new tab, you will see a clear area where you can place the child controls associated with that tab. When you select another tab the child controls are covered until you re-select the original tab.

1.	First, select a tab by clicking on it with the left mouse button.

2.	Draw a frame control on the Index Tab Control.

Note	You must be sure that the frame is a child control of the Index Tab control. To ensure that it is, follow this procedure to create the frame control: first select the Index Tab control on your form by clicking on it once with the left mouse button. Then select the frame control in the Visual Basic toolbox. Click inside the Index Tab control and drag the frame to the desired size.

To test whether the frame is a child of the Index Tab control, move the Index Tab control to a different location on the form. The frame control should follow and remain inside the Index Tab control. If it does not, delete the frame and try the above steps again.

3.	Place any other controls that you want to appear on this tab:

4.	Repeat the above steps for each tab on the Index Tab control.

5.	At design time, you will notice that when you select a new tab, all the controls associated with the new tab appear and the other controls associated with the previous tab disappear. Click on the different tabs to see this effect.

6.	Once you have placed all the controls on the different tabs, run the program. You will see that when you click a tab, only those controls that you placed on that tab will appear.


Index Tab Exercise 6: Working with Pages
Exercise 6: Working with Pages

See Also

The Index Tab control now features pages for each tab, which give you even more room to place controls. A page is a container control which is associated with a particular tab. A given tab can have any number of pages, and each page can have its own controls. Several methods of navigating through the pages are provided, or you can define your own.

All controls contained by the Index Tab control are stored on pages. Even controls which appear to be drawn directly on one of the tabs are actually on a page of that tab. This makes it easier to organize and work with controls through code.

1.	First, you must enable the display of pages in the control by setting the PagesVisible property to True. Then change the PageCount property to 2, and the Page property to 1. This will give you two pages for the current tab, and display the first page:

2.	You can "flip through" the pages by clicking on the page earmarks, which are located in the upper corners of the page. The earmark on the right side takes you to page two. The earmark on the left takes you back to "page" zero, which is the tab itself. When you are on the tab, clicking in the caption area will display page one.

3.	Create a series of controls on the first page:

4.	Flip to the second page. The controls will be hidden until you return to the first page.

5.	Flip back to the tab by clicking on the left earmark. If you did not previously add a command button to the tab, add one now. Then double-click on the command button (which is labeled 'Edit Custom View...' in this example) and add the following line of code:

SSIndexTab1.Page = 1

6.	Save and run your project. When you click on the command button, page one is displayed. You can then flip through the pages using earmarks. You can use the standard interface to navigate through pages or code your own.

This exercise provides a very brief introduction to using Index Tab pages. For a more in-depth look at pages and their properties, see Exercise 4: Using Page Tabs and Properties. in the Notebook control section of the Guided Tours.


Index Tab Exercise 7: Using Control Templates
Exercise 7: Using Control Templates

See Also

Often you may want to have controls which appear on multiple tabs or pages, such as common 'OK' and 'Cancel' buttons which set the selected options and close the form. Or you might want to have certain information always available, such as a text box containing current data. This is accomplished using control templates. A template is a special container object that can be associated with Index Tab control pages. Controls on the template will appear on any page to which the template is assigned.

1.	Start by pressing the ellipsis (...) button next to the (TemplateManager) property in the property sheet. If you are using the OCX version of the control, right click on the control and select Template Manager from the pop-up menu. This will invoke the Template Manager dialog box, where you can create and work with templates.

2.	Press the 'Create' button to create a new control template. When you are prompted for a name, type a name which is descriptive of the template's function, such as "TID_OKCANCEL" and press enter.

3.	The template you just created will be selected in the template list. Press Modify. You will be returned to the control, which is now in template editing mode. You will notice that the control is grayed, and a message is displayed reminding you that you can press the right mouse button to quit editing.

4.	Draw some controls, such as command buttons. When you are finished editing the template, click on the control with the right mouse button to exit template editing mode.

5.	Click again on the the ellipsis (...) button next to the (TemplateManager) property in the property sheet and the Template Manager dialog will re-appear. Select the name of template you just created form the list and click the 'Apply' button to apply the new template to the current tab, as indicated by the values in the Tab and Page boxes. If you wanted, you could now apply this template to other tabs and pages by changing the values in the Tab anPage boxes. For now, just click 'Close' to close the dialog. Your control should look something like this:

6.	Flip to the first page of your control by clicking on the command button you previously created. Return to the Template Manager dialog. You will see that the template you created is there, and the page number has changed:

7.	Click once on the name of your template (TID_OKCANCEL) to highlight it, then click on the 'Apply' button. If you wanted, you could apply this template to any other page or tab in the control by changing the numbers in the Tab and Page boxes and then clicking the 'Apply' button.

8.	Click 'Close' to close the Template Manager. The first page of your control should now look similar to this:

9.	Double-click on the OK button and add the following code to the click event:

MsgBox "OK pressed"

10.	Save your work and run the project. Try flipping back and forth between the tab and the first page, and clicking on the OK button. Notice how there is really only one control, although it appears in two places.

You will find that control templates give you a great deal of flexibility when designing the layout of your Index Tab control. Using templates not only reduces the resources required by your application, but gives you the ability to switch dynamically between sets of controls in response to user or system events.


Index Tab Exercise 8: Binding to a Data Control
Exercise 8: Binding to a Data Control

See Also

The Index Tab control can be bound to a Visual Basic data control, giving you an intuitive front-end to your data. You can bind a field in the database to the caption of each tab, then place data bound controls on the tabs (most likely by using a template) to provide the rest of the information. This exercise creates the skeleton of a "card catalog" application using the BIBLIO.MDB database that ships with Visual Basic 3.0. This database should be located in your Visual Basic subdirectory.

1.	For this exercise, start a new project and place an Index Tab control and a Data control on the form.

2.	Set the DatabaseName property of the Data control to "C:\VB\BIBLIO.MDB." (This file name may be different if you have installed Visual Basic to a directory other than the default directory.) Set the RecordSource property to "Authors."

3.	Click on the Index Tab control and set the TabVariableSize property to True. This will automatically adjust the width of the tabs to the width of the caption text. Also set the TabCount property to '9.'

4.	Set the DataSource property of the Index Tab control to "Data1." Set the DataField property to "Author."

5.	Save and run your project. The control should look like this:

6.	Try clicking on all the tabs of the control. You can select any tab, but you cannot scroll the control to records other than those displayed.

7.	Click on the [image] button of the Data control several times to move through the recordset. Notice how the Index Tab control changes to reflect the state of the Data control.

8.	Stop the program (by pressing the [image] button on the Visual Basic toolbar) and return to design mode. Click on the Data control and set the Visible property to False. Now click on the Index Tab control and set the TabScrollType property to '1 - Scroll buttons if needed.' Save and run the project. It should now look like this:

9.	Click on the scroll buttons, located on the far right of the first row of tabs. Notice how you can now scroll through the records of the database without having to use the data control. Try clicking on different tabs in combination with the scroll buttons to get a feel for how data scrolling works. Data is always retrieved a row at a time, and is dependent upon the position of the recordset and the position of the active tab.


Index Tab Methods
Index Tab Control Methods

AddControl Method

Drag Method

Insert Method

Refresh Method

Remove Method

RemoveControl Method

SetFocus Method


Index Tab Objects
Index Tab Control Objects

Objects marked with a · are only accessible via the X object when using the VBX version of the control.

ActivePageFont Object

ActiveTabFont Object

Font Object

Page Object

PageFont Object

Picture Object

Tab Object

Template Object


Index Tab Properties
Index Tab Control Properties

(About) Property

(Custom) Property

(TemplateManager) Property

ActivePage3D Property

ActivePage3DBackColor Property

ActivePageBackColor Property

ActivePageFont Property

ActivePageFontBold Property

ActivePageFontItalic Property

ActivePageFontName Property

ActivePageFontSize Property

ActivePageFontStrikethru Property

ActivePageFontUnderline Property

ActivePageForeColor Property

ActivePagePicture Property

ActivePagePictureMetaHeight Property

ActivePagePictureMetaWidth Property

ActivePagePropertiesUsed Property

ActiveTab3D Property

ActiveTab3DBackColor Property

ActiveTabBackColor Property

ActiveTabFont Property

ActiveTabFontBold Property

ActiveTabFontItalic Property

ActiveTabFontName Property

ActiveTabFontSize Property

ActiveTabFontStrikethru Property

ActiveTabFontUnderline Property

ActiveTabForeColor Property

ActiveTabPicture Property

ActiveTabPictureMetaHeight Property

ActiveTabPictureMetaWidth Property

ActiveTabPropertiesUsed Property

Align Property

AlignmentCaption Property

AlignmentPicture Property

BackColor Property

BevelColorFace Property

BevelColorHighLight Property

BevelColorOutline Property

BevelColorScheme Property

BevelColorShadow Property

ClientHeight Property

ClientLeft Property

ClientTop Property

ClientWidth Property

CompatibilityMode Property

DragIcon Property

DragMode Property

Enabled Property

Font Property

Font3D Property

FontBold Property

FontItalic Property

FontName Property

FontSize Property

FontStrikethru Property

FontUnderline Property

ForeColor Property

Height Property

HelpContextID Property

HelpWhatsThisID Property

HideInactiveControls Property

Index Property

Left Property

MousePointer Property

Name Property

Page Property

PageAlignmentCaption Property

PageAlignmentPicture Property

PageBackColor Property

PageCaption Property

PageCaptionRotation Property

PageCount Property

PageEarmarkPos Property

PageFont Property

PageFont3D Property

PageFontBold Property

PageFontItalic Property

PageFontName Property

PageFontSize Property

PageFontStrikethru Property

PageFontUnderline Property

PageForeColor Property

PageMargin Property

PageNavigation Property

PagePicture Property

PagePictureMetaHeight Property

PagePictureMetaWidth Property

Pages3D Property

PageStyle Property

PagesVisible Property

PageTabEarmark Property

PageTabHeight Property

PageTabOrientation Property

PageTabsPerRow Property

PageWordWrap Property

Parent Property

Picture Property

PictureMetaHeight Property

PictureMetaWidth Property

ShowFocusRect Property

Tab Property

TabBackColorDefault Property

TabCaptionRotation Property

TabCount Property

TabCutSize Property

TabForeColorDefault Property

TabHeight Property

TabIndex Property

TabLeftMargin Property

TabMaxRows Property

TabMaxWidth Property

TabOrientation Property

TabRightMargin Property

TabRowOffset Property

Tabs3D Property

TabScrollType Property

TabSelectType Property

TabShape Property

TabSpacing Property

TabsPerRow Property

TabStart Property

TabStop Property

TabTopOffset Property

TabVariableSize Property

TabVisibleFirst Property

TabVisibleLast Property

Tag Property

TemplateName Property

Top Property

TransparentBack Property

Visible Property

Width Property

WordWrap Property


Insert Method

See Also	Applies To	Example

Description

This method is used to insert a new tab or page object into the Tabs or Pages collection.

Syntax

object  .Insert target

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

target	Required.  Integer value that specifies an index at which the tab or page is to be inserted into the Tabs or Pages collection.

Remarks

This method affects the value of TabCount or PageCount, depending on which type of object is inserted.


InstantClose Property

See Also	Applies To	Example

Description

This property determines whether or not a single click on the control box will close the form.

Syntax

object  .InstantClose [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the control box behavior, as described in Settings.

Settings

Setting	Description

True	The control box will close the form with a single click.  The form's normal system menu is disabled.

False	(Default) The control box will function as normal.

Remarks

The StdCaption property must be set to False for this property to be active.


Italic Property

See Also	Applies To

Description

Returns or sets the font style of the specified Font object to either italicized or non-italicized.

Syntax

object  .Italic [= boolean  ]

The Italic property syntax has these parts:

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on italic formatting.

False	Turns off italic formatting.

Remarks

The Font object is not directly available at design time.  Instead you set the Italic property through a control's Font property.

At run time, however, you can set Italic directly by specifying its setting for the Font object.

In Visual Basic 3.0 you set the Italic property by selecting a control's ActiveTabFontItalic, ActivePageFontItalic or FontItalic property in the Visual Basic Properties window.


LockCtlKeyOverride Property

See Also	Applies To	Example

Description

Allows the user to override the LockMove and / or LockSize properties at run time, by holding down the CTRL key.

Syntax

object  .LockCtlKeyOverride [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the control-key override mode, as described in Settings.

Settings

Setting	Description

True	(Default) The form can be resized or moved when the CTRL key is held down, even if LockMove and/or LockSize are set to True.

False	LockMove and/or LockSize property cannot be overridden.


LockMove Property

See Also	Applies To	Example

Description

This property determines whether or not the form can be moved by the user at run time.

Syntax

object  .LockMove [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the ability of the form to move, as described in Settings.

Settings

Setting	Description

True	The form cannot be moved by the user at run time.

False	(Default) The form can be moved.

Remarks

By default, the user can override this lock by holding down the CTRL key.  If you do not want the user to be able to do this, set the LockCtlKeyOverride property to False.


LockSize Property

See Also	Applies To	Example

Description

This property determines whether or not the size of the form can be changed by the user at run time.

Syntax

object  .LockSize [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the sizing mode of the form, as described in Settings.

Settings

Setting	Description

True	The form cannot be resized.

False	(Default) The form can be resized.

Remarks

By default, the user can override this lock by holding down the CTRL key.  If you do not want the user to be able to do this, set the LockCtlKeyOverride property to False.


MaximizeHeight, MaximizeWidth Properties

See Also	Applies To	Example

Description

Specifies the height and/or width of the form when the form is maximized.

Syntax

object  .MaximizeHeight [= number  ]

object  .MaximizeWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the maximum value for the height or width of the form when maximized.

Remarks

Set these properties to zero for the Windows default size.  The value specified is based on the scale mode of the form.


MaximizeLeft, MaximizeTop Properties

See Also	Applies To	Example

Description

Specifies the X-coordinate and / or Y-coordinate of the form when the form is maximized.

Syntax

object  .MaximizeLeft [= number  ]

object  .MaximizeTop [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the coordinate of the maximized form.

Remarks

Set these properties to zero for the Windows default position.  The value is specified based on the scale mode of the form.


Mnemonic Property

See Also	Applies To

Description

Returns or sets the mnemonic character associated with a tool.

Syntax

object  .Mnemonic [=  text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that evaluates to a single-character.

Remarks

By setting a mnemonic for a tool, the user can click a button by hitting ALT and the character specified in Mnemonic.  This will cause the Click event of the button to fire.  This property is generally used when a caption is included in the picture, to allow the user to 'hotkey' the button.

Note	You should be aware that mnemonic characters only work within the currently active form.  Therefore, if an MDI child form is active, the mnemonic characters for toolbars that are on the MDI parent will not operate.

This property supersedes the ToolsetToolMnemonic property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTool object and not the control itself.

This property is only available at run time.  However, it can be initially set at design time using the Toolbar Designer.


MouseEnter Event

Applies To	See Also	Example

Description

Occurs when the mouse pointer enters a button on the toolbar.

Syntax

Sub control_MouseEnter ([Index  As Integer] ToolID  As String, ToolNum  As Integer, Btn  As Integer)

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

ToolID	A string expression that evaluates to the ID of the tool that is associated with this button.  This is specified in the ID property of the tool.

ToolNum	An integer expression that evaluates to the index of the tool in the toolset.

Btn	An integer expression that evaluates to the button's index number (0 is the leftmost button on toolbar).


MouseExit Event

Applies To	See Also	Example

Description

Occurs when the mouse pointer exits a button on the toolbar..

Syntax

Sub control_MouseExit ([Index  As Integer] ToolID  As String, ToolNum  As Integer, Btn  As Integer)

Remarks

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

ToolID	An integer expression that evaluates to the ID of the tool that is associated with this button.  This is specified in the ID property of the tool.

ToolNum	An integer expression that evaluates to the index of the tool in the toolset.

Btn	An integer expression that evaluates to the button's index number (0 is the leftmost button on toolbar).


Name Property

See Also	Applies To	Example

Description

Returns or sets a unique ID string for the specified object.

Syntax

object  .Name [= text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that specifies a unique identifier for the object.

Remarks

In Designer Widgets, objects in collections can be referred to either by index number or name. Names are automatically assigned to all objects when they are created. You can change the name of an object to suit your own purposes.

Object names must be unique within a collection. If you try to give an object a name which already exists, an error occurs.

When applied to the ToolsetTools collection, this property supersedes the ToolsetName property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTools collection and not the control itself.


Name Property (Font object)

See Also	Applies To

Description

Returns or sets the font name of the Font object  .

Syntax

object  .Name [= text  ]

The Name property syntax has these parts:

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A string expression specifying the name of the font to be used.

Remarks

The Font object is not directly available at design time. Instead you set the Name property through a control's Font property.

At run time, however, you can set Name directly by specifying its setting for the Font object.

In Visual Basic 3.0 you set the Name property by selecting a control's FontName property in the Visual Basic Properties window.


Notebook Collections
Notebook Control Collections

Objects marked with a · are only accessible via the X object when using the VBX version of the control.

Pages Collection

Tabs Collection

Templates Collection


Notebook Control

Properties	Events	Methods	Objects	Collections

 The Notebook control is a custom control that you can use in your projects to provide an intuitive notebook interface for your data and other controls. Using the Notebook control, it is easy to quickly incorporate an indexed notebook metaphor into your programs. Because it is familiar and visually appealing, users immediately feel at ease using your notebook-based application.

Notebook tabs are selected (in design and run modes) by clicking on the tab with the left mouse button.  When a tab is selected at run time, the pages and controls associated with it appear and the user can then view or modify the information.

Each tab can have any number of pages associated with it. Pages are selected, depending on the chosen mode, by clicking directly on their tab, by clicking on page earmarks until the page is reached, or by using custom navigation controls that you declare. Since both tabs and pages are active at design time, creating and arranging controls is easy.

Placing Controls in the Notebook

Setting Captions & Pictures at Design Time

Setting Up the Number of Tabs or Pages

Using the Control in Data-Bound Mode

Working With Templates

Back to list of all controls


Notebook Events
Notebook Control Events

Click Event

ClickAfter Event

ClickBefore Event

DblClick Event

DragDrop Event

DragOver Event

GotFocus Event

KeyDown Event

KeyPress Event

KeyUp Event

LostFocus Event

MouseDown Event

MouseMove Event

MouseUp Event


Notebook Exercise 1: Creating a Notebook
Exercise 1: Creating a Notebook

See Also

These exercises are designed to introduce you to the power of the Notebook control. They build on the skills you acquired while completing the Index Tab control exercises. If you have not completed the Index Tab exercises, please do so before beginning these.

Because the tabs of the Notebook control behave much like the tabs of the Index Tab control, you can apply all that you have learned regarding the Index Tab control to understanding the Notebook control. In this exercise, you will work extensively with pages and set the properties used to control the appearance of the notebook. You will also see the various ways of navigating within the Notebook.

Much of what you will learn in this chapter can also be applied back to the Index Tab control. The only exceptions are properties and methods relating to interface elements not present in the Index Tab control, such as rings, spine, animation and sound.

1.	Using the [image] tool, draw a Notebook control on the form so that it occupies most of the form. The Notebook control appears, and has the following parts:

2.	First, use the mouse to turn through the notebook pages. Click with the left button on the earmark in the upper right corner of the page. Notice how the pages turn. Turn the pages backwards until all the pages are on the right side.

3.	You can change the position of the earmark. Change PageEarmarkPos to 'Bottom/Left of Page.' The earmark will jump to the bottom corner.

4.	Switch the PageAnimation property from True to False and turn a few pages to see the difference. Change the setting back to True.

5.	Try the different settings for NotebookOrientation to get an idea of how the Notebook looks in other positions. When you are done, return NotebookOrientation to the default setting of '3 - Portrait Right to Left.' Now try setting the TabOrientation property to different values. You will see the difference between these two settings: one affects the orientation of the entire control, and the other just the tabs themselves. Return TabOrientation to '0 - Outside.'

6.	To finish with the basic properties, change to different settings for PageStyle. This shows the different types of "paper" available for use in your notebook. When you have seen all the types, change this setting back to '0 - None.'


Notebook Exercise 2: Changing the Look of the Notebook
Exercise 2: Changing the Look of the Notebook

See Also

In this exercise you will learn how to alter the appearance of the different pieces of the notebook - the cover, the spine, the rings and the various margins.

1.	Start by setting some properties that control the look of the cover. Set the CoverBackColor to dark blue. CoverShadowColor should be black. Set CoverCreaseColor, CoverCreaseStyle, CoverCornerStyle, CoverGuardStyle to whichever settings you like.

2.	You can change the appearance of the notebook spine. From the Properties window, set the SpineStyle to '1 - Square.' Next, set SpineBackColor to yellow. SpineOutlineColor should be black. It is easiest to see the spine when all the tabs are on the same side, so you may want to click the left-most tab to move them all to the right. Just be sure to return the first tab to the left when you are finished with the spine.

3.	Now you will set the look of the binding rings. Start by setting RingCount to ten and RingGroups to three. You will see two groups of three rings, top and bottom, and a group of four rings in the middle. The Notebook control automatically groups the rings to give your Notebook a symmetrical appearance.

4.	Set the RingType to '1 - Plastic.' You may notice that the cover creases and the spine are no longer visible. This is because an actual plastic-bound notebook would not have these features.

5.	Set the RingBackColor property to dark red. You can experiment with the RingSize, RingWidth and RingSpacing properties until the Notebook looks right to you.

6.	Finally, set the BackColor property to match the color of your form, which in this case is white. BackColor controls the color of the background behind the cover.


Notebook Exercise 3: Changing Tabs and Adding Controls
Exercise 3: Changing Tabs and Adding Controls

See Also

Now that the Notebook has the right look, you can put it to work by changing some properties and adding a few controls:

1.	First, make sure the Notebook is opened to the first tab (labeled 'Tab 0' by default) and that all of the pages are on the right. To do this, set the Tab and  Page properties to 0. Then set the following properties:
PageCount 	= '3'

TabCount	= '5'
TabSpacing	= '0'

TabsPerRow 	= '4'

This gives you five tabs; each tab will have three pages. Also set TabShape to 'Chamfered' and TabCutSize to '12' to complete the look.

2.	Change the following properties in the Visual basic property window:
ActiveTabFontName 	= 'Arial'
ActiveTabFontSize 	= '10'
ActiveTabFontBold 	= True
Caption	= 'Q1'
FontName 	= 'Arial'
FontSize 	= '10'
FontBold 	= True

Your notebook should now look like this:

3.	Next, draw some controls, such as command buttons, text boxes and labels on the left-hand tab and on the first page. The Notebook might look something like this:

4.	Now save and run your application. Test it by clicking on the different tabs and page earmarks. Notice how the controls are covered or uncovered as you change pages.


Notebook Exercise 4: Using Page Tabs and Properties
Exercise 4: Using Page Tabs and Properties

See Also

Now you will see how to take advantage of some additional properties to further flesh out your Notebook application:

1.	If you are not already positioned on the 'Q1' tab, click on it now. Turn to the first page. Then click on the page earmark so that you have two blank pages available.

2.	Change the PageNavigation property from '1 - Earmarks' to '2 - Page Tabs.' Now instead of earmarks, you will see each page has its own tab. Many of the properties associated with pages relate to these page tabs. For instance, change the following values:
PageFontName to Arial 8-point Regular, then change PageCaption to 'Sales.' Your new caption will appear on the page tab on the left.

3.	Set the PageTabsPerRow property to 3. The three page tabs should be symmetrical, with 'Sales' occupying the top portion of the page's edge, and the other two tabs occupying the center and bottom position.

4.	Click on the center page tab and turn to the next page. Change PageCaption to 'Expenses.' Then click on the lower page tab and turn to the back page. Change PageCaption to 'Milestones.'

5.	Try setting different values for the PageTabOrientation property to see its effects on the page tabs. When you are done, set PageTabOrientation back to the default setting of '3 - Same as Tab.'

6.	Try different values for Pages3D, PageFont3D, PageTabEarmark and PageTabHeight until you find a satisfactory look.

7.	Draw some controls on each page. Your control might now look similar to this:

8.	Save and run your program. You can now navigate directly to any page by clicking on its tab. You do not need to flip through the intervening pages.


Notebook Exercise 5: Setting Margins and Borders
Exercise 5: Setting Margins and Borders

See Also

This exercise will give you a fine degree of control over the details of the notebook's appearance. It will show you how to change the margins and spacing of the different parts of the control. In this exercise all values are in the scale mode of the form, which is assumed to be twips.

1.	For this exercise, change the RingType property to '0 - Two Piece'. Then click on the 'Q1' tab until all the tabs are on the right side. This will enable you to see the spine more clearly, since many of these properties affect the spine.

2.	Set the CoverMarginX property to 50 and CoverMarginY property to 200 and observe the effect on the Notebook. CoverMarginX controls the distance between the tabs and the cover along the left and right edges. CoverMarginY controls the distance between the top and bottom edges of the tabs and the cover. It also affects the distance between the edges of the cover and the spine.

3.	Set CoverShadowSize to 200 to see how a wide shadow looks on the Notebook. Then set CoverShadowSize to 50.

4.	Set the RingType to '3 - Spiral (single wire)' and open the 'Q1' tab so it is on the left for this next exercise. Then change the TabGutterMargin property's value to 100. Notice the distance between the edge of the tab and the ring holes at the center of the Notebook. Now increment TabGutterMargin to 200, then 300, then 400. Each time, you will see the space at the center of the Notebook expand; however, the size of the rings stays constant. When you are finished, set TabGutterMargin back to 100.

5.	Set the PageGutterMargin property to 50. This property controls the distance from the edge of the page to the ring holes. Set the property to 100, then 150, then 200 to see it's effects. When you are finished, set PageGutterMargin to 75 and RingType back to '0 - Two Piece.'

6.	Set the PageBorder property to 200. Notice the amount of space between the edges of the pages and the edges of the tab. Now set PageBorder to 50 and see the difference.

7.	Click on the 'Q1' tab so that all the tabs are on the right side. Change the RingMarginBottom property to 200 and RingMarginTop property to 600. These properties control the distance between the top or bottom of the spine and the edges of the tabs. Notice how the spacing and grouping of the rings is affected. Using these properties, you can override the control's default behavior, which is to make the rings symmetrical from top to bottom. You can also set these properties to negative values. Try setting RingMarginBottom and RingMarginTop to -50 and see what happens. Finally, set the values of RingMarginBottom and RingMarginTop to 0.

8.	Set TabLeftMargin to 100 and TabRightMargin to 200 and observe the change. Notice how the size of the tab changes relative to the spine and the rings. With the Notebook in its current mode, these settings control the offset of the top and bottom of the tab, since each tab is effectively rotated 90° (the orientation of the tab caption text is evidence of this.) You can use these properties in combination with the CoverMarginY property to produce a wide range of effects.

9.	To finish, set TabLeftMargin and TabRightMargin back to 0, change the RingType back to '1 - Plastic' and open the notebook so that the 'Q1' tab is on the left. Save the project.


Notebook Exercise 6: Binding to a Data Control
Exercise 6: Binding to a Data Control

See Also

The Notebook control can be bound to a Visual Basic data control providing an attractive and intuitive interface for your data. The procedure for binding the Notebook control to a Data control is identical to that for binding an Index Tab control (see Binding to a Data Control  in the Index Tab control section.) The captions of the tabs are bound to a single field in the database; you create controls in the Notebook to display the other fields. Unlike the Index Tab control, there is no method built in to the Notebook control which will allow you to scroll through the records in a recordset. You must provide this functionality yourself.

1.	For this exercise, start a new project. Place a Notebook control and a Data control on the initial form. Set the TabsPerRow property of the Notebook control to two. This will give the control large, evenly spaced tabs.

2.	Set the DatabaseName property of the Data control to "c:\vb\biblio.mdb." (This file name may be different if you have installed Visual Basic to a directory other than the default directory.) Set the RecordSource property to "Authors."

3.	Set the DataSource property of the Notebook control to "Data1." Set the DataField property to "Author."

4.	Save and run your project. The control should look like this:

5.	Try clicking on all the tabs of the control. You can select any tab, but you cannot scroll the control to records other than those displayed.

6.	Click on the [image] button of the Data control several times to move through the recordset. Notice how the Notebook control changes to reflect the state of the Data control. Move back and forth through several records until you get a feel for what is happening.

If you want, you can design your own custom interface to replace the buttons of the Data control. You might want to place navigation controls on a template and assign it to each tab in your Notebook, or you might want to keep the controls outside the Notebook altogether. The Notebook control will automatically update its appearance whenever the recordset changes position.


Notebook Methods
Notebook Control Methods

AddControl Method

Drag Method

Insert Method

Refresh Method

Remove Method

RemoveControl Method

SetFocus Method


Notebook Objects
Notebook Control Objects

Objects marked with a · are only accessible via the X object when using the VBX version of the control.

ActivePageFont Object

ActiveTabFont Object

Font Object

Page Object

PageFont Object

Picture Object

Tab Object

Template Object


Notebook Properties
Notebook Control Properties

(About) Property

(Custom) Property

(TemplateManager) Property

ActivePage3D Property

ActivePage3DBackColor Property

ActivePageBackColor Property

ActivePageFont Property

ActivePageFontBold Property

ActivePageFontItalic Property

ActivePageFontName Property

ActivePageFontSize Property

ActivePageFontStrikethru Property

ActivePageFontUnderline Property

ActivePageForeColor Property

ActivePagePicture Property

ActivePagePictureMetaHeight Property

ActivePagePictureMetaWidth Property

ActivePagePropertiesUsed Property

ActiveTab3D Property

ActiveTab3DBackColor Property

ActiveTabBackColor Property

ActiveTabFont Property

ActiveTabFontBold Property

ActiveTabFontItalic Property

ActiveTabFontName Property

ActiveTabFontSize Property

ActiveTabFontStrikethru Property

ActiveTabFontUnderline Property

ActiveTabForeColor Property

ActiveTabPicture Property

ActiveTabPictureMetaHeight Property

ActiveTabPictureMetaWidth Property

ActiveTabPropertiesUsed Property

Align Property

AlignmentCaption Property

AlignmentPicture Property

BackColor Property

BevelColorFace Property

BevelColorHighLite Property

BevelColorOutline Property

BevelColorScheme Property

BevelColorShadow Property

CoverAlignmentPicture Property

CoverAllowClose Property

CoverBackColor Property

CoverCornerStyle Property

CoverCreaseColor Property

CoverCreaseStyle Property

CoverGuardStyle Property

CoverMarginX Property

CoverMarginY Property

CoverPicture Property

CoverShadow Property

CoverShadowColor Property

CoverShadowSize Property

CoverVisible Property

DragIcon Property

DragMode Property

Enabled Property

Font Property

Font3D Property

FontBold Property

FontItalic Property

FontName Property

FontSize Property

FontStrikethru Property

FontUnderline Property

ForeColor Property

Height Property

HelpContextID Property

HelpWhatsThisID Property

HideInactiveControls Property

Index Property

Left Property

MouseIcon Property

MousePointer Property

Name Property

NotebookOrientation Property

Page Property

PageAlignmentCaption Property

PageAlignmentPicture Property

PageAnimation Property

PageAnimationResolution Property

PageBackColor Property

PageCaption Property

PageCaptionRotation Property

PageCount Property

PageEarmarkPos Property

PageFont Property

PageFont3D Property

PageFontBold Property

PageFontItalic Property

PageFontName Property

PageFontSize Property

PageFontStrikethru Property

PageFontUnderline Property

PageForeColor Property

PageGutterMargin Property

PageMargin Property

PageNavigation Property

PagePicture Property

PagePictureMetaHeight Property

PagePictureMetaWidth Property

Pages3D Property

PageStyle Property

PageTabEarmark Property

PageTabHeight Property

PageTabOrientation Property

PageTabsPerRow Property

PageTurnSound Property

PageTurnSoundFile Property

PageWordWrap Property

Parent Property

Picture Property

PictureMetaHeight Property

PictureMetaWidth Property

RingBackColor Property

RingCount Property

RingGroups Property

RingHighlightColor Property

RingHoleColor Property

RingHoleOutlineColor Property

RingHolesVisible Property

RingMarginBottom Property

RingMarginTop Property

RingOutlineColor Property

RingSize Property

RingSpacing Property

RingType Property

RingWidth Property

ShowFocusRect Property

SpineBackColor Property

SpineHighlightColor Property

SpineOutlineColor Property

SpineStyle Property

SpineVisible Property

Tab Property

TabBackColorDefault Property

TabCaptionRotation Property

TabCount Property

TabCutSize Property

TabForeColorDefault Property

TabGutterMargin Property

TabHeight Property

TabIndex Property

TabLeftMargin Property

TabMaxRows Property

TabMaxWidth Property

TabOrientation Property

TabRightMargin Property

TabRowOffset Property

Tabs3D Property

TabShape Property

TabSpacing Property

TabsPerRow Property

TabStart Property

TabStop Property

TabTopOffset Property

TabVariableSize Property

Tag Property

TemplateName Property

Top Property

TransparentBack Property

Visible Property

Width Property

WordWrap Property


NotebookOrientation Property

Applies To

Description

Returns or sets the orientation of the tabs, pages and spine in a Notebook control

Syntax

object  .NotebookOrientation [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the orientation of the tabs, as described in Settings.

Settings

Setting	Description

0	Landscape (top to bottom) - Notebook will be oriented with tabs on the top and bottom. Tabs and pages will be ordered from top to bottom.

1	Landscape (bottom to top) - Notebook will be oriented with tabs on the top and bottom. Tabs and pages will be ordered from bottom to top.

2	Portrait (left to right) - Notebook will be oriented with tabs on the left and right sides. Tabs and pages will be ordered from left to right.

3	(Default) Portrait (right to left) - Notebook will be oriented with tabs on the left and right sides. Tabs and pages will be ordered from right to left.


NumBtnStates Property

See Also	Applies To

Description

Returns or sets the number of button states included in the ToolsetPicture property.

Syntax

object  .NumBtnStates [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression with a value ranging from two to four that specifies the number of button states available on the toolbar.

Remarks

A value of two means that only the 'up' and 'down' states are included.  Three means that the 'up disabled' state is also included while a value of four means that all four states are included (as in the sample bitmap that follows).

This property supersedes the ToolsetNumBtnStates property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTools collection and not the control itself.

This property is only available at run time.  However, it can be initially set at design time using the Toolbar Designer.


Object Concepts

Note	This section will be of special interest to programmers who have worked with earlier versions of our custom controls. It highlights the major differences between the older controls you may be familiar with and the newer controls you now have.

Object-oriented programming offers you greater power than before, with less work on your part. However, because this is a new technology, there are some new concepts with which you should be familiar. This section provides a brief introduction to some of the new concepts you will encounter while using Sheridan custom controls.

Sub-objects and Collections

Designer Widgets provides an object-oriented approach to programming through the use of objects, sub-objects  and collections.  Objects can contain sub-objects, which have properties and methods of their own that can be examined and changed. Objects may also contain collection  objects.

You are probably familiar with the concept of sub-objects if you have used the Visual Basic 3.0 data control. The Recordset object is a sub-object of the Visual Basic Data Control. The Recordset contains a collection sub-object called the Fields object, which contains information that relates to all the fields in the Recordset collectively. The Fields collection also contains the Field objects themselves, which store data and also information pertaining to that data.

Objects within collections often have this type of "paired" arrangement; a single collection object (Fields) which describes and contains the collection as a whole, and multiple member objects (Field) which make up the collection. In addition, there is usually a corresponding property of the same name as the object that returns information about the object.

Collections used by Designer Widgets include the Tabs  collection, which is made up of Tab  objects; the Pages  collection and Page  objects; The Templates  collection and Template  objects; and the ToolsetTools  and Buttons  collections with their ToolsetTool  and Button  objects.

Collections have replaced property arrays as the preferred method for accessing sets of controls at run time. This means you no longer have to specify an array for each property you wish to access, and there are fewer special property names. For example, previously to set the caption text of the fifth tab in an Index Tab control, you would have used the following code:

SSIndexTab1.TabCaption(4) = "5th Tab"

Now, you would use the standard Caption property, specifying instead the object in the collection to which it will apply:

SSIndexTab1.Tabs(4).Caption = "5th Tab"


Outline Property

Applies To

Description

This property determines whether or not the toolbar is displayed with a 1-pixel black border around its outer edge.

Syntax

object  .Outline [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the visibility of the toolbar border, as described in Settings.

Settings

Setting	Description

True	A 1-pixel black border will be drawn around the toolbar.

False	(Default) No border is drawn.

Remarks

This property does not apply to a floating toolbar.


Page Object

Applies To

Description

A Page object is a container object within a Tab object.  Similar to a notebook with tab dividers, there may be any number of pages within a tab section.

Properties

BackColor

Caption

ForeColor

Name

Picture

PictureMetaHeight

PictureMetaWidth

TemplateName

Methods

AddControl

RemoveControl


Page Property

See Also	Applies To

Description

Returns or sets the active (current) page.

Syntax

object  .Page [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the active page.

Remarks

If you set this property, the control will change to display the page specified by page number.  This value is zero-based.


PageAlignmentCaption Property

See Also	Applies To	Example

Description

Determines how captions will be aligned on each page tab.

Syntax

object  .PageAlignmentCaption [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the alignment of the text in the captions of the tabs, as described in Settings.

Settings

Setting	Description

0	Left Justify - Top

1	Left Justify - Middle

2	Left Justify - Bottom

3	Right Justify - Top

4	Right Justify - Middle

5	Right Justify - Bottom

6	Center - Top

7	(Default) Center - Middle

8	Center - Bottom

Remarks

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageAlignmentPicture Property

See Also	Applies To	Example

Description

Determines how the picture will be aligned on each page tab.

Syntax

object  .PageAlignmentPicture[= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the alignment of the page tab pictures, as described in Settings.

Settings

Setting	Description

0	Left Justify - Top

1	(Default) Left Justify - Middle

2	Left Justify - Right

3	Right Justify - Top

4	Right Justify - Middle

5	Right Justify - Right

6	Center - Top

7	Center - Middle

8	Center - Right

9	Left of Text

10	Right of Text

11	Above Text

12	Below Text

13	Fit to Tab/Caption

Remarks

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageAnimation Property

See Also	Applies To

Description

Determines if page animation is to be used.

Syntax

object  .PageAnimation [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether animation will be used, as described in Settings.

Settings

Setting	Description

True	(Default) Animation will be used.

False	Animation will not be used.


PageAnimationResolution Property

See Also	Applies To

Description

Specifies the number of frames that will be used to draw the animated page effect.

Syntax

object  .PageAnimationResolution [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of frames to use when drawing the animated page turn effect..

Remarks

Increasing the number of frames increases the smoothness of the animation, but causes the animation to display more slowly. A lower value for this setting produces faster page turns but more choppy animation.

For this property to be active, the PageAnimation property must be set to True.


PageBackColor Property

See Also	Applies To

Description

Returns or sets the default background color of the pages.

Syntax

object  .PageBackColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the background color of the pages.

Remarks

This property only applies when PageStyle is set to zero.


PageCaption Property

See Also	Applies To

Description

Specifies the text to appear on the tab portion of the active or specified page.

Syntax

object  .PageCaption  [= text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that evaluates to the text displayed as the page caption.

Remarks

Caption text will only be visible if the PageNavigation property is set to "2 - Page Tabs." The appearance of the caption is based on the PageCaptionRotation, PageFont and PageFont3D properties.

At design time, this property sets the caption for the active page.

If a TrueType font is specified, the caption will automatically be rotated to match orientation of the page tab.


PageCaptionRotation Property

See Also	Applies To

Description

Specifies the amount that the text is rotated on the page tabs.

Syntax

object  .PageCaptionRotation [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the text rotation, as described in Settings.

Settings

Setting	Description

0	(Default) 0 degrees

1	90 degrees

2	180 degrees

3	270 degrees

Remarks

The text can be rotated in 90-degree increments. The rotation of the text is determined relative to the tab or page orientation, not the screen.

Caption text will only be visible if the PageNavigation property is set to "2 - Page Tabs."

You must specify a TrueType font for the caption if you want to use this property. Non-TrueType fonts cannot be rotated.

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageCount Property

See Also	Applies To	Example

Description

Returns or sets the total number of pages in the Pages collection of the active Tab object.

Syntax

object  .PageCount  [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of pages in the Pages collection.

Remarks

At design time, you can use this property to alter the number of pages contained in the currently active tab. The value of this property is identical to the value of the Count property of the Pages collection for a specified Tab.


PageEarmarkPos Property

See Also	Applies To

Description

Returns or sets the position of the earmark on the page.

Syntax

object  .PageEarmarkPos [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the position of the page earmark, as described in Settings.

Settings

Setting	Description

0	(Default) Top or right corner of page, depending on PageTabOrientation.

1	Bottom or left corner of page, depending on PageTabOrientation.

Remarks

This setting only applies if the value of  PageNavigation is set to "1 - Earmarks." This setting is affected by the PageTabOrientation property; if the page orientation is portrait, the earmarks will be on the top or bottom corners. If the orientation is landscape, earmarks will be on the left or right corners.

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageFont Object

See Also	Applies To

Description

Contains the information used to format the display of text in the caption of the selected pages collection.

Properties

Bold

Italic

Name (default)

Size

Strikethrough

Weight

Underline

Remarks

This object is equivalent to the standard Font object and has the same properties; however it applies only to the active or specified Pages collection.

Specifying a TrueType font for the PageFont property allows the control to rotate its caption text to match the orientation of the page tabs. Page tabs are visible only when the PageNavigation property is set to "2 - Page Tabs."


PageFont Property

See Also	Applies To	Example

Description

Returns or sets the properties of the PageFont object at design time and run time.

Syntax

object  .PageFont

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

Remarks

This setting provides access to the properties of the PageFont object. At design time, you can choose this setting to invoke the Font dialog box and set the font attributes of the object. At run time, specify a property setting of the object that you want to change or return.


PageFont3D Property

See Also	Applies To

Description

Returns or sets the 3-D style of the caption text for the selected pages collection.

Syntax

object  .Font3D [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the 3-D font style of the page, as described in Settings.

Settings

Setting	Description

0	(Default) None.  Caption is displayed flat (not 3-dimensional).

1	Raised w/light shading. Caption appears as if it is raised slightly off the screen.

2	Raised w/heavy shading. Caption appears even more raised.

3	Inset w/light shading. Caption appears as if it is inset slightly into the screen.

4	Inset w/heavy shading. Caption appears even more inset.

Remarks

At design time, this property applies to the collection containing the active page.

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageFontBold Property

See Also	Applies To

Description

Returns or sets the font style of the PageFont object to either bold or non-bold.

Syntax

object  .PageFontBold [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on bold formatting.

False	Turns off bold formatting.

Remarks

The PageFont object is not directly available at design time.  Instead you set the Bold property through a page's Font property.

At run time, however, you can set Bold directly by specifying its setting for the PageFont object.

In Visual Basic 3.0 you set the Bold property for the active page by selecting a control's PageFontBold property in the Visual Basic Properties window.


PageFontItalic Property

See Also	Applies To

Description

Returns or sets the font style of the PageFont object to either italicized or non-italicized.

Syntax

object  .PageFontItalic [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean  are:

Setting	Description

True	(Default) Turns on italic formatting.

False	Turns off italic formatting.

Remarks

The PageFont object is not directly available at design time.  Instead you set the Italic property through a page's Font property.

At run time, however, you can set Italic directly by specifying its setting for the PageFont object.

In Visual Basic 3.0 you set the Italic property for the active page by selecting a control's PageFontItalic property in the Visual Basic Properties window.


PageFontName Property
ActivePageFontName Property

See Also	Applies To

Description

Returns or sets the name of the font used by the PageFont object.

Syntax

object  .PageFontName [= font  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

font	A string expression specifying the font name to use.

Remarks

The PageFont object is not directly available at design time.  Instead you set the Name property through a page's Font property.

At run time, however, you can set Name directly by specifying its setting for the PageFont object.

In Visual Basic 3.0 you set the Name property for the active page by selecting a control's PageFontName property in the Visual Basic Properties window.


PageFontSize Property

See Also	Applies To

Description

Returns or sets the font size used in the PageFont object.

Syntax

object  .PageFontSize [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the size of the font in points.

Remarks

Use this property to format text in the font size you want.  The default font size is determined by the operating system.  To change the default, specify the size of the font in points.

The PageFont object is not directly available at design time.  Instead you set the Size property through a page's Font property.

At run time, however, you can set Size directly by specifying its setting for the PageFont object.

In Visual Basic 3.0 you set the Size property for the active page by selecting a control's PageFontSize property in the Visual Basic Properties window.


PageFontStrikethru Property

See Also	Applies To

Description

Returns or sets the font style of the PageFont object to either strikethrough or non-strikethrough.

Syntax

object  .PageFontStrikethru [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on strikethrough formatting.

False	Turns off strikethrough formatting.

Remarks

The PageFont object is not directly available at design time.  Instead you set the Strikethrough property through a page's Font property.

At run time, however, you can set Strikethrough directly by specifying its setting for the PageFont object.

In Visual Basic 3.0 you set the Strikethrough property for the active page by selecting a control's PageFontStrikethru property in the Visual Basic Properties window.


PageFontUnderline Property

See Also	Applies To

Description

Returns or sets the font style of the PageFont object to either underlined or not underlined.

Syntax

object  .PageFontUnderline [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style, as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on underlining.

False	Turns off underlining.

Remarks

The PageFont object is not directly available at design time.  Instead you set the Underline property through a page's Font property.

At run time, however, you can set Underline directly by specifying its setting for the PageFont object.

In Visual Basic 3.0 you set the Underline property for the active page by selecting a control's PageFontUnderline property in the Visual Basic Properties window.


PageForeColor Property

See Also	Applies To

Description

Returns or sets the default foreground color of the pages.

Syntax

object  .PageForeColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the foreground color of the pages.


PageGutterMargin Property

See Also	Applies To

Description

Returns or sets the distance between the ring holes and the inside (center) edge of the notebook pages.

Syntax

object  .PageGutterMargin [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the distance from the inside of the ring holes to the inside edge of the tab.

Remarks

Values for this property are in the scale mode of the form.


PageMargin Property

Applies To

Description

Returns or sets the distance between the edges of the page and the edges of the tab which contains it.

Syntax

object  .PageMargin [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of the area surrounding the pages.

Remarks

The value for this property is based on the scale mode of the form.


PageNavigation Property

See Also	Applies To	Example

Description

Returns or sets a value which determines the method used to identify and turn pages.

Syntax

object  .PageNavigation [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the type of page, as described in Settings.

Settings

Setting	Description

0	Code Only

1	(Default) Earmarks

2	Page Tabs

Remarks

Setting this property to "0 - Code Only" gives you the ability to create a custom interface for navigating pages using your own controls or keystrokes. Use the Page and PageCount properties respectively to change pages and track the number of available pages.

This property can be applied to an individual Tab object, which overrides the value set for the control.


PagePicture Property

See Also	Applies To

Description

Specifies the picture that will be displayed in the caption area of the selected page.

Syntax

object  .PagePicture [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap, icon, metafile)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap, icon or metafile.

Remarks

Page pictures will only be visible if the PageNavigation property is set to "2 - Page Tabs." The picture specified here will be overridden by the picture specified in ActivePagePicture when the page becomes the active page.

Setting this property is equivalent to setting the Picture property for the Page object that is currently selected.

If you specify a Windows metafile, you must also set the height and width to display the picture via the PagePictureMetaHeight and PagePictureMetaWidth properties.


PagePictureMetaHeight, PagePictureMetaWidth Properties

See Also	Applies To

Description

Returns or sets the height and/or width of a metafile selected for the Page object.

Syntax

object  .PagePictureMetaHeight [= number  ]

object  .PagePictureMetaWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying height or width of the metafile image on the page.

Remarks

The units specified are based on the scale mode of the form.


PageStyle Property

See Also	Applies To

Description

Returns or sets the appearance of the pages

Syntax

object  .PageStyle  [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the page style, as described in Settings.

Settings

Setting	Description

0	(Default) None - plain pages

1	Loose-leaf - white pages with margin and rules

2	Legal Pad - yellow pages with margin and rules

3	Steno Pad - white 2-column ruled pages

4	Graph Paper - white pages with blue grid

Remarks

If this property is set to "0 - None," the color of the pages is determined by the PageBackColor property. Otherwise, the color of the page is determined by the style.

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageTabEarmark Property

See Also	Applies To

Description

Determines whether the page tabs will have earmarks.

Syntax

object  .PageTabEarmark [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the visibility of page tab earmarks, as described in Settings.

Settings

Setting	Description

True	(Default) The page tabs will have earmarks.

False	The page tabs will not have earmarks.

Remarks

This property applies only when PageNavigation is set to "2 - Page Tabs."

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageTabHeight Property

See Also	Applies To

Description

Returns or sets the height of the page tabs.

Syntax

object  . PageTabHeight [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the height of the page tabs.

Remarks

This property is similar to the TabHeight property, except that it applies to the caption area of pages. The value for this property is based on the scale mode of the form. This property applies only when PageNavigation is set to "2 - Page Tabs."

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageTabOrientation Property

See Also	Applies To

Description

Returns or sets the orientation of the page tabs.

Syntax

object  .PageTabOrientation [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the orientation of the page tabs, as described in Settings.

Settings

The settings of this property vary depending on the object to which it is applied:

Notebook Control object:

Setting	Description

0	Outside - Page tabs will be displayed opposite the spine.

1	Top or Right - Page tabs will be at the top or on the right side of the tabs, depending on NotebookOrientation.

2	Bottom or Left - Page tabs will be at the bottom or on the left side of the tabs, depending on NotebookOrientation.

3	(Default) Page tabs will be the same as tab captions, as determined by TabOrientation.

Index Tab Control object:

Setting	Description

0	Top of the control.

1	Bottom of the control.

2	Left side of the control

3	Right side of the control

4	(Default) Same as TabOrientation

Remarks

This property applies only when PageNavigation is set to "2 - Page Tabs."

If the Notebook control is in a portrait mode (NotebookOrientation is 0 or 1) page tabs will be displayed on the left or the right side, according to the value of TabOrientation. If the Notebook is in landscape mode, (NotebookOrientation is 2 or 3) page tabs will be displayed on the top or bottom, according to the value of TabOrientation.

This property can be applied to an individual Tab object, which overrides the value set for the control. Use the settings appropriate to the control which contains the Tab object.


PageTabsPerRow Property

See Also	Applies To	Example

Description

Returns or sets the maximum number of page tabs in a row.

Syntax

object  .PageTabsPerRow [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the maximum number of page tabs to appear in the page caption row.

Remarks

You can use this property in conjunction with the PageCount property to determine the number of page tabs the control will display.

This property applies only when PageNavigation is set to "2 - Page Tabs."

This property can be applied to an individual Tab object, which overrides the value set for the control.


PageTurnSound Property

See Also	Applies To	Example

Description

Returns or sets the type of sound that will accompany the page turning.

Syntax

object  .PageTurnSound [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the sound effect to use for page turns, as described in Settings.

Settings

Setting	Description

0	(Default) None

1	Stock 1

2	Stock 2

3	Stock 3

4	Custom

Remarks

In addition to the sounds included with the control, you can specify your own sound to be played with the animation. To use your own sounds, set the PageTurnSound property to "4 - Custom" and specify the filename of a sound file to in the PageTurnSoundFile property.

Note	The computer must have a properly installed and configured audio playback device in order to use animation sounds.


PageTurnSoundFile Property

See Also	Applies To	Example

Description

Specifies the file name of a sound file to be played when a page is turned.

Syntax

object  . PageTurnSoundFile [= filename  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

filename	A string expression specifying the name of a WAV audio file for the control to use.

Remarks

This property is used only when PageTurnSound is set to "4 - Custom."

The file specified by filename  must be in the current directory unless additional path information is supplied.

If you use custom sound files, be sure to distribute them along with your application. If a custom sound file cannot be found, no sound will be played.

Note	The computer must have a properly installed and configured audio playback device in order to use animation sounds.


PageWordWrap Property

See Also	Applies To

Description

Determines whether or not the caption text of the pages can be wrapped.

Syntax

object  .PageWordWrap [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the page will wrap caption text to the next line, as described in Settings.

Settings

Setting	Description

True	The page will wrap text that is too long to fit within the caption area.

False	(Default) The page will truncate text that is too long to fit within the caption area.

Remarks

This property can be applied to an individual Tab object, which overrides the value set for the control.


Pages Collection

See Also	Applies To

Description

The Pages collection is a collection of Page objects (container objects within a tab section).  Similar to a notebook with tab dividers, there may be any number of pages within a tab section.

Properties

Count

Item

Methods

Insert

Remove


Pages3D Property

See Also	Applies To

Description

Returns or sets the type of 3-D appearance for the pages.

Syntax

object  .Pages3D [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether pages will have a 3-D effect, as described in Settings.

Settings

Setting	Description

True	The pages will be drawn in 3-D (beveled).

False	(Default) The pages will not be drawn in 3-D .

Remarks

When this property is set to True, the background colors of the page are determined by the bevel color properties: BevelColorFace, BevelColorShadow, and BevelColorHighlight. Otherwise, the color specified by PageBackColor is used.

This property can be applied to an individual Tab object, which overrides the value set for the control.


PagesVisible Property

Applies To

Description

Returns or sets the visibility of all the pages in the control.

Syntax

object  .PagesVisible [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the visibility of the pages, as described in Settings.

Settings

Setting	Description

True	(Default) Pages will be visible.

False	Pages will not be visible.

Remarks

Setting this property to false disables and hides all the pages in the control, regardless of their individual settings. This property is useful if you want to use only the tabs in a control. You might also want to use this property to provide different levels of detail, such as unrestricted and password-protected modes, where pages remain invisible until a password is entered.

Although they cannot be accessed through code, pages hidden by the PagesVisible property are not removed from the control. Any controls placed on hidden pages remain intact, and will be accessible when PagesVisible is set to True.

Page zero, which displays the controls associated with the tab itself, is not affected by this property.


Parts of a Form

The FormFX control can be used to customize different areas of Visual Basic forms. The diagram below illustrates the parts of a form:

A standard Visual Basic form is divided into two basic parts; the client area and the non-client area.  The client area is where controls are placed. The non-client area includes the border, the caption area and the standard caption buttons. FormFX further divides the caption area into CaptionButtonsLeft and CaptionButtonsRight areas.

Note	The caption area and caption buttons together are referred to as the title bar.

You can use SSFormFX to change the caption height, the standard caption button height, the control box height, the number of lines of caption text and the font used for the caption.  Pictures can also be added to the caption area.  You can also specify a bitmap to customize the look of the standard caption buttons.  In addition, you can make the border appear 3-D.

You can also use the FormFX control to place custom buttons in the caption area of the form.  The CaptionButtonsLeft and CaptionButtonsRight areas can contain custom caption buttons for the left and right side of the caption area. Each added button will fire an event when clicked.

There are also several properties that you can use to customize the behavior of a form,  such as restricting its movement and its maximized and restored sizes.


Picture Object

See Also	Applies To

Description

The Picture object gives you a way to manipulate bitmaps, icons, and metafiles assigned to objects having a Picture property.

The Picture object supports the following properties:

Properties

Handle

Height

hPal

Type

Width

Remarks

You frequently access a Picture object using the Picture property. The Picture object is an object that displays graphics; the Picture property sets or returns the graphic that the object will display.

See Pictures in Compatibility Issues  for more information on setting the Picture property while using the VBX version of the control.


Picture Property

See Also	Applies To

Description

Specifies a picture object for display.

Syntax

object  .Picture [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap, icon, metafile)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap, icon or metafile.

Remarks

This property will set the picture for the specified object. If the picture is a Windows metafile, you must also set the height and width used to display the picture via the appropriate MetaHeight and MetaWidth properties for the specific object.

When applied to the Index Tab or Notebook controls at design time, this property sets the picture for the currently selected tab. At run time, this property sets the picture for the currently selected tab object or the specified tab or page object.

This property supersedes the TabPicture property from the previous version. It is functionally identical to that property, except that it applies at both the object level and the control level.

When applied to the ToolsetTools collection, this property supersedes the ToolsetNumTools property from the previous version. It is functionally identical to that property, except that it applies to the ToolsetTools collection and not the control itself.


PictureDn, PictureUp Properties

See Also	Applies To

Description

Specifies the image to be used for the 'up' or 'down' states of a toolbar button.

Syntax

object  .PictureDn [= picture  ]

object  .PicureUp [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap.

Remarks

These properties are not kept as separate bitmaps and therefore do not consume excessive system resources. They are used just like the GraphicCell() property in the Picture Clip control (included in the Visual Basic Professional Edition) except that they are not read-only.

You can use the Toolset Bitmap Editor to easily design custom bitmaps for use with these properties.

These properties supersede the ToolsetToolPicDn and ToolsetToolPicUp properties from the previous version. They are functionally identical to those properties, except that they apply to the ToolsetTool object and not the control itself.

These properties are only available at run time.


PictureDnDis, PictureUpDis Properties

See Also	Applies To

Description

Specifies the image to be used for the 'up' or 'down' states of a toolbar button when it is disabled.

Syntax

object  .PictureDnDis [= picture  ]

object  .PicureUpDis [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap.

Remarks

These properties are not kept as separate bitmaps and therefore do not consume excessive system resources.  They are used just like the GraphicCell() property in the Picture Clip control (included in the Visual Basic Professional Edition) except that they are not read-only.

You can use the Toolset Bitmap Editor to easily design custom bitmaps for use with these properties.

These properties supersede the ToolsetToolPicDnDis and ToolsetToolPicUpDis properties from the previous version. They are functionally identical to those properties, except that they apply to the ToolsetTool object and not the control itself.

These properties are only available at run time.


PictureMetaHeight, PictureMetaWidth Properties

See Also	Applies To

Description

Returns or sets the height and/or width of a metafile selected for the caption area of a Page or Tab object.

Syntax

object  .PictureMetaHeight [= number  ]

object  .PictureMetaWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying height or width of the metafile image in the caption area of a page or tab.

Remarks

The units specified are based on the scale mode of the form.

When applied to the Tab object, these properties supersede the TabPictureMetaHeight and TabPictureMetaWidth properties from the previous version. They are functionally identical to those properties, except that they apply to the Tab object and not the control itself.


Pictures (Appendix C)
Pictures

As with fonts, both the VBX and OCX versions of the Designer Widgets controls support the Picture object.

The following properties are supported under the Picture object:

Properties

Handle	hPal	Width
Height	Type
Note	When you use the VBX version of the controls, control-level picture properties do not return a Picture object. The above properties of the Picture object can only be set when using the OCX version of the controls or on picture properties of sub-objects using the VBX version of the control.

When you use the VBX version of the controls, the LoadPicture function cannot be used to set the Picture property of a sub-object.  Instead, the Picture property must be set to one of the following:

•	A literal string containing the name of the file containing the picture

•	The picture property of another control

•	The picture property of another sub-object

•	The handle to a bitmap, icon or metafile.

The following line of code sets the Picture property of a Page object in the Pages collection to a string containing the name of a bitmap file:

SSNotebook1.X.Pages(1).Picture = "MYPIC.BMP"

The next line of code sets it to the Picture property of a Picture control:

SSNotebook1.X.Pages(1).Picture = Picture1.Picture

The next line of code sets it to the Picture property of another sub-object:

SSNotebook1.X.Pages(1).Picture = SSNotebook1.X.Pages(2).Picture

See Sub-objects and Collections for a discussion of sub-objects.


Placeholder Property

See Also	Applies To

Description

Determines whether or not a placeholder will be assigned for this tool.  A placeholder is necessary, for example, if the toolbar's orientation is changed from horizontal to vertical, and the control is wider than the single button width of the toolbar.

Syntax

object  .Placeholder [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether a placeholder is assigned to the tool, as described in Settings.

Settings

Setting	Description

True	Placeholder is assigned.

False	(Default) No placeholder.


PlaceholderWidth Property

Applies To

Description

Returns or sets the width of the placeholder button.

Syntax

object  .PlaceholderWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the width of a child control

Remarks

The value of this property determines the width of the area that will be reserved for a child control on the toolbar when it is horizontal. For this property to be active, the Placeholder property must be set to True.

The units specified are based on the scale mode of the form.


Placing Controls in the Notebook

The Notebook control allows you to visually place the controls that will appear inside of it from within the Visual Basic design time environment.  This is done simply by selecting a tab or page (using the left mouse button) and placing the desired controls directly onto the Notebook Control.

When finished with a tab or page, select the next tab or page.  You will notice that all the controls that you placed on the previous tab or page have disappeared.  The Notebook Control remembers where these controls were placed so that the next time you select that tab or page, the controls will reappear.

Be sure that all controls placed in the Notebook are in fact child controls of the Notebook. To ensure that a control you create is a child, first select the Notebook control by clicking on it once with the left mouse button.  Then select the desired tool from the Visual Basic toolbox.  Now drag the control to the proper size directly on the Notebook control.

To test whether the controls are children of the Notebook control, move the Notebook control to a different location on the form.  The controls should follow the Notebook control.

Note	Although you place controls on a tab at design time, the controls are actually stored on a page of that tab designated as page zero. This page is unique in that it cannot be removed or made visible, nor is it affected by other page settings. The use of page zero is managed by the control should be transparent both at design time and at run time. However, you have the option of referring to page zero if you wish.


Placing Controls on the Tab
Placing Controls on the Index Tab

The Index Tab Control allows you to visually set up the controls that will appear on each tab within the Visual Basic design time environment. This is done simply by selecting each tab (using the left mouse button) one at a time and placing the desired controls directly onto the Index Tab control.

Be sure that all controls placed on the tab are, in fact, child controls of the  tab.  This is how the Index Tab Control knows which controls are on which tab.  To ensure that a control is a child of the tab, first select the Index Tab Control by clicking on it once with the left mouse button. Then select the desired tool from the Visual Basic toolbox.  Now drag the control to the proper size directly on the Index Tab Control.

It is especially easy to "misplace" controls in the design time environment when you are pasting them from the clipboard. Be sure to select the Index Tab control before executing the paste command. To test whether the controls are actually children of the Index Tab Control, move the Index Tab control to a different location on the form.  The controls should follow the Index Tab Control.

When finished with one tab, select the next tab. You will notice that all the controls that you placed on the previous tab have disappeared. The Index Tab Control remembers where these controls were placed so that the next time you select the tab, the controls will reappear.

Note	Although you place controls on a tab at design time, the controls are actually stored on a page of that tab designated as page zero. This page is unique in that it cannot be removed, and it is not affected by other page settings. The use of page zero is managed by the control and should be transparent both at design time and at run time. However, you have the option of referring to page zero if you wish.


Property Pages

Sheridan Software custom controls now support a feature known as property pages. Property pages provide an interface through which you can view and modify the properties of your custom control objects. The purpose of property pages is twofold.

First, property pages make it possible to modify your control in a host environment that does not provide a property sheet. Second, you can use property pages to set properties at design time that would not otherwise be available - the so-called "run time" properties. Property pages provide access to all the properties of a control, even those which do not appear in the Visual Basic Property Sheet.

Note	For the most up-to-date information regarding property pages, please consult the README.TXT file that was installed along with the custom controls.

The Property Pages Interface

The property pages dialog consists of a series of index tabs, each of which provides access to a different aspect of a control's behavior. How many tabs appear in a given dialog will depend on the features that the control supports. There will always be at least one tab called 'Properties' which lists all the properties of the control. Other tabs may support added functions or utilities.

Properties are listed in a hierarchical menu structure similar to the tree view of the Windows File Manager. This structure makes it easy for you to access the properties of sub-objects and collections. As you choose a property name from the tree on the left, the valid settings for that property appear on the right, enabling you to examine or modify them.

Accessing Property Pages

The method you use to access the property pages of your control depends on two things; the version of the control you are using, and the host environment in which you are using the control.

Many host environments support the use of the right mouse button to pop up a context-specific menu. In these environments, you simply click on your control with the right mouse button, and choose 'Property Pages' or 'Properties' from the pop-up menu.

If you are using the VBX version of a control, this behavior may not be supported. Instead, use the property sheet of your design environment. You will see a property labeled '(Custom)' in the property sheet. By double-clicking this property or choosing the ellipsis (...) button, you can invoke the property pages for the selected control.

If neither of these methods are supported, you will need to consult the documentation of your host environment for information on how to change the properties of objects. You may need to choose a special menu option, or perform a shifted mouse-click or double-click on the control. Try searching your environment's on-line help file for references to objects, embedded objects, object properties, object settings, OLE linking, OLE servers, or properties.


Redraw Property

Applies To	Example

Description

Temporarily disables repainting of the form or control.

Syntax

object  .Redraw [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying when the form or control will be redrawn, as described in Settings.

Settings

Setting	Description

True	(Default) Will redraw the form or control when changes are made to the control's properties.

False	Will not redraw the form or control when changes are made.  You must set this back to True so the form or control can redraw itself.

Remarks

This property is used to defer painting when changing multiple properties so that flickering does not occur. When used with the Tab or Notebook control, Redraw affects the painting of the control. When used with FormFX, Redraw affects the painting of the entire form.


Remove Method

See Also	Applies To	Example

Description

This method is used to remove a specified tab, page or template from the Tabs, Pages or Templates collection.

Syntax

object  .Remove target

Remarks

The parameters are:

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

target	Required. An integer expression which specifies the index of the object in the Tabs, Pages or Templates collection which is to be removed.

Note	A page, tab or template must be empty before it can be removed. If the it contains controls when you apply the Remove method, a trappable error will be generated and the page, tab or template will not be removed.

This method affects the value of TabCount or PageCount, depending on which type of object is removed.


RemoveControl Method

See Also	Applies To	Example

Description

This method is used to remove a control from a Tab or Page object.

Syntax

object  .RemoveControl controlname

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

controlname	The name of an existing control.

Remarks

Controls removed via the RemoveControl method are not destroyed. They still exist in the Index Tab or Notebook control, but are no longer associated with any tab or page. They can later be placed using the AddControl method.


RingBackColor Property

See Also	Applies To

Description

Returns or sets the background color of the notebook rings.

Syntax

object  .RingBackColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the background (fill) color of the rings.

Remarks

This property will set the main color of the notebook rings.  The highlight color of the rings is set by the RingHighlightColor property, and the outline color is set by the RingOutlineColor property.


RingCount Property

See Also	Applies To

Description

Returns or sets the total number of notebook rings.

Syntax

object  .RingCount [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of rings in the notebook.

Remarks

Together with the RingGroups property, this property determines the basic structure of the notebook rings.  The valid setting for this property is 0 or greater.


RingGroups Property

See Also	Applies To

Description

Returns or sets the number of notebook ring groups.

Syntax

object  .RingGroups [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of groups of notebook rings.

Remarks

Together with the RingCount property, this property determines the overall layout of the notebook rings.


RingHighlightColor Property

See Also	Applies To

Description

Returns or sets the highlight color of the notebook rings.

Syntax

object  .RingHighlightColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the highlight color of the rings.

Remarks

The main color of the rings is set by the RingBackColor property, and the outline color is set by the RingOutlineColor property.


RingHoleColor Property

See Also	Applies To

Description

Returns or sets the color of the notebook ring holes.

Syntax

object  .RingHoleColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the color of the ring holes.

Remarks

This property will set the color of the notebook ring holes.  For this property to be active, the RingHolesVisible property must be set to True.


RingHoleOutlineColor Property

See Also	Applies To

Description

Returns or sets the outline color of the holes in the notebook pages.

Syntax

object  .RingHoleOutlineColor [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the color of the outline surrounding the ring holes.


RingHolesVisible Property

See Also	Applies To

Description

Determines whether or not the notebook ring holes will be shown.

Syntax

object  .RingHolesVisible [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the visibility of the ring holes, as described in Settings.

Settings

Setting	Description

True	Ring holes will be shown.

False	(Default) Ring holes will not be shown.


RingMarginBottom, RingMarginTop Properties

See Also	Applies To

Description

Returns or sets the ring top margin (from the top of the tab to the top of the ring) and the ring bottom margin (from the bottom of the tab to the bottom of the ring).

Syntax

object  .RingMarginBottom [= number  ]

object  .RingMarginTop [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the distance from the edge of the rings to the edge of the tab.

Remarks

By setting the top and bottom margins to different values, you can offset the rings to provide a non-symmetrical appearance.

The units specified are based on the scale mode of the form.  A setting of 0 or greater is valid for these properties.


RingOutlineColor Property

See Also	Applies To

Description

Returns or sets the outline color of the notebook rings.

Syntax

object  .RingOutlineColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the color of the outline of the rings.

Remarks

The main color of the rings is set by the RingBackColor property, and the highlight color is set by the RingHighlightColor property.


RingSize Property

See Also	Applies To

Description

Returns or sets the width of the rings and spine of the notebook.

Syntax

object  .RingSize [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the width of the ring area.

Remarks

This property determines the width of the entire spinal area, including notebook rings, creases, gutter, and the spine itself.

The units specified are based on the scale mode of the form.  The valid setting for this property is 0 or greater.


RingSpacing Property

See Also	Applies To

Description

Returns or sets the spacing between notebook rings.

Syntax

object  .RingSpacing [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the distance between individual notebook rings.

Remarks

The units specified are based on the scale mode of the form.  The valid setting for this property is 0 or greater.


RingType Property

See Also	Applies To

Description

Returns or sets the type of notebook ring to display.

Syntax

object  .RingType [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the type of ring, as described in Settings.

Settings

Setting	Description

0	Two Piece

1	Plastic

2	Solid

3	Spiral (Single Wire)

4	Spiral (Double Wire)

5	Spiral (Triple Wire)


RingWidth Property

See Also	Applies To

Description

Returns or sets the width (thickness) of each notebook ring.

Syntax

object  .RingWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the width of the rings.

Remarks

The units specified are based on the scale mode of the form.  The valid setting for this property is 0 or greater.


Scrolling Interface
The Scrolling Interface

Although clicking on tabs is the easiest and most obvious way to navigate through the Index Tab control, there are certain circumstances where you may want to provide the user with an alternative method. Examples include:

•	A control that has more tabs than will fit on the screen at once. For instance, if you only have room for two rows of five tabs on your control (for a maximum of 10 visible tabs) but you wish to have a total of twenty or thirty tabs in your control

•	A control that has only one row of tabs. You may want to display all the tabs on a single line, and have the user scroll back and forth to select the one they want.

•	A control that is bound to a database. In this case you may have hundreds or thousands of records which can be selected, but a limited number of tabs. You would need a scrolling interface so that when the user clicks on the last tab in the control, they have a means to move on to further records.

To cope with these types of situations, the Index Tab control has a built-in scrolling interface, which consists of two scroll buttons. The scroll buttons appear on the far right of the first row of tabs. By default, this interface is disabled, but you can use it by setting the value of TabScrollType to a value other than zero.

The shape and orientation of the buttons varies depending on the type of tabs selected by the TabShape property, the number of rows specified by the TabMaxRows property and the height of the tabs set in the TabHeight property.

When the control is in data bound mode, the number of tabs represents a fixed "window" that shows a specific number of records from the database. For example, if you have a tab control with ten tabs bound to a database with one hundred records, only ten of the records will be visible at a time:

Using the scroll buttons, you can navigate through the recordset. Records will be retrieved a row at a time (if your control has more than one row) until you reach the end (or beginning) of the database. For example, if your control has two rows of five tabs each, pressing the forward scroll button will cause the next five records to appear in the second row.


Setting Index Tab Captions and Pictures at Design Time
Setting Captions and Pictures at Design Time

In the design time environment, any changes you make to tab-specific or page-specific properties are applied to the currently selected tab or page.

To set the caption and/or picture for a specific tab, first select the tab you want to modify. Then, set the Caption property using the Visual Basic Property Sheet. To set a picture for the selected tab, set the Picture property. Repeat this process for all the tabs.

The process is the same for setting page captions and pictures, except that page captions and pictures are not visible unless you have chosen to use Page Tabs by setting PageNavigation to '2- Page Tabs'. Select the page you want to modify. Then, set the PageCaption property using the Visual Basic Property Sheet. Pages also have a PagePicture property .

You can distinguish the active tab and the active page by selecting a unique picture. Set the ActiveTabPicture or ActivePagePicture properties to specify a picture which will appear on whichever tab or page is active.

In each of the above cases, you can specify a Windows icon, bitmap or metafile as the picture to be used. If you specify a metafile, you must additionally supply the size of the metafile. This is done using MetaHeight and MetaWidth properties that are based on the scale mode of the form. For a tab, you would set the PictureMetaHeight and PictureMetaWidth properties. Metafiles used on a page require a setting for PagePictureMetaHeight and PagePictureMetaWidth. If you use a metafile to designate the active tab or page, you must set the ActiveTabPictureMetaHeight and ActiveTabPictureMetaWidth or ActivePagePictureMetaHeight and ActivePagePictureMetaWidth properties.

When you save the form, all of these property settings will be written to disk.  The next time you load the project, the captions and pictures will be retrieved and set for the appropriate objects.


Setting Notebook Captions and Pictures at Design Time
Setting Captions and Pictures at Design Time

In the design time environment, any changes you make to tab-specific or page-specific properties are applied to the currently selected tab or page.

To set the caption and/or picture for a specific tab, first select the tab you want to modify. Then, set the Caption property using the Visual Basic Property Sheet. To set a picture for the selected tab, set the Picture property. Repeat this process for all the tabs.

The process is the same for setting page captions and pictures, except that page captions and pictures are not visible unless you have chosen to use Page Tabs by setting PageNavigation to '2- Page Tabs'. Select the page you want to modify. Then, set the PageCaption property using the Visual Basic Property Sheet. Pages also have a PagePicture property .

You can distinguish the active tab and the active page by selecting a unique picture. Set the ActiveTabPicture or ActivePagePicture properties to specify a picture which will appear on whichever tab or page is active.

In each of the above cases, you can specify a Windows icon, bitmap or metafile as the picture to be used. If you specify a metafile, you must additionally supply the size of the metafile. This is done using MetaHeight and MetaWidth properties that are based on the scale mode of the form. For a tab, you would set the PictureMetaHeight and PictureMetaWidth properties. Metafiles used on a page require a setting for PagePictureMetaHeight and PagePictureMetaWidth. If you use a metafile to designate the active tab or page, you must set the ActiveTabPictureMetaHeight and ActiveTabPictureMetaWidth or ActivePagePictureMetaHeight and ActivePagePictureMetaWidth properties.

When you save the form, all of these property settings will be written to disk.  The next time you load the project, the captions and pictures will be retrieved and set for the appropriate objects.


Setting Up the Number of Index Tabs or Pages
Setting Up the Number of Tabs or Pages

You can specify the number of tabs that you want in your control, as well as the number of pages for each tab. You can also determine how many rows of tabs and pages will be displayed. To set the number of tabs the control will have, use the TabCount property. To determine how many rows of tabs the control will display, you must specify a value for the TabsPerRow property. The control will divide the number of tabs by the number of tabs per row (TabCount / TabsPerRow) to get the number of rows. If the number of tabs does not divide evenly into the number of rows, one row will have fewer tabs than the others.

For example, if you specify a TabCount of eleven and TabsPerRow value of four, the result would be a control with three rows of tabs. The first two rows would each have four tabs, but the final row would have only three.

Setting the number of pages is a similar process, but any changes you make apply only to the pages of the active tab. This gives you the ability to have a different number of pages for each tab. You set the value of the PageCount property to specify the number of pages you want in the active tab. You can determine the number of  page tabs in each row by setting the PageTabsPerRow property. Page tabs are only visible if the PageNavigation property is set to '2 - Page Tabs.'

The Index Tab control also gives you the ability to disable the display of pages altogether. The PagesVisible property can be used to hide all of the pages at once. Although the pages still exist as they were created at run time, the user will be unable to access them or the controls they contain.


Setting Up the Number of Notebook Tabs or Pages
Setting Up the Number of Tabs or Pages

You can specify the number of tabs that you want in your control, as well as the number of pages for each tab. You can also determine how many rows of tabs and pages will be displayed. To set the number of tabs the control will have, use the TabCount property. To determine how many rows of tabs the control will display, you must specify a value for the TabsPerRow property. The control will divide the number of tabs by the number of tabs per row (TabCount / TabsPerRow) to get the number of rows. If the number of tabs does not divide evenly into the number of rows, one row will have fewer tabs than the others.

For example, if you specify a TabCount of eleven and TabsPerRow value of four, the result would be a control with three rows of tabs. The first two rows would each have four tabs, but the final row would have only three.

Setting the number of pages is a similar process, but any changes you make apply only to the pages of the active tab. This gives you the ability to have a different number of pages for each tab. You set the value of the PageCount property to specify the number of pages you want in the active tab. You can determine the number of  page tabs in each row by setting the PageTabsPerRow property. Page tabs are only visible if the PageNavigation property is set to '2 - Page Tabs.'

The Index Tab control also gives you the ability to disable the display of pages altogether. The PagesVisible property can be used to hide all of the pages at once. Although the pages still exist as they were created at run time, the user will be unable to access them or the controls they contain.


Setting the Caption of a Form

Due to the way Visual Basic behaves when setting the Form's Caption property at run time, unusual painting problems may occur.  If you need to set the Caption property at run time, set the FormFX Caption property instead.  The FormFX control will use the text in this property to display in the Form's caption area.  If you leave the FormFX Caption property blank at design time, the FormFX control will use the text in the Form's Caption property.


ShowFocusRect Property

Applies To

Description

Determines if the focus rectangle will be displayed on a tab when the control gets focus.

Syntax

object  .ShowFocusRect [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the focus rectangle will be displayed, as described in Settings.

Settings

Setting	Description

True	(Default) Shows the focus rectangle when a tab has focus.

False	Does not show the focus rectangle when a tab has focus.


Size Property

See Also	Applies To	Example

Description

Returns or sets the font size used in the specified Font object.

Syntax

object  .Size [= number  ]

The Size property syntax has these parts:

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the size of the font in points.

Remarks

Use this property to format text in the font size you want.  The default font size is determined by the operating system.  To change the default, specify the size of the font in points.  The maximum value for the Size property is 2048 points.

The Font object is not directly available at design time.  Instead you set the Size property through a control's Font property.

At run time, however, you can set Size directly by specifying its setting for the appropriate Font object.

In Visual Basic 3.0 you set the Size property by selecting a control's ActiveTabFontSize, ActivePageFontSize or FontSize property in the Visual Basic Properties window.


SizeMaxHeight, SizeMaxWidth Properties

See Also	Applies To	Example

Description

Returns or sets the maximum height/width to which the form can be sized to at run time.

Syntax

object  .SizeMaxHeight [= number  ]

object  .SizeMaxWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the maximum vertical or horizontal size of a form.

Remarks

Set these properties to zero for no size restrictions.  The value specified is based on the scale mode of the form.


SizeMinHeight, SizeMinWidth Properties

See Also	Applies To	Example

Description

Returns or sets the minimum height/width to which the form can be sized to at run time.

Syntax

object  .SizeMinHeight [= number  ]

object  .SizeMinWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the minimum vertical or horizontal size of a form.

Remarks

Set these properties to zero for no size restrictions.  The value specified is based on the scale mode of the form.


SpineBackColor Property

See Also	Applies To

Description

Returns or sets the background color of the spine.

Syntax

object  .SpineBackColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the background (fill) color of the spine.

Remarks

This property will change the main color of the spine.  The outline color of the spine is set by the SpineOutlineColor property.  For this property to be active, the SpineVisible property must be set to True.


SpineHighlightColor Property

See Also	Applies To

Description

Returns or sets the highlight color of the spine.

Syntax

object  .SpineHighlightColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the highlight color of the spine.

Remarks

The main color of the spine is set by the SpineBackColor property.


SpineOutlineColor Property

See Also	Applies To

Description

Returns or sets the outline color of the spine.

Syntax

object  .SpineOutlineColor [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the outline color of the spine.

Remarks

The main color of the spine is set by the SpineBackColor property.


SpineStyle Property

See Also	Applies To

Description

Returns or sets the shape of the spine.

Syntax

object  .SpineStyle [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the style of the spine, as described in Settings.

Settings

Setting	Description

0	(Default) Rounded

1	Square

2	Chamfered


SpineVisible Property

See Also	Applies To

Description

Determines whether or not the spine will be visible.

Syntax

object  .SpineVisible [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the visibility of the spine, as described in Settings.

Settings

Setting	Description

True	(Default) Spine will be visible.

False	Spine will not be visible.

Remarks

The spine automatically becomes invisible when RingType is set to the following values:

1 - Plastic

3 - Spiral (Single Wire)

4 - Spiral (Double Wire)

5 - Spiral (Triple Wire)


StdButtonHeight Property

See Also	Applies To	Example

Description

Determines whether or not the buttons in the caption area will be the standard height.

Syntax

object  .StdButtonHeight [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the height of the caption buttons, as described in Settings.

Settings

Setting	Description

True	The buttons in the caption area will be the standard height.  This includes the Maximize and Minimize buttons, and the Control Box.  This property will not make the buttons greater than the CaptionHeight. However, if the CaptionHeight is less than the standard button height, the control will shrink the buttons to fit.

False	(Default) The buttons in the caption area will be sized using the value of CaptionHeight.

Remarks

The StdCaption property must be set to False for this property to be active.


StdCaption Property

Applies To	Example

Description

Determines if the control should display a standard caption, ignoring all custom caption-related properties.

Syntax

object  .StdCaption [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the display mode of the caption, as described in Settings.

Settings

Setting	Description

True	Standard Windows caption area will be used.

False	(Default) The control will alter the caption area based on caption-related property settings.

Remarks

Set this property to True to effectively disable all caption-related customization. If this setting is True, the following properties are ignored:

•	Caption3D

•	CaptionBevelInner/Outer

•	CaptionBevelWidth

•	CaptionBorderWidth

•	CaptionButtonEnabledLeft/Right

•	CaptionButtonPicDisLeft/Right

•	CaptionButtonPicLeft/Right

•	CaptionButtonTypeLeft/Right

•	CaptionButtonValueLeft/Right

•	CaptionButtonVisibleLeft/Right

•	CaptionButtonsLeft/Right

•	CaptionButtonsPic

•	CaptionHeight

•	CaptionMultiLine

•	CaptionPicture

•	CaptionPictureMetaHeight/Width

•	CaptionPictureX/Y

•	ControlBox3D

•	ControlBoxWidth

•	Font (and  Font-related properties )

•	Font3D

•	ForeColorActive

•	ForeColorInactive

•	InstantClose

•	StdButtonHeight

•	StdCaptionHeight


StdCaptionHeight Property

See Also	Applies To	Example

Description

Determines if the FormFX control should use the Windows standard height for the caption area of the form.

Syntax

object  .StdCaptionHeight [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the form will have a custom or standard caption height, as described in Settings.

Settings

Setting	Description

True	The caption height will be the Windows standard height.  The CaptionHeight property is ignored when this property is set to True.

False	(Default)  The control will base the caption height on the setting of the CaptionHeight property.


Strikethrough Property

See Also	Applies To	Example

Description

Returns or sets the font style of the specified Font object to either strikethrough or non-strikethrough.

Syntax

object  .Strikethrough [= boolean  ]

The Strikethrough property syntax has these parts:

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on strikethrough formatting.

False	Turns off strikethrough formatting.

Remarks

The Font object is not directly available at design time.  Instead you set the Strikethrough property through a control's Font property.

At run time, however, you can set Strikethrough directly by specifying its setting for the appropriate Font object.

In Visual Basic 3.0 you set the Strikethrough property by selecting a control's ActivePageFontStrikethru, ActiveTabFontStrikethru or FontStrikethru property in the Visual Basic Properties window.


System Requirements

System Requirements

•	Microsoft Windows version 3.1 or higher.

•	Microsoft Visual Basic version 3.0 or higher, (See hardware and system requirements for installing Visual Basic in the Visual Basic Programmer's Guide, Chapter 1 - ‘Setting Up.’) or any development environment that supports either Level 3 VBX controls or 16-bit or 32-bit OCX controls.

•	At least 5 megabytes of available space on your hard disk.


Tab Object

See Also	Applies To

Description

Similar to a notebook with tab dividers, a Tab object is a container object which can contain any number of Page objects.

Properties

BackColor	PageEarmarkPos	PageTabsPerRow
Bookmark	PageFont3D	PageWordWrap
Caption	PageNavigation	Picture
Enabled	Pages3D	PictureMetaHeight
ForeColor	PageStyle	PictureMetaWidth
PageAlignmentCaption	PageTabEarmark	Tab
PageAlignmentPicture	PageTabHeight	Visible
PageCaptionRotation	PageTabOrientation
Collections

Pages

Remarks

•	When using the VBX version of the control, this object must be accessed via the X object. See Compatibility Issues  for more information.


Tab Property

See Also	Applies To	Example

Description

Returns or sets the active tab.

Syntax

object  .Tab [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the active tab.

Remarks

If you set this property, the control will change to display the tab specified by number.  This value is zero-based.


TabBackColorDefault Property

See Also	Applies To	Example

Description

Returns or sets the default background color for all non-active tabs in the control

Syntax

object  .TabBackColorDefault [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the background color of a non-active tab.

Remarks

The color of the active tab is determined by the ActiveTabBackColor property. This property can be overridden by setting the BackColor property for individual tabs.


TabBookmark Property

See Also	Applies To	Example

Description

Returns or sets the bookmark property of a recordset to which the control is bound.

Syntax

object  .TabBookmark [= variant  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

variant	A variant expression specifying a bookmark in the recordset to which the control is bound.

Remarks

When a tab or Notebook control is in data bound mode (values have been specified for the DataSource and DataField properties) this property can be used to retrieve a bookmark which uniquely identifies the current record, based on the value of the active tab's caption. This property can be saved to a variable and later used to return to a specific point in the recordset.

This property functions identically to the Bookmark property of the Visual Basic data control.

This property is available only when the control is in data bound mode. If the control is not in bound mode, this property returns Null.

•	When using the VBX version of the control, this object must be accessed via the X object. See Compatibility Issues  for more information.


TabCaption Property

See "Caption Property"


TabCaptionRotation Property

See Also	Applies To

Description

Specifies the amount that the text is rotated in the tab captions.

Syntax

object  .TabCaptionRotation [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the text rotation, as described in Settings.

Settings

Setting	Description

0	(Default) 0 degrees

1	90 degrees

2	180 degrees

3	270 degrees

Remarks

The text can be rotated in 90-degree increments. The rotation of the text is determined relative to the tab or page orientation, not the screen.

You must specify a TrueType font for the caption if you want to use this property. Non-TrueType fonts cannot be rotated.


TabCount Property

See Also	Applies To	Example

Description

Returns or sets the total number of tabs in the Tabs collection of a control.

Syntax

object  .TabCount [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of tabs in the control.

Remarks

At design time, you can use this property to alter the number of tabs in the control. The value of this property is identical to the value of the Count property of the Tabs collection.


TabCutSize Property

See Also	Applies To

Description

Returns or sets the size of the tab corners.

Syntax

object  .TabCutSize [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the size of the tab corners.

Remarks

This setting has different effects depending on the setting of TabShape. If TabShape is set to '2 - Square' this setting has no effect. Otherwise, TabCutSize determines the degree of slanting or rounding of the tab corners.


TabEnabled Property

See "Enabled Property"


TabForeColorDefault Property

See Also	Applies To	Example

Description

Returns or sets the default foreground color for all non-active tabs in the control

Syntax

object  .TabForeColorDefault [= color  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

color	A long integer value or constant that determines the foreground color of the tab.

Remarks

The color of the active tab is determined by the ActiveTabForeColor property. This property can be overridden by setting the ForeColor property for individual tabs.


TabGutterMargin Property

See Also	Applies To

Description

Returns or sets the distance between the tab's inside edge and the notebook ring hole.

Syntax

object  .TabGutterMargin [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the distance between the ring hole and the edge of the tab.

Remarks

For  this property to be active, the RingHolesVisible property must be set to True.

The units specified are based on the scale mode of the form.  The valid setting for this property is 0 or greater.


TabHeight Property

See Also	Applies To

Description

Returns or sets the height of each tab.

Syntax

object  .TabHeight [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the height of the tabs.

Remarks

This property is based on the scale mode of the container.


TabLeftMargin Property

See Also	Applies To

Description

Returns or sets the space between the left side of the control and the first tab.

Syntax

object  .TabLeftMargin [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the distance between the edge of the control and the tab.

Remarks

In the Notebook control, this property also affects the offset of the tabs from the spine and rings.

This property is based on the scale mode of the container.  The setting must be greater than or equal to 0.


TabMaxRows Property

See Also	Applies To

Description

Returns or sets the maximum number of rows of tabs.

Syntax

object  .TabMaxRows [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the maximum number of rows that will be displayed by the control.

Remarks

If the value of this property is set to zero, the number of rows is limited only by the amount of available memory.


TabMaxWidth Property

Applies To	See Also

Description

Returns or sets the maximum width of each tab.

Syntax

object  .TabMaxWidth [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the maximum width of each tab.

Remarks

If this property is set to zero, the control will automatically size the tabs to evenly fit across the control. This property is based on the scale mode of its container.


TabOrientation Property (Index Tab control)

See Also	Applies To

Description

Returns or sets the orientation of the tab captions.

Syntax

object  .TabOrientation [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the orientation of the tabs, as described in Settings.

Settings

Setting	Description

0	(Default) Top of the control.

1	Bottom of the control.

2	Left side of the control

3	Right side of the control


TabOrientation Property (Notebook control)

See Also	Applies To

Description

Returns or sets the orientation of the tab captions.

Syntax

object  .TabOrientation [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the orientation of the tabs, as described in Settings.

Settings

Setting	Description

0	(Default) Outside - Tab captions will be displayed opposite the spine.

1	Top or Right - Tab captions will be at the top or on the right side of the tabs, depending on NotebookOrientation.

2	Bottom or Left - Tab captions will be at the bottom or on the left side of the tabs, depending on NotebookOrientation.

Remarks

If the Notebook control is in portrait mode (NotebookOrientation is 0 or 1) tab captions will be displayed on the left or the right side, according to the value of TabOrientation. If the notebook is in landscape mode, (NotebookOrientation is 2 or 3) tab captions will be displayed on the top or bottom.


TabPicture Property

See "Picture Property"


TabPictureMetaHeight, TabPictureMetaWidth Properties

See "PictureMetaHeight, PictureMetaWidth Properties"


TabRightMargin Property

See Also	Applies To

Description

Returns or sets the space between the last tab and the right side of the control.

Syntax

object  .TabRightMargin [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the distance between the edge of the tab and the edge of the control.

Remarks

In the Notebook control, this property also affects the offset of the tabs from the spine and rings.

This property is based on the scale mode of the container.


TabRowOffset Property

See Also	Applies To

Description

Returns or sets the offset that each row of tabs will be indented.

Syntax

object  .TabRowOffset [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the indentation between rows of tabs.

Remarks

If the control is displaying two or more rows of tabs, this property will determine the offset from one row to the next.  The first row of tabs is always aligned to the left of the front tab or index card.  The next row will start at this offset, and all remaining rows will continue to be indented increasingly by this value.

The units specified are based on the scale mode of the form.


TabScrollType Property

See Also	Applies To

Description

Returns or sets the state of the tab scrolling buttons.

Syntax

object  .TabScrollType [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying when tab scroll buttons will be displayed, as described in Settings.

Settings

Setting	Description

0	(Default) None

1	Scroll buttons visible if needed

2	Scroll buttons always visible

Remarks

There are times when you may want to give the user an alternative to clicking on tab captions as the primary means of navigation. For example, you may need to specify more tabs than can fit on the screen at once. You might want to restrict the control to a single row, but have several row's worth of tabs. Or, if you use the DataSource and DataField properties to bind the tab captions to a database, you will need to provide a way for the user to move to records beyond the ones showing on screen.

The Index Tab control provides tab scrolling buttons for these types of situations. Using the TabScrollType property, you can determine if this interface is available to the user. The default setting of 0 disables the use of scroll buttons. Setting this property to 1 will display the scroll buttons only as needed, if there are more tabs than will fit in the rows specified or if the control is in data-bound mode. A setting of 2 will enable full-time display of the scrolling interface.

When the control is in data bound mode, the scrolling interface provides a method for the user to navigate through the database without any additional coding or controls. In this case, the control will first scroll until it reaches the end of the tabs, as determined by the TabCount property, then begin to fetch data from the recordset specified by the DataSource property.


TabSelectType Property

Applies To

Description

Restricts the rows of tabs (if more than one) from scrolling to the front row when selected.

Syntax

object  .TabSelectType [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying how to manage the caption of the active tab, as described in Settings.

Settings

Setting	Description

True	The tab's caption remains in its place when it becomes the active tab.

False	(Default) the control moves the selected tab and all other tabs on its row to the front row, cycling all tab rows so that their relative order remains the same.

Remarks

Whatever the value of this setting, when a tab becomes active all the controls placed on that tab will appear.


TabShape Property

See Also	Applies To

Description

Returns or sets the shape of the tab.

Syntax

object  .TabShape [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the style of the tab, as described in Settings.

Settings

Setting	Description

0	(Default) Chamfered

1	Rounded

2	Square

3	Curved

4	Slanted

5	Arced in

6	Win95 Property Page

7	S-Curve


TabSpacing Property

See Also	Applies To

Description

Returns or sets the spacing (in pixels) between each tab.

Syntax

object  .TabSpacing [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the distance between tabs.

Remarks

The units specified (pixels) can also be set to a negative value to specify a tab overlap.


TabStart Property

Applies To

Description

Specifies which tab will be the active tab when the control loads.

Syntax

object  .TabStart [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of the default active tab.

Remarks

If this property is set to -1, then the tab that is selected when the form is saved at design time will be the initial active tab. If set to any other number, then the tab with that number will be the initial active tab.  Tab numbers are zero-based and can range from 0 to Tabs.Count - 1.

This property is only available at design time.


TabTopOffset Property

See Also	Applies To

Description

Returns or sets the distance that each row of tabs will be offset vertically (or horizontally) from the others.

Syntax

object  .TabTopOffset [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	A single-precision expression specifying the vertical or horizontal offset between rows of tabs.

Remarks

If the control is displaying two or more rows of tabs, this property will determine the offset between the rows of tabs. This effectively determines how much of a row is visible behind the row in front of it. Specify a greater value to see more of the tab caption area in rows following the first. A lesser value covers more of the tab captions.

Whether this property offsets horizontally or vertically will depend on the orientation of the control, as specified by TabOrientation or NotebookOrientation. If the tabs are on the top and/or bottom of the control, the offset is vertical. If the tabs are on the left and/or right sides, the offset is horizontal.

Setting the value of this property to -1 causes the control to automatically adjust the offset based on the value specified in TabHeight.

The units specified are based on the scale mode of the form.


TabVariableSize Property

See Also	Applies To

Description

Determines whether or not the caption area of the tabs will automatically size to fit the caption text.

Syntax

object  .TabVariableSize [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the tab will size the caption area to fit the caption text, as described in Settings.

Settings

Setting	Description

True	The individual tab will automatically adjust the size of the caption area to accommodate its caption text.

False	(Default) The size of the caption area is fixed for all tabs.

Remarks

If this property is set to True, the value specified in TabMaxWidth is ignored.


TabVisible Property

This property has been superseded by the standard Visible property as applied to the Tab object. See "Tab Object" and Important Information for Users of Version 1.0  for more information.


TabVisibleFirst Property

See Also	Applies To

Description

Returns or sets the index number of the first visible tab.

Syntax

object  .TabVisibleFirst [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the index number of the tab which has the lowest index number among the visible tabs.

Remarks

This property refers to the tab that is designated as the first visible tab. If the control is using the default orientation, this will be the leftmost visible tab in the first visible row. If the orientation is different, it will be the tab that functionally occupies the same position.

The range of valid values for this property is 0  to TabCount - 1.


TabVisibleLast Property

See Also	Applies To

Description

Returns or sets the number of the right-most visible tab.

Syntax

object  .TabVisibleLast [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the tab which will be aligned farthest to the right.

Remarks

This property refers to the tab that is designated as the last visible tab. If the control is using the default orientation, this will be the rightmost visible tab in the last visible row. If the orientation is different, it will be the tab that functionally occupies the same position

If you change the value of this property, the control will scroll to align the tab with the specified value farthest to the right. This may affect the value of the TabVisibleFirst property.

The range of valid values for this property is 0  to TabCount - 1.


Tabs Collection

See Also	Applies To

Description

A Tabs collection is a collection of all the Tab objects associated with a particular Index Tab or Notebook control. A Tab object can in turn contain Page objects.  (Similar to a notebook with tab dividers and pages within the tabs.)

Properties

Count

Item

Methods

Insert

Remove

Remarks

•	When using the VBX version of the control, this object must be accssed via the X object. See Compatibility Issues  for more information.


Tabs3D Property

See Also	Applies To

Description

Returns or sets the 3-D display mode for the tabs.

Syntax

object  .Tabs3D [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the 3-D appearance of the tabs, as described in Settings.

Settings

Setting	Description

True	(Default) Tabs will be displayed in 3-D (beveled.)

False	Tabs will not have a 3-D appearance.

Remarks

When this property is set to True, the background colors of the tab are determined by the bevel color properties: BevelColorFace, BevelColorShadow, and BevelColorHighlight. Otherwise, the color specified by TabBackColorDefault or BackColor is used for the background.


TabsPerRow Property

See Also	Applies To	Example

Description

Returns or sets the number of tabs in each row.

Syntax

object  .TabsPerRow [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of tabs per row.

Remarks

You can use this property in conjunction with the Count property to determine the number of rows the control will display.


Technical Specifications

All of the following information is subject to change. Please check the README.TXT file for any updates.

	System Requirements A list of requirements for using Designer Widgets
	Included Files A list of files included with Designer Widgets and their locations
	Distribution Notes A list of the files you need to distribute with your applications


Technical Support

CompuServe

You can obtain technical support on CompuServe by contacting the SYSOP at the SHERIDAN section of the COMPA forum.  You can type GO SHERIDAN at any CompuServe prompt.

Internet

You can send electronic mail to technical support via the Internet. Messages should be addressed to support.designer@shersoft.com

For up-to-the-minute Designer Widgets information and the latest updates, as well as general information about Sheridan Software Systems Inc. and our products, visit our home page on the World Wide Web. The address is http://www.shersoft.com

FAX

To fax questions or comments regarding any Sheridan product, dial (516) 753-3661.

Telephone Support

For technical support for this or any other Sheridan product, contact Sheridan Software systems at (516) 753-0985.  You can either speak to a live technical support representative or get answers using the Automated Fax Service.


Template Object

Applies To

Description

A Template object is a special container object within the control. Objects placed on a template do not appear until the template is associated with a Page object. Objects placed on a template will appear on any pages that have been associated with the template. A page is associated with a template by setting the TemplateName property of the page to the name of a template, or by using the Template Manager.

Properties

Item

Name

Methods

AddControl

RemoveControl

Remarks

•	When using the VBX version of the control, this object must be accessed via the X object. See Compatibility Issues  for more information.


TemplateName Property

See Also	Applies To	Example

Description

Returns or sets the ID string of the control template associated with the page.

Syntax

object  .TemplateName [= text  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	An string expression evaluating to the unique ID tag of a control template.

Remarks

This value specifies the ID of the control template that will be used with the active page. A blank setting means that no template will be used for the current page.

Controls placed on a template appear on any page that is associated with that template.

This property is only available at run time. It can be set at design time using the Template Manager.


Templates Collection

See Also	Applies To

Description

A Templates collection is a collection of Template objects.

Properties

Count

Item

Methods

Insert

Remove

Remarks

•	When using the VBX version of the control, this object must be accessed via the X object. See Compatibility Issues  for more information.


The ToolsetTools Collection
ToolsetTools Collection

A ToolsetTools collection is a collection of related tools. Each tool can represent a specific user-defined function. A Toolset determines how many buttons are available for you to use on a single toolbar; your toolbar may contain all of the buttons from a Toolset or just some of them. Toolsets are easily defined and maintained using the integrated Toolbar Designer.

To create a toolbar, you first supply a bitmap that contains an image for each state of every tool in the toolset. The possible states are:

1.	Up (required)

2.	Down (required)

3.	Up disabled (optional, but required if 'Down disabled' is present.)

4.	Down disabled (optional)

The following bitmap contains images for all four states of eight tools:

The best method for creating or modifying Toolset bitmaps is to use the Toolset Bitmap Editor that is included with Designer Widgets. This is a powerful tool for designing your own original Toolset bitmaps or modeling your toolbars after those of other applications. It automatically handles details such as the formatting and spacing of buttons, the addition of bevels and the generation of button states.

When creating the bitmap, you need to be aware of the following:

•	The size of the image for each state of every tool in the toolset must be the same.

•	You must supply at least the 'up' and 'down states' (the 'up disabled' and 'down disabled' states are optional).

•	The NumBtnStates property allows you to specify which button states are to be supplied. A value of 2 means that only the 'up' and 'down' states are included. A value of 3 means that the 'up disabled' state is also included, while a value of 4 means that all four states are included (as in the sample bitmap above).

•	The Count property specifies how many tools are in the set. This would be set to eight for the above sample bitmap.

•	BtnWidth and BtnHeight properties are automatically calculated and set by the control based on the size of the bitmap and the NumBtnStates and Count property settings.

At design time, the Toolbar Designer automatically specifies the Name, NumBtnStates, Count and Picture properties of the ToolsetTools collection based on the bitmap used for the toolset and the information you supply. You can also access these properties at run time through code.

At run time, you can access the properties of individual tools in the toolset via the following properties of the ToolsetTool object.

•	ID - A unique ID (maximum 16 characters) that the developer can use internally to identify the tool.

•	Help - The text that will appear in the toolbar's balloon help for the tool.

•	Desc - An expanded description of the tool which might be used in a status bar.

•	Type - The tool type: push button (0) or toggle button (1.)

•	Group - This setting affects both visual and functional aspects of the tools. Adjacent tools with the same group number are separated from each other based on the BtnSpacing property. Adjacent tools with different group numbers are separated from each other based on the BtnGroupSpacing property. The group number also determines how toggle-type tools operate based on their Exclusive and AllowAllUp property settings.

•	Exclusive - True or False. If set to True, all tools with the same Group number as this tool will operate exclusively, with only one tool in the group at a time allowed to be pushed down. This applies only to tools with Type set to '1 - Toggle.'

•	AllowAllUp - True or False. If set to True, allows all tools in an exclusive group to be toggled up. This applies only to tools with the Type set to '1 - Toggle' and Exclusive set to True.

•	Mnemonic - A keyboard accelerator or shortcut character, such as ALT-A (optional).

Note that these properties supersede the Toolset-specific properties used in the previous version of Designer Widgets. See Important Information for Users of Version 1.0   for more information on using the new collection based properties as opposed to the old array-based properties.

The indexes for these property arrays are zero-based and correspond to each tool in the toolset. For example, in the sample bitmap above, zero represents the [image] tool, one represents the [image] tool and so on.

All of these settings are actually stored in a bitmap information file that has the same name as the bitmap, but with a BM$ extension. For example, if the bitmap is named toolset1.bmp, the above settings would be saved in the same directory in a file named toolset1.bm$.

The advantage to storing these settings in a parallel file with the bitmap is that you don't need to redefine these parameters for every form and/or project that uses the same toolset. In effect, they can be viewed as reusable objects.

Once you have created a toolset and assigned it to a toolbar, the Toolbar Designer provides an easy drag and drop interface for arranging tools on the toolbar. Simply drag a tool from the toolset and drop it on the toolbar at the appropriate spot. An instance of a tool on the toolbar is referred to as a button.

For each button, the Toolbar Designer allows you to specify whether, at run time, the button is initially enabled, visible, up/down, or assigned as a placeholder. These settings can also be controlled via the following run-time properties:

•	ToolNum - identifies which tool this button represents. It is the zero-based index of the tool in the toolset (described above).

•	Visible

•	Enabled

•	Value - Determines the state of the button (up is False, down is True).

•	Placeholder - True or False, determines if the button is to be used as a placeholder for a child control. A placeholder button is necessary when the toolbar's orientation is changed from horizontal to vertical. Child controls are displayed only on a horizontal or floating toolbar.

•	PlaceholderWidth - sets the width of the area assigned to the placeholder button. This is the width of the area which will be occupied by the child control when the toolbar is horizontal. If the child control is narrower than PlaceholderWidth, it will be centered within the placeholder area.


ToolNum Property

See Also	Applies To	Example

Description

Returns or sets the tool index (within the toolbar's toolset) that is associated with the button.

Syntax

object  .ToolNum [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the index of the specified tool.

Remarks

This property is set automatically when a toolbar is defined using the Toolbar Designer.  However, you can set this property at run time to a valid tool number of a tool in the current toolset.

This property supersedes the BtnToolNum property from the previous version. It is functionally identical to that property, except that it applies to the Button object and not the control itself.

This property is initialized to -1. If this property is not defined for a button, the following bitmap is displayed instead:

This property is only available at run time.


Toolbar Child Control Considerations
Considerations - Child Controls on Toolbars

When adding a child control to the Dockable Toolbar, you should be aware of the following considerations:

Limitations on Child Controls

Due to a limitation in the way Visual Basic handles child controls, some controls cannot be placed directly on a toolbar. These include the combo box and any custom controls (VBX or OCX.) Note that the 3-D Panel and other 3-D controls are custom controls supplied by the THREED.VBX file and cannot be placed directly on the toolbar.

If you wish to place a combo box or a custom control on a toolbar, you must first create a container using the Picture control. You can then place the combo box or custom control inside of this container. After that, the control should operate normally.

Placeholders and Placeholder Buttons

A placeholder button is always assigned to a toolbar child control. The placeholder button substitutes for the child control when the toolbar is oriented vertically (docked along the left or right side.) You also use the placeholder to set Toolset properties for the child control, such as Desc and Help, and to assign the control to a group.

The placeholder is used by the Toolbar Designer to reserve space on the toolbar for the child control. When you check the 'Placeholder' check box and supply a value for 'Width' in the Toolbar Designer, you are setting aside space in which to create the child control. This is the same as specifying True for the value of Placeholder and supplying a value to the PlaceholderWidth property of the button. Balloon help for the control will be displayed if the cursor is positioned anywhere within the space specified, regardless of the actual size of the control.

Mouse Events

When the toolbar is oriented vertically, the child control does not appear, and the placeholder button receives and processes the normal Click event for a button. You may wish to include code in this event that provides access to the function of your child control, perhaps through a dialogue box. When the toolbar is horizontal, the child control appears and will receive and process any mouse events. The placeholder button does not appear and will not receive the Click event. Note that the Help event is a function of the toolbar itself, and will occur whether or not the child control is visible.

Floating Toolbar

If a toolbar is floating, child controls remain in their assigned groups when the toolbar is resized. The toolbar cannot be resized narrower than the value of PlaceholderWidth.

Procedure


Toolbar Child Controls Procedure
Procedure - Child Controls on Toolbars

The following items outline a general procedure to add a child control to the Dockable Toolbar:

1.	Start by adding a toolbar to a standard or MDI form, using the regular procedure.

2.	Create or select a toolset, using the Toolbar Designer.

3.	After adding the desired tools to the toolbar, select a particular button that you want to represent a child control and designate it as a placeholder. This is done by clicking on the button and then selecting the 'Placeholder' check box.

4.	The placeholder can then be sized to the size of the child control you are adding. This is done either by entering a value in the 'Width' box, or by simply dragging the handle of the placeholder to the desired width. When you are finished, press the 'OK' button to exit the Toolbar Designer window. The toolbar should be on the form with the tools you selected, and a blank space of the size you specified for the placeholder.

5.	If you are placing a combo box or a custom control as the child control, choose the [image] tool from the Visual Basic toolbox and draw a Picture control on the toolbar that occupies all the available placeholder space. Set the BorderStyle property of the Picture control to '0 - None.'

6.	Select the control you want to add and draw it on top of the placeholder area. (If using a combo box or custom control, this will be on top of the Picture control.) The added control doesn't have to exactly fill the placeholder area, but it must be contained within it.

7.	Now you can save the project, and then run it. Try positioning the mouse over the child control to see how balloon help works. If you have placed the toolbar on an MDI form, you can also try docking it to different areas to see the effect of the placeholder button.


Toolbar3D Property

See Also	Applies To

Description

Determines whether or not the toolbar will be 3-D.

Syntax

object  .Toolbar3D [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the 3-D appearance of the toolbar, as described in Settings.

Settings

Setting	Description

True	The toolbar will be displayed in 3-D.

False	(Default) The toolbar will not be 3-D.


ToolbarClosed Event

Applies To	Example

Description

Occurs when the user closes the floating toolbar by clicking on the control box.

Syntax

Sub control_ToolbarClosed ([Index As Integer])

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

Remarks

When the user closes a floating toolbar, the Visible property of the toolbar is set to False.  This event will occur after the user closes the toolbar.


ToolbarFloating Property

See Also	Applies To

Description

Toggles a toolbar between floating and stationary at run time.

Syntax

object  .ToolbarFloating [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the floating status of the toolbar, as described in Settings.

Setting	Description

True	The toolbar will float in its own window.

False	(Default) The toolbar will remain stationary on the form.

Remarks

The primary purpose of the ToolbarFloating property is to float toolbars placed on a standard, non-MDI form. However, this propery will also work with toolbars on an MDI form.


ToolbarOrientation Property

Applies To

Description

Determines the orientation of the toolbar when it is on a standard (non-MDI) form.

Syntax

object  .ToolbarOrientation [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the orientation of the toolbar when aligned, as described in Settings.

Settings

Setting	Description

0	(Default) Horizontal - Toolbar will be oriented horizontally.

1	Vertical - Toolbar will be oriented vertically.

Remarks

The settings of this property will only take effect when the Align property of the Toolbar is set to '0 - None.'  Because that setting is not available on an MDI form, this property is only valid on a non-MDI form.


ToolbarResized Event

Applies To

Description

Occurs when the floating toolbar has been resized at run time by the user.

Syntax

Sub control_ToolbarResized ([Index As Integer])

The event parameters are:

Parameter	Description

Index	An integer expression that uniquely identifies a control if it is in a control array.

Remarks

A toolbar can only be resized at run time if the FloatingSizable property is set to True.


Toolbars and Buttons

A toolbar is a single control that contains a collection of one or more tools. Each tool performs a specific function and is represented by a Button object.

There are two types of Button objects:

•	Push buttons - perform a specific function and then return to the up state. An example of this type of button would be a button that invokes a print function.

•	Toggle buttons - remain either in the up or down state. An example of this type of button would be a button that selects or deselects boldface text.

These buttons can also be logically grouped together. A toolbar can contain multiple groups, each consisting of one or more buttons. However, since the toolbar is actually a single control utilizing a single bitmap, the impact on system resources is greatly minimized.

In addition, toggle buttons in a group can operate independently or exclusively (with only one button in the group down at a time). For example, a group of three buttons might set an alignment option (left, center or right). Only one of these buttons could be selected (in the down state) at one time. If the 'left' button is down, pressing the 'center' button would cause the 'left' button to come up.

Buttons may also be assigned as placeholders for child controls located on the toolbar. Buttons acting as placeholders appear only when the toolbar is oriented vertically (fixed along the left or right side of the form or container.) When the toolbar is horizontal or floating, the child control itself will appear.

Every toolbar is linked to a ToolsetTools collection via the ToolsetPicture property. Buttons for the toolbar are selected from the available tools in the toolset. Toolsets and toolbars are created and maintained using the Toolbar Designer and the Toolset Bitmap Editor.


ToolsetName Property

See Also	Applies To

Description

Sets or returns a descriptive name string for the toolset

Syntax

object  .ToolsetName [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

text	A string expression that evaluates to the name of the toolset.

Remarks

This property could be used in any situation where you would want to refer to a toolset by name. For example, if you provide the user with a means to customize the toolbar, you could use ToolsetName to present the user with a list of toolsets.

This property is identical to the Name property of the ToolsetTools collection.

This property is only available at run time, however it can be initially set at design time using the Toolbar Designer.


ToolsetNumBtnStates Property

See Also	Applies To

Description

Returns or sets the number of button states included in the ToolsetPicture property.

Syntax

object  .ToolsetNumBtnStates [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression with a value ranging from two to four that specifies the number of button states available on the toolbar.

Remarks

A value of two means that only the 'up' and 'down' states are included. Three means that the 'up disabled' state is also included, while a value of four means that all four states are included.

This property is identical to the NumBtnStates property, except that it applies at the control level instead of the collection level.

This property is only available at run time, however it can be initially set at design time using the Toolbar Designer.


ToolsetNumTools Property

See Also	Applies To

Description

Sets or returns the number of tools available in the ToolsetTools collection of the control.

Syntax

object  .ToolsetNumTools [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the number of tools available, based on the bitmap specified by ToolsetPicture.

Remarks

This property determines the number of columns of button images defined in the toolset bitmap. This property is functionally identical to the Count property of the ToolsetTools collection.

This property is only available at run time. It is indirectly available at design time through the Toolbar Designer.


ToolsetPicture Property

See Also	Applies To	Example

Description

Specifies the bitmap to use for the ToolsetTools collection.

Syntax

object  .ToolsetPicture [= picture  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

picture	A string expression specifying a file containing a graphic, as described in Settings.

Settings

Setting	Description

(None)	(Default) No picture.

(Bitmap)	Specifies a graphic. You can load the graphic from the properties window at design time. At run time, you can set this property using the LoadPicture function on a bitmap.

Remarks

ToolsetTools is a collection of related tools.  Each tool represents a specific user function.  The bitmap must contain an image for at least the 'up' and 'down' state of every tool in the toolset.  The possible states are:

1.	Up (required)

2.	Down (required)

3.	Up disabled (optional)

4.	Down disabled (optional)

Note	The bitmap can be created or modified with the Toolset Bitmap Editor.

When creating the bitmap, you need to be aware of the following:

•	The size of the image for each state of each tool in the toolset must be the same.

•	You must supply at least the 'up' and 'down' states (the 'up disabled' and 'down disabled' states are optional).

•	The NumBtnStates property lets you specify which button states are supplied.  A value of two means that only the 'up' and 'down' states are included.  Three means that the 'up disabled' state is also included, while a value of four means that all four states are included (as in the sample bitmap above).

•	The Count property specifies how many tools are in the set.  This would be set to 8 for the above sample bitmap.

•	Width and Height properties are automatically calculated based on the NumBtnStates and Count property settings and the size of the bitmap.

This property is only available at run time.


ToolsetTool Object

See Also	Applies To

Description

A ToolsetTool object represents a specific tool that can be placed on the toolbar.  All of the tools (ToolsetTool objects) associated with a specific Toolbar control are collectively referred to as the ToolsetTools collection.

Properties

AllowAllUp	Mnemonic
Desc	PictureDn
Exclusive	PictureDnDis
Group	PictureUp
Help	PictureUpDis
ID	Type
Remarks

•	When using the VBX version of the control, this object must be accessed via the X object. See Compatibility Issues  for more information.


ToolsetToolAllowAllUp Property

See "AllowAllUp Property"


ToolsetToolDesc Property

See "Desc Property"


ToolsetToolExclusive Property

See "Exclusive Property"


ToolsetToolGroup Property

See "Group Property"


ToolsetToolHelp Property

See "Help Property"


ToolsetToolID Property

See "ID Property"


ToolsetToolMnemonic Property

See "Mnemonic Property"


ToolsetToolPicDn, ToolsetToolPicUp  Property

See "PictureDn, PictureUp Properties"


ToolsetToolPicDnDis , ToolsetToolPicUpDis  Property

See "PictureDnDis, PictureUpDis Properties"


ToolsetTools Collection

See Also	Applies To

Description

A ToolsetTools collection is a collection of related tools (ToolsetTool objects).  Each tool represents a specific user function.  Toolsets are defined and maintained in the Toolbar Designer.

Properties

Count

Name

Picture

Item

NumBtnStates

Remarks

•	When using the VBX version of the control, this object must be accessed via the X object. See Compatibility Issues  for more information.


TransparentBack Property

See Also	Applies To

Description

Determines whether the background area of the control will be visible.

Syntax

object  .TransparentBack [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the visiblity of the background area, as described in Settings.

Setting	Description

True	The background area of the control will not be visible.

False	(Default) The background area of the control will be visible.

Remarks

This property affects the area behind the cover of the Notebook control or behind the tabs in the Index Tab control. When visible, the color of the area is determined by the BackColor property of the control itself.

This property is available only at design time. When this property is changed, you may need to close and re-open the form containing the control before the changes will take effect.


Type Property (ToolsetTool object)

See Also	Applies To

Description

Returns or sets the type of each tool; either a Push button or a Toggle button.

Syntax

object  .Type [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the type of a tool button, as described in Settings.

Settings

Setting	Description

0	(Default) Push.  A button associated with this tool will depress and automatically return to the 'up' position when clicked.

1	Toggle.  A button associated with this tool will toggle between 'up' and 'down' states when clicked.

Remarks

This property is only available at run time.  However, it can be initially set at design time using the Toolbar Designer.


Underline Property

See Also	Applies To	Example

Description

Returns or sets the font style of the specified Font object to either underlined or non-underlined.

Syntax

object  .Underline [= boolean  ]

The Underline property syntax has these parts:

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A Boolean expression specifying the font style as described in Settings.

Settings

The settings for boolean are:

Setting	Description

True	(Default) Turns on underline formatting.

False	Turns off underline formatting.

Remarks

The Font object is not directly available at design time.  Instead you set the Underline property through a control's Font property.

At run time, however, you can set Underline directly by specifying its setting for the appropriate Font object.

In Visual Basic 3.0 you set the Underline property by selecting a control's ActivePageFontUnderline, ActiveTabFontUnderline or FontUnderline property in the Visual Basic Properties window.


UseSystemColors Property

See Also	Applies To

Description

Determines whether the toolbar wil be displayed using the Windows system colors or the specified Bevel colors.

Syntax

object  .UseSystemColors [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the how the colors of the toolbar will be determined, as described in Settings.

Settings

Setting	Description

True	The toolbar will use the colors specified by the Windows color settings.

False	(Default) The toolbar will use the colors specified by the BevelColorFace, BevelColorHighlight, BevelColorShadow and BevelColorOutline properties.

Remarks

To have the colors of the toolbar match the colors of other 3-D elements in Windows, set this property to True. To specify your own colors for the toolbar, set this property to False.


Using a Child Control on the Toolbar

A child control (such as a combo box) can be easily added to the Dockable Toolbar. You may also add multiple child controls to the same toolbar.

Considerations

Programming issues regarding the placement of child controls on a toolbar

Procedure

Overview of the steps required to place a child control on a toolbar


Using the Index Tab in Data Bound Mode

The tab captions of an Index Tab or Notebook control can be bound to a database field, giving you the power to transform the control into an intuitive database front end. If you are not familiar with bound controls and the related issues and terminology, please refer to 'Chapter 20 - Accessing Databases with the Data Control' in the Microsoft Visual Basic 3.0 Programmer's Guide.

Binding the control to a database changes it's behavior in several significant ways:

1.	Any tab captions you have created at design time are overridden by the bound data. If you bind the control at design time by setting the DataField property, the tab captions you have specified in the design environment will be lost. If you bind the control at run time through code, any tab captions set at design time will be preserved as the default values, but will be overwritten as soon as the binding occurs.

Note	The Caption property provides read-only access to the bound field data. This means that if you change a tab's caption property through code, the control will not automatically update the value in the database. To change the field value, you must update the database directly using normal data access methods (Edit and Update.) Changes will be reflected in the control when the update is completed.

2.	The number of tabs in the control, as specified by TabCount, does not change. The number of tabs simply represents the number of records that will be visible at one time via the control.

3.	The active tab of the control always determines the position of the record pointer in the recordset. If the recordset pointer is moved  by using the Data control or through code, the active tab of the control will change to reflect that movement.

4.	The Index Tab control can use its own scrolling interface to navigate through the recordset. This interface becomes active when the control is in data bound mode if the TabScrollType property is set to allow it. The scrolling interface first scrolls to the end of the available tabs, as specified by TabCount, then begins scrolling through the recordset, updating the tab captions with consecutive data.


Using the Notebook in Data Bound Mode

 The tab captions of an Index Tab or Notebook control can be bound to a database field, giving you the power to transform the control into an intuitive database front end. If you are not familiar with bound controls and the related issues and terminology, please refer to 'Chapter 20 - Accessing Databases with the Data Control' in the Microsoft Visual Basic 3.0 Programmer's Guide.

Binding the control to a database changes it's behavior in several significant ways:

1.	Any tab captions you have created at design time are overridden by the bound data. If you bind the control at design time by setting the DataField property, the tab captions you have specified in the design environment will be lost. If you bind the control at run time through code, any tab captions set at design time will be preserved as the default values, but will be overwritten as soon as the binding occurs.

Note	The Caption property provides read-only access to the bound field data. This means that if you change a tab's caption property through code, the control will not automatically update the value in the database. To change the field value, you must update the database directly using normal data access methods (Edit and Update.) Changes will be reflected in the control when the update is completed.

2.	The number of tabs in the control, as specified by TabCount, does not change. The number of tabs simply represents the number of records that will be visible at one time via the control.

3.	The active tab of the control always determines the position of the record pointer in the recordset. If the recordset pointer is moved  by using the Data control or through code, the active tab of the control will change to reflect that movement.

4.	When in bound mode the Notebook operates as though it contains the same number of tabs as there are records in the recordset. The value of TabCount is ignored, and the appearance of the tab is determined by the value of TabsPerRow.

For example, suppose you have a Notebook that displays two rows of three tabs on each side, and the Notebook is bound to a database with thirty records. As you flip tabs from right to left, the number of tabs visible on the right will not decrease until you reach the twenty-fifth record. After that, the tabs will flip from right to left just as they would in unbound mode. When you click on the tab for record thirty, all the tabs will have been flipped to the left side.


Using the Toolbar Designer

The Toolbar Designer is a design-time tool for creating and maintaining toolsets and assigning tools to a toolbar. The following is a brief demonstration of how the Toolbar Designer works.

Start a new Visual Basic project and add the Dockable Toolbar control file to your project. Next, place a toolbar control on a form, using the [image] tool in the Visual Basic toolbox. In the Visual Basic Property window, double click on the (Toolbar Designer) property, or if you are using the OCX version, right-click on the control and select Toolbar Designer from the pop-up menu. This will bring up the following dialog:

Press the button labeled 'Select Toolset...' (if there was already a toolset attached to the toolbar, this button would be labeled 'Change Toolset...'). This will bring up a File Open dialogue requesting the name of the bitmap file. If you haven't created your own bitmap, you can use TOOLSET1.BMP in the SAMPLES\CHAPTER9 directory provided with Designer Widgets.

After selecting a BMP file, if there is no parallel BM$ file, the 'Set Bitmap Information' dialogue will be displayed. (See the previous section for an explanation of the bitmap information file.)

This dialogue displays the bitmap, along with its width and height in pixels. From here, you must supply the following information:

•	Rows  - corresponds to the NumBtnStates property.

•	Columns  - corresponds to the Count property.

It is important that these numbers correspond exactly to the number of rows and columns in the bitmap. Otherwise, you will end up with some very strange looking tools.

Pressing the 'OK' button will bring you back to the Toolbar Designer main window. Now press the 'Edit Toolset' button. The Toolset Editor should look like this:

Select a tool by clicking on it in the toolset box. The selected tool will be shown with a rectangular outline around it. Here you can specify the Name of the toolset. You can also set several properties for each tool in the toolset.

For the selected tool you can specify the following:

•	Description - Corresponds to the Desc property. This can be used to display an expanded description of the button in a status bar when the cursor is over the tool (see also the Help, MouseEnter and MouseExit events.)

•	Balloon Help Text - Corresponds to the Help property. This text is displayed in a balloon help window when the cursor pauses over the tool at run time (see also the BalloonHelp and BalloonHelpDelay properties, and the Help event.)

•	ID - Corresponds to the ID property. This ID can be a maximum of 16 characters. It uniquely identifies the tool and is passed as the first parameter in the Click, Help, MouseEnter and MouseExit events.

•	Accelerator Key - Corresponds to the Mnemonic property. If the form containing the toolbar is the active window, holding the ALT key down and pressing this character will push or toggle the tool. Remember that if an MDI Child form is the active form, accelerator keys for toolbars on the main MDI form will not be active.

•	Group # - Corresponds to the Group property. This property allows you to logically group tools. Adjacent tools on a toolbar with the same group number will be separated based on the value of the BtnSpacing property. Adjacent tools with different group numbers will be separated based on the value of the BtnGroupSpacing property. Also, toggle-type tools within the same group can behave differently, based on the AllowAllUp and Exclusive settings.

•	Type - corresponds to the Type property (either push or toggle).

•	Exclusive - corresponds to the Exclusive property. If checked, will cause all of the toggle-type tools (with the same group number) to operate in mutually-exclusive mode. In other words, within the same group only one tool at a time can be in the toggled down position; pressing in one button automatically causes other buttons in the group to return to the up state.

•	Allow All Up - corresponds to the AllowAllUp property. If checked, will allow all toggle-type tools (with the same group number) to be in the up state at the same time. This setting only has meaning if Exclusive is also checked.

Note	Changing the Exclusive or AllowAllUp settings for one tool in a group will automatically cause these settings on all the other tools in the same group to be changed as well.

The 'Bitmap Info...' button will display the 'Set Bitmap Information' dialogue explained previously in this section.

Press 'OK' to save any changes, or press 'Cancel' to exit without saving changes.

The Toolbar Designer main window should now display the tools from the selected toolset, in a box labeled 'Available Tools.'

To add a tool to the toolbar, simply drag it from the 'Available Tools' box and drop it on the toolbar. To insert a tool between two other tools, drop it between them on the toolbar. To remove a tool, click on it in the toolbar (not in the 'Available Tools' box) and press the Delete key. A dialogue box will appear asking you to confirm the deletion.

Press 'Add All Tools' to add all of the tools in the toolset to the toolbar. This will overlay any tools that were already on the toolbar.

In addition, there are four check boxes labeled 'Button Properties'. They apply to the currently selected button. You select the currently selected button by clicking on it in the toolbar.

In the above example, the [image] tool is selected and the 'Initial Property Settings' are set so that when the toolbar is first displayed, the Boldface tool will be enabled and visible. It will be in the up, un-selected state (value = False) and will not be used as a placeholder.

These check boxes correspond to the Enabled, Visible, Value and Placeholder  properties respectively.

Note	Although the ToolNum property is not explicitly shown here, it is automatically set, based on the index of the tool that was dragged from the 'Available Tools' box.


Value Property

See Also	Applies To

Description

Determines whether the button is raised or depressed.

Syntax

object  .Value [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying the state of a button object, as described in Settings.

Settings

Setting	Description

True	The button is in a depressed state.

False	(Default) the button is in a raised state.

Remarks

This property supersedes the BtnValue property from the previous version. It is functionally identical to that property, except that it applies to the Button object and not the control itself.


Version 1 Info - Index Tabs
Important Information for Users of Version 1.0

Some of the properties of the Index Tab control, particularly those used in property arrays, have been superseded in this version of the control by object and collection properties. All the properties used by version 1.0 of the control will still work, and you should not need to modify any of your existing code when you upgrade. However, if you are writing new code you should use the new object and collection-based properties. This is the best way to ensure your code will be supported by the next release of Designer Widgets. For more information on objects and collections, see 'Appendix C - Compatibility Issues.'

This table lists the properties that have been superseded, and the properties that have replaced them:

Version 1 Property	Property Array?	New Property	Applies To
TabBackColor	YES	BackColor, TabBackColor Default	Tab object, IndexTab control
TabForeColor	YES	ForeColor, TabForeColor Default	Tab object, IndexTab control
TabCaption	YES	Caption	Tab object
TabEnabled	YES	Enabled	Tab object
TabHwnd *	YES	AddControl, RemoveControl methods	Tab object
TabPicture	YES	Picture	Tab object
TabPictureMetaHeight	YES	PictureMeta Height	Tab object
TabPictureMetaWidth	YES	PictureMeta Width	Tab object
TabVisible	YES	Visible	Tab object
* Because of changes to the control, individual tabs no longer have individual window handles. Window handles were necessary in the previous version for moving controls between tabs at run time. The new version of the control supports the easier-to-use object methods AddControl and RemoveControl to manage the placement of controls through code. TabHwnd now returns the window handle of the control itself. Refer to the AddControl and RemoveControl methods for more information.


Version 1 Info - Toolbar
Important Information for Users of Version 1.0

Some of the properties of the Dockable Toolbar control, particularly those used in property arrays, have been superseded in this version of the control by object and collection properties. All the properties used by version 1.0 of the control will still work, and you should not need to modify any of your existing code when you upgrade. However, if you are writing new code you should use the new object and collection-based properties. This is the best way to ensure your code will be supported by the next release of Designer Widgets.

This table lists the properties that have been superseded, and the properties that have replaced them:

Version 1 Property	Property Array?	New Property	Applies To
BtnToolNum	YES	ToolNum	Button object
BtnValue	YES	Value	Button object
BtnVisible	YES	Visible	Button object
ToolsetName	NO	Name	ToolsetTools collection
ToolsetNumBtnStates	NO	NumBtnStates	ToolsetTools collection
ToolsetNumTools	NO	Count	ToolsetTools collection
ToolsetPicture	NO	Picture	ToolsetTools collection
ToolsetToolAllowAllUp	YES	AllowAllUp	ToolsetTool object
ToolsetToolDesc	YES	Desc	ToolsetTool object
ToolsetToolExclusive	YES	Exclusive	ToolsetTool object
ToolsetToolGroup	YES	Group	ToolsetTool object
ToolsetToolHelp	YES	Help	ToolsetTool object
ToolsetToolID	YES	ID	ToolsetTool object
ToolsetToolMnemonic	YES	Mnemonic	ToolsetTool object
ToolsetToolPicDn	YES	PictureDn	ToolsetTool object
ToolsetToolPicDnDis	YES	PictureDnDis	ToolsetTool object
ToolsetToolPicUp	YES	PictureUp	ToolsetTool object
ToolsetToolPicUpDis	YES	PictureUpDis	ToolsetTool object


What's New in Designer Widgets 2
What's New In Designer Widgets 2.0?

Important for users of Version 1.0

What's New in the Dockable Toolbar control
Can now be used with more types of forms and controls.

What's New in the Index Tab control
Even more features for organizing and presenting information.

The New Notebook control
A completely new look for your applications.

What's New in the FormFX control
Custom buttons and a broader range of features.


What's New in Dockable Toolbar
What's New in the Dockable Toolbar

•	Toolbars can now contain child controls, such as combo boxes.

•	Toolbars can now be placed on MDI and non-MDI forms or containers.

•	Toolbars can now float when placed on non-MDI forms or containers.

•	Toolbar Orientation property for aligning the Toolbar to the left or right edge of a form or container.

•	Property Pages allow you to set run-time-only properties at design time.

•	Collection properties for Tools and Buttons.


What's New in FormFX

•	You can now place your own custom buttons on the left and right side of the caption area in addition to the standard caption buttons. Each button fires an event when clicked.

•	The FormFX control can now be placed on MDI parent or child forms. Properties relating to customizing the look of the caption area or borders will still not apply, but most other properties relating to controlling window behavior will now apply.

•	Property Pages allow you to set run-time-only properties at design time.


What's New in Index Tabs
What's New in the Index Tab

•	Tabs can now have multiple pages associated with them, providing better organization and increasing the space available for controls.

•	You can now bind the caption text of tabs to a database field.

•	You now have a range of styles for tab corners.

•	More means of navigation are provided for moving through the tabs/pages.

•	The number of tabs you can have is limited only by available memory.

•	‘Graphical’ controls (label, shape, line, or image) can be placed directly on a tab.

•	Control templates provide common controls across tabs while minimizing system resources.

•	You can set a negative value for spacing between tabs, to produce a tab-overlap effect.

•	You can specify custom spacing between rows of tabs.

•	Improved methods for managing controls on a tab at run time.

•	Property Pages allow you to set run-time-only properties at design time.

•	Collection properties for tabs and pages


WindowLook Property

Applies To

Description

This property specifies how the standard caption buttons will appear on a form. This property gives you the ability to choose between the Windows 3.X and the Windows 95 interface.

Syntax

object  .WindowLook [= number  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

number	An integer expression specifying the appearance of the form, as described in Settings.

Settings

Setting	Description

0	(Default) Automatic. The appearance of the form will be determined by the operating system on which it is running.

1	Windows 95. The form will have a Windows 95 appearance.

2	Windows 3.X. The form will have a Windows 3.1 or Windows NT 3.5 appearance.


WordWrap Property

See Also	Applies To

Description

Determines whether or not the caption text of the tabs can be wrapped.

Syntax

object  .WordWrap [= boolean  ]

Part	Description

object	An object expression that evaluates to an object or a control in the Applies To list.

boolean	A boolean expression specifying whether the tab will wrap the caption text to the next line, as described in Settings.

Settings

Setting	Description

True	The tab will wrap text that is too long to fit within the caption area.

False	(Default) The tab will truncate text that is too long to fit within the caption area.


Working With Index Tab Templates
Working With Templates

Templates  are used to simplify the task of placing the same controls on multiple tabs and pages. A template is an invisible page which holds child controls. The controls placed on a template can be made to appear on any page or tab in the control. This is known as applying the template. Templates make it easy for you to provide a consistent design for all of the pages or tabs in your control. Templates also conserve system resources by allowing you to re-use controls instead creating separate instances.

You can create or edit templates at design time using the Template Manager. Your control can have any number of templates, limited only by system memory. The Template Manager is available by clicking on the ellipsis (...) button of the (TemplateManager) property in the Visual Basic property sheet, or if you are using the OCX version, by right clicking on the control and selecting Template Manager from the pop-up menu. This invokes the Template Manager dialog, which looks like this:

Templates are identified by a descriptive name which you assign when creating the template. To assign a template to the current page or tab, you invoke the Template Manager, select a template name from the list, and choose 'Apply.' The dialog will close and the controls from the selected template will appear on the current page or tab. The name of the template you have selected will be available via the TemplateName property of the selected tab or page. You can only assign one template at a time to a page or tab.

If you choose the 'Create' button, a dialog will appear prompting you for the name of the new template. When this has been entered, the control will be placed in template editing mode, and you will be returned to it. While in template editing mode, the control will appear grayed. You can add or edit controls just as you normally would. When you are finished editing the template, click the right mouse button to exit. To assign the template to the active tab, you must go back into the Template Manager, choose the template from the list and click on 'Apply.'

Choosing the 'Modify' button returns you to the control in template editing mode with the controls from the selected template displayed. You can then add or delete controls, or modify the properties of existing controls. Right-clicking exits template editing mode.

Choosing 'Delete' will delete the template name from the list and remove the template. You will be prompted for confirmation before the delete actually occurs.


Working With Notebook Templates
Working With Templates

Templates  are used to simplify the task of placing the same controls on multiple tabs and pages. A template is an invisible page which holds child controls. The controls placed on a template can be made to appear on any page or tab in the control. This is known as applying the template. Templates make it easy for you to provide a consistent design for all of the pages or tabs in your control. Templates also conserve system resources by allowing you to re-use controls instead creating separate instances.

You can create or edit templates at design time using the Template Manager. Your control can have any number of templates, limited only by system memory. The Template Manager is available by clicking on the ellipsis (...) button of the (TemplateManager) property in the Visual Basic property sheet, or if you are using the OCX version, by right clicking on the control and selecting Template Manager from the pop-up menu. This invokes the Template Manager dialog, which looks like this:

Templates are identified by a descriptive name which you assign when creating the template. To assign a template to the current page or tab, you invoke the Template Manager, select a template name from the list, and choose 'Apply.' The dialog will close and the controls from the selected template will appear on the current page or tab. The name of the template you have selected will be available via the TemplateName property of the selected tab or page. You can only assign one template at a time to a page or tab.

If you choose the 'Create' button, a dialog will appear prompting you for the name of the new template. When this has been entered, the control will be placed in template editing mode, and you will be returned to it. While in template editing mode, the control will appear grayed. You can add or edit controls just as you normally would. When you are finished editing the template, click the right mouse button to exit. To assign the template to the active tab, you must go back into the Template Manager, choose the template from the list and click on 'Apply.'

Choosing the 'Modify' button returns you to the control in template editing mode with the controls from the selected template displayed. You can then add or delete controls, or modify the properties of existing controls. Right-clicking exits template editing mode.

Choosing 'Delete' will delete the template name from the list and remove the template. You will be prompted for confirmation before the delete actually occurs.


X Object
The X Object

A limitation of using VBX controls in Visual Basic 3.0 is that they do not support custom properties and methods that are applied to control - level objects. A control-level object is an object that can be directly accessed from the control. For example, the Tabs collection is a control-level object. Therefore, the following code would be invalid:

SSIndexTab1.Tabs.Insert 1

For this reason, Designer Widgets provides the X object.  The X object logically moves control-level objects out one level, circumventing the limitation.

Note	This limitation only applies to control-level objects.  Sub-objects do not have this limitation (see Sub-objects and Collections.)

In order to apply the Insert method to the Tabs collection, it must be done through the X object as follows:

SSIndexTab1.X.Tabs.Insert 1

In addition to the Tabs collection, the X object must also be used when applying properties or methods to the Templates collection.  All properties, methods and collections that need to be referenced through the X object are so indicated in the Remarks section in the Control Reference.

Compatibility with OCX controls

Any code written for use with the VBX version of the controls is fully compatible with the OCX version. The X object as used in the VBX version is supported in the OCX version also. This measure was taken so that you can substitute OCX controls for VBX controls without having to make changes to your code.


ap2_(Custom) Property
(Custom) Property applies to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control

SSToolbar Control


ap2_(TemplateManager) Property
(TemplateManager) Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_(ToolbarDesigner) Property
(ToolbarDesigner) Property applies to:

SSToolbar Control


ap2_About Property
(About) property applies to:

SSFormFX control

SSIndexTab control

SSNotebook control

SSToolbar control


ap2_ActiveControl Property
ActiveControl Property applies to:

SSFormFX Control


ap2_ActivePage3D Property
ActivePage3D Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePage3DBackColor Property
ActivePage3DBackColor Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePageBackColor, ActivePageForeColor Properties
ActivePageBackColor, ActivePageForeColor Properties apply to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePageFont Object
ActivePageFont Object applies to:

SSNotebook Control

SSIndexTab Control


ap2_ActivePageFont Property
ActivePageFont Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePageFontBold Property
ActivePageFontBold Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePageFontItalic Property
ActivePageFontItalic Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePageFontName Property
ActivePageFontName Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePageFontSize Property
ActivePageFontSize Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePageFontStrikethru Property
ActivePageFontStrikethru Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePageFontUnderline Property
ActivePageFontUnderline Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePagePicture Property
ActivePagePicture Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePagePictureMetaHeight, ActivePagePictureMetaWidth Properties
ActivePagePictureMetaHeight, ActivePagePictureMetaWidth Properties apply to:

SSIndexTab Control

SSNotebook Control


ap2_ActivePagePropertiesUsed Property
ActivePagePropertiesUsed Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTab3D Property
ActiveTab3D Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTab3DBackColor Property
ActiveTab3DBackColor Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabBackColor, ActiveTabForeColor Properties
ActiveTabBackColor, ActiveTabForeColor Properties apply to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabFont Object
ActiveTabFont Object applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabFont Property
ActiveTabFont Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabFontBold Property
ActiveTabFontBold Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabFontItalic Property
ActiveTabFontItalic Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabFontName Property
ActiveTabFontName Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabFontSize Property
ActiveTabFontSize Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabFontStrikethru Property
ActiveTabFontStrikethru Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabFontUnderline Property
ActiveTabFontUnderline Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabPicture Property
ActiveTabPicture Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabPictureMetaHeight, ActiveTabPictureMetaWidth Properties
ActiveTabPictureMetaHeight, ActiveTabPictureMetaWidth Properties apply to:

SSIndexTab Control

SSNotebook Control


ap2_ActiveTabPropertiesUsed Property
ActiveTabPropertiesUsed Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_AddControl Method
AddControl Method applies to:

Page Object


ap2_AlignmentCaption Property
AlignmentCaption Property applies to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control


ap2_AlignmentPicture Property
AlignmentPicture Property applies to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control


ap2_AllowAllUp Property
AllowAllUp Property applies to:

ToolsetTool Object


ap2_AllowToolbarDockLeft, AllowToolbarDockRight, AllowToolbarDockTop, AllowToolbarDockBottom Properties
AllowToolbarDockLeft, AllowToolbarDockRight, AllowToolbarDockTop, AllowToolbarDockBottom Properties apply to:

SSToolbar Control


ap2_AllowToolbarFloat Property
AllowToolbarFloat Property applies to:

SSToolbar Control


ap2_AllowToolbarMove Property
AllowToolbarMove Property applies to:

SSToolbar Control


ap2_AlwaysOnTop Property
AlwaysOnTop Property applies to:

SSFormFX Control


ap2_BackColor, ForeColor Properties
BackColor, ForeColor Properties apply to:

SSIndexTab Control

SSNotebook Control

Tab Object

Page Object


ap2_BackColorActive, ForeColorActive Properties
BackColorActive, ForeColorActive Properties apply to:

SSFormFX Control


ap2_BackColorDock Property
BackColorDock Property applies to:

SSToolbar Control


ap2_BackColorHelp, ForeColorHelp Properties
BackColorHelp, ForeColorHelp Properties apply to:

SSToolbar Control


ap2_BackColorInactive, ForeColorInactive Properties
BackColorInactive, ForeColorInactive Properties apply to:

SSFormFX Control


ap2_BalloonHelp Property
BalloonHelp Property applies to:

SSToolbar Control


ap2_BalloonHelpDelay Property
BalloonHelpDelay Property applies to:

SSToolbar Control


ap2_BevelColorFace, BevelColorHighlight, BevelColorOutline, BevelColorShadow Properties
BevelColorFace, BevelColorHighlight, BevelColorOutline, BevelColorShadow Properties apply to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control

SSToolbar Control


ap2_BevelColorScheme Property
BevelColorScheme Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_BevelInner Property
BevelInner Property applies to:

SSToolbar Control


ap2_BevelOuter Property
BevelOuter Property applies to:

SSToolbar Control


ap2_BevelWidth Property
BevelWidth Property applies to:

SSToolbar Control


ap2_Bold Property
Bold Property applies to:

ActivePageFont Object

ActiveTabFont Object

Font Object


ap2_Bookmark Property
Bookmark Property applies to:

Tab Object


ap2_Border3D Property
Border3D Property applies to:

SSFormFX Control


ap2_BorderWidth Property
BorderWidth Property applies to:

SSToolbar Control


ap2_BtnGroupSpacing Property
BtnGroupSpacing Property applies to:

SSToolbar Control


ap2_BtnHeight Property
BtnHeight Property applies to:

SSToolbar Control


ap2_BtnMarginX BtnMarginY Properties
BtnMarginX BtnMarginY Properties applies to:

SSToolbar Control


ap2_BtnSpacing Property
BtnSpacing Property applies to:

SSToolbar Control


ap2_BtnWidth Property
BtnWidth Property applies to:

SSToolbar Control


ap2_Btns Property
Btns Property applies to:

SSToolbar Control


ap2_Button Object
Button Object applies to:

SSToolbar Control


ap2_Buttons Collection
Buttons Collection applies to:

SSToolbar control


ap2_Caption Property
Caption Property applies to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control

Tab Object

Page Object


ap2_Caption3D Property
Caption3D Property applies to:

SSFormFX Control


ap2_CaptionBevelInner, CaptionBevelOuter Properties
CaptionBevelInner, CaptionBevelOuter Properties apply to:

SSFormFX Control


ap2_CaptionBevelWidth Property
CaptionBevelWidth Property applies to:

SSFormFX Control


ap2_CaptionBorderWidth Property
CaptionBorderWidth Property applies to:

SSFormFX Control


ap2_CaptionButtonEnabledLeft, CaptionButtonEnabledRight Properties
CaptionButtonEnabledLeft, CaptionButtonEnabledRight Properties apply to:

SSFormFX Control


ap2_CaptionButtonPicDisLeft, CaptionButtonPicDisRight Properties
CaptionButtonPicDisLeft, CaptionButtonPicDisRight Properties apply to:

SSFormFX Control


ap2_CaptionButtonPicLeft, CaptionButtonPicRight Properties
CaptionButtonPicLeft, CaptionButtonPicRight Properties apply to:

SSFormFX Control


ap2_CaptionButtonTypeLeft, CaptionButtonTypeRight Properties
CaptionButtonTypeLeft, CaptionButtonTypeRight Properties apply to:

SSFormFX Control


ap2_CaptionButtonValueLeft, CaptionButtonValueRight Properties
CaptionButtonValueLeft, CaptionButtonValueRight Properties apply to:

SSFormFX Control


ap2_CaptionButtonVisibleLeft, CaptionButtonVisibleRight Properties
CaptionButtonVisibleLeft, CaptionButtonVisibleRight Properties apply to:

SSFormFX Control


ap2_CaptionButtonsLeft, CaptionButtonsRight Properties
CaptionButtonsLeft, CaptionButtonsRight Properties apply to:

SSFormFX Control


ap2_CaptionButtonsLeftClick, CaptionButtonsRightClick Events
CaptionButtonsLeftClick, CaptionButtonsRightClick Events apply to:

SSFormFX Control


ap2_CaptionButtonsPic Property
CaptionButtonsPic Property applies to:

SSFormFX Control


ap2_CaptionHeight Property
CaptionHeight Property applies to:

SSFormFX Control


ap2_CaptionMultiLine Property
CaptionMultiLine Property applies to:

SSFormFX Control


ap2_CaptionPicture Property
CaptionPicture Property applies to:

SSFormFX Control


ap2_CaptionPictureMetaHeight, CaptionPictureMetaWidth Properties
CaptionPictureMetaHeight, CaptionPictureMetaWidth Properties apply to:

SSFormFX Control


ap2_CaptionPictureX, CaptionPictureY Properties
CaptionPictureX, CaptionPictureY Properties apply to:

SSFormFX Control


ap2_Click Event (SSIndexTab, SSNotebook)
Click Event (SSIndexTab, SSNotebook) applies to:

SSIndexTab Control

SSNotebook Control


ap2_Click Event (SSToolbar)
Click Event (SSToolbar) applies to:

SSToolbar Control


ap2_ClickAfter Event
ClickAfter Event applies to:

SSIndexTab Control

SSNotebook Control


ap2_ClickBefore Event
ClickBefore Event applies to:

SSIndexTab Control

SSNotebook Control


ap2_Client3D Property
Client3D Property applies to:

SSFormFX Control


ap2_ClientBevelInner, ClientBevelOuter Properties
ClientBevelInner, ClientBevelOuter Properties apply to:

SSFormFX Control


ap2_ClientBevelWidth Property
ClientBevelWidth Property applies to:

SSFormFX Control


ap2_ClientBorderWidth Property
ClientBorderWidth Property applies to:

SSFormFX Control


ap2_ClientHeight Property
ClientHeight Property applies to:

SSIndexTab Control


ap2_ClientLeft Property
ClientLeft Property applies to:

SSIndexTab Control


ap2_ClientMove Property
ClientMove Property applies to:

SSFormFX Control


ap2_ClientTop Property
ClientTop Property applies to:

SSIndexTab Control


ap2_ClientWidth Property
ClientWidth Property applies to:

SSIndexTab Control


ap2_CompatibilityMode Property
CompatibilityMode Property applies to:

SSIndexTab Control


ap2_ControlBox3D Property
ControlBox3D Property applies to:

SSFormFX Control


ap2_ControlBoxWidth Property
ControlBoxWidth Property applies to:

SSFormFX Control


ap2_Count Property
Count Property applies to:

Tabs Collection

Pages Collection

ToolsetTools Collection


ap2_CoverAlignmentPicture Property
CoverAlignmentPicture Property applies to:

SSNotebook Control


ap2_CoverAllowClose Property
CoverAllowClose Property applies to:

SSNotebook Control


ap2_CoverBackColor Property
CoverBackColor Property applies to:

SSNotebook Control


ap2_CoverCornerStyle Property
CoverCornerStyle Property applies to:

SSNotebook Control


ap2_CoverCreaseColor Property
CoverCreaseColor Property applies to:

SSNotebook Control


ap2_CoverCreaseStyle Property
CoverCreaseStyle Property applies to:

SSNotebook Control


ap2_CoverGuardStyle Property
CoverGuardStyle Property applies to:

SSNotebook Control


ap2_CoverMarginX, CoverMarginY Properties
CoverMarginX, CoverMarginY Properties apply to:

SSNotebook Control


ap2_CoverPicture Property
CoverPicture Property applies to:

SSNotebook Control


ap2_CoverShadow Property
CoverShadow Property applies to:

SSNotebook Control


ap2_CoverShadowColor Property
CoverShadowColor Property applies to:

SSNotebook Control


ap2_CoverShadowSize Property
CoverShadowSize Property applies to:

SSNotebook Control


ap2_CoverVisible Property
CoverVisible Property applies to:

SSNotebook Control


ap2_DataField Property
DataField Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_DataSourceHwnd Property
DataSourceHwnd Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_DeferDocking Property
DeferDocking Property applies to:

SSToolbar Control


ap2_Desc Property
Desc Property applies to:

ToolsetTool Object


ap2_DockRank Property
DockRank Property applies to:

SSToolbar Control


ap2_DockRankSeq Property
DockRankSeq Property applies to:

SSToolbar Control


ap2_DockStatus Property
DockStatus Property applies to:

SSToolbar Control


ap2_DockStatusChanged Event
DockStatusChanged Event applies to:

SSToolbar Control


ap2_Enabled Property
Enabled Property applies to:

Button Object

Tab Object

Page Object


ap2_Exclusive Property
Exclusive Property applies to:

ToolsetTool Object


ap2_FloatingCaption Property
FloatingCaption Property applies to:

SSToolbar Control


ap2_FloatingCaptionType Property
FloatingCaptionType Property applies to:

SSToolbar Control


ap2_FloatingControlBox Property
FloatingControlBox Property applies to:

SSToolbar Control


ap2_FloatingLeft, FloatingTop Properties
FloatingLeft, FloatingTop Properties apply to:

SSToolbar Control


ap2_FloatingSizable Property
FloatingSizable Property applies to:

SSToolbar Control


ap2_FloatingWidthInBtns Property
FloatingWidthInBtns Property applies to:

SSToolbar Control


ap2_Font Object
Font Object applies to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control


ap2_Font Property
Font Property applies to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control


ap2_Font3D Property
Font3D Property applies to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control


ap2_Group Property
Group Property applies to:

ToolsetTool Object


ap2_Help Event
Help Event applies to:

SSToolbar Control


ap2_Help Property
Help Property applies to:

ToolsetTool Object


ap2_HideInactiveControls
HideInactiveControls Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_HwndToolbar Property
HwndToolbar Property applies to:

SSToolbar Control


ap2_ID Property
ID Property applies to:

ToolsetTool Object


ap2_Insert Method
Insert Method applies to:

Tabs Collection

Pages Collection


ap2_InstantClose Property
InstantClose Property applies to:

SSFormFX Control


ap2_Italic Property
Italic Property applies to:

ActivePageFont Object

ActiveTabFont Object

Font Object


ap2_LockCtlKeyOverride Property
LockCtlKeyOverride Property applies to:

SSFormFX Control


ap2_LockMove Property
LockMove Property applies to:

SSFormFX Control


ap2_LockSize Property
LockSize Property applies to:

SSFormFX Control


ap2_MaximizeHeight, MaximizeWidth Properties
MaximizeHeight, MaximizeWidth Properties apply to:

SSFormFX Control


ap2_MaximizeLeft, MaximizeTop Properties
MaximizeLeft, MaximizeTop Properties apply to:

SSFormFX Control


ap2_Mnemonic Property
Mnemonic Property applies to:

ToolsetTool Object


ap2_MouseEnter Event
MouseEnter Event applies to:

SSToolbar Control


ap2_MouseExit Event
MouseExit Event applies to:

SSToolbar Control


ap2_Name Property
Name Property applies to:

Page Object

Tab Object

Template Object

ToolsetTools Collection


ap2_Name Property (Font object)
Name Property (Font object) applies to:

Font Object


ap2_NotebookOrientation Property
NotebookOrientation Property applies to:

SSNotebook Control


ap2_NumBtnStates Property
NumBtnStates Property applies to:

ToolsetTools Collection


ap2_Outline Property
Outline Property applies to:

SSToolbar Control


ap2_Page Object
Page Object applies to:

Pages Collection


ap2_Page Property
Page Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageAlignmentCaption Property
PageAlignmentCaption Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageAlignmentPicture Property
PageAlignmentPicture Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageAnimation Property
PageAnimation Property applies to:

SSNotebook Control


ap2_PageAnimationResolution Property
PageAnimationResolution Property applies to:

SSNotebook Control


ap2_PageBackColor Property
PageBackColor Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageCaption Property
PageCaption Property applies to:

Page Object


ap2_PageCaptionRotation Property
PageCaptionRotation Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageCount Property
PageCount Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageEarmarkPos Property
PageEarmarkPos Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageFont Object
PageFont Object applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageFont Property
PageFont Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageFont3D Property
PageFont3D Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageFontBold Property
PageFontBold Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageFontItalic Property
PageFontItalic Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageFontName Property
PageFontName Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageFontSize Property
PageFontSize Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageFontStrikethru Property
PageFontStrikethru Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageFontUnderline Property
PageFontUnderline Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageForeColor Property
PageForeColor Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageGutterMargin Property
PageGutterMargin Property applies to:

SSNotebook Control


ap2_PageMargin Property
PageMargin Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PageNavigation Property
PageNavigation Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PagePicture Property
PagePicture Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_PagePictureMetaHeight, PagePictureMetaWidth Properties
PagePictureMetaHeight, PagePictureMetaWidth Properties apply to:

SSIndexTab Control

SSNotebook Control


ap2_PageStyle Property
PageStyle Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageTabEarmark Property
PageTabEarmark Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageTabHeight Property
PageTabHeight Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageTabOrientation Property
PageTabOrientation Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageTabsPerRow Property
PageTabsPerRow Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PageTurnSound Property
PageTurnSound Property applies to:

SSNotebook Control


ap2_PageTurnSoundFile Property
PageTurnSoundFile Property applies to:

SSNotebook Control


ap2_PageWordWrap Property
PageWordWrap Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_Pages3D Property
Pages3D Property applies to:

SSIndexTab Control

SSNotebook Control

Tab Object


ap2_PagesCollection
Pages Collection applies to:

Tab object


ap2_PagesVisible Property
PagesVisible Property applies to:

SSIndexTab Control


ap2_Picture Object
Picture Object applies to:

SSIndexTab Control

SSNotebook Control

Page Object

Tab Object

ToolsetTools Collection


ap2_Picture Property
Picture Property applies to:

SSIndexTab Control

SSNotebook Control

Page Object

Tab Object

ToolsetTools Collection


ap2_PictureDn, PictureUp Properties
PictureDn, PictureUp Properties apply to:

ToolsetTool Object


ap2_PictureDnDis, PictureUpDis Properties
PictureDnDis, PictureUpDis Properties apply to:

ToolsetTool Object


ap2_PictureMetaHeight, PictureMetaWidth Properties
PictureMetaHeight, PictureMetaWidth Properties apply to:

Page Object

Tab Object


ap2_Placeholder Property
Placeholder Property applies to:

Button Object


ap2_PlaceholderWidth Property
PlaceholderWidth Property applies to:

Button Object


ap2_Redraw Property
Redraw Property applies to:

SSFormFX Control

SSIndexTab Control

SSNotebook Control


ap2_Remove Method
Remove Method applies to:

Pages Collection

Tabs Collection

Templates Collection


ap2_RemoveControl Method
RemoveControl Method applies to:

Tab Object

Page Object


ap2_RingBackColor Property
RingBackColor Property applies to:

SSNotebook Control


ap2_RingCount Property
RingCount Property applies to:

SSNotebook Control


ap2_RingGroups Property
RingGroups Property applies to:

SSNotebook Control


ap2_RingHighlightColor Property
RingHighlightColor Property applies to:

SSNotebook Control


ap2_RingHoleColor Property
RingHoleColor Property applies to:

SSNotebook Control


ap2_RingHoleOutlineColor Property
RingHoleOutlineColor Property applies to:

SSNotebook Control


ap2_RingHolesVisible Property
RingHolesVisible Property applies to:

SSNotebook Control


ap2_RingMarginBottom, RingMarginTop Properties
RingMarginBottom, RingMarginTop Properties apply to:

SSNotebook Control


ap2_RingOutlineColor Property
RingOutlineColor Property applies to:

SSNotebook Control


ap2_RingSize Property
RingSize Property applies to:

SSNotebook Control


ap2_RingSpacing Property
RingSpacing Property applies to:

SSNotebook Control


ap2_RingType Property
RingType Property applies to:

SSNotebook Control


ap2_RingWidth Property
RingWidth Property applies to:

SSNotebook Control


ap2_ShowFocusRect Property
ShowFocusRect Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_Size Property
Size Property applies to:

ActivePageFont Object

ActiveTabFont Object

Font Object


ap2_SizeMaxHeight, SizeMaxWidth Properties
SizeMaxHeight, SizeMaxWidth Properties apply to:

SSFormFX Control


ap2_SizeMinHeight, SizeMinWidth Properties
SizeMinHeight, SizeMinWidth Properties apply to:

SSFormFX Control


ap2_SpineBackColor Property
SpineBackColor Property applies to:

SSNotebook Control


ap2_SpineHighlightColor Property
SpineHighlightColor Property applies to:

SSNotebook Control


ap2_SpineOutlineColor Property
SpineOutlineColor Property applies to:

SSNotebook Control


ap2_SpineStyle Property
SpineStyle Property applies to:

SSNotebook Control


ap2_SpineVisible Property
SpineVisible Property applies to:

SSNotebook Control


ap2_StdButtonHeight Property
StdButtonHeight Property applies to:

SSFormFX Control


ap2_StdCaption Property
StdCaption Property applies to:

SSFormFX Control


ap2_StdCaptionHeight Property
StdCaptionHeight Property applies to:

SSFormFX Control


ap2_Strikethrough Property
Strikethrough Property applies to:

ActivePageFont Object

ActiveTabFont Object

Font Object


ap2_Tab Object
Tab Object applies to:

Tabs collection


ap2_Tab Property
Tab Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabBackColorDefault Property
TabBackColorDefault Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabBookmark Property
TabBookmark Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabCaptionRotation Property
TabCaptionRotation Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabCount Property
TabCount Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabCutSize Property
TabCutSize Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabForeColorDefault Property
TabForeColorDefault Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabGutterMargin Property
TabGutterMargin Property applies to:

SSNotebook Control


ap2_TabHeight Property
TabHeight Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabLeftMargin Property
TabLeftMargin Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabMaxRows Property
TabMaxRows Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabMaxWidth Property
TabMaxWidth Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabOrientation Property (Index Tab control)
TabOrientation Property (Index Tab control) applies to:

SSIndexTab Control


ap2_TabOrientation Property (Notebook control)
TabOrientation Property (Notebook control) applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabRightMargin Property
TabRightMargin Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabRowOffset Property
TabRowOffset Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabScrollType Property
TabScrollType Property applies to:

SSIndexTab Control


ap2_TabSelectType Property
TabSelectType Property applies to:

SSIndexTab Control


ap2_TabShape Property
TabShape Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabSpacing Property
TabSpacing Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabStart Property
TabStart Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabTopOffset Property
TabTopOffset Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabVariableSize Property
TabVariableSize Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabVisibleFirst Property
TabVisibleFirst Property applies to:

SSIndexTab Control


ap2_TabVisibleLast Property
TabVisibleLast Property applies to:

SSIndexTab Control


ap2_TabWordWrap Property
TabWordWrap Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_Tabs Collection
Tabs Collection applies to:

SSIndexTab control

SSNotebook control


ap2_Tabs3D Property
Tabs3D Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_TabsPerRow Property
TabsPerRow Property applies to:

SSIndexTab Control

SSNotebook Control


ap2_Template Object
Template Object applies to:

Templates Collection


ap2_TemplateName Property
TemplateName Property applies to:

Page Object


ap2_Templates Collection
The Templates Collection applies to:

SSIndexTab control

SSNotebook control


ap2_ToolNum Property
ToolNum Property applies to:

ToolsetTool Object


ap2_Toolbar3D Property
Toolbar3D Property applies to:

SSToolbar Control


ap2_ToolbarClosed Event
ToolbarClosed Event applies to:

SSToolbar Control


ap2_ToolbarOrientation Property
ToolbarOrientation Property applies to:

SSToolbar Control


ap2_ToolbarResized Event
ToolbarResized Event applies to:

SSToolbar Control


ap2_ToolsetName Property
ToolsetName Property applies to:

SSToolbar Control


ap2_ToolsetNumBtnStates Property
ToolsetNumBtnStates Property applies to:

SSToolbar Control


ap2_ToolsetNumTools Property
ToolsetNumTools Property applies to:

SSToolbar Control


ap2_ToolsetPicture Property
ToolsetPicture Property applies to:

SSToolbar Control


ap2_ToolsetTool Object
ToolsetTool Object applies to:

SSToolbar control


ap2_ToolsetTools Collection
ToolsetTools Collection applies to:

SSToolbar Control


ap2_TransparentBack Property
The TransparentBack Property applies to:

SSIndexTab control

SSNotebook control


ap2_Type Property (ToolsetTool object)
Type Property (ToolsetTool object) applies to:

ToolsetTool Object


ap2_Underline Property
Underline Property applies to:

ActivePageFont Object

ActiveTabFont Object

Font Object


ap2_UseSystemColors
UseSystemColors Property applies to:

SSToolbar Control


ap2_Value Property
Value Property applies to:

Button Object


ap2_WinowLook Property
WindowLook Property applies to:

SSFormFX Control


ex_ActivePageFont Property
ActivePageFont Property Example:

This code sets the ActivePageFont object to use the Times New Roman font in bold and italic:

SSIndexTab1.ActivePageFont = "Times New Roman"	'Name is the

'default property

SSIndexTab1. ActivePageFont.Bold = True

SSIndexTab1.ActivePageFont.Italic = True


ex_ActivePagePicture Property
ActivePagePicture Property Example

This sample code sets picture for the active page to an icon:

SSIndexTab1.ActivePagePicture = LoadPicture("C:\ICONS\ACTIVE.ICO")


ex_ActivePagePictureMetaHeight, ActivePagePictureMetaWidth Properties
ActivePagePictureMetaHeight, ActivePagePictureMetaWidth Properties example

This sample code scales a metafile in the caption area of the active Page into 100 twips square:

Form1.ScaleMode = 1	'Twips

SSIndexTab1.ActivePagePictureMetaHeight = 100

SSIndexTab1.ActivePagePictureMetaWidth = 100


ex_ActiveTabFont Property
ActiveTabFont Property example

This code sets the ActiveTabFont object to use the Times New Roman font in bold and italic:

SSIndexTab1.ActiveTabFont = "Times New Roman"	'Name is the

'default property

SSIndexTab1.ActiveTabFont.Bold = True

SSIndexTab1.ActiveTabFont.Italic = True


ex_ActiveTabPictureMetaHeight, ActiveTabPictureMetaWidth Properties
ActiveTabPictureMetaHeight, ActiveTabPictureMetaWidth Properties example

This sample code scales a metafile in the caption area of the active tab into 200 twips square:

Form1.ScaleMode = 1	'Twips

SSIndexTab1.ActiveTabPictureMetaHeight = 200

SSIndexTab1.ActiveTabPictureMetaWidth = 200


ex_AddControl Method
AddControl Method example

This sample code adds a command button to the first tab in a notebook. The command button Command1(0) must be created at design time:

Load Command1(1)

SSNotebook1.X.Tabs(1).Pages(0).AddControl Command1(1)


ex_AlignmentCaption Property
AlignmentCaption Property example

The following sample aligns the text to the left and aligns the picture to the left of the text:

SSFormFX.AlignmentPicture = 9  'Left of Text

SSFormFX.AlignmentCaption = 1  'Left Justify - MIDDLE


ex_AlignmentPicture Property
AlignmentPicture Property example

The following sample aligns the text of a caption to the left, and the caption picture to the left of the text:

SSFormFX.AlignmentPicture = 9  'Left of Text

SSFormFX.AlignmentCaption = 1  'Left Justify - MIDDLE


ex_AllowToolbarDockLeft, AllowToolbarDockRight, AllowToolbarDockTop, AllowToolbarDockBottom Properties
AllowToolbarDockLeft, AllowToolbarDockRight, AllowToolbarDockTop, AllowToolbarDockBottom Properties example

This sample code restricts the user from docking the toolbar in the left and right docking areas:

SSToolbar1.AllowToolbarDockLeft  = False

SSToolbar1.AllowToolbarDockRight = False


ex_AlwaysOnTop Property
AlwaysOnTop Property example

This sample code toggles the form between Always On Top and regular display mode when a command button is clicked:

Sub cmdFloat_Click ()

SSFormFX1.AlwaysOnTop = Not SSFormFX1.AlwaysOnTop

End Sub


ex_BackColor, ForeColor Properties
BackColor, ForeColor Properties example

The following sample code shows how to set the area behind a tab control to white, and the background color of the first tab to light gray:

SSIndexTab1.BackColor = &HFFFFFF

SSIndexTab1.X.Tabs(0).BackColor = &HC0C0C0


ex_BackColorActive, ForeColorActive Properties
BackColorActive, ForeColorActive Properties example

This sample code sets the active back color to white and the active fore color to black:

SSFormFX1.BackColorActive = &HFFFFFF

SSFormFX1.ForeColorActive = &H000000


ex_BackColorInactive, ForeColorInactive Properties
BackColorInactive, ForeColorInactive Properties example

This sample code sets the inactive fore color to black and the inactive back color to light gray:

SSFormFX1.ForeColorInactive = &HFFFFFF

SSFormFX1.BackColorInactive = &HC0C0C0


ex_BalloonHelp Property
BalloonHelp PropertyBalloonHelp Property example

This sample code sets the toolbar to activate balloon help when the mouse is over a button for more than 1 second:

SSToolbar1.BalloonHelpDelay = 1000	'Set delay to 1 second

SSToolbar1.BalloonHelp = True	'Activate balloon help


ex_BalloonHelpDelay Property
BalloonHelpDelay Property example

This sample code sets the toolbar to activate balloon help when the mouse is over a button for over 1 second:

SSToolbar1.BalloonHelpDelay = 1000	'Set delay to 1 second

SSToolbar1.BalloonHelp = True	'Enable balloon help


ex_Bookmark Property
Bookmark Property example

This sample code uses the Bookmark property to create an array consisting of all the bookmarks and captions for the currently available tabs. This array is used to populate a list, providing a simple table of contents. When the user selects an entry on the list and clicks a button, the tab for that entry is made active.

This code requires a form containing an Index Tab control, a list box (List1) and two command buttons (cmdMakeTOC   to create the table, and cmdGoToEntry   to jump to the value selected from the list.)

Enter the following code in the [declarations] section of the form:

Type TabsTable

Caption as String

Bookmark as Variant

End Type

Dim tContents() as TabsTable

Then enter the following code in the indicated event procedures:

Sub cmdMakeTOC_Click

ReDim tContents(SSIndexTab1.TabCount) as TabsTable

'Store the bookmarks and captions for each tab

For N% = 0 to SSIndexTab1.TabCount

tContents(N%).Caption = SSIndexTab1.X.Tabs(N%).Caption

tContents(N%).Bookmark = SSIndexTab1.X.Tabs(N%).Bookmark

'Add caption text to list

List1.List(N%) = tContents(N%).Caption

Next N%

End Sub

Sub cmdGoToEntry_Click

If List1.ListIndex > -1 Then	'If a list item is selected

'Set the bookmark of the active tab to the saved value

SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Bookmark = tContents(List1.ListIndex).Bookmark

End If

End Sub


ex_Border3D Property
Border3D Property example

This sample code enables the 3-D border on a form:

SSFormFX1.Border3D = True


ex_BtnGroupSpacing Property
BtnGroupSpacing Property example

This sample code sets the space between buttons to be -1 pixels (to cause a 1 pixel overlap) and the group spacing to be 8 pixels:

SSToolbar1.BtnSpacing      = -1  'causes a 1 pixel overlap

SSToolbar1.BtnGroupSpacing = 8   'set to 8 pixels


ex_BtnSpacing Property
BtnSpacing Property example

This sample code sets the space between buttons to be -1 pixels (to cause a 1 pixel overlap) and the group spacing to 8 pixels:

SSToolbar1.BtnSpacing      = -1  'causes a 1 pixel overlap

SSToolbar1.BtnGroupSpacing = 8   'set to 8 pixels


ex_Btns Property
Btns Property example

The following code adds a button to the toolbar and assigns a 'Cut' tool from a pre-defined toolset:

SSToolbar1.Btns = SSToolbar1.Btns + 1 	'create the new button

SSToolbar1.BtnToolNum(SSToolbar1.Btns - 1) = 2 	'Assign the cut tool


ex_Caption Property_1
Caption Property example

This sample code sets the caption text of a form using the FormFX control:

Form1.Caption = ""

SSFormFX1.Caption = "Sheridan Software Form FX Demo"


ex_Caption Property_2
Caption Property example

This sample code sets the caption text of the currently active tab:

SSIndexTab1.Caption = "Now Set"

This sample code sets the caption text of the first tab in a Index Tab control, and also of the first page of that tab:

SSIndexTab1.X.Tabs(0).Caption = "Start Here"

SSIndexTab1.X.Tabs(0).Pages(1).Caption = "Page One"


ex_Caption3D Property
Caption3D Property example

This sample code sets the caption of a form to have a 3-D appearance:

SSFormFX1.StdCaption = False

SSFormFX1.Caption3D = True


ex_CaptionBevelInner, CaptionBevelOuter Properties
CaptionBevelInner, CaptionBevelOuter Properties example

This sample code sets the caption of a form to have a framed 3-D appearance:

SSFormFX1.Caption3D = True

SSFormFX1.CaptionBevelWidth = 1

SSFormFX1.CaptionBorderWidth = 2

SSFormFX1.CaptionBevelOuter = 2	'Raised outside

SSFormFX1.CaptionBevelInner = 1	'Inset inside


ex_CaptionBevelWidth Property
CaptionBevelWidth Property example

This sample code sets the beveling in the caption area to a width of one pixel:

SSFormFX1.Caption3D = True

SSFormFX1.CaptionBevelWidth = 1


ex_CaptionBorderWidth Property
CaptionBorderWidth Property example

This sample code sets the width of the border in the caption area to one pixel:

SSFormFX1.Caption3D = True

SSFormFX1.CaptionBorderWidth = 1


ex_CaptionButtonPicDisLeft, CaptionButtonPicDisRight Properties
CaptionButtonPicDisLeft, CaptionButtonPicDisRight Properties example

This sample code sets the CaptionButtonPicDisLeft property to a bitmap:

SSFormFX1.CaptionButtonPicDisLeft = LoadPicture("B-DISABL.BMP")


ex_CaptionButtonPicLeft, CaptionButtonPicRight Properties
CaptionButtonPicLeft, CaptionButtonPicRight Properties example

This sample code sets the CaptionButtonPicLeft property to a bitmap:

SSFormFX1.CaptionButtonPicLeft = LoadPicture("B-ENABL.BMP")


ex_CaptionButtonTypeLeft, CaptionButtonTypeRight Properties
CaptionButtonTypeLeft, CaptionButtonTypeRight Properties example

This sample code turns all the custom caption buttons on the left into toggle buttons:

For N = 0 to SSFormFX1.CaptionButtonsLeft-1

SSFormFX1.CaptionButtonTypeLeft(N) = 1

Next N


ex_CaptionButtonValueLeft, CaptionButtonValueRight Properties
CaptionButtonValueLeft, CaptionButtonValueRight Properties example

This sample code turns all the custom caption buttons on the left into toggle buttons and sets them all to the depressed state:

For N = 0 to SSFormFX1.CaptionButtonsLeft-1

SSFormFX1.CaptionButtonTypeLeft(N) = 1

SSFormFX1.CaptionButtonValueLeft(N) = True

Next N


ex_CaptionButtonVisibleLeft, CaptionButtonVisibleRight Properties
CaptionButtonVisibleLeft, CaptionButtonVisibleRight Properties example

This sample code hides the inner-most custom caption button on the right and left:

If SSFormFX1.CaptionButtonsLeft > 0

SSFormFX1.CaptionButtonVisibleLeft(SSFormFX1.CaptionButtonsLeft-1)=False

End If

If SSFormFX1.CaptionButtonsRight > 0

SSFormFX1.CaptionButtonVisibleRight(SSFormFX1.CaptionButtonsRight-1)=False

End If


ex_CaptionButtonsLeft, CaptionButtonsRight Properties
CaptionButtonsLeft, CaptionButtonsRight Properties example

This sample code adds three custom caption buttons to the left side of a form:

SSFormFX1.CaptionButtonsLeft = 3

' Load 6-segment enabled bitmap for left side

SSFormFX1.CaptionButtonPicLeft = LoadPicture("ON-6SEG.BMP")

' Load 6-segment disabled bitmap for left side

SSFormFX1.CaptionButtonPicDisLeft = LoadPicture("OFF-6SEG.BMP")


ex_CaptionButtonsLeftClick, CaptionButtonsRightClick Events
CaptionButtonsLeftClick, CaptionButtonsRightClick Events example

This sample code shows how to use a custom caption button to display an "About" box:

Sub SSFormFX1_CaptionButtonRightClick(ByVal ButtonNumber As Integer)

Select Case ButtonNumber

Case 0

frmAboutBox.Show MODAL

Case Else

End Select

End Sub


ex_CaptionButtonsPic Property
CaptionButtonsPic Property example

This sample code sets the CaptionButtonsPic property to a bitmap:

SSFormFX1.CaptionButtonsPic = LoadPicture("BUTTONS.BMP")


ex_CaptionHeight Property
CaptionHeight Property example

This sample code sets the caption height to be 2000 twips to fit a multi-line caption:

SSFormFX1.CaptionHeight = 2000  'Set CaptionHeight=2000 twips

SSFormFX1.CaptionMultiLine = True

SSFormFX1.Caption = "This is a" + Chr$(13) + Chr$(10) + "Multiline Caption"


ex_CaptionMultiLine Property
CaptionMultiLine Property example

This sample code sets the caption height to be 2000 twips to fit a multi-line caption:

SSFormFX1.CaptionHeight = 2000  'Set CaptionHeight=2000 twips

SSFormFX1.CaptionMultiLine = True

SSFormFX1.Caption = "This is a" + Chr$(13) + Chr$(10) + "Multiline Caption"


ex_CaptionPicture Property
CaptionPicture Property example

This sample code puts an icon left justified in the caption area:

SSFormFX1.CaptionHeight = 2000  	'Make the caption big enough

SSFormFX1.CaptionPicture = LoadPicture("GOGGLES.ICO")

SSFormFX1.AlignmentPicture = 1 	'left justify


ex_CaptionPictureMetaHeight, CaptionPictureMetaWidth Properties
CaptionPictureMetaHeight, CaptionPictureMetaWidth Properties example

This sample code scales a metafile in the caption area into a square half the height of the caption:

SSFormFX1.CaptionPictureMetaHeight = SSFormFX1.CaptionHeight/2

SSFormFX1.CaptionPictureMetaWidth = SSFormFX1.CaptionHeight/2


ex_CaptionPictureX, CaptionPictureY Properties
CaptionPictureX, CaptionPictureY Properties example

This sample code displays a picture 1000 twips from the right side of the caption:

SSFormFX1.CaptionHeight = 2000   	'Make the caption big enough

SSFormFX1.CaptionPicture = LoadPicture("GOGGLES.ICO")

SSFormFX1.AlignmentPicture = 15  	'Fixed from right

SSFormFX1.CaptionPictureX = 1000 	'1000 twips from the right


ex_Click Event (SSToolbar)
Click Event (SSToolbar) example

This sample shows how to identify a button based on the ID parameter as defined in the toolset.  This sample uses the toolset TSBASIC.BMP:

Sub SSToolbar1_Click (ToolID As String, ToolNum As Integer,

 Btn As Integer, Value As Integer)

Select Case ToolID

    Case "ID_NEW"

               MsgBox "This invokes the New File function"

    Case "ID_OPEN"

               MsgBox "This invokes the Open File function"

    Case "ID_SAVE"

               MsgBox "This invokes the Save File function"

    Case "ID_PRINT"

               MsgBox "This invokes the Print function"

    Case "ID_PREVW"

               MsgBox "This invokes Print Preview"

    Case "ID_CUT"

               MsgBox "This invokes the Cut function"

    Case "ID_COPY"

               MsgBox "This invokes the Copy function"

    Case "ID_PASTE"

               MsgBox "This invokes the Paste function"

    Case "ID_UNDO"

               MsgBox "This invokes the Undo function"

    Case "ID_REDO"

               MsgBox "This invokes the Redo function"

    Case "ID_HELP1"

               MsgBox "This invokes the Item Help function"

    Case "ID_HELP2"

               MsgBox "This invokes General Help"

End Select

End Sub


ex_ClientBevelInner, ClientBevelOuter Properties
ClientBevelInner, ClientBevelOuter Properties example

This sample code sets the client area of a form to have a framed 3-D appearance:

SSFormFX1.Client3D = True

SSFormFX1.ClientBevelWidth = 2

SSFormFX1.ClientBorderWidth = 5

SSFormFX1.ClientBevelOuter = 2	'Raised outside

SSFormFX1.ClientBevelInner = 1	'Inset inside


ex_ClientBevelWidth Property
ClientBevelWidth Property example

This sample code sets the beveling of the client area to a width of two pixels:

SSFormFX1.Client3D = True

SSFormFX1.ClientBevelWidth = 2


ex_ClientBorderWidth Property
ClientBorderWidth Property example

This sample code sets the width of the border in the client area to five pixels:

SSFormFX1.Client3D = True

SSFormFX1.ClientBorderWidth = 5


ex_ClientMove Property
ClientMove Property example

The following line shows how to enable the ClientMove property on a form:

SSFormFX1.ClientMove = True


ex_CompatibilityMode Property
CompatibilityMode Property example

This sample code sets the compatibility mode of the Index Tab control to be compatible with earlier versions:

SSIndexTab1.CompatibilityMode = True


ex_ControlBox3D Property
ControlBox3D Property example

The following line shows how to display a 3-D control box on a form:

SSFormFX1.ControlBox3D = True


ex_ControlBoxWidth Property
ControlBoxWidth Property example

The following sample shows how to get a caption to appear like the standard Visual Basic toolbox window:

SSFormFX1.FontName = "Small Fonts"

SSFormFX1.FontSize = 6

SSFormFX1.CaptionHeight = 0 'sizes caption based on font size

SSFormFX1.ControlBoxWidth = 10 '10 pixels


ex_Count Property
Count Property example

This sample code doubles the number of tab pages in an existing set of index tabs:

SSIndexTab1.X.Tabs.Count = (SSIndexTab1.X.Tabs.Count * 2)


ex_DeferDocking Property
DeferDocking Property example

This sample code shows how to defer updates to a toolbar while changes are being made in code. This will prevent flickering and incorrect placement of the toolbar while the code is executing. In this example, SSToolbar1, SSToolbar2 and SSToolbar3 are all docked in the same area:

SSToolbar1.DeferDocking = TRUE

SSToolbar1.DockRank = 0

SSToolbar1.DockRankSeq = 0

SSToolbar2.DockRank = 0

SSToolbar2.DockRankSeq = 1

SSToolbar3.DockRank = 1

SSToolbar3.DockRankSeq = 0

SSToolbar1.DeferDocking = FALSE


ex_Desc Property
Desc Property example

This sample code shows how to display the tool's description in a status bar when the mouse moves over a button:

Sub SSToolbar1_MouseEnter(ToolID As String, ToolNum As Integer, Btn As Integer)

    pnlStatus.Caption = SSToolbar1.X.ToolsetTools(ToolNum).Desc

End Sub


ex_DockStatus Property
DockStatus Property example

This sample code shows how to set the caption of a status panel based upon the value of DockStatus:

If SSToolbar1.DockStatus = 4 Then

pnlStatusPanel.Caption = "Toolbar is floating"

Else

pnlStatusPanel.Caption = "Toolbar is docked"

End If


ex_DockStatusChanged Event
DockStatusChanged Event example

This sample code shows how to update the caption of a status panel using the DockStatus property and the DockStatusChanged event:

Sub SSToolbar_DockStatusChanged(Index as Integer,

PreviousDock as Integer)

If PreviousDock = 4 Then

pnlStatusPanel.Caption = "Toolbar is docked"

Else

If DockStatus = 4 Then

pnlStatusPanel.Caption = "Toolbar is floating"

Else

pnlStatusPanel.Caption = "Toolbar changed area"

End If

End If

End Sub


ex_Font Object
Font Object example

The following code changes the Bold property setting of a Font object identified by the Font property of a FormFX control:

SSFormFX1.Font.Bold = True	'Sets caption text to bold


ex_Font Property
Font Property example

The following code changes the Bold property setting of a Font object identified by the Font property of a FormFX control:

SSFormFX1.Font.Bold = True	'Sets caption text to bold


ex_Font3D Property
Font3D Property example

This sample code sets the caption text to 3-D or non-3-D depending on the appearance of the control box.

If SSFormFX1.ControlBox3D = True Then

SSFormFX1.Font3D = 2	'Raised w/heavy shading

Else

SSFormFX1.Font3D = 0	'No 3-D appearance

EndIf


ex_Help Event
Help Event example

This sample code shows how to display the tool's description in a status bar when the balloon help is activated.  To clear the text from the status bar, respond to the MouseExit event:

Sub SSToolbar1_Help(ToolID As String, ToolNum As Integer, Btn As Integer, X As Long, Y As Long,	RtnCancelDisplay As Integer)

    pnlStatus.Caption = SSToolbar1.ToolsetTools(ToolNum).Desc

End Sub


ex_Insert Method
Insert Method example

This sample code inserts a new page between the first and second pages in a notebook:

SSIndexTab1.X.Tabs.Insert 1


ex_InstantClose Property
InstantClose Property example

The following line shows how to set a control box to close the form on a single click:

SSFormFX1.InstantClose = True


ex_LockCtlKeyOverride Property
LockCtlKeyOverride Property example

This sample code shows how to turn off control-key override of moving and sizing locks:

SSFormFX1.LockCtlKeyOverride = False


ex_LockMove Property
LockMove Property example

This sample code shows how prevent the user from moving a form in the usual manner:

SSFormFX1.LockMove = True

MsgBox "Form movement disabled. Hold CTRL key to override."


ex_LockSize Property
LockSize Property example

This sample code shows how prevent the user from sizing a form in the usual manner:

SSFormFX1.LockSize = True

MsgBox "Form sizing disabled. Hold CTRL key to override."


ex_MaximizeHeight, MaximizeWidth Properties
MaximizeHeight, MaximizeWidth Properties example

This sample code sets the size of the form to 3000 X 5000 twips and positioned in the center of the screen when the form is maximized:

SSFormFX1.MaximizeWidth  = 3000

SSFormFX1.MaximizeHeight = 5000

SSFormFX1.MaximizeTop    = (Screen.Width / 2) - (SSFormFX1.MaximizeHeight / 2)

SSFormFX1.MaximizeLeft   = (Screen.Width / 2) - (SSFormFX1.MaximizeWidth / 2)


ex_MaximizeLeft, MaximizeTop Properties
MaximizeLeft, MaximizeTop Properties example

This sample code sets the size of the form to 3000 X 5000 twips and positioned in the center of the screen when the form is maximized:

SSFormFX1.MaximizeWidth  = 3000

SSFormFX1.MaximizeHeight = 5000

SSFormFX1.MaximizeTop    = (Screen.Width / 2) - (SSFormFX1.MaximizeHeight / 2)

SSFormFX1.MaximizeLeft   = (Screen.Width / 2) - (SSFormFX1.MaximizeWidth / 2)


ex_MouseEnter Event
MouseEnter Event example

This sample code shows how to display the tool's description in a status bar when the mouse is moved over a button:

Sub SSToolbar1_MouseEnter(ToolID As String, ToolNum As Integer, Btn As Integer)

    pnlStatus.Caption = SSToolbar1.X.ToolsetTools(ToolNum).Desc

End Sub


ex_MouseExit Event
MouseExit Event example

This sample code shows how to clear the tool's description in a status bar (assuming it was displayed in either the Help or MouseEnter event) when the mouse is moved off a button:

Sub SSToolbar1_MouseExit(ToolID As String, ToolNum As Integer, Btn As Integer)

    pnlStatus.Caption = ""

End Sub


ex_Name Property
Name Property example

The following sample code assigns a name to a Tab object, then uses that name to make the tab active:

SSIndexTab1.X.Tabs(0).Name = "ID_VIEW"

SSIndexTab1.Tab = SSIndexTab1.X.Tabs("ID_VIEW")


ex_PageAlignmentCaption Property
PageAlignmentCaption Property example

The following sample aligns the caption text of all the pages in the control to the left:

SSIndexTab1.PageAlignmentCaption = 1  'Left Justify - MIDDLE


ex_PageAlignmentPicture Property
PageAlignmentPicture Property example

The following sample code aligns the page tab pictures to the left of the text:

SSIndexTab1.PageAlignmentPicture = 9  'Left of Text


ex_PageCount Property
PageCount Property example

This sample code uses PageCount to determine if the current tab has less than ten pages, and if so adds pages until there are ten:

Do While SSIndexTab1.PageCount < 10

'Add a page to the current tab

SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Pages.Insert SSIndexTab1.PageCount

Loop


ex_PageFont Property
PageFont Property example

This code sets the PageFont object to use the Times New Roman font without boldface or italics:

SSIndexTab1.PageFont = "Times New Roman"	'Name is the default property

SSIndexTab1.PageFont.Bold = False

SSIndexTab1.PageFont.Italic = False


ex_PageNavigation Property
PageNavigation Property example

This example illustrates how you can use your own controls to modify the Notebook interface. The example uses a command button to cycle through the pages of the active tab one at a time, returning to the beginning page when the end is reached.

Sub Form1_Load()

SSIndexTab1.PageNavigation = 0	'Code-only interface

SSIndexTab1.Tab = 0	'Go to first tab

SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Page = 0	'Go to first page

End Sub

Sub Command1_Click()

'If the current page is the last page

If SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Page = (SSIndexTab1.X.Tabs(SSIndexTab1.Tab).PageCount - 1) Then

'Go to the first page

SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Page = 0

Else

'Go to the next page

SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Page = SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Page + 1

End If

End Sub


ex_PageTabsPerRow Property
PageTabsPerRow Property example

The following code sets up all the pages in a Index Tab control to have four page tabs per row. The first tab will have twelve page tabs, occupying 3 rows:

SSIndexTab1.PageTabsPerRow = 4

SSIndexTab1.X.Tabs(0).Pages.Count = 12


ex_PageTurnSound Property
PageTurnSound Property example

This sample code sets a notebook to play a stock sound whenever the page is turned:

SSIndexTab1.PageTurnSound = 3


ex_PageTurnSoundFile Property
PageTurnSoundFile Property example

This sample code sets the Notebook control to play a supplied sound file whenever the page turns:

Notebook1.PageTurnSound = 4

Notebook1.PageTurnSoundFile = "C:\SOUNDS\FLIPPER.WAV"


ex_Redraw Property
Redraw Property example

This sample code shows how you might use Redraw while changing a range of FormFX properties:

SSFormFX1.Redraw = False

SSFormFX1.ControlBox3D = True

SSFormFX1.Client3D = True

SSFormFX1.Caption3D = True

SSFormFX1.ClientBorderWidth = 6

SSFormFX1.CaptionButtonsLeft = 4

SSFormFX1.CaptionButtonsRight = 2

SSFormFX1.Redraw = True


ex_Remove Method
Remove Method example

This sample code removes the last page in a tab, and the last tab in a notebook:

SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Pages.Remove (SSIndexTab1.X.Tabs(SSIndexTab1.Tab).PageCount - 1)

SSIndexTab1.X.Tabs.Remove (SSIndexTab1.TabCount - 1)


ex_RemoveControl Method
RemoveControl Method example

This sample code demonstrates how to remove a control from the first page of a tab in an Index Tab control:

SSIndexTab1.X.Tabs(0).Pages(0).RemoveControl Text1


ex_Size Property
Size Property example

The following sample code sets the font of the active tab of an Index Tab control to 18 points, and the font for the rest of the tabs to 12 points:

SSIndexTab1.ActiveTabFont.Size = 18

SSIndexTab1.Font.Size = 12


ex_SizeMaxHeight, SizeMaxWidth Properties
SizeMaxHeight, SizeMaxWidth Properties example

This sample code shows how to limit the resizing of a form:

frmVGAForm.ScaleMode = 3	'Pixel

SSFormFX1.SizeMaxHeight = 480

SSFormFX1.SizeMaxWidth = 640


ex_SizeMinHeight, SizeMinWidth Properties
SizeMinHeight, SizeMinWidth Properties example

This sample code show how to limit the resizing of a form:

Form1.ScaleMode = 3	'Pixel

'Put a picture in upper left corner of form

Image1.Top = 0

Image1.Left = 0

Image1.Height = 50

Image1.Width = 100

'Keep form large enough to see picture

SSFormFX1.SizeMinHeight = 50

SSFormFX1.SizeMinWidth = 100


ex_StdButtonHeight Property
StdButtonHeight Property example

This sample code sets the buttons in the caption area to the standard size:

SSFormFX1.StdButtonHeight = True


ex_StdCaption Property
StdCaption Property example

This sample code shows how to switch between standard and customized captions:

Sub cmdCapSwitch_Click()

SSFormFX1.StdCaption = Not SSFormFX1.StdCaption

If SSFormFX1.StdCaption = True Then

MsgBox "Caption standardized"

Else

MsgBox "Caption customized"

EndIf

End Sub


ex_StdCaptionHeight Property
StdCaptionHeight Property example

This sample code sets the entire caption area to the standard size:

SSFormFX1.StdCaptionHeight = True


ex_Strikethrough Property
Strikethrough Property example

The following sample code causes every tab except the active tab to have struck-through text:

SSNotebook1.Font.Strikethrough = TRUE

SSNotebook1.ActiveTabFont.Strikethrough = FALSE


ex_Tab Property
Tab Property example

This sample code makes the fourth tab the active tab in the notebook:

SSNotebook1.Tab = 3	'Tab numbers are zero-based


ex_TabBackColorDefault Property
TabBackColorDefault Property example

This sample code specifies a blue default background for all non-active tabs:

SSIndexTab1.TabBackColorDefault = &HFF0000


ex_TabBookmark Property
TabBookmark Property example

This sample code uses the TabBookmark property to set a bookmark and later return to it:

Global IdxTabMark as String

Sub cmdBookMark_Click

IdxTabMark = SSIndexTab1.X.TabBookmark

MsgBox "Active tab marked. Click BACK button to return."

End Sub

Sub cmd_BackButton_Click

SSIndexTab1.X.TabBookmark = IdxTabMark

MsgBox "Returned to last bookmark."

End Sub


ex_TabCount Property
TabCount Property example

This sample code uses TabCount to determine if the current control has less than five pages:

Do While SSIndexTab1.TabCount < 5

SSIndexTab1.Tabs.Insert 0	'Add a tab if less than 5

Loop


ex_TabForeColorDefault Property
TabForeColorDefault Property example

This sample code specifies a dark blue default foreground (text) color for all non-active tabs:

SSIndexTab1.TabForeColorDefault = &H800000&


ex_TabsPerRow Property
TabsPerRow Property example

The following code sets up a Index Tab control to have 12 tabs, occupying 3 rows of tabs:

SSIndexTab1.TabsPerRow = 4

SSIndexTab1.Tabs.Count = 12


ex_TemplateName Property
TemplateName Property example

The following sample code causes the controls on a specific template to appear on the active page:

SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Pages(SSIndexTab1.X.Tabs(SSIndexTab1.Tab).Page).TemplateName = "TID_SEARCHBTNS"


ex_ToolNum Property
ToolNum Property example

The following code adds a button to the toolbar and assigns a  'Cut' tool from a pre-defined toolset:

SSToolbar1.Btns = SSToolbar1.Btns + 1	'create the new button

SSToolbar1.X.Buttons(SSToolbar1.Btns - 1).ToolNum = 2	'assign the cut tool


ex_ToolbarClosed Event
ToolbarClosed Event example

The following sample code maintains a list of "closed" toolbars in a global Type array variable so that later in the program, the user can select from a list of toolbars to re-open:

Type TBarProfile	'Define Type variable

TBarID As String

Closed as Integer

Docked As Integer

DockArea as Integer

End Type

Global gToolbarInfo(10) As TBarProfile	'Dim global Type array

Sub SSToolbar1_ToolbarClosed(Index As Integer)

gToolbarInfo(Index).Closed = True

End Sub


ex_ToolsetPicture Property
ToolsetPicture Property example

This sample code assigns a bitmap to the ToolsetPicture property and configures it to have 8 tools and 2 states (up and down only), and set the type of the tools to be 'Push Button':

Dim I As Integer

Tb1.ToolsetNumBtnStates = 2

Tb1.ToolsetNumTools = 8

Tb1.ToolsetPicture = LoadBitmap("MYTOOLS.BMP")

For i = 0 to Tb1.ToolsetNumTools - 1

Tb1.ToolsetToolType(i) = 0   'Push Button

Next i


ex_Underline Property
Underline Property example

The following sample code sets the font of the active tab and page in a Notebook control to underlined, and the font for non-active tabs to non-underlined:

SSNotebook1.ActiveTabFont.Underline = TRUE

SSNotebook1.ActivePageFont.Underline = TRUE

SSNotebook1.Font.Underline = FALSE


frmpart_Caption Area
This is the Caption Area of the form. The Caption Area displays the form's title. Using FormFX, you can change the appearance of the text in the Caption Area, add pictures, or give the Caption Area 3-D bevels.

The Control Box, the Caption Area and the Minimize/Maximize/Restore buttons together make up the Title Bar of the form.


frmpart_MaxMinBtns
These are the Maximize and Minimize buttons. When the form is maximized, the Maximize button is replaced with the Restore button. Using FormFX you can customize the appearance of these buttons.


frmpart_border
This is the border of the form. Using FormFX, you can give this border a 3-D appearance. FormFX also gives you control ofver the sizing and movement of the form.


frmpart_cbla
This is the CaptionButtonsLeft area. Using FormFX you can place custom buttons in this part of the caption.


frmpart_cbra
This is the CaptionButtonsRight area. Using FormFX you can place custom buttons in this part of the caption.


frmpart_client area
This is the Client Area of the form, where you may place controls. Using FormFX you can add 3-D bevels to the outside of the Client Area (but inside the border.) You can also allow the form to be moved with the mouse using the Client Area.


frmpart_control box
This is the Control Box of the form. Using FormFX, you change the width of the Control Box or give it a 3-D appearance. You can specify your own image to replace the Control Box. You can also cause the Control Box to instantly close the form when it is clicked once.


itpart_Tabs
These are Index Tabs. Index Tabs provide an easy way to make groups of controls available in your program. Index Tabs can have pictures as well as text in their caption area.


itpart_page
This is an Index Tab page. Using pages you can refine the grouping of controls in your program. Pages may be hidden, which causes controls to appear to be positioned on the tab itself.


nbpart_cover
This is the Notebook cover. You can choose different options for the cover, including color and shadow size.


nbpart_earmark
This is a page earmark. By clicking on the earmark, you can "flip through" the pages in a particular tab section.


nbpart_page
This is a Notebook page. Pages give you more flexibility to group controls within tabs. This page uses the "Loose-leaf paper" style, one of several options for giving the pages a distinctive look.


nbpart_rings
These are the Notebook rings and spine. You can choose from several different types of rings,and control the spacing, size and number of rings.


nbpart_tabs
This is a Notebook tab. Notebook tabs provide you with a way to organize groups of related controls and switch between them with a single mouse click.


popup ActivePageFont related props
ActivePageFont related properties include:

ActivePageFontBold

ActivePageFontItalic

ActivePageFontSize

ActivePageFontStrikethru

ActivePageFontUnderline


popup ActiveTabFont related props
ActivePageFont related properties include:

ActiveTabFontBold

ActiveTabFontItalic

ActiveTabFontSize

ActiveTabFontStrikethru

ActiveTabFontUnderline


popup Collection object
A collection is a special type of object that contains sub-objects that are all of the same type, or class.


popup Font related props
Font related properties include:

FontBold

FontItalic

FontSize

FontStrikethru

FontUnderline


popup Objects
An object  is a single unit or entity within your application which contains both code and data.


popup Standard Event
Standard Event. Depending on your host environment, this event may be referred to by a different name or may not apply to this control. Refer to your host environment's documentation or help file for further information regarding this event.


popup Standard Method
Standard Method. Depending on your host environment, this method may be referred to by a different name or may not apply to this control. Refer to your host environment's documentation or help file for further information regarding this method.


popup Standard Property
Standard Property. Depending on your host environment, this property may be referred to by a different name or may not apply to this control. Refer to your host environment's documentation or help file for further information regarding this property.


popup caption area
Caption Area


popup control box
Control Box


popup dockback toolbar
This is the background of the top toolbar docking area.


popup dockleft toolbar
This is a toolbar docked in the left docking area.


popup docktop toolbar
This is a toolbar docked in the top docking area.


popup floating toolbar
This is a toolbar floating in its own window.


popup mdiform
This is an MDI form. Toolbars can dock along the edges of the form or float in a window inside or outside of the form.


popup min max buttons
Minimize / Maximize buttons


popup title bar
The Control Box, the Caption Area and the Minimize/Maximize/Restore buttons together make up the Title Bar of the form.


popup toolbar status
This is a status bar for displaying messages from the toolbar &/or the program.


popup_FormFX_contents
These are just some of the effects you can achieve using the FormFX control.


popup_scrolling interface
The scrolling interface consists of two arrow buttons that appear on the first row of tabs. These buttons scroll the tabs forward and backward, or in the case of tabs constrained to a single row, left or right.


s_also_ActivePage3D Property
See Also

ActivePageBackColor, ActivePageForeColor Properties

ActivePage3DBackColor Property

Pages3D Property


s_also_ActivePage3DBackColor Property
See Also

ActivePageBackColor, ActivePageForeColor Properties

ActivePage3D Property


s_also_ActivePageBackColor, ActivePageForeColor Properties
See Also

ActivePage3D Property

ActivePage3DBackColor Property

ActiveTabBackColor, ActiveTabForeColor Properties


s_also_ActivePageFont Object
See Also

ActivePageFont Property

ActiveTabFont Object

ActiveTabFont Property


s_also_ActivePageFont Property
See Also

ActivePageFont Object

ActiveTabFont Object

ActiveTabFont Property


s_also_ActivePageFontBold Property
See Also

ActivePageFont object

ActivePageFont property


s_also_ActivePageFontItalic Property
See Also

ActivePageFont object

ActivePageFont property


s_also_ActivePageFontName Property
See Also

ActivePageFont object

ActivePageFont property


s_also_ActivePageFontSize Property
See Also

ActivePageFont object

ActivePageFont property


s_also_ActivePageFontStrikethru Property
See Also

ActivePageFont object

ActivePageFont property


s_also_ActivePageFontUnderline Property
See Also

ActivePageFont object

ActivePageFont property


s_also_ActivePagePicture Property
See Also

ActivePagePictureMetaHeight, ActivePagePictureMetaWidth Properties

PagePicture Property

TabPicture Property


s_also_ActivePagePictureMetaHeight, ActivePagePictureMetaWidth Properties
See Also

ActivePagePicture Property

PagePictureMetaHeight, PagePictureMetaWidth Properties


s_also_ActiveTab3D Property
See Also

ActiveTab3DBackColor  Property

ActiveTabBackColor, ActiveTabForeColor Properties

Tabs3D property


s_also_ActiveTabBackColor, ActiveTabForeColor Properties
See Also

ActiveTab3DBackColor Property

ActiveTabFont Object

ActiveTabPicture Property

BackColor, ForeColor Properties

Tabs3D Property


s_also_ActiveTabFont Object
See Also

ActiveTabBackColor, ActiveTabForeColor Properties

ActiveTabPicture Property


s_also_ActiveTabFont Property
See Also

ActiveTabBackColor, ActiveTabForeColor Properties

ActiveTabPicture Property


s_also_ActiveTabFontBold Property
See Also

ActiveTabFont Object

ActiveTabFont Property


s_also_ActiveTabFontItalic Property
See Also

ActiveTabFont Object

ActiveTabFont Property


s_also_ActiveTabFontName Property
See Also

ActiveTabFont Object

ActiveTabFont Property


s_also_ActiveTabFontSize Property
See Also

ActiveTabFont Object

ActiveTabFont Property


s_also_ActiveTabFontStrikethru Property
See Also

ActiveTabFont Object

ActiveTabFont Property


s_also_ActiveTabFontUnderline Property
See Also

ActiveTabFont Object

ActiveTabFont Property


s_also_ActiveTabPicture Property
See Also

ActivePagePicture Property

Picture Property


s_also_ActiveTabPictureMetaHeight, ActiveTabPictureMetaWidth Properties
See Also

ActiveTabPicture Property

PictureMetaHeight, PictureMetaWidth Properties


s_also_AddControl Method
See Also

RemoveControl Method


s_also_AlignmentCaption Property
See Also

AlignmentPicture Property


s_also_AlignmentPicture Property
See Also

CaptionPictureX, CaptionPictureY Properties

PageAlignmentPicture Property


s_also_AllowAllUp Property
See Also

Exclusive Property

ToolsetTools Collection


s_also_AllowToolbarDockLeft, AllowToolbarDockRight, AllowToolbarDockTop, AllowToolbarDockBottom Properties
See Also

DockRank Property

DockRankSeq Property

DockStatus Property


s_also_AllowToolbarFloat Property
See Also

AllowToolbarMove Property

ToolbarFloating Property


s_also_AllowToolbarMove Property
See Also

AllowToolbarFloat Property


s_also_BackColor, ForeColor Properties
See Also

Tabs3D Property

BevelColorFace Property


s_also_BackColorActive, ForeColorActive Properties
See Also

BackColorInactive, ForeColorInactive Properties

BevelColorFace Property

StdCaption Property


s_also_BackColorDock Property
See Also

AllowToolbarDockLeft, AllowToolbarDockTop, AllowToolbarDockRight, AllowToolbarDockBottom Properties

DockStatus Property


s_also_BackColorHelp, ForeColorHelp Properties
See Also

BalloonHelp Property

BalloonHelpDelay Property

Help Property


s_also_BackColorInactive, ForeColorInactive Properties
See Also

BackColorActive, ForeColorActive Properties

BevelColorFace Property


s_also_BalloonHelp Property
See Also

BackColorHelp, ForeColorHelp Properties

BalloonHelpDelay Property

Help Property


s_also_BalloonHelpDelay Property
See Also

BackColorHelp, ForeColorHelp Properties

BalloonHelp Property

Help Property


s_also_BevelColorFace, BevelColorHighlight, BevelColorOutline, BevelColorShadow Properties
See Also

UseSystemColors Property (Toolbar only)


s_also_BevelColorScheme Property
See Also

BevelColorFace, BevelColorHighlight, BevelColorOutline, BevelColorShadow Properties


s_also_BevelInner Property
See Also

BevelColorFace, BevelColorHighlight, BevelColorOutline, BevelColorShadow Properties

Toolbar3D Property

BevelOuter Property


s_also_BevelOuter Property
See Also

BevelInner Property

BevelColorFace, BevelColorHighlight, BevelColorOutline, BevelColorShadow Properties

Toolbar3D Property


s_also_BevelWidth Property
See Also

BevelInner Property

BevelOuter Property


s_also_Bold Property
See Also

ActivePageFont Object

ActivePageFontBold Property

ActiveTabFont Object

ActiveTabFontBold Property

Font Property

Font Object


s_also_Bookmark Property
See Also

DataField Property

TabBookmark Property


s_also_Border3D Property
See Also

Caption3D Property

Client3D Property


s_also_BorderWidth Property
See Also

BevelInner Property

BevelOuter Property


s_also_BtnGroupSpacing Property
See Also

BtnSpacing Property

Group Property


s_also_BtnHeight Property
See Also

BtnWidth Property


s_also_BtnMarginX BtnMarginY Properties
See Also

BtnGroupSpacing Property

BtnSpacing Property


s_also_BtnSpacing Property
See Also

BtnGroupSpacing Property

Group Property


s_also_BtnWidth Property
See Also

BtnHeight Property


s_also_Btns Property
See Also

ToolNum Property


s_also_Button Object
See Also

Buttons Collection

ToolsetTool Object

ToolsetTools Collection


s_also_Buttons_Collection
See Also

Button Object,

ToolsetTool Object,

ToolsetTools Collection


s_also_Caption Property
See Also

AlignmentCaption Property

AlignmentPicture Property


s_also_Caption3D Property
See Also

CaptionBevelInner, CaptionBevelOuter Properties

CaptionBevelWidth Property

CaptionBorderWidth Property


s_also_CaptionBevelInner, CaptionBevelOuter Properties
See Also

BevelColorFace, BevelColorHighlight, BevelColorShadow Properties

Caption3D Property

CaptionBevelWidth Property

CaptionBorderWidth Property

StdCaption Property


s_also_CaptionBevelWidth Property
See Also

Caption3D Property

CaptionBevelInner, CaptionBevelOuter Properties

StdCaption property


s_also_CaptionBorderWidth Property
See Also

Caption3D Property

CaptionBevelInner, CaptionBevelOuter Properties


s_also_CaptionButtonEnabledLeft, CaptionButtonEnabledRight Properties
See Also

CaptionButtonPicDisLeft, CaptionButtonPicDisRight Properties

CaptionButtonPicLeft, CaptionButtonPicRight Properties

CaptionButtonsLeft, CaptionButtonsRight Properties


s_also_CaptionButtonPicDisLeft, CaptionButtonPicDisRight Properties
See Also

CaptionButtonEnabledLeft,CaptionButtonEnabledRight Properties

CaptionButtonPicLeft,CaptionButtonPicRight Properties

CaptionButtonsLeft,CaptionButtonsRight Properties

CaptionButtonsPic Property


s_also_CaptionButtonPicLeft, CaptionButtonPicRight Properties
See Also

CaptionButtonEnabledLeft,CaptionButtonEnabledRight Properties

CaptionButtonPicDisLeft,CaptionButtonPicDisRight Properties

CaptionButtonsLeft,CaptionButtonsRight Properties

CaptionButtonsPic Property


s_also_CaptionButtonTypeLeft, CaptionButtonTypeRight Properties
See Also

CaptionButtonsLeft, CaptionButtonsRight Properties


s_also_CaptionButtonValueLeft, CaptionButtonValueRight Properties
See Also

CaptionButtonsLeft, CaptionButtonsRight Properties

CaptionButtonTypeLeft, CaptionButtonTypeRight Properties


s_also_CaptionButtonVisibleLeft, CaptionButtonVisibleRight Properties
See Also

CaptionButtonEnabledLeft, CaptionButtonEnabledRight Properties


s_also_CaptionButtonsLeft, CaptionButtonsRight Properties
See Also

CaptionButtonPicDisLeft,CaptionButtonPicDisRight Properties

CaptionButtonPicLeft,CaptionButtonPicRight Properties

CaptionButtonVisibleLeft,CaptionButtonVisibleRight Properties


s_also_CaptionButtonsLeftClick, CaptionButtonsRightClick Events
See Also

CaptionButtonsLeft, CaptionButtonsRight Properties


s_also_CaptionButtonsPic Property
See Also

StdButtonHeight Property


s_also_CaptionHeight Property
See Also

StdCaptionHeight Property

StdButtonHeight Property


s_also_CaptionMultiLine Property
See Also

Caption Property

CaptionHeight Property


s_also_CaptionPicture Property
See Also

AlignmentPicture Property

CaptionPictureMetaHeight, CaptionPictureMetaWidth Properties


s_also_CaptionPictureMetaHeight, CaptionPictureMetaWidth Properties
See Also

CaptionPicture Property


s_also_CaptionPictureX, CaptionPictureY Properties
See Also

AlignmentPicture Property


s_also_Click Event (SSIndexTab, SSNotebook)
See Also

ClickAfter event

ClickBefore event


s_also_ClickAfter Event
See Also

Click event

ClickBefore event


s_also_ClickBefore Event
See Also

Click event

ClickAfter event


s_also_Client3D Property
See Also

ClientBevelInner, ClientBevelOuter Properties

ClientBevelWidth Property

ClientBorderWidth Property


s_also_ClientBevelInner, ClientBevelOuter Properties
See Also

BevelColorFace, BevelColorHighlight, BevelColorShadow Properties

Client3D Property

ClientBevelWidth Property


s_also_ClientBevelWidth Property
See Also

Client3D Property

ClientBevelInner, ClientBevelOuter Properties


s_also_ClientBorderWidth Property
See Also

Client3D Property

ClientBevelInner, ClientBevelOuter Properties


s_also_ClientHeight Property
See Also

ClientLeft Property

ClientTop Property

ClientWidth Property


s_also_ClientLeft Property
See Also

ClientHeight Property

ClientTop Property

ClientWidth Property


s_also_ClientMove Property
See Also

LockMove Property


s_also_ClientTop Property
See Also

ClientHeight property

ClientLeft property

ClientWidth property


s_also_ClientWidth Property
See Also

ClientHeight Property

ClientLeft Property

ClientTop Property


s_also_ControlBox3D Property
See Also

Caption3D Property

CaptionButtonsPic Property


s_also_ControlBoxWidth Property
See Also

ControlBox3D Property

CaptionButtonsPic Property

StdButtonHeight Property


s_also_Count Property
See Also

TabCount Property

PageCount Property


s_also_CoverAlignmentPicture Property
See Also

AlignmentPicture Property

CoverPicture Property

Picture Property


s_also_CoverBackColor Property
See Also

CoverShadowColor Property


s_also_CoverCornerStyle Property
See Also

CoverGuardStyle Property


s_also_CoverCreaseColor Property
See Also

CoverCreaseStyle Property


s_also_CoverCreaseStyle Property
See Also

CoverCreaseColor Property


s_also_CoverGuardStyle Property
See Also

CoverCornerStyle Property


s_also_CoverMarginX, CoverMarginY Properties
See Also

TabLeftMargin Property

TabRightMargin Property

RingMarginBottom, RingMarginTop Properties


s_also_CoverPicture Property
See Also

CoverAlignmentPicture Property

Picture Property


s_also_CoverShadow Property
See Also

CoverShadowColor Property


s_also_CoverShadowColor Property
See Also

CoverShadow Property

CoverShadowSize Property


s_also_CoverShadowSize Property
See Also

CoverShadow Property

CoverShadowColor Property


s_also_CoverVisible Property
See Also

CoverBackColor Property

CoverCornerStyle Property

CoverCreaseStyle Property

CoverGuardStyle Property


s_also_DataField Property
See Also

TabCount Property

TabScrollType Property


s_also_DeferDocking Property
See Also

DockRank Property

DockRankSeq Property

DockStatus Property


s_also_Desc Property
See Also

Help Property


s_also_DockRank Property
See Also

DockRankSeq Property

DockStatus Property

BackColorDock Property


s_also_DockRankSeq Property
See Also

DockStatus Property

BackColorDock Property


s_also_DockStatus Property
See Also

DockRank Property

DockRankSeq Property

FloatingLeft, FloatingTop Properties


s_also_Exclusive Property
See Also

AllowAllUp Property

Group Property

Value Property


s_also_FloatingCaption Property
See Also

FloatingCaptionType Property


s_also_FloatingCaptionType Property
See Also

FloatingCaption Property

FloatingControlBox Property


s_also_FloatingControlBox Property
See Also

FloatingCaptionType Property


s_also_FloatingLeft, FloatingTop Properties
See Also

FloatingWidthInBtns Property

DockStatus Property


s_also_FloatingSizable Property
See Also

FloatingWidthInBtns Property


s_also_FloatingWidthInBtns Property
See Also

FloatingLeft, FloatingTop Properties

FloatingSizable Property


s_also_Font Object
See Also

Bold Property

Font Property

Italic Property

Name Property

Size Property

Strikethrough Property

Underline Property


s_also_Font Property
See Also

Font object


s_also_Font3D Property
See Also

Caption Property


s_also_Group Property
See Also

Exclusive Property

AllowAllUp Property

BtnGroupSpacing Property

Type Property


s_also_Help Property
See Also

BalloonHelp Property

BalloonHelpDelay Property

Desc Property


s_also_ID Property
See Also

Click Event

Help Event

MouseEnter Event

MouseExit Event


s_also_Insert Method
See Also

Remove Method


s_also_InstantClose Property
See Also

ControlBoxWidth Property

CaptionButtonsPic Property


s_also_Italic Property
See Also

ActivePageFont Object

ActivePageFontItalic Property

ActiveTabFont Object

ActiveTabFontItalic Property

Font Property

Font Object


s_also_LockCtlKeyOverride Property
See Also

LockMove Property

LockSize Property


s_also_LockMove Property
See Also

LockCtlKeyOverride Property

LockSize Property


s_also_LockSize Property
See Also

LockCtlKeyOverride Property

LockMove Property


s_also_MaximizeHeight, MaximizeWidth Properties
See Also

MaximizeLeft, MaximizeTop Properties


s_also_MaximizeLeft, MaximizeTop Properties
See Also

MaximizeHeight, MaximizeWidth Properties


s_also_Mnemonic Property
See Also

Click Event


s_also_MouseEnter Event
See Also

MouseExit Event


s_also_MouseExit Event
See Also

MouseEnter Event


s_also_Name Property
See Also

Page Object

Pages Collection

Tab Object

Tabs Collection

Template Object

Templates Collection


s_also_Name Property (Font object)
See Also

Font Object

Font Property


s_also_NumBtnStates Property
See Also

ToolsetNumBtnStates Property

ToolsetPicture Property


s_also_Page Property
See Also

Page Object

Pages Collection


s_also_PageAlignmentCaption Property
See Also

PageAlignmentPicture Property


s_also_PageAlignmentPicture Property
See Also

Picture Property

PageAlignmentCaption Property


s_also_PageAnimation Property
See Also

PageAnimationResolution Property


s_also_PageAnimationResolution Property
See Also

PageAnimation Property


s_also_PageBackColor Property
See Also

PageForeColor Property

PageStyle Property


s_also_PageCaption Property
See Also

PageCaptionRotation Property

PageFont Property

PageFont3D Property

PageNavigation Property


s_also_PageCaptionRotation Property
See Also

PageAlignmentCaption Property

PageCaption Property

PageNavigation Property


s_also_PageCount Property
See Also

Count Property

Pages Collection


s_also_PageEarmarkPos Property
See Also

PageNavigation Property


s_also_PageFont Object
See Also

PageCaption Property

PageFont Property

PageFont3D Property

PageNavigation Property


s_also_PageFont Property
See Also

PageBackColor Property

PageForeColor Property

PagePicture Property


s_also_PageFont3D Property
See Also

Font3D Property

PageCaption Property

PageFont Property

PageNavigation Property


s_also_PageFontBold Property
See Also

PageFont Object

PageFont Property


s_also_PageFontItalic Property
See Also

PageFont Object

PageFont Property


s_also_PageFontName Property
See Also

PageFont object

PageFont property


s_also_PageFontSize Property
See Also

PageFont Object

PageFont Property


s_also_PageFontStrikethru Property
See Also

PageFont object

PageFont property


s_also_PageFontUnderline Property
See Also

PageFont Object

PageFont Property


s_also_PageForeColor Property
See Also

PageBackColor Property

PageStyle Property


s_also_PageGutterMargin Property
See Also

PageBackColor Property

PageStyle Property


s_also_PageNavigation Property
See Also

Page Property

PageCount Property


s_also_PagePicture Property
See Also

ActivePagePicture Property

PagePictureMetaHeight, PagePictureMetaWidth Properties

Picture Property

TabPicture Property


s_also_PagePictureMetaHeight, PagePictureMetaWidth Properties
See Also

Page Object

PagePicture Property


s_also_PageStyle Property
See Also

PageBackColor Property


s_also_PageTabEarmark Property
See Also

PageNavigation Property


s_also_PageTabHeight Property
See Also

PageNavigation Property

TabHeight Property


s_also_PageTabOrientation Property
See Also

PageNavigation Property

NotebookOrientation Property

TabOrientation Property (Index Tab control)

TabOrientation Property (Notebook control)


s_also_PageTabsPerRow Property
See Also

TabSpacing Property


s_also_PageTurnSound Property
See Also

PageTurnSoundFile Property


s_also_PageTurnSoundFile Property
See Also

PageTurnSound Property


s_also_PageWordWrap Property
See Also

WordWrap Property


s_also_Pages Collection
See Also

Page Object


s_also_Pages3D Property
See Also

PageNavigation Property


s_also_Picture Object
See Also

ActiveTabPicture Property

ActivePagePicture Property

CaptionPicture Property

CoverPicture Property

PagePicture Property

Picture Property

PictureMetaHeight, PictureMetaWidth Properties

TabPicture Property


s_also_Picture Property
See Also

ActiveTabPicture Property

ActivePagePicture Property

AlignmentPicture Property

CaptionPicture Property

CoverPicture Property

PagePicture Property

Picture Object

PictureMetaHeight, PictureMetaWidth Properties

TabPicture Property


s_also_PictureDn, PictureUp Properties
See Also

PictureDnDis, PictureUpDis Properties

ToolsetPicture Property

ToolsetTool Object


s_also_PictureDnDis, PictureUpDis Properties
See Also

PictureDn, PictureUp Properties

ToolsetPicture Property

ToolsetTool Object


s_also_PictureMetaHeight, PictureMetaWidth Properties
See Also

Page Object

PagePictureMetaHeight, PagePictureMetaWidth Properties

Tab Object


s_also_Placeholder Property
See Also

PlaceholderWidth Property


s_also_Remove Method
See Also

Insert Method


s_also_RemoveControl Method
See Also

AddControl Method


s_also_RingBackColor Property
See Also

RingHighlightColor Property

RingOutlineColor Property


s_also_RingCount Property
See Also

RingGroups Property

RingSpacing Property

RingSize Property

RingType Property

RingWidth Property


s_also_RingGroups Property
See Also

RingCount Property

RingSpacing Property

RingSize Property

RingType Property

RingWidth Property


s_also_RingHighlightColor Property
See Also

RingBackColor Property

RingOutlineColor Property


s_also_RingHoleColor Property
See Also

RingHoleOutlineColor Property


s_also_RingHoleOutlineColor Property
See Also

RingHoleColor Property


s_also_RingHolesVisible Property
See Also

RingHoleColor Property

TabGutterMargin Property


s_also_RingMarginBottom, RingMarginTop Properties
See Also

RingCount Property

RingGroups Property

RingSize Property

RingType Property

RingWidth Property


s_also_RingOutlineColor Property
See Also

RingBackColor Property

RingHighlightColor Property


s_also_RingSize Property
See Also

RingCount Property

RingGroups Property

RingSpacing Property

RingType Property

RingWidth Property


s_also_RingSpacing Property
See Also

RingCount Property

RingGroups Property

RingSize Property

RingType Property

RingWidth Property


s_also_RingType Property
See Also

RingCount Property

RingGroups Property

RingSpacing Property

RingSize Property

RingWidth Property


s_also_RingWidth Property
See Also

RingCount Property

RingGroups Property

RingSpacing Property

RingSize Property

RingType Property


s_also_Size Property
See Also

ActivePageFont Object

ActivePageFontSize Property

ActiveTabFont Object

ActiveTabFontSize Property

Font Property

Font Object


s_also_SizeMaxHeight, SizeMaxWidth Properties
See Also

LockSize Property

SizeMinHeight, SizeMinWidth Properties


s_also_SizeMinHeight, SizeMinWidth Properties
See Also

LockSize Property

SizeMaxHeight, SizeMaxWidth Properties


s_also_SpineBackColor Property
See Also

SpineOutlineColor Property

SpineStyle Property

SpineVisible Property


s_also_SpineHighlightColor Property
See Also

SpineBackColor Property

SpineStyle Property

SpineVisible Property


s_also_SpineOutlineColor Property
See Also

SpineBackColor Property

SpineStyle Property

SpineVisible Property


s_also_SpineStyle Property
See Also

SpineBackColor Property

SpineOutlineColor Property

SpineVisible Property


s_also_SpineVisible Property
See Also

RingType Property

SpineBackColor Property

SpineOutlineColor Property

SpineStyle Property


s_also_StdButtonHeight Property
See Also

CaptionHeight Property


s_also_StdCaptionHeight Property
See Also

CaptionHeight Property


s_also_Strikethrough Property
See Also

ActivePageFont Object

ActivePageFontStrikethru Property

ActiveTabFont Object

ActiveTabFontStrikethru Property

Font Property

Font Object


s_also_Tab Object
See Also

Tab Property

Tabs Collection


s_also_Tab Property
See Also

Caption Property

Tabs Collection

Tab Object


s_also_TabBackColorDefault Property
See Also

TabForeColorDefault Property


s_also_TabBookmark Property
See Also

Bookmark Property

DataField Property


s_also_TabCaptionRotation Property
See Also

AlignmentCaption Property

TabCaption Property


s_also_TabCount Property
See Also

Count Property

Tabs Collection


s_also_TabCutSize Property
See Also

TabShape Property


s_also_TabForeColorDefault Property
See Also

TabBackColorDefault Property


s_also_TabGutterMargin Property
See Also

RingHoleColor Property


s_also_TabHeight Property
See Also

TabMaxWidth Property


s_also_TabLeftMargin Property
See Also

CoverMarginX, CoverMarginY Properties

TabRightMargin Property


s_also_TabMaxRows Property
See Also

TabsPerRow Property


s_also_TabMaxWidth Property
See Also

TabsPerRow Property

TabHeight Property


s_also_TabOrientation Property (Index Tab control)
See Also

PageTabOrientation Property


s_also_TabOrientation Property (Notebook control)
See Also

NotebookOrientation Property

PageTabOrientation Property


s_also_TabRightMargin Property
See Also

CoverMarginX, CoverMarginY Properties

TabLeftMargin Property


s_also_TabRowOffset Property
See Also

TabsPerRow Property


s_also_TabScrollType Property
See Also

DataField Property

TabCount Property

TabsPerRow Property


s_also_TabShape Property
See Also

TabCutSize Property


s_also_TabSpacing Property
See Also

TabsPerRow Property


s_also_TabTopOffset Property
See Also

NotebookOrientation Property

TabHeight Property

TabOrientation (Index Tab Control)

TabOrientation (Notebook Control)

TabRowOffset Property


s_also_TabVariableSize Property
See Also

TabMaxWidth Property


s_also_TabVisibleFirst Property
See Also

TabVisibleLast Property


s_also_TabVisibleLast Property
See Also

TabVisibleFirst Property


s_also_TabWordWrap Property
See Also

PageWordWrap Property


s_also_Tabs Collection
See Also

Tab Object


s_also_Tabs3D Property
See Also

ActiveTab3DBackColor Property

BackColor, ForeColor Properties

BevelColorFace, BevelColorHighlight, BevelColorShadow Properties

Caption Property

TabBackColorDefault Property

TabForeColorDefault Property


s_also_TabsPerRow Property
See Also

TabSpacing Property


s_also_TemplateName Property
See Also

Template Object

Templates Collection

TemplateManager Property


s_also_Templates Collection
See Also

Template Object


s_also_ToolNum Property
See Also

Button Object

ID Property


s_also_Toolbar3D Property
See Also

BevelColorFace, BevelColorHighlight, BevelColorOutline, BevelColorShadow Properties

BevelInner Property

BevelOuter Property

BevelWidth Property

BorderWidth Property


s_also_ToolbarFloating Property
See Also

AllowToolbarFloat Property


s_also_ToolsetName Property
See Also

ToolsetTools Collection


s_also_ToolsetNumBtnStates Property
See Also

NumBtnStates Property

ToolsetPicture Property


s_also_ToolsetNumTools Property
See Also

ToolsetPicture Property

ToolsetTools Collection


s_also_ToolsetPicture Property
See Also

ID Property

Help Property

Desc Property

Type Property

Group Property

Exclusive Property

AllowAllUp Property

Mnemonic Property


s_also_ToolsetTool Object
See Also

ToolsetTools Collection


s_also_ToolsetTools Collection
See Also

ToolsetTool Object


s_also_TransparentBack_Property
See Also

BackColor Property


s_also_Type Property (ToolsetTool object)
See Also

Group Property


s_also_Underline Property
See Also

ActivePageFont Object

ActivePageFontUnderline Property

ActiveTabFont Object

ActiveTabFontUnderline Property

Font Property

Font Object


s_also_UseSystemColors Property
See Also

BevelColorFace Property

BevelColorHighlight Property

BevelColorShadow Property

BevelColorOutline Property


s_also_Value Property
See Also

Button Object


see_also Using DesWidg
See Also

Using Designer Widgets


see_also_PEMCO
Properties

Events

Methods

Collections

Objects