Overview

Ugi subclass of Application, adding title bar, footer and various UGI functionality

Instance Methods
	UgiFormsContentPage (bool createTitleBar=true, bool createFooter=false, bool overlapStatusBar=false)
	Initializes a new instance of the UgiFormsContentPage class. More...

async Task	ShowEmbeddedPopup (View popup)
	Shows the embedded popup. More...

async Task	ShowPopup (View popup, bool modal=false, View relativeTo=null, PopupPositionings positioning=PopupPositionings.CenterOnScreen)
	Show a popup window More...

async Task	ShowPopup (View popup, bool modal, Rectangle relativeToBounds, PopupPositionings positioning)
	Show a popup window More...

void	MovePopup (View popup, View relativeTo=null, PopupPositionings positioning=PopupPositionings.CenterOnScreen)
	Move a popup window More...

void	MovePopup (View popup, Rectangle relativeToBounds, PopupPositionings positioning)
	Move a popup window More...

void	MovePopupAbsolute (View popup, double x, double y, bool keepOnScreen)
	Move a popup window to an absolute position More...

void	GetPopupLocationAbsolute (View popup, out double x, out double y)
	Gets the absolute position of a popup window More...

async Task	HidePopup (View popup)
	Hide a popup window (does not remove it) More...

virtual void	GoForward (Page page, bool removeThisPage=false)
	Go forward to another page More...

virtual void	GoBack ()
	Go back a page More...

virtual void	BeforeLeavingPage (bool goingForward, Action completion)
	Called before leaving a page More...

virtual void	DisconnectedDialogCancelled ()
	Called when the disconnected dialog box is cancelled More...

Properties
bool	CreateTitleBar `[get]`
	Create a title bar? More...

bool	CreateFooter `[get]`
	Create a footer? More...

bool	OverlapStatusBar `[get]`
	Overlap the status bar? More...

Color	ThemeColor `[get, set]`
	Gets the color of the page More...

Color	TextColorOnThemeColor `[get, set]`
	Gets the text color to use when the background is the theme color More...

UgiFormsTitleBar	FormsTitleBar `[get]`
	Title bar More...

UgiFormsFooter	FormsFooter `[get]`
	Footer More...

virtual Layout	InnerContent `[get, set]`
	Content inside the age More...

bool	IsAppeared `[get]`
	Gets a value indicating whether this page has appeared (is on the screen). More...

bool	DisplayDialogIfDisconnected `[get, set]`
	whether to display the "disconnected .. please connect the Grokker" dialog if needed while running inventory More...

bool	DisplayDialogIfDisconnectedEvenIfNotRunningInventory `[get, set]`
	whether to display the "disconnected .. please connect the Grokker" dialog anytime the Grokker is not connected, even if not running inventory More...

string	TitleBarTitle `[get, set]`
	Title for the title bar More...

bool	TitleBarUseBackgroundBasedOnThemeColor `[get, set]`
	whether the title bar should use a background color based on the UI color More...

bool	TitleBarDisplayWaveAnimationWhileScanning `[get, set]`
	whether the title bar should display an animation whiole scanning More...

bool	TitleBarHideBatteryStatusIndicator `[get, set]`
	whether the title bar should display an animation whiole scanning More...

bool	TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouch `[get, set]`
	whether the title bar should display an animation whiole scanning More...

Types
enum	PopupPositionings { CenterOnScreen, BelowReferenceObject, AboveReferenceObject, AwayFromReferenceObject }
	Value passed to ShowPopup to determine where the popup is positioned More...

Constants
static readonly BindableProperty	DisplayDialogIfDisconnectedProperty
	BindableProperty for DisplayDialogIfDisconnected More...

static readonly BindableProperty	DisplayDialogIfDisconnectedEvenIfNotRunningInventoryProperty
	BindableProperty for DisplayDialogIfDisconnectedEvenIfNotRunningInventory More...

static readonly BindableProperty	TitleBarTitleProperty
	BindableProperty for TitleBarTitle More...

static readonly BindableProperty	TitleBarUseBackgroundBasedOnThemeColorProperty
	BindableProperty for TitleBarUseBackgroundBasedOnThemeColor More...

static readonly BindableProperty	TitleBarDisplayWaveAnimationWhileScanningProperty
	BindableProperty for TitleBarDisplayWaveAnimationWhileScanning More...

static readonly BindableProperty	TitleBarHideBatteryStatusIndicatorProperty
	BindableProperty for TitleBarHideBatteryStatusIndicator More...

static readonly BindableProperty	TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouchProperty
	BindableProperty for TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouch More...

Protected Member Functions
virtual void	KeyboardStateChange (bool keyboardShown, double contentHeight)
	Called when the keyboard state changes, just before the content area is resized More...

virtual void	OnRotation ()
	Called when the device is rotated More...

virtual void	WillAppear ()
	Called before the page appears, if possible. On Android this is caled just after the page appears, because that is the best we can do More...

virtual void	ConnectionStateChanged ()
	Called when the connection state changes More...

virtual void	InventoryStateChanged ()
	Called when the inventory state changes More...

virtual void	BackButtonPressed ()
	Called when the title bar's back button is pressed More...

Instance Method Documentation

◆ KeyboardStateChange()

virtual void UGrokItApiForms.UgiFormsContentPage.KeyboardStateChange	(	bool	keyboardShown,
		double	contentHeight
	)

inlineprotectedvirtual

Called when the keyboard state changes, just before the content area is resized

Parameters

keyboardShown	true if keyboard is shown
contentHeight	Content height

◆ OnRotation()

virtual void UGrokItApiForms.UgiFormsContentPage.OnRotation ( )

inlineprotectedvirtual

Called when the device is rotated

◆ WillAppear()

virtual void UGrokItApiForms.UgiFormsContentPage.WillAppear ( )

inlineprotectedvirtual

Called before the page appears, if possible. On Android this is caled just after the page appears, because that is the best we can do

◆ ShowEmbeddedPopup()

async Task UGrokItApiForms.UgiFormsContentPage.ShowEmbeddedPopup ( View popup )

inline

Shows the embedded popup.

Parameters

popup The popup to show

Returns: Task to wait on if the caller wants to wait until the popup is fully shown

◆ ShowPopup() [1/2]

async Task UGrokItApiForms.UgiFormsContentPage.ShowPopup	(	View	popup,
		bool	modal = `false`,
		View	relativeTo = `null`,
		PopupPositionings	positioning = `PopupPositionings.CenterOnScreen`
	)

inline

Show a popup window

Parameters

popup	The popup to show
modal	true to make this popup modal
relativeTo	View to position relative to
positioning	Method for positioning the popup

Returns: Task to wait on if the caller wants to wait until the popup is fully shown

◆ ShowPopup() [2/2]

async Task UGrokItApiForms.UgiFormsContentPage.ShowPopup	(	View	popup,
		bool	modal,
		Rectangle	relativeToBounds,
		PopupPositionings	positioning
	)

inline

Show a popup window

Parameters

popup	The popup to show
modal	true to make this popup modal
relativeToBounds	Bounds to position relative to
positioning	Method for positioning the popup

Returns: Task to wait on if the caller wants to wait until the popup is fully shown

◆ MovePopup() [1/2]

void UGrokItApiForms.UgiFormsContentPage.MovePopup	(	View	popup,
		View	relativeTo = `null`,
		PopupPositionings	positioning = `PopupPositionings.CenterOnScreen`
	)

inline

Move a popup window

Parameters

popup	The popup to move
relativeTo	View to position relative to
positioning	Method for positioning the popup

◆ MovePopup() [2/2]

void UGrokItApiForms.UgiFormsContentPage.MovePopup	(	View	popup,
		Rectangle	relativeToBounds,
		PopupPositionings	positioning
	)

inline

Move a popup window

Parameters

popup	The popup to move
relativeToBounds	Bounds to position relative to
positioning	Method for positioning the popup

◆ MovePopupAbsolute()

