Class Popup

Definition

Namespace:

Tizen.NUI.UIComponents

Assembly:

Tizen.NUI.dll

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

public class Popup : View, IDisposable

Inheritance

object

BaseHandle

Animatable

Container

View

Popup

Implements

System.IDisposable

Constructors

Popup()

Creates the popup.

Declaration

public Popup()

Properties

AnimationDuration

The animation duration.

Declaration

public float AnimationDuration { get; set; }

Property Value

Type	Description
float

AnimationMode

The animation mode.

Declaration

public Popup.AnimationModeType AnimationMode { get; set; }

Property Value

Type	Description
Popup.AnimationModeType

AutoHideDelay

The auto hide delay.

Declaration

public int AutoHideDelay { get; set; }

Property Value

Type	Description
int

BackingColor

The backing color.

Declaration

public Vector4 BackingColor { get; set; }

Property Value

Type	Description
Vector4

BackingEnabled

The backing enabled.

Declaration

public bool BackingEnabled { get; set; }

Property Value

Type	Description
bool

Content

The popup content.

Declaration

public PropertyMap Content { get; set; }

Property Value

Type	Description
PropertyMap

ContextualMode

The contextual mode.

Declaration

public Popup.ContextualModeType ContextualMode { get; set; }

Property Value

Type	Description
Popup.ContextualModeType

DisplayState

The popup display state.

Declaration

public Popup.DisplayStateType DisplayState { get; set; }

Property Value

Type	Description
Popup.DisplayStateType

EntryAnimation

The entry animation.

Declaration

public PropertyMap EntryAnimation { get; set; }

Property Value

Type	Description
PropertyMap

ExitAnimation

The exit animation.

Declaration

public PropertyMap ExitAnimation { get; set; }

Property Value

Type	Description
PropertyMap

Footer

The popup footer.

Declaration

public PropertyMap Footer { get; set; }

Property Value

Type	Description
PropertyMap

PopupBackgroundBorder

The background border.

Declaration

public Rectangle PopupBackgroundBorder { get; set; }

Property Value

Type	Description
Rectangle

PopupBackgroundImage

The background image.

Declaration

public string PopupBackgroundImage { get; set; }

Property Value

Type	Description
string

TailDownImage

The tail down image.

Declaration

public string TailDownImage { get; set; }

Property Value

Type	Description
string

TailLeftImage

The tail left image.

Declaration

public string TailLeftImage { get; set; }

Property Value

Type	Description
string

TailPosition

The popup tail position.

Declaration

public Vector3 TailPosition { get; set; }

Property Value

Type	Description
Vector3

TailRightImage

The tail right image.

Declaration

public string TailRightImage { get; set; }

Property Value

Type	Description
string

TailUpImage

The tail up image.

Declaration

public string TailUpImage { get; set; }

Property Value

Type	Description
string

TailVisibility

The popup tail visibility.

Declaration

public bool TailVisibility { get; set; }

Property Value

Type	Description
bool

Title

The popup title.

Declaration

public PropertyMap Title { get; set; }

Property Value

Type	Description
PropertyMap

TouchTransparent

The touch transparent.

Declaration

public bool TouchTransparent { get; set; }

Property Value

Type	Description
bool

Methods

Dispose(DisposeTypes)

Dispose.

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type	The dispose type

Overrides

View.Dispose(DisposeTypes)

SetContent(View)

Sets the content actor.

Declaration

public void SetContent(View content)

Parameters

Type	Name	Description
View	content	The actor to use.

SetDisplayState(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

public void SetDisplayState(Popup.DisplayStateType displayState)

Parameters

Type	Name	Description
Popup.DisplayStateType	displayState	The desired display state to change to.

SetFooter(View)

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

Declaration

public void SetFooter(View footer)

Parameters

Type	Name	Description
View	footer	The footer actor to be added to this popup.

SetTitle(View)

Sets the title for this popup.

Declaration

public void SetTitle(View titleView)

Parameters

Type	Name	Description
View	titleView	The actor to set the title.

Events

Hidden

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

Declaration

public event EventHandler<Popup.HiddenEventArgs> Hidden

Event Type

Type	Description
System.EventHandler<TEventArgs><Popup.HiddenEventArgs>

Hiding

An event is sent when the popup starts to hide.

Declaration

public event EventHandler<Popup.HidingEventArgs> Hiding

Event Type

Type	Description
System.EventHandler<TEventArgs><Popup.HidingEventArgs>

Showing

An event is sent when the popup starts showing.

Declaration

public event EventHandler<Popup.ShowingEventArgs> Showing

Event Type

Type	Description
System.EventHandler<TEventArgs><Popup.ShowingEventArgs>

Shown

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

Declaration

public event EventHandler<Popup.ShownEventArgs> Shown

Event Type

Type	Description
System.EventHandler<TEventArgs><Popup.ShownEventArgs>

TouchedOutside

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

Declaration

public event EventHandler<Popup.TouchedOutsideEventArgs> TouchedOutside

Event Type

Type	Description
System.EventHandler<TEventArgs><Popup.TouchedOutsideEventArgs>

Implements

System.IDisposable