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

From Manual
Jump to navigation Jump to search
 
(4 intermediate revisions by the same user not shown)
Line 5: Line 5:
  
 
== Component ==
 
== Component ==
MobileStatusNavigationBar statusNavigation;
+
<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 ==
<syntaxhighlight lang="c#">
+
To hide status and navigation bar:
statusNavigation.Hide(); // Hide status and navigation bar
+
 
 +
<code>statusNavigation.'''Hide'''();</code>
 +
 
 +
To show status and navigation bar:
 +
 
 +
<code>statusNavigation.'''Show'''();</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>
  
statusNavigation.Show(); // Show status and navigation bar
+
To set bars background color:
  
statusNavigation.SetLightMode(BackgroundMode); // Set background color of bars to light
+
<code>statusNavigation.'''SetColor'''(Color color);</code>
  
statusNavigation.SetDarkMode(BackgroundMode); // Set background color of bars to dark
+
To set background color of bars to light with light content:
  
statusNavigation.SetColor(Color color); // Set bars background color
+
<code>statusNavigation.'''SetLightModeWithLightContent'''();</code>
  
statusNavigation.SetStatusLightMode(BackgroundMode); // Set background color of status bar to light
+
To set background color of bars to dark with light content:
  
statusNavigation.SetStatusDarkMode(); // Set background color of status bar to dark
+
<code>statusNavigation.'''SetDarkModeWithLightContent'''();</code>
  
statusNavigation.SetStatusColor(Color color); // Set status bar background color
+
To set background color of bars to light with dark content:
  
statusNavigation.SetStatusLightModeWithLightContent(); // Set background color of status bar to light
+
<code>statusNavigation.'''SetLightModeWithDarkContent'''();</code>
  
statusNavigation.SetStatusDarkModeWithLightContent(); // Set background color of status bar to dark
+
To set background color of bars to dark with dark content:
  
statusNavigation.SetStatusLightModeWithDarkContent(); // Set background color of status bar to light
+
<code>statusNavigation.'''SetDarkModeWithDarkContent'''();</code>
  
statusNavigation.SetStatusDarkModeWithDarkContent(); // Set background color of status bar to dark
 
  
statusNavigation.SetNavigationLightMode(BackgroundMode); // Set background color of navigation bar to light
+
'''Status'''
  
statusNavigation.SetNavigationDarkMode(BackgroundMode); // Set background color of navigation bar to dark
+
To set background color of status bar to light:
  
statusNavigation.SetNavigationColor(Color color); // Set navigation bar background color
+
<code>statusNavigation.'''SetStatusLightMode'''(BackgroundMode);</code>
  
statusNavigation.SetNavigationLightModeWithLightContent(); // Set background color of navigation bar to light
+
To set background color of status bar to dark:
  
statusNavigation.SetNavigationDarkModeWithLightContent(); // Set background color of navigation bar to dark
+
<code>statusNavigation.'''SetStatusDarkMode'''();</code>
  
statusNavigation.SetNavigationLightModeWithDarkContent(); // Set background color of navigation bar to light
+
To set status bar background color:
  
statusNavigation.SetNavigationDarkModeWithDarkContent(); // Set background color of navigation bar to dark
+
<code>statusNavigation.'''SetStatusColor'''(Color color);</code>
</syntaxhighlight>
+
 
 +
To set background color of status bar to light with light content:
 +
 
 +
<code>statusNavigation.'''SetStatusLightModeWithLightContent'''();</code>
 +
 
 +
To set background color of status bar to dark with light content:
 +
 
 +
<code>statusNavigation.'''SetStatusDarkModeWithLightContent'''();</code>
 +
 
 +
To set background color of status bar to light with dark content:
 +
 
 +
<code>statusNavigation.'''SetStatusLightModeWithDarkContent'''();</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'''
 +
 
 +
Status light mode color:
 +
 
 +
<code>Color statusNavigation.'''statusLightModeBackgroundColor''';</code>
 +
 
 +
Status dark mode color:
 +
 
 +
<code>Color statusNavigation.'''statusDarkModeBackgroundColor''';</code>
 +
 
 +
 
 +
'''Navigation'''
 +
 
 +
Navigation light mode color:
 +
 
 +
<code>Color statusNavigation.'''navigationLightModeBackgroundColor''';</code>
 +
 
 +
Navigation dark mode color:
 +
 
 +
<code>Color statusNavigation.'''navigationDarkModeBackgroundColor''';</code>
 +
 
 +
 
 +
'''Other'''
 +
 
 +
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 ==
 +
'''Realtime data'''
  
<code>Color statusNavigation.statusDarkModeBackgroundColor; // Status dark mode color</code>
+
Get realtime height of status bar:
  
<code>Color statusNavigation.navigationLightModeBackgroundColor; // Navigation light mode color</code>
+
<code>float MobileStatusNavigationBar.'''StatusBarHeight''';</code>
  
<code>Color statusNavigation.navigationDarkModeBackgroundColor; // Navigation dark mode color</code>
+
Get realtime height of navigation bar:
  
<code>UnityEvent statusNavigation.backButtonOnClick; // Back button event</code>
+
<code>float MobileStatusNavigationBar.'''NavigationBarHeight''';</code>
  
<code>bool statusNavigation.startFullScreen; // Sets to fullscreen at Start</code>
 
  
<code>bool statusNavigation.startLightMode; // Sets to light mode at Start</code>
+
'''Static data'''
  
== C# internal static variables generated by the component Mobile Status Navigation Bar ==
+
Get height of status bar:
<code>float MobileStatusNavigationBar.StatusBarHeight; // Get Realtime Height of Status Bar</code>
 
  
<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>

Latest revision as of 01:33, 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

Status light mode color:

Color statusNavigation.statusLightModeBackgroundColor;

Status dark mode color:

Color statusNavigation.statusDarkModeBackgroundColor;


Navigation

Navigation light mode color:

Color statusNavigation.navigationLightModeBackgroundColor;

Navigation dark mode color:

Color statusNavigation.navigationDarkModeBackgroundColor;


Other

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

Realtime data

Get realtime height of status bar:

float MobileStatusNavigationBar.StatusBarHeight;

Get realtime height of navigation bar:

float MobileStatusNavigationBar.NavigationBarHeight;


Static data

Get height of status bar:

float MobileStatusNavigationBar.StatusBarHeight_STATIC;

Get height of navigation bar:

float MobileStatusNavigationBar.NavigationBarHeight_STATIC;