Show / Hide Table of Contents

    Class Naviframe

    Definition

    Namespace:
    ElmSharp
    Assembly:
    ElmSharp.dll
    API Level:
    preview

    The Naviframe is a widget to stand for the navigation frame. It's a views manager for applications. Inherits Widget.

    public class Naviframe : Widget, IAccessibleObject
    Inheritance
    Object
    EvasObject
    AccessibleObject
    Widget
    Naviframe
    Implements
    IAccessibleObject

    Constructors

    View Source

    Naviframe(EvasObject)

    Creates and initializes a new instance of the Naviframe class.

    Declaration
    public Naviframe(EvasObject parent)
    Parameters
    Type Name Description
    EvasObject parent

    The parent is a given container which will be attached by Naviframe as a child. It's EvasObject type.

    API Level: preview

    Properties

    View Source

    DefaultBackButtonEnabled

    Sets or gets whether the default back button is enabled.

    Declaration
    public bool DefaultBackButtonEnabled { get; set; }
    Property Value
    Type Description
    Boolean
    API Level: preview
    View Source

    NavigationStack

    Gets the list of the navi item.

    Declaration
    public IReadOnlyList<NaviItem> NavigationStack { get; }
    Property Value
    Type Description
    IReadOnlyList<NaviItem>
    API Level: preview
    View Source

    PreserveContentOnPop

    Sets or gets the preserve content objects when items are popped.

    Declaration
    public bool PreserveContentOnPop { get; set; }
    Property Value
    Type Description
    Boolean
    API Level: preview

    Methods

    View Source

    CreateHandle(EvasObject)

    Creates a widget handle.

    Declaration
    protected override IntPtr CreateHandle(EvasObject parent)
    Parameters
    Type Name Description
    EvasObject parent

    Parent EvasObject.

    Returns
    Type Description
    IntPtr

    Handle IntPtr.

    Overrides
    EvasObject.CreateHandle(EvasObject)
    API Level: preview
    View Source

    InsertAfter(NaviItem, EvasObject)

    Inserts a new item into the naviframe after the item. The title is "" and the style is null.

    Declaration
    public NaviItem InsertAfter(NaviItem after, EvasObject content)
    Parameters
    Type Name Description
    NaviItem after

    The item for which a new item is inserted after.

    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    Returns
    Type Description
    NaviItem

    The created item, or null upon failure.

    API Level: preview
    View Source

    InsertAfter(NaviItem, EvasObject, String)

    Inserts a new item into the naviframe after the item. The style is null.

    Declaration
    public NaviItem InsertAfter(NaviItem after, EvasObject content, string title)
    Parameters
    Type Name Description
    NaviItem after

    The item which a new item is inserted after.

    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    String title

    The current item title. Null would be default.

    Returns
    Type Description
    NaviItem

    The created item, or null upon failure.

    API Level: preview
    View Source

    InsertAfter(NaviItem, EvasObject, String, String)

    Inserts a new item into the naviframe after the item.

    Declaration
    public NaviItem InsertAfter(NaviItem after, EvasObject content, string title, string style)
    Parameters
    Type Name Description
    NaviItem after

    The item for which a new item is inserted after.

    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    String title

    The current item title. Null would be default.

    String style

    The current item style name. Null would be default.

    Returns
    Type Description
    NaviItem

    The created item, or null upon failure.

    API Level: preview
    View Source

    InsertBefore(NaviItem, EvasObject)

    Inserts a new item into the naviframe before the item. The title is "" and the style is null.

    Declaration
    public NaviItem InsertBefore(NaviItem before, EvasObject content)
    Parameters
    Type Name Description
    NaviItem before

    The item for which a new item is inserted before.

    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    Returns
    Type Description
    NaviItem

    The created item, or null upon failure.

    API Level: preview
    View Source

    InsertBefore(NaviItem, EvasObject, String)

    Inserts a new item into the naviframe before the item. The style is null.

    Declaration
    public NaviItem InsertBefore(NaviItem before, EvasObject content, string title)
    Parameters
    Type Name Description
    NaviItem before

    The item for which a new item is inserted before.

    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    String title

    The current item title. Null would be default.

    Returns
    Type Description
    NaviItem

    The created item, or null upon failure.

    API Level: preview
    View Source

    InsertBefore(NaviItem, EvasObject, String, String)

    Inserts a new item into the naviframe before the item.

    Declaration
    public NaviItem InsertBefore(NaviItem before, EvasObject content, string title, string style)
    Parameters
    Type Name Description
    NaviItem before

    The item for which a new item is inserted before.

    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    String title

    The current item title. Null would be default.

    String style

    The current item style name. Null would be default.

    Returns
    Type Description
    NaviItem

    The created item, or null upon failure.

    API Level: preview
    View Source

    Pop()

    Pops an item that is on top of the stack.

    Declaration
    public void Pop()
    API Level: preview
    View Source

    Push(EvasObject)

    Pushes a new item to the top of the naviframe stack and shows it. The title and style are null.

    Declaration
    public NaviItem Push(EvasObject content)
    Parameters
    Type Name Description
    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    Returns
    Type Description
    NaviItem

    The created item, or null upon failure.

    API Level: preview
    View Source

    Push(EvasObject, String)

    Pushes a new item to the top of the naviframe stack and shows it. The style is null.

    Declaration
    public NaviItem Push(EvasObject content, string title)
    Parameters
    Type Name Description
    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    String title

    The current item title. Null would be default.

    Returns
    Type Description
    NaviItem
    API Level: preview
    View Source

    Push(EvasObject, String, String)

    Pushes a new item to the top of the naviframe stack and shows it.

    Declaration
    public NaviItem Push(EvasObject content, string title, string style)
    Parameters
    Type Name Description
    EvasObject content

    The main content object. The name of the content part is "elm.swallow.content".

    String title

    The current item title. Null would be default.

    String style

    The current item style name. Null would be default.

    Returns
    Type Description
    NaviItem

    The created item, or null upon failure.

    API Level: preview

    Events

    View Source

    AnimationFinished

    AnimationFinished will be triggered when the animation is finished.

    Declaration
    public event EventHandler AnimationFinished
    Event Type
    Type Description
    EventHandler
    API Level: preview
    View Source

    Popped

    Popped will be triggered when the NaviItem is removed.

    Declaration
    public event EventHandler<NaviframeEventArgs> Popped
    Event Type
    Type Description
    EventHandler<NaviframeEventArgs>
    Remarks

    It is always called when the NaviItem is removed. (even if removed by NaviItem.Delete()) This event will be invoked in progress of the Pop/Delete operation. After calling the Popped event, the Pop/Delete method will be returned.

    API Level: preview

    Implements

    IAccessibleObject

    Extension Methods

    RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)
    RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)
    RotaryEventExtensions.Activate(EvasObject)
    RotaryEventExtensions.Deactivate(EvasObject)
    • View Source
    Back to top Copyright © 2016-2020 Samsung
    Generated by DocFX