Estructura TASKDIALOGCONFIG (commctrl.h)

La estructura TASKDIALOGCONFIG contiene información utilizada para mostrar un cuadro de diálogo de tareas. La función TaskDialogIndirect usa esta estructura.

Sintaxis

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;

Miembros

cbSize

Tipo: UINT

Especifica el tamaño de la estructura, en bytes.

hwndParent

Tipo: HWND

Identificador de la ventana primaria. Este miembro puede ser NULL.

hInstance

Tipo: HINSTANCE

Identificador del módulo que contiene el recurso de icono identificado por los miembros pszMainIcon o pszFooterIcon , y los recursos de cadena identificados por los miembros pszWindowTitle, pszMainInstruction, pszContent, pszVerificationText, pszExpandedInformation, pszExpandedControlText, pszCollapsedControlText o pszFooter .

dwFlags

Tipo: TASKDIALOG_FLAGS

Especifica el comportamiento del cuadro de diálogo de tarea. Este parámetro puede ser una combinación de marcas del siguiente grupo:

Valor Significado
TDF_ENABLE_HYPERLINKS
Habilita el procesamiento de hipervínculos para las cadenas especificadas en los miembros pszContent, pszExpandedInformation y pszFooter . Cuando se habilita, estos miembros pueden apuntar a cadenas que contienen hipervínculos de la forma siguiente:
<A HREF="executablestring">Hyperlink Text</A>

Advertencia: La habilitación de hipervínculos al usar contenido de un origen no seguro puede provocar vulnerabilidades de seguridad.

Nota Los diálogos de tareas no ejecutarán realmente ningún hipervínculo. La ejecución del hipervínculo debe controlarse en la función de devolución de llamada especificada por pfCallback. Para obtener más información, consulte TaskDialogCallbackProc.
 
TDF_USE_HICON_MAIN
Indica que el cuadro de diálogo debe usar el icono al que hace referencia el identificador en el miembro hMainIcon como icono principal del cuadro de diálogo de tarea. Si se especifica esta marca, se omite el miembro pszMainIcon .
TDF_USE_HICON_FOOTER
Indica que el cuadro de diálogo debe usar el icono al que hace referencia el identificador en el miembro hFooterIcon como icono de pie de página en el cuadro de diálogo de tarea. Si se especifica esta marca, se omite el miembro pszFooterIcon .
TDF_ALLOW_DIALOG_CANCELLATION
Indica que el cuadro de diálogo debe poder cerrarse mediante Alt-F4, Escape y el botón cerrar de la barra de título, incluso si no se especifica ningún botón de cancelación en los miembros dwCommonButtons o pButtons .
TDF_USE_COMMAND_LINKS
Indica que los botones especificados en el miembro pButtons se mostrarán como vínculos de comandos (mediante un glifo de diálogo de tareas estándar) en lugar de botones de inserción. Al usar vínculos de comandos, todos los caracteres hasta el primer carácter de línea nuevo del miembro pszButtonText se tratarán como el texto principal del vínculo de comando y el resto se tratará como nota del vínculo de comando. Esta marca se omite si el miembro cButtons es cero.
TDF_USE_COMMAND_LINKS_NO_ICON
Indica que los botones especificados en el miembro pButtons se mostrarán como vínculos de comandos (sin glifo) en lugar de botones de inserción. Al usar vínculos de comandos, todos los caracteres hasta el primer carácter de línea nuevo del miembro pszButtonText se tratarán como el texto principal del vínculo de comando y el resto se tratará como nota del vínculo de comando. Esta marca se omite si el miembro cButtons es cero.
TDF_EXPAND_FOOTER_AREA
Indica que la cadena especificada por el miembro pszExpandedInformation se muestra en la parte inferior del área del pie de página del diálogo en lugar de inmediatamente después del contenido del diálogo. Esta marca se omite si el miembro pszExpandedInformation es NULL.
TDF_EXPANDED_BY_DEFAULT
Indica que la cadena especificada por el miembro pszExpandedInformation se muestra cuando se muestra inicialmente el cuadro de diálogo. Esta marca se omite si el miembro pszExpandedInformation es NULL.
TDF_VERIFICATION_FLAG_CHECKED
Indica que la casilla de verificación del cuadro de diálogo está activada cuando se muestra inicialmente el cuadro de diálogo. Esta marca se omite si el parámetro pszVerificationText es NULL.
TDF_SHOW_PROGRESS_BAR
Indica que se va a mostrar una barra de progreso.
TDF_SHOW_MARQUEE_PROGRESS_BAR
Indica que se va a mostrar una barra de progreso de Marquee.
TDF_CALLBACK_TIMER
Indica que se llamará a la devolución de llamada del cuadro de diálogo de tarea aproximadamente cada 200 milisegundos.
TDF_POSITION_RELATIVE_TO_WINDOW
Indica que el cuadro de diálogo de tarea está colocado (centrado) en relación con la ventana especificada por hwndParent. Si no se proporciona la marca (o no se especifica ningún miembro hwndParent ), el cuadro de diálogo de tarea se coloca (centrado) en relación con el monitor.
TDF_RTL_LAYOUT
Indica que el texto se muestra leyendo de derecha a izquierda.
TDF_NO_DEFAULT_RADIO_BUTTON
Indica que no se seleccionará ningún elemento predeterminado.
TDF_CAN_BE_MINIMIZED
Indica que se puede minimizar el cuadro de diálogo de tareas.
TDIF_SIZE_TO_CONTENT
Esta marca está en desuso. Use TDF_SIZE_TO_CONTENT en su lugar.
TDF_SIZE_TO_CONTENT
Indica que el ancho del cuadro de diálogo de tarea viene determinado por el ancho de su área de contenido. Esta marca se omite si cxWidth no está establecida en 0.

dwCommonButtons

Tipo: TASKDIALOG_COMMON_BUTTON_FLAGS

Especifica los botones de inserción que se muestran en el cuadro de diálogo de tarea. Si no se especifican botones comunes y no se especifica ningún botón personalizado mediante los miembros cButtons y pButtons , el cuadro de diálogo de tarea contendrá el botón Aceptar de forma predeterminada. Este parámetro puede ser una combinación de marcas del siguiente grupo:

Valor Significado
TDCBF_OK_BUTTON
El cuadro de diálogo de tarea contiene el botón de inserción: Aceptar.
TDCBF_YES_BUTTON
El cuadro de diálogo de tarea contiene el botón de inserción: .
TDCBF_NO_BUTTON
El cuadro de diálogo de tarea contiene el botón de inserción: No.
TDCBF_CANCEL_BUTTON
El cuadro de diálogo de tarea contiene el botón de inserción: Cancelar. Si se especifica este botón, el cuadro de diálogo de tarea responderá a las acciones de cancelación típicas (Alt-F4 y Escape).
TDCBF_RETRY_BUTTON
El cuadro de diálogo de tarea contiene el botón de inserción: Reintentar.
TDCBF_CLOSE_BUTTON
El cuadro de diálogo de tarea contiene el botón de inserción: Cerrar.

pszWindowTitle

Tipo: PCWSTR

Puntero que hace referencia a la cadena que se va a usar para el título del cuadro de diálogo de tarea. Este parámetro puede ser una cadena terminada en null o un identificador de recurso entero pasado a la macro MAKEINTRESOURCE . Si este parámetro es NULL, se usa el nombre de archivo del programa ejecutable.

DUMMYUNIONNAME

DUMMYUNIONNAME.hMainIcon

Tipo: HICON

Identificador de un icono que se va a mostrar en el cuadro de diálogo de tareas. Este miembro se omite a menos que se especifique la marca TDF_USE_HICON_MAIN. Si este miembro es NULL y se especifica el TDF_USE_HICON_MAIN, no se mostrará ningún icono.

DUMMYUNIONNAME.pszMainIcon

Tipo: PCWSTR

Puntero que hace referencia al icono que se va a mostrar en el cuadro de diálogo de tareas. Este parámetro se omite si se especifica la marca USE_HICON_MAIN. De lo contrario, si este parámetro es NULL o el parámetro hInstance es NULL, no se mostrará ningún icono. Este parámetro debe ser un identificador de recurso entero pasado a la macro MAKEINTRESOURCE o uno de los siguientes valores predefinidos:

Valor Significado
TD_ERROR_ICON
Aparece un icono de inicio de sesión de detención en el cuadro de diálogo de tareas.
TD_WARNING_ICON
Aparece un icono de signo de signo de exclamación en el cuadro de diálogo de tarea.
TD_INFORMATION_ICON
Un icono que consta de una letra minúscula i en un círculo aparece en el cuadro de diálogo de tarea.
TD_SHIELD_ICON
Aparece un icono de escudo en el cuadro de diálogo de tareas.

pszMainInstruction

Tipo: PCWSTR

Puntero que hace referencia a la cadena que se va a usar para la instrucción principal. Este parámetro puede ser una cadena terminada en null o un identificador de recurso entero pasado a la macro MAKEINTRESOURCE .

pszContent

Tipo: PCWSTR

Puntero que hace referencia a la cadena que se va a usar para el contenido principal del cuadro de diálogo. Este parámetro puede ser una cadena terminada en null o un identificador de recurso entero pasado a la macro MAKEINTRESOURCE . Si se especifica la marca ENABLE_HYPERLINKS para el miembro dwFlags , esta cadena puede contener hipervínculos con el formato: <A HREF="executablestring">Hyperlink Text</A>. ADVERTENCIA: Habilitar hipervínculos al usar contenido de un origen no seguro puede provocar vulnerabilidades de seguridad.

cButtons

Tipo: UINT

Número de entradas de la matriz pButtons que se usa para crear botones o vínculos de comandos en el cuadro de diálogo de tareas. Si este miembro es cero y no se han especificado botones comunes mediante el miembro dwCommonButtons , el cuadro de diálogo de tarea tendrá un solo botón Aceptar mostrado.

pButtons

Tipo: const TASKDIALOG_BUTTON*

Puntero a una matriz de estructuras de TASKDIALOG_BUTTON que contienen la definición de los botones personalizados que se van a mostrar en el cuadro de diálogo de tarea. Esta matriz debe contener al menos el número de entradas especificadas por el miembro cButtons .

nDefaultButton

Tipo: int

Botón predeterminado para el cuadro de diálogo de tarea. Puede ser cualquiera de los valores especificados en los miembros nButtonID de una de las estructuras de TASKDIALOG_BUTTON de la matriz pButtons o uno de los identificadores correspondientes a los botones especificados en el miembro dwCommonButtons :

IDCANCEL Haga que el botón Cancelar sea el valor predeterminado.
IDNO Haga que el botón No sea el valor predeterminado.
IDOK Haga que el botón Aceptar sea el valor predeterminado.
IDRETRY Haga que el botón Reintentar sea el valor predeterminado.
IDYES Haga que el botón sea el valor predeterminado.
IDCLOSE Haga que el botón Cerrar sea el valor predeterminado.
 

Si este miembro es cero o su valor no corresponde a ningún identificador de botón en el cuadro de diálogo, el primer botón del cuadro de diálogo será el valor predeterminado.

cRadioButtons

Tipo: UINT

Número de entradas de la matriz pRadioButtons que se usa para crear botones de radio en el cuadro de diálogo de tareas.

pRadioButtons

Tipo: const TASKDIALOG_BUTTON*

Puntero a una matriz de estructuras de TASKDIALOG_BUTTON que contienen la definición de los botones de radio que se van a mostrar en el cuadro de diálogo de tarea. Esta matriz debe contener al menos el número de entradas especificadas por el miembro cRadioButtons . Este parámetro puede ser NULL.

nDefaultRadioButton

Tipo: int

El identificador de botón del botón de radio seleccionado de forma predeterminada. Si este valor no corresponde a un identificador de botón, el primer botón de la matriz se selecciona de forma predeterminada.

pszVerificationText

Tipo: PCWSTR

Puntero que hace referencia a la cadena que se va a usar para etiquetar la casilla de verificación. Este parámetro puede ser una cadena terminada en null o un identificador de recurso entero pasado a la macro MAKEINTRESOURCE . Si este parámetro es NULL, la casilla de verificación no se muestra en el cuadro de diálogo de tarea. Si el parámetro pfVerificationFlagChecked de TaskDialogIndirect es NULL, la casilla no está habilitada.

