ContentDialog.CloseButtonText Propiedad

Definición

Obtiene o establece el texto que se va a mostrar en el botón Cerrar.

public:
 property Platform::String ^ CloseButtonText { Platform::String ^ get(); void set(Platform::String ^ value); };
winrt::hstring CloseButtonText();

void CloseButtonText(winrt::hstring value);
public string CloseButtonText { get; set; }
var string = contentDialog.closeButtonText;
contentDialog.closeButtonText = string;
Public Property CloseButtonText As String
<ContentDialog CloseButtonText="string"/>

Valor de propiedad

String

Platform::String

winrt::hstring

Texto que se va a mostrar en el botón Cerrar.

Requisitos de Windows

Familia de dispositivos
Windows 10 Creators Update (se introdujo en la versión 10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (se introdujo en la versión v4.0)

Comentarios

Cada cuadro de diálogo debe contener un botón de acción segura y no destructiva que permita al usuario salir del cuadro de diálogo con confianza.

Use el botón Cerrar para crear este botón. Esto le permite crear la experiencia de usuario adecuada para todas las entradas como el mouse, el teclado, las funciones táctiles y el controlador para juegos. El cuadro de diálogo se cerrará cuando:

  • El usuario hace clic o pulsa en el botón Cerrar.
  • El usuario presione el botón del sistema Atrás
  • El usuario presiona el botón ESC en el teclado
  • El usuario presione el botón B del controlador para juegos

Al invocar el botón Cerrar, se devuelve ContentDialogResult.None.

Compatibilidad de versiones

La propiedad CloseButtonText no está disponible antes de Windows 10, versión 1703. Si la configuración "versión mínima de la plataforma" de la aplicación en Microsoft Visual Studio es menor que la "versión introducida" que se muestra en el bloque Requisitos más adelante en esta página, debe usar la propiedad SecondaryButtonText en su lugar. Para obtener más información, consulta Código adaptable de versión.

Para evitar excepciones cuando la aplicación se ejecute en versiones anteriores de Windows 10, no establezca esta propiedad en XAML ni úsela sin realizar una comprobación en tiempo de ejecución. En este ejemplo se muestra cómo usar la clase ApiInformation para comprobar la presencia de esta propiedad antes de establecerla.

<ContentDialog x:Name="contentDialog1" Loaded="ContentDialog_Loaded">
    ...
</ContentDialog>
private void ContentDialog_Loaded(object sender, RoutedEventArgs e)
{
    if (ApiInformation.IsPropertyPresent("Windows.UI.Xaml.Controls.ContentDialog", "CloseButtonText"))
    {
        contentDialog1.CloseButtonText = "Cancel";
    }
    else
    {
        contentDialog1.SecondaryButtonText = "Cancel";
    }
}

Se aplica a