Estrutura TASKDIALOGCONFIG (commctrl.h)
A estrutura TASKDIALOGCONFIG contém informações usadas para exibir uma caixa de diálogo de tarefa. A função TaskDialogIndirect usa essa estrutura.
Sintaxe
typedef struct _TASKDIALOGCONFIG {
UINT cbSize;
HWND hwndParent;
HINSTANCE hInstance;
TASKDIALOG_FLAGS dwFlags;
TASKDIALOG_COMMON_BUTTON_FLAGS dwCommonButtons;
PCWSTR pszWindowTitle;
union {
HICON hMainIcon;
PCWSTR pszMainIcon;
} DUMMYUNIONNAME;
PCWSTR pszMainInstruction;
PCWSTR pszContent;
UINT cButtons;
const TASKDIALOG_BUTTON *pButtons;
int nDefaultButton;
UINT cRadioButtons;
const TASKDIALOG_BUTTON *pRadioButtons;
int nDefaultRadioButton;
PCWSTR pszVerificationText;
PCWSTR pszExpandedInformation;
PCWSTR pszExpandedControlText;
PCWSTR pszCollapsedControlText;
union {
HICON hFooterIcon;
PCWSTR pszFooterIcon;
} DUMMYUNIONNAME2;
PCWSTR pszFooter;
PFTASKDIALOGCALLBACK pfCallback;
LONG_PTR lpCallbackData;
UINT cxWidth;
} TASKDIALOGCONFIG;
Membros
cbSize
Tipo: UINT
Especifica o tamanho da estrutura, em bytes.
hwndParent
Tipo: HWND
Identificador para a janela pai. Esse membro pode ser NULL.
hInstance
Tipo: HINSTANCE
Manipule para o módulo que contém o recurso de ícone identificado pelos membros pszMainIcon ou pszFooterIcon e os recursos de cadeia de caracteres identificados pelos membros pszWindowTitle, pszMainInstruction, pszContent, pszVerificationText, pszExpandedInformation, pszExpandedControlText, pszCollapsedControlText ou pszFooter .
dwFlags
Tipo: TASKDIALOG_FLAGS
Especifica o comportamento da caixa de diálogo da tarefa. Esse parâmetro pode ser uma combinação de sinalizadores do seguinte grupo:
| Valor | Significado |
|---|---|
|
Habilita o processamento de hiperlink para as cadeias de caracteres especificadas nos membros pszContent, pszExpandedInformation e pszFooter . Quando habilitados, esses membros podem apontar para cadeias de caracteres que contêm hiperlinks na seguinte forma:Aviso: habilitar hiperlinks ao usar conteúdo de uma fonte não segura pode causar vulnerabilidades de segurança.
Nota As caixas de diálogo de tarefa não executarão nenhum hiperlink. A execução do hiperlink deve ser tratada na função de retorno de chamada especificada por pfCallback. Para obter mais detalhes, consulte TaskDialogCallbackProc.
|
|
Indica que a caixa de diálogo deve usar o ícone referenciado pelo identificador no membro hMainIcon como o ícone principal na caixa de diálogo da tarefa. Se esse sinalizador for especificado, o membro pszMainIcon será ignorado. |
|
Indica que a caixa de diálogo deve usar o ícone referenciado pelo identificador no membro hFooterIcon como o ícone de rodapé na caixa de diálogo da tarefa. Se esse sinalizador for especificado, o membro pszFooterIcon será ignorado. |
|
Indica que a caixa de diálogo deve ser capaz de ser fechada usando Alt-F4, Escape e o botão fechar da barra de título, mesmo que nenhum botão cancelar seja especificado nos membros dwCommonButtons ou pButtons . |
|
Indica que os botões especificados no membro pButtons devem ser exibidos como links de comando (usando um glifo de caixa de diálogo de tarefa padrão) em vez de botões de push. Ao usar links de comando, todos os caracteres até o primeiro caractere de linha novo no membro pszButtonText serão tratados como texto main do link de comando e o restante será tratado como a anotação do link de comando. Esse sinalizador será ignorado se o membro cButtons for zero. |
|
Indica que os botões especificados no membro pButtons devem ser exibidos como links de comando (sem um glifo) em vez de botões de push. Ao usar links de comando, todos os caracteres até o primeiro caractere de linha novo no membro pszButtonText serão tratados como texto main do link de comando e o restante será tratado como a anotação do link de comando. Esse sinalizador será ignorado se o membro cButtons for zero. |
|
Indica que a cadeia de caracteres especificada pelo membro pszExpandedInformation é exibida na parte inferior da área do rodapé da caixa de diálogo, em vez de imediatamente após o conteúdo da caixa de diálogo. Esse sinalizador será ignorado se o membro pszExpandedInformation for NULL. |
|
Indica que a cadeia de caracteres especificada pelo membro pszExpandedInformation é exibida quando a caixa de diálogo é inicialmente exibida. Esse sinalizador será ignorado se o membro pszExpandedInformation for NULL. |
|
Indica que a caixa de seleção de verificação na caixa de diálogo é marcada quando a caixa de diálogo é exibida inicialmente. Esse sinalizador será ignorado se o parâmetro pszVerificationText for NULL. |
|
Indica que uma Barra de Progresso deve ser exibida. |
|
Indica que uma Barra de Progresso do Letreiro deve ser exibida. |
|
Indica que o retorno de chamada da caixa de diálogo da tarefa deve ser chamado aproximadamente a cada 200 milissegundos. |
|
Indica que a caixa de diálogo da tarefa está posicionada (centralizada) em relação à janela especificada por hwndParent. Se o sinalizador não for fornecido (ou nenhum membro hwndParent for especificado), a caixa de diálogo da tarefa será posicionada (centralizada) em relação ao monitor. |
|
Indica que o texto é exibido lendo da direita para a esquerda. |
|
Indica que nenhum item padrão será selecionado. |
|
Indica que a caixa de diálogo da tarefa pode ser minimizada. |
|
Esse sinalizador foi preterido. Em vez disso , use TDF_SIZE_TO_CONTENT . |
|
Indica que a largura da caixa de diálogo da tarefa é determinada pela largura de sua área de conteúdo. Esse sinalizador será ignorado se cxWidth não estiver definido como 0. |
dwCommonButtons
Tipo: TASKDIALOG_COMMON_BUTTON_FLAGS
Especifica os botões de push exibidos na caixa de diálogo da tarefa. Se nenhum botão comum for especificado e nenhum botão personalizado for especificado usando os membros cButtons e pButtons , a caixa de diálogo da tarefa conterá o botão OK por padrão. Esse parâmetro pode ser uma combinação de sinalizadores do seguinte grupo:
pszWindowTitle
Tipo: PCWSTR
Ponteiro que faz referência à cadeia de caracteres a ser usada para o título da caixa de diálogo da tarefa. Esse parâmetro pode ser uma cadeia de caracteres terminada em nulo ou um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE . Se esse parâmetro for NULL, o nome do arquivo do programa executável será usado.
DUMMYUNIONNAME
DUMMYUNIONNAME.hMainIcon
Tipo: HICON
Um identificador para um Ícone que deve ser exibido na caixa de diálogo da tarefa. Esse membro é ignorado, a menos que o sinalizador TDF_USE_HICON_MAIN seja especificado. Se esse membro for NULL e o TDF_USE_HICON_MAIN for especificado, nenhum ícone será exibido.
DUMMYUNIONNAME.pszMainIcon
Tipo: PCWSTR
Ponteiro que faz referência ao ícone a ser exibido na caixa de diálogo da tarefa. Esse parâmetro será ignorado se o sinalizador USE_HICON_MAIN for especificado. Caso contrário, se esse parâmetro for NULL ou o parâmetro hInstance for NULL, nenhum ícone será exibido. Esse parâmetro deve ser um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE ou um dos seguintes valores predefinidos:
pszMainInstruction
Tipo: PCWSTR
Ponteiro que faz referência à cadeia de caracteres a ser usada para a instrução main. Esse parâmetro pode ser uma cadeia de caracteres terminada em nulo ou um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE .
pszContent
Tipo: PCWSTR
Ponteiro que faz referência à cadeia de caracteres a ser usada para o conteúdo primário da caixa de diálogo. Esse parâmetro pode ser uma cadeia de caracteres terminada em nulo ou um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE . Se o sinalizador ENABLE_HYPERLINKS for especificado para o membro dwFlags , essa cadeia de caracteres poderá conter hiperlinks no formulário: <A HREF="executablestring">Hyperlink Text</A>. AVISO: habilitar hiperlinks ao usar o conteúdo de uma fonte não segura pode causar vulnerabilidades de segurança.
cButtons
Tipo: UINT
O número de entradas na matriz pButtons que é usada para criar botões ou links de comando na caixa de diálogo da tarefa. Se esse membro for zero e nenhum botão comum tiver sido especificado usando o membro dwCommonButtons , a caixa de diálogo da tarefa terá um único botão OK exibido.
pButtons
Tipo: const TASKDIALOG_BUTTON*
Ponteiro para uma matriz de estruturas de TASKDIALOG_BUTTON que contém a definição dos botões personalizados que devem ser exibidos na caixa de diálogo da tarefa. Essa matriz deve conter pelo menos o número de entradas especificadas pelo membro cButtons .
nDefaultButton
Tipo: int
O botão padrão da caixa de diálogo da tarefa. Isso pode ser qualquer um dos valores especificados em membros nButtonID de uma das estruturas TASKDIALOG_BUTTON na matriz pButtons ou uma das IDs correspondentes aos botões especificados no membro dwCommonButtons :
| IDCANCEL | Torne o botão Cancelar o padrão. |
| IDNO | Torne o botão Não o padrão. |
| IDOK | Torne o botão OK o padrão. |
| IDRETRY | Torne o botão Repetir o padrão. |
| IDYES | Torne o botão Sim o padrão. |
| IDCLOSE | Torne o botão Fechar o padrão. |
Se esse membro for zero ou seu valor não corresponder a nenhuma ID de botão na caixa de diálogo, o primeiro botão na caixa de diálogo será o padrão.
cRadioButtons
Tipo: UINT
O número de entradas na matriz pRadioButtons que é usada para criar botões de opção na caixa de diálogo da tarefa.
pRadioButtons
Tipo: const TASKDIALOG_BUTTON*
Ponteiro para uma matriz de estruturas TASKDIALOG_BUTTON que contêm a definição dos botões de opção que devem ser exibidos na caixa de diálogo da tarefa. Essa matriz deve conter pelo menos o número de entradas especificadas pelo membro cRadioButtons . Este parâmetro pode ser NULL.
nDefaultRadioButton
Tipo: int
A ID do botão de opção selecionada por padrão. Se esse valor não corresponder a uma ID de botão, o primeiro botão na matriz será selecionado por padrão.
pszVerificationText
Tipo: PCWSTR
Ponteiro que faz referência à cadeia de caracteres a ser usada para rotular a caixa de seleção de verificação. Esse parâmetro pode ser uma cadeia de caracteres terminada em nulo ou um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE . Se esse parâmetro for NULL, a caixa de seleção de verificação não será exibida na caixa de diálogo da tarefa. Se o parâmetro pfVerificationFlagChecked de TaskDialogIndirect for NULL, a caixa de seleção não estará habilitada.
pszExpandedInformation
Tipo: PCWSTR
Ponteiro que faz referência à cadeia de caracteres a ser usada para exibir informações adicionais. Esse parâmetro pode ser uma cadeia de caracteres terminada em nulo ou um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE . As informações adicionais são exibidas imediatamente abaixo do conteúdo ou abaixo do texto do rodapé, dependendo se o sinalizador TDF_EXPAND_FOOTER_AREA é especificado. Se o sinalizador TDF_ENABLE_HYPERLINKS for especificado para o membro dwFlags , essa cadeia de caracteres poderá conter hiperlinks no formulário: <A HREF="executablestring">Hyperlink Text</A>. AVISO: habilitar hiperlinks ao usar o conteúdo de uma fonte não segura pode causar vulnerabilidades de segurança.
pszExpandedControlText
Tipo: PCWSTR
Ponteiro que faz referência à cadeia de caracteres a ser usada para rotular o botão para recolher as informações expansíveis. Esse parâmetro pode ser uma cadeia de caracteres terminada em nulo ou um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE . Esse membro é ignorado quando o membro pszExpandedInformation é NULL. Se esse membro for NULL e o pszCollapsedControlText for especificado, o valor pszCollapsedControlText também será usado para esse membro.
pszCollapsedControlText
Tipo: PCWSTR
Ponteiro que faz referência à cadeia de caracteres a ser usada para rotular o botão para expandir as informações expansíveis. Esse parâmetro pode ser uma cadeia de caracteres terminada em nulo ou um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE . Esse membro é ignorado quando o membro pszExpandedInformation é NULL. Se esse membro for NULL e o pszCollapsedControlText for especificado, o valor pszCollapsedControlText também será usado para esse membro.
DUMMYUNIONNAME2
DUMMYUNIONNAME2.hFooterIcon
Tipo: HICON
Um identificador para um Ícone que deve ser exibido no rodapé da caixa de diálogo da tarefa. Esse membro é ignorado, a menos que o sinalizador TDF_USE_HICON_FOOTER seja especificado e o pszFooterIcon não seja. Se esse membro for NULL e o TDF_USE_HICON_FOOTER for especificado, nenhum ícone será exibido.
DUMMYUNIONNAME2.pszFooterIcon
Tipo: PCWSTR
Ponteiro que faz referência ao ícone a ser exibido na área do rodapé da caixa de diálogo da tarefa. Esse parâmetro será ignorado se o sinalizador TDF_USE_HICON_FOOTER for especificado ou se pszFooter for NULL. Caso contrário, se esse parâmetro for NULL ou o parâmetro hInstance for NULL, nenhum ícone será exibido. Esse parâmetro deve ser um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE ou um dos valores predefinidos listados para pszMainIcon.
pszFooter
Tipo: PCWSTR
Ponteiro para a cadeia de caracteres a ser usada na área do rodapé da caixa de diálogo da tarefa. Esse parâmetro pode ser uma cadeia de caracteres terminada em nulo ou um identificador de recurso inteiro passado para a macro MAKEINTRESOURCE . Se o sinalizador TDF_ENABLE_HYPERLINKS for especificado para o membro dwFlags , essa cadeia de caracteres poderá conter hiperlinks nesse formulário.
<A HREF="executablestring">Hyperlink Text</A>
pfCallback
Tipo: PFTASKDIALOGCALLBACK
Ponteiro para uma função de retorno de chamada definida pelo aplicativo. Para obter mais informações, consulte TaskDialogCallbackProc.
lpCallbackData
Tipo: LONG_PTR
Um ponteiro para dados de referência definidos pelo aplicativo. Esse valor é definido pelo chamador.
cxWidth
Tipo: UINT
A largura da área de cliente da caixa de diálogo da tarefa, em unidades de diálogo. Se 0, o gerenciador de caixa de diálogo da tarefa calculará a largura ideal.
Requisitos
| Cliente mínimo com suporte | Windows Vista [somente aplicativos da área de trabalho] |
| Servidor mínimo com suporte | Windows Server 2008 [somente aplicativos da área de trabalho] |
| Cabeçalho | commctrl.h |