SalQuickTabs
PPJ.Runtime.Windows.QO.SalQuickTabs
Last updated
PPJ.Runtime.Windows.QO.SalQuickTabs
Last updated
Namespace: PPJ.Runtime.Windows.QO
Assembly: PPJ.Web.49 (4.9.0.0)
Tab frame window class. Instances of this class should be created as children of cQuickTabsForm objects or cQuickTabsDialog objects.
Default Constructor.
TabAlignment: Gets or sets the area of the control (for example, along the top) where the tabs are aligned.
Boolean: Returns/Sets whether the user can drag a tab to a different position. (Default: False
)
ImageList: Returns/Sets the image list to use to display images on child tabs. (Default: null
)
Size: Gets or sets the fixed size of the tab buttons. It's used when the value of SizeMode is Fixed or Center.
Orientation: Gets or sets a value indicating the horizontal or vertical orientation of the tabs.
Rectangle: Returns the display area of the tab pages.
Int32: Returns/Sets the currently selected tab. (Default: 0
)
TabPage: Returns/Sets the selected tab page.
Boolean: Shows/Hides the tab visibility menu. (Default: False
)
TabSizeMode: Gets or sets whether the tab buttons should fill the control's size, or placed in the center, or use the size set in ItemSize.
TabControl: Returns the wrapped tab control
SalTabPageCollection: Returns the collection of tab pages.
String: Initial Tab pages collection. Each tab is defined using a string property formatted as: {Name=Name0;Label=Label0;Form=FormClass0}{...} (Default: ""
)
Append a tab. Redraw is optional Return an index
bRedraw
Returns: SalNumber.
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.
sTag
sForm
hWnd
Returns: SalBoolean.
Adds a tab page at a valid index position.
pageIndex
pageName
Returns: SalBoolean.
Adds a tab page at a valid index position. You can include an image and a tooltip.
pageIndex
pageName
imageFile
tooltip
Returns: SalBoolean.
Apply changes to all pages. Call this function to cause the PAGEM_ApplyChanges message to be sent to all form pages.
Returns: SalBoolean.
Associates a child to a tab page.
pageIndex
child
Returns: SalBoolean.
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.
pageIndex
form
Returns: SalBoolean.
Activate a tab
nIndex
bRedraw
Returns: SalBoolean.
Cancel a user action. This can be called when processing a TABSM_ message.
Returns: SalBoolean.
Clear all tabs from the frame. Redraw is optional.
bRedraw
Returns: SalBoolean.
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.
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.
sTag
Returns: SalBoolean.
Delete a tab at a location. Redraw is optional. Return TRUE or FALSE.
nIndex
bRedraw
Returns: SalBoolean.
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.
sTag
Returns: SalBoolean.
Detaches a child window from the specified tab control.
pageIndex
Returns: SalWindowHandle.
Disables a tab page.
pageIndex
Returns: SalBoolean.
Disassociates a child with a tab page.
pageIndex
child
Returns: SalBoolean.
Enable or disable a tab
nIndex
bEnable
Returns: SalBoolean.
Enables a tab page
pageIndex
Returns: SalBoolean.
Find a tab give a tab label
sLabel
Returns: SalNumber.
Find a tab give a tab name
sName
Returns: SalNumber.
Finds the tab frame window on a form or dialog box
hWndForm
Returns: SalWindowHandle.
Returns the control associated with the handle.
hWnd
Returns: SalQuickTabs.
Gets the current active tab page.
Returns: SalNumber.
Get the index of the tab being clicked. This should only be called during a click notification.
Returns: SalNumber.
nLeft
nTop
nRight
nBottom
Returns: SalBoolean.
nLeft
nTop
nRight
nBottom
Returns: SalBoolean.
nLeftPixels
nTopPixels
nRightPixels
nBottomPixels
Returns: SalBoolean.
Returns the names of the tab pages that the control is associated to. The list if names is separated by a semicolon.
control
Returns: String.
Get the count of tabs
Returns: SalNumber.
nIndex
sLabel
Returns: SalBoolean.
nLeft
nTop
nRight
nBottom
Returns: SalBoolean.
nIndex
sName
Returns: SalBoolean.
Gets the tab page index as specified by the tab name.
pageName
Returns: SalNumber.
Sets the name of the tab page (not the title that appears on the tab page at runtime).
pageIndex
Returns: SalString.
Gets the tab page title as specified by the tab index.
pageIndex
Returns: SalString.
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.
sTag
Returns: SalWindowHandle.
Gets the window handle of the specified tab page.
pageIndex
Returns: SalWindowHandle.
Retrieve the number rows of tabs
Returns: SalNumber.
pageIndex
tooltip
maxLength
Returns: SalNumber.
Get the index of the active tab
Returns: SalNumber.
Hides a tab page.
pageIndex
Returns: SalBoolean.
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.
hWnd
Returns: SalBoolean.
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.
hWnd
Returns: SalBoolean.
Get the tab, if any, under a given point (in pixels). A negative number is returned if the point is not over a tab.
nX
nY
Returns: SalNumber.
Generates the PAGEM_Initialize event for all forms that are bound to tab pages.
Returns: SalBoolean.
Insert a tab at a location. Redraw is optional. Return TRUE or FALSE.
nIndex
The index where to insert the new tab page.
bRedraw
Not used.
Returns: SalBoolean.
Indicate whether a child window is associated with a tab
nIndex
hWnd
Returns: SalBoolean.
Indicate whether a tab is enabled
nIndex
Returns: SalBoolean.
Returns if the specified control is considered to be visible by the tab control and will be shown when the associated tab is selected.
hWnd
Returns: SalBoolean.
Activate the next tab
Returns: SalNumber.
Returns the number of tab pages.
Returns: SalNumber.
Activate the previous tab
Returns: SalNumber.
Arranges tabs on the frame and repaints. Call after adding tabs or clearing with a FALSE redraw flag.
Returns: SalBoolean.
Reloads the original tabs configuration.
Returns: SalBoolean.
Removes a tab page.
pageIndex
Returns: SalBoolean.
Renames a tab page.
pageIndex
pageName
Returns: SalBoolean.
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.
Resize all pages. Call this function to resize all form pages. The active page is resized first. The return value is TRUE or FALSE.
rect
Returns: SalBoolean.
Send a message to all child windows associated with a tab
nIndex
nMsg
wParam
lParam
Returns: SalBoolean.
Activates a tab specified by a particular tab index.
pageIndex
Returns: SalBoolean.
Sets the tab pages associated to child control. The list is separated by a semicolon.
control
tabNames
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.
sTag
Returns: SalBoolean.
Sets the image to associate with the tab.
nIndex
tResource
Returns: SalBoolean.
Sets the image to associate with the tab.
nIndex
image
Returns: SalBoolean.
Set the label displayed on a tab. Redraw is optional.
nIndex
sLabel
bRedraw
Returns: SalBoolean.
Associate a name with a tab
nIndex
sName
Returns: SalBoolean.
Defines the location and size of form pages.
nLeft
nTop
nRight
nBottom
bResize
Returns: SalBoolean.
Defines the location and size of form pages.
rect
bResize
Returns: SalBoolean.
Sets the title of the specified tab page.
pageIndex
pageTitle
Returns: SalBoolean.
Sets the tooltip text on the specified tab page. Tooltip text appears only on tab selector, not on a tab container window.
pageIndex
tooltip
Returns: SalBoolean.
Define the boundaries of the workspace so that a tiled-to-parent tab frame won't be resized smaller than this boundary.
nMinWidth
nMinHeight
Returns: SalBoolean.
Shows a tab page
pageIndex
Returns: SalBoolean.
Show or hide child windows based on the current tab
Returns: SalBoolean.
Use this function instead of SalShowWindow because it works properly with the class function HideWindow
hWnd
Returns: SalBoolean.
Use this function instead of SalShowWindowAndLabel because it works properly with the class function HideWindowAndLabel.
hWnd
Returns: SalBoolean.
Updates the Tab bar after a SalTabAssociateChild or SalTabDisassociateChild is called.
Returns: SalBoolean.
EventHandler Fired when the selected tab has changed.
TabCancelEventHandler Fired when the selected tab is about to change.
All Sal windows (Child windows, Forms, Dialogs and MDIs) implement this interface.