CSSPrimitiveValue: setStringValue() method
Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.
The setStringValue()
method of the
CSSPrimitiveValue
interface is used to set a string value. If the
property attached to this value can't accept the specified unit or the string value, the
value will be unchanged and a DOMException
will be raised.
Note: This method was part of an attempt to create a typed CSS Object Model. This attempt has been abandoned, and most browsers do not implement it.
To achieve your purpose, you can use:
- the untyped CSS Object Model, widely supported, or
- the modern CSS Typed Object Model API, less supported and considered experimental.
Syntax
js
setStringValue(stringType, stringValue)
Parameters
stringType
-
An
unsigned short
representing the type of the value. Possible values are: stringValue
-
A string representing the new string value.
Return value
None (undefined
).
Exceptions
InvalidAccessError
DOMException
-
Thrown if the CSS value doesn't contain a string value or if the string value can't be converted into the specified unit.
- `NoModificationAllowedError'
DOMException
-
Thrown if the property is read-only.
Specifications
This feature was originally defined in the DOM Style Level 2 specification, but has been dropped from any standardization effort since then.
It has been superseded by a modern, but incompatible, CSS Typed Object Model API that is now on the standard track.
Browser compatibility
BCD tables only load in the browser