DisplayRequest Classe

Definição

Namespace:

Windows.System.Display

Representa uma solicitação de exibição.

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

Herança

Object Platform::Object IInspectable DisplayRequest

Atributos

ActivatableAttribute ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Requisitos do Windows

Família de dispositivos	Windows 10 (introduzida na 10.0.10240.0)
API contract	Windows.Foundation.UniversalApiContract (introduzida na v1.0)

Exemplos

O código a seguir (obtido do exemplo de estado de energia de exibição) mostra como ativar, acompanhar e liberar solicitações de exibição.

/// <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 

Comentários

Para conservar a energia e estender a duração da bateria, o sistema reduzirá a energia do computador se ele não detectar nenhuma atividade do usuário por um determinado período de tempo. Dependendo das configurações de energia do sistema, a tela pode primeiro ser esmaecida, uma proteção de tela pode ser exibida e, eventualmente, a exibição pode ser desativada à medida que o sistema entra em um estado de suspensão de baixa potência.

Aplicativos que mostram vídeo ou são executados por longos períodos sem entrada do usuário podem solicitar que a exibição permaneça ativada chamando DisplayRequest.RequestActive. Quando uma solicitação de exibição é ativada, a exibição do dispositivo permanece ativada enquanto o aplicativo está visível. Quando o usuário move o aplicativo para fora do primeiro plano, o sistema desativa as solicitações de exibição do aplicativo e as reativa quando o aplicativo retorna para o primeiro plano.

As solicitações de exibição são cumulativas – cada solicitação de exibição deve ser liberada com uma chamada separada para DisplayRequest.RequestRelease. Um aplicativo deve acompanhar o número de solicitações de exibição ativas e verificar se todas foram liberadas (cada uma com uma chamada correspondente para DisplayRequest.RequestRelease) quando o aplicativo não exigir mais que a exibição permaneça ativada. Para obter mais informações, consulte:

• Como manter a exibição ativada durante a reprodução de áudio/vídeo
• MediaElement
• Exibir exemplo de estado de energia

O uso de solicitações de exibição para manter a exibição ativada consome muita energia. Use essas diretrizes para obter o melhor comportamento do aplicativo ao usar solicitações de exibição.

• Use solicitações de exibição somente quando necessário, ou seja, horas em que nenhuma entrada do usuário é esperada, mas a exibição deve permanecer ativada. Por exemplo, durante apresentações em tela inteira ou quando o usuário está lendo um livro eletrônico.
• Libere cada solicitação de exibição assim que ela não for mais necessária.

Observação

Essa classe não é ágil, o que significa que você precisa considerar seu modelo de threading e o comportamento de marshaling. Para obter mais informações, consulte Threading and Marshaling (C++/CX) e Using Windows Runtime objects in a multithreaded environment (.NET).

Windows Phone 8

Essa API tem suporte apenas em aplicativos nativos.

Construtores

DisplayRequest()

Cria uma instância da classe DisplayRequest .

Métodos

RequestActive()	Ativa uma solicitação de exibição.
RequestRelease()	Desativa uma solicitação de exibição.