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.
C#Copypublic class ContextPopup : Layout, IAccessibleObject
- Inheritance
- Implements
Constructors
ContextPopup(EvasObject)
Creates and initializes a new instance of the ContextPopup class.
Declaration
C#Copypublic 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
AutoHide
Gets or sets whether the ContextPopup hides automatically or not when the parent of the ContextPopup is resized.
Declaration
C#Copypublic bool AutoHide { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
Default value of AutoHide is False.
API Level: preview
Declaration
C#Copypublic ContextPopupDirection Direction { get; }
Property Value
| Type | Description |
|---|---|
| ContextPopupDirection |
Remarks
Once the ContextPopup shows up, the direction would be determined.
API Level: preview
IsHorizontal
Gets or sets the value of the current ContextPopup object's orientation. True for horizontal mode, False for vertical mode (or errors).
Declaration
C#Copypublic bool IsHorizontal { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Boolean |
API Level: preview
Declaration
C#Copypublic override int Opacity { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Int32 |
Overrides
API Level: preview
Methods
Declaration
C#Copypublic ContextPopupItem Append(string label)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | label | Label of the new item. |
Returns
| Type | Description |
|---|---|
| ContextPopupItem | A ContextPopupItem added, or null on errors. |
API Level: preview
Append(String, EvasObject)
Adds a new item to a ContextPopup object with the label and icon.
Declaration
C#Copypublic ContextPopupItem Append(string label, EvasObject icon)
Parameters
| Type | Name | Description |
|---|---|---|
| System.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
Declaration
C#Copypublic void Clear()
API Level: preview
Declaration
C#Copyprotected override IntPtr CreateHandle(EvasObject parent)
Parameters
| Type | Name | Description |
|---|---|---|
| EvasObject | parent | Parent EvasObject. |
Returns
| Type | Description |
|---|---|
| System.IntPtr | Handle IntPtr. |
Overrides
API Level: preview
Dismiss()
Dismisses a ContextPopup object. The ContextPopup will be hidden and the "clicked" signal will be emitted.
Declaration
C#Copypublic void Dismiss()
API Level: preview
GetDirectionPriority(out ContextPopupDirection, out ContextPopupDirection, out ContextPopupDirection, out ContextPopupDirection)
Gets the direction priority of a ContextPopup.
Declaration
C#Copypublic 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
IsAvailableDirection(ContextPopupDirection)
Gets the possibility that the direction would be available.
Declaration
C#Copypublic bool IsAvailableDirection(ContextPopupDirection direction)
Parameters
| Type | Name | Description |
|---|---|---|
| ContextPopupDirection | direction | A direction that the user wants to check. |
Returns
| Type | Description |
|---|---|
| System.Boolean | Get false if you cannot put it in the direction. Get true if it's possible. |
API Level: preview
SetDirectionPriorty(ContextPopupDirection, ContextPopupDirection, ContextPopupDirection, ContextPopupDirection)
Sets the direction priority of a ContextPopup.
Declaration
C#Copypublic 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
Declaration
C#Copypublic event EventHandler Dismissed
Event Type
| Type | Description |
|---|---|
| System.EventHandler |
Remarks
Outside of ContextPopup is clicked or it's parent area is changed or the language is changed, and then ContextPopup is dismissed.