TabPanel Help File


Table of Contents

TabPanel.AddTab
TabPanel.EmbedObject
TabPanel.GetActiveTab
TabPanel.GetObjectFromPanel
TabPanel.GetPanelObjects
TabPanel.GetPos
TabPanel.GetSize
TabPanel.GetTabCount
TabPanel.GetTabData
TabPanel.GetTabExtraData
TabPanel.GetTabID
TabPanel.GetTabObjects
TabPanel.GetTabText
TabPanel.InitializePanel
TabPanel.IsEnabled
TabPanel.IsVisible
TabPanel.MoveObject
TabPanel.ObjectIsInTab
TabPanel.ObjectIsSupported
TabPanel.Refresh
TabPanel.RemoveTab
TabPanel.SetEnabled
TabPanel.SetPos
TabPanel.SetSize
TabPanel.SetTabData
TabPanel.SetTabExtraData
TabPanel.SetTabText
TabPanel.SetVisible
TabPanel.TabDoesExist

TabPanel.AddTab


(boolean) TabPanel.AddTab ( 

(string) Panel = "TabPanel1",

(string) Text = "Tab1",

(variant) Data = "",

(variant) Extra Data = "" )

Description

Adds a tab to an existing TabPanel object.

Parameters

Panel

(string) The name of the TabPanel.

Text

(string) The text to display on the tab.

Data

(variant) The data that will be associated with the tab.

Extra Data

(variant) The extra data that will be associated with the tab.


Return

This action returns a (boolean) value.



TabPanel.EmbedObject


(boolean) TabPanel.EmbedObject ( 

(string) Panel = "TabPanel1",

(variant) Tab = 4,

(string) Object = "Grid1",

(number) X = 0,

(number) Y = 0 )

Description

Embeds an object in a specific tab in TabPanel object.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab in which the object will be embedded.

Object

(string) The name of the object to embed.

X

(number) The X coordinate of the object.

Y

(number) The Y coordinate of the object.


Return

This action returns a (boolean) value.



TabPanel.GetActiveTab


(table) TabPanel.GetActiveTab ( 

(string) Panel = "TabPanel1" )

Description

Gets the active tab on the specified panel object.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action returns a (table) value.



TabPanel.GetObjectFromPanel


(string) TabPanel.GetObjectFromPanel ( 

(string) Panel = "TabPanel1" )

Description

Get the actual name of the TabPanel object.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action returns a (string) value.



TabPanel.GetPanelObjects


(table) TabPanel.GetPanelObjects ( 

(string) Panel = "TabPanel1" )

Description

Get a list of all embedded objectsin all tabs of the specified TabPanel.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action returns a (table) value.



TabPanel.GetPos


(table) TabPanel.GetPos ( 

(string) Panel = "TabPanel1" )

Description

Returns the X and Y page or dialog coordinates of a TabPanel in pixels. This coordinate refers to the upper left hand corner of the object's bounding box relative to the page or dialog.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action returns a (table) value.



TabPanel.GetSize


(table) TabPanel.GetSize ( 

(string) Panel = "TabPanel1" )

Description

Returns the pixel dimensions of a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action returns a (table) value.



TabPanel.GetTabCount


(number) TabPanel.GetTabCount ( 

(string) Panel = "TabPanel1" )

Description

Returns the number of tabs in a specific TabPanel.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action returns a (number) value.



TabPanel.GetTabData


(table) TabPanel.GetTabData ( 

(string) Panel = "TabPanel1",

(variant) Tab = 3 )

Description

Returns the item data associated to a specific tab in a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab for which to find the data.


Return

This action returns a (table) value.



TabPanel.GetTabExtraData


(table) TabPanel.GetTabExtraData ( 

(string) Panel = "TabPanel1",

(variant) Tab = 0 )

Description

Returns the item extra data associated to a specific tab in a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab for which to find the data.


Return

This action returns a (table) value.



TabPanel.GetTabID


(number) TabPanel.GetTabID ( 

(string) Panel = "TabPanel1",

(string) Tab Text = "Tab1" )

Description

Returns the ID of the selected tab in a specific TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Tab Text

(string) The text of the tab.


Return

This action returns a (number) value.



TabPanel.GetTabObjects


(table) TabPanel.GetTabObjects ( 

(string) Panel = "TabPanel1",

(variant) Tab = 0 )

Description

Get a list of all embedded objects in a specific tab of the specified TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab for which to find the embedded objects.


Return

This action returns a (table) value.



TabPanel.GetTabText


(string) TabPanel.GetTabText ( 

(string) Panel = "TabPanel1",

(number) Tab ID = 2 )

Description

Returns the tab text of a specific tab in a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Tab ID

(number) The ID of the tab.


Return

This action returns a (string) value.



TabPanel.InitializePanel


(boolean) TabPanel.InitializePanel ( 

(string) Object = "TabPanel1" )

Description

Prepares a listbox object to recieve TabPanel commands.

Parameters

Object

(string) The name of the ListBox object.


Return

This action returns a (boolean) value.



TabPanel.IsEnabled


(boolean) TabPanel.IsEnabled ( 

(string) Panel = "TabPanel1" )

Description

Returns true if a specific TabPanel is enabled, or false if it's disabled.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action returns a (boolean) value.



TabPanel.IsVisible


(boolean) TabPanel.IsVisible ( 

(string) Panel = "TabPanel1" )

Description

Returns true if a specific TabPanel is visible, and false if it isn't.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action returns a (boolean) value.



