Class Decoration

Namespace

BSGameLib.UI.Builder.Models

Assembly

BSGameLib.UI.dll

A decoration: a visual mark pinned to a corner or edge of the view, outside the layout.

public class Decoration

Inheritance

object

Decoration

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Anchor

The corner or edge of the view the decoration is pinned to. TopLeft by default.

public DecorationAnchor Anchor { get; set; }

Property Value

DecorationAnchor

BorderColor

A flat border color, drawn inside BorderThickness.

public string BorderColor { get; set; }

Property Value

string

BorderThickness

The border's width in pixels. Has no effect unless BorderColor is set. One by default.

[Range(0, 2147483647)]
public int BorderThickness { get; set; }

Property Value

int

FillColor

A flat fill color.

public string FillColor { get; set; }

Property Value

string

FillGradient

A gradient fill, naming a Gradient resource. Drawn in place of FillColor when both are set.

public string FillGradient { get; set; }

Property Value

string

Layer

Whether the decoration is painted behind the controls (the default) or over them.

[EnumDataType(typeof(DecorationLayer))]
public DecorationLayer Layer { get; set; }

Property Value

DecorationLayer

Offset

The distance in pixels inward from Anchor, measured the same way on every anchor. Written through OffsetValue.

public Point Offset { get; set; }

Property Value

Point

OffsetValue

The Offset attribute's text, as {x,y}. Use Offset in code.

public string OffsetValue { get; set; }

Property Value

string

Size

The decoration's size in pixels. Needed unless Stretch is set.

public Size Size { get; set; }

Property Value

Size

SizeValue

The Size attribute's text form. See Size.

public string SizeValue { get; set; }

Property Value

string

Stretch

Whether the decoration covers the whole view, ignoring Anchor, Offset and Size.

public bool Stretch { get; set; }

Property Value

bool

Texture

A texture drawn over the decoration's bounds, for a flourish made of art rather than flat shapes.

public TextureReference Texture { get; set; }

Property Value

TextureReference

TextureColor

The tint applied to Texture, when one is set. No tint by default.

public string TextureColor { get; set; }

Property Value

string