Class Display

    Definition

    Namespace:
    Tizen.System
    Assembly:
    Tizen.System.dll

    The Display class provides the properties and events to control the display status and brightness.

    public class Display
    Inheritance
    object
    Display
    Remarks

    The Display API provides the way to get the current display brightness value, the display state, and the total number of available displays. It also provides the events for an application to receive the display state change events from the device. To receive the display event, the application should register with an associated EventHandler.

    Examples
        Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State);
        Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays);

    Properties

    View Source

    Brightness

    The brightness value of the display.

    Declaration
    public int Brightness { get; set; }
    Property Value
    Type Description
    int
    Remarks

    The brightness value should be less than or equal to the MaxBrightness value.

    Examples
        Display display = Display.Displays[0];
        Console.WriteLine("Display current Brightness is: {0}", display.Brightness);
    Exceptions
    Type Condition
    System.ArgumentException

    When an invalid parameter value is set.

    System.UnauthorizedAccessException

    If the privilege is not set.

    View Source

    Displays

    Gets all the available displays. The display at the index zero is always assigned to the main display.

    Declaration
    public static IReadOnlyList<Display> Displays { get; }
    Property Value
    Type Description
    System.Collections.Generic.IReadOnlyList<T><Display>
    Remarks

    The Display API provides the way to get the current display brightness value, the display state, and the total number of available displays. It also provides the events for an application to receive the display state change events from the device. To receive the display event, the application should register with an associated EventHandler.

    View Source

    MaxBrightness

    The maximum brightness value that can be set for the specific display.

    Declaration
    public int MaxBrightness { get; }
    Property Value
    Type Description
    int
    Remarks

    The Display API provides the way to get the current display brightness value, the display state, and the total number of available displays. It also provides the events for an application to receive the display state change events from the device. To receive the display event, the application should register with an associated EventHandler.

    Examples
        Display display = Display.Displays[0];
        Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness);
    View Source

    NumberOfDisplays

    The number of available display devices.

    Declaration
    public static int NumberOfDisplays { get; }
    Property Value
    Type Description
    int
    Remarks

    The Display API provides the way to get the current display brightness value, the display state, and the total number of available displays. It also provides the events for an application to receive the display state change events from the device. To receive the display event, the application should register with an associated EventHandler.

    View Source

    State

    The current device display state.

    Declaration
    public static DisplayState State { get; set; }
    Property Value
    Type Description
    DisplayState
    Remarks

    The Display API provides the way to get the current display brightness value, the display state, and the total number of available displays. It also provides the events for an application to receive the display state change events from the device. To receive the display event, the application should register with an associated EventHandler.

    Events

    View Source

    StateChanged

    StateChanged is raised when the state of the display is changed.

    Declaration
    public static event EventHandler<DisplayStateChangedEventArgs> StateChanged
    Event Type
    Type Description
    System.EventHandler<TEventArgs><DisplayStateChangedEventArgs>
    Remarks

    The Display API provides the way to get the current display brightness value, the display state, and the total number of available displays. It also provides the events for an application to receive the display state change events from the device. To receive the display event, the application should register with an associated EventHandler.

    Examples
    public static async Task DisplayEventHandler()
    {
        EventHandler<DisplayStateChangedEventArgs> handler = null;
        handler = (object sender, DisplayStateChangedEventArgs args) =>
        {
             Console.WriteLine("Display State is: {0}", args.State);
        }
        Battery.StateChanged += handler;
        await Task.Delay(20000);
    }
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX