CMFCPropertyGridCtrl Classe

Para obter mais detalhes, consulte o código-fonte localizado na pasta mfc da instalação do Visual Studio. Por exemplo, %ProgramFiles(x86)%\Microsoft Visual Studio\2019\Enterprise\VC\Tools\MSVC\14.29.30133\atlmfc\src\mfc.

Suporta um controle de grade de propriedades editável que pode exibir propriedades em ordem alfabética ou hierárquica.

Sintaxe

class CMFCPropertyGridCtrl : public CWnd

Membros

Construtores Públicos

Métodos Públicos

Métodos Protegidos

Comentários

A classe CMFCPropertyGridCtrl exibe um controle de grade de propriedades que contém propriedades editáveis derivadas da classe CMFCPropertyGridProperty. Cada propriedade pode representar um tipo e pode conter subitens. O controle de grade de propriedades oferece suporte a uma área redimensionável na parte inferior que pode exibir a descrição de uma propriedade selecionada.

Para usar um controle de grade de propriedades, construa um objeto CMFCPropertyGridCtrl e chame o método CMFCPropertyGridCtrl::Create. Use o método CMFCPropertyGridCtrl::AddProperty para adicionar propriedades à lista.

Propriedades de seleção

Em vez de representar um valor, um item de propriedade pode iniciar uma caixa de diálogo que permite ao usuário selecionar uma cor, arquivo ou fonte.

A tabela a seguir lista quatro tipos de propriedade de seleção:

Ilustrações

As ilustrações a seguir descrevem um controle de grade de propriedades que exibe propriedades de duas maneiras. A primeira ilustração exibe propriedades hierarquicamente e a segunda exibe propriedades em ordem alfabética.

Exemplo

O exemplo a seguir demonstra como configurar um objeto de controle de grade de propriedade usando vários métodos na classe CMFCPropertyGridCtrl. O exemplo demonstra como habilitar o controle de cabeçalho, habilitar a área de descrição e definir a aparência do controle de grade de propriedades. O exemplo também mostra como definir o modo alfabético para o controle pelo qual o controle classifica todas as propriedades que ele contém pelo nome da propriedade e como definir as cores personalizadas para vários elementos do controle de grade de propriedades. Este exemplo faz parte do exemplo New Controls.

CMFCPropertyGridCtrl m_wndPropList;

m_wndPropList.EnableHeaderCtrl();
m_wndPropList.EnableDescriptionArea();
m_wndPropList.SetVSDotNetLook(m_bDotNetLook);
// BOOL m_bMarkChanged
m_wndPropList.MarkModifiedProperties(m_bMarkChanged);
// BOOL m_bPropListCategorized
m_wndPropList.SetAlphabeticMode(!m_bPropListCategorized);
// BOOL m_bShowDragContext
m_wndPropList.SetShowDragContext(m_bShowDragContext);

// BOOL m_bMarkSortedColumn
m_wndList.EnableMarkSortedColumn(m_bMarkSortedColumn);

// BOOL m_bPropListCustomColors
// set custom colors for various elements of the property grid control
if (m_bPropListCustomColors)
{
   m_wndPropList.SetCustomColors(RGB(228, 243, 254), RGB(46, 70, 165), RGB(200, 236, 209), RGB(33, 102, 49), RGB(255, 229, 216), RGB(128, 0, 0), RGB(159, 159, 255));
}
else
{
   COLORREF c = (COLORREF)-1;
   m_wndPropList.SetCustomColors(c, c, c, c, c, c, c);
}

m_wndPropList.RedrawWindow();

// restore original values of the properties
m_wndPropList.ResetOriginalValues();

Hierarquia de herança

CObject

CCmdTarget

CWnd

CMFCPropertyGridCtrl

Requerimentos

Cabeçalho:afxpropertygridctrl.h

CMFCPropertyGridCtrl::accSelect

virtual HRESULT accSelect(
    long flagsSelect,
    VARIANT varChild);

Parâmetros

[em] flagsSelect
[em] varChild

Valor de retorno

Comentários

CMFCPropertyGridCtrl::AddProperty

Adiciona uma nova propriedade a um controle de grade de propriedades.

int AddProperty(
    CMFCPropertyGridProperty* pProp,
    BOOL bRedraw=TRUE,
    BOOL bAdjustLayout=TRUE);

Parâmetros

pProp
[em] Ponteiro para uma propriedade.

bRedraw
[em] TRUE redesenhar o imóvel imediatamente; caso contrário, FALSE. O valor padrão é TRUE.

bAdjustLayout
[em] TRUE recalcular como desenhar o texto e o valor da propriedade e, em seguida, desenhar a propriedade; FALSE usar os cálculos existentes para desenhar a propriedade. O valor padrão é TRUE.

Valor de retorno

Se esse método for bem-sucedido, o índice baseado em zero da posição no controle de grade de propriedades onde a propriedade é adicionada; caso contrário, -1.

Comentários

