CListCtrl::GetGroupRect

Artigo
08/25/2010

Recupera o retângulo delimitador para um agrupar especificado no controle de exibição de lista corrente.

BOOL GetGroupRect(
          int iGroupId, 
          LPRECT lpRect, 
          int iCoords = LVGGR_GROUP
) const;

Parâmetros

Parâmetro	Descrição
[in] iGroupId	Especifica um agrupar.
[in, out] lpRect	Ponteiro para um RECT estrutura.Se esse método for bem-sucedido, a estrutura recebe as coordenadas do retângulo do agrupar especificado por iGroupId.
[in] iCoords	Especifica as coordenadas de retângulo para recuperar.Use um destes valores: LVGGR_GROUP -Coordenadas (padrão) do agrupar expandido inteiro. LVGGR_HEADER -Coordenadas do somente o cabeçalho (agrupar recolhido). LVGGR_SUBSETLINK -Coordenadas do apenas o subconjunto de link (subconjunto marcação).

[in] iGroupId

Especifica um agrupar.

[in, out] lpRect

Ponteiro para um RECT estrutura.Se esse método for bem-sucedido, a estrutura recebe as coordenadas do retângulo do agrupar especificado por iGroupId.

[in] iCoords

Especifica as coordenadas de retângulo para recuperar.Use um destes valores:

LVGGR_GROUP -Coordenadas (padrão) do agrupar expandido inteiro.
LVGGR_HEADER -Coordenadas do somente o cabeçalho (agrupar recolhido).
LVGGR_SUBSETLINK -Coordenadas do apenas o subconjunto de link (subconjunto marcação).

Valor de retorno

true Se esse método for bem-sucedida; caso contrário, false.

Comentários

O chamador é responsável por alocar o RECT estrutura apontada pelo pRect parâmetro.

Esse método envia o LVM_GETGROUPRECT mensagem, que é descrita no Windows SDK.

Requisitos

Cabeçalho: afxcmn.h

Este controle é suportado no Windows Vista e mais recente.

Requisitos adicionais para este método são descritos em compilação Requisitos para controles comuns do Windows Vista.

Exemplo

O exemplo de código a seguir define uma variável, m_listCtrl, que é usado para acessar o controle de exibição de lista corrente. Essa variável é usada no exemplo a seguir.

public:
    // Variable used to access the list control.
    CListCtrl m_listCtrl;

O exemplo de código a seguir demonstra o GetGroupRect método. Em uma seção anterior deste exemplo de código, criamos um controle de exibição de lista que exibe duas colunas intituladas "ClientID" e "classificação" em um modo de exibição de relatório.O exemplo de código a seguir desenha um retângulo 3D ao redor do agrupar cujo índice é 0, se existir um agrupar.

  // GetGroupRect

    // Get the graphics rectangle that surrounds group 0.
    CRect rect;
    BOOL bRet = m_listCtrl.GetGroupRect( 0, &rect, LVGGR_GROUP); 
    // Draw a blue rectangle around group 0.
    if (bRet == TRUE) {
        m_listCtrl.GetDC()->Draw3dRect( &rect, RGB(0, 0, 255), RGB(0, 0, 255));
    }
    else {
        AfxMessageBox(_T("No group information was retrieved."), MB_ICONINFORMATION);
    }