SVGLength Class

SVGLength class

The SVGLength interface corresponds to the length basic data type. An SVGLength object can be designated as read only, which means that attempts to modify the object will result in an exception being thrown, as described below.

public class SVGLength : SVGValueType

Properties

NameDescription
UnitType { get; }The type of the value as specified by one of the SVG_LENGTHTYPE_* constants defined on this interface.
Value { get; set; }The value as a floating point value, in user units. Setting this attribute will cause valueInSpecifiedUnits and valueAsString to be updated automatically to reflect this setting.
ValueAsString { get; set; }The value as a string value, in the units expressed by unitType. Setting this attribute will cause value, valueInSpecifiedUnits and unitType to be updated automatically to reflect this setting.
ValueInSpecifiedUnits { get; set; }The value as a floating point value, in the units expressed by unitType. Setting this attribute will cause value and valueAsString to be updated automatically to reflect this setting.

Methods

NameDescription
ConvertToSpecifiedUnits(ushort)Preserve the same underlying stored value, but reset the stored unit identifier to the given unitType. Object attributes unitType, valueInSpecifiedUnits and valueAsString might be modified as a result of this method. For example, if the original value were “0.5cm” and the method was invoked to convert to millimeters, then the unitType would be changed to SVG_LENGTHTYPE_MM, valueInSpecifiedUnits would be changed to the numeric value 5 and valueAsString would be changed to “5mm”.
Dispose()Releases unmanaged and - optionally - managed resources.
virtual GetPlatformType()This method is used to retrieve the ECMAScript object .
NewValueSpecifiedUnits(ushort, float)Reset the value as a number with an associated unitType, thereby replacing the values for all of the attributes on the object.
override ToString()Returns a String that represents this instance.

Fields

NameDescription
const SVG_LENGTHTYPE_CMA value was specified using the cm units defined in CSS2.
const SVG_LENGTHTYPE_EMSA value was specified using the em units defined in CSS2.
const SVG_LENGTHTYPE_EXSA value was specified using the ex units defined in CSS2.
const SVG_LENGTHTYPE_INA value was specified using the in units defined in CSS2.
const SVG_LENGTHTYPE_MMA value was specified using the mm units defined in CSS2.
const SVG_LENGTHTYPE_NUMBERNo unit type was provided (i.e., a unitless value was specified), which indicates a value in user units.
const SVG_LENGTHTYPE_PCA value was specified using the pc units defined in CSS2.
const SVG_LENGTHTYPE_PERCENTAGEA percentage value was specified.
const SVG_LENGTHTYPE_PTA value was specified using the pt units defined in CSS2.
const SVG_LENGTHTYPE_PXA value was specified using the px units defined in CSS2.
const SVG_LENGTHTYPE_UNKNOWNThe unit type is not one of predefined unit types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.

See Also

SVGAnimatedValueT Class SVGLengthList Class