Class NUIApplication

View Source

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll
API Level:
3

Represents an application that have a UI screen. The NUIApplication class has a default stage.


                
C#

                

                    
Copy

                    

                

            
public class NUIApplication : CoreApplication
Inheritance
Object
Application
CoreApplication
NUIApplication

Constructors

View Source

NUIApplication()

The default constructor.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication()
API Level: 3
View Source

NUIApplication(String)

The constructor with a stylesheet.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(string styleSheet)
Parameters
Type Name Description
String styleSheet

The styleSheet url.
API Level: 3
View Source

NUIApplication(String, NUIApplication.WindowMode)

The constructor with a stylesheet and window mode.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(string styleSheet, NUIApplication.WindowMode windowMode)
Parameters
Type Name Description
String styleSheet

The styleSheet url.
NUIApplication.WindowMode windowMode

The windowMode.
API Level: 3
View Source

NUIApplication(String, NUIApplication.WindowMode, CoreTask)

The constructor with a stylesheet, window mode, coretask

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(string styleSheet, NUIApplication.WindowMode windowMode, CoreTask task)
Parameters
Type Name Description
String styleSheet

The styleSheet URL.
NUIApplication.WindowMode windowMode

The windowMode.
CoreTask task

True If app creates a UI Thread
View Source

NUIApplication(String, NUIApplication.WindowMode, Size2D, Position2D)

The constructor with a stylesheet, window mode, window size, and position.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(string styleSheet, NUIApplication.WindowMode windowMode, Size2D windowSize, Position2D windowPosition)
Parameters
Type Name Description
String styleSheet

The styleSheet URL.
NUIApplication.WindowMode windowMode

The windowMode.
Size2D windowSize

The window size.
Position2D windowPosition

The window position.
API Level: 5
View Source

NUIApplication(String, NUIApplication.WindowMode, Size2D, Position2D, CoreTask)

The constructor with a stylesheet, window mode, window size, position, coretask

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(string styleSheet, NUIApplication.WindowMode windowMode, Size2D windowSize, Position2D windowPosition, CoreTask task)
Parameters
Type Name Description
String styleSheet

The styleSheet URL.
NUIApplication.WindowMode windowMode

The windowMode.
Size2D windowSize

The window size.
Position2D windowPosition

The window position.
CoreTask task

True If app creates a UI Thread
View Source

NUIApplication(String, NUIApplication.WindowMode, WindowType)

The constructor with a stylesheet, window mode and default window type. It is the only way to create an IME window.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(string styleSheet, NUIApplication.WindowMode windowMode, WindowType type)
Parameters
Type Name Description
String styleSheet

The styleSheet URL.
NUIApplication.WindowMode windowMode

The windowMode.
WindowType type

The default window type.
API Level: 9
View Source

NUIApplication(String, Size2D, Position2D)

The constructor with a stylesheet, window size, and position.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(string styleSheet, Size2D windowSize, Position2D windowPosition)
Parameters
Type Name Description
String styleSheet

The styleSheet URL.
Size2D windowSize

The window size.
Position2D windowPosition

The window position.
API Level: 5
View Source

NUIApplication(String, Size2D, Position2D, IBorderInterface, NUIApplication.WindowMode)

The constructor with a stylesheet, size, position, boderInterface and window mode

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(string styleSheet, Size2D windowSize, Position2D windowPosition, IBorderInterface borderInterface, NUIApplication.WindowMode windowMode = default(NUIApplication.WindowMode))
Parameters
Type Name Description
String styleSheet

The styleSheet URL.
Size2D windowSize

The window size.
Position2D windowPosition

The window position.
IBorderInterface borderInterface

IBorderInterfaceIf borderInterface is null, defaultBorder is enabled.
NUIApplication.WindowMode windowMode

The windowMode.
View Source

NUIApplication(Graphics.BackendType, NUIApplication.WindowMode, Size2D, Position2D, String)

