Detailed Description

A CSS property. You can create custom ones by deriving from this class. Note that they are instanced globally.

Inheritance diagram for Css.CssProperty:

Public Member Functions
virtual string[]	GetProperties ()
	The set of all properties that this one will handle. Usually just one. e.g. "v-align", "vertical-align". More...

virtual float	GetNormalValue (RenderableData context)
	The value of the 'normal' keyword. More...

CssProperty	GetAliased (int index)
	Gets the aliased property for the given index. E.g. color-r is index 0 of color. More...

CssProperty	GetAliased (int index, bool orThis)
	Gets the aliased property for the given index. E.g. color-r is index 0 of color. More...

virtual void	Aliases ()
	The set of aliases for this property. For example, the border-radius property can declare an alias of border-top-left which maps to e.g. "1", i.e. the first inner index. More...

virtual ApplyState	Apply (ComputedStyle style, Value value)
	Apply this CSS style to the given computed style. Note that you can grab the element from the computed style if you need that. More...

virtual void	ApplyText (TextRenderingProperty text, RenderableData data, ComputedStyle style, Value value)
	Apply this CSS style to the given computed style. Note that you can grab the element from the computed style if you need that. More...

virtual void	OnReadValue (Style styleBlock, Css.Value value)
	Called when a value is read from the CSS stream. More...

virtual Css.Value	GetValue (Style styleBlock)
	Called to get a this properties value from the given style. This exists as it may be an alias property. More...

Css.Value	GetOrCreateValue (Node context, Style styleBlock, bool allowInherit)
	Called to get a this properties value from the given style. This overload should not be used with alias properties - it always returns the 'host' value. More...

virtual Css.Value	GetOrCreateValue (Node context, Style styleBlock, bool allowInherit, out Css.Value hostValue)
	Called to get a this properties value from the given style. This exists as it may be an alias property. More...

void	Reapply (ComputedStyle computed, string propertyName)
	Causes the named property to apply its value. More...

void	Reapply (ComputedStyle style, CssProperty property)
	Sets the named css property from the given style if the property exists in the style. More...

BackgroundImage	GetBackground (ComputedStyle style)
	Call this if the current property requires a background image object. More...

BorderProperty	GetBorder (ComputedStyle style)
	Call this if the current property requies a border object. More...

TextRenderingProperty	GetText (ComputedStyle style)
	Call this if the current property requires a text object. NOTE: This one may be null. More...

TextRenderingProperty3D	GetText3D (ComputedStyle style)
	Call this if the current property requires a text object. NOTE: This one may be null. More...

Public Attributes
int	SetSize
	If this property is a known set, the size of the set. This is automatically computed from aliases. More...

string	Name
	The main property name. Some properties use multiple names (e.g. content and inner-text). More...

bool	IsAlias
	True if this is an alias. More...

bool	IsTextual
	Does this css property apply to text? E.g. font-size, color etc. More...

string	NamespaceName
	Set if this property comes from some other namespace (e.g. "svg"). More...

ValueAxis	Axis =ValueAxis.None
	True if this property occurs along the x axis. E.g. width, left, right. More...

ValueRelativity	RelativeTo =ValueRelativity.Dimensions
	What is this property relative to? Most of the time, they're relative to dimensions (e.g. 100% of width). More...

bool	IsWidthOrHeight
	True if this is width or height only. More...

List< CssProperty >	AliasedProperties
	The properties that are aliased to this one. For example, color-r is aliased to color. More...

bool	Inherits
	True if this property inherits. Defaults to false. More...

Css.Value	InitialValue =NONE
	The initial value for this property. Defaults to a decimal 0 (equiv of 'none' or just '0'). More...

Protected Member Functions
virtual Css.Spec.Value	GetSpecification ()
	Loads the values spec. More...

void	ColourAliases (string property, ValueAxis axis, int index)
	Loads a set of colour aliases for a given property name. E.g. name-r,name-g,name-b and name-a. The alias may also be mapped to a sub-index. It must be an empty string otherwise. More...

void	SquareAliases (string property, int index)
	Loads a set of square aliases. E.g. name-top or name-bottom. More...

