Class StyleProperties

A collection of properties describing the styles of a user interface element.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

BackgroundColor BorderBottomColor BorderBottomLeftRadius BorderBottomRightRadius BorderBottomWidth BorderLeftColor BorderLeftWidth BorderRightColor BorderRightWidth BorderStyle BorderTopColor BorderTopLeftRadius BorderTopRightRadius BorderTopWidth Color FontFamily FontSize FontStyle FontWeight MarginBottom MarginLeft MarginRight MarginTop PaddingBottom PaddingLeft PaddingRight PaddingTop SecondaryColor CreateFontMetadata GetEffectiveBackgroundColor ToInlineCss

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

BackgroundColor

BorderBottomColor

  • get BorderBottomColor(): ColorInfo

  • Gets the border bottom color.

    Returns ColorInfo

    Since

    2.0

BorderBottomLeftRadius

BorderBottomRightRadius

BorderBottomWidth

  • get BorderBottomWidth(): number

  • Gets the bottom border width.

    Returns number

    Since

    2.0

BorderLeftColor

BorderLeftWidth

  • get BorderLeftWidth(): number

  • Gets the left border width.

    Returns number

    Since

    2.0

BorderRightColor

BorderRightWidth

  • get BorderRightWidth(): number

  • Gets the right border width.

    Returns number

    Since

    2.0

BorderStyle

BorderTopColor

BorderTopLeftRadius

BorderTopRightRadius

BorderTopWidth

  • get BorderTopWidth(): number

  • Gets the top border width.

    Returns number

    Since

    2.0

Color

FontFamily

  • get FontFamily(): string

  • Gets the font family name.

    Returns string

    Since

    2.0

FontSize

  • get FontSize(): number

  • Gets the size of the font.

    Returns number

    Since

    2.0

FontStyle

FontWeight

MarginBottom

  • get MarginBottom(): number

  • Gets the bottom margin.

    Returns number

    Since

    2.0

MarginLeft

  • get MarginLeft(): number

  • Gets the left margin.

    Returns number

    Since

    2.0

MarginRight

  • get MarginRight(): number

  • Gets the right margin.

    Returns number

    Since

    2.0

MarginTop

  • get MarginTop(): number

  • Gets the top margin.

    Returns number

    Since

    2.0

PaddingBottom

  • get PaddingBottom(): number

  • Gets the bottom padding.

    Returns number

    Since

    2.0

PaddingLeft

  • get PaddingLeft(): number

  • Gets the left padding.

    Returns number

    Since

    2.0

PaddingRight

  • get PaddingRight(): number

  • Gets the right padding.

    Returns number

    Since

    2.0

PaddingTop

  • get PaddingTop(): number

  • Gets the top padding.

    Returns number

    Since

    2.0

SecondaryColor

  • get SecondaryColor(): ColorInfo

  • Gets the secondary color. Used when rendering labels etc. on graphical elements (bars, lines, etc.) when the Color has worse contrast to the background.

    Returns ColorInfo

    Since

    2.0

CreateFontMetadata

  • CreateFontMetadata(): FontMetadata

  • Creates a font from current settings.

    Returns FontMetadata

    The font metadata.

    Since

    2.0

GetEffectiveBackgroundColor

  • GetEffectiveBackgroundColor(): Color

  • Gets a suitable color to use for painting the background. Use this to render the background of an element that does not support transparency. This method is typically only relevant for Forms based implementations of views for CustomVisuals etc. If your view is based on HTML and Javascript (that is, derived from CustomVisualView) you can just leave your background transparent to use the theme color of the page.

    Returns Color

    A color.

    Since

    2.0

ToInlineCss

  • ToInlineCss(): string

  • Creates a string containing the CSS corrsponding to the current property values.

    Returns string

    A CSS string.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability