The SalQuickTabs type exposes the following members.

Constructors

  NameDescription
Public methodSalQuickTabs
Default Constructor.

Methods

  NameDescription
Public methodAdd
Append a tab. Redraw is optional Return an index
Public methodAddPage
Add a page. Call this function to add a page to the page list. The page window will not be created until the page is activated. The return value is TRUE or FALSE.
Public methodApplyFormPageChanges
Apply changes to all pages. Call this function to cause the PAGEM_ApplyChanges message to be sent to all form pages. Typically this function is called when the "OK" or "Apply Changes" button is selected. The return value is TRUE or FALSE.
Public methodBringToTop
Activate a tab
Public methodBringWindowToTop
Brings a window to the top of all overlapping windows.
(Inherited from SalUserControl.)
Public methodCancelMode
Cancel a user action. This can be called when processing a TABSM_ message.
Public methodCenterWindow
Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.
(Inherited from SalUserControl.)
Public methodClear
Clear all tabs from the frame. Redraw is optional.
Public methodClearCursor
Clears a window's cursor.
(Inherited from SalUserControl.)
Public methodClearPages
Clear all pages. Call this function to remove all entries from the page list and destroy any existing windows. The return value is TRUE of FALSE.
Public methodCreatePage
Create a page window. This function to causes the page window to be created. Typically it is not necessary to call this function because SetCurrentPage will take care of creating the page window. The page window will not be shown until SetCurrentPage is called.
Public methodDelete
Delete a tab at a location. Redraw is optional. Return TRUE or FALSE.
Public methodDestroyPage
Destroy a page window. Call this function to destroy a page window. The page is not removed from the list. The page window can be recreated.. The return value is TRUE or FALSE.
Public methodDestroyWindow
Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.
(Inherited from SalUserControl.)
Public methodDisableWindow
Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.
(Inherited from SalUserControl.)
Protected methodDispose
Releases the unmanaged resources used by the SalQuickTabs and optionally releases the managed resources
(Overrides ContainerControl..::..Dispose(Boolean).)
Public methodEnable
Enable or disable a tab
Public methodEnableWindow
Enables keyboard and mouse input to a window.
(Inherited from SalUserControl.)
Public methodFindChild
This function finds a child window of a given name in the specified window.
(Inherited from SalUserControl.)
Public methodFindLabel
Find a tab give a tab label
Public methodFindName
Find a tab give a tab name
Public methodFindTabFrame
Finds the tab frame window on a form or dialog box
Public methodFormUnitsToPixels
Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.
(Inherited from SalUserControl.)
Public methodStatic memberFromHandle
Returns the control associated with the handle.
Public methodGetClassName
Return the name of a window's class as a string.
(Inherited from SalUserControl.)
Public methodGetClicked
Get the index of the tab being clicked. This should only be called during a click notification.
Public methodGetContentsBorderRect
Get the area between the contents rect and the edge of the tab frame. For example nLeft will indicate the width of the left border, nTop will indicate the combined height of the top border and tab area.
Public methodGetContentsRect
Get the area available for child controls. Coordinates are relative to the parent window.
Public methodGetContentsRectPixels
Get the area available for child controls. Coordinates are relative to the parent window.
Public methodGetControlTabPages
Returns the names of the tab pages that the control is associated to. The list if names is separated by a semicolon.
Public methodGetControlType
Returns an object's type.
(Inherited from SalUserControl.)
Public methodGetCount
Get the count of tabs
Public methodGetFirstChild
Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.
(Inherited from SalUserControl.)
Public methodGetFont
Gets a window's font name, size, and enhancements.
(Inherited from SalUserControl.)
Public methodGetLabel
Get the label displayed on a tab
Public methodGetLocation
Returns a window's current position on the X and Y axes.
(Inherited from SalUserControl.)
Public methodGetMarginRect
Get the margins defined for a tiled-to-parent tabbed frame
Public methodGetName()()()()
Gets the name of an object.
(Inherited from SalUserControl.)
Public methodGetName(SalString%)
Gets the name of an object.
(Inherited from SalUserControl.)
Public methodGetName(SalNumber, SalString%)
Get the name associated with a tab
Public methodGetNextChild
Returns the handle of the next child window that matches a specified type.
(Inherited from SalUserControl.)
Public methodGetPageWindow
Get the window of a page. Call this function to get the Window Handle of a page. The return value is the Window Handle of the page. hWndNULL is returned if the page window has not been created.
Public methodGetParent
Returns the handle of an object's parent window.
(Inherited from SalUserControl.)
Public methodGetProperty(SalString)
Gets the value of a named property.
(Inherited from SalUserControl.)
Public methodGetProperty(SalString, SalString%)
Gets the value of a named property.
(Inherited from SalUserControl.)
Public methodGetRowCount
Retrieve the number rows of tabs
Public methodGetSize
Returns a window's size.
(Inherited from SalUserControl.)
Public methodGetText(SalNumber)
Retrieves the text of a window.
(Inherited from SalUserControl.)
Public methodGetText(SalString%, SalNumber)
Retrieves the text of a window.
(Inherited from SalUserControl.)
Public methodGetTop
Get the index of the active tab
Public methodGetWindowColor
Gets a window's color.
(Inherited from SalUserControl.)
Public methodGetWindowState
Returns a window's current state.
(Inherited from SalUserControl.)
Public methodHideWindow()()()()
Hides a window.
(Inherited from SalUserControl.)
Public methodHideWindow(SalWindowHandle)
Use this function instead of SalHideWindow. This function will keep the window hidden as tabs are selected. Use the class function ShowWindow to undo the affect of this function.
Public methodHideWindowAndLabel
Use this function instead of SalHideWindowAndLabel. This function will keep the window hidden as tabs are selected. Use the class function ShowWindowWindowAndLabel to undo the affect of this function.
Public methodIndexFromPoint
Get the tab, if any, under a given point (in pixels). A negative number is returned if the point is not over a tab.
Public methodInsert
Insert a tab at a location. Redraw is optional. Return TRUE or FALSE.
Public methodInvalidateWindow
Causes a window to be repainted.
(Inherited from SalUserControl.)
Public methodIsAssociatedWithTab
Indicate wether a child window is associated with a tab
Public methodIsDerivedFromClass
Determines whether a window is an instance of the specified class.
(Inherited from SalUserControl.)
Public methodIsEnabled()()()()
Determines whether a window is enabled for mouse and keyboard input.
(Inherited from SalUserControl.)
Public methodIsEnabled(SalNumber)
Indicate whether a tab is enabled
Public methodIsWindowVisible
Returns if the specified control is considered to be visible by the tab control and will be shown when the associated tab is selected.
Public methodIsVisible
Determines whether a window is currently visible.
(Inherited from SalUserControl.)
Public methodKillTimer
Destroys an object's system timer.
(Inherited from SalUserControl.)
Public methodMoveWindow
Moves a window a given number of form units on the X and Y axes relative to its current position.
(Inherited from SalUserControl.)
Public methodNext
Activate the next tab
Protected methodOnFontChanged (Overrides ContainerControl..::..OnFontChanged(EventArgs).)
Protected methodOnForeColorChanged (Overrides Control..::..OnForeColorChanged(EventArgs).)
Protected methodOnHandleCreated (Overrides Control..::..OnHandleCreated(EventArgs).)
Protected methodOnLayout (Overrides ContainerControl..::..OnLayout(LayoutEventArgs).)
Protected methodOnLoad (Overrides UserControl..::..OnLoad(EventArgs).)
Protected methodOnPaintBackground
Fires the internal PaintBackground event. This allows the handler component to take over the background painting of the form. This is primarily used to allow the SalQuickTabs control to paint transparent backgrounds.
(Inherited from SalUserControl.)
Protected methodOnParentChanged (Overrides ContainerControl..::..OnParentChanged(EventArgs).)
Public methodPaintBackground
Delegates the painting of the background to the tab control when the rectangle to paint is within the display area of the tab pages. This is needed to render the background of transparent controls using the visual style back color or the same back color of the tab page.
Public methodPixelsToFormUnits
Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.
(Inherited from SalUserControl.)
Public methodPostMessage
Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.
(Inherited from SalUserControl.)
Public methodPrev
Activate the previous tab
Public methodProcessKeys
Handles keys to change the selected tab.
Public methodRedraw
Arranges tabs on the frame and repaints. Call after adding tabs or clearing with a FALSE redraw flag.
Public methodReloadTabs
Reloads the original tabs configuration.
Public methodResizePages()()()()
Resize all pages. Call this function to resize all form pages. The active page is resized first. The return value is TRUE or FALSE.
Public methodResizePages(Rectangle)
Resize all pages. Call this function to resize all form pages. The active page is resized first. The return value is TRUE or FALSE.
Public methodSendMessage
Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.
(Inherited from SalUserControl.)
Public methodSendMessageToChildren
Sends a message to all child items of a form window, dialog box, table window, or MDI window.
(Inherited from SalUserControl.)
Public methodSendMsgToAssociated
Send a message to all child windows associated with a tab
Public methodSetContextMenu(Type, SalNumber)
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
(Inherited from SalUserControl.)
Public methodSetContextMenu(SalString, SalNumber)
Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.
(Inherited from SalUserControl.)
Public methodSetControlTabPages
Sets the tab pages associated to child control. The list is separated by a semicolon.
Public methodSetCurrentPage
Activates a page. Causes the form page associated to the specified tab to be created and/or shown. The current form page will be hidden.
Public methodSetCursor(Int32, SalNumber)
Sets a window's cursor.
(Inherited from SalUserControl.)
Public methodSetCursor(SalResourceCursor, SalNumber)
Sets a window's cursor.
(Inherited from SalUserControl.)
Public methodSetCursor(SalString, SalNumber)
Sets a window's cursor from a string variable.
(Inherited from SalUserControl.)
Public methodSetCursorFile
Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.
(Inherited from SalUserControl.)
Public methodSetFocus
Sets the focus to a specified window.
(Inherited from SalUserControl.)
Public methodSetFont
Sets a window's font, font size, and font enhancements.
(Inherited from SalUserControl.)
Public methodSetLabel
Set the label displayed on a tab. Redraw is optional.
Public methodSetLocation
Moves a window to a new position (x, y) on the X and Y axes.
(Inherited from SalUserControl.)
Public methodSetMarginRect
Public methodSetName
Associate a name with a tab
Public methodSetPageSize(Rectangle, SalBoolean)
Defines the location and size of form pages.
Public methodSetPageSize(SalNumber, SalNumber, SalNumber, SalNumber, SalBoolean)
Defines the location and size of form pages.
Public methodSetProperty
Sets the value of a named property.
(Inherited from SalUserControl.)
Public methodSetSize
Resizes a window.
(Inherited from SalUserControl.)
Public methodSetText
Sets the text of a window.
(Inherited from SalUserControl.)
Public methodSetTimer
Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.
(Inherited from SalUserControl.)
Public methodSetWindowColor
Sets a window's color.
(Inherited from SalUserControl.)
Public methodSetWorkspaceBoundary
Define the boundaries of the workspace so that a tiled-to-parent tab frame won't be resized smaller than this boundary.
Public methodShowSiblings
Show or hide child windows based on the current tab
Public methodShowWindow()()()()
Makes a window visible.
(Inherited from SalUserControl.)
Public methodShowWindow(SalWindowHandle)
Use this function instead of SalShowWindow because it works properly with the class function HideWindow
Public methodShowWindowAndLabel
Use this function instead of SalShowWindowAndLabel because it works properly with the class function HideWindowAndLabel.
Public methodTrackPopupMenu(Type, SalNumber, SalNumber, SalNumber)
Creates pop-up menus at runtime.
(Inherited from SalUserControl.)
Public methodTrackPopupMenu(SalString, SalNumber, SalNumber, SalNumber)
Creates pop-up menus at runtime.
(Inherited from SalUserControl.)
Public methodUpdateWindow
Forces the update of a window.
(Inherited from SalUserControl.)
Public methodWinHelp
Starts the Windows help system.
(Inherited from SalUserControl.)
Protected methodWndProc
Process WM_DESTROY to clear the pages collection to avoid destroying the form pages more than once.
(Overrides SalUserControl..::..WndProc(Message%).)
Public methodYield
Processes messages for this control.
(Inherited from SalUserControl.)

