Difference between revisions of "SANB C-sharp Code References"

From Manual
Jump to navigation Jump to search
Line 6: Line 6:
 
== Component ==
 
== Component ==
 
<code>MobileStatusNavigationBar statusNavigation;</code>
 
<code>MobileStatusNavigationBar statusNavigation;</code>
 +
 +
== Enum ==
 +
<code>BackgroundMode</code> have <code>Auto</code>, <code>Light</code> and <code>Dark</code>
  
 
== C# public functions ==
 
== C# public functions ==
To hide status and navigation bar
+
To hide status and navigation bar:
  
 
<code>statusNavigation.Hide();</code>
 
<code>statusNavigation.Hide();</code>
  
To show status and navigation bar
+
To show status and navigation bar:
  
 
<code>statusNavigation.Show();</code>
 
<code>statusNavigation.Show();</code>
  
<code>statusNavigation.SetLightMode(BackgroundMode); // Set background color of bars to light</code>
 
  
<code>statusNavigation.SetDarkMode(BackgroundMode); // Set background color of bars to dark</code>
+
'''Status & Navigation'''
 +
 
 +
To set background color of bars to light:
 +
 
 +
<code>statusNavigation.SetLightMode(BackgroundMode);</code>
 +
 
 +
To set background color of bars to dark:
 +
 
 +
<code>statusNavigation.SetDarkMode(BackgroundMode);</code>
 +
 
 +
To set bars background color:
 +
 
 +
<code>statusNavigation.SetColor(Color color);</code>
 +
 
 +
To set background color of bars to light with light content:
 +
 
 +
<code>statusNavigation.SetLightModeWithLightContent();</code>
 +
 
 +
To set background color of bars to dark with light content:
 +
 
 +
<code>statusNavigation.SetDarkModeWithLightContent();</code>
 +
 
 +
To set background color of bars to light with dark content:
 +
 
 +
<code>statusNavigation.SetLightModeWithDarkContent();</code>
 +
 
 +
To set background color of bars to dark with dark content:
 +
 
 +
<code>statusNavigation.SetDarkModeWithDarkContent();</code>
  
<code>statusNavigation.SetColor(Color color); // Set bars background color</code>
 
  
<code>statusNavigation.SetStatusLightMode(BackgroundMode); // Set background color of status bar to light</code>
+
'''Status'''
  
<code>statusNavigation.SetStatusDarkMode(); // Set background color of status bar to dark</code>
+
To set background color of status bar to light:
  
<code>statusNavigation.SetStatusColor(Color color); // Set status bar background color</code>
+
<code>statusNavigation.SetStatusLightMode(BackgroundMode);</code>
  
<code>statusNavigation.SetStatusLightModeWithLightContent(); // Set background color of status bar to light</code>
+
To set background color of status bar to dark:
  
<code>statusNavigation.SetStatusDarkModeWithLightContent(); // Set background color of status bar to dark</code>
+
<code>statusNavigation.SetStatusDarkMode();</code>
  
<code>statusNavigation.SetStatusLightModeWithDarkContent(); // Set background color of status bar to light</code>
+
To set status bar background color:
  
<code>statusNavigation.SetStatusDarkModeWithDarkContent(); // Set background color of status bar to dark</code>
+
<code>statusNavigation.SetStatusColor(Color color);</code>
  
<code>statusNavigation.SetNavigationLightMode(BackgroundMode); // Set background color of navigation bar to light</code>
+
To set background color of status bar to light with light content:
  
<code>statusNavigation.SetNavigationDarkMode(BackgroundMode); // Set background color of navigation bar to dark</code>
+
<code>statusNavigation.SetStatusLightModeWithLightContent();</code>
  
<code>statusNavigation.SetNavigationColor(Color color); // Set navigation bar background color</code>
+
To set background color of status bar to dark with light content:
  
<code>statusNavigation.SetNavigationLightModeWithLightContent(); // Set background color of navigation bar to light</code>
+
<code>statusNavigation.SetStatusDarkModeWithLightContent();</code>
  