void UGrokItApiForms.UgiFormsContentPage.MovePopupAbsolute	(	View	popup,
		double	x,
		double	y,
		bool	keepOnScreen
	)

inline

Move a popup window to an absolute position

Parameters

popup	The popup to move
x	The x coordinate to move to
y	The y coordinate to move to
keepOnScreen	true to keep the popup on the screen

◆ GetPopupLocationAbsolute()

void UGrokItApiForms.UgiFormsContentPage.GetPopupLocationAbsolute	(	View	popup,
		out double	x,
		out double	y
	)

inline

Gets the absolute position of a popup window

Returns: The position

Parameters

popup	The popup to get the absolute position of
x	The x coordinate of the popup (a return value)
y	The y coordinate of the popup (a return value)

◆ HidePopup()

async Task UGrokItApiForms.UgiFormsContentPage.HidePopup ( View popup )

inline

Hide a popup window (does not remove it)

Parameters

popup The popup to hide

Returns: Task to wait on if the caller wants to wait until the popup is fully hidden

◆ ConnectionStateChanged()

virtual void UGrokItApiForms.UgiFormsContentPage.ConnectionStateChanged ( )

inlineprotectedvirtual

Called when the connection state changes

◆ InventoryStateChanged()

virtual void UGrokItApiForms.UgiFormsContentPage.InventoryStateChanged ( )

inlineprotectedvirtual

Called when the inventory state changes

◆ BackButtonPressed()

virtual void UGrokItApiForms.UgiFormsContentPage.BackButtonPressed ( )

inlineprotectedvirtual

Called when the title bar's back button is pressed

◆ GoForward()

virtual void UGrokItApiForms.UgiFormsContentPage.GoForward	(	Page	page,
		bool	removeThisPage = `false`
	)

inlinevirtual

Go forward to another page

Parameters

page	Page to move to
removeThisPage	If set to `true` remove this page from the navigation stack.

◆ GoBack()

virtual void UGrokItApiForms.UgiFormsContentPage.GoBack ( )

inlinevirtual

Go back a page

◆ BeforeLeavingPage()

virtual void UGrokItApiForms.UgiFormsContentPage.BeforeLeavingPage	(	bool	goingForward,
		Action	completion
	)

inlinevirtual

Called before leaving a page

Parameters

goingForward	If set to `true` going forward, otherwise going back
completion	Code to run when ready to actualy leave this page.

◆ DisconnectedDialogCancelled()

virtual void UGrokItApiForms.UgiFormsContentPage.DisconnectedDialogCancelled ( )

inlinevirtual

Called when the disconnected dialog box is cancelled

Property Documentation

◆ CreateTitleBar

bool UGrokItApiForms.UgiFormsContentPage.CreateTitleBar

get

Create a title bar?

true to create a title bar; otherwise, false.

◆ CreateFooter

bool UGrokItApiForms.UgiFormsContentPage.CreateFooter

get

Create a footer?

true to create a footer; otherwise, false.

◆ OverlapStatusBar

bool UGrokItApiForms.UgiFormsContentPage.OverlapStatusBar

get

Overlap the status bar?

true if the page should overlap the status bar; otherwise, false.

◆ ThemeColor

Color UGrokItApiForms.UgiFormsContentPage.ThemeColor

getset

Gets the color of the page

Color for the page.

◆ TextColorOnThemeColor

Color UGrokItApiForms.UgiFormsContentPage.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.

◆ FormsTitleBar

UgiFormsTitleBar UGrokItApiForms.UgiFormsContentPage.FormsTitleBar

get

Title bar

The title bar for the page

◆ FormsFooter

UgiFormsFooter UGrokItApiForms.UgiFormsContentPage.FormsFooter

get

Footer

The footer for the page

◆ InnerContent

virtual Layout UGrokItApiForms.UgiFormsContentPage.InnerContent

getset

Content inside the age

The content of the page

◆ IsAppeared

bool UGrokItApiForms.UgiFormsContentPage.IsAppeared

get

