Class AppBar
Definition
- Namespace:
- Tizen.NUI.Components
- Assembly:
- Tizen.NUI.Components.dll
The AppBar class is a class which shows title text and provides navigation and action functions on Page.
public class AppBar : Control, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider
- Inheritance
-
objectAppBar
- Implements
-
System.IDisposable
Constructors
View SourceAppBar()
Creates a new instance of AppBar.
Declaration
public AppBar()
AppBar(string)
Creates a new instance of AppBar.
Declaration
public AppBar(string style)
Parameters
| Type | Name | Description |
|---|---|---|
| string | style | Creates AppBar by special style defined in UX. |
AppBar(AppBarStyle)
Creates a new instance of AppBar.
Declaration
public AppBar(AppBarStyle appBarStyle)
Parameters
| Type | Name | Description |
|---|---|---|
| AppBarStyle | appBarStyle | Creates AppBar by style customized by user. |
Fields
View SourceActionContentProperty
ActionContentProperty
Declaration
public static readonly BindableProperty ActionContentProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
AutoNavigationContentProperty
AutoNavigationContentProperty
Declaration
public static readonly BindableProperty AutoNavigationContentProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
NavigationContentProperty
NavigationContentProperty
Declaration
public static readonly BindableProperty NavigationContentProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
TitleContentProperty
TitleContentProperty
Declaration
public static readonly BindableProperty TitleContentProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
TitleProperty
TitleProperty
Declaration
public static readonly BindableProperty TitleProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
Properties
View SourceActionContent
Action content of AppBar. ActionContent is added as a child of AppBar automatically. Action content contains action views and action buttons by Actions. The Action and ActionButton styles of AppBarStyle are applied to actions only by setting Actions.
Declaration
public View ActionContent { get; set; }
Property Value
| Type | Description |
|---|---|
| View |
Actions
Action views of AppBar. Action views are added to ActionContent of AppBar. If action views and action buttons are set to Actions, then proper style look for action views and action buttons are automatically applied to action views and action buttons. e.g. size, button icon color, etc. If you do not want to apply framework's style look for action views and action buttons, then please use ActionContent.Add(actionView) instead of setting Actions.
Declaration
public IEnumerable<View> Actions { get; set; }
Property Value
| Type | Description |
|---|---|
| IEnumerable<><View> |
AutoNavigationContent
Flag to indicate if default navigation content is automatically set or not. The default value is true. If AutoNavigationContent is set to be true and NavigationContent is not set, then default navigation content is automatically displayed. If default navigation content is clicked, the back navigation proceeds.
Declaration
public bool AutoNavigationContent { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
DefaultActionContent
Default action content of AppBar set automatically by default. If ActionContent is not set by user, then default action content is automatically displayed.
Declaration
protected View DefaultActionContent { get; }
Property Value
| Type | Description |
|---|---|
| View |
DefaultNavigationContent
Default navigation content of AppBar set automatically by default. If AutoNavigationContent is set to be true and NavigationContent is not set, then default navigation content is automatically displayed. If default navigation content is clicked, it calls navigator pop operation.
Declaration
protected View DefaultNavigationContent { get; }
Property Value
| Type | Description |
|---|---|
| View |
DefaultTitleContent
Default title content of AppBar set automatically by default. If TitleContent is not set by user, then default title content is automatically displayed.
Declaration
protected View DefaultTitleContent { get; }
Property Value
| Type | Description |
|---|---|
| View |
NavigationContent
Navigation content of AppBar. NavigationContent is added as a child of AppBar automatically. If AutoNavigationContent is set to be true and NavigationContent is not set, then default navigation content is automatically displayed.
Declaration
public View NavigationContent { get; set; }
Property Value
| Type | Description |
|---|---|
| View |
Title
Title text of AppBar. Title sets title text to the default title content. If TitleContent is not TextLabel, then Title does not set title text of the TitleContent.
Declaration
public string Title { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
TitleContent
Title content of AppBar. TitleContent is added as a child of AppBar automatically. If TitleContent is not TextLabel, then Title does not set title text of the TitleContent.
Declaration
public View TitleContent { get; set; }
Property Value
| Type | Description |
|---|---|
| View |
Methods
View SourceAccessibilityGetName()
Gets accessibility name.
Declaration
protected override string AccessibilityGetName()
Returns
| Type | Description |
|---|---|
| string |
Overrides
View SourceApplyStyle(ViewStyle)
Applies style to AppBar.
Declaration
public override void ApplyStyle(ViewStyle viewStyle)
Parameters
| Type | Name | Description |
|---|---|---|
| ViewStyle | viewStyle | The style to apply. |
Overrides
View SourceCreateViewStyle()
Gets AppBar style.
Declaration
protected override ViewStyle CreateViewStyle()
Returns
| Type | Description |
|---|---|
| ViewStyle | The default AppBar style. |
Overrides
View SourceDispose(DisposeTypes)
Disposes AppBar and all children on it.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
| Type | Name | Description |
|---|---|---|
| DisposeTypes | type | Dispose type. |
Overrides
View SourceGetNextFocusableView(View, FocusDirection, bool)
ToDo : only key navigation is enabled, but value editing is not yet added. for example, after enter key and up/down key the value need be changed.
Declaration
public override View GetNextFocusableView(View currentFocusedView, View.FocusDirection direction, bool loopEnabled)
Parameters
| Type | Name | Description |
|---|---|---|
| View | currentFocusedView | |
| View.FocusDirection | direction | |
| bool | loopEnabled |
Returns
| Type | Description |
|---|---|
| View |
Overrides
View SourceOnInitialize()
Overrides the parent method. This method is called by the framework when the instance is created.
Declaration
public override void OnInitialize()
Overrides
View SourcePassFocusableViewInsideIfNeeded()
when the derived class of Control is used as container and itself is not Focusable, this can be used when calling SetCurrentFocusView() this can return Focusable View inside of itself. this can be utilized when default algorithm is enabled and when the case of setting first key focus in container.
Declaration
protected override View PassFocusableViewInsideIfNeeded()
Returns
| Type | Description |
|---|---|
| View | Focusable View inside of container |