UGrokItApiForms.UgiFormsTitleBar Class Reference

Overview

Xamarin.Forms UI component meant for the top of the screen, a title bar with the app name and a UgiFormsStatusImageView

Instance Methods

 UgiFormsTitleBar ()
 Initializes a new instance of the UgiFormsTitleBar class. More...
 

Properties

string Title [get, set]
 Gets or sets the title. More...
 
string TitleImage [get, set]
 Gets or sets the title image. More...
 
Color ThemeColor [get, set]
 Gets the color of the title bar More...
 
Color TextColorOnThemeColor [get, set]
 Gets the text color to use when the background is the theme color More...
 
bool UseBackgroundBasedOnThemeColor [get, set]
 whether the view should use a background color based on the UI color More...
 
bool DisplayWaveAnimationWhileScanning [get, set]
 whether the view should display an animation whiole scanning More...
 
bool HideBatteryStatusIndicator [get, set]
 whether the view should display an animation whiole scanning More...
 
bool BatteryStatusIndicatorDisplayVersionInfoOnTouch [get, set]
 whether the view should display an animation whiole scanning More...
 
Action BackButtonAction [get, set]
 Code to execute for Back, or null for no back button More...
 
string RightButtonImage [get, set]
 Gets or sets the right button image. More...
 
Color RightButtonColor [get, set]
 Gets the color for the right button image (if any) More...
 
string RightButtonHighlightedImage [get, set]
 Gets or sets the right button image. More...
 
Color RightButtonHighlightedColor [get, set]
 Gets the color for the right button image (if any) More...
 
Action RightButtonAction [get, set]
 Gets or sets the right button action. More...
 

Constants

static readonly BindableProperty TitleProperty
 BindableProperty for Title More...
 
static readonly BindableProperty TitleImageProperty
 BindableProperty for TitleImage More...
 
static readonly BindableProperty ThemeColorProperty
 BindableProperty for ThemeColor More...
 
static readonly BindableProperty TextColorOnThemeColorProperty
 BindableProperty for TextColorOnThemeColor More...
 
static readonly BindableProperty UseBackgroundBasedOnThemeColorProperty
 BindableProperty for UseBackgroundBasedOnThemeColor More...
 
static readonly BindableProperty DisplayWaveAnimationWhileScanningProperty
 BindableProperty for DisplayWaveAnimationWhileScanning More...
 
static readonly BindableProperty HideBatteryStatusIndicatorProperty
 BindableProperty for HideBatteryStatusIndicator More...
 
static readonly BindableProperty BatteryStatusIndicatorDisplayVersionInfoOnTouchProperty
 BindableProperty for BatteryStatusIndicatorDisplayVersionInfoOnTouch More...
 
static readonly BindableProperty BackButtonActionProperty
 BindableProperty for BackButtonAction More...
 
static readonly BindableProperty RightButtonImageProperty
 BindableProperty for RightButtonImage More...
 
static readonly BindableProperty RightButtonColorProperty
 BindableProperty for RightButtonColor More...
 
static readonly BindableProperty RightButtonHighlightedImageProperty
 BindableProperty for RightButtonImage More...
 
static readonly BindableProperty RightButtonHighlightedColorProperty
 BindableProperty for RightButtonHighlightedColor More...
 
static readonly BindableProperty RightButtonActionProperty
 BindableProperty for RightButtonAction More...
 

Property Documentation

◆ Title

string UGrokItApiForms.UgiFormsTitleBar.Title
getset

Gets or sets the title.

The title.

◆ TitleImage

string UGrokItApiForms.UgiFormsTitleBar.TitleImage
getset

Gets or sets the title image.

The title.

◆ ThemeColor

Color UGrokItApiForms.UgiFormsTitleBar.ThemeColor
getset

Gets the color of the title bar

Color for the title bar.

◆ TextColorOnThemeColor

Color UGrokItApiForms.UgiFormsTitleBar.TextColorOnThemeColor
getset

Gets the text color to use when the background is the theme color

Text color to use when the background is the theme color.

◆ UseBackgroundBasedOnThemeColor

bool UGrokItApiForms.UgiFormsTitleBar.UseBackgroundBasedOnThemeColor
getset

whether the view should use a background color based on the UI color

true if the view uses a background

◆ DisplayWaveAnimationWhileScanning

bool UGrokItApiForms.UgiFormsTitleBar.DisplayWaveAnimationWhileScanning
getset

whether the view should display an animation whiole scanning

true if the view will display the wave animation

◆ HideBatteryStatusIndicator

bool UGrokItApiForms.UgiFormsTitleBar.HideBatteryStatusIndicator
getset

whether the view should display an animation whiole scanning

true if the view will display the wave animation

◆ BatteryStatusIndicatorDisplayVersionInfoOnTouch