Gets a value indicating whether this page has appeared (is on the screen).

true if the page has appeared, false.

◆ DisplayDialogIfDisconnected

bool UGrokItApiForms.UgiFormsContentPage.DisplayDialogIfDisconnected

getset

whether to display the "disconnected .. please connect the Grokker" dialog if needed while running inventory

true to display the disconnected dialog; otherwise, false.

◆ DisplayDialogIfDisconnectedEvenIfNotRunningInventory

bool UGrokItApiForms.UgiFormsContentPage.DisplayDialogIfDisconnectedEvenIfNotRunningInventory

getset

whether to display the "disconnected .. please connect the Grokker" dialog anytime the Grokker is not connected, even if not running inventory

true to display the disconnected dialog even if not running inventory; otherwise, false.

◆ TitleBarTitle

string UGrokItApiForms.UgiFormsContentPage.TitleBarTitle

getset

Title for the title bar

The title bar title.

◆ TitleBarUseBackgroundBasedOnThemeColor

bool UGrokItApiForms.UgiFormsContentPage.TitleBarUseBackgroundBasedOnThemeColor

getset

whether the title bar should use a background color based on the UI color

true if the view uses a background

◆ TitleBarDisplayWaveAnimationWhileScanning

bool UGrokItApiForms.UgiFormsContentPage.TitleBarDisplayWaveAnimationWhileScanning

getset

whether the title bar should display an animation whiole scanning

true if the view will display the wave animation

◆ TitleBarHideBatteryStatusIndicator

bool UGrokItApiForms.UgiFormsContentPage.TitleBarHideBatteryStatusIndicator

getset

whether the title bar should display an animation whiole scanning

true if the view will display the wave animation

◆ TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouch

bool UGrokItApiForms.UgiFormsContentPage.TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouch

getset

whether the title bar should display an animation whiole scanning

true if the view will display the wave animation

Enumeration Documentation

◆ PopupPositionings

enum UGrokItApiForms.UgiFormsContentPage.PopupPositionings

strong

Value passed to ShowPopup to determine where the popup is positioned

Constructor & Destructor Documentation

◆ UgiFormsContentPage()

UGrokItApiForms.UgiFormsContentPage.UgiFormsContentPage	(	bool	createTitleBar = `true`,
		bool	createFooter = `false`,
		bool	overlapStatusBar = `false`
	)

inline

Initializes a new instance of the UgiFormsContentPage class.

Parameters

createTitleBar	`true` to create a title bar; otherwise, `false`.
createFooter	`true` to create a footer; otherwise, `false`.
overlapStatusBar	`true` if the page should overlap the status bar; otherwise, `false`.

Member Data Documentation

◆ DisplayDialogIfDisconnectedProperty

readonly BindableProperty UGrokItApiForms.UgiFormsContentPage.DisplayDialogIfDisconnectedProperty

static

Initial value:

= BindableProperty.Create (
      propertyName: "DisplayDialogIfDisconnected",
      returnType: typeof (bool),
      declaringType: typeof (UgiFormsContentPage),
      defaultValue: false)

BindableProperty for DisplayDialogIfDisconnected

◆ DisplayDialogIfDisconnectedEvenIfNotRunningInventoryProperty

readonly BindableProperty UGrokItApiForms.UgiFormsContentPage.DisplayDialogIfDisconnectedEvenIfNotRunningInventoryProperty

static

Initial value:

= BindableProperty.Create (
      propertyName: "DisplayDialogIfDisconnectedEvenIfNotRunningInventory",
      returnType: typeof (bool),
      declaringType: typeof (UgiFormsContentPage),
      defaultValue: false)

BindableProperty for DisplayDialogIfDisconnectedEvenIfNotRunningInventory

◆ TitleBarTitleProperty

readonly BindableProperty UGrokItApiForms.UgiFormsContentPage.TitleBarTitleProperty

static

Initial value:

= BindableProperty.Create (
      propertyName: "TitleBarTitle",
      returnType: typeof (string),
      declaringType: typeof (UgiFormsContentPage),
      defaultValue: null)

