Click or drag to resize

TabControl Class (Typed)

X#
Create a tab control.
Inheritance Hierarchy
Object
  VObject
    Control
      TextControl
        TabControl

Namespace:  XSharp.VO.SDK
Assembly:  XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21
Syntax
 CLASS TabControl INHERIT TextControl
Request Example View Source

The TabControl type exposes the following members.

Constructors
  NameDescription
Public methodTabControl
Construct a tab control.
Top
Properties
  NameDescription
Public propertyAutoSize
A logical value which lets the tab control automatically resize itself to accommodate the size of largest tab page. The default is FALSE.
Public propertyBackground
The brush used for painting the background of the control. For example, in a single line edit control, the background is the color behind the text in the edit control.
(Inherited from Control.)
Public propertyCaption
The string representing the caption of the text control.
(Inherited from TextControl.)
Public propertyContextMenu
A menu object representing the local pop-up menu for a control.
(Inherited from Control.)
Public propertyControlFont
The font used to draw the text in the control.
(Inherited from TextControl.)
Public propertyControlID
A number between 1 and 8000 representing the unique ID of a control
(Inherited from Control.)
Public propertyControlType (Overrides ControlType.)
Public propertyCurrentPage
The currently displayed tab control page.
Public propertyCurrentText
A string representing the text currently displayed in a text control. For edit controls, including the edit box associated with simple and drop-down combo boxes, it contains the text currently appearing in the edit box. For fixed icon and group box controls, TextControl:CurrentText contains NULL_STRING.
(Inherited from TextControl.)
Public propertyEventReturnValue (Inherited from Control.)
Public propertyFieldSpec (Inherited from Control.)
Public propertyHasFocus (Inherited from Control.)
Public propertyHyperLabel
The hyperlabel connected to the control.
(Inherited from Control.)
Public propertyImageList
The image list for the tab control.
Public propertyIsHidden (Inherited from Control.)
Public propertyLength
A numeric value representing the number of characters in the control.
(Inherited from TextControl.)
Public propertyModified
A logical value that is set to TRUE when a standard edit control or editable combo box is in the process of being modified.
(Inherited from Control.)
Public propertyName
A string representing the name of the control.
(Inherited from Control.)
Public propertyNameSym
A symbol representing the name of the control.
(Inherited from Control.)
Public propertyOrigin
A point representing the location of a control on its owner window, in canvas coordinates.
(Inherited from Control.)
Public propertyOwner
The owner window of a control.
(Inherited from Control.)
Public propertyOwnerAlignment
Constant representing how the window will be aligned within its owner window.
(Inherited from Control.)
Public propertyParent (Inherited from Control.)
Public propertyReadOnly
Is the control readonly ?
(Inherited from Control.)
Public propertyRowCount
A numeric value representing the number of rows of tabs currently displayed in the tab control.
Public propertySelectedTab
A symbolic name representing the currently selected tab in the tab control.
Public propertySelectedTabPage
The modeless dialog window object representing the currently selected tab page in the tab control.
Public propertyServer
The server object that currently connected to this control. If no server is connected, the value is NIL.
(Inherited from Control.)
Public propertySize
A dimension representing the size of a control.
(Inherited from Control.)
Public propertyStatus
A hyperlabel indicating the status of the control after a validation attempt or other action.
(Inherited from Control.)
Public propertySWFControl (Inherited from Control.)
Public propertyTabCount
A numeric value representing the total number of tabs in the tab control.
Public propertyTextColor
The color used to draw the text in the control. (Refer to the Color:Init() method for details on specifying a color object.)
(Inherited from TextControl.)
Public propertyTextValue
A string representing the value held in the control.
(Inherited from TextControl.)
Public propertyToolTipText
String value representing the tooltip text used when the user moves the mouse pointer over the control.
(Inherited from Control.)
Public propertyUseHLForToolTip
Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
(Inherited from Control.)
Public propertyCode exampleValue
The value held in the control, in whatever data type the control holds.
(Inherited from Control.)
Public propertyValueChanged (Inherited from Control.)
Top
Functions
  NameDescription
Public methodActivate
Provide a method that is invoked when the control has focus and a window is activated.

(Inherited from Control.)
Public methodAddChild (Inherited from Control.)
Public methodAddTipText
Add a string to be displayed as tip text for a tab.
Public methodAppendTab
Add a new tab and tab page at the end of a tab control.
Public methodAsString (Inherited from Control.)
Public methodBringToFront (Inherited from Control.)
Public methodChangeTipText
Change the current tip text for a tab.
Public methodCreate
Creates the underlying Win32 control
(Inherited from TextControl.)
Public methodCreatePageInstance
Dynamically create a tab page.
Public methodCreateWindowEx (Inherited from Control.)
Public methodDeactivate
Provide a method that is invoked when the control has focus and a window is deactivated.

(Inherited from Control.)
Public methodDefault
Call the default windows procedure for a control and set the EventReturnValue.
(Inherited from Control.)
Public methodDeleteAllTabs
Remove all the tabs and their corresponding pages in the tab control.
Public methodDeleteTab
Remove a tab and page from the tab control.
Public methodDestroy
Provide a method to de-instantiate a Tab Control object.
(Overrides Destroy.)
Public methodDisable
Disable a control (until a subsequent call to Control:Enable()).
(Inherited from Control.)
Public methodDisableTheme
Disable the WinXP theme for a control.
(Inherited from Control.)
Public methodDispatch
Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers.

(Inherited from Control.)
Public methodDrop (Inherited from Control.)
Public methodEnable
Enable a control that was previously disabled.
(Inherited from Control.)
Public methodExpose
Provide a method that is invoked when the control has focus and whenever part of the window needs repainting.

(Inherited from Control.)
Public methodFocusChange
Provide a method that is invoked when the control has focus and the input focus changes from the current control to another (or vice versa).

(Inherited from Control.)
Public methodFont
Change the current font of the text control.
(Inherited from TextControl.)
Public methodGetCaption
Public methodGetTabBoundingBox
Get the bounding box representing the area that a tab occupies.
Public methodGetTabImage
Return the current image for a tab.
Public methodGetTabPage
Retrieve a specified tab page.
Public methodGetTipText
Return the current tip text for a tab.
Public methodHandle
Return the handle for a control.
(Inherited from Control.)
Public methodHasBorder
Check if a border has been set for the control
(Inherited from Control.)
Public methodHasStyle
Check if a style value has been set for the control
(Inherited from Control.)
Public methodHide
To hide the current tab page.
(Overrides Hide.)
Public methodHorizontalScroll
Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled.

(Inherited from Control.)
Public methodIme
Return and optionally set whether Input Method Editor is enabled for this text control.
(Inherited from TextControl.)
Public methodInsertTab
Insert a new tab and tab page at a particular position in the tab control.
Public methodIsEnabled
Report if this control is currently enabled.
(Inherited from Control.)
Public methodIsReadOnly
Report if this control is currently readonly.
(Inherited from Control.)
Public methodIsVisible
Report if this control is visible (completely or partially) or hidden.
(Inherited from Control.)
Public methodKeyDown
Provide a method that is invoked when the control has focus and a key on the keyboard is pressed.

(Inherited from Control.)
Public methodKeyUp
Provide a method that is invoked when the control has focus and a key on the keyboard is released.

(Inherited from Control.)
Public methodLinkDF
Connect a control to a data field in a data server.
(Inherited from Control.)
Public methodMenuInit
Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
(Inherited from Control.)
Public methodMenuSelect
Provide a method that is invoked when an item on a menu owned by the control is highlighted.
(Inherited from Control.)
Public methodMouseButtonDoubleClick
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is double-clicked.

(Inherited from Control.)
Public methodMouseButtonDown
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is clicked.

(Inherited from Control.)
Public methodMouseButtonUp
Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is released.
(Inherited from Control.)
Public methodMouseDrag
Provide a method that is invoked when the control has focus and a mouse with one or more buttons clicked is moved in the window.
(Inherited from Control.)
Public methodMouseMove
Provide a method that is invoked when the control has focus and the mouse is moved in the control.
(Inherited from Control.)
Public methodMove
Provide a method that is invoked when the control has focus and the control is moved (either by the user or by the application).
(Overrides Move(MoveEvent).)
Public methodOnControlCreated (Overrides OnControlCreated(IVOControl).)
Public methodOnHandleCreated (Inherited from TextControl.)
Public methodOnHandleDestroyed (Inherited from TextControl.)
Public methodOverRide
This is a compatibility method that is no longer used or needed.
(Inherited from Control.)
Public methodPadTabs
Pad a tab's label and icon with empty space.
Public methodPaintBackGround (Inherited from Control.)
Public methodPerformValidations
Perform all the validations defined to this control's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
(Inherited from Control.)
Public methodRegisterTimer
Register a timer method to be invoked for the control.
(Inherited from Control.)
Public methodRemoveEditBalloonTip
Removes the current BallonTip from the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodRemoveTabImage
Remove an image from the tab control's image list.
Public methodRemoveTipText
Remove the current tip text for a tab.
Public methodRePaint
Send an ExposeEvent to repaint the control
(Inherited from Control.)
Public methodResize
Provide a method that is invoked when the control has focus and the control changes size.
(Overrides Resize(ResizeEvent).)
Public methodRestoreUpdate
Resume all drawing updates for a control (after Control:SuspendUpdate() is called).
(Inherited from Control.)
Public methodSelectTab
Select a tab and display its page.
Public methodSendToBack (Inherited from Control.)
Public methodSetCaption
Set a new caption for a tab.
Public methodSetCueBanner(String)
Add a cue banner to the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodSetCueBanner(String, IntPtr) (Inherited from TextControl.)
Public methodSetExStyle
Set the exstyle for the control.
(Inherited from Control.)
Public methodSetFocus
Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
(Inherited from Control.)
Public methodSetStyle
Set the style for the control.
(Inherited from Control.)
Public methodSetTabImage
Dynamically change the image (index) of a tab page.
Public methodSetTipText
Change the current tip text for a tab.
Public methodShowEditBalloonTip
Add a BallonTip to the Edit control that has inherited from this class.
(Inherited from TextControl.)
Public methodShowToolTip (Inherited from Control.)
Public methodSuspendUpdate
Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate().
(Inherited from Control.)
Public methodTimer
Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
(Inherited from Control.)
Public methodValidateControl
This method validates if the control has been created and when not then it triggers the control creation
(Inherited from Control.)
Public methodVerticalScroll
Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.
(Inherited from Control.)
Top
Globals and Defines
  NameDescription
Public fieldoCargo
Cargo slot.
(Inherited from VObject.)
Top
Remarks
A tab control is a control that manages multiple pages (modeless dialog windows) and can be compared to dividers in a notebook. By using a tab control, an application can define multiple pages for the same area of a dialog window or data window. Each page is displayed when the user selects the corresponding tab.
See Also