Esse método adiciona um ponteiro para a propriedade especificada para o final da lista de propriedades no controle de grade de propriedades. Não destrua as propriedades nem permita que elas saiam do escopo antes que o controle de grade seja destruído. Quando terminar o controle de grade de propriedades, chame CMFCPropertyGridCtrl::RemoveAll para excluir todas as propriedades adicionadas. O método AddProperty falhará se a propriedade especificada já tiver sido adicionada à lista.

CMFCPropertyGridCtrl::AdjustLayout

Redesenha o controle de grade de propriedades e suas propriedades.

virtual void AdjustLayout();

Comentários

Esse método recalcula como desenhar todo o controle de grade de propriedades e suas propriedades, incluindo imagens, fontes e controles.

CMFCPropertyGridCtrl::AlwaysShowUserToolTip

void AlwaysShowUserToolTip(BOOL bShow = TRUE);

Parâmetros

[em] bShow

Comentários

CMFCPropertyGridCtrl::CloseColorPopup

Fecha a caixa de diálogo de seleção de cores.

virtual void CloseColorPopup();

Comentários

Para obter mais informações sobre a caixa de diálogo de seleção de cores, consulte CMFCPropertyGridColorProperty Class.

CMFCPropertyGridCtrl::CMFCPropertyGridCtrl

Constrói um objeto CMFCPropertyGridCtrl.

CMFCPropertyGridCtrl();

Valor de retorno

Comentários

CMFCPropertyGridCtrl::CompareProps

Chamado pelo controle de grade de propriedades para classificar propriedades.

virtual int CompareProps(
    const CMFCPropertyGridProperty* pProp1,
    const CMFCPropertyGridProperty* pProp2) const;

Parâmetros

pProp1
Um ponteiro para uma propriedade.

pProp2
Um ponteiro para uma propriedade.

Valor de retorno

Comentários

Por padrão, esse método usa o método CString::Compare para comparar os membros CMFCPropertyGridProperty::m_strName dos parâmetros especificados.

CMFCPropertyGridCtrl::Create

Cria um controle de grade de propriedades e o anexa ao objeto de controle de grade de propriedades.

virtual BOOL Create(
    DWORD dwStyle,
    const RECT& rect,
    CWnd* pParentWnd,
    UINT nID);

Parâmetros

dwStyle
[em] Uma combinação bit a bit "ou" (|) de estilos de janela.

rect
[em] Um retângulo delimitador que especifica o tamanho e a posição da janela, nas coordenadas do cliente de pParentWnd.

pParentWnd
[em] Ponteiro para a janela pai. Não deve ser NULL.

nID
[em] O ID da janela filho.

Valor de retorno

TRUE se a janela foi criada com êxito; caso contrário, FALSE.

Comentários

Para criar um controle de grade de propriedades, primeiro chame CMFCPropertyGridCtrl::CMFCPropertyGridCtrl para construir um objeto de grade de propriedades. Em seguida, ligue para CMFCPropertyGridCtrl::Create.

Exemplo

O exemplo a seguir demonstra como usar o método Create em CMFCPropertyGridCtrl classe. Este exemplo faz parte do exemplo New Controls.

// CRect rectPropList
// CMFCPropertyGridCtrl m_wndPropList
// The this pointer points to a CPage5 class which extends the CMFCPropertyPage class.
m_wndPropList.Create(WS_CHILD | WS_VISIBLE | WS_TABSTOP | WS_BORDER, rectPropList, this, (UINT)-1);

CMFCPropertyGridCtrl::DeleteProperty

Exclui a propriedade especificada do controle de grade de propriedades.

BOOL DeleteProperty(
    CMFCPropertyGridProperty*& pProp,
    BOOL bRedraw=TRUE,
    BOOL bAdjustLayout=TRUE);

Parâmetros

pProp
[em] Ponteiro para uma propriedade.

bRedraw
[em] TRUE para redesenhar o controle de grade de propriedades; caso contrário, FALSE. O valor padrão é TRUE.

bAdjustLayout
[in] TRUE recalcular como desenhar todo o texto, imagens e itens no controle Property Grid e, em seguida, desenhar o controle; caso contrário, FALSE. O valor padrão é TRUE.

Valor de retorno

TRUE se este método for bem-sucedido; caso contrário, FALSE.

Comentários

Use esse método para excluir uma propriedade e quaisquer subitens do controle de grade de propriedades.

CMFCPropertyGridCtrl::DrawControlBarColors

BOOL DrawControlBarColors() const;

Valor de retorno

Comentários

CMFCPropertyGridCtrl::EditItem

Chamado pela estrutura quando o usuário começa a modificar uma propriedade.

virtual BOOL EditItem(
    CMFCPropertyGridProperty* pProp,
    LPPOINT lptClick=NULL);

Parâmetros

pProp
[em] Ponteiro para uma propriedade.

lptClick
[em] O ponto no controle de grade de propriedades que o usuário clicou para iniciar a operação de edição. O ponto está nas coordenadas do cliente do controle. O valor padrão é NULL.

Valor de retorno

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

Comentários

