DisplayRequest DisplayRequest DisplayRequest DisplayRequest Class

Definition

Represents a display request.

public : sealed class DisplayRequest : IDisplayRequest
public sealed class DisplayRequest : IDisplayRequest
Public NotInheritable Class DisplayRequest Implements IDisplayRequest
var displayRequest = new displayRequest();
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Examples

The following code (taken from the display power state sample) shows how to activate, track, and release display requests.

var g_dispRequest = null;
var drCount = 0;

function activateRequest() {

    if (g_dispRequest === null) {
        try {
            // This call creates an instance of the displayRequest object
            g_dispRequest = new Windows.System.Display.DisplayRequest;
        } catch (e) {
            WinJS.log && WinJS.log("Failed: displayRequest object creation, error: " + e.message, "sample", "error");
        }
    }

    if (g_dispRequest) {
        try {
            // This call activates a display-required request. If successful, 
            // the screen is guaranteed not to turn off automatically due to user inactivity.
            g_dispRequest.requestActive();
            drCount += 1;
            WinJS.log && WinJS.log("Display request activated (" + drCount +")", "sample", "status");
        } catch (e) {
            WinJS.log && WinJS.log("Failed: displayRequest.requestActive, error: " + e.message, "sample", "error");
        }
    }
}

function releaseRequest() {


    if (g_dispRequest) {
        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_dispRequest.requestRelease();
            drCount -= 1;
            WinJS.log && WinJS.log("Display request released (" + drCount +")", "sample", "status");
        }  catch (e) {
            WinJS.log && WinJS.log("Failed: displayRequest.requestRelease, error: " + e.message, "sample", "error");
        }
    }
}

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

Remarks

To conserve power and extend battery life, the system reduces power to the computer if it does not detect any user activity for a certain amount of time. Depending on system power settings, the display may first be dimmed, a screen saver may be displayed, and eventually the display may be turned off as the system enters a low-power sleep state.

Apps that show video or run for extended periods without user input can request that the display remain on by calling DisplayRequest::RequestActive. When a display request is activated, the device's display remains on while the app is visible. When the user moves the app out of the foreground, the system deactivates the app's display requests and reactivates them when the app returns to the foreground.

Display requests are cumulative - each display request must be released with a separate call to DisplayRequest::RequestRelease. An app should keep track of the number of active display requests and make sure all are released (each with a corresponding call to DisplayRequest::RequestRelease ) when the app no longer requires the display to remain on. For more information see:

Using display requests to keep the display on consumes a lot of power. Use these guidelines for best app behavior when using display requests.

  • Use display requests only when required, that is, times when no user input is expected but the display should remain on. For example, during full screen presentations or when the user is reading an e-book.
  • Release each display request as soon as it is no longer required.

Note

This class is not agile, which means that you need to consider its threading model and marshaling behavior. For more info, see Threading and Marshaling (C++/CX) and Using Windows Runtime objects in a multithreaded environment (.NET).

Windows Phone 8

This API is supported in native apps only.

Constructors

DisplayRequest() DisplayRequest() DisplayRequest() DisplayRequest()

Creates an instance of the DisplayRequest class.

public : DisplayRequest()
public DisplayRequest()
Public Sub New()
var displayRequest = new displayRequest();

Methods

RequestActive() RequestActive() RequestActive() RequestActive()

Activates a display request.

public : void RequestActive()
public void RequestActive()
Public Function RequestActive() As void
displayRequest.requestActive();

RequestRelease() RequestRelease() RequestRelease() RequestRelease()

Deactivates a display request.

public : void RequestRelease()
public void RequestRelease()
Public Function RequestRelease() As void
displayRequest.requestRelease();