Class ContextPopup
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
- API Level:
- preview
It inherits Layout. The ContextPopup is a widget that when shown, pops up a list of items.
public class ContextPopup : Layout, IAccessibleObject
- Inheritance
- Implements
Constructors
View SourceContextPopup(EvasObject)
Creates and initializes a new instance of the ContextPopup class.
Declaration
public ContextPopup(EvasObject parent)
Parameters
Type | Name | Description |
---|---|---|
EvasObject | parent | The parent is a given container, which will be attached by ContextPopup as a child. It's EvasObject type. |
API Level: preview
Properties
View SourceAutoHide
Gets or sets whether the ContextPopup hides automatically or not when the parent of the ContextPopup is resized.
Declaration
public bool AutoHide { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
Remarks
Default value of AutoHide is False.
API Level: preview
View SourceDirection
Gets the current direction of a ContextPopup.
Declaration
public ContextPopupDirection Direction { get; }
Property Value
Type | Description |
---|---|
ContextPopupDirection |
Remarks
Once the ContextPopup shows up, the direction would be determined.
API Level: preview
View SourceIsHorizontal
Gets or sets the value of the current ContextPopup object's orientation. True for horizontal mode, False for vertical mode (or errors).
Declaration
public bool IsHorizontal { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Level: preview
View SourceOpacity
Gets the Alpha of a default Color class.
Declaration
public override int Opacity { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Overrides
API Level: preview
Methods
View SourceAppend(String)
Adds a new item to a ContextPopup object with the label.
Declaration
public ContextPopupItem Append(string label)
Parameters
Type | Name | Description |
---|---|---|
String | label | Label of the new item. |
Returns
Type | Description |
---|---|
ContextPopupItem | A ContextPopupItem added, or null on errors. |
API Level: preview
View SourceAppend(String, EvasObject)
Adds a new item to a ContextPopup object with the label and icon.
Declaration
public ContextPopupItem Append(string label, EvasObject icon)
Parameters
Type | Name | Description |
---|---|---|
String | label | Label of the new item. |
EvasObject | icon | Icon to be set on the new item. |
Returns
Type | Description |
---|---|
ContextPopupItem | A ContextPopupItem added, or null on errors. |
API Level: preview
View SourceClear()
Clears all the items in a given ContextPopup object.
Declaration
public void Clear()
API Level: preview
View SourceCreateHandle(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
API Level: preview
View SourceDismiss()
Dismisses a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted.
Declaration
public void Dismiss()
API Level: preview
View SourceGetDirectionPriority(out ContextPopupDirection, out ContextPopupDirection, out ContextPopupDirection, out ContextPopupDirection)
Gets the direction priority of a ContextPopup.
Declaration
public void GetDirectionPriority(out ContextPopupDirection first, out ContextPopupDirection second, out ContextPopupDirection third, out ContextPopupDirection fourth)
Parameters
Type | Name | Description |
---|---|---|
ContextPopupDirection | first | 1st priority of the direction to be returned. |
ContextPopupDirection | second | 2nd priority of the direction to be returned. |
ContextPopupDirection | third | 2nd priority of the direction to be returned. |
ContextPopupDirection | fourth | 4th priority of the direction to be returned. |
API Level: preview
View SourceIsAvailableDirection(ContextPopupDirection)
Gets the possibility that the direction would be available.
Declaration
public bool IsAvailableDirection(ContextPopupDirection direction)
Parameters
Type | Name | Description |
---|---|---|
ContextPopupDirection | direction | A direction that the user wants to check. |
Returns
Type | Description |
---|---|
Boolean | Get false if you cannot put it in the direction. Get true if it's possible. |
API Level: preview
View SourceSetDirectionPriorty(ContextPopupDirection, ContextPopupDirection, ContextPopupDirection, ContextPopupDirection)
Sets the direction priority of a ContextPopup.
Declaration
public void SetDirectionPriorty(ContextPopupDirection first, ContextPopupDirection second, ContextPopupDirection third, ContextPopupDirection fourth)
Parameters
Type | Name | Description |
---|---|---|
ContextPopupDirection | first | 1st priority of the direction. |
ContextPopupDirection | second | 2nd priority of the direction. |
ContextPopupDirection | third | 3th priority of the direction. |
ContextPopupDirection | fourth | 4th priority of the direction. |
API Level: preview
Events
View SourceDismissed
Dismissed is raised when the ContextPopup item is dismissed.
Declaration
public event EventHandler Dismissed
Event Type
Type | Description |
---|---|
EventHandler |
Remarks
Outside of ContextPopup is clicked or it's parent area is changed or the language is changed, and then ContextPopup is dismissed.