<code>statusNavigation.SetNavigationDarkModeWithLightContent(); // Set background color of navigation bar to dark</code>
+
To set background color of status bar to light with dark content:
  
<code>statusNavigation.SetNavigationLightModeWithDarkContent(); // Set background color of navigation bar to light</code>
+
<code>statusNavigation.SetStatusLightModeWithDarkContent();</code>
  
<code>statusNavigation.SetNavigationDarkModeWithDarkContent(); // Set background color of navigation bar to dark</code>
+
To set background color of status bar to dark with dark content:
 +
 
 +
<code>statusNavigation.SetStatusDarkModeWithDarkContent();</code>
 +
 
 +
 
 +
'''Navigation'''
 +
 
 +
To set background color of navigation bar to light:
 +
 
 +
<code>statusNavigation.SetNavigationLightMode(BackgroundMode);</code>
 +
 
 +
To set background color of navigation bar to dark:
 +
 
 +
<code>statusNavigation.SetNavigationDarkMode(BackgroundMode);</code>
 +
 
 +
To set navigation bar background color:
 +
 
 +
<code>statusNavigation.SetNavigationColor(Color color);</code>
 +
 
 +
To set background color of navigation bar to light with light content:
 +
 
 +
<code>statusNavigation.SetNavigationLightModeWithLightContent();</code>
 +
 
 +
To set background color of navigation bar to dark with light content:
 +
 
 +
<code>statusNavigation.SetNavigationDarkModeWithLightContent();</code>
 +
 
 +
To set background color of navigation bar to light with dark content:
 +
 
 +
<code>statusNavigation.SetNavigationLightModeWithDarkContent();</code>
 +
 
 +
To set background color of navigation bar to dark with dark content:
 +
 
 +
<code>statusNavigation.SetNavigationDarkModeWithDarkContent();</code>
  
 
== C# public variables ==
 
== C# public variables ==
<code>Color statusNavigation.statusLightModeBackgroundColor; // Status light mode color</code>
+
Status light mode color:
  
<code>Color statusNavigation.statusDarkModeBackgroundColor; // Status dark mode color</code>
+
<code>Color statusNavigation.statusLightModeBackgroundColor;</code>
  
<code>Color statusNavigation.navigationLightModeBackgroundColor; // Navigation light mode color</code>
+
Status dark mode color:
  
<code>Color statusNavigation.navigationDarkModeBackgroundColor; // Navigation dark mode color</code>
+
<code>Color statusNavigation.statusDarkModeBackgroundColor;</code>
  
<code>UnityEvent statusNavigation.backButtonOnClick; // Back button event</code>
+
Navigation light mode color:
  
<code>bool statusNavigation.startFullScreen; // Sets to fullscreen at Start</code>
+
<code>Color statusNavigation.navigationLightModeBackgroundColor;</code>
  
<code>bool statusNavigation.startLightMode; // Sets to light mode at Start</code>
+
Navigation dark mode color:
 +
 
 +
<code>Color statusNavigation.navigationDarkModeBackgroundColor;</code>
 +
 
 +
Back button event:
 +
 
 +
<code>UnityEvent statusNavigation.backButtonOnClick;</code>
 +
 
 +
Sets to fullscreen at Start
 +
 
 +
<code>bool statusNavigation.startFullScreen;</code>
 +
 
 +
Sets to light mode at Start
 +
 
 +
<code>bool statusNavigation.startLightMode;</code>
  
 
== C# internal static variables generated by the component Mobile Status Navigation Bar ==
 
== C# internal static variables generated by the component Mobile Status Navigation Bar ==
<code>float MobileStatusNavigationBar.StatusBarHeight; // Get Realtime Height of Status Bar</code>
+
Get realtime height of status bar:
 +
 
 +
<code>float MobileStatusNavigationBar.StatusBarHeight;</code>
 +
 
 +
Get realtime height of navigation bar:
 +
 
 +
<code>float MobileStatusNavigationBar.NavigationBarHeight;</code>
 +
 
 +
Get height of status bar:
  
