ActionComponents  04.05.00
Customizable UI and time-saving tools for Android development with Xamarin and Visual Studio.
ActionComponents.ACNavBarButtonCollection Class Reference

This collection holds all buttons within a given section (top, middle or bottom) of a ActionComponents.ACNavBar and has properties to control the appearance of new ActionComponents.ACNavBarButtons added to the collection. More...

Public Member Functions

ACNavBarButton AddButton (int image, bool enabled, bool hidden)
 Creates a new button and adds it to the collection More...
 
ACNavBarButton AddButton (int image, bool enabled, bool hidden, object tag)
 Creates a new button and adds it to the collection More...
 
ACNavBarButton AddAutoDisposingButton (int image, bool enabled, bool hidden)
 Creates a new button that will automatically dispose of its attached view when it is unselected and adds it to the collection More...
 
ACNavBarButton AddAutoDisposingButton (int image, bool enabled, bool hidden, object tag)
 Creates a new button that will automatically dispose of its attached view when it is unselected and adds it to the collection More...
 
ACNavBarButton AddTool (int image, bool enabled, bool hidden)
 Creates a new tool button and adds it to the collection More...
 
ACNavBarButton AddTool (int image, bool enabled, bool hidden, object tag)
 Creates a new tool button and adds it to the collection More...
 
ACNavBarButton AddNotification (int image, object tag, bool hidden)
 Creates a new notification icon and adds it to the collection More...
 
ACNavBarButton Button (int index)
 Returns the ActionComponents.ACNavBarButton for the specified index More...
 
void RemoveButtonAt (int index)
 Removes the button at index. More...
 
void Clear ()
 Removes all ActionComponents.ACNavBarButtons from the collection More...
 
void SelectButtonAt (int index)
 Selects the ActionComponents.ACNavBarButton at the given index. More...
 
ACNavBarButton SelectedButton ()
 Returns the currently selected ActionComponents.ACNavBarButton in this ActionComponents.ACNavBarButtonCollection button group More...
 

Public Attributes

object tag
 [OPTIONAL] Tag to hold user information about this collection More...
 

Properties

int Id [get, set]
 Gets or sets the unique identifier for this ActionComponents.ACNavBarButtonCollection More...
 
int rehydrationId [get, set]
 Gets or sets the rehydration identifier used to restore the selected ActionComponents.ACNavBarButton after a state change such as rotation. More...
 
float top [get]
 Gets the top position for this virtual layout More...
 
float left [get]
 Gets the left position for this virtual layout More...
 
float width [get]
 Gets the width for this virtual layout More...
 
float height [get]
 Gets the height for this virtual layout More...
 
ACNavBarButtonCollectionLocation location [get]
 Gets the location. More...
 
bool suspendUpdates [get, set]
 Gets or sets a value indicating whether this ActionComponents.ACNavBarButtonCollection suspends the updating of the GUI. More...
 
ACNavBarButtonAppearance buttonAppearanceEnabled [get, set]
 Gets or sets the button appearance enabled values More...
 
ACNavBarButtonAppearance buttonAppearanceDisabled [get, set]
 Gets or sets the button appearance disabled values More...
 
ACNavBarButtonAppearance buttonAppearanceSelected [get, set]
 Gets or sets the button appearance selected values More...
 
int Count [get]
 Returns the number of buttons in this collection More...
 

Detailed Description

This collection holds all buttons within a given section (top, middle or bottom) of a ActionComponents.ACNavBar and has properties to control the appearance of new ActionComponents.ACNavBarButtons added to the collection.

ActionComponents.ACNavBarButtonCollections can not be directly created but can be interacted with via the parent containing ActionComponents.ACNavBar

Member Function Documentation

ACNavBarButton ActionComponents.ACNavBarButtonCollection.AddAutoDisposingButton ( int  image,
bool  enabled,
bool  hidden 
)

Creates a new button that will automatically dispose of its attached view when it is unselected and adds it to the collection

Returns
The button.
Parameters
imageThe button's icon
enabledIf set to true enabled.
hiddenIf set to true hidden.

Creates a ActionComponents.ACNavBarButton that controls an attached UIView. The view will be automatically removed from memory when it loses focus.

Here is the call graph for this function:

ACNavBarButton ActionComponents.ACNavBarButtonCollection.AddAutoDisposingButton ( int  image,
bool  enabled,
bool  hidden,
object  tag 
)

Creates a new button that will automatically dispose of its attached view when it is unselected and adds it to the collection

Returns
The button.
Parameters
imageThe button's icon
enabledIf set to true enabled.
hiddenIf set to true hidden.
tagHolds any user defined information for the button

Creates a ActionComponents.ACNavBarButton that controls an attached UIView. The view will be automatically removed from memroy when it loses focus.

Here is the call graph for this function:

ACNavBarButton ActionComponents.ACNavBarButtonCollection.AddButton ( int  image,
bool  enabled,
bool  hidden 
)

Creates a new button and adds it to the collection

Returns
The button.
Parameters
imageThe button's icon
enabledIf set to true enabled.
hiddenIf set to true hidden.

Creates a ActionComponents.ACNavBarButton that controls an attached UIView

Here is the caller graph for this function:

ACNavBarButton ActionComponents.ACNavBarButtonCollection.AddButton ( int  image,
bool  enabled,
bool  hidden,
object  tag 
)

