Partilhar via


Classe CMFCRibbonComboBox

Observação

A biblioteca Microsoft Foundation Classes (MFC) continua a ser suportada. No entanto, já não estamos a adicionar funcionalidades nem a atualizar a documentação.

A CMFCRibbonComboBox classe implementa um controlo de caixa combinada que podes adicionar a uma barra de fitas, um painel de fitas ou um menu pop-up de fitas.

Sintaxe

class CMFCRibbonComboBox : public CMFCRibbonEdit

Membros

Construtores

Nome Description
CMFCRibbonComboBox::CMFCRibbonComboBox Constrói um objeto CMFCRibbonComboBox.

Métodos Públicos

Nome Description
CMFCRibbonComboBox::AddItem Acrescenta um item único à caixa da lista.
CMFCRibbonComboBox::D eleteItem Apaga um item especificado da caixa da lista.
CMFCRibbonComboBox::EnableDropDownListResize Especifica se a caixa da lista pode mudar de tamanho quando esta desce.
CMFCRibbonComboBox::FindItem Devolve o índice do primeiro item na caixa da lista que corresponde a uma cadeia especificada.
CMFCRibbonComboBox::GetCount Devolve o número de itens na caixa da lista.
CMFCRibbonComboBox::GetCurSel Obtém o índice do item atualmente selecionado na caixa da lista.
CMFCRibbonComboBox::GetDropDownHeight Obtém a altura da caixa da lista quando a caixa da lista é descer.
CMFCRibbonComboBox::GetIntermediateSize Devolve o tamanho da caixa de combo tal como mostrado no modo intermédio.
CMFCRibbonComboBox::GetItem Devolve a cadeia associada a um item num índice especificado na caixa de lista.
CMFCRibbonComboBox::GetItemData Devolve os dados associados a um item num índice especificado na caixa de lista.
CMFCRibbonComboBox::HasEditBox Indica se o controlo contém uma caixa de edição.
CMFCRibbonComboBox::IsResizeDropDownList Indica se a caixa da lista pode ou não ser redimensionada.
CMFCRibbonComboBox::OnSelectItem É chamado pelo framework quando o utilizador seleciona um item na caixa da lista.
CMFCRibbonComboBox::RemoveAllItems Apaga todos os itens da caixa de lista e limpa a caixa de edição.
CMFCRibbonComboBox::SelectItem Seleciona um item na caixa da lista.
CMFCRibbonComboBox::SetDropDownHeight Define a altura da caixa da lista quando esta é descida.

Observações

A caixa de combinação de fitas consiste numa caixa de lista combinada com uma etiqueta estática ou uma etiqueta que pode ser editada pelo utilizador. Tens de especificar qual o tipo que queres quando criares a tua caixa combinada de fitas.

Example

O exemplo seguinte demonstra como construir um objeto da CMFCRibbonComboBox classe, adicionar um item à caixa de combo, selecionar um item na caixa de combo e adicionar uma caixa de combo a um painel.

// Create a simple combo box with two entries:
// The first parameter is the id of the combo box.
// The third parameter is the width of the combo box in pixels.
// The fourth parameter is the display label of the combo box.
// The fifth parameter is the index of the small image of the combo box.
CMFCRibbonComboBox *pComboSimple = new CMFCRibbonComboBox(-1, FALSE, -1, 0, -1);

// Add two items to the combo box and select the first item in the list:
pComboSimple->AddItem(_T("Hi!"));
pComboSimple->AddItem(_T("Hello!"));
pComboSimple->SelectItem(0);

// Add combo button to "Favorites" panel:
// CMFCRibbonPanel* pPanelFavorites
pPanelFavorites->Add(pComboSimple);

Hierarquia de herança

CObject

CMFCRibbonBaseElement

CMFCRibbonButton

CMFCRibbonEdit

CMFCRibbonComboBox

Requerimentos

Cabeçalho: afxribboncombobox.h

CMFCRibbonComboBox::AddItem

Acrescenta um item único à caixa da lista.

virtual INT_PTR AddItem(
    LPCTSTR lpszItem,
    DWORD_PTR dwData=0);

Parâmetros

lpszItem
[dentro] A sequência do item a adicionar.

dwData
[dentro] Os dados associados ao item a adicionar.

Valor de retorno

O índice baseado em zero do item anexado.

CMFCRibbonComboBox::CMFCRibbonComboBox

Constrói um CMFCRibbonComboBox objeto.

public:
CMFCRibbonComboBox(
    UINT nID,
    BOOL bHasEditBox=TRUE,
    int nWidth=-1,
    LPCTSTR lpszLabel=NULL,
    int nImage=-1);

protected:
CMFCRibbonComboBox();

Parâmetros

nID
[dentro] O ID da caixa combinada.

bHasEditBox
[dentro] TRUE se quiseres uma caixa de edição dentro do controlo; FALSO, caso contrário.

nLargura
[dentro] Largura da caixa de combo em pixels; ou -1 para a largura padrão.

lpszLabel
[dentro] A etiqueta de exibição da caixa combinada.

nImagem
[dentro] O pequeno índice de imagem da caixa combinada.

Observações

A largura padrão é 108 pixels.

CMFCRibbonComboBox::D eleteItem

Apaga um item especificado da caixa da lista.

BOOL DeleteItem(int iIndex);
BOOL DeleteItem(DWORD_PTR dwData);

BOOL DeleteItem(LPCTSTR lpszText);

Parâmetros