CMFCPropertyGridCtrl::EnableDescriptionArea

Habilita ou desabilita a área de descrição exibida abaixo da lista de propriedades no controle de grade de propriedades.

void EnableDescriptionArea(BOOL bEnable=TRUE);

Parâmetros

bEnable
[em] TRUE para habilitar a área de descrição; FALSE desativar a área de descrição. O valor padrão é TRUE.

Comentários

A área de descrição é exibida na parte inferior do controle de grade de propriedades. Por padrão, a área de descrição está desabilitada e não está visível.

CMFCPropertyGridCtrl::EnableHeaderCtrl

Habilita ou desabilita o controle de cabeçalho na parte superior do controle de grade de propriedades.

void EnableHeaderCtrl(
    BOOL bEnable=TRUE,
    LPCTSTR lpszLeftColumn=_T("Property"),
    LPCTSTR lpszRightColumn=_T("Value"));

Parâmetros

bEnable
[in] TRUE para habilitar o controle de cabeçalho; FALSE desativar o controle de cabeçalho. O valor padrão é TRUE.

lpszLeftColumn
[em] O título da coluna esquerda do controle de cabeçalho. O valor padrão é Property.

lpszRightColumn
[em] O título da coluna direita do controle de cabeçalho. O valor padrão é Value.

CMFCPropertyGridCtrl::EndEditItem

Chamado pela estrutura quando o usuário termina de modificar uma propriedade.

virtual BOOL EndEditItem(BOOL bUpdateData=TRUE);

Parâmetros

bUpdateData
[in] TRUE para especificar que os dados de propriedade modificados devem ser validados quando a operação de edição for concluída; caso contrário, FALSE. O valor padrão é TRUE.

Valor de retorno

TRUE se a operação de edição terminar com êxito; FALSE se os dados de propriedade modificados não são válidos ou se a operação de edição deve continuar.

Comentários

CMFCPropertyGridCtrl::EnsureVisible

Rola um controle de grade de propriedades e expande os itens de propriedade até que a propriedade especificada fique visível.

void EnsureVisible(
    CMFCPropertyGridProperty* pProp,
    BOOL bExpandParents=FALSE);

Parâmetros

pProp
[em] Ponteiro para uma propriedade.

bExpandParents
[in] TRUE expandir os itens pai para tornar visível a propriedade especificada; caso contrário, FALSE. O padrão é FALSE.

Comentários

CMFCPropertyGridCtrl::ExpandAll

Expande ou recolhe todos os nós de controle de grade de propriedades.

void ExpandAll(BOOL bExpand=TRUE);

Parâmetros

bExpand
[em] TRUE expandir todos os nós; FALSE recolher todos os nós. O valor padrão é TRUE.

Comentários

CMFCPropertyGridCtrl::FindItemByData

Recupera a propriedade associada a um valor de DWORD definido pelo usuário.

CMFCPropertyGridProperty* FindItemByData(
    DWORD_PTR dwData,
    BOOL bSearchSubItems=TRUE) const;

Parâmetros

dwData
[em] Um valor DWORD.

bSearchSubItems
[em] TRUE pesquisar subitens de propriedade; caso contrário, FALSE. O valor padrão é TRUE.

Valor de retorno

Um ponteiro para o objeto de propriedade associado se esse método for bem-sucedido; caso contrário, NULL.

Comentários

Use o construtor CMFCPropertyGridCtrl::CMFCPropertyGridCtrl ou CMFCPropertyGridProperty::SetData método para associar um DWORD a uma propriedade.

CMFCPropertyGridCtrl::get_accChildCount

virtual HRESULT get_accChildCount(long* pcountChildren);

Parâmetros

[em] pcountChildren

Valor de retorno

Comentários

CMFCPropertyGridCtrl::get_accFocus

virtual HRESULT get_accFocus(VARIANT* pvarChild);

Parâmetros

[em] pvarChild

Valor de retorno

Comentários

CMFCPropertyGridCtrl::get_accHelp

virtual HRESULT get_accHelp(
    VARIANT varChild,
    BSTR* pszHelp);

Parâmetros

[em] varChild
[em] pszHelp

Valor de retorno

Comentários

CMFCPropertyGridCtrl::get_accHelpTopic

virtual HRESULT get_accHelpTopic(
    BSTR* pszHelpFile,
    VARIANT varChild,
    long* pidTopic);

Parâmetros

[em] pszHelpFile
[em] varChild
[em] pidTopic

Valor de retorno

Comentários

CMFCPropertyGridCtrl::get_accKeyboardShortcut

virtual HRESULT get_accKeyboardShortcut(
    VARIANT varChild,
    BSTR* pszKeyboardShortcut);

Parâmetros

[em] varChild
[em] pszKeyboardShortcut

Valor de retorno

Comentários

CMFCPropertyGridCtrl::get_accSelection

virtual HRESULT get_accSelection(VARIANT* pvarChildren);

Parâmetros

[em] pvarChildren

Valor de retorno

Comentários

CMFCPropertyGridCtrl::GetBkColor