BindableProperty for TitleBarTitle

◆ TitleBarUseBackgroundBasedOnThemeColorProperty

readonly BindableProperty UGrokItApiForms.UgiFormsContentPage.TitleBarUseBackgroundBasedOnThemeColorProperty

static

Initial value:

= BindableProperty.Create (
      propertyName: "TitleBarUseBackgroundBasedOnThemeColor",
      returnType: typeof (bool),
      declaringType: typeof (UgiFormsContentPage),
      defaultValue: false)

BindableProperty for TitleBarUseBackgroundBasedOnThemeColor

◆ TitleBarDisplayWaveAnimationWhileScanningProperty

readonly BindableProperty UGrokItApiForms.UgiFormsContentPage.TitleBarDisplayWaveAnimationWhileScanningProperty

static

Initial value:

= BindableProperty.Create (
      propertyName: "TitleBarDisplayWaveAnimationWhileScanning",
      returnType: typeof (bool),
      declaringType: typeof (UgiFormsContentPage),
      defaultValue: false)

BindableProperty for TitleBarDisplayWaveAnimationWhileScanning

◆ TitleBarHideBatteryStatusIndicatorProperty

readonly BindableProperty UGrokItApiForms.UgiFormsContentPage.TitleBarHideBatteryStatusIndicatorProperty

static

Initial value:

= BindableProperty.Create (
      propertyName: "TitleBarHideBatteryStatusIndicator",
      returnType: typeof (bool),
      declaringType: typeof (UgiFormsContentPage),
      defaultValue: false)

BindableProperty for TitleBarHideBatteryStatusIndicator

◆ TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouchProperty

readonly BindableProperty UGrokItApiForms.UgiFormsContentPage.TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouchProperty

static

Initial value:

= BindableProperty.Create (
      propertyName: "TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouch",
      returnType: typeof (bool),
      declaringType: typeof (UgiFormsContentPage),
      defaultValue: false)

BindableProperty for TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouch

Overview

Instance Methods

Properties

Types

Constants

Protected Member Functions

Instance Method Documentation

◆ KeyboardStateChange()

◆ OnRotation()

◆ WillAppear()

◆ ShowEmbeddedPopup()

◆ ShowPopup() [1/2]

◆ ShowPopup() [2/2]

◆ MovePopup() [1/2]

◆ MovePopup() [2/2]

◆ MovePopupAbsolute()

◆ GetPopupLocationAbsolute()

◆ HidePopup()

◆ ConnectionStateChanged()

◆ InventoryStateChanged()

◆ BackButtonPressed()

◆ GoForward()

◆ GoBack()

◆ BeforeLeavingPage()

◆ DisconnectedDialogCancelled()

Property Documentation

◆ CreateTitleBar

◆ CreateFooter

◆ OverlapStatusBar

◆ ThemeColor

◆ TextColorOnThemeColor

◆ FormsTitleBar

◆ FormsFooter

◆ InnerContent

◆ IsAppeared

◆ DisplayDialogIfDisconnected

◆ DisplayDialogIfDisconnectedEvenIfNotRunningInventory

◆ TitleBarTitle

◆ TitleBarUseBackgroundBasedOnThemeColor

◆ TitleBarDisplayWaveAnimationWhileScanning

◆ TitleBarHideBatteryStatusIndicator

◆ TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouch

Enumeration Documentation

◆ PopupPositionings

Constructor & Destructor Documentation

◆ UgiFormsContentPage()

Member Data Documentation

◆ DisplayDialogIfDisconnectedProperty

◆ DisplayDialogIfDisconnectedEvenIfNotRunningInventoryProperty

◆ TitleBarTitleProperty

◆ TitleBarUseBackgroundBasedOnThemeColorProperty

◆ TitleBarDisplayWaveAnimationWhileScanningProperty

◆ TitleBarHideBatteryStatusIndicatorProperty

◆ TitleBarBatteryStatusIndicatorDisplayVersionInfoOnTouchProperty