iIndex
[dentro] O índice em base zero do item a ser eliminado.

dwData
[dentro] Os dados associados ao item a serem eliminados.

lpszText
[dentro] A sequência do item a eliminar. Se houver vários itens com a mesma cadeia, o primeiro item é eliminado.

Valor de retorno

TRUE se o item especificado tiver sido eliminado; caso contrário, FALSO.

Observações

CMFCRibbonComboBox::EnableDropDownListResize

Especifica se a caixa da lista pode mudar de tamanho quando esta desce.

void EnableDropDownListResize(BOOL bEnable=FALSE);

Parâmetros

bEnable
[dentro] TRUE para permitir o redimensionamento; FALSE para desativar o redimensionamento.

Observações

Quando o redimensionamento está ativado, a caixa da lista muda de tamanho para se ajustar aos itens que apresenta.

CMFCRibbonComboBox::FindItem

Devolve o índice do primeiro item na caixa da lista que corresponde a uma cadeia especificada.

int FindItem(LPCTSTR lpszText) const;

Parâmetros

lpszText
[dentro] A sequência de um item na caixa da lista.

Valor de retorno

O índice em base zero do item; ou -1 se o item não for encontrado.

Observações

CMFCRibbonComboBox::GetCount

Devolve o número de itens na caixa da lista.

INT_PTR GetCount() const;

Valor de retorno

O número de itens na caixa da lista, ou 0 se a caixa da lista não contiver itens.

Observações

CMFCRibbonComboBox::GetCurSel

Obtém o índice do item atualmente selecionado na caixa da lista.

int GetCurSel() const;

Valor de retorno

O índice base zero do item atualmente selecionado na caixa da lista; ou -1 se nenhum item for selecionado.

CMFCRibbonComboBox::GetDropDownHeight

Obtém a altura da caixa da lista quando a caixa da lista é descer.

int GetDropDownHeight();

Valor de retorno

A altura, em pixels, da caixa da lista.

Observações

CMFCRibbonComboBox::GetIntermediateSize

Devolve o tamanho da caixa de combo tal como mostrado no modo intermédio.

virtual CSize GetIntermediateSize(CDC* pDC);

Parâmetros

pDC
[dentro] Apontar para o contexto de um dispositivo para a caixa combinada.

Valor de retorno

O tamanho da caixa combinada.

Observações

O tamanho devolvido baseia-se no tamanho da caixa combinada quando esta apresenta imagens pequenas.

CMFCRibbonComboBox::GetItem

Devolve a cadeia associada a um item num índice especificado na caixa de lista.

LPCTSTR GetItem(int iIndex) const;

Parâmetros

iIndex
[dentro] O índice em base zero de um item na caixa da lista.

Valor de retorno

Um apontador para a cadeia associada ao item; caso contrário, NULL se o parâmetro de índice for inválido, ou se o parâmetro de índice estiver -1 e não houver elemento selecionado na caixa de combo.

Observações

CMFCRibbonComboBox::GetItemData

Devolve os dados associados a um item num índice especificado na caixa de lista.

DWORD_PTR GetItemData(int iIndex) const;

Parâmetros

iIndex
[dentro] O índice em base zero de um item na caixa da lista.

Valor de retorno

Os dados associados ao item; ou 0 se o item não existir, ou se o parâmetro de índice for -1 e não houver um item selecionado na caixa de lista.

CMFCRibbonComboBox::HasEditBox

Indica se o controlo contém uma caixa de edição.

BOOL HasEditBox() const;

Valor de retorno

TRUE se o controlo contiver uma caixa de edição; caso contrário, FALSO.

Observações

CMFCRibbonComboBox::IsResizeDropDownList

Indica se a caixa da lista pode ou não ser redimensionada.

BOOL IsResizeDropDownList() const;

Valor de retorno

TRUE se a caixa da lista puder ser redimensionada; caso contrário, FALSO. CMFCRibbonComboBox::EnableDropDownListResize

Observações

Pode ativar o redimensionamento de listas usando o método CMFCRibbonComboBox::EnableDropDownListResize .

CMFCRibbonComboBox::OnSelectItem

Chamada pelo framework quando um utilizador seleciona um item na caixa da lista.

virtual void OnSelectItem(int nItem);

Parâmetros

nItem
[dentro] O índice do item selecionado.

Observações

Anule este método se quiser processar uma seleção de entrada do utilizador.

CMFCRibbonComboBox::RemoveAllItems

Apaga todos os itens da caixa de lista e limpa a caixa de edição.

void RemoveAllItems();

Observações

CMFCRibbonComboBox::SelectItem

Seleciona um item na caixa da lista.

BOOL SelectItem(int iIndex);
BOOL SelectItem(DWORD_PTR dwData);

BOOL SelectItem(LPCTSTR lpszText);

Parâmetros

iIndex
[dentro] O índice em base zero de um item na caixa da lista.

dwData
[dentro] Os dados associados a um item na caixa da lista.

lpszText
[dentro] A sequência de um item na caixa da lista.

Valor de retorno

TRUE se o método foi bem-sucedido; caso contrário, FALSO.

Observações

CMFCRibbonComboBox::SetDropDownHeight

Define a altura da caixa da lista quando esta é descida.

void SetDropDownHeight(int nHeight);

Parâmetros

nAltura
[dentro] A altura, em pixels, da caixa da lista.

Observações

A altura padrão é 150 pixels.

Consulte também

Gráfico de Hierarquia
Classes
Classe CMFCRibbonEdit