Recupera a cor do plano de fundo do controle de grade de propriedades atual.

COLORREF GetBkColor() const;

Valor de retorno

Um valor de cor RGB.

Comentários

Esse método recupera a cor que a estrutura usa para desenhar o plano de fundo do controle de grade de propriedade atual. O método CMFCPropertyGridCtrl::GetTextColor recupera a cor de primeiro plano.

CMFCPropertyGridCtrl::GetBoldFont

Recupera a fonte do Windows usada para desenhar texto no controle de grade de propriedades atual em negrito.

CFont& GetBoldFont();

Valor de retorno

Uma referência a um objeto CFont que descreve as características de uma fonte em negrito.

CMFCPropertyGridCtrl::GetCurSel

Recupera a propriedade selecionada no momento.

CMFCPropertyGridProperty* GetCurSel() const;

Valor de retorno

Um ponteiro para o objeto de propriedade que corresponde ao item selecionado no controle de grade de propriedades.

Comentários

CMFCPropertyGridCtrl::GetCustomColors

Recupera as cores personalizadas atualmente definidas para elementos de controle de grade de propriedades.

void GetCustomColors(
    COLORREF& clrBackground,
    COLORREF& clrText,
    COLORREF& clrGroupBackground,
    COLORREF& clrGroupText,
    COLORREF& clrDescriptionBackground,
    COLORREF& clrDescriptionText,
    COLORREF& clrLine);

Parâmetros

clrBackground
[saídas] A cor de plano de fundo dos valores de propriedade.

clrText
[saídas] A cor dos nomes de propriedade e do texto do valor da propriedade.

clrGroupBackground
[saídas] A cor do plano de fundo de um grupo de propriedades.

clrGroupText
[saídas] A cor do texto no grupo de propriedades.

clrDescriptionBackground
[saídas] A cor de fundo da área de descrição.

clrDescriptionText
[saídas] A cor do texto na área de descrição.

clrLine
[saídas] A cor das linhas que são desenhadas entre as propriedades.

Comentários

Use o método CMFCPropertyGridCtrl::SetCustomColors para definir cores personalizadas.

CMFCPropertyGridCtrl::GetDescriptionHeight

Recupera a altura da área de descrição, que está localizada na parte inferior do controle de grade de propriedades.

int GetDescriptionHeight() const;

Valor de retorno

A altura da área de descrição, em pixels.

Comentários

A altura da área de descrição é calculada automaticamente e é definida como 1/4 da altura do controle de grade de propriedades.

Use o método CMFCPropertyGridCtrl::EnableDescriptionArea para exibir ou ocultar a área de descrição. Use o método CMFCPropertyGridCtrl::IsDescriptionArea para determinar se a área de descrição é exibida ou oculta.

CMFCPropertyGridCtrl::GetDescriptionRows

Recupera o número de linhas na área de descrição do controle de grade de propriedades atual.

int GetDescriptionRows() const;

Valor de retorno

O número de linhas na área de descrição do controle de grade de propriedades atual.

Comentários

O construtor CMFCPropertyGridCtrl::CMFCPropertyGridCtrl inicializa a área de descrição para 3 linhas.

CMFCPropertyGridCtrl::GetHeaderCtrl

Recupera o objeto CMFCHeaderCtrl interno que a estrutura usa para exibir o controle de grade de propriedades atual.

virtual CMFCHeaderCtrl& GetHeaderCtrl();

Valor de retorno

Uma referência a um objeto CMFCHeaderCtrl.

CMFCPropertyGridCtrl::GetHeaderHeight

Recupera a altura do cabeçalho de um controle de grade de propriedades.

int GetHeaderHeight() const;

Valor de retorno

A altura do cabeçalho, em pixels.

Comentários

CMFCPropertyGridCtrl::GetLeftColumnWidth

Recupera a largura da coluna esquerda do controle de grade de propriedade atual, que contém o nome de cada propriedade.

int GetLeftColumnWidth() const;

Valor de retorno

A largura da coluna de nome.

Comentários

A coluna direita de um controle de grade de propriedades contém o valor de cada propriedade.

CMFCPropertyGridCtrl::GetListRect

Recupera o retângulo delimitador do controle de grade de propriedades.

CRect GetListRect() const;

Valor de retorno

O retângulo delimitador do controle de grade de propriedades. Este retângulo não inclui a área de descrição e o cabeçalho.

Comentários

CMFCPropertyGridCtrl::GetProperty

Recupera um ponteiro para o objeto de propriedade que corresponde ao índice especificado de um item em um controle de grade de propriedades.

CMFCPropertyGridProperty* GetProperty(int nIndex) const;

Parâmetros

nIndex
[em] O índice baseado em zero de um item de controle de grade de propriedades.

Este método afirma se o parâmetro nIndex é menor que zero ou maior que ou igual ao número de propriedades.

Valor de retorno

Um ponteiro para o objeto de propriedade que corresponde ao índice especificado se esse método for bem-sucedido; caso contrário, NULL.

Comentários