Operators

  NameDescription
Public operatorStatic memberExplicitNarrowingExplicitExplicitExplicit(SalWindowHandle to SalQuickTabs)
Fully qualified expressions operator.

Fields

  NameDescription
Public field_derived
Instance of the derived object that inherits this class as a second base in a multiple inheritance tree.
(Inherited from SalUserControl.)
Protected fieldm_salWindow
This is the basic implementation for all Sal controls. Every visual class uses SalWindow through delegation.
(Inherited from SalUserControl.)

Properties

  NameDescription
Public propertyAlignment
Gets or sets the area of the control (for example, along the top) where the tabs are aligned.
Public propertyAppearance
Gets or sets the visual appearance of the control's tabs.
Public propertyCustomRender
Public propertyDrawMode
Returns/Sets the way the tab control is drawn.
Public propertyImageList
Returns/Sets the image list to use to display images on child tabs.
Public propertyItemSize
Reflects the tab�s size
Public propertyMultiline
Indicates if more than one row of tabs is allowed.
Public propertyNamedProperties
Returns the collection of named properties.
(Inherited from SalUserControl.)
Public propertyPageRectangle
Returns the display area of the tab pages.
Public propertyRightToLeftLayout
Indicates whether the layout of the control is right-to-left when the RightToLeft property is set to Yes.
Public propertySelectedIndex
Returns/Sets the currently selected tab.
Public propertySelectedTab
Returns/Sets the selected tab page.
Public propertySizeMode
Indicates how tabs sized.
Public propertyTabControl
Returns the wrapped tab control
Public propertyTabPages
Returns the collection of tab pages.
Public propertyTabSetup
Initial Tab pages collection. Each tab is defined using a string property formatted as: {Name=Name0;Label=Label0;Form=FormClass0}{...}
Public propertyUseVisualStyleBackColor
Returns/Sets a value that determines if the tab pages paints the background using visual styles, if supported.
Public propertyVisualStyleBackColor
Color that should be used if visual styles is enabled. Current implementation of the tab control will not paint transparency correct as the controls is not bound to the tab page itself but have the form window as parent.

Events

  NameDescription
Public eventDrawControl
Public eventDrawItem
Public eventMessageActions (Inherited from SalUserControl.)
Public eventPaintBackground (Inherited from SalUserControl.)
Public eventSelectedIndexChanged
Fired when the selected tab has changed.
Public eventSelectedIndexChanging
Fired when the selected tab is about to change.

See Also