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


Класс CMFCRibbonEdit

Замечание

Библиотека классов Microsoft Foundation (MFC) продолжает поддерживаться. Однако мы больше не добавляем функции или обновляем документацию.

Реализует элемент управления редактирования, расположенный на панели ленты.

Синтаксис

class CMFCRibbonEdit : public CMFCRibbonButton

Участники

Открытые конструкторы

Имя Описание
CMFCRibbonEdit::CMFCRibbonEdit Формирует объект CMFCRibbonEdit.

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

Имя Описание
CMFCRibbonEdit::CanBeStretched Указывает, может ли высота элемента управления увеличиваться вертикально до высоты CMFCRibbonEdit строки ленты.
CMFCRibbonEdit::CMFCRibbonEdit Формирует объект CMFCRibbonEdit.
CMFCRibbonEdit::CopyFrom Копирует состояние указанного CMFCRibbonEdit объекта в текущий CMFCRibbonEdit объект.
CMFCRibbonEdit::CreateEdit Создает новое текстовое поле для CMFCRibbonEdit объекта.
CMFCRibbonEdit::D efcCtrl Уничтожает CMFCRibbonEdit объект.
CMFCRibbonEdit::D ropDownList Раскрывающийся список.
CMFCRibbonEdit::EnableSpinButtons Включает и задает диапазон кнопки спина для текстового поля.
CMFCRibbonEdit::GetCompactSize Извлекает компактный CFMCRibbonEdit размер объекта.
CMFCRibbonEdit::GetEditText Извлекает текст в текстовом поле.
CMFCRibbonEdit::GetIntermediateSize Извлекает промежуточный CMFCRibbonEdit размер объекта.
CMFCRibbonEdit::GetTextAlign Извлекает выравнивание текста в текстовом поле.
CMFCRibbonEdit::GetWidth Извлекает ширину элемента управления в пикселях CMFCRibbonEdit .
CMFCRibbonEdit::HasCompactMode Указывает, может ли размер дисплея элемента CMFCRibbonEdit управления быть компактным.
CMFCRibbonEdit::HasFocus Указывает, имеет ли CMFCRIbbonEdit элемент управления фокус.
CMFCRibbonEdit::HasLargeMode Указывает, может ли размер дисплея элемента CMFCRibbonEdit управления быть большим.
CMFCRibbonEdit::HasSpinButtons Указывает, имеет ли текстовое поле кнопку спина.
CMFCRibbonEdit::IsHighlighted Указывает, выделен ли CMFCRibbonEdit элемент управления.
CMFCRibbonEdit::OnAfterChangeRect Вызывается платформой, когда измерения прямоугольника отображения для CMFCRibbonEdit элемента управления изменяются.
CMFCRibbonEdit::OnDraw Вызывается платформой для рисования CMFCRibbonEdit элемента управления.
CMFCRibbonEdit::OnDrawLabelAndImage Вызывается платформой для рисования метки и изображения элемента CMFCRibbonEdit управления.
CMFCRibbonEdit::OnDrawOnList Вызывается платформой для рисования CMFCRibbonEdit элемента управления в поле списка команд.
CMFCRibbonEdit::OnEnable Вызывается платформой для включения или отключения CMFCRibbonEdit элемента управления.
CMFCRibbonEdit::OnHighlight Вызывается платформой, когда указатель вводит или покидает границы CMFCRibbonEdit элемента управления.
CMFCRibbonEdit::OnKey Вызывается платформой, когда пользователь нажимает подсказку CMFCRibbonEdit и элемент управления имеет фокус.
CMFCRibbonEdit::OnLButtonDown Вызывается платформой для обновления CMFCRibbonEdit элемента управления, когда пользователь нажимает левую кнопку мыши на элементе управления.
CMFCRibbonEdit::OnLButtonUp Вызывается платформой, когда пользователь освобождает левую кнопку мыши.
CMFCRibbonEdit::OnRTLChanged Вызывается платформой для обновления CMFCRibbonEdit элемента управления при изменении направления макета.
CMFCRibbonEdit::OnShow Вызывается платформой для отображения или скрытия CMFCRibbonEdit элемента управления.
CMFCRibbonEdit::Redraw Обновляет отображение CMFCRibbonEdit элемента управления.
CMFCRibbonEdit::SetACCData Задает данные специальных возможностей CMFCRibbonEdit для объекта.
CMFCRibbonEdit::SetEditText Задает текст в текстовом поле.
CMFCRibbonEdit::SetTextAlign Задает выравнивание текста текстового поля.
CMFCRibbonEdit::SetWidth Задает ширину текстового поля для CMFCRibbonEdit элемента управления.

Замечания

Пример

В следующем примере показано, как создать CMFCRibbonEdit объект, отобразить кнопки спины рядом с элементом управления редактированием и задать текст элемента управления редактирования. Этот фрагмент кода является частью примера демонстрации MS Office 2007.

CMFCRibbonEdit *pEditIndentLeft = new CMFCRibbonEdit(ID_PAGELAYOUT_INDENT_LEFT, 72, _T("Left:\nil"), 13);
// specify the min and max value of the spin button control
pEditIndentLeft->EnableSpinButtons(0, 1000);
// set the text of the edit control
pEditIndentLeft->SetEditText(_T("0"));

Требования

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

CMFCRibbonEdit::CanBeStretched

Указывает, может ли высота элемента управления CMFCRibbonEdit увеличиваться вертикально до высоты строки ленты.

virtual BOOL CanBeStretched();

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

Всегда возвращает значение FALSE.

Замечания

CMFCRibbonEdit::CMFCRibbonEdit

Создает объект CMFCRibbonEdit.

CMFCRibbonEdit(
    UINT nID,
    int nWidth,
    LPCTSTR lpszLabel = NULL,
    int nImage = -1);

CMFCRibbonEdit();

Параметры

nID
[in] Идентификатор команды для CMFCRibbonEdit элемента управления.

nWidth
[in] Ширина в пикселях текстового CMFCRibbonEdit поля элемента управления.

lpszLabel
[in] Метка элемента CMFCRibbonEdit управления.

nImage
[in] Индекс небольшого изображения, используемого CMFCRibbonEdit для элемента управления. Коллекция небольших изображений поддерживается родительской категорией ленты.

Замечания

Элемент CMFCRibbonEdit управления не использует большое изображение.

CMFCRibbonEdit::CopyFrom

Копирует состояние указанного объекта CMFCRibbonEdit в текущий объект CMFCRibbonEdit .

virtual void CopyFrom(const CMFCRibbonBaseElement& src);

Параметры

src
[in] Исходный CMFCRibbonEdit объект.

Замечания

Параметр src должен иметь тип CMFCRibbonEdit.

CMFCRibbonEdit::CreateEdit

Создает новое текстовое поле для объекта CMFCRibbonEdit .

virtual CMFCRibbonRichEditCtrl* CreateEdit(
    CWnd* pWndParent,
    DWORD dwEditStyle);

Параметры

pWndParent
[in] Указатель на родительское окно CMFCRibbonEdit объекта.

dwEditStyle
[in] Задает стиль текстового поля. Стили окон, перечисленные в разделе "Примечания", можно объединить с стилями элементов управления редактирования, описанными в пакете SDK для Windows.

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

Указатель на новое текстовое поле, если метод выполнен успешно; в противном случае значение NULL.

Замечания

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

К текстовому поле можно применить следующие стили окон:

  • WS_CHILD

  • WS_VISIBLE

  • WS_DISABLED

  • WS_GROUP

  • WS_TABSTOP

CMFCRibbonEdit::D efcCtrl

Уничтожает объект CMFCRibbonEdit .

virtual void DestroyCtrl();

Замечания

Раскрывающийся список.

virtual void DropDownList();

Замечания

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

CMFCRibbonEdit::EnableSpinButtons

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

void EnableSpinButtons(
    int nMin,
    int nMax);

Параметры

nMin
[in] Минимальное значение кнопки спина.

nMax
[in] Максимальное значение кнопки спина.

Замечания

Кнопки спина отображают стрелку вверх и вниз и позволяют пользователям перемещаться по фиксированному набору значений.

CMFCRibbonEdit::GetCompactSize

Извлекает компактный размер объекта CMFCRibbonEdit .

virtual CSize GetCompactSize(CDC* pDC);

Параметры

pDC
[in] Указатель на контекст устройства для CMFCRibbonEdit объекта.

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

Компактный CMFCRibbonEdit размер объекта.

Замечания

CMFCRibbonEdit::GetEditText

Извлекает текст в текстовом поле.

CString GetEditText() const;

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

Текст в текстовом поле.

Замечания

CMFCRibbonEdit::GetIntermediateSize

Извлекает промежуточный размер объекта CMFCRibbonEdit .