CMFCPropertyGridCtrl::GetPropertyColumnWidth

Recupera a largura atual da coluna que contém valores de propriedade.

int GetPropertyColumnWidth() const;

Valor de retorno

A largura atual da coluna que contém valores de propriedade.

Comentários

A coluna à direita no controle de grade de propriedades contém os valores de propriedade. Um cliente pode usar a caixa de divisão do controle de grade de propriedades para alterar a largura da coluna de valores.

CMFCPropertyGridCtrl::GetPropertyCount

Recupera o número de propriedades em um controle de grade de propriedades.

int GetPropertyCount() const;

Valor de retorno

O número de propriedades.

Comentários

CMFCPropertyGridCtrl::GetRowHeight

Recupera a altura de uma linha no controle de grade de propriedades.

int GetRowHeight() const;

Valor de retorno

A altura de uma linha.

Comentários

A altura de uma linha é igual à altura da fonte atual mais 4 pixels.

CMFCPropertyGridCtrl::GetScrollBarCtrl

Recupera um ponteiro para o controle de barra de rolagem no controle de grade de propriedades.

virtual CScrollBar* GetScrollBarCtrl(int nBar) const;

Parâmetros

nBar
[em] A orientação da barra de rolagem, que deve ser SB_VERT.

Valor de retorno

Um ponteiro para um objeto da barra de rolagem, ou NULL se não houver barra de rolagem ou se a orientação da barra de rolagem estiver SB_HORZ.

Comentários

Use esse método para obter acesso direto ao controle de barra de rolagem vertical.

CMFCPropertyGridCtrl::GetTextColor

Recupera a cor usada para desenhar o texto de itens de propriedade no controle de grade de propriedades atual.

COLORREF GetTextColor() const;

Valor de retorno

Um valor de cor RGB.

Comentários

Esse método recupera a cor que a estrutura usa para desenhar o primeiro plano do controle de grade de propriedades atual. O método CMFCPropertyGridCtrl::GetBkColor recupera a cor do plano de fundo.

CMFCPropertyGridCtrl::HitTest

Recupera um ponteiro para o objeto de propriedade que corresponde a um item de controle de grade de propriedades se um ponto especificado estiver no item. Esse método também indica a área no controle de grade de propriedades que contém o ponto.

CMFCPropertyGridProperty* HitTest(
    CPoint pt,
    CMFCPropertyGridProperty::ClickArea* pnArea=NULL,
    BOOL bPropsOnly=FALSE) const;

Parâmetros

pt
[em] Um ponto, nas coordenadas do cliente.

pnArea
[dentro, fora] Um ponteiro para uma variável ClickArea. Quando esse método retorna, a variável indica a área de propriedade que contém o ponto especificado. Para obter mais informações sobre uma área de propriedade, consulte Observações.

bPropsOnly
[em] TRUE testar apenas a área do imóvel; FALSE testar a área de descrição se o ponto especificado não estiver na área da propriedade. O valor padrão é FALSE. Para obter mais informações sobre a área de descrição, consulte Observações.

Valor de retorno

Se o parâmetro bPropsOnly for TRUE e o ponto especificado estiver em uma área de propriedade, o valor de retorno será um ponteiro para o objeto de propriedade correspondente. Além disso, o parâmetro pnArea é definido para a área específica que contém o ponto especificado. Caso contrário, o valor de retorno será NULL e o parâmetro pnArea não será modificado.

Se o parâmetro bPropsOnly for FALSE, o valor de retorno será sempre NULL. No entanto, se o ponto especificado estiver na área de descrição, o parâmetro pnArea será definido como CMFCPropertyGridProperty::ClickDescription.

Comentários

O termo área de propriedade refere-se a qualquer uma das áreas de caixa de nome, valor ou expansão de um item de controle de grade de propriedade. A área de descrição é a zona na parte inferior de um controle de grade de propriedades. Quando você seleciona um item de controle de grade de propriedade, a área de descrição exibe uma descrição da propriedade correspondente.

Este método define o valor da variável para a qual o parâmetro pnArea aponta. A tabela a seguir lista os valores possíveis e as áreas correspondentes.

CMFCPropertyGridCtrl::Init

Chamado pela estrutura para inicializar um controle de grade de propriedades.

virtual void Init();

Comentários

CMFCPropertyGridCtrl::InitHeader

Inicializa o objeto CMFCHeaderCtrl interno que a estrutura usa para exibir o controle de grade de propriedades atual.

virtual void InitHeader();

CMFCPropertyGridCtrl::IsAlphabeticMode

Indica se um controle de grade de propriedades está no modo alfabético.

BOOL IsAlphabeticMode() const;

Valor de retorno

TRUE se o controle de grade de propriedades estiver no modo alfabético; caso contrário, FALSE.

Comentários

Quando o controle de grade de propriedades está no modo alfabético, todas as propriedades são classificadas alfabeticamente por seus nomes. Caso contrário, as propriedades serão agrupadas em seus nós pai.