<code>float MobileStatusNavigationBar.NavigationBarHeight; // Get Realtime Height of Navigation Bar</code>
+
<code>float MobileStatusNavigationBar.StatusBarHeight_STATIC;</code>
  
<code>float MobileStatusNavigationBar.StatusBarHeight_STATIC; // Get Height of Status Bar</code>
+
Get height of navigation bar:
  
<code>float MobileStatusNavigationBar.NavigationBarHeight_STATIC; // Get Height of Navigation Bar</code>
+
<code>float MobileStatusNavigationBar.NavigationBarHeight_STATIC;</code>

Revision as of 00:52, 4 February 2021

Quick C# Code References

Using

using SaariTech.UI;

Component

MobileStatusNavigationBar statusNavigation;

Enum

BackgroundMode have Auto, Light and Dark

C# public functions

To hide status and navigation bar:

statusNavigation.Hide();

To show status and navigation bar:

statusNavigation.Show();


Status & Navigation

To set background color of bars to light:

statusNavigation.SetLightMode(BackgroundMode);

To set background color of bars to dark:

statusNavigation.SetDarkMode(BackgroundMode);

To set bars background color:

statusNavigation.SetColor(Color color);

To set background color of bars to light with light content:

statusNavigation.SetLightModeWithLightContent();

To set background color of bars to dark with light content:

statusNavigation.SetDarkModeWithLightContent();

To set background color of bars to light with dark content:

statusNavigation.SetLightModeWithDarkContent();

To set background color of bars to dark with dark content:

statusNavigation.SetDarkModeWithDarkContent();


Status

To set background color of status bar to light:

statusNavigation.SetStatusLightMode(BackgroundMode);

To set background color of status bar to dark:

statusNavigation.SetStatusDarkMode();

To set status bar background color:

statusNavigation.SetStatusColor(Color color);

To set background color of status bar to light with light content:

statusNavigation.SetStatusLightModeWithLightContent();

To set background color of status bar to dark with light content:

statusNavigation.SetStatusDarkModeWithLightContent();

To set background color of status bar to light with dark content:

statusNavigation.SetStatusLightModeWithDarkContent();

To set background color of status bar to dark with dark content:

statusNavigation.SetStatusDarkModeWithDarkContent();


Navigation

To set background color of navigation bar to light:

statusNavigation.SetNavigationLightMode(BackgroundMode);

To set background color of navigation bar to dark:

statusNavigation.SetNavigationDarkMode(BackgroundMode);

To set navigation bar background color:

statusNavigation.SetNavigationColor(Color color);

To set background color of navigation bar to light with light content:

statusNavigation.SetNavigationLightModeWithLightContent();

To set background color of navigation bar to dark with light content:

statusNavigation.SetNavigationDarkModeWithLightContent();

To set background color of navigation bar to light with dark content:

statusNavigation.SetNavigationLightModeWithDarkContent();

To set background color of navigation bar to dark with dark content:

statusNavigation.SetNavigationDarkModeWithDarkContent();

C# public variables

Status light mode color:

Color statusNavigation.statusLightModeBackgroundColor;

Status dark mode color:

Color statusNavigation.statusDarkModeBackgroundColor;

Navigation light mode color:

Color statusNavigation.navigationLightModeBackgroundColor;

Navigation dark mode color:

Color statusNavigation.navigationDarkModeBackgroundColor;

Back button event:

UnityEvent statusNavigation.backButtonOnClick;

Sets to fullscreen at Start

bool statusNavigation.startFullScreen;

Sets to light mode at Start

bool statusNavigation.startLightMode;

C# internal static variables generated by the component Mobile Status Navigation Bar

Get realtime height of status bar:

float MobileStatusNavigationBar.StatusBarHeight;

Get realtime height of navigation bar:

float MobileStatusNavigationBar.NavigationBarHeight;

Get height of status bar:

float MobileStatusNavigationBar.StatusBarHeight_STATIC;

Get height of navigation bar:

float MobileStatusNavigationBar.NavigationBarHeight_STATIC;