SalQuickTabs

PPJ.Runtime.Windows.QO.SalQuickTabs

Namespace: PPJ.Runtime.Windows.QO

Assembly: PPJ.Runtime.49 (4.9.0.0)

Tab frame window class. Instances of this class should be created as children of SalQuickTabsForm objects or SalQuickTabsDialog objects.

C#

public class SalQuickTabs : SalUserControl, IExtenderProvider

VB.NET

Constructors

SalQuickTabs()

Default Constructor.

Properties

Alignment

TabAlignment: Gets or sets the area of the control (for example, along the top) where the tabs are aligned. (Default: Top)

Appearance

TabAppearance: Gets or sets the visual appearance of the control's tabs. (Default: Normal)

DrawMode

TabDrawMode: Returns/Sets the way the tab control is drawn. (Default: Normal)

ImageList

ImageList: Returns/Sets the image list to use to display images on child tabs. (Default: null)

ItemSize

Size: Reflects the tab's size

Multiline

Boolean: Indicates if more than one row of tabs is allowed. (Default: False)

PageRectangle

Rectangle: Returns the display area of the tab pages.

RightToLeftLayout

Boolean: Indicates whether the layout of the control is right-to-left when the RightToLeft property is set to Yes.

SelectedIndex

Int32: Returns/Sets the currently selected tab. (Default: 0)

SelectedTab

SalTabPage: Returns/Sets the selected tab page.

SizeMode

TabSizeMode: Indicates how tabs sized. (Default: Normal)

TabControl

TabControl: Returns the wrapped tab control

TabPages

SalTabPageCollection: Returns the collection of tab pages.

TabSetup

String: Initial Tab pages collection. Each tab is defined using a string property formatted as: {Name=Name0;Label=Label0;Form=FormClass0}{...} (Default: "")

UseVisualStyleBackColor

Boolean: Returns/Sets a value that determines if the tab pages paints the background using visual styles, if supported. (Default: False)

Methods

Add(bRedraw)

Append a tab. Redraw is optional Return an index

Parameter	Type	Description
bRedraw	SalBoolean

Returns: SalNumber.

AddPage(sTag, sForm, hWnd)

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.

Parameter	Type	Description
sTag	SalString
sForm	SalString
hWnd	SalWindowHandle

Returns: SalBoolean.

AddPage(pageIndex, pageName)

Adds a tab page at a valid tab set index position.

Parameter	Type	Description
pageIndex	SalNumber
pageName	SalString

Returns: SalBoolean.

AddPageEx(pageIndex, pageName, imageFile, tooltip)

Adds a tab page at a valid tab set index position. You can include an image and a tool tip.

Parameter	Type	Description
pageIndex	SalNumber
pageName	SalString
imageFile	SalString
tooltip	SalString

Returns: SalBoolean.

ApplyFormPageChanges()

Apply changes to all pages. Call this function to cause the PAGEM_ApplyChanges message to be sent to all form pages.

Returns: SalBoolean.

AssociateChild(pageIndex, child)

Associates a child to a tab page.

Parameter	Type	Description
pageIndex	SalNumber
child	Control

Returns: SalBoolean.

AttachWindow(pageIndex, form)

Assigns a child window created at runtime to the specified tab page as its container window. You can programmatically create a Form Window or Dialog Box as child and assign it to a tab page by using this function.

Parameter	Type	Description
pageIndex	SalNumber
form	Control

Returns: SalBoolean.

BringToTop(nIndex, bRedraw)

Activate a tab.

Parameter	Type	Description
nIndex	SalNumber
bRedraw	SalBoolean

Returns: SalBoolean.

CancelMode()

Cancel a user action. This can be called when processing a TABSM_ message.

Returns: SalBoolean.

Clear(bRedraw)

Clear all tabs from the frame. Redraw is optional.

Parameter	Type	Description
bRedraw	SalBoolean

Returns: SalBoolean.

ClearPages()

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.

Returns: SalBoolean.

CreatePage(sTag)

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.

Parameter	Type	Description
sTag	SalString

Returns: SalBoolean.

Delete(nIndex, bRedraw)

Delete a tab at a location. Redraw is optional. Return TRUE or FALSE.

Parameter	Type	Description
nIndex	SalNumber
bRedraw	SalBoolean

Returns: SalBoolean.

DestroyPage(sTag)

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.

Parameter	Type	Description
sTag	SalString

Returns: SalBoolean.

DetachWindow(pageIndex)

Detaches a child window from the specified tab control.

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalWindowHandle.

DisablePage(pageIndex)

Disables a tab page.

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalBoolean.

DisassociateChild(pageIndex, child)

Disassociates a child with a tab page.

Parameter	Type	Description
pageIndex	SalNumber
child	Control

Returns: SalBoolean.

Enable(nIndex, bEnable)

Enable or disable a tab

Parameter	Type	Description
nIndex	SalNumber
bEnable	SalBoolean

Returns: SalBoolean.

EnablePage(pageIndex)

Enables a tab page

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalBoolean.