Use o método CMFCPropertyGridCtrl::SetAlphabeticMode para habilitar ou desabilitar o modo alfabético.

CMFCPropertyGridCtrl::IsAlwaysShowUserToolTip

BOOL IsAlwaysShowUserToolTip() const;

Valor de retorno

Comentários

CMFCPropertyGridCtrl::IsDescriptionArea

Indica se a área de descrição do controle de grade de propriedades é exibida.

BOOL IsDescriptionArea() const;

Valor de retorno

TRUE se a área de descrição for exibida; caso contrário, FALSE.

Comentários

Use o método CMFCPropertyGridCtrl::EnableDescriptionArea para ocultar ou exibir a área de descrição.

CMFCPropertyGridCtrl::IsGroupNameFullWidth

Indica se cada nome de grupo de propriedades é exibido na largura do controle de grade de propriedades atual.

BOOL IsGroupNameFullWidth() const;

Valor de retorno

TRUE se os nomes dos grupos são exibidos na largura do controle de grade de propriedades; FALSE se os nomes de grupo são truncados pela coluna direita (valor) do controle.

Comentários

Um grupo é uma coleção de propriedades relacionadas em um controle de grade de propriedades. Se o controle for exibido hierarquicamente, o nome do grupo será exibido como um título de categoria na linha acima do grupo.

CMFCPropertyGridCtrl::IsHeaderCtrl

Indica se o controle de cabeçalho é exibido.

BOOL IsHeaderCtrl() const;

Valor de retorno

TRUE se o controle de cabeçalho é exibido; caso contrário, FALSE.

Comentários

Use o método CMFCPropertyGridCtrl::EnableHeaderCtrl para ocultar ou exibir o controle de cabeçalho.

CMFCPropertyGridCtrl::IsMarkModifiedProperties

Indica como o controle de grade de propriedades exibe propriedades modificadas.

BOOL IsMarkModifiedProperties() const;

Valor de retorno

TRUE se o estilo negrito for usado para exibir propriedades modificadas; FALSE se o estilo regular for usado para exibir propriedades modificadas.

Comentários

CMFCPropertyGridCtrl::IsShowDragContext

Indica se a estrutura redesenha as colunas de nome e valor do controle de grade de propriedades atual quando um usuário redimensiona as colunas.

BOOL IsShowDragContext() const;

Valor de retorno

TRUE se a estrutura redesenha as colunas de nome e valor durante uma operação de redimensionamento; FALSE se a estrutura redesenha as colunas após a conclusão da operação de arrastar.

Comentários

O usuário pode redimensionar as colunas de nome e valor de um controle de grade de propriedades arrastando a barra de divisão que está entre as colunas. Se o contexto de arrastar for exibido, as colunas de nome e valor serão redimensionadas, desde que o usuário arraste a barra de divisão. Caso contrário, a barra de divisão se move, mas as colunas não são redesenhadas até que a operação de arrastar seja concluída.

CMFCPropertyGridCtrl::IsVSDotNetLook

Indica se a aparência do controle de grade de propriedades está no estilo do Visual Studio .NET.

BOOL IsVSDotNetLook() const;

Valor de retorno

TRUE se o controle de grade de propriedades estiver no estilo do Visual Studio .NET; caso contrário, FALSE.

Comentários

Use o método CMFCPropertyGridCtrl::SetVSDotNetLook para definir o controle de grade de propriedades para o estilo do Visual Studio .NET.

CMFCPropertyGridCtrl::MarkModifiedProperties

Especifica como exibir propriedades modificadas.

void MarkModifiedProperties(
    BOOL bMark=TRUE,
    BOOL bRedraw=TRUE);

Parâmetros

bMark
[in] TRUE para exibir propriedades modificadas em negrito; FALSE para exibir propriedades modificadas em estilo regular. O valor padrão é TRUE.

bRedraw
[em] TRUE redesenhar o controle da grade de propriedades imediatamente; caso contrário, FALSE. O valor padrão é TRUE.

Comentários

CMFCPropertyGridCtrl::OnChangeSelection

Chamado pelo quadro quando a seleção atual é alterada.

virtual void OnChangeSelection(
    CMFCPropertyGridProperty* pNewSel,
    CMFCPropertyGridProperty* pOldSel);

Parâmetros

pNewSel
[em] Ponteiro para a propriedade recém-selecionada.

pOldSel
[em] Ponteiro para a propriedade selecionada anteriormente.

Comentários

A implementação padrão desse método não faz nada.

CMFCPropertyGridCtrl::OnClickButton

Chamado pela estrutura quando um botão de propriedade é clicado.

virtual void OnClickButton(CPoint point);

Parâmetros

point
[em] Um ponto, nas coordenadas do cliente.

Comentários

Por padrão, esse método atualiza o valor da propriedade atual.

CMFCPropertyGridCtrl::OnDrawBorder

Chamado pela estrutura para desenhar uma borda em torno de um controle de grade de propriedade.

virtual void OnDrawBorder(CDC* pDC);

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

Comentários

CMFCPropertyGridCtrl::OnDrawDescription