Internal inhouse constructor with Graphics Backend Type

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(Graphics.BackendType backend, NUIApplication.WindowMode windowMode = default(NUIApplication.WindowMode), Size2D windowSize = null, Position2D windowPosition = null, string styleSheet = "")
Parameters
Type Name Description
Graphics.BackendType backend
NUIApplication.WindowMode windowMode
Size2D windowSize
Position2D windowPosition
String styleSheet
View Source

NUIApplication(NUIApplication.ThemeOptions)

The constructor with theme option.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(NUIApplication.ThemeOptions option)
Parameters
Type Name Description
NUIApplication.ThemeOptions option

The theme option.
View Source

NUIApplication(NUIApplication.ThemeOptions, IBorderInterface)

The constructor with theme option and borderInterface.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(NUIApplication.ThemeOptions option, IBorderInterface borderInterface)
Parameters
Type Name Description
NUIApplication.ThemeOptions option

The theme option.
IBorderInterface borderInterface

IBorderInterfaceIf borderInterface is null, defaultBorder is enabled.
View Source

NUIApplication(NUIApplication.ThemeOptions, WindowData)

The constructor with a ThemeOptions, WindowData

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(NUIApplication.ThemeOptions option, WindowData windowData)
Parameters
Type Name Description
NUIApplication.ThemeOptions option

The theme option.
WindowData windowData

The default window data
View Source

NUIApplication(Size2D, Position2D)

The constructor with window size and position.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(Size2D windowSize, Position2D windowPosition)
Parameters
Type Name Description
Size2D windowSize

The window size.
Position2D windowPosition

The window position.
API Level: 5
View Source

NUIApplication(Size2D, Position2D, NUIApplication.ThemeOptions)

The constructor with window size and position and theme option.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(Size2D windowSize, Position2D windowPosition, NUIApplication.ThemeOptions option)
Parameters
Type Name Description
Size2D windowSize

The window size.
Position2D windowPosition

The window position.
NUIApplication.ThemeOptions option

The theme option.
View Source

NUIApplication(Size2D, Position2D, NUIApplication.ThemeOptions, IBorderInterface)

The constructor with window size, position, theme option and borderInterface.

Declaration

                
C#

                

                    
Copy

                    

                

            
public NUIApplication(Size2D windowSize, Position2D windowPosition, NUIApplication.ThemeOptions option, IBorderInterface borderInterface)
Parameters
Type Name Description
Size2D windowSize

The window size.
Position2D windowPosition

The window position.
NUIApplication.ThemeOptions option

The theme option.
IBorderInterface borderInterface

IBorderInterfaceIf borderInterface is null, defaultBorder is enabled.

Properties

View Source

AppId

Gets the Application Id.

Declaration

                
C#

                

                    
Copy

                    

                

            
public string AppId { get; }
Property Value
Type Description
String
API Level: 6
View Source

CurrentLoadedXaml

Current loaded xaml's full name.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static string CurrentLoadedXaml { get; set; }
Property Value
Type Description
String
View Source

MultilingualResourceManager

ResourceManager to handle multilingual.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static Resources.ResourceManager MultilingualResourceManager { get; set; }
Property Value
Type Description
Tizen.System.Resources.ResourceManager
API Level: 4
View Source

Window

Gets the window instance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Window Window { get; }
Property Value
Type Description
Window
API Level: 3

Methods

View Source

AddIdle(Delegate)

Ensures that the function passed in is called from the main loop when it is idle.

Declaration

                
C#

                

                    
Copy

                    

                

            
public bool AddIdle(Delegate func)
Parameters
Type Name Description
Tizen.System.Delegate func

The function to call
Returns
Type Description
Boolean

true if added successfully, false otherwise
API Level: 4
View Source

Exit()

Exits the NUIApplication.

Declaration

                
C#

                

                    
Copy

                    

                

            
public override void Exit()
Overrides
API Level: 4
View Source

FlushUpdateMessages()

Flush render/update thread messages synchronously.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void FlushUpdateMessages()
Remarks

This function will relayout forcibily. This function is used for advanced developer. It will make main-thread overhead if you call this function frequencely.

View Source

GetDefaultWindow()

Gets the default window.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static Window GetDefaultWindow()
Returns
Type Description
Window