TabPanel.MoveObject


TabPanel.MoveObject ( 

(string) Panel = "TabPanel1",

(variant) Source Tab = 4,

(variant) Destination Tab = 5,

(string) Object = "Grid1",

(boolean) Refresh = false )

Description

Moves an embeddded object from one tab to a different tab.

Parameters

Panel

(string) The name of the TabPanel.

Source Tab

(variant) The tab text or ID of the tab from which the object will be moved..

Destination Tab

(variant) The tab text or ID of the tab to which the object will be moved..

Object

(string) The name of the object to be moved.

Refresh

(boolean) Whether or not to refresh the TabPanel after the action.


Return

This action dose not return any value.



TabPanel.ObjectIsInTab


(boolean) TabPanel.ObjectIsInTab ( 

(string) Panel = "TabPanel1",

(variant) Tab = 2,

(string) Object = "Grid1" )

Description

Determines whether or not an object is in the specified tab.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab in which to search for the embedded object.

Object

(string) The object for which to search.


Return

This action returns a (boolean) value.



TabPanel.ObjectIsSupported


(boolean) TabPanel.ObjectIsSupported ( 

(variant) Object = 5 )

Description

Determines whether or not a specific object or object type is supported for use in a TabPanel.

Parameters

Object

(variant) The name or type of an object.


Return

This action returns a (boolean) value.



TabPanel.Refresh


TabPanel.Refresh ( 

(string) Panel = "TabPanel1" )

Description

Refreshes the tabs in a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.


Return

This action dose not return any value.



TabPanel.RemoveTab


TabPanel.RemoveTab ( 

(string) Panel = "TabPanel1",

(variant) Tab = 3,

(number) Object Handler Code = TB_MOVE_RIGHT,

(table) Object Orders = nil,

(boolean) Refresh = true )

Description

Removes a tab from a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab which will be removed.

Object Handler Code

(number) The code that describes how to handle the object (if any) in the specified tab.

Object Orders

(table) The table containing objects and their destination details.

Refresh

(boolean) Whether or not to refresh the obejct once this action as been completed (recommended).


Return

This action dose not return any value.



TabPanel.SetEnabled


TabPanel.SetEnabled ( 

(string) Panel = "TabPanel1",

(boolean) Enable = false )

Description

Sets the enabled/disabled state of a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Enable

(boolean) Whether to make the TabPanel object enabled or disabled.


Return

This action dose not return any value.



TabPanel.SetPos


TabPanel.SetPos ( 

(string) Panel = "TabPanel1",

(number) X = 0,

(number) Y = 0 )

Description

Sets the X and Y pixel coordinates of a TabPanel relative to the page or dialog.

Parameters

Panel

(string) The name of the TabPanel.

X

(number) The new X pixel coordinate (horizontal position) to set for the TabPanel object. This is the X coordinate of the upper left hand corner of the object's bounding box relative to the page or dialog.

Y

(number) The new Y pixel coordinate (vertical position) to set for the TabPanel object. This is the Y coordinate of the upper left hand corner of the object's bounding box relative to the page or dialog.


Return

This action dose not return any value.



TabPanel.SetSize


TabPanel.SetSize ( 

(string) Panel = "TabPanel1",

(number) Width = 200,

(number) Height = 32 )

Description

Sets the size of a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Width

(number)  The new width of the TabPanel object in pixels.

Height

(number) The new height of the TabPanel object in pixels.


Return

This action dose not return any value.



TabPanel.SetTabData


(boolean) TabPanel.SetTabData ( 

(string) Panel = "TabPanel1",

(variant) Tab = 1,

(variant) Data = 4 )

Description

Set the data for the specified tab.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab for which to set the data.

Data

(variant) The data to set.


Return

This action returns a (boolean) value.



TabPanel.SetTabExtraData


(boolean) TabPanel.SetTabExtraData ( 

(string) Panel = "TabPanel1",

(variant) Tab = 1,

(variant) Extra Data = 4 )

Description

Set the extra data for the specified tab.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab for which to set the data.

Extra Data

(variant) The extra data to set.


Return

This action returns a (boolean) value.



TabPanel.SetTabText


(table) TabPanel.SetTabText ( 

(string) Panel = "TabPanel1",

(variant) Tab = 0,

(string) Text = "Tab2",

(boolean) Refresh = true )

Description

Set the title of a tab.

Parameters

Panel

(string) The name of the TabPanel

Tab

(variant) The tab text or ID of the tab which which will be renamed.

Text

(string) The new text to display in the tab.

Refresh

(boolean) Whether or not to refresh the TabPanel after the action has been completed (recommeded).


Return

This action returns a (table) value.



TabPanel.SetVisible


TabPanel.SetVisible ( 

(string) Panel = "TabPanel1",

(boolean) Visible = false )

Description

Sets the visibility of a TabPanel.

Parameters

Panel

(string) The name of the TabPanel.

Visible

(boolean) Whether to make the tabPanel object visible or invisible.


Return

This action dose not return any value.



TabPanel.TabDoesExist


(boolean) TabPanel.TabDoesExist ( 

(string) Panel = "TabPanel1",

(variant) Tab = "Tab1" )

Description

Determines whether or not the specified tab exists in the specified panel.

Parameters

Panel

(string) The name of the TabPanel.

Tab

(variant) The tab text or ID of the tab for which to search.


Return

This action returns a (boolean) value.



Made with Action Plugin Compiler