Chamado pela estrutura para desenhar a área de descrição e exibir o texto da descrição.

virtual void OnDrawDescription(
    CDC* pDC,
    CRect rect);

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

rect
[em] Um retângulo que especifica onde desenhar a área de descrição.

Comentários

Use o método CMFCPropertyGridCtrl::EnableDescriptionArea para exibir a área de descrição.

CMFCPropertyGridCtrl::OnDrawList

Chamado pela estrutura para exibir a lista de propriedades no controle de grade de propriedades.

virtual void OnDrawList(CDC* pDC);

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

Comentários

CMFCPropertyGridCtrl::OnDrawProperty

Chamado pela estrutura para exibir uma propriedade.

virtual int OnDrawProperty(
    CDC* pDC,
    CMFCPropertyGridProperty* pProp) const;

Parâmetros

pDC
[em] Um ponteiro para um contexto de dispositivo.

pProp
[em] Um ponteiro para um objeto de propriedade.

Valor de retorno

TRUE se este método for bem-sucedido; caso contrário, FALSE.

Comentários

CMFCPropertyGridCtrl::OnPropertyChanged

Chamado pela estrutura quando o valor de uma propriedade é alterado.

virtual void OnPropertyChanged(CMFCPropertyGridProperty* pProp) const;

Parâmetros

pProp
[em] Um ponteiro para um objeto de propriedade cujo valor foi alterado.

Comentários

Por padrão, esse método envia a mensagem AFX_WM_PROPERTY_CHANGED para o proprietário do controle de grade de propriedade.

CMFCPropertyGridCtrl::OnSelectCombo

Chamado pela estrutura quando uma propriedade que contém um controle de caixa de combinação é selecionada.

void OnSelectCombo();

Comentários

CMFCPropertyGridCtrl::RemoveAll

Remove todos os objetos de propriedade de um controle de grade de propriedades.

void RemoveAll();

Comentários

CMFCPropertyGridCtrl::ResetOriginalValues

Restaura os valores originais de todas as propriedades.

void ResetOriginalValues(BOOL bRedraw=TRUE);

Parâmetros

bRedraw
[em] TRUE redesenhar a lista de propriedades; caso contrário, FALSE. O valor padrão é TRUE.

Comentários

CMFCPropertyGridCtrl::SetAlphabeticMode

Define ou redefine o modo alfabético.

void SetAlphabeticMode(BOOL bSet=TRUE);

Parâmetros

bSet
[em] TRUE para definir o modo alfabético; FALSE redefinir o modo alfabético. O valor padrão é TRUE.

Comentários

Quando o controle de grade de propriedades está no modo alfabético, o controle classifica todas as propriedades que ele contém pelo nome da propriedade.

CMFCPropertyGridCtrl::SetBoolLabels

Especifica o texto dos rótulos booleanos.

void SetBoolLabels(
    LPCTSTR lpszTrue,
    LPCTSTR lpszFalse);

Parâmetros

lpszTrue
[em] A cadeia de caracteres de texto a ser exibida para o valor booleano de true.

lpszFalse
[em] A cadeia de caracteres de texto a ser exibida para o valor booleano de false.

Comentários

CMFCPropertyGridCtrl::SetCurSel

Seleciona uma propriedade em um controle de grade de propriedades.

void SetCurSel(
    CMFCPropertyGridProperty* pProp,
    BOOL bRedraw=TRUE);

Parâmetros

pProp
[em] Um ponteiro para um objeto de propriedade.

bRedraw
[em] TRUE redesenhar o controle da grade de propriedades imediatamente; caso contrário, FALSE. O valor padrão é TRUE.

Comentários

Use esse método para cancelar a seleção do item atual no controle de grade de propriedades e, em seguida, selecione o item que corresponde à propriedade especificada.

CMFCPropertyGridCtrl::SetCustomColors

Especifica cores personalizadas para vários elementos do controle de grade de propriedades.

void SetCustomColors(
    COLORREF clrBackground,
    COLORREF clrText,
    COLORREF clrGroupBackground,
    COLORREF clrGroupText,
    COLORREF clrDescriptionBackground,
    COLORREF clrDescriptionText,
    COLORREF clrLine);

Parâmetros

clrBackground
[em] A cor de plano de fundo dos valores de propriedade.

clrText
[em] A cor dos nomes de propriedade e do texto do valor da propriedade.

clrGroupBackground
[em] A cor do plano de fundo de um grupo de propriedades.

clrGroupText
[em] A nova cor do texto do grupo de propriedades.

clrDescriptionBackground
[em] A cor de fundo da área de descrição.

clrDescriptionText
[em] A cor do texto na área de descrição.

clrLine
[em] A cor das linhas que são desenhadas entre as propriedades.

Comentários

Para qualquer parâmetro, especifique o valor de cor ((COLORREF)-1) para usar a cor padrão para esse elemento do controle de grade de propriedades.