void	ColourAliases ()
	Loads a set of colour aliases. E.g. name-r,name-g,name-b and name-a. More...

void	PointAliases2D ()
	Loads a set of point aliases. E.g. name-x, name-y and name-z. More...

void	PointAliases3D ()
	Loads a set of point aliases. E.g. name-x, name-y and name-z. More...

void	SquareAliases ()
	Loads a set of square aliases. E.g. name-top or name-bottom. More...

void	LogicalAlias (string name, ValueAxis axis, params int[] target)
	Adds a logical alias for the given CSS property to the given target. A numeric target, e.g. 1, means that inner index of this property, which is a set. More...

void	Alias (string name, ValueAxis axis, params int[] target)
	Adds an alias for the given CSS property to the given target. A numeric target, e.g. 1, means that inner index of this property, which is a set. More...

Static Package Attributes
static Css.Value	NONE =new Css.Keywords.None()
	Shared default values. More...

static Css.Value	ZERO =new Css.Units.DecimalUnit(0)

static Css.Value	AUTO =new Css.Keywords.Auto()

Properties
bool	HasAliases `[get]`
	True if this property has aliases. More...

Css.Spec.Value	Specification `[get]`
	The specification for this properties value. More...

virtual bool	Internal `[get]`
	True if this property is for internal use only. More...

virtual bool	NonStandard `[get]`
	True if this property is specific to Spark. More...

string	InitialValueText `[set]`
	A convenience property for setting up initial values. More...

Private Member Functions
void	AddAlias (string name, CssPropertyAlias alias)

Private Attributes
Css.Spec.Value	Specification_
	The specification for this properties value. Use Specification instead. More...

Member Function Documentation

void Css.CssProperty.AddAlias	(	string	name,
		CssPropertyAlias	alias
	)

inlineprivate

void Css.CssProperty.Alias	(	string	name,
		ValueAxis	axis,
		params int[]	target
	)

inlineprotected

Adds an alias for the given CSS property to the given target. A numeric target, e.g. 1, means that inner index of this property, which is a set.

virtual void Css.CssProperty.Aliases ( )

inlinevirtual

The set of aliases for this property. For example, the border-radius property can declare an alias of border-top-left which maps to e.g. "1", i.e. the first inner index.

Reimplemented in Css.Properties.Overflow, Css.Properties.PositionInternal, Css.Properties.ColorOverlay, Css.Properties.BackgroundSize, Css.Properties.BorderStyle, Css.Properties.BorderWidth, Css.Properties.Margin, Css.Properties.Padding, Css.Properties.Scroll, Css.Properties.BorderColor, Css.Properties.ColorProperty, Css.Properties.ParticlesRotateProperty, Css.Properties.TextDecorationColor, Css.Properties.TransformOrigin, Css.Properties.TextDecorationStyle, Css.Properties.BackgroundColor, Css.Properties.BackgroundPosition, and Css.Properties.BorderRadius.

virtual ApplyState Css.CssProperty.Apply	(	ComputedStyle	style,
		Value	value
	)

inlinevirtual

Apply this CSS style to the given computed style. Note that you can grab the element from the computed style if you need that.

Parameters

style	The computed style to apply the property to.
value	The new value being applied.

