Class Popup

Definition

Namespace:
Tizen.NUI.UIComponents
Assembly:
Tizen.NUI.dll
API Level:
3

The Popup widget provides a configurable popup dialog with a built-in layout of three main fields.

C#
Copy
public class Popup : View, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider
Inheritance
Tizen.NUI.Binding.BindableObject
Tizen.NUI.Binding.Element
Popup
Implements
System.IDisposable

Constructors

View Source

Popup()

Creates the popup.

Declaration
C#
Copy
public Popup()
API Level: 3

Properties

View Source

AnimationDuration

The animation duration.

Declaration
C#
Copy
public float AnimationDuration { get; set; }
Property Value
Type Description
Single
API Level: 3
View Source

AnimationMode

The animation mode.

Declaration
C#
Copy
public Popup.AnimationModeType AnimationMode { get; set; }
Property Value
Type Description
Popup.AnimationModeType
API Level: 3
View Source

AutoHideDelay

The auto hide delay.

Declaration
C#
Copy
public int AutoHideDelay { get; set; }
Property Value
Type Description
System.Int32
API Level: 3
View Source

BackingColor

The backing color.

Declaration
C#
Copy
public Vector4 BackingColor { get; set; }
Property Value
Type Description
Vector4
API Level: 3
View Source

BackingEnabled

The backing enabled.

Declaration
C#
Copy
public bool BackingEnabled { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

Content

The popup content.

Declaration
C#
Copy
public PropertyMap Content { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

ContextualMode

The contextual mode.

Declaration
C#
Copy
public Popup.ContextualModeType ContextualMode { get; set; }
Property Value
Type Description
Popup.ContextualModeType
API Level: 3
View Source

DisplayState

The popup display state.

Declaration
C#
Copy
public Popup.DisplayStateType DisplayState { get; set; }
Property Value
Type Description
Popup.DisplayStateType
API Level: 3
View Source

EntryAnimation

The entry animation.

Declaration
C#
Copy
public PropertyMap EntryAnimation { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

ExitAnimation

The exit animation.

Declaration
C#
Copy
public PropertyMap ExitAnimation { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

The popup footer.

Declaration
C#
Copy
public PropertyMap Footer { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

PopupBackgroundBorder

The background border.

Declaration
C#
Copy
public Rectangle PopupBackgroundBorder { get; set; }
Property Value
Type Description
Rectangle
API Level: 3
View Source

PopupBackgroundImage

The background image.

Declaration
C#
Copy
public string PopupBackgroundImage { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

TailDownImage

The tail down image.

Declaration
C#
Copy
public string TailDownImage { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

TailLeftImage

The tail left image.

Declaration
C#
Copy
public string TailLeftImage { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

TailPosition

The popup tail position.

Declaration
C#
Copy
public Vector3 TailPosition { get; set; }
Property Value
Type Description
Vector3
API Level: 3
View Source

TailRightImage

The tail right image.

Declaration
C#
Copy
public string TailRightImage { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

TailUpImage

The tail up image.

Declaration
C#
Copy
public string TailUpImage { get; set; }
Property Value
Type Description
System.String
API Level: 3
View Source

TailVisibility

The popup tail visibility.

Declaration
C#
Copy
public bool TailVisibility { get; set; }
Property Value
Type Description
Boolean
API Level: 3
View Source

Title

The popup title.

Declaration
C#
Copy
public PropertyMap Title { get; set; }
Property Value
Type Description
PropertyMap
API Level: 3
View Source

TouchTransparent

The touch transparent.

Declaration
C#
Copy
public bool TouchTransparent { get; set; }
Property Value
Type Description
Boolean
API Level: 3

Methods

View Source

Dispose(DisposeTypes)

Dispose.

Declaration
C#
Copy
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

The dispose type

Overrides
API Level: 3
View Source

SetContent(View)

Sets the content actor.

Declaration
C#
Copy
public void SetContent(View content)
Parameters
Type Name Description
View content

The actor to use.

API Level: 3
View Source

SetDisplayState(Popup.DisplayStateType)

Sets the display state of popup.
There are 4 total display states.
Only 2 can be set, but all four can be read for better inspection of the current popup state.

The other two states are getable, but not setable, and are there for consistency.

| Value | Setting the state | Getting the state |
|----------|--------------------------------|--------------------------------|
| SHOWN | Show the popup | The popup is fully shown |
| HIDDEN | Hide the popup | The popup is fully hidden |
| SHOWING | | The popup is transitioning in |
| HIDING | | The popup is transitioning out |

All 4 states changes cause notifications via 4 respective signals that can be connected to.

Declaration
C#
Copy
public void SetDisplayState(Popup.DisplayStateType displayState)
Parameters
Type Name Description
Popup.DisplayStateType displayState

The desired display state to change to.

API Level: 3
View Source

SetFooter(View)

Sets the actor to use for the footer in this popup.

Declaration
C#
Copy
public void SetFooter(View footer)
Parameters
Type Name Description
View footer

The footer actor to be added to this popup.

API Level: 3
View Source

SetTitle(View)

Sets the title for this popup.

Declaration
C#
Copy
public void SetTitle(View titleView)
Parameters
Type Name Description
View titleView

The actor to set the title.

API Level: 3

Events

View Source

Hidden

An event is sent when the popup has been completely hidden.

Declaration
C#
Copy
public event EventHandler<Popup.HiddenEventArgs> Hidden
Event Type
Type Description
System.EventHandler<Popup.HiddenEventArgs>
API Level: 3
View Source

Hiding

An event is sent when the popup starts to hide.

Declaration
C#
Copy
public event EventHandler<Popup.HidingEventArgs> Hiding
Event Type
Type Description
System.EventHandler<Popup.HidingEventArgs>
API Level: 3
View Source

Showing

An event is sent when the popup starts showing.

Declaration
C#
Copy
public event EventHandler<Popup.ShowingEventArgs> Showing
Event Type
Type Description
System.EventHandler<Popup.ShowingEventArgs>
API Level: 3
View Source

Shown

An event is sent when the popup has been fully displayed.

Declaration
C#
Copy
public event EventHandler<Popup.ShownEventArgs> Shown
Event Type
Type Description
System.EventHandler<Popup.ShownEventArgs>
API Level: 3
View Source

TouchedOutside

An event is sent when the user has touched outside the dialog.

Declaration
C#
Copy
public event EventHandler<Popup.TouchedOutsideEventArgs> TouchedOutside
Event Type
Type Description
System.EventHandler<Popup.TouchedOutsideEventArgs>
API Level: 3

Implements

System.IDisposable