virtual CSize GetIntermediateSize(CDC* pDC);

Параметры

pDC
[in] Указатель на контекст устройства для CMFCRibbonEdit объекта.

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

Промежуточный CMFCRibbonEdit размер объекта.

Замечания

CMFCRibbonEdit::GetTextAlign

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

int GetTextAlign() const;

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

Перечисленное значение выравнивания текста. Сведения о возможных значениях см. в разделе "Примечания".

Замечания

Возвращаемое значение является одним из следующих стилей элементов управления правки:

  • ES_LEFT для выравнивания по левому краю

  • ES_CENTER для выравнивания центра

  • ES_RIGHT для выравнивания по правому краю

Дополнительные сведения об этих стилях см. в разделе "Изменить стили элементов управления".

CMFCRibbonEdit::GetWidth

Извлекает ширину в пикселях элемента управления CMFCRibbonEdit .

int GetWidth(BOOL bInFloatyMode = FALSE) const;

Параметры

bInFloatyMode
[in] ЗНАЧЕНИЕ TRUE, если CMFCRibbonEdit элемент управления находится в плавающем режиме; в противном случае — ЗНАЧЕНИЕ FALSE.

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

Ширина элемента управления в пикселях CMFCRibbonEdit .

Замечания

CMFCRibbonEdit::HasCompactMode

Указывает, может ли отображаться размер элемента управления CMFCRibbonEdit .

virtual BOOL HasCompactMode() const;

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

Всегда возвращает значение TRUE.

Замечания

По умолчанию этот метод всегда возвращает ЗНАЧЕНИЕ TRUE. Переопределите этот метод, чтобы указать, может ли размер дисплея быть компактным.

CMFCRibbonEdit::HasFocus

Указывает, имеет ли элемент управления CMFCRibbonEdit фокус.

virtual BOOL HasFocus() const;

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

ЗНАЧЕНИЕ TRUE, если элемент CMFCRibbonEdit управления имеет фокус; в противном случае — ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonEdit::HasLargeMode

Указывает, может ли размер дисплея элемента управления CMFCRibbonEdit быть большим.

virtual BOOL HasLargeMode() const;

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

Всегда возвращает значение FALSE.

Замечания

По умолчанию этот метод всегда возвращает ЗНАЧЕНИЕ FALSE. Переопределите этот метод, чтобы указать, может ли размер дисплея быть большим.

CMFCRibbonEdit::HasSpinButtons

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

virtual BOOL HasSpinButtons() const;

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

TRUE, если текстовое поле имеет кнопку спины; в противном случае ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonEdit::IsHighlighted

Указывает, выделен ли элемент управления CMFCRibbonEdit .

virtual BOOL IsHighlighted() const;

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

ЗНАЧЕНИЕ TRUE, если CMFCRibbonEdit элемент управления выделен; в противном случае — ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonEdit::OnAfterChangeRect

Вызывается платформой, когда измерения прямоугольника отображения для элемента управления CMFCRibbonEdit изменяются.

virtual void OnAfterChangeRect(CDC* pDC);

Параметры

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

Замечания

CMFCRibbonEdit::OnDraw

Вызывается платформой для рисования элемента управления CMFCRibbonEdit .

virtual void OnDraw(CDC* pDC);

Параметры

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

Замечания

CMFCRibbonEdit::OnDrawLabelAndImage

Вызывается платформой для рисования метки и изображения для элемента управления CMFCRibbonEdit .

virtual void OnDrawLabelAndImage(CDC* pDC);

Параметры

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

Замечания

CMFCRibbonEdit::OnDrawOnList

Вызывается платформой для рисования элемента управления CMFCRibbonEdit в поле списка команд.

virtual void OnDrawOnList(
    CDC* pDC,
    CString strText,
    int nTextOffset,
    CRect rect,
    BOOL bIsSelected,
    BOOL bHighlighted);

Параметры

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

strText
[in] Отображаемый текст.

nTextOffset
[in] Расстояние в пикселях от левой части поля списка до отображаемого текста.

rect
[in] Прямоугольник отображения для CMFCRibbonEdit элемента управления.

bIsSelected
[in] Этот параметр не используется.

bHighlighted
[in] Этот параметр не используется.

Замечания

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

CMFCRibbonEdit::OnEnable

Вызывается платформой для включения или отключения элемента управления CMFCRibbonEdit .

virtual void OnEnable(BOOL bEnable);

Параметры

