Класс CMFCBaseTabCtrl

Статья
10/12/2023

Реализует базовую функциональность для окон с вкладками. Дополнительные сведения см. в исходном коде, расположенном в папке VC\atlmfc\src\mfc установки Visual Studio.

Синтаксис

class CMFCBaseTabCtrl : public CWnd

Участники

Открытые методы

Имя	Описание
CMFCBaseTabCtrl::AddIcon
CMFCBaseTabCtrl::AddTab	Добавляет новую вкладку в окно с вкладками.
CMFCBaseTabCtrl::ApplyRestoredTabInfo
CMFCBaseTabCtrl::AutoDestroyWindow
CMFCBaseTabCtrl::CalcRectEdit
CMFCBaseTabCtrl::CleanUp
CMFCBaseTabCtrl::ClearImageList
CMFCBaseTabCtrl::DetachTab	Отделяет вкладку от окна с вкладками.
CMFCBaseTabCtrl::EnableActivateLastActive
CMFCBaseTabCtrl::EnableAutoColor	Включает или выключает автоматическую цветовую маркировку вкладок.
CMFCBaseTabCtrl::EnableCustomToolTips	Включает или отключает настраиваемые подсказки для вкладок.
CMFCBaseTabCtrl::EnableInPlaceEdit	Включает или отключает прямое редактирование меток вкладок.
CMFCBaseTabCtrl::EnableTabDetach	Включает отделяемые вкладки.
CMFCBaseTabCtrl::EnableTabSwap	Включает или отключает возможность изменения порядка вкладок с помощью мыши.
CMFCBaseTabCtrl::EnsureVisible	Прокручивает вкладки, пока не станет видна указанная вкладка. Не действует, если указанная вкладка уже видна.
CMFCBaseTabCtrl::EnterDragMode
CMFCBaseTabCtrl::FindTargetWnd	Возвращает область, содержащую указанную точку.
CMFCBaseTabCtrl::FireChangeActiveTab
CMFCBaseTabCtrl::FireChangingActiveTab
CMFCBaseTabCtrl::GetActiveTab	Возвращает индекс активной вкладки.
CMFCBaseTabCtrl::GetActiveTabColor	Возвращает цвет фона активной вкладки.
CMFCBaseTabCtrl::GetActiveTabTextColor	Возвращает цвет текста активной вкладки.
CMFCBaseTabCtrl::GetActiveWnd	Возвращает указатель на активную страницу набора вкладок.
CMFCBaseTabCtrl::GetAutoColors	Возвращает ссылку на массив цветов, используемых для автоматической цветовой маркировки.
CMFCBaseTabCtrl::GetFirstVisibleTab	Возвращает указатель на первую видимую вкладку.
CMFCBaseTabCtrl::GetFirstVisibleTabNum
CMFCBaseTabCtrl::GetHighlightedTab	Возвращает индекс выделенной вкладки.
CMFCBaseTabCtrl::GetImageList
CMFCBaseTabCtrl::GetImageSize
CMFCBaseTabCtrl::GetLastVisibleTab
CMFCBaseTabCtrl::GetLocation	Возвращает переменную типа LOCATION, указывающую положение области вкладок по отношению к элементу управления вкладки (например, сверху или снизу).
CMFCBaseTabCtrl::GetMaxWindowSize
CMFCBaseTabCtrl::GetTabArea	Возвращает размер и положение области вкладок в окне с вкладками. Положение области вкладок определяется по координатам.
CMFCBaseTabCtrl::GetTabBkColor	Возвращает цвет фона указанной вкладки.
CMFCBaseTabCtrl::GetTabBorderSize	Возвращает размер границ вкладки в наборе вкладок.
CMFCBaseTabCtrl::GetTabByID	Возвращает индекс вкладки, определяемой по указанному идентификатору.
CMFCBaseTabCtrl::GetTabCloseButton
CMFCBaseTabCtrl::GetTabFromHwnd	Возвращает индекс вкладки, содержащей указанный объект HWND.
CMFCBaseTabCtrl::GetTabFromPoint	Возвращает вкладку, содержащую указанную точку.
CMFCBaseTabCtrl::GetTabFullWidth
CMFCBaseTabCtrl::GetTabHicon	Возвращает значок, связанный с указанной вкладкой.
CMFCBaseTabCtrl::GetTabID	Возвращает идентификатор вкладки по ее индексу.
CMFCBaseTabCtrl::GetTabIcon	Возвращает идентификатор значка указанной вкладки.
CMFCBaseTabCtrl::GetTabLabel	Возвращает текст указанной вкладки.
CMFCBaseTabCtrl::GetTabRect	Извлекает размер и положение указанной вкладки.
CMFCBaseTabCtrl::GetTabsHeight
CMFCBaseTabCtrl::GetTabsRect
CMFCBaseTabCtrl::GetTabTextColor	Возвращает цвет текста указанной вкладки.
CMFCBaseTabCtrl::GetTabWnd	Возвращает указатель в область, расположенную на указанной странице вкладки.
CMFCBaseTabCtrl::GetTabWndNoWrapper	Возвращает прямой указатель на элемент управления, находящийся на указанной странице вкладки, даже если у этого элемента управления имеется оболочка.
CMFCBaseTabCtrl::GetTabsNum	Возвращает количество вкладок, входящих в набор вкладок.
CMFCBaseTabCtrl::GetToolTipCtrl	Возвращает ссылку на элемент управления ToolTip, связанный с объектом `CMFCBaseTabCtrl` .
CMFCBaseTabCtrl::GetVisibleTabsNum	Возвращает количество видимых вкладок.
CMFCBaseTabCtrl::HasImage
CMFCBaseTabCtrl::HideSingleTab	Задает параметр, скрывающий вкладку окна, но только в случае, если в окне с вкладками отображается лишь одна видимая вкладка.
CMFCBaseTabCtrl::InsertTab	Вставляет новую вкладку.
CMFCBaseTabCtrl::InvalidateTab
CMFCBaseTabCtrl::IsActiveTabCloseButton
CMFCBaseTabCtrl::IsAutoColor	Возвращает значение, указывающее, включена ли для окна с вкладками автоматическая цветовая маркировка.
CMFCBaseTabCtrl::IsAutoDestroyWindow
CMFCBaseTabCtrl::IsColored
CMFCBaseTabCtrl::IsDialogControl
CMFCBaseTabCtrl::IsDrawNoPrefix
CMFCBaseTabCtrl::IsFlatFrame	Возвращает значение, указывающее, является фрейм области вкладок плоским или трехмерным.
CMFCBaseTabCtrl::IsFlatTab
CMFCBaseTabCtrl::IsHideSingleTab	Возвращает значение, указывающее, будет ли скрыта метка вкладки, если в окне с вкладками отображается лишь одна вкладка.
CMFCBaseTabCtrl::IsIconAdded
CMFCBaseTabCtrl::IsInPlaceEdit	Указывает, могут ли пользователи изменять метку вкладки.
CMFCBaseTabCtrl::IsLeftRightRounded
CMFCBaseTabCtrl::IsMDITab
CMFCBaseTabCtrl::IsOneNoteStyle	Указывает, отображаются ли вкладки в окне в стиле Microsoft OneNote.
CMFCBaseTabCtrl::IsPtInTabArea	Проверяет, существует ли в области вкладок указанная точка.
CMFCBaseTabCtrl::IsTabCloseButtonHighlighted
CMFCBaseTabCtrl::IsTabCloseButtonPressed
CMFCBaseTabCtrl::IsTabDetachable	Указывает, является ли вкладка отделяемой.
CMFCBaseTabCtrl::IsTabIconOnly	Указывает, отображаются ли для вкладок значки, а не метки.
CMFCBaseTabCtrl::IsTabSwapEnabled	Указывает, может ли пользователь менять положение вкладок путем их перетаскивания.
CMFCBaseTabCtrl::IsTabVisible	Указывает, является ли указанная вкладка видимой.
CMFCBaseTabCtrl::IsVS2005Style
CMFCBaseTabCtrl::MoveTab
CMFCBaseTabCtrl::OnChangeTabs	Вызывается платформой при изменении количества вкладок.
CMFCBaseTabCtrl::OnDragEnter
CMFCBaseTabCtrl::OnDragLeave
CMFCBaseTabCtrl::OnDragOver
CMFCBaseTabCtrl::OnDrop
CMFCBaseTabCtrl::OnRenameTab
CMFCBaseTabCtrl::PreTranslateMessage	Используется классом CWinApp для преобразования сообщений окна перед их передачей функциям Windows TranslateMessage и DispatchMessage . (Переопределяет CWnd::PreTranslateMessage.)
CMFCBaseTabCtrl::RecalcLayout	Повторно вычисляет внутренний макет окна с вкладками.
CMFCBaseTabCtrl::RemoveAllTabs	Удаляет все вкладки из окна.
CMFCBaseTabCtrl::RemoveTab	Удаляет вкладку из окна.
CMFCBaseTabCtrl::RenameTab
CMFCBaseTabCtrl::ResetImageList	Сбрасывает список изображений, прикрепленный к окну с вкладками.
CMFCBaseTabCtrl::Serialize	Считывает этот объект из архива или записывает в него. (Переопределяет CObject::Serialize.)
CMFCBaseTabCtrl::SetActiveTab	Активирует вкладку.
CMFCBaseTabCtrl::SetActiveTabColor	Задает цвет фона для активной вкладки.
CMFCBaseTabCtrl::SetActiveTabTextColor	Задает цвет текста для активных вкладок.
CMFCBaseTabCtrl::SetAutoColors	Задает для набора вкладок цвета, используемые в режиме автоматической цветовой маркировки.
CMFCBaseTabCtrl::SetDockingBarWrapperRTC	Задает класс-оболочку, который используется для любых объектов, не являющихся производными от CDockablePane Class.
CMFCBaseTabCtrl::SetDrawNoPrefix	Включает и отключает обработку символов префикса при отрисовке подписей вкладок.
CMFCBaseTabCtrl::SetImageList	Задает список изображений значка.
CMFCBaseTabCtrl::SetLocation
CMFCBaseTabCtrl::SetTabBkColor	Задает цвет фона для указанной вкладки.
CMFCBaseTabCtrl::SetTabBorderSize	Задает размер границ новой вкладки.
CMFCBaseTabCtrl::SetTabHicon	Задает значок вкладки.
CMFCBaseTabCtrl::SetTabIcon	Задает идентификатор значка вкладки.
CMFCBaseTabCtrl::SetTabIconOnly	Включает и отключает режим "только значок" для указанной вкладки.
CMFCBaseTabCtrl::SetTabLabel	Задает метку вкладки, аналогичную значению указанной строки.
CMFCBaseTabCtrl::SetTabsHeight
CMFCBaseTabCtrl::SetTabTextColor	Задает цвет текста для указанной вкладки.
CMFCBaseTabCtrl::SetTabsOrder	Располагает вкладки в указанном порядке.
CMFCBaseTabCtrl::ShowTab	Отображает или скрывает указанную вкладку.
CMFCBaseTabCtrl::StartRenameTab
CMFCBaseTabCtrl::SwapTabs

