Classe COlePropertyPage

Usado para mostrar as propriedades de um controlo personalizado numa interface gráfica, semelhante a uma caixa de diálogo.

Sintaxe

class AFX_NOVTABLE COlePropertyPage : public CDialog

Membros

Construtores Públicos

Métodos Públicos

Observações

Por exemplo, uma página de propriedades pode incluir um controlo de edição que permite ao utilizador visualizar e modificar a propriedade da legenda do controlo.

Cada propriedade personalizada ou de controlo de stock pode ter um controlo de diálogo que permite ao utilizador do controlo visualizar o valor atual da propriedade e modificá-lo, se necessário.

Para mais informações sobre a utilização COlePropertyPagede , consulte o artigo Controlos ActiveX: Páginas de Propriedades.

Hierarquia de herança

CObject

CCmdTarget

CWnd

CDialog

COlePropertyPage

Requerimentos

Cabeçalho: afxctl.h

COlePropertyPage::COlePropertyPage:COleProperty

Constrói um COlePropertyPage objeto.

COlePropertyPage(
    UINT idDlg,
    UINT idCaption);

Parâmetros

idDlg
ID de recurso do modelo de diálogo.

idCaption
ID de recurso da legenda da página da propriedade.

Observações

Quando implementa uma subclasse de COlePropertyPage, o construtor da sua subclasse deve usar o COlePropertyPage construtor para identificar o recurso modelo de diálogo sobre o qual a página de propriedades se baseia e o recurso string que contém a sua legenda.

ColePropertyPage::GetControlStatus

Determina se o utilizador modificou o valor do controlo da página de propriedades com o ID de recurso especificado.

BOOL GetControlStatus(UINT nID);

Parâmetros

nID
ID de recurso de um controlo de página de propriedades.

Valor de retorno

TRUE se o valor de controlo tiver sido modificado; caso contrário, FALSO.

COlePropertyPage::GetObjectArray

Devolve o array de objetos que está a ser editado pela página de propriedades.

LPDISPATCH* GetObjectArray(ULONG* pnObjects);

Parâmetros

pnObjects
Apontar para um inteiro longo sem sinal que receberá o número de objetos editados pela página.

Valor de retorno

Apontador para um array de IDispatch ponteiros, que são usados para aceder às propriedades de cada controlo na página de propriedades. O chamador não deve libertar estes ponteiros de interface.

Observações

Cada objeto da página de propriedades mantém um array de ponteiros para as IDispatch interfaces dos objetos que estão a ser editados pela página. Esta função define o seu argumento pnObjects para o número de elementos nesse array e devolve um ponteiro para o primeiro elemento do array.

COlePropertyPage::GetPageSite

Recebe um ponteiro para a interface da IPropertyPageSite página de propriedades.

LPPROPERTYPAGESITE GetPageSite();

Valor de retorno

Um ponteiro para a interface da IPropertyPageSite página de propriedades.

Observações

Os controlos e os contentores cooperam para que os utilizadores possam navegar e editar propriedades de controlo. O controlo fornece páginas de propriedades, cada uma das quais é um objeto OLE que permite ao utilizador editar um conjunto relacionado de propriedades. O contentor fornece um quadro de propriedades que mostra as páginas de propriedades. Para cada página, o frame de propriedade fornece um site de página, que suporta a IPropertyPageSite interface.

PáginaDePropriedade do Cole::IgnorarCandidatar-se

Determina quais os controlos que não ativam o botão Aplicar.

void IgnoreApply(UINT nID);

Parâmetros

nID
Identificação do controlo a ser ignorada.

Observações

O botão Aplicar da página de propriedades só está ativado quando os valores dos controlos da página de propriedades foram alterados. Use esta função para especificar controlos que não ativem o botão Aplicar quando os seus valores mudam.

Página de Propriedade de COle::ÉModificada

Determina se o utilizador alterou algum valor na página de propriedades.

BOOL IsModified();

Valor de retorno

VERDADEIRO se a página de propriedades tiver sido modificada.

PáginaDePropriedade::OnEditProperty

A estrutura chama esta função quando uma propriedade específica vai ser editada.

virtual BOOL OnEditProperty(DISPID dispid);

Parâmetros

dispid
ID de despacho da propriedade a ser editada.

Valor de retorno

A implementação padrão devolve FALSE. As sobrescrituras desta função devem devolver TRUE.

Observações