Reimplemented in Css.Properties.FontVariantNumeric, Css.Properties.FontVariantEastAsian, Css.Properties.TransformProperty, Css.Properties.FontVariantLigatures, Css.Properties.FontVariantAlternates, Css.Properties.Filter, Css.Properties.FontVariantCaps, Css.Properties.UserSelect, Css.Properties.FontFeatureSettings, Css.Properties.FontVariantPosition, Css.Properties.SparkWritingSystem, Css.Properties.TextExtrude, Css.Properties.BackgroundPosition, Css.Properties.TransformOriginPosition, Css.Properties.PositionInternal, Css.Properties.FontWeight, Css.Properties.Overflow, Css.Properties.FontStretch, Css.Properties.FontSize, Css.Properties.BorderColor, Css.Properties.TextDecorationColor, Css.Properties.FontFamily, Css.Properties.ColorOverlay, Css.Properties.Scroll, Css.Properties.BorderWidth, Css.Properties.TextDecorationLine, Css.Properties.TextDecorationStyle, Css.Properties.BorderStyle, Css.Properties.FontStyle, Css.Properties.ShaderFamily, Css.Properties.Margin, Css.Properties.Padding, Css.Properties.LineHeight, Css.Properties.BackgroundSize, Css.Properties.Height, Css.Properties.Quotes, Css.Properties.ParticlesRotateProperty, Css.Properties.Width, Css.Properties.BorderImageSlice, Css.Properties.ClipMode, Css.Properties.ParticlesScaleProperty, Css.Properties.BorderImageRepeat, Css.Properties.ScriptLevel, Css.Properties.ScriptMinSize, Css.Properties.ScriptSizeMultiplier, Css.Properties.BorderImageWidth, Css.Properties.WordSpacing, Css.Properties.MathDisplay, Css.Properties.MathVariant, Css.Properties.ColorProperty, Css.Properties.BorderImageSource, Css.Properties.BorderRadius, Css.Properties.Content, Css.Properties.WhiteSpace, Css.Properties.BorderImageOutset, Css.Properties.FontSizeAdjust, Css.Properties.FontSynthesis, Css.Properties.LetterSpacing, Css.Properties.MinWidth, Css.Properties.TransformOrigin, Css.Properties.UnicodeBidi, Css.Properties.MinHeight, Css.Properties.TextShadow, Css.Properties.TextStroke, Css.Properties.BoxSizing, Css.Properties.MaxHeight, Css.Properties.MaxWidth, Css.Properties.OverflowWrap, Css.Properties.Azimuth, Css.Properties.Elevation, Css.Properties.Pitch, Css.Properties.PitchRange, Css.Properties.Richness, Css.Properties.Speak, Css.Properties.SpeakHeader, Css.Properties.SpeakNumeral, Css.Properties.SpeechRate, Css.Properties.Stress, Css.Properties.BackgroundColor, Css.Properties.CaptionSide, Css.Properties.Cursor, Css.Properties.Direction, Css.Properties.EmptyCells, Css.Properties.Orphans, Css.Properties.Widows, Css.Properties.Zoom, Css.Properties.FloodColor, Css.Properties.StrokeLineCap, Css.Properties.StrokeWidth, Css.Properties.SlidesTimingFunction, Css.Properties.PlayDuring, Css.Properties.SpeakPunctuation, Css.Properties.AlignmentBaseline, Css.Properties.BaselineShift, Css.Properties.Display, Css.Properties.FilteringMode, Css.Properties.AlignContents, Css.Properties.AlignItems, Css.Properties.AlignSelf, Css.Properties.Ascent, Css.Properties.CapHeight, Css.Properties.Descent, Css.Properties.Slope, Css.Properties.Stemh, Css.Properties.Stemv, Css.Properties.Widths, Css.Properties.XHeight, Css.Properties.ListStylePosition, Css.Properties.ListStyleType, Css.Properties.Position, Css.Properties.TableLayout, Css.Properties.TextAlign, Css.Properties.TextAlignLast, Css.Properties.TextTransform, Css.Properties.VerticalAlign, Css.Properties.Visibility, Css.Properties.ZIndex, Css.Properties.AnimationTimingFunction, Css.Properties.All, Css.Properties.BackgroundImageProperty, Css.Properties.Clip, Css.Properties.CounterIncrement, Css.Properties.CounterReset, Css.Properties.Clear, Css.Properties.Float, Css.Properties.FontSmoothing, Css.Properties.ListStyleImage, Css.Properties.Fill, Css.Properties.Stroke, Css.Properties.BorderColllapseProperty, Css.Properties.BorderSpacingProperty, Css.Properties.TextOrientation, Css.Properties.WritingMode, Css.Properties.BackgroundAttachment, Css.Properties.BackgroundRepeat, Css.Properties.Baseline, Css.Properties.BBox, Css.Properties.Centerline, Css.Properties.Mathline, Css.Properties.Panose1, Css.Properties.Topline, Css.Properties.UnicodeRange, Css.Properties.UnitsPerEm, Css.Properties.ClipPath, Css.Properties.ClipRule, Css.Properties.TextAnchor, Css.Properties.SlidesName, Css.Properties.SlidesDelay, Css.Properties.SlidesDirection, Css.Properties.SlidesDuration, Css.Properties.SlidesIterationCount, Css.Properties.AnimationDelay, Css.Properties.AnimationDirection, Css.Properties.AnimationDuration, Css.Properties.AnimationFillMode, Css.Properties.AnimationIterationCount, Css.Properties.AnimationName, Css.Properties.AnimationPlayState, Css.Properties.BackgroundClip, and Css.Properties.OnAtlas.