FindLabel(sLabel)

Find a tab give a tab label

Parameter	Type	Description
sLabel	SalString

Returns: SalNumber.

FindName(sName)

Find a tab give a tab name

Parameter	Type	Description
sName	SalString

Returns: SalNumber.

FindTabFrame(hWndForm)

Finds the tab frame window on a form or dialog box

Parameter	Type	Description
hWndForm	SalWindowHandle

Returns: SalWindowHandle.

FromHandle(hWnd)

Returns the control associated with the handle.

Parameter	Type	Description
hWnd	SalWindowHandle

Returns: SalQuickTabs.

GetActivePage()

Gets the current active tab page.

Returns: SalNumber.

GetClicked()

Get the index of the tab being clicked. This should only be called during a click notification.

Returns: SalNumber.

GetContentsBorderRect(nLeft, nTop, nRight, nBottom)

Parameter	Type	Description
nLeft	SalNumber&
nTop	SalNumber&
nRight	SalNumber&
nBottom	SalNumber&

Returns: SalBoolean.

GetContentsRect(nLeft, nTop, nRight, nBottom)

Parameter	Type	Description
nLeft	SalNumber&
nTop	SalNumber&
nRight	SalNumber&
nBottom	SalNumber&

Returns: SalBoolean.

GetContentsRectPixels(nLeftPixels, nTopPixels, nRightPixels, nBottomPixels)

Parameter	Type	Description
nLeftPixels	SalNumber&
nTopPixels	SalNumber&
nRightPixels	SalNumber&
nBottomPixels	SalNumber&

Returns: SalBoolean.

GetControlTabPages(control)

Returns the names of the tab pages that the control is associated to. The list if names is separated by a semicolon.

Parameter	Type	Description
control	Control

Returns: String.

GetCount()

Get the count of tabs

Returns: SalNumber.

GetLabel(nIndex, sLabel)

Parameter	Type	Description
nIndex	SalNumber
sLabel	SalString&

Returns: SalBoolean.

GetMarginRect(nLeft, nTop, nRight, nBottom)

Parameter	Type	Description
nLeft	SalNumber&
nTop	SalNumber&
nRight	SalNumber&
nBottom	SalNumber&

Returns: SalBoolean.

GetName(nIndex, sName)

Parameter	Type	Description
nIndex	SalNumber
sName	SalString&

Returns: SalBoolean.

GetPageIndex(pageName)

Gets the tab page index as specified by the tab name.

Parameter	Type	Description
pageName	SalString

Returns: SalNumber.

GetPageName(pageIndex)

Gets the name of the tab page (not the title that appears on the tab page at runtime).

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalString.

GetPageTitle(pageIndex)

Gets the tab page title as specified by the tab index.

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalString.

GetPageWindow(sTag)

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.

Parameter	Type	Description
sTag	SalString

Returns: SalWindowHandle.

GetPageWindow(pageIndex)

Gets the window handle of the specified tab page.

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalWindowHandle.

GetRowCount()

Retrieve the number rows of tabs

Returns: SalNumber.

GetTooltip(pageIndex, tooltip, maxLength)

Parameter	Type	Description
pageIndex	SalNumber
tooltip	SalString&
maxLength	SalNumber

Returns: SalNumber.

GetTop()

Get the index of the active tab

Returns: SalNumber.

HidePage(pageIndex)

Hides a tab page.

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalBoolean.

HideWindow(hWnd)

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.

Parameter	Type	Description
hWnd	SalWindowHandle

Returns: SalBoolean.

HideWindowAndLabel(hWnd)

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.

Parameter	Type	Description
hWnd	SalWindowHandle

Returns: SalBoolean.

IndexFromPoint(nX, nY)

Get the tab, if any, under a given point (in pixels). A negative number is returned if the point is not over a tab.

Parameter	Type	Description
nX	SalNumber
nY	SalNumber

Returns: SalNumber.

InitializeFormPages()

Generates the PAGEM_Initialize event for all forms that are bound to tab pages.

Returns: SalBoolean.

Insert(nIndex, bRedraw)

Insert a tab at a location. Redraw is optional. Return TRUE or FALSE.

Parameter	Type	Description
nIndex	SalNumber
bRedraw	SalBoolean

Returns: SalBoolean.

IsAssociatedWithTab(index, wnd)

Indicate whether a child window is associated with a tab

Parameter	Type	Description
index	SalNumber
wnd	SalWindowHandle

Returns: SalBoolean.

IsEnabled(nIndex)

Indicate whether a tab is enabled

Parameter	Type	Description
nIndex	SalNumber

Returns: SalBoolean.

IsWindowVisible(hWnd)

Returns if the specified control is considered to be visible by the tab control and will be shown when the associated tab is selected.

Parameter	Type	Description
hWnd	SalWindowHandle

Returns: SalBoolean.

Next()

Activate the next tab

Returns: SalNumber.

PageCount()

Returns the number of tab pages.

Returns: SalNumber.

Prev()

Activate the previous tab

