Class Panes

Definition

Namespace:

ElmSharp

Assembly:

ElmSharp.dll

API Level:

preview

The Panes is a widget that adds a draggable bar between two contents. When dragged, this bar resizes the contents' size.

public class Panes : Layout, IAccessibleObject

Inheritance

Object

EvasObject

AccessibleObject

Widget

Container

Layout

Panes

Implements

IAccessibleObject

Constructors

Panes(EvasObject)

Creates and initializes a new instance of the Panes class.

Declaration

public Panes(EvasObject parent)

Parameters

Type	Name	Description
EvasObject	parent	The EvasObject to which the new Panes will be attached as a child.

API Level: preview

Properties

IsFixed

Sets or gets the resize mode of a given Panes widget. True means the left and right panes resize homogeneously.

Declaration

public bool IsFixed { get; set; }

Property Value

Type	Description
Boolean

API Level: preview

IsHorizontal

Sets or gets the orientation of a given Panes widget.

Declaration

public bool IsHorizontal { get; set; }

Property Value

Type	Description
Boolean

Remarks

Use this function to change how your panes are to be disposed: vertically or horizontally. Horizontal panes have "top" and "bottom" contents, vertical panes have "left" and "right" contents. By default, the panes are in a vertical mode.

API Level: preview

LeftMinimumRelativeSize

Sets or gets the relative minimum size of the panes widget's left side. The proportion of minimum size of the left side. If displayed vertically, left content is displayed at the top. The value between 0.0 and 1.0 represents size proportion of the minimum size of the left side.

Declaration

public double LeftMinimumRelativeSize { get; set; }

Property Value

Type	Description
Double

API Level: preview

LeftMinimumSize

Sets or gets the absolute minimum size of panes widget's left side. If displayed vertically, left content is displayed at the top. The value represents minimum size of the left side in pixels.

Declaration

public int LeftMinimumSize { get; set; }

Property Value

Type	Description
Int32

API Level: preview

Proportion

Sets or gets the size proportion of the Panes widget's left side.

Declaration

public double Proportion { get; set; }

Property Value

Type	Description
Double

Remarks

By default, it's homogeneous, i.e., both sides have the same size. If something different is required, it can be set with this function. For example, if the left content should be displayed over 75% of the panes size, the size should be passed as 0.75. This way, the right content is resized to 25% of the panes size. If displayed vertically, left content is displayed at the top and right content at the bottom. This proportion changes when the user drags the panes bar.

The float type value between 0.0 and 1.0 represents the size proportion of the left side.

API Level: preview

RightMinimumRelativeSize

Sets or gets the relative minimum size of the panes widget's right side. Proportion of the minimum size of the right side. If displayed vertically, right content is displayed at the top. The value between 0.0 and 1.0 represents size proportion of the minimum size of the right side.

Declaration

public double RightMinimumRelativeSize { get; set; }

Property Value

Type	Description
Double

API Level: preview

RightMinimumSize

Sets or gets the absolute minimum size of the panes widget's right side. If displayed vertically, right content is displayed at the top. The value represents the minimum size of the right side in pixels.

Declaration

public int RightMinimumSize { get; set; }

Property Value

Type	Description
Int32

API Level: preview

Methods

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

Layout.CreateHandle(EvasObject)

API Level: preview

Events

Pressed

Pressed will be triggered when the panes have been pressed (button isn't released yet).

Declaration

public event EventHandler Pressed

Event Type

Type	Description
EventHandler

API Level: preview

Unpressed

Unpressed will be triggered when the panes are released after being pressed.

Declaration

public event EventHandler Unpressed

Event Type

Type	Description
EventHandler

API Level: preview

Implements

IAccessibleObject

Extension Methods

RotaryEventExtensions.AddRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.RemoveRotaryEventHandler(EvasObject, RotaryEventHandler)

RotaryEventExtensions.Activate(EvasObject)

RotaryEventExtensions.Deactivate(EvasObject)