virtual void Css.CssProperty.ApplyText	(	TextRenderingProperty	text,
		RenderableData	data,
		ComputedStyle	style,
		Value	value
	)

inlinevirtual

Apply this CSS style to the given computed style. Note that you can grab the element from the computed style if you need that.

Parameters

style	The computed style to apply the property to.
value	The new value being applied.

Reimplemented in Css.Properties.TextShadow, and Css.Properties.TextStroke.

void Css.CssProperty.ColourAliases	(	string	property,
		ValueAxis	axis,
		int	index
	)

inlineprotected

Loads a set of colour aliases for a given property name. E.g. name-r,name-g,name-b and name-a. The alias may also be mapped to a sub-index. It must be an empty string otherwise.

void Css.CssProperty.ColourAliases ( )

inlineprotected

Loads a set of colour aliases. E.g. name-r,name-g,name-b and name-a.

CssProperty Css.CssProperty.GetAliased ( int index)

inline

Gets the aliased property for the given index. E.g. color-r is index 0 of color.

CssProperty Css.CssProperty.GetAliased	(	int	index,
		bool	orThis
	)

inline

Gets the aliased property for the given index. E.g. color-r is index 0 of color.

Parameters

orThis If true, returns 'this' if index is not a valid alias.

BackgroundImage Css.CssProperty.GetBackground ( ComputedStyle style)

inline

Call this if the current property requires a background image object.

BorderProperty Css.CssProperty.GetBorder ( ComputedStyle style)

inline

Call this if the current property requies a border object.

virtual float Css.CssProperty.GetNormalValue ( RenderableData context)

inlinevirtual

The value of the 'normal' keyword.

Reimplemented in Css.Properties.WordSpacing, Css.Properties.FontWeight, Css.Properties.WhiteSpace, and Css.Properties.FontStretch.

Css.Value Css.CssProperty.GetOrCreateValue	(	Node	context,
		Style	styleBlock,
		bool	allowInherit
	)

inline

Called to get a this properties value from the given style. This overload should not be used with alias properties - it always returns the 'host' value.

virtual Css.Value Css.CssProperty.GetOrCreateValue	(	Node	context,
		Style	styleBlock,
		bool	allowInherit,
		out Css.Value	hostValue
	)

inlinevirtual

Called to get a this properties value from the given style. This exists as it may be an alias property.

Parameters

hostValue This can return aliased values. The 'host' value is the actual property. Think the value of 'margin' (host) when calling GetValue on 'margin-left' (returned).

Reimplemented in Css.CssPropertyAlias.

virtual string [] Css.CssProperty.GetProperties ( )

inlinevirtual

The set of all properties that this one will handle. Usually just one. e.g. "v-align", "vertical-align".

virtual Css.Spec.Value Css.CssProperty.GetSpecification ( )

inlineprotectedvirtual

Loads the values spec.

TextRenderingProperty Css.CssProperty.GetText ( ComputedStyle style)

inline

Call this if the current property requires a text object. NOTE: This one may be null.

TextRenderingProperty3D Css.CssProperty.GetText3D ( ComputedStyle style)

inline

Call this if the current property requires a text object. NOTE: This one may be null.

virtual Css.Value Css.CssProperty.GetValue ( Style styleBlock)

inlinevirtual

Called to get a this properties value from the given style. This exists as it may be an alias property.

Reimplemented in Css.CssPropertyAlias, and Css.CssCompositeProperty.