Podes sobrepor para definir o foco para o controlo apropriado na página. A implementação padrão não faz nada e devolve FALSE.

PáginaDePropriedade do Cole::OnHelp

O framework chama esta função quando o utilizador solicita ajuda online.

virtual BOOL OnHelp(LPCTSTR lpszHelpDir);

Parâmetros

lpszHelpDir
Diretório contendo o ficheiro de ajuda da página de propriedades.

Valor de retorno

A implementação padrão devolve FALSE.

Observações

Anule-a se a sua página de propriedades tiver de realizar alguma ação especial quando o utilizador aceder à ajuda. A implementação padrão não faz nada e devolve FALSE, que instrui o framework a chamar o WinHelp.

Página de Propriedades::OnInitDiálogo

O framework chama esta função quando o diálogo da página de propriedades é inicializado.

virtual BOOL OnInitDialog();

Valor de retorno

A implementação padrão devolve FALSE.

Observações

Anule-a se for necessária alguma ação especial quando o diálogo for inicializado. A implementação padrão chama CDialog::OnInitDialog e devolve FALSE.

Página de Propriedade do COle::EmObjetosAlterados

Chamado pelo framework quando outro controlo OLE, com novas propriedades, é escolhido.

virtual void OnObjectsChanged();

Observações

Ao visualizar as propriedades de um controlo OLE no ambiente de desenvolvimento, é usada uma caixa de diálogo sem modos para mostrar as suas páginas de propriedades. Se for selecionado outro controlo, deve ser exibido um conjunto diferente de páginas de propriedades para o novo conjunto de propriedades. O framework chama esta função para notificar a página de propriedades da alteração.

Sobrescrita esta função para receber notificação desta ação e realizar quaisquer ações especiais.

ColePropertyPage::OnSetPageSite

O framework chama esta função quando o frame de propriedade fornece o site da página da página de propriedades.

virtual void OnSetPageSite();

Observações

A implementação padrão carrega a legenda da página e tenta determinar o tamanho da página a partir do recurso de diálogo. Substitua esta função se a sua página de propriedades exigir qualquer ação adicional; O seu override deve chamar a implementação de classe base.

COlePropertyPage::SetControlStatus

Altera o estado de um controlo de página de propriedade.

BOOL SetControlStatus(
    UINT nID,
    BOOL bDirty);

Parâmetros

nID
Contém o ID de um controlo de página de propriedades.

bDirty
Especifica se um campo da página de propriedades foi modificado. Defina para TRUE se o campo tiver sido modificado, FALSE se não tiver sido modificado.

Valor de retorno

TRUE, se o controlo especificado estivesse definido; caso contrário, FALSO.

Observações

Se o estado de um controlo da página de propriedade estiver sujo quando a página de propriedades é encerrada ou se escolhe o botão Aplicar, a propriedade do controlo será atualizada com o valor apropriado.

COlePropertyPage::SetDialogResource

Define o recurso de diálogo da página de propriedades.

void SetDialogResource(HGLOBAL hDialog);

Parâmetros

hDiálogo
Handle para o recurso de diálogo da página de propriedades.

ColePropertyPage::SetHelpInfo

Especifica a informação de tooltip, o nome do ficheiro de ajuda e o contexto de ajuda para a sua página de propriedade.

void SetHelpInfo(
    LPCTSTR lpszDocString,
    LPCTSTR lpszHelpFile = NULL,
    DWORD dwHelpContext = 0);

Parâmetros

lpszDocString
Uma cadeia contendo informações breves de ajuda para exibição numa barra de estado ou noutro local.

lpszHelpFile
Nome do ficheiro de ajuda da página da propriedade.

dwHelpContext
Contexto de ajuda para a página da propriedade.

PáginaDePropriedade::DefinirBandeiraModificadaT

Indica se o utilizador modificou a página de propriedades.

void SetModifiedFlag(BOOL bModified = TRUE);

Parâmetros

bModified
Especifica o novo valor para a flag modificada da página de propriedades.

COlePropertyPage::SetPageName

Define o nome da página de propriedades, que normalmente será exibido no separador da página.

void SetPageName(LPCTSTR lpszPageName);

Parâmetros

lpszPageName
Apontador para uma string contendo o nome da página de propriedades.

Consulte também

Exemplo MFC CIRC3
Exemplo de MFC TESTHELP
Classe CDialog
Gráfico de Hierarquia
Classe CDialog