Защищенные методы

Имя Описание

CMFCBaseTabCtrl::CreateWrapper Создает оболочку для объекта, производного от класса CWnd и не являющегося производным от CDockablePane. Чтобы закрепить объект CMFCBaseTabCtrl , каждый внедренный элемент управления должен иметь закрепляющую оболочку или быть производным от CDockablePane.

Класс оболочки задается с помощью SetDockingBayWrapperRTC.

Имя	Описание
CMFCBaseTabCtrl::CreateWrapper	Создает оболочку для объекта, производного от класса CWnd и не являющегося производным от `CDockablePane`. Чтобы закрепить объект `CMFCBaseTabCtrl` , каждый внедренный элемент управления должен иметь закрепляющую оболочку или быть производным от `CDockablePane`. Класс оболочки задается с помощью `SetDockingBayWrapperRTC`.

Элементы данных

Имя	Описание
CMFCBaseTabCtrl::m_bActivateTabOnRightClick	Указывает, выбираются вкладки щелчком левой или правой кнопкой мыши.
CMFCBaseTabCtrl::m_bAutoDestroyWindow	Указывает, будут ли автоматически уничтожаться области, входящие во вкладки.

Замечания

Класс CMFCBaseTabCtrl представляет собой абстрактный класс. Это означает, что нельзя создать его экземпляр. Чтобы создать окно с вкладками, необходимо создать класс, производный от класса CMFCBaseTabCtrl. Библиотека MFC содержит несколько примеров производных классов, два из которых — CMFCTabCtrl Class и CMFCOutlookBarTabCtrl Class.

Начиная с Visual Studio 2015, этот класс поддерживает Microsoft Active Accessibility.

Советы по настройке

Следующие советы относятся к классу CMFCBaseTabCtrl Class и всем классам, наследующим от него.

При включении отделяемых вкладок не следует оставлять указатели на окна с вкладками. Эти отделяемые вкладки могут динамически создаваться и уничтожаться, поэтому указатели могут стать недействительными.
Вы можете настроить набор вкладок, чтобы пользователи получили возможность динамического перемещения входящих в него вкладок с помощью мыши. Эта функция входит в класс CMFCBaseTabCtrl . Чтобы включить ее, вызовите CMFCBaseTabCtrl::EnableTabSwap.
По умолчанию в набор вкладок добавляются отделяемые вкладки. Также с помощью метода CMFCBaseTabCtrl::AddTabможно создавать неотделяемые вкладки. Если в качестве значения параметра bDetachable выбрать FALSE, соответствующая вкладка будет неотделяемой. Кроме того, вы можете изменить состояние вкладок (отсоединяемые или нет), вызвав метод CMFCBaseTabCtrl::EnableTabDetach.
Объекты, производные от класса CWnd, можно поместить на закрепленную панель управления или на вкладку с закреплением. Чтобы весь элемент управления был закреплен, необходимо сделать CWnd объект закрепления. Для этого MFC использует класс-оболочку. Этот класс-оболочка — CDockablePaneAdapter Class. Любые объекты CWnd , добавляемые на закрепляемую панель управления или закрепляемую вкладку, будут помещены в оболочку в объекте CDockablePaneAdapter . Автоматическое помещение в оболочку можно отключить, установив для параметра m_bEnableWrapping объекта CMFCBaseTablCtrl значение FALSE. С помощью метода CMFCBaseTabCtrl::SetDockingBarWrapperRTCвы также можете изменить класс, используемый приложением в качестве оболочки.

Иерархия наследования

Требования

Заголовок: afxbasetabctrl.h

CMFCBaseTabCtrl::AddIcon

Добавляет значок в список значков в защищенном элементе CMap m_mapAddedIcons.