bool UGrokItApiForms.UgiFormsTitleBar.BatteryStatusIndicatorDisplayVersionInfoOnTouch
getset

whether the view should display an animation whiole scanning

true if the view will display the wave animation

◆ BackButtonAction

Action UGrokItApiForms.UgiFormsTitleBar.BackButtonAction
getset

Code to execute for Back, or null for no back button

true if the view uses a background

◆ RightButtonImage

string UGrokItApiForms.UgiFormsTitleBar.RightButtonImage
getset

Gets or sets the right button image.

Image for the right buton, or null for no right button

◆ RightButtonColor

Color UGrokItApiForms.UgiFormsTitleBar.RightButtonColor
getset

Gets the color for the right button image (if any)

Color

◆ RightButtonHighlightedImage

string UGrokItApiForms.UgiFormsTitleBar.RightButtonHighlightedImage
getset

Gets or sets the right button image.

Image for the right buton, or null for no right button

◆ RightButtonHighlightedColor

Color UGrokItApiForms.UgiFormsTitleBar.RightButtonHighlightedColor
getset

Gets the color for the right button image (if any)

Color

◆ RightButtonAction

Action UGrokItApiForms.UgiFormsTitleBar.RightButtonAction
getset

Gets or sets the right button action.

Code to ewxecute when the right button is pressed

Constructor & Destructor Documentation

◆ UgiFormsTitleBar()

UGrokItApiForms.UgiFormsTitleBar.UgiFormsTitleBar ( )
inline

Initializes a new instance of the UgiFormsTitleBar class.

Member Data Documentation

◆ TitleProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.TitleProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "Title",
returnType: typeof (string),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: null)

BindableProperty for Title

◆ TitleImageProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.TitleImageProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "TitleImage",
returnType: typeof (string),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: null)

BindableProperty for TitleImage

◆ ThemeColorProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.ThemeColorProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "ThemeColor",
returnType: typeof (Color),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: UgiForms.NULL_COLOR)

BindableProperty for ThemeColor

◆ TextColorOnThemeColorProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.TextColorOnThemeColorProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "TextColorOnThemeColor",
returnType: typeof (Color),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: UgiForms.NULL_COLOR)

BindableProperty for TextColorOnThemeColor

◆ UseBackgroundBasedOnThemeColorProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.UseBackgroundBasedOnThemeColorProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "UseBackgroundBasedOnThemeColor",
returnType: typeof (bool),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: false)

BindableProperty for UseBackgroundBasedOnThemeColor

◆ DisplayWaveAnimationWhileScanningProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.DisplayWaveAnimationWhileScanningProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "DisplayWaveAnimationWhileScanning",
returnType: typeof (bool),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: false)

BindableProperty for DisplayWaveAnimationWhileScanning

◆ HideBatteryStatusIndicatorProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.HideBatteryStatusIndicatorProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "HideBatteryStatusIndicator",
returnType: typeof (bool),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: false)

BindableProperty for HideBatteryStatusIndicator

◆ BatteryStatusIndicatorDisplayVersionInfoOnTouchProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.BatteryStatusIndicatorDisplayVersionInfoOnTouchProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "BatteryStatusIndicatorDisplayVersionInfoOnTouch",
returnType: typeof (bool),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: false)

BindableProperty for BatteryStatusIndicatorDisplayVersionInfoOnTouch

◆ BackButtonActionProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.BackButtonActionProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "BackButtonAction",
returnType: typeof (Action),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: null)

BindableProperty for BackButtonAction

◆ RightButtonImageProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.RightButtonImageProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "RightButtonImage",
returnType: typeof (string),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: null)

BindableProperty for RightButtonImage

◆ RightButtonColorProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.RightButtonColorProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "RightButtonColor",
returnType: typeof (Color),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: UgiForms.NULL_COLOR)

BindableProperty for RightButtonColor

◆ RightButtonHighlightedImageProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.RightButtonHighlightedImageProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "RightButtonHighlightedImage",
returnType: typeof (string),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: null)

BindableProperty for RightButtonImage

◆ RightButtonHighlightedColorProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.RightButtonHighlightedColorProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "RightButtonHighlightedColor",
returnType: typeof (Color),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: UgiForms.NULL_COLOR)

BindableProperty for RightButtonHighlightedColor

◆ RightButtonActionProperty

readonly BindableProperty UGrokItApiForms.UgiFormsTitleBar.RightButtonActionProperty
static
Initial value:
= BindableProperty.Create (
propertyName: "RightButtonAction",
returnType: typeof (Action),
declaringType: typeof (UgiFormsTitleBar),
defaultValue: null)

BindableProperty for RightButtonAction