s&box docs
API ReferenceSandbox.UI

Stylesclass

Represents all supported CSS properties and their currently assigned values.

object→BaseStyles→Styles
Namespace
Sandbox.UI
Assembly
Sandbox.Engine
Declaration
public class Sandbox.UI.Styles : Sandbox.UI.BaseStyles

Constructors1

Showing 1 constructors

public Styles()PUBLICCONSTRUCTOR

Methods14

Showing 14 methods

public virtual void Add(Sandbox.UI.BaseStyles bs)PUBLICVIRTUAL

ParameterTypeDescription
bsBaseStyles—
Returns:void—

public bool ApplyAnimation(Sandbox.UI.Panel panel)PUBLIC

ParameterTypeDescription
panelPanel—
Returns:bool—

public void ApplyScale(float scale)PUBLIC

ParameterTypeDescription
scalefloat—
Returns:void—

public Matrix BuildTransformMatrix(Vector2 size)PUBLIC

Creates a matrix based on this style's "transform" and other related properties

ParameterTypeDescription
sizeVector2—
Returns:Matrix—

public virtual void Dirty()PUBLICVIRTUAL

Returns:void—

public virtual void From(Sandbox.UI.BaseStyles bs)PUBLICVIRTUAL

ParameterTypeDescription
bsBaseStyles—
Returns:void—

public virtual void LerpProperty(string name, Sandbox.UI.BaseStyles from, Sandbox.UI.BaseStyles to, float delta)PUBLICVIRTUAL

ParameterTypeDescription
namestring—
fromBaseStyles—
toBaseStyles—
deltafloat—
Returns:void—

public void ResetAnimation()PUBLIC

Stops the animation. If we have animation vars we'll start again.

Returns:void—

public void StartAnimation(string name, float duration, int iterations = 1, float delay = 0, string timing = linear, string direction = normal, string fillmode = none)PUBLIC

Stop any previous animations and start this one. Make it last this long.

ParameterTypeDescription
namestring—
durationfloat—
iterations = 1int—
delay = 0float—
timing = linearstring—
direction = normalstring—
fillmode = nonestring—
Returns:void—

Properties7

Showing 7 properties

public System.Nullable`1<Color> Sandbox.UI.Styles.BorderColor { get; set; }PUBLICGETSET

Returns:Nullable<Color>—

public System.Nullable`1<Sandbox.UI.Length> Sandbox.UI.Styles.BorderWidth { get; set; }PUBLICGETSET

Returns:Nullable<Length>—

public bool Sandbox.UI.Styles.HasBorder { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.UI.Styles.HasTransitions { get; set; }PUBLICGETSET

Whether this style sheet has any transitions that would need to be run.

Returns:bool—

public bool Sandbox.UI.Styles.IsAnimationActive { get; set; }PUBLICGETSET

True while an animation is set and still running. Becomes false once a finite animation has finished, so the panel can stop re-laying-out every frame for the rest of its life.

Returns:bool—

public System.Nullable`1<Sandbox.UI.Length> Sandbox.UI.Styles.Padding { get; set; }PUBLICGETSET

Returns:Nullable<Length>—

Related Guides

→Style Properties→VirtualGrid

TestBroadphase()

Previous Page

BorderColor

Next Page

On this page

Constructorspublic Styles()Methodspublic virtual System.Void Add(Sandbox.UI.BaseStyles bs)public System.Boolean ApplyAnimation(Sandbox.UI.Panel panel)public System.Void ApplyScale(System.Single scale)public Matrix BuildTransformMatrix(Vector2 size)public virtual System.Void Dirty()public virtual System.Void From(Sandbox.UI.BaseStyles bs)public virtual System.Void FromLerp(Sandbox.UI.BaseStyles from, Sandbox.UI.BaseStyles to, System.Single delta)public Sandbox.UI.Margin GetInset(Vector2 size)public Sandbox.UI.Margin GetOutset(Vector2 size)public virtual System.Void LerpProperty(System.String name, Sandbox.UI.BaseStyles from, Sandbox.UI.BaseStyles to, System.Single delta)public System.Void ResetAnimation()public virtual System.Boolean Set(System.String property, System.String value)public System.Boolean Set(System.String styles)public System.Void StartAnimation(System.String name, System.Single duration, System.Int32 iterations = 1, System.Single delay = 0, System.String timing = linear, System.String direction = normal, System.String fillmode = none)Propertiespublic System.Nullable`1<Color> Sandbox.UI.Styles.BorderColor { get; set; }public System.Nullable`1<Sandbox.UI.Length> Sandbox.UI.Styles.BorderWidth { get; set; }public System.Boolean Sandbox.UI.Styles.HasBorder { get; set; }public System.Boolean Sandbox.UI.Styles.HasTransitions { get; set; }public System.Boolean Sandbox.UI.Styles.IsAnimationActive { get; set; }public System.Nullable`1<Sandbox.UI.Length> Sandbox.UI.Styles.Margin { get; set; }public System.Nullable`1<Sandbox.UI.Length> Sandbox.UI.Styles.Padding { get; set; }Metadata