The default Window.
API Level: 6
View Source

GetScreenSize()

Gets the screen size

Declaration

                
C#

                

                    
Copy

                    

                

            
public static Size GetScreenSize()
Returns
Type Description
Size

Screen size
View Source

OnAppControlReceived(AppControlReceivedEventArgs)

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void OnAppControlReceived(AppControlReceivedEventArgs e)
Parameters
Type Name Description
AppControlReceivedEventArgs e
Overrides
API Level: 3
View Source

OnCreate()

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void OnCreate()
Overrides
API Level: 3
View Source

OnDeviceOrientationChanged(DeviceOrientationEventArgs)

This method is to handle behavior when the device orientation is changed.

When device is rotated to ccw or cw, this event occurs. In addition, this event is different to window orientation changed event. The window orientation event is for per a window and occurs when some flags should be set before.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void OnDeviceOrientationChanged(DeviceOrientationEventArgs e)
Parameters
Type Name Description
DeviceOrientationEventArgs e

The device orientation changed event argument
Overrides
View Source

OnLocaleChanged(LocaleChangedEventArgs)

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void OnLocaleChanged(LocaleChangedEventArgs e)
Parameters
Type Name Description
LocaleChangedEventArgs e
Overrides
API Level: 3
View Source

OnLowBattery(LowBatteryEventArgs)

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void OnLowBattery(LowBatteryEventArgs e)
Parameters
Type Name Description
LowBatteryEventArgs e
Overrides
API Level: 3
View Source

OnLowMemory(LowMemoryEventArgs)

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void OnLowMemory(LowMemoryEventArgs e)
Parameters
Type Name Description
LowMemoryEventArgs e
Overrides
API Level: 3
View Source

OnPause()

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void OnPause()
API Level: 3
View Source

OnPreCreate()

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void OnPreCreate()
API Level: 3
View Source

OnRegionFormatChanged(RegionFormatChangedEventArgs)

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void OnRegionFormatChanged(RegionFormatChangedEventArgs e)
Parameters
Type Name Description
RegionFormatChangedEventArgs e
Overrides
API Level: 3
View Source

OnResume()

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected virtual void OnResume()
API Level: 3
View Source

OnTerminate()

Overrides this method if you want to handle behavior.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void OnTerminate()
Overrides
API Level: 3
View Source

Preload()

This is used to improve application launch performance.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void Preload()
View Source

RegisterAssembly(Assembly)

Register the assembly to XAML.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void RegisterAssembly(Assembly assembly)
Parameters
Type Name Description
Assembly assembly
API Level: 3
View Source

Run(String[])

Runs the NUIApplication.

Declaration

                
C#

                

                    
Copy

                    

                

            
public override void Run(string[] args)
Parameters
Type Name Description
String[] args

Arguments from commandline.
Overrides
API Level: 4
View Source

SetRenderRefreshRate(UInt32)

Sets the number of frames per render.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static void SetRenderRefreshRate(uint numberOfVSyncsPerRender)
Parameters
Type Name Description
UInt32 numberOfVSyncsPerRender

The number of vsyncs between successive renders.
Remarks

Suggest this is a power of two: 1 - render each vsync frame. 2 - render every other vsync frame. 4 - render every fourth vsync frame. 8 - render every eighth vsync frame.
For example, if an application runs on 60 FPS and SetRenderRefreshRate(2) is called, the frames per second will be changed to 30.

Events

View Source

Paused

Occurs whenever the application is paused.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler Paused
Event Type
Type Description
EventHandler
API Level: 4
View Source

Resumed

Occurs whenever the application is resumed.

Declaration

                
C#

                

                    
Copy

                    

                

            
public event EventHandler Resumed
Event Type
Type Description
EventHandler
API Level: 4
View Source

XamlLoaded

Xaml loaded event.

Declaration

                
C#

                

                    
Copy

                    

                

            
public static event NUIApplication.XamlLoadedHandler XamlLoaded
Event Type
Type Description
NUIApplication.XamlLoadedHandler

Extension Methods