Returns: SalNumber.

ProcessKeys(keyData)

Handles keys to change the selected tab.

Parameter	Type	Description
keyData	Keys

Returns: Boolean.

Redraw()

Arranges tabs on the frame and repaints. Call after adding tabs or clearing with a FALSE redraw flag.

Returns: SalBoolean.

ReloadTabs()

Reloads the original tabs configuration.

Returns: SalBoolean.

RemovePage(pageIndex)

Removes a tab page.

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalBoolean.

RenamePage(pageIndex, pageName)

Renames a tab page.

Parameter	Type	Description
pageIndex	SalNumber
pageName	SalString

Returns: SalBoolean.

ResizePages()

Resize all pages. Call this function to resize all form pages. The active page is resized first. The return value is TRUE or FALSE.

Returns: SalBoolean.

ResizePages(rect)

Resize all pages. Call this function to resize all form pages. The active page is resized first. The return value is TRUE or FALSE.

Parameter	Type	Description
rect	Rectangle

Returns: SalBoolean.

SendMsgToAssociated(nIndex, nMsg, wParam, lParam)

Send a message to all child windows associated with a tab

Parameter	Type	Description
nIndex	SalNumber
nMsg	SalNumber
wParam	SalNumber
lParam	SalNumber

Returns: SalBoolean.

SetActivePage(pageIndex)

Activates a tab specified by a particular tab index.

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalBoolean.

SetControlTabPages(control, tabNames)

Sets the tab pages associated to child control. The list is separated by a semicolon.

Parameter	Type	Description
control	Control
tabNames	String

SetCurrentPage(sTag)

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.

Parameter	Type	Description
sTag	SalString

Returns: SalBoolean.

SetImage(nIndex, tResource)

Sets the image to associate with the tab.

Parameter	Type	Description
nIndex	SalNumber
tResource	SalResource

Returns: SalBoolean.

SetImage(nIndex, image)

Sets the image to associate with the tab.

Parameter	Type	Description
nIndex	SalNumber
image	Image

Returns: SalBoolean.

SetImage(nIndex, icon)

Sets the icon to associate with the tab.

Parameter	Type	Description
nIndex	SalNumber
icon	Icon

Returns: SalBoolean.

SetLabel(nIndex, sLabel, bRedraw)

Set the label displayed on a tab. Redraw is optional.

Parameter	Type	Description
nIndex	SalNumber
sLabel	SalString
bRedraw	SalBoolean

Returns: SalBoolean.

SetName(nIndex, sName)

Associate a name with a tab

Parameter	Type	Description
nIndex	SalNumber
sName	SalString

Returns: SalBoolean.

SetPageSize(nLeft, nTop, nRight, nBottom, bResize)

Defines the location and size of form pages.

Parameter	Type	Description
nLeft	SalNumber
nTop	SalNumber
nRight	SalNumber
nBottom	SalNumber
bResize	SalBoolean

Returns: SalBoolean.

SetPageSize(rect, bResize)

Defines the location and size of form pages.

Parameter	Type	Description
rect	Rectangle
bResize	SalBoolean

Returns: SalBoolean.

SetPageTitle(pageIndex, pageTitle)

Sets the title of the specified tab page.

Parameter	Type	Description
pageIndex	SalNumber
pageTitle	SalString

Returns: SalBoolean.

SetTooltip(pageIndex, tooltip)

Sets the tool tip text on the specified tab page. Tool tip text appears only on tab selector, not on a tab container window.

Parameter	Type	Description
pageIndex	SalNumber
tooltip	SalString

Returns: SalBoolean.

SetWorkspaceBoundary(nMinWidth, nMinHeight)

Define the boundaries of the workspace so that a tiled-to-parent tab frame won't be resized smaller than this boundary.

Parameter	Type	Description
nMinWidth	SalNumber
nMinHeight	SalNumber

Returns: SalBoolean.

ShowPage(pageIndex)

Shows a tab page

Parameter	Type	Description
pageIndex	SalNumber

Returns: SalBoolean.

ShowSiblings()

Show or hide child windows based on the current tab

Returns: SalBoolean.

ShowWindow(hWnd)

Use this function instead of SalShowWindow because it works properly with the class function HideWindow

Parameter	Type	Description
hWnd	SalWindowHandle

Returns: SalBoolean.

ShowWindowAndLabel(hWnd)

Use this function instead of SalShowWindowAndLabel because it works properly with the class function HideWindowAndLabel.

Parameter	Type	Description
hWnd	SalWindowHandle

Returns: SalBoolean.

Update()

Updates the Tab bar after a SalTabAssociateChild or SalTabDisassociateChild is called.

Returns: SalBoolean.

Events

DrawControl

PaintEventHandler DrawControl event

DrawItem

DrawItemEventHandler DrawItem event

SelectedIndexChanged

EventHandler Fired when the selected tab has changed.

SelectedIndexChanging

TabCancelEventHandler Fired when the selected tab is about to change.

Implements

Name	Description
ISalWindow	All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.