Creates a new button and adds it to the collection

Returns
The button.
Parameters
imageThe button's icon
enabledIf set to true enabled.
hiddenIf set to true hidden.
tagHolds any user defined information for the button

Creates a ActionComponents.ACNavBarButton that controls an attached UIView

Here is the call graph for this function:

ACNavBarButton ActionComponents.ACNavBarButtonCollection.AddNotification ( int  image,
object  tag,
bool  hidden 
)

Creates a new notification icon and adds it to the collection

Returns
The button.
Parameters
imageThe button's icon
tagHolds any user defined information for the button
hiddenIf set to true hidden.

Notification icons are for display only and do not respond to touch

Here is the call graph for this function:

ACNavBarButton ActionComponents.ACNavBarButtonCollection.AddTool ( int  image,
bool  enabled,
bool  hidden 
)

Creates a new tool button and adds it to the collection

Returns
The button.
Parameters
imageThe button's icon
enabledIf set to true enabled.
hiddenIf set to true hidden.

Tool buttons do not have an attached UIView or move the ActionComponents.ACNavBarPointer when selected

Here is the call graph for this function:

ACNavBarButton ActionComponents.ACNavBarButtonCollection.AddTool ( int  image,
bool  enabled,
bool  hidden,
object  tag 
)

Creates a new tool button and adds it to the collection

Returns
The button.
Parameters
imageThe button's icon
enabledIf set to true enabled.
hiddenIf set to true hidden.
tagHolds any user defined information for the button

Tool buttons do not have an attached UIView or move the ActionComponents.ACNavBarPointer when selected

Here is the call graph for this function:

ACNavBarButton ActionComponents.ACNavBarButtonCollection.Button ( int  index)

Returns the ActionComponents.ACNavBarButton for the specified index

Parameters
indexThe index of the button requested

Requesting an index out of range will result in a null being returned

Returns
The ActionComponents.ACNavBarButton for the given index
void ActionComponents.ACNavBarButtonCollection.Clear ( )

Removes all ActionComponents.ACNavBarButtons from the collection

void ActionComponents.ACNavBarButtonCollection.RemoveButtonAt ( int  index)

Removes the button at index.

Parameters
indexIndex of the button to remove

No action is taken if the index is out of range

void ActionComponents.ACNavBarButtonCollection.SelectButtonAt ( int  index)

Selects the ActionComponents.ACNavBarButton at the given index.

Parameters
indexIndex of the button to select

No action is taken if the index if out of range.

ACNavBarButton ActionComponents.ACNavBarButtonCollection.SelectedButton ( )

Returns the currently selected ActionComponents.ACNavBarButton in this ActionComponents.ACNavBarButtonCollection button group

Returns
Returns the ActionComponents.ACNavBarButton selected or null if no button is selected

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

object ActionComponents.ACNavBarButtonCollection.tag

[OPTIONAL] Tag to hold user information about this collection

Property Documentation

ACNavBarButtonAppearance ActionComponents.ACNavBarButtonCollection.buttonAppearanceDisabled
getset

Gets or sets the button appearance disabled values

The button appearance disabled values

Any changes to this appearance will cascade to all ActionComponents.ACNavBarButtons in this ActionComponents.ACNavBarButtonCollection

ACNavBarButtonAppearance ActionComponents.ACNavBarButtonCollection.buttonAppearanceEnabled
getset

Gets or sets the button appearance enabled values

The button appearance enabled values

Any changes to this appearance will cascade to all ActionComponents.ACNavBarButtons in this ActionComponents.ACNavBarButtonCollection

ACNavBarButtonAppearance ActionComponents.ACNavBarButtonCollection.buttonAppearanceSelected
getset

Gets or sets the button appearance selected values

The button appearance selected values

Any changes to this appearance will cascade to all ActionComponents.ACNavBarButtons in this ActionComponents.ACNavBarButtonCollection

int ActionComponents.ACNavBarButtonCollection.Count
get

Returns the number of buttons in this collection

The count.

float ActionComponents.ACNavBarButtonCollection.height
get

Gets the height for this virtual layout

The height.

int ActionComponents.ACNavBarButtonCollection.Id
getset

Gets or sets the unique identifier for this ActionComponents.ACNavBarButtonCollection

The identifier.

float ActionComponents.ACNavBarButtonCollection.left
get

Gets the left position for this virtual layout

The left.

ACNavBarButtonCollectionLocation ActionComponents.ACNavBarButtonCollection.location
get

Gets the location.

The location.

int ActionComponents.ACNavBarButtonCollection.rehydrationId
getset

Gets or sets the rehydration identifier used to restore the selected ActionComponents.ACNavBarButton after a state change such as rotation.

The rehydration identifier.

Call the ActionComponents.ACNavBar.SelectedButtonID method in the OnSaveInstanceState method of your Action to get the value to set this property to.

bool ActionComponents.ACNavBarButtonCollection.suspendUpdates
getset

Gets or sets a value indicating whether this ActionComponents.ACNavBarButtonCollection suspends the updating of the GUI.

true if suspend updates; otherwise, false.

If doing batch updates of the buttons in this collection it is best to suspend updating of the GUI first

float ActionComponents.ACNavBarButtonCollection.top
get

Gets the top position for this virtual layout

The top.

float ActionComponents.ACNavBarButtonCollection.width
get

Gets the width for this virtual layout

The width.