Class Background

Definition

Namespace:
ElmSharp
Assembly:
ElmSharp.dll
API Level:
preview

The Background is a widget that use for setting (solid) background decorations to a window (unless it has transparency enabled) or to any container object.

public class Background : Layout, IAccessibleObject
Inheritance
Object
EvasObject
AccessibleObject
Widget
Container
Layout
Background
Implements
IAccessibleObject

Constructors

View Source

Background(EvasObject)

Creates and initializes a new instance of the Background class.

Declaration
public Background(EvasObject parent)
Parameters
Type Name Description
EvasObject parent

The EvasObject to which the new background will be attached as a child.
API Level: preview

Properties

View Source

BackgroundOption

Sets or gets the mode of display for a given background widget's image.

Declaration
public BackgroundOptions BackgroundOption { get; set; }
Property Value
Type Description
BackgroundOptions
Remarks

This sets how the background widget will display its image. This will only work if the file was previously set with an image file on object. The image can be display tiled, scaled, centered, or stretched. Scaled by default.

API Level: preview
View Source

Color

Sets or gets the color to the background.

Declaration
public override Color Color { get; set; }
Property Value
Type Description
Color
Overrides
API Level: preview
View Source

File

Sets or gets the image to the background.

Declaration
public string File { get; set; }
Property Value
Type Description
String
API Level: preview

Methods

View Source

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
API Level: preview
View Source

SetFileLoadSize(Int32, Int32)

Sets the size of the pixmap representation of the image set on a given background widget. This method just makes sense if an image file was set. This is just a hint for the underlying system. The real size of the pixmap may differ depending on the type of image being loaded, being bigger than requested.

Declaration
public void SetFileLoadSize(int w, int h)
Parameters
Type Name Description
Int32 w

The new width of the image pixmap representation.
Int32 h

The new height of the image pixmap representation.
API Level: preview

Implements

Extension Methods