DisplayRequest Clase

Definición

Espacio de nombres:

Windows.System.Display

Representa una solicitud de presentación.

public ref class DisplayRequest sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.STA)]
/// [Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
class DisplayRequest final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.None)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.STA)]
[Windows.Foundation.Metadata.Activatable(65536, "Windows.Foundation.UniversalApiContract")]
public sealed class DisplayRequest

function DisplayRequest()

Public NotInheritable Class DisplayRequest

Herencia

Object Platform::Object IInspectable DisplayRequest

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos de Windows

Familia de dispositivos	Windows 10 (se introdujo en la versión 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (se introdujo en la versión v1.0)

Ejemplos

El código siguiente (tomado del ejemplo de estado de energía de visualización) muestra cómo activar, realizar un seguimiento y liberar solicitudes de visualización.

/// <param name="sender"></param> 
/// <param name="e"></param> 
private void Activate_Click(object sender, RoutedEventArgs e)
{
    Error.Text = string.Empty;
    Button b = sender as Button;
    if (b != null)
    {
        try
        {
            if (g_DisplayRequest == null)
            {
                // This call creates an instance of the displayRequest object 
                g_DisplayRequest = new DisplayRequest();
            }
        }
        catch (Exception ex)
        {
            rootPage.NotifyUser("Error Creating Display Request: " + ex.Message, NotifyType.ErrorMessage);
        }

        if (g_DisplayRequest != null)
        {
            try
            {
                // This call activates a display-required request. If successful,  
                // the screen is guaranteed not to turn off automatically due to user inactivity. 
                g_DisplayRequest.RequestActive();
                drCount += 1;
                rootPage.NotifyUser("Display request activated (" + drCount + ")", NotifyType.StatusMessage);
            }
            catch (Exception ex)
            {
                rootPage.NotifyUser("Error: " + ex.Message, NotifyType.ErrorMessage);
            }
        }
    }
}

/// <param name="sender"></param> 
/// <param name="e"></param> 
private void Release_Click(object sender, RoutedEventArgs e)
{
    Error.Text = string.Empty;
    Button b = sender as Button;
    if (b != null)
    {
        if (g_DisplayRequest != null)
        {
            try
            {
                // This call de-activates the display-required request. If successful, the screen 
                // might be turned off automatically due to a user inactivity, depending on the 
                // power policy settings of the system. The requestRelease method throws an exception  
                // if it is called before a successful requestActive call on this object. 
                g_DisplayRequest.RequestRelease();
                drCount -= 1;
                rootPage.NotifyUser("Display request released (" + drCount + ")", NotifyType.StatusMessage);
            }
            catch (Exception ex)
            {
                rootPage.NotifyUser("Error: " + ex.Message, NotifyType.ErrorMessage);
            }
        }
    }
}

''' <param name="sender"></param> 
''' <param name="e"></param> 
Private Sub Activate_Click(sender As Object, e As RoutedEventArgs) 
    ErrorTestBlock.Text = String.Empty 
    Dim b As Button = TryCast(sender, Button) 
    If b IsNot Nothing Then 
        Try 
            If g_DisplayRequest Is Nothing Then 
                ' This call creates an instance of the displayRequest object 
                g_DisplayRequest = New DisplayRequest() 
            End If 
        Catch ex As Exception 
            rootPage.NotifyUser("Error Creating Display Request: " & ex.Message, NotifyType.ErrorMessage) 
        End Try 

        If g_DisplayRequest IsNot Nothing Then 
            Try 
                ' This call activates a display-required request. If successful,  
                ' the screen is guaranteed not to turn off automatically due to user inactivity. 
                g_DisplayRequest.RequestActive() 
                drCount += 1 
                rootPage.NotifyUser("Display request activated (" & drCount & ")", NotifyType.StatusMessage) 
            Catch ex As Exception 
                rootPage.NotifyUser("Error:" & ex.Message, NotifyType.ErrorMessage) 
            End Try 
        End If 
    End If 
End Sub

''' <param name="sender"></param> 
''' <param name="e"></param> 
Private Sub Release_Click(sender As Object, e As RoutedEventArgs) 
    ErrorTestBlock.Text = String.Empty 
    Dim b As Button = TryCast(sender, Button) 
    If b IsNot Nothing Then 
        If g_DisplayRequest IsNot Nothing Then 
            Try 
                ' This call de-activates the display-required request. If successful, the screen 
                ' might be turned off automatically due to a user inactivity, depending on the 
                ' power policy settings of the system. The requestRelease method throws an exception  
                ' if it is called before a successful requestActive call on this object. 
                g_DisplayRequest.RequestRelease() 
                drCount -= 1 
                rootPage.NotifyUser("Display request released (" & drCount & ")", NotifyType.StatusMessage) 
            Catch ex As Exception 
                rootPage.NotifyUser("Error: " & ex.Message, NotifyType.ErrorMessage) 
            End Try 
        End If 
    End If 
End Sub 

Comentarios

Para ahorrar energía y ampliar la duración de la batería, el sistema reduce la energía al equipo si no detecta ninguna actividad del usuario durante un determinado período de tiempo. Según la configuración de alimentación del sistema, la pantalla puede atenuarse primero, se puede mostrar un protector de pantalla y, finalmente, la pantalla puede desactivarse a medida que el sistema entra en un estado de suspensión de bajo consumo.

Las aplicaciones que muestran vídeo o se ejecutan durante períodos prolongados sin entrada del usuario pueden solicitar que la pantalla permanezca activa llamando a DisplayRequest.RequestActive. Cuando se activa una solicitud de visualización, la pantalla del dispositivo permanece activada mientras la aplicación está visible. Cuando el usuario mueve la aplicación fuera del primer plano, el sistema desactiva las solicitudes de visualización de la aplicación y las reactiva cuando la aplicación vuelve al primer plano.

Las solicitudes de visualización son acumulativas: cada solicitud de visualización debe publicarse con una llamada independiente a DisplayRequest.RequestRelease. Una aplicación debe realizar un seguimiento del número de solicitudes de visualización activas y asegurarse de que se liberan todos (cada uno con una llamada correspondiente a DisplayRequest.RequestRelease) cuando la aplicación ya no requiere que la pantalla permanezca activa. Para obtener más información, consulte:

• Cómo mantener la pantalla activada durante la reproducción de audio/vídeo
• MediaElement
• Muestra de estado de energía

El uso de solicitudes de visualización para mantener la pantalla en consume mucha energía. Use estas directrices para mejorar el comportamiento de la aplicación al usar solicitudes de visualización.

• Use las solicitudes de visualización solo cuando sea necesario, es decir, las veces en las que no se espera ninguna entrada del usuario, pero la pantalla debe permanecer activada. Por ejemplo, durante presentaciones en pantalla completa o cuando el usuario está leyendo un libro electrónico.
• Libere cada solicitud de presentación en cuanto ya no sea necesaria.

Nota:

Esta clase no es ágil, lo que significa que debe tener en cuenta su modelo de subprocesos y el comportamiento de serialización. Para obtener más información, consulte Subprocesos y serialización (C++/CX) y Uso de objetos Windows Runtime en un entorno multiproceso (.NET).

Windows Phone 8

Esta API solo se admite en aplicaciones nativas.

Constructores

DisplayRequest()

Crea una instancia de la clase DisplayRequest .

Métodos

RequestActive()	Activa una solicitud de visualización.
RequestRelease()	Desactiva una solicitud de visualización.