Para personalizar a aparência de uma propriedade específica, derive uma classe da classe CMFCPropertyGridProperty e, em seguida, substitua os métodos CMFCPropertyGridProperty::OnDrawName, CMFCPropertyGridProperty::OnDrawValue, CMFCPropertyGridProperty::OnDrawExpandBoxe CMFCPropertyGridProperty::OnDrawButton.

CMFCPropertyGridCtrl::SetDescriptionRows

Especifica o número de linhas a serem exibidas na seção de descrição do controle de grade de propriedades atual.

void SetDescriptionRows(int nDescRows);

Parâmetros

nDescRows
[em] O número de linhas a serem exibidas na descrição da propriedade.

CMFCPropertyGridCtrl::SetGroupNameFullWidth

Especifica se a largura total do nome da categoria deve ser exibida para um grupo de propriedades no controle de grade de propriedades atual.

void SetGroupNameFullWidth(
    BOOL bGroupNameFullWidth = TRUE,
    BOOL bRedraw = TRUE);

Parâmetros

bGroupNameFullWidth
[in] TRUE para exibir a largura completa do nome da categoria, independentemente da largura da coluna Nome da propriedade. FALSE limitar a largura do nome da categoria à largura da coluna Nome da propriedade. O valor padrão é TRUE.

bRedraw
[in] TRUE atualizar o controle de grade de propriedades imediatamente; FALSE atualizar o controle quando ocorrer o próximo evento de redesenho. O valor padrão é TRUE.

Comentários

O controle de grade de propriedades consiste em um redimensionável nome de propriedade coluna e um valor de propriedade coluna. O final da coluna de nome também é o início da coluna de valor. Para redimensionar as colunas, arraste a borda entre as colunas.

Os termos nome do grupo e nome da categoria são usados indistintamente neste método. O nome da categoria é exibido em uma linha que encabeça um conjunto de propriedades e valores relacionados. Este método especifica se a largura da coluna de nome da propriedade também especifica a largura do nome da categoria exibida.

CMFCPropertyGridCtrl::SetListDelimiter

Define um caractere que é usado como um delimitador em uma lista de valores de propriedade.

void SetListDelimiter(TCHAR c);

Parâmetros

c
[em] Um personagem para servir de delimitador.

Comentários

Use esse método para definir um caractere delimitador em uma lista de valores de propriedade que são usados no construtor CMFCPropertyGridProperty::CMFCPropertyGridProperty. Nesse construtor, defina o parâmetro bIsValueList como TRUE.

Por padrão, o construtor CMFCPropertyGridCtrl::CMFCPropertyGridCtrl define o caractere delimitador como vírgula (',').

CMFCPropertyGridCtrl::SetShowDragContext

Especifica se a estrutura redesenha as colunas de nome e valor do controle de grade de propriedades atual quando um usuário redimensiona as colunas.

void SetShowDragContext(BOOL bShowDragContext = TRUE);

Parâmetros

bShowDragContext
[in] TRUE redesenhar as colunas de nome e valor durante uma operação de redimensionamento; FALSE redesenhar as colunas após a conclusão da operação de arrastar. O valor padrão é TRUE.

Comentários

O usuário pode redimensionar as colunas de nome e valor de um controle de grade de propriedades arrastando a barra de divisão que está entre as colunas. Se o contexto de arrastar for exibido, as colunas de nome e valor serão redimensionadas, desde que o usuário arraste a barra de divisão. Caso contrário, a barra de divisão se move, mas as colunas não são redesenhadas até que a operação de arrastar seja concluída.

CMFCPropertyGridCtrl::SetVSDotNetLook

Define a aparência do controle de grade de propriedades para o estilo que é usado no Visual Studio .NET.

void SetVSDotNetLook(BOOL bSet=TRUE);

Parâmetros

bSet
[in] TRUE definir o controle de grade de propriedades para o estilo usado no Visual Studio .NET; caso contrário, FALSE. O valor padrão é TRUE.

Comentários

CMFCPropertyGridCtrl::UpdateColor

Define o valor de cor da propriedade de cor selecionada no momento.

virtual void UpdateColor(COLORREF color);

Parâmetros

color
[em] Um valor de cor RGB.

Comentários

Esse método afirma no modo de depuração se a propriedade atualmente selecionada do controle de grade de propriedades não for uma propriedade color.

CMFCPropertyGridCtrl::ValidateItemData

Chamado pela estrutura para validar dados de propriedade.

virtual BOOL ValidateItemData(CMFCPropertyGridProperty* pProp);

Parâmetros

pProp
[em] Ponteiro para uma propriedade. Este parâmetro não é usado.

Valor de retorno

Sempre TRUE.

Comentários

O método CMFCPropertyGridCtrl::EndEditItem chama esse método para validar dados. Por padrão, esse método não usa seu parâmetro pProp e seu valor de retorno é sempre TRUE.

Se você substituir esse método, retorne TRUE se os dados de propriedade especificados forem válidos. Caso contrário, retorne FALSE, caso em que a estrutura não atualiza a propriedade.

Ver também

Gráfico de Hierarquia
Aulas