Api Sandbox UI BaseStyles
class

BaseStyles

public abstract class BaseStyles

Auto generated container class for majority of CSS properties available.

Properties

Name Type Description
Overflow OverflowMode? Represents the overflow CSS property.
Content String Represents the content CSS property.
Width Length? Represents the width CSS property.
MinWidth Length? Represents the min-width CSS property.
MaxWidth Length? Represents the max-width CSS property.
Height Length? Represents the height CSS property.
MinHeight Length? Represents the min-height CSS property.
MaxHeight Length? Represents the max-height CSS property.
Left Length? Represents the left CSS property.
Top Length? Represents the top CSS property.
Right Length? Represents the right CSS property.
Bottom Length? Represents the bottom CSS property.
Opacity Single? Represents the opacity CSS property.
BackgroundColor Color? Represents the background-color CSS property.
PaddingLeft Length? Represents the padding-left CSS property.
PaddingTop Length? Represents the padding-top CSS property.
PaddingRight Length? Represents the padding-right CSS property.
PaddingBottom Length? Represents the padding-bottom CSS property.
MarginLeft Length? Represents the margin-left CSS property.
MarginTop Length? Represents the margin-top CSS property.
MarginRight Length? Represents the margin-right CSS property.
MarginBottom Length? Represents the margin-bottom CSS property.
BorderTopLeftRadius Length? Represents the border-top-left-radius CSS property.
BorderTopRightRadius Length? Represents the border-top-right-radius CSS property.
BorderBottomRightRadius Length? Represents the border-bottom-right-radius CSS property.
BorderBottomLeftRadius Length? Represents the border-bottom-left-radius CSS property.
BorderLeftWidth Length? Represents the border-left-width CSS property.
BorderTopWidth Length? Represents the border-top-width CSS property.
BorderRightWidth Length? Represents the border-right-width CSS property.
BorderBottomWidth Length? Represents the border-bottom-width CSS property.
BorderLeftColor Color? Represents the border-left-color CSS property.
BorderTopColor Color? Represents the border-top-color CSS property.
BorderRightColor Color? Represents the border-right-color CSS property.
BorderBottomColor Color? Represents the border-bottom-color CSS property.
FontSize Length? Represents the font-size CSS property.
FontColor Color? Represents the font-color CSS property.
FontWeight Int32? Represents the font-weight CSS property.
FontFamily String Represents the font-family CSS property.
CaretColor Color? Represents the caret-color CSS property.
Cursor String Represents the cursor CSS property.
PointerEvents PointerEvents? Represents the pointer-events CSS property.
MixBlendMode String Represents the mix-blend-mode CSS property.
Position PositionMode? Represents the position CSS property.
OverflowX OverflowMode? Represents the overflow-x CSS property.
OverflowY OverflowMode? Represents the overflow-y CSS property.
FlexDirection FlexDirection? Represents the flex-direction CSS property.
JustifyContent Justify? Represents the justify-content CSS property.
Display DisplayMode? Represents the display CSS property.
FlexWrap Wrap? Represents the flex-wrap CSS property.
AlignContent Align? Represents the align-content CSS property.
AlignSelf Align? Represents the align-self CSS property.
AlignItems Align? Represents the align-items CSS property.
FlexBasis Length? Represents the flex-basis CSS property.
FlexGrow Single? Represents the flex-grow CSS property.
FlexShrink Single? Represents the flex-shrink CSS property.
RowGap Length? Represents the row-gap CSS property.
ColumnGap Length? Represents the column-gap CSS property.
AspectRatio Single? Represents the aspect-ratio CSS property.
TextAlign TextAlign? Represents the text-align CSS property.
TextOverflow TextOverflow? Represents the text-overflow CSS property.
TextFilter FilterMode? Represents the text-filter CSS property.
WordBreak WordBreak? Represents the word-break CSS property.
TextDecorationLine TextDecoration? Represents the text-decoration-line CSS property.
TextDecorationColor Color? Represents the text-decoration-color CSS property.
TextDecorationThickness Length? Represents the text-decoration-thickness CSS property.
TextDecorationSkipInk TextSkipInk? Represents the text-decoration-skip-ink CSS property.
TextDecorationStyle TextDecorationStyle? Represents the text-decoration-style CSS property.
TextUnderlineOffset Length? Represents the text-underline-offset CSS property.
TextOverlineOffset Length? Represents the text-overline-offset CSS property.
TextLineThroughOffset Length? Represents the text-line-through-offset CSS property.
FontStyle FontStyle? Represents the font-style CSS property.
FontVariantNumeric FontVariantNumeric? Represents the font-variant-numeric CSS property.
Transform PanelTransform? Represents the transform CSS property.
TextTransform TextTransform? Represents the text-transform CSS property.
TransformOriginX Length? Represents the transform-origin-x CSS property.
TransformOriginY Length? Represents the transform-origin-y CSS property.
LetterSpacing Length? Represents the letter-spacing CSS property.
LineHeight Length? Represents the line-height CSS property.
WordSpacing Length? Represents the word-spacing CSS property.
WhiteSpace WhiteSpace? Represents the white-space CSS property.
ZIndex Int32? Represents the z-index CSS property.
Order Int32? Represents the order CSS property.
SoundIn String Represents the sound-in CSS property.
SoundOut String Represents the sound-out CSS property.
BackdropFilterBlur Length? Represents the backdrop-filter-blur CSS property.
BackdropFilterBrightness Length? Represents the backdrop-filter-brightness CSS property.
BackdropFilterContrast Length? Represents the backdrop-filter-contrast CSS property.
BackdropFilterSaturate Length? Represents the backdrop-filter-saturate CSS property.
BackdropFilterSepia Length? Represents the backdrop-filter-sepia CSS property.
BackdropFilterInvert Length? Represents the backdrop-filter-invert CSS property.
BackdropFilterHueRotate Length? Represents the backdrop-filter-hue-rotate CSS property.
FilterBlur Length? Represents the filter-blur CSS property.
FilterSaturate Length? Represents the filter-saturate CSS property.
FilterSepia Length? Represents the filter-sepia CSS property.
FilterBrightness Length? Represents the filter-brightness CSS property.
FilterHueRotate Length? Represents the filter-hue-rotate CSS property.
FilterInvert Length? Represents the filter-invert CSS property.
FilterContrast Length? Represents the filter-contrast CSS property.
FilterTint Color? Represents the filter-tint CSS property.
FilterBorderWidth Length? Represents the filter-border-width CSS property.
FilterBorderColor Color? Represents the filter-border-color CSS property.
MaskMode MaskMode? Represents the mask-mode CSS property.
MaskRepeat BackgroundRepeat? Represents the mask-repeat CSS property.
MaskSizeX Length? Represents the mask-size-x CSS property.
MaskSizeY Length? Represents the mask-size-y CSS property.
MaskPositionX Length? Represents the mask-position-x CSS property.
MaskPositionY Length? Represents the mask-position-y CSS property.
MaskAngle Length? Represents the mask-angle CSS property.
MaskScope MaskScope? Represents the mask-scope CSS property.
BackgroundSizeX Length? Represents the background-size-x CSS property.
BackgroundSizeY Length? Represents the background-size-y CSS property.
BackgroundPositionX Length? Represents the background-position-x CSS property.
BackgroundPositionY Length? Represents the background-position-y CSS property.
BackgroundRepeat BackgroundRepeat? Represents the background-repeat CSS property.
BorderImageWidthLeft Length? Represents the border-image-width-left CSS property.
BorderImageWidthRight Length? Represents the border-image-width-right CSS property.
BorderImageWidthTop Length? Represents the border-image-width-top CSS property.
BorderImageWidthBottom Length? Represents the border-image-width-bottom CSS property.
BorderImageFill BorderImageFill? Represents the border-image-fill CSS property.
BorderImageRepeat BorderImageRepeat? Represents the border-image-repeat CSS property.
BorderImageTint Color? Represents the border-image-tint CSS property.
BackgroundBlendMode String Represents the background-blend-mode CSS property.
BackgroundTint Color? Represents the background-tint CSS property.
BackgroundAngle Length? Represents the background-angle CSS property.
TextBackgroundAngle Length? Represents the text-background-angle CSS property.
PerspectiveOriginX Length? Represents the perspective-origin-x CSS property.
PerspectiveOriginY Length? Represents the perspective-origin-y CSS property.
TextStrokeColor Color? Represents the text-stroke-color CSS property.
TextStrokeWidth Length? Represents the text-stroke-width CSS property.
ImageRendering ImageRendering? Represents the image-rendering CSS property.
AnimationDelay Single? Represents the animation-delay CSS property.
AnimationDirection String Represents the animation-direction CSS property.
AnimationDuration Single? Represents the animation-duration CSS property.
AnimationFillMode String Represents the animation-fill-mode CSS property.
AnimationIterationCount Single? Represents the animation-iteration-count CSS property.
AnimationName String Represents the animation-name CSS property.
AnimationPlayState String Represents the animation-play-state CSS property.
AnimationTimingFunction String Represents the animation-timing-function CSS property.
FontSmooth FontSmooth? Represents the font-smooth CSS property.
ObjectFit ObjectFit? Represents the object-fit CSS property.
OutlineWidth Length? Represents the outline-width CSS property.
OutlineColor Color? Represents the outline-color CSS property.
OutlineOffset Length? Represents the outline-offset CSS property.
BackgroundImage Texture
MaskImage Texture
BorderImageSource Texture
HasAnimation Boolean Whether there is an active CSS animation.

Methods

virtual Void Dirty()

Called when any CSS properties are changed.

virtual Void Add(BaseStyles bs)

Copy over only the styles that are set.

virtual Void From(BaseStyles bs)

Copy all styles from given style set.

virtual Boolean Set(String property, String value)

Copy all styles from given style set.

Void FillDefaults()
Void SetRect(Rect r, Single scale = 1)

Set Left, Right, Width and Height based on this rect. Scale can be used to scale the rect (maybe you want to use Panel.ScaleFromScreen etc)

virtual Void FromLerp(BaseStyles from, BaseStyles to, Single delta)

Lerp every property in this stylesheet

virtual Void LerpProperty(String name, BaseStyles from, BaseStyles to, Single delta)

Lerp a specific property by name

virtual Object Clone()

Perform a deep copy of this stylesheet

Void ApplyCascading(BaseStyles parent)
Assembly: Sandbox.Engine Namespace: Sandbox.UI Full Name: Sandbox.UI.BaseStyles