void AddIcon(
    HICON hIcon,
    int iIcon);

Параметры

hIcon
[in] Дескриптор значка, который нужно добавить.

iIcon
[in] Отсчитываемый от нуля индекс значка в защищенном элементе CImageList m_Images.

Замечания

CMFCBaseTabCtrl::AddTab

Добавляет новую вкладку в набор вкладок.

virtual void AddTab(
    CWnd* pTabWnd,
    LPCTSTR lpszTabLabel,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

virtual void AddTab(
    CWnd* pTabWnd,
    UINT uiResTabLabel,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

Параметры

pTabWnd
[in] Указатель на окно, которое этот метод представляет в виде новой вкладки.

lpszTabLabel
[in] Строка, содержащая метку новой вкладки.

uiImageId
[in] Идентификатор изображения из списка изображений. Набор вкладок использует это изображение в качестве значка для новой вкладки.

uiResTabLabel
[in] Идентификатор ресурса для метки.

bDetachable
[in] Логический параметр, который определяет, является ли новая вкладка отделяемой.

Замечания

Если pTabWnd указывает на объект, который не является производным от класса CDockablePane, и если параметр bDetachable имеет значение TRUE, платформа автоматически создает оболочку для объекта pTabWnd. Наличие оболочки делает объект pTabWnd отделяемым. По умолчанию оболочка — это экземпляр класса CDockablePaneAdapter. Если функциональность, предлагаемая оболочкой по умолчанию, неприемлема, укажите другую оболочку, используя метод CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

CMFCBaseTabCtrl::ApplyRestoredTabInfo

virtual void ApplyRestoredTabInfo(BOOL bUseTabIndexes = FALSE);

Параметры

[in] bUseTabIndexes

Замечания

CMFCBaseTabCtrl::AutoDestroyWindow

void AutoDestroyWindow(BOOL bAutoDestroy = TRUE);

Параметры

[in] bAutoDestroy

Замечания

CMFCBaseTabCtrl::CalcRectEdit

virtual void CalcRectEdit(CRect& rectEdit);

Параметры

[in] rectEdit

Замечания

CMFCBaseTabCtrl::CleanUp

virtual void CleanUp();

Замечания

CMFCBaseTabCtrl::ClearImageList

virtual void ClearImageList();

Замечания

CMFCBaseTabCtrl::CreateWrapper

Создает оболочку для окна области, которое является производным от класса CWnd, но не от класса CDockablePane.

virtual CWnd* CreateWrapper(
    CWnd* pWndToWrap,
    LPCTSTR lpszTabLabel,
    BOOL bDetachable);

Параметры

pWndToWrap
[in] Указатель на окно области с оболочкой.

lpszTabLabel
[in] Строка, содержащая метку окна.

bDetachable
[in] Логический параметр, который указывает, является ли окно отделяемым.

Возвращаемое значение

Указатель на оболочку, производную от класса CDockablePane, если метод CreateWrapper успешно создает класс-оболочку для pWndToWrap. Если метод завершается ошибкой, он возвращает pWndToWrap.

Замечания

В окне с вкладками можно закрепить любой объект, производный от CWnd. Однако чтобы объект CMFCBaseTabCtrl Class можно было закрепить, каждый объект в CMFCBaseTabCtrl должен быть отделяемым. Таким образом, CMFCBaseTabCtrl автоматически создает оболочки для всех объектов, которые не являются производными от CDockablePane.

По умолчанию CMFCBaseTabCtrl создает экземпляры класса CDockablePaneAdapter. Чтобы изменить класс оболочки по умолчанию, вызовите CMFCBaseTabCtrl::SetDockingBarWrapperRTC.

Если pWndToWrap является производным от CDockablePane, этот метод не создаст оболочку. Вместо этого он завершится ошибкой и вернет pWndToWrap.

CMFCBaseTabCtrl::DetachTab

Платформа вызывает этот метод, чтобы отделить вкладку от набора вкладок.

virtual BOOL DetachTab(
    AFX_DOCK_METHOD dockMethod,
    int nTabNum = -1,
    BOOL bHide = FALSE);

Параметры

dockMethod
[in] Перечислимый тип данных, предоставляемый классом CBasePane. Этот тип данных определяет метод, который был использован для отделения вкладки.

nTabNum
[in] Отсчитываемый от нуля индекс отделяемой вкладки.

bHide
[in] Логический параметр, который указывает, следует ли платформе скрыть отделенную вкладку.

Возвращаемое значение

Имеет ненулевое значение в случае успешного выполнения, иначе — 0.

Замечания

Если вкладка, заданная nTabNum, не является отделяемой, эта функция завершается ошибкой и возвращает значение FALSE.

CMFCBaseTabCtrl::EnableActivateLastActive

void EnableActivateLastActive(BOOL bLastActive = TRUE);

Параметры

[in] bLastActive

Замечания

CMFCBaseTabCtrl::EnableAutoColor

Контролирует, использует ли платформа автоматические цвета фона при рисовании вкладки.

void EnableAutoColor(BOOL bEnable = TRUE);

Параметры

bEnable
[in] Логический параметр, который определяет, использует ли платформа автоматические цвета.

Замечания

Набор вкладок содержит массив из нескольких стандартных цветов. Когда платформа использует автоматические цвета, каждой вкладке в наборе назначается следующий цвет из этого массива.

По умолчанию автоматические цвета определяются цветами, определенными библиотекой. Можно указать пользовательский массив цветов, вызвав метод CMFCBaseTabCtrl::SetAutoColors.

CMFCBaseTabCtrl::EnableCustomToolTips

Включает пользовательские подсказки для набора вкладок.

BOOL EnableCustomToolTips(BOOL bEnable = TRUE);

Параметры

bEnable
[in] Логический параметр, определяющий, следует ли использовать пользовательские подсказки.

Возвращаемое значение

Значение TRUE, если успешно; в противном случае — FALSE.

Замечания

Если пользовательские подсказки включены, набор вкладок отправляет сообщение AFX_WM_ON_GET_TAB_TOOLTIP в главную область. Если вы хотите поддерживать пользовательские подсказки в приложении, окно основной области должно обрабатывать этот метод и предоставлять текст такой подсказки. Дополнительные сведения о предоставлении текста пользовательской подсказки см. в статье о структуре CMFCTabToolTipInfo.

CMFCBaseTabCtrl::EnableInPlaceEdit

Включает прямое редактирование меток вкладок пользователем.

virtual void EnableInPlaceEdit(BOOL bEnable) = 0;

Параметры

bEnable
[in] Логический параметр, который указывает, следует ли включить прямое редактирование меток вкладок.

Замечания

По умолчанию прямое редактирование меток вкладок отключено для наборов вкладок.

Вы можете включить прямое редактирование для подмножества вкладок в наборе вкладок. Чтобы сделать это, переопределите метод CMFCBaseTabCtrl::StartRenameTab. StartRenameTab должен возвращать ненулевое значение для всех вкладок, которые поддерживают прямое редактирование меток вкладок.

В классе CMFCBaseTabCtrl (CMFCBaseTabCtrl Class) этот метод является чистой виртуальной функцией и не имеет реализации. Если вы наследуете класс от CMFCBaseTabCtrl, необходимо реализовать эту функцию.

CMFCBaseTabCtrl::EnableTabDetach

Включает отделяемые вкладки.

virtual BOOL EnableTabDetach(
    int iTab,
    BOOL bEnable);

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

bEnable
[in] Логический параметр, указывающий, будет ли вкладка отделяемой.

Возвращаемое значение

Значение TRUE, если успешно; в противном случае — FALSE.

CMFCBaseTabCtrl::EnableTabSwap

Позволяет пользователю изменить порядок вкладок с помощью мыши.

void EnableTabSwap(BOOL bEnable);

Параметры

bEnable
[in] Логический параметр, указывающий, следует ли включить смену вкладок.

Замечания

Когда смена вкладок включена, пользователь может перетащить вкладку и изменить ее относительное положение в наборе вкладок.

CMFCBaseTabCtrl::EnsureVisible

Прокручивает вкладки, пока не станет видна указанная вкладка.

virtual BOOL EnsureVisible(int iTab);

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

Имеет ненулевое значение в случае успешного выполнения, иначе — 0.

Замечания

Этот метод не действует, если вкладка, обозначенная iTab, уже видна.

CMFCBaseTabCtrl Class не поддерживает этот метод по умолчанию. Вы должны реализовать эту функцию в пользовательском классе, производном от CMFCBaseTabCtrl, если этот пользовательский набор вкладок поддерживает прокрутку. Этот метод поддерживается классом CMFCTabCtrl.

CMFCBaseTabCtrl::EnterDragMode

void EnterDragMode();

Замечания

CMFCBaseTabCtrl::FindTargetWnd

Определяет область, которая содержит указанную точку.

virtual CWnd* FindTargetWnd(const CPoint& pt) = 0;

Параметры

пт
[in] Точка, определенная с помощью координат клиентской области объекта CMFCBaseTabCtrl.

Возвращаемое значение

Указатель на объект CWnd в случае успешного выполнения. В противном случае — значение NULL.

Замечания

В классе CMFCBaseTabCtrl этот метод является чистой виртуальной функцией: вы должны реализовать его, если класс является производным от CMFCBaseTabCtrl.

CMFCBaseTabCtrl::FireChangeActiveTab

virtual void FireChangeActiveTab(int nNewTab);

Параметры

[in] nNewTab

Замечания

CMFCBaseTabCtrl::FireChangingActiveTab

virtual BOOL FireChangingActiveTab(int nNewTab);

Параметры

[in] nNewTab

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetActiveTab

Извлекает индекс активной вкладки.

virtual int GetActiveTab() const;

Возвращаемое значение

Отсчитываемый от нуля индекс активной вкладки. Значение -1, если активной вкладки нет.

CMFCBaseTabCtrl::GetActiveTabColor

Получает цвет фона активной вкладки.

virtual COLORREF GetActiveTabColor() const;

Возвращаемое значение

Значение COLORREF, указывающее цвет фона активной вкладки.

Замечания

По умолчанию цвет фона активной вкладки — COLOR_WINDOW. Цвет фона активной вкладки можно изменить с помощью метода CMFCBaseTabCtrl::SetActiveTabColor.

CMFCBaseTabCtrl::GetActiveTabTextColor

Извлекает цвет текста для активной вкладки.

virtual COLORREF GetActiveTabTextColor() const;

Возвращаемое значение

Значение COLORREF, задающее цвет текста активной вкладки.

Замечания

По умолчанию цветом текста для активных вкладок является COLOR_WINDOWTEXT. Цвет текста можно изменить с помощью метода CMFCBaseTabCtrl::SetActiveTabTextColor.

CMFCBaseTabCtrl::GetActiveWnd

Получает указатель на текущее активное окно вкладки.

virtual CWnd* GetActiveWnd() const;

Возвращаемое значение

Указатель на окно.

CMFCBaseTabCtrl::GetAutoColors

Извлекает массив цветов, используемых для автоматической цветовой маркировки.

const CArray<COLORREF,COLORREF>& GetAutoColors() const;

Возвращаемое значение

Ссылка на массив значений COLORREF, который используется объектом CMFCBaseTabCtrl для автоматической цветовой маркировки вкладок.

Замечания

По умолчанию платформа инициализирует массив цветов в соответствии с определяемыми библиотекой цветами. Можно указать пользовательский массив цветов, вызвав метод CMFCBaseTabCtrl::SetAutoColors.

CMFCBaseTabCtrl::GetFirstVisibleTab

Возвращает указатель на первую видимую вкладку.

virtual CWnd* GetFirstVisibleTab(int& iTabNum);

virtual CWnd* GetFirstVisibleTab(
    int iStartFrom,
    int& iTabNum);

Параметры

iTabNum
[out] Ссылка на целое число. Этот метод записывает в этот параметр отсчитываемый от нуля индекс первой видимой вкладки.

iStartFrom
[in] Отсчитываемый от нуля индекс первой проверяемой вкладки.

Возвращаемое значение

Указатель на первую видимую вкладку в случае успешного выполнения. В противном случае — значение NULL.

Замечания

Если этот метод завершается ошибкой, он записывает значение -1 для iStartFrom.

Если значение iStartFrom больше или равно числу вкладок в наборе вкладок, GetFirstVisibleTab автоматически завершается сбоем.

CMFCBaseTabCtrl::GetFirstVisibleTabNum

virtual int GetFirstVisibleTabNum() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetHighlightedTab

Извлекает индекс выделенной вкладки.

int GetHighlightedTab() const;

Возвращаемое значение

Отсчитываемый от нуля индекс выделенной вкладки.

CMFCBaseTabCtrl::GetImageList

virtual const CImageList* GetImageList() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetImageSize

virtual CSize GetImageSize() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetLastVisibleTab

virtual CWnd* GetLastVisibleTab(int& iTabNum);

Параметры

[in] iTabNum

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetLocation

Извлекает расположение части области вкладки набора вкладок.

Location GetLocation() const;

Возвращаемое значение

Расположение области вкладки.

Замечания

Возможные значения расположения области вкладки: LOCATION_BOTTOM и LOCATION_TOP.

CMFCBaseTabCtrl::GetMaxWindowSize

virtual CSize GetMaxWindowSize() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetTabArea

Извлекает размер и положение области вкладки набора вкладок.

virtual void GetTabArea(
    CRect& rectTabAreaTop,
    CRect& rectTabAreaBottom) const = 0;

Параметры

rectTabAreaTop
[in] Ссылка на объект CRect. Метод GetTabArea использует этот объект для хранения размера и положения верхней области вкладок.

rectTabAreaBottom
[in] Ссылка на объект CRect. GetTabArea использует этот объект для хранения размера и положения нижней области вкладки.

Замечания

После возвращения метода GetTabArea параметры CRect содержат размер и положение области вкладки в клиентских координатах набора вкладок. Если в верхней или нижней части набора вкладок нет области вкладки, параметры rectTabAreaTop или rectTabAreaBottom пусты.

CMFCBaseTabCtrl::GetTabBkColor

Извлекает цвет фона указанной вкладки.

virtual COLORREF GetTabBkColor(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

Значение COLORREF, которое указывает цвет фона заданной вкладки. Значение -1, если iTab выходит за пределы диапазона.

CMFCBaseTabCtrl::GetTabBorderSize

Извлекает размер границ вкладки в наборе вкладок.

virtual int GetTabBorderSize() const;

Возвращаемое значение

Размер границы вкладки в пикселях.

Замечания

Размер по умолчанию границы вкладки равен трем пикселям. Вы можете изменить этот размер границы с помощью метода CMFCBaseTabCtrl:: SetTabBorderSize.

CMFCBaseTabCtrl::GetTabByID

Извлекает индекс вкладки на основе ее идентификатора.

virtual int GetTabByID(int id) const;

Параметры

id
[in] Идентификатор вкладки.

Возвращаемое значение

Отсчитываемый от нуля индекс вкладки, если он найден. Значение -1, если идентификатор вкладки не найден.

Замечания

Идентификаторы вкладок назначаются автоматически, когда вкладки добавляются в набор вкладок.

CMFCBaseTabCtrl::GetTabCloseButton

CRect GetTabCloseButton() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetTabFromHwnd

Извлекает индекс вкладки, содержащей указанный объект HWND.

virtual int GetTabFromHwnd(HWND hwnd) const;

Параметры

hwnd
[in] Дескриптор окна.

Возвращаемое значение

Отсчитываемый от нуля индекс вкладки в случае успешного выполнения. Значение -1, если ни одна вкладка не содержит hwnd.

CMFCBaseTabCtrl::GetTabFromPoint

Извлекает вкладку, содержащую указанную точку.

virtual int GetTabFromPoint(CPoint& pt) const;

Параметры

пт
[in] Точка в клиентских координатах набора вкладок.

Возвращаемое значение

Индекс вкладки, которая содержит pt. Значение -1, если нет вкладки, содержащей pt.

CMFCBaseTabCtrl::GetTabFullWidth

virtual int GetTabFullWidth(int iTab) const;

Параметры

[in] iTab

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetTabHicon

Возвращает дескриптор HICON, связанный с указанной вкладкой.

virtual HICON GetTabHicon(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

В случае успешного выполнения — HICON, связанный с меткой вкладки. NULL, если HICON отсутствует или если метод завершается ошибкой.

CMFCBaseTabCtrl::GetTabIcon

Извлекает значок, связанный с указанной вкладкой.

virtual UINT GetTabIcon(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

Идентификатор значка указанной вкладки в случае успешного выполнения. Значение -1, если индекс является недопустимым.

Замечания

Объект CMFCBaseTabCtrl сохраняет значки во внутреннем объекте CImageList.

CMFCBaseTabCtrl::GetTabID

Извлекает идентификатор вкладки, заданный ее индексом.

int GetTabID(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

Идентификатор вкладки или значение -1, если iTab выходит за пределы диапазона.

CMFCBaseTabCtrl::GetTabLabel

Извлекает текст метки вкладки.

virtual BOOL GetTabLabel(
    int iTab,
    CString& strLabel) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

strLabel
[out] Ссылка на объект CString. Этот метод сохраняет метку вкладки в этом параметре.

Возвращаемое значение

Значение TRUE в случае успешного выполнения. В противном случае — значение FALSE.

Замечания

Этот метод завершается ошибкой, если индекс iTab является недопустимым.

Метка для вкладки настраивается при создании вкладки с помощью метода CMFCBaseTabCtrl::AddTab. Можно также изменить созданную метку с помощью метода CMFCBaseTabCtrl::SetTabLabel.

CMFCBaseTabCtrl::GetTabRect

Извлекает размер и положение указанной вкладки.

virtual BOOL GetTabRect(
    int iTab,
    CRect& rect) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

rect
[out] Ссылка на объект CRect. Этот метод сохраняет размер и положение вкладки в этом параметре.

Возвращаемое значение

Значение TRUE в случае успешного выполнения. Значение FALSE, если индекс вкладки является недопустимым.

CMFCBaseTabCtrl::GetTabsHeight

virtual int GetTabsHeight() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetTabsNum

Извлекает число вкладок в наборе вкладок.

virtual int GetTabsNum() const;

Возвращаемое значение

Число вкладок в наборе вкладок.

CMFCBaseTabCtrl::GetTabsRect

virtual void GetTabsRect(CRect& rect) const;

Параметры

[in] rect

Замечания

CMFCBaseTabCtrl::GetTabTextColor

Извлекает цвет текста для указанной вкладки.

virtual COLORREF GetTabTextColor(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

Параметр COLORREF, который указывает цвет текста указанной вкладки. Значение -1, если iTab выходит за пределы диапазона.

CMFCBaseTabCtrl::GetTabWnd

Возвращает указатель на область, расположенную на указанной вкладке.

virtual CWnd* GetTabWnd(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

Указатель на объект CWnd, который находится на вкладке, которую указывает iTab. Значение NULL, если значение iTab является недопустимым.

Замечания

Возвращаемый объект — это тот, который приложение добавило при вызове метода CMFCBaseTabCtrl::AddTab или CMFCBaseTabCtrl::InsertTab.

Если у объекта на вкладке есть оболочка, этот метод вернет ее. Дополнительные сведения об оболочках см. в разделе о CMFCBaseTabCtrl::CreateWrapper. Если вы хотите получить доступ к указателю на прямой объект без оболочки, используйте метод CMFCBaseTabCtrl::GetTabWndNoWrapper.

CMFCBaseTabCtrl::GetTabWndNoWrapper

Возвращает указатель на элемент управления, находящийся на вкладке, даже если у этого элемента управления есть оболочка.

virtual CWnd* GetTabWndNoWrapper(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

Указатель на объект CWnd, который находится на указанной вкладке. NULL, если значение iTab недопустимо.

Замечания

Этот метод получает прямой указатель на объект CWnd, добавленный с помощью метода CMFCBaseTabCtrl::AddTab или CMFCBaseTabCtrl::InsertTab. GetTabWndNoWrapper будет получать указатель на добавленный объект CWnd, даже если платформа добавила оболочку для объекта. Дополнительные сведения об оболочках и классе CMFCBaseTabCtrl см. в разделе CMFCBaseTabCtrl::CreateWrapper.

Используйте метод CMFCBaseTabCtrl::GetTabWnd, если вы не хотите игнорировать класс-оболочку.

CMFCBaseTabCtrl::GetToolTipCtrl

Получает ссылку на элемент управления "Подсказка".

CToolTipCtrl& GetToolTipCtrl() const;

Возвращаемое значение

Ссылка на элемент управления "Подсказка".

CMFCBaseTabCtrl::GetVisibleTabsNum

Получает количество видимых вкладок.

virtual int GetVisibleTabsNum() const;

Возвращаемое значение

Количество видимых вкладок.

CMFCBaseTabCtrl::HasImage

virtual BOOL HasImage(int iTab) const;

Параметры

[in] iTab

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::HideSingleTab

Задает параметр, чтобы скрыть вкладки из набора вкладок, если есть одна видимая вкладка.

virtual void HideSingleTab(BOOL bHide = TRUE);

Параметры

bHide
[in] Логический параметр, указывающий, следует ли включить скрытие отдельных вкладок.

Замечания

Если приложение настроено на скрытие отдельных вкладок, платформа автоматически отображает вкладки, когда вторая вкладка добавляется в набор вкладок.

CMFCBaseTabCtrl::InsertTab

Вставляет вкладку в набор вкладок.

Virtual void InsertTab(
    CWnd* pNewWnd,
    LPCTSTR lpszTabLabel,
    int nInsertAt,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

virtual void InsertTab(
    CWnd* pNewWnd,
    UINT uiResTabLabel,
    int nInsertAt,
    UINT uiImageId = (UINT)-1,
    BOOL bDetachable = TRUE);

Параметры

pNewWnd
[in] Указатель на окно, которое этот метод добавляет в виде новой вкладки.

lpszTabLabel
[in] Строка, содержащая метку новой вкладки.

nInsertAt
[in] Отсчитываемый от нуля индекс новой вкладки.

bDetachable
[in] Логический параметр, который определяет, является ли новая вкладка отделяемой.

uiResTabLabel
[in] Идентификатор ресурса для метки.

Замечания

Если объект, указанный pNewWnd , не является производным от класса CDockablePane и если параметр bDetachable имеет значение TRUE, платформа создает специальную оболочку для новой вкладки. По умолчанию оболочка является экземпляром класса CDockablePaneAdapter. Используйте метод CMFCBaseTabCtrl::SetDockingBarWrapperRTC, чтобы создать другой класс-оболочку. Любой пользовательский класс-оболочка должен быть производным от CDockablePaneAdapter.

CMFCBaseTabCtrl::InvalidateTab

void InvalidateTab(int iTab);

Параметры

[in] iTab

Замечания

CMFCBaseTabCtrl::IsActiveTabCloseButton

virtual BOOL IsActiveTabCloseButton() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsAutoColor

Определяет, находится ли набор вкладок в режиме автоматической цветовой маркировки.

BOOL IsAutoColor() const;

Возвращаемое значение

Значение TRUE, если набор вкладок находится в режиме автоматической цветовой маркировки. В противном случае — значение FALSE.

Замечания

Вы можете включить или отключить режим автоматической цветовой маркировки с помощью метода CMFCBaseTabCtrl::EnableAutoColor.

CMFCBaseTabCtrl::IsAutoDestroyWindow

BOOL IsAutoDestroyWindow() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsColored

virtual BOOL IsColored() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsDialogControl

BOOL IsDialogControl() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsDrawNoPrefix

BOOL IsDrawNoPrefix() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsFlatFrame

Указывает, как отображаются рамки набора вкладок: в стиле плоского представления или в трехмерном стиле.

virtual BOOL IsFlatFrame() const;

Возвращаемое значение

Значение TRUE, если рамка набора вкладок отображается в стиле плоского представления. Значение FALSE, если в трехмерном стиле.

Замечания

Используйте метод CMFCTabCtrl::SetFlatFrame, чтобы изменить стиль отображения рамки набора вкладок.

Наборы вкладок, которые используют стиль Outlook, не могут быть отображены с плоскими рамками. Это касается класса CMFCOutlookBarTabCtrl и любых производных от него классов.

CMFCBaseTabCtrl::IsFlatTab

virtual BOOL IsFlatTab() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsHideSingleTab

Определяет, скрывает ли набор вкладок метку вкладки, если присутствует только одна вкладка.

virtual BOOL IsHideSingleTab() const;

Возвращаемое значение

Значение TRUE, если набор вкладок с одной вкладкой скрывает метку вкладки. В противном случае — значение FALSE.

Замечания

Используйте метод CMFCBaseTabCtrl::HideSingleTab, чтобы включить скрытие метки вкладки, когда есть только одна вкладка.

CMFCBaseTabCtrl::IsIconAdded

BOOL IsIconAdded(
    HICON hIcon,
    int& iIcon);

Параметры

[in] hIcon

[in] iIcon

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsInPlaceEdit

Указывает, настроен ли набор вкладок так, чтобы пользователь мог динамически изменять метки вкладок.

virtual BOOL IsInPlaceEdit() const;

Возвращаемое значение

Ненулевое значение, если встроенная активация разрешена. В противном случае — значение 0.

Замечания

Встроенную активацию можно включить или отключить, вызвав метод CMFCBaseTabCtrl::EnableInPlaceEdit.

CMFCBaseTabCtrl::IsLeftRightRounded

virtual BOOL IsLeftRightRounded() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsMDITab

BOOL IsMDITab() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsOneNoteStyle

Определяет, отображаются ли вкладки в стиле Microsoft OneNote.

virtual BOOL IsOneNoteStyle() const;

Возвращаемое значение

Значение TRUE, если вкладки отображаются в стиле Microsoft OneNote. В противном случае — значение FALSE.

Замечания

Вызовите метод CMDIFrameWndEx::EnableMDITabs, чтобы включить стиль Microsoft OneNote. Этот стиль также можно включить при создании экземпляра класса CMFCTabCtrl: просто передайте стиль STYLE_3D_ONENOTE методу CMFCTabCtrl::Create.

По умолчанию стиль Microsoft OneNote не поддерживается в пользовательском классе, производном от CMFCBaseTabCtrl Class. Тем не менее он поддерживается в классе CMFCTabCtrl.

CMFCBaseTabCtrl::IsPtInTabArea

Определяет, находится ли точка внутри области вкладок.

virtual BOOL IsPtInTabArea(CPoint point) const = 0;

Параметры

point
[in] Точка для проверки.

Возвращаемое значение

Ненулевое значение, если точка находится в области вкладок. В противном случае — 0.

Замечания

CMFCBaseTabCtrl::IsTabCloseButtonHighlighted

BOOL IsTabCloseButtonHighlighted() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsTabCloseButtonPressed

BOOL IsTabCloseButtonPressed() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::IsTabDetachable

Указывает, является ли вкладка отделяемой.

virtual BOOL IsTabDetachable(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс проверяемой вкладки.

Возвращаемое значение

Значение TRUE, если вкладка отделяемая. В противном случае — значение FALSE.

Замечания

Чтобы сделать вкладку отделяемой, используйте метод CMFCBaseTabCtrl::EnableTabDetach.

CMFCBaseTabCtrl::IsTabIconOnly

Определяет, содержит ли метка вкладки только значки (без текста).

virtual BOOL IsTabIconOnly(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

Возвращаемое значение

Значение TRUE, если метка вкладки содержит только значки. В противном случае — значение FALSE.

Замечания

Чтобы настроить для вкладок в приложении отображение только значков, вызовите метод CMFCBaseTabCtrl::SetTabIconOnly.

CMFCBaseTabCtrl::IsTabSwapEnabled

Определяет, позволяет ли набор вкладок изменять положения вкладок с помощью мыши.

BOOL IsTabSwapEnabled() const;

Возвращаемое значение

Ненулевое значение, если пользователь может изменять положения вкладок. В противном случае — 0.

Замечания

По умолчанию пользователи не могут изменять порядок вкладок в наборе вкладок. Используйте метод CMFCBaseTabCtrl::EnableTabSwap, чтобы включить эту функцию.

CMFCBaseTabCtrl::IsTabVisible

Указывает, является ли указанная вкладка видимой.

virtual BOOL IsTabVisible(int iTab) const;

Параметры

iTab
[in] Отсчитываемый от нуля индекс проверяемой вкладки.

Возвращаемое значение

Ненулевое значение, если указанная вкладка видима. В противном случае — 0.

CMFCBaseTabCtrl::IsVS2005Style

virtual BOOL IsVS2005Style() const;

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::m_bActivateTabOnRightClick

m_bActivateTabOnRightClick определяет, находятся ли вкладки в фокусе, когда пользователь щелкает метку вкладки, используя правую кнопку мыши.

BOOL m_bActivateTabOnRightClick;

Замечания

Значение по умолчанию этого элемента данных — FALSE.

CMFCBaseTabCtrl::m_bAutoDestroyWindow

m_bAutoDestroyWindow определяет, уничтожает ли платформа (в автоматическом режиме) объекты на вкладках при удалении вкладок.

BOOL m_bAutoDestroyWindow;

Замечания

Значение по умолчанию — FALSE.

CMFCBaseTabCtrl::MoveTab

virtual void MoveTab(
    int nSource,
    int nDest);

Параметры

[in] nSource

[in] nDest

Замечания

CMFCBaseTabCtrl::OnChangeTabs

Платформа вызывает этот метод, когда количество вкладок в наборе вкладок изменяется.

virtual void OnChangeTabs();

Замечания

По умолчанию этот метод не выполняет никаких действий. Переопределите этот метод, чтобы он выполнял пользовательский код, когда число вкладок в наборе вкладок изменяется.

CMFCBaseTabCtrl::OnDrop

virtual BOOL OnDrop(
    COleDataObject*,
    DROPEFFECT,
    CPoint);

Параметры

[in] COleDataObject*

[in] DROPEFFECT

[in] CPoint

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::OnDragOver

virtual DROPEFFECT OnDragOver(
    COleDataObject*,
    DWORD,
    CPoint);

Параметры

[in] COleDataObject*

[in] DWORD

[in] CPoint

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::OnDragLeave

virtual void OnDragLeave();

Замечания

CMFCBaseTabCtrl::OnDragEnter

virtual DROPEFFECT OnDragEnter(
    COleDataObject*,
    DWORD,
    CPoint);

Параметры

[in] COleDataObject*

[in] DWORD

[in] CPoint

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::OnRenameTab

virtual BOOL OnRenameTab(int, CString&);

Параметры

[in] int

[in] CString&

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::PreTranslateMessage

virtual BOOL PreTranslateMessage(MSG* pMsg);

Параметры

[in] pMsg

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::RecalcLayout

Повторно вычисляет внутренний макет набора вкладок.

virtual void RecalcLayout() = 0;

Замечания

В классе CMFCBaseTabCtrl (CMFCBaseTabCtrl Class) этот метод является чистой виртуальной функцией. Если вы наследуете класс от CMFCBaseTabCtrl, необходимо реализовать эту функцию.

CMFCBaseTabCtrl::RemoveAllTabs

Удаляет все вкладки из набора вкладок.

virtual void RemoveAllTabs();

Замечания

Если CMFCBaseTabCtrl::m_bAutoDestroyWindow имеет значение TRUE, платформа удаляет все объекты CWnd, прикрепленные к удаленным вкладкам.

CMFCBaseTabCtrl::RemoveTab

Удаляет вкладку из набора вкладок.

virtual BOOL RemoveTab(
    int iTab,
    BOOL bRecalcLayout = TRUE);

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

bRecalcLayout
[in] Логический параметр, указывающий, следует ли повторно вычислять макет вкладки.

Возвращаемое значение

Значение TRUE, если метод удаляет вкладку успешно. В противном случае — значение FALSE.

Замечания

Если CMFCBaseTabCtrl::m_bAutoDestroyWindow имеет значение TRUE, метод RemoveTab уничтожает объект CWnd, связанный с указанной вкладкой.

CMFCBaseTabCtrl::RenameTab

virtual BOOL RenameTab();

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::ResetImageList

Сбрасывает список изображений для экземпляра класса CMFCBaseTabCtrl.

void ResetImageList();

CMFCBaseTabCtrl::Serialize

virtual void Serialize(CArchive& ar);

Параметры

[in] ar

Замечания

CMFCBaseTabCtrl::SetActiveTab

Активирует заданную вкладку.

virtual BOOL SetActiveTab(int iTab) = 0;

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки. SetActiveTab активирует вкладку с данным индексом.

Возвращаемое значение

Значение TRUE, если успешно; в противном случае — FALSE.

Замечания

CMFCBaseTabCtrl::SetActiveTabColor

Устанавливает цвет фона для активной вкладки.

virtual void SetActiveTabColor(COLORREF clr);

Параметры

clr
[in] Задает новый цвет фона.

Замечания

Платформа получает цвет фона по умолчанию для активных вкладок из метода GetSysColor.

CMFCBaseTabCtrl::SetActiveTabTextColor

Задает цвет текста для активных вкладок.

virtual void SetActiveTabTextColor(COLORREF clr);

Параметры

clr
[in] Параметр COLORREF, который указывает новый цвет текста.

Замечания

По умолчанию платформа получает цвет текста из метода GetSysColor. Этот цвет по умолчанию переопределяется с помощью метода SetActiveTabTextColor.

CMFCBaseTabCtrl::SetAutoColors

Устанавливает цвета набора вкладок, используемые платформой в режиме автоматической цветовой маркировки.

void SetAutoColors(const CArray<COLORREF,COLORREF>& arColors);

Параметры

arColors
[in] Массив цветов RGB.

Замечания

Если вы предоставите пользовательский массив цветов, массив цветов по умолчанию не учитывается. Если параметр arColors является пустым, платформа возвращается к массиву цветов по умолчанию.

Чтобы включить режим автоматической цветовой маркировки, используйте метод CMFCBaseTabCtrl::EnableAutoColor.

CMFCBaseTabCtrl::SetDockingBarWrapperRTC

Задает класс-оболочку, который используется для любых объектов, не являющихся производными от CDockablePane Class.

void SetDockingBarWrapperRTC(CRuntimeClass* pRTC);

Параметры

pRTC
[in] Сведения о классе среды выполнения для нового класса-оболочки.

Замечания

Вкладки в набор вкладок можно добавить с помощью методов CMFCBaseTabCtrl::AddTab и CMFCBaseTabCtrl::InsertTab. При добавлении вкладки каждый элемент управления на этой вкладке должен быть закрепляемым. Все объекты, которые не являются производными от CDockablePane, должны быть заключены в оболочку. Методы AddTab и InsertTab создают оболочку для этих объектов. Класс-оболочка по умолчанию — CDockablePaneAdapter. Метод SetDockingBarWrapperRTC позволяет изменить класс, который используется как класс-оболочка. Предоставляемый класс-оболочка должен быть производным от CDockablePaneAdapter.

CMFCBaseTabCtrl::SetDrawNoPrefix

Включает и отключает обработку символов префикса в метках вкладок.

void SetDrawNoPrefix(
    BOOL bNoPrefix,
    BOOL bRedraw = TRUE);

Параметры

bNoPrefix
[in] TRUE, если символы префикса нужно обрабатывать. В противном случае — значение FALSE.

bRedraw
[in] Значение TRUE, если требуется перерисовать окно с вкладками. В противном случае — значение FALSE.

Замечания

Символом префикса является назначенный символ, которому предшествует амперсанд (&).

CMFCBaseTabCtrl::SetImageList

Задает список изображений значка для набора вкладок.

virtual BOOL SetImageList(
    UINT uiID,
    int cx = 15,
    COLORREF clrTransp = RGB(255, 0, 255));

virtual BOOL SetImageList(HIMAGELIST hImageList);

Параметры

uiID
[in] Идентификатор ресурса растрового изображения. SetImageList загружает список изображений из данного ресурса.

cx
[in] Ширина каждого изображения в пикселях.

clrTransp
[in] Параметр COLORREF, указывающий прозрачный цвет изображения.

hImageList
[in] Дескриптор списка предварительно загруженных изображений.

Возвращаемое значение

Ненулевое значение, если метод выполнен успешно. В противном случае — значение 0.

Замечания

Изображения из списка изображений значков отображаются вместе с метками для вкладки. Чтобы отобразить значок, необходимо указать его индекс при вызове CMFCBaseTabCtrl::AddTab.

Метод SetImageList завершится ошибкой, если набор вкладок был создан со стилем плоского представления. Он также завершится ошибкой, если платформе не удастся загрузить изображение, обозначенное идентификатором uiID.

Этот метод повторно вычисляет высоту вкладки в соответствии с размерами изображений и текста.

CMFCBaseTabCtrl::SetLocation

virtual void SetLocation(Location location);

Параметры

[in] location

Замечания

CMFCBaseTabCtrl::SetTabBkColor

Задает цвет фона для указанной вкладки.

virtual BOOL SetTabBkColor(
    int iTab,
    COLORREF color = (COLORREF)-1);

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

color
[in] Задаваемый цвет.

Возвращаемое значение

Значение TRUE в случае успешного выполнения. В противном случае — значение FALSE.

CMFCBaseTabCtrl::SetTabBorderSize

Задает новый размер границы для набора вкладок.

virtual void SetTabBorderSize(
    int nTabBorderSize,
    BOOL bRepaint = TRUE);

Параметры

nTabBorderSize
[in] Новый размер границы в пикселях.

bRepaint
[in] Логический параметр, который указывает, следует ли платформе перерисовать элемент управления.

CMFCBaseTabCtrl::SetTabHicon

Задает значок для метки вкладки.

virtual BOOL SetTabHicon(
    int iTab,
    HICON hIcon);

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки. Этот метод изменяет значок для этой вкладки.

hIcon
[in] Дескриптор значка.

Возвращаемое значение

Значение TRUE, если успешно; в противном случае — FALSE.

CMFCBaseTabCtrl::SetTabIcon

Задает значок для вкладки.

virtual BOOL SetTabIcon(
    int iTab,
    UINT uiIcon);

Параметры

iTab
[in] Отсчитываемый от нуля индекс обновляемой вкладки.

uiIcon
[in] Идентификатор нового значка. Этот идентификатор ссылается на внутренний объект CImageList.

Возвращаемое значение

Значение TRUE, если успешно; в противном случае — FALSE.

CMFCBaseTabCtrl::SetTabIconOnly

Включает отображение только значка (без текстовой подписи) на конкретной вкладке.

virtual BOOL SetTabIconOnly(
    int iTab,
    BOOL bIconOnly = TRUE,
    BOOL bShowTooltipAlways = FALSE);

Параметры

iTab
[in] Отсчитываемый от нуля индекс изменяемой вкладки.

bIconOnly
[in] Логический параметр, который определяет, следует ли отображать только значки.

bShowTooltipAlways
[in] Логический параметр, определяющий, отображает ли платформа подсказки для метки вкладки, на которой отображаются только значки.

Возвращаемое значение

Значение TRUE, если успешно; в противном случае — FALSE.

Замечания

По умолчанию набор вкладок отображает значок и текстовую подпись для каждой вкладки.

CMFCBaseTabCtrl::SetTabLabel

Задает текст для метки вкладки.

virtual BOOL SetTabLabel(
    int iTab,
    const CString& strLabel);

Параметры

iTab
[in] Отсчитываемый от нуля индекс обновляемой вкладки.

strLabel
[in] Ссылка на строку, которая содержит новый текст для метки вкладки.

Возвращаемое значение

Ненулевое значение в случае успешного выполнения. В противном случае — 0.

CMFCBaseTabCtrl::SetTabsHeight

virtual void SetTabsHeight();

Замечания

CMFCBaseTabCtrl::SetTabsOrder

Располагает вкладки в указанном порядке.

BOOL SetTabsOrder(const CArray<int,int>& arOrder);

Параметры

arOrder
[in] Массив индексов (с отсчетом от нуля), определяющий новый порядок вкладок.

Возвращаемое значение

Значение TRUE в случае успешного выполнения. В противном случае — значение FALSE.

Замечания

Размер массива arOrder должен быть равен количеству вкладок в наборе вкладок.

CMFCBaseTabCtrl::SetTabTextColor

Задает цвет текста для указанной вкладки.

virtual BOOL SetTabTextColor(
    int iTab,
    COLORREF color = (COLORREF)-1);

Параметры

iTab
[in] Отсчитываемый от нуля индекс вкладки.

color
[in] Параметр COLORREF, который указывает новый цвет текста.

Возвращаемое значение

Ненулевое значение в случае успешного выполнения. В противном случае — 0.

CMFCBaseTabCtrl::ShowTab

Отображает или скрывает указанную вкладку.

virtual BOOL ShowTab(
    int iTab,
    BOOL bShow = TRUE,
    BOOL bRecalcLayout = TRUE,
    BOOL bActivate = FALSE);

Параметры

iTab
[in] Индекс вкладки, который метод ShowTab будет отображать или скрывать.

bShow
[in] Логический параметр, который указывает, отображать ли вкладку.

bRecalcLayout
[in] Логический параметр, который указывает, следует ли немедленно повторно вычислить макет окна.

bActivate
[in] Логический параметр, который указывает, следует ли выбирать вкладку, указанную iTab.

Возвращаемое значение

Имеет ненулевое значение в случае успешного выполнения, иначе — 0.

Замечания

Параметр bActivate применяется, только если параметр bShow имеет значение TRUE. Если параметр bActivate имеет значение TRUE и если метод ShowTab выполнен успешно, ShowTab отправит сообщение AFX_WM_CHANGE_ACTIVE_TAB родительскому объекту окна вкладки.

CMFCBaseTabCtrl::StartRenameTab

virtual BOOL StartRenameTab(int iTab);

Параметры

[in] iTab

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::SwapTabs

virtual void SwapTabs(
    int nFisrtTabID,
    int nSecondTabID);

Параметры

[in] nFisrtTabID

[in] nSecondTabID

Замечания

См. также

Диаграмма иерархии
Классы
Класс CMFCTabCtrl
Класс CMFCOutlookBarTabCtrl

Поделиться через

Класс CMFCBaseTabCtrl

Синтаксис

Участники

Открытые методы

Защищенные методы

Элементы данных

Замечания

Советы по настройке

Иерархия наследования

Требования

CMFCBaseTabCtrl::AddIcon

Параметры

Замечания

CMFCBaseTabCtrl::AddTab

Параметры

Замечания

CMFCBaseTabCtrl::ApplyRestoredTabInfo

Параметры

Замечания

CMFCBaseTabCtrl::AutoDestroyWindow

Параметры

Замечания

CMFCBaseTabCtrl::CalcRectEdit

Параметры

Замечания

CMFCBaseTabCtrl::CleanUp

Замечания

CMFCBaseTabCtrl::ClearImageList

Замечания

CMFCBaseTabCtrl::CreateWrapper

Параметры

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::DetachTab

Параметры

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::EnableActivateLastActive

Параметры

Замечания

CMFCBaseTabCtrl::EnableAutoColor

Параметры

Замечания

CMFCBaseTabCtrl::EnableCustomToolTips

Параметры

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::EnableInPlaceEdit

Параметры

Замечания

CMFCBaseTabCtrl::EnableTabDetach

Параметры

Возвращаемое значение

CMFCBaseTabCtrl::EnableTabSwap

Параметры

Замечания

CMFCBaseTabCtrl::EnsureVisible

Параметры

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::EnterDragMode

Замечания

CMFCBaseTabCtrl::FindTargetWnd

Параметры

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::FireChangeActiveTab

Параметры

Замечания

CMFCBaseTabCtrl::FireChangingActiveTab

Параметры

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetActiveTab

Возвращаемое значение

CMFCBaseTabCtrl::GetActiveTabColor

Возвращаемое значение

Замечания

CMFCBaseTabCtrl::GetActiveTabTextColor