bEnable
[in] ЗНАЧЕНИЕ TRUE для включения элемента управления; ЗНАЧЕНИЕ FALSE, чтобы отключить элемент управления.

Замечания

CMFCRibbonEdit::OnHighlight

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

virtual void OnHighlight(BOOL bHighlight);

Параметры

bHighlight
[in] ЗНАЧЕНИЕ TRUE, если указатель находится в границах CMFCRibbonEdit элемента управления; в противном случае — ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonEdit::OnKey

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

virtual BOOL OnKey(BOOL bIsMenuKey);

Параметры

bIsMenuKey
[in] ЗНАЧЕНИЕ TRUE, если подсказка ключа отображает всплывающее меню; в противном случае — ЗНАЧЕНИЕ FALSE.

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

ЗНАЧЕНИЕ TRUE, если событие было обработано; в противном случае — ЗНАЧЕНИЕ FALSE.

Замечания

CMFCRibbonEdit::OnLButtonDown

Вызывается платформой для обновления элемента управления CMFCRibbonEdit , когда пользователь нажимает левую кнопку мыши на элементе управления.

virtual void OnLButtonDown(CPoint point);

Параметры

point
[in] Этот параметр не используется.

Замечания

CMFCRibbonEdit::OnLButtonUp

Вызывается платформой, когда пользователь освобождает левую кнопку мыши.

virtual void OnLButtonUp(CPoint point);

Параметры

point
[in] Этот параметр не используется.

Замечания

CMFCRibbonEdit::OnRTLChanged

Вызывается платформой для обновления элемента управления CMFCRibbonEdit при изменении направления макета.

virtual void OnRTLChanged(BOOL bIsRTL);

Параметры

bIsRTL
[in] ЗНАЧЕНИЕ TRUE, если макет находится справа налево; Значение FALSE, если макет находится слева направо.

Замечания

CMFCRibbonEdit::OnShow

Вызывается платформой для отображения или скрытия элемента управления CMFCRibbonEdit .

virtual void OnShow(BOOL bShow);

Параметры

bShow
[in] Значение TRUE для отображения элемента управления; Значение FALSE для скрытия элемента управления.

Замечания

CMFCRibbonEdit::Redraw

Обновляет отображение элемента управления CMFCRibbonEdit .

virtual void Redraw();

Замечания

Этот метод перерисовывает прямоугольник отображения для CMFCRibbonEdit объекта путем косвенного вызова CWnd::RedrawWindow с набором флагов RDW_INVALIDATE, RDW_ERASE и RDW_UPDATENOW флагов.

CMFCRibbonEdit::SetACCData

Задает данные специальных возможностей для объекта CMFCRibbonEdit .

virtual BOOL SetACCData(
    CWnd* pParent,
    CAccessibilityData& data);

Параметры

pParent
Указатель на родительское окно объекта CMFCRibbonEdit .

data
Данные специальных возможностей CMFCRibbonEdit для объекта.

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

Всегда возвращает значение TRUE.

Замечания

CMFCRibbonEdit::SetEditText

Задает текст в текстовом поле.

void SetEditText(CString strText);

Параметры

strText
[in] Текст текстового поля.

CMFCRibbonEdit::SetTextAlign

Задает выравнивание текста текстового поля.

void SetTextAlign(int nAlign);

Параметры

nAlign
[in] Перечисленное значение выравнивания текста. Сведения о возможных значениях см. в разделе "Примечания".

Замечания

Параметр nAlign является одним из следующих стилей элементов управления правки:

  • ES_LEFT для выравнивания по левому краю

  • ES_CENTER для выравнивания центра

  • ES_RIGHT для выравнивания по правому краю

Дополнительные сведения об этих стилях см. в разделе "Изменить стили элементов управления".

CMFCRibbonEdit::SetWidth

Задает ширину текстового поля для элемента управления CMFCRibbonEdit .

void SetWidth(
    int nWidth,
    BOOL bInFloatyMode = FALSE);

Параметры

nWidth
[in] Ширина в пикселях текстового поля.

bInFloatyMode
ЗНАЧЕНИЕ TRUE, чтобы задать ширину для режима с плавающей запятой; Значение FALSE, чтобы задать ширину для регулярного режима.

Замечания

Элемент CMFCRibbonEdit управления имеет две ширины в зависимости от режима отображения: режим с плавающей запятой и обычный режим.

См. также

Диаграмма иерархии
Классы
Класс CMFCRibbonButton
Класс CMFCRibbonBar