void Css.CssProperty.LogicalAlias	(	string	name,
		ValueAxis	axis,
		params int[]	target
	)

inlineprotected

Adds a logical alias for the given CSS property to the given target. A numeric target, e.g. 1, means that inner index of this property, which is a set.

virtual void Css.CssProperty.OnReadValue	(	Style	styleBlock,
		Css.Value	value
	)

inlinevirtual

Called when a value is read from the CSS stream.

Reimplemented in Css.CssPropertyAlias, Css.CssCompositeProperty, Css.Properties.SlidesCompProperty, Css.Properties.AnimationCompProperty, Css.Properties.BackgroundCompProperty, Css.Properties.BorderCompProperty, Css.Properties.BorderBottomProperty, Css.Properties.BorderLeftProperty, Css.Properties.BorderRightProperty, and Css.Properties.BorderTopProperty.

void Css.CssProperty.PointAliases2D ( )

inlineprotected

Loads a set of point aliases. E.g. name-x, name-y and name-z.

void Css.CssProperty.PointAliases3D ( )

inlineprotected

Loads a set of point aliases. E.g. name-x, name-y and name-z.

void Css.CssProperty.Reapply	(	ComputedStyle	computed,
		string	propertyName
	)

inline

Causes the named property to apply its value.

void Css.CssProperty.Reapply	(	ComputedStyle	style,
		CssProperty	property
	)

inline

Sets the named css property from the given style if the property exists in the style.

Parameters

property	The css property, e.g. color.
style	The style to load value of the property from. This should be the computed style for the parent element.

void Css.CssProperty.SquareAliases	(	string	property,
		int	index
	)

inlineprotected

Loads a set of square aliases. E.g. name-top or name-bottom.

void Css.CssProperty.SquareAliases ( )

inlineprotected

Loads a set of square aliases. E.g. name-top or name-bottom.

Member Data Documentation

List<CssProperty> Css.CssProperty.AliasedProperties

The properties that are aliased to this one. For example, color-r is aliased to color.

Css.Value Css.CssProperty.AUTO =new Css.Keywords.Auto()

staticpackage

ValueAxis Css.CssProperty.Axis =ValueAxis.None

True if this property occurs along the x axis. E.g. width, left, right.

bool Css.CssProperty.Inherits

True if this property inherits. Defaults to false.

Css.Value Css.CssProperty.InitialValue =NONE

The initial value for this property. Defaults to a decimal 0 (equiv of 'none' or just '0').

bool Css.CssProperty.IsAlias

True if this is an alias.

bool Css.CssProperty.IsTextual

Does this css property apply to text? E.g. font-size, color etc.

bool Css.CssProperty.IsWidthOrHeight

True if this is width or height only.

string Css.CssProperty.Name

The main property name. Some properties use multiple names (e.g. content and inner-text).

string Css.CssProperty.NamespaceName

Set if this property comes from some other namespace (e.g. "svg").

Css.Value Css.CssProperty.NONE =new Css.Keywords.None()

staticpackage

Shared default values.

ValueRelativity Css.CssProperty.RelativeTo =ValueRelativity.Dimensions

What is this property relative to? Most of the time, they're relative to dimensions (e.g. 100% of width).

int Css.CssProperty.SetSize

If this property is a known set, the size of the set. This is automatically computed from aliases.

Css.Spec.Value Css.CssProperty.Specification_

private

The specification for this properties value. Use Specification instead.

Css.Value Css.CssProperty.ZERO =new Css.Units.DecimalUnit(0)

staticpackage

Property Documentation

bool Css.CssProperty.HasAliases

get

True if this property has aliases.

string Css.CssProperty.InitialValueText

set

A convenience property for setting up initial values.

virtual bool Css.CssProperty.Internal

get

True if this property is for internal use only.

virtual bool Css.CssProperty.NonStandard

get

True if this property is specific to Spark.

Css.Spec.Value Css.CssProperty.Specification

get

The specification for this properties value.

Detailed Description

Public Member Functions

Public Attributes

Protected Member Functions

Static Package Attributes

Properties

Private Member Functions

Private Attributes

Member Function Documentation

Member Data Documentation

Property Documentation