Skip to main content
A newer version of this page is available. .

XtraTabPage Class

Represents a single tab page.

Namespace: DevExpress.XtraTab

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

[Docking(DockingBehavior.Never)]
[SmartTagSupport(typeof(XtraTabPageBounds), SmartTagSupportAttribute.SmartTagCreationMode.Auto)]
[SmartTagFilter(typeof(XtraTabPageFilter))]
public class XtraTabPage :
    XtraPanel,
    IXtraTabPageExt,
    IXtraTabPage,
    IToolTipControlClient,
    IAnimatedItem,
    ISupportXtraAnimation,
    ISupportAdornerElementEx,
    ISupportAdornerElement,
    IUpdateAdornerUI

Remarks

The tab pages are used to display other controls. They provide a client area to which visual elements can be added. Each page has a header which can display an image and text. An end-user can click the page header to switch between the pages in a tab control. Note that only one tab page at a time is active.

The image below shows a tab page.

XtraTabPage

All the tab pages are stored in the tab control’s XtraTabControl.TabPages collection. Individual pages can be accessed using index notation.

The tab page’s visibility is specified by its XtraTabPage.PageVisible property. The XtraTabPage.PageEnabled property specifies whether the page can be activated. A disabled page cannot be activated by an end-user or via code, and its header is displayed grayed.

By default, the appearance of all tab pages is specified by the tab control’s XtraTabControl.AppearancePage property. Individual pages can be painted with custom appearance settings. Use the page’s XtraTabPage.Appearance property for this purpose.

Tab pages support animated images (animated GIF files). Animation starts automatically at runtime. To stop and then restart animation, use the XtraTabPage.StopAnimation and XtraTabPage.StartAnimation methods, respectively.

XtraTabPage_animate

To specify images to be displayed in tab page headers, use the XtraTabPage.Image and XtraTabPage.ImageIndex properties.

The following code snippets (auto-collected from DevExpress Examples) contain references to the XtraTabPage class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

See Also