pszExpandedInformation

Tipo: PCWSTR

Puntero que hace referencia a la cadena que se va a usar para mostrar información adicional. Este parámetro puede ser una cadena terminada en null o un identificador de recurso entero pasado a la macro MAKEINTRESOURCE . La información adicional se muestra inmediatamente debajo del contenido o debajo del texto del pie de página en función de si se especifica la marca TDF_EXPAND_FOOTER_AREA. Si se especifica la marca TDF_ENABLE_HYPERLINKS para el miembro dwFlags , esta cadena puede contener hipervínculos con el formato: <A HREF="executablestring">Hyperlink Text</A>. ADVERTENCIA: Habilitar hipervínculos al usar contenido de un origen no seguro puede provocar vulnerabilidades de seguridad.

pszExpandedControlText

Tipo: PCWSTR

Puntero que hace referencia a la cadena que se va a usar para etiquetar el botón para contraer la información expandible. Este parámetro puede ser una cadena terminada en null o un identificador de recurso entero pasado a la macro MAKEINTRESOURCE . Este miembro se omite cuando el miembro pszExpandedInformation es NULL. Si este miembro es NULL y se especifica pszCollapsedControlText , también se usará el valor pszCollapsedControlText para este miembro.

pszCollapsedControlText

Tipo: PCWSTR

Puntero que hace referencia a la cadena que se va a usar para etiquetar el botón para expandir la información expandible. Este parámetro puede ser una cadena terminada en null o un identificador de recurso entero pasado a la macro MAKEINTRESOURCE . Este miembro se omite cuando el miembro pszExpandedInformation es NULL. Si este miembro es NULL y se especifica pszCollapsedControlText , también se usará el valor pszCollapsedControlText para este miembro.

DUMMYUNIONNAME2

DUMMYUNIONNAME2.hFooterIcon

Tipo: HICON

Identificador de un icono que se va a mostrar en el pie de página del cuadro de diálogo de tarea. Este miembro se omite a menos que se especifique la marca de TDF_USE_HICON_FOOTER y pszFooterIcon no lo sea. Si este miembro es NULL y se especifica el TDF_USE_HICON_FOOTER, no se muestra ningún icono.

DUMMYUNIONNAME2.pszFooterIcon

Tipo: PCWSTR

Puntero que hace referencia al icono que se va a mostrar en el área de pie de página del cuadro de diálogo de tarea. Este parámetro se omite si se especifica la marca TDF_USE_HICON_FOOTER o si pszFooter es NULL. De lo contrario, si este parámetro es NULL o el parámetro hInstance es NULL, no se muestra ningún icono. Este parámetro debe ser un identificador de recurso entero pasado a la macro MAKEINTRESOURCE o uno de los valores predefinidos enumerados para pszMainIcon.

pszFooter

Tipo: PCWSTR

Puntero a la cadena que se va a usar en el área de pie de página del cuadro de diálogo de tarea. Este parámetro puede ser una cadena terminada en null o un identificador de recurso entero pasado a la macro MAKEINTRESOURCE . Si se especifica la marca TDF_ENABLE_HYPERLINKS para el miembro dwFlags , esta cadena puede contener hipervínculos en este formato.

<A HREF="executablestring">Hyperlink Text</A>
Advertencia La habilitación de hipervínculos cuando se usa contenido de un origen no seguro puede provocar vulnerabilidades de seguridad.
 

pfCallback

Tipo: PFTASKDIALOGCALLBACK

Puntero a una función de devolución de llamada definida por la aplicación. Para obtener más información, vea TaskDialogCallbackProc.

lpCallbackData

Tipo: LONG_PTR

Puntero a los datos de referencia definidos por la aplicación. El autor de la llamada define este valor.

cxWidth

Tipo: UINT

Ancho del área cliente del cuadro de diálogo de tareas, en unidades de diálogo. Si es 0, el administrador de diálogos de tareas calculará el ancho ideal.

Requisitos

   
Cliente mínimo compatible Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible Windows Server 2008 [solo aplicaciones de escritorio]
Encabezado commctrl.h