Export (0) Print
Expand All

currentStyle object

Represents the cascaded format and style of the object as specified by global style sheets, inline styles, and HTML attributes.

Members

The currentStyle object has these types of members:

Methods

The currentStyle object has these methods.

MethodDescription
getAttribute

Retrieves the value of the specified attribute.

getExpression

This element is obsolete and should no longer be used. Retrieves the expression for the given property.

getPropertyPriority

Gets the priority of a CSS property if the priority is explicitly set in the current declaration block.

getPropertyValue

Gets the value of a CSS property if it is explicitly set within the current declaration block.

item

Gets a property that has been explicitly set in the current declaration block.

removeProperty

Removes a CSS property if it is explicitly set within the current declaration block.

setAttribute

Sets the value of the specified attribute.

setExpression

This element is obsolete and should no longer be used. Sets an expression for the specified object.

setProperty

Sets a property value and priority within the current declaration block.

 

Properties

The currentStyle object has these properties.

PropertyAccess typeDescription

accelerator

Sets or retrieves a string that indicates whether the object represents a keyboard shortcut.

animation

Read/write

Specifies shorthand values that define animation properties for object properties identified in the @keyframes at-rule of the animations-name property.

animationDelay

Read/write

Specifies the offset within an animation cycle (the amount of time from the start of a cycle) before the animation is displayed for a set of corresponding object properties identified in the CSS @keyframes at-rule specified by the animation-name property.

animationDirection

Read/write

Specifies the direction of play for an animation cycle.

animationDuration

Read/write

Specifies the length of time to complete one cycle of the animation.

animationFillMode

Read/write

Specifies whether the effects of an animation are visible before or after it plays.

animationIterationCount

Read/write

Specifies the number of times an animation cycle is played.

animationName

Read/write

Identifies one or more animation names. An animation name selects a CSS @keyframes at-rule.

animationPlayState

Read/write

Specifies whether an animation is playing or paused.

animationTimingFunction

Read/write

Specifies the intermediate property values to be used during a single cycle of an animation on a set of corresponding object properties identified in the CSS @keyframes at-rule specified by the animation-name property.

backfaceVisibility

Read/write

Gets or sets a value that specifies whether the back face (reverse side) of an object is visible.

background

Specifies up to five separate background properties of an object.

backgroundAttachment

Specifies how the background image (or images) is attached to the object within the document.

backgroundClip

Specifies the background painting area or areas relative to the element's bounding boxes.

backgroundColor

Specifies the color behind the content of the object.

backgroundImage

Specifies the background image or images of the object.

backgroundOrigin

Specifies the positioning area of an element or multiple elements.

backgroundPosition

Specifies the position of the background of the object.

backgroundPositionX

Specifies the x-coordinate of the background-position property.

backgroundPositionY

Specifies the y-coordinate of the background-position property.

backgroundRepeat

Specifies whether and how the background image (or images) is tiled.

backgroundSize

Specifies the size of the background images.

baselineShift

Sets or retrieves a value that indicates how the dominant baseline should be repositioned relative to the dominant baseline of the parent text content element.

behavior

Sets or retrieves the location of the Dynamic HTML (DHTML) behaviorDHTML Behaviors.

blockDirection

Gets a string value that indicates whether the content in the block element flows from left to right, or from right to left.

border

Specifies the properties of a border drawn around an object.

borderBottom

Specifies the properties of the bottom border of the object.

borderBottomColor

Specifies the foreground color of the bottom border of an object.

borderBottomLeftRadius

Specifies the radii of the quarter ellipse that defines the shape of the lower-left corner for the outer border edge of the current box.

borderBottomRightRadius

Sets or retrieves one or two values that define the radii of the quarter ellipse that defines the shape of the lower-right corner for the outer border edge of the current box.

borderBottomStyle

Specifies the style of the bottom border of the object.

borderBottomWidth

Specifies the thickness of the bottom border of the object.

borderCollapse

Indicates whether the row and cell borders of a table are joined in a single border or detached as in standard HTML.

borderColor

Specifies the border color of the object.

borderLeft

Specifies the properties of the left border of the object.

borderLeftColor

Specifies the foreground color of the left border of an object.

borderLeftStyle

Sets or retrieves the style of the left border of the object.

borderLeftWidth

Specifies the thickness of the left border of the object.

borderRadius

Specifies the radii of a quarter ellipse that defines the shape of the corners for the outer border edge of the current box.

borderRight

Specifies the properties of the right border of the object.

borderRightColor

Specifies the foreground color of the right border of an object.

borderRightStyle

Specifies the style of the right border of the object.

borderRightWidth

Specifies the thickness of the right border of the object.

borderSpacing

Specifies the distance between the borders of adjoining cells in a table.

borderStyle

Specifies the style of the left, right, top, and bottom borders of the object.

borderTop

Specifies the properties of the top border of the object.

borderTopColor

Specifies the foreground color of the top border of an object.

borderTopLeftRadius

Sets or retrieves one or two values that define the radii of the quarter ellipse that defines the shape of the upper-left corner for the outer border edge of the current box.

borderTopRightRadius

Sets or retrieves one or two values that define the radii of the quarter ellipse that defines the shape of the upper-right corner for the outer border edge of the current box.

borderTopStyle

Specifies the style of the top border of the object.

borderTopWidth

Specifies the thickness of the top border of the object.

borderWidth

Specifies the thicknesses of the left, right, top, and bottom borders of an object.

bottom

Sets or retrieves the bottom position of the object in relation to the bottom of the next positioned object in the document hierarchy.

boxShadow

Specifies one or more set of shadow values that attaches one or more drop shadows to the current box.

boxSizing

Specifies the box model to use for object sizing.

breakAfter

Read/write

Gets or sets the column-break behavior that follows a content block in a multi-column element.

breakBefore

Read/write

Gets or sets the column-break behavior that precedes a content block in a multi-column element.

breakInside

Read/write

Gets or sets the column-break behavior that occurs within a content block in a multi-column element.

captionSide

Sets or retrieves where the caption of a table is located.

clear

Specifies whether the object allows floating objects on its left side, right side, or both, so that the next text displays past the floating objects.

clip

Read/write

Specifies which part of a positioned object is visible.

clipBottom

Gets the bottom coordinate of the object clipping region.

clipLeft

Gets the left coordinate of the object clipping region.

clipPath

Sets or retrieves a reference to the SVG graphical object that will be used as the clipping path.

clipRight

Gets the right coordinate of the object clipping region.

clipTop

Read-only

Gets the top coordinate of the object clipping region.

color

The foreground color of the text of an object.

columnCount

Read/write

Gets or sets the optimal number of columns in a multi-column element.

columnFill

Read/write

Gets or sets a value that indicates how the column lengths in a multi-column element are affected by the content flow.

columnGap

Read/write

Gets or sets the width of the gap between columns in a multi-column element.

columnRule

Read/write

Gets or sets a shorthand value that specifies values for the columnRuleWidth, columnRuleStyle, and the columnRuleColor of a multi-column element.

columnRuleColor

Read/write

Gets or sets the color for all column rules in a multi-column element.

columnRuleStyle

Read/write

Gets or sets the style for all column rules in a multi-column element.

columnRuleWidth

Read/write

Gets or sets the width of all column rules in a multi-column element.

columnSpan

Read/write

Gets or sets the number of columns that a content block spans in a multi-column element.

columnWidth

Read/write

Gets or sets the optimal width of the columns in a multi-column element.

constructor

Returns a reference to the constructor of an object.

content

Specifies generated content to insert before or after an element.

counterIncrement

Sets or retrieves a list of counters to increment.

counterReset

Sets or retrieves a list of counters to create or reset to zero.

cssFloat

Sets or retrieves a value that specifies whether a box should float to the left, right, or not at all.

cssText

Read/write

Sets or retrieves the persisted representation of the style rule.

cursor

Specifies the type of cursor to display as the mouse pointer moves over the object.

direction

Specifies the reading order of the object.

display

Gets or sets a value that indicates whether and how the object is rendered.

dominantBaseline

Sets or retrieves a value that determines or redetermines a scaled-baseline table.

emptyCells

Determines whether to show or hide a cell without content.

fill

Sets or retrieves a value that indicates the color to paint the interior of the given graphical element.

fillOpacity

Sets or retrieves a value that specifies the opacity of the painting operation that is used to paint the interior of the current object.

fillRule

Sets or retrieves a value that indicates the algorithm that is to be used to determine what parts of the canvas are included inside the shape.

filter

Sets or retrieves the filter or collection of filters that are applied to the object.

font

Specifies a combination of separate font properties of the object. Alternatively, sets or retrieves one or more of six user-preference fonts.

fontFamily

Specifies the name of the font used for text in the object.

fontSize

Specifies a value that indicates the font size used for text in the object.

fontStretch

Specifies a value that indicates a normal, condensed, or expanded face of a font family.

fontStyle

Specifies the font style of the object as italic, normal, or oblique.

fontVariant

Specifies whether the text of the object is in small capital letters.

fontWeight

Gets the numeric weight of the font of the object.

fontWeight

Specifies the weight of the font of the object.

glyphOrientationHorizontal

Sets or retrieves a value that alters the orientation of a sequence of characters relative to an inline-progression-direction of horizontal.

glyphOrientationVertical

Sets or retrieves a value that alters the orientation of a sequence of characters relative to an inline-progression-direction of vertical.

hasLayout

Gets a value that indicates whether the object has layout.

height

Sets or retrieves the height of the object.

imeMode

Specifies the state of an IME.

kerning

Gets or sets a value that indicates whether Internet Explorer should adjust inter-glyph spacing based on kerning tables that are included in the relevant font (that is, enable auto-kerning) or instead disable auto-kerning and set inter-character spacing to a specific length (typically zero).

layoutFlow

Specifies the direction and flow of the content in the object.

layoutGrid

Specifies the composite document grid properties that specify the layout of text characters.

layoutGridChar

Specifies the size of the character grid used for rendering the text content of an element.

layoutGridLine

Specifies the gridline value used for rendering the text content of an element.

layoutGridMode

Specifies whether the text layout grid uses two dimensions.

layoutGridType

Specifies the type of grid used for rendering the text content of an element.

left

Sets or retrieves the position of the object relative to the left edge of the next positioned object in the document hierarchy.

length

Retrieves the number of properties that are explicitly set on the parent object.

letterSpacing

Specifies the amount of additional space between letters in the object.

lineBreak

Specifies line-breaking rules for text in selected languages such as Japanese, Chinese, and Korean.

lineHeight

Sets or retrieves the distance between lines in the object.

listStyle

Sets or retrieves up to three separate list-style properties of the object.

listStyleImage

Sets or retrieves a value that indicates which image to use as a list-item marker for the object.

listStylePosition

Sets or retrieves a variable that indicates how the list-item marker is drawn relative to the content of the object.

listStyleType

Sets or retrieves the predefined type of the line-item marker for the object.

margin

Sets or retrieves the width of the top, right, bottom, and left margins of the object.

marginBottom

Sets or retrieves the height of the bottom margin of the object.

marginLeft

Sets or retrieves the width of the left margin of the object.

marginRight

Sets or retrieves the width of the right margin of the object.

marginTop

Sets or retrieves the height of the top margin of the object.

marker

Sets or retrieves a value that specifies the marker symbol that is used for all vertices on the given path element or basic shape.

markerEnd

Sets or retrieves a value that defines the arrowhead or polymarker that is drawn at the final vertex of a given path element or basic shape.

markerMid

Sets or retrieves a value that defines the arrowhead or polymarker that is drawn at every other vertex (that is, every vertex except the first and last) of a given path element or basic shape.

markerStart

Sets or retrieves a value that defines the arrowhead or polymarker that is drawn at the first vertex of a given path element or basic shape.

mask

Sets or retrieves a value that indicates a SVG mask.

maxHeight

Sets or retrieves the maximum height for an element.

maxWidth

Sets or retrieves the maximum width for an element.

minHeight

Specifies the minimum height for an element.

minWidth

Sets or retrieves the minimum width for an element.

msBlockProgression

Specifies the block progression and layout orientation.

msGridColumn

Read/write

Gets or sets a value that specifies in which column of the grid to place the object.

msGridColumnAlign

Read/write

Gets or sets a value that specifies the horizontal alignment of the object within the grid column.

msGridColumns

Read/write

Gets or sets one or more values that specify the width of each grid column within the object.

msGridColumnSpan

Read-only

Gets or sets a value that specifies the number of columns of the grid that the object spans.

msGridRow

Read/write

Gets or sets a value that specifies in which row of the grid to place the object.

msGridRowAlign

Read/write

Gets or sets a value that specifies the vertical alignment of the object within the grid row.

msGridRows

Read/write

Gets or sets one or more values that specify the height of each grid row within the object.

msGridRowSpan

Read/write

Gets or sets a value that specifies the number of rows of the grid that the object spans.

msInterpolationMode

Obsolete. Gets or sets the interpolation (resampling) method used to stretch images.

msProgressAppearance

Read/write

This property is obsolete. Use animation-name instead.

opacity

Gets or sets a value that specifies object or group opacity in CSS or SVG.

orphans

Sets or retrieves the minimum number of lines of a paragraph that must appear at the bottom of a page.

outline

Specifies the color, style, and width of the outline frame.

outlineColor

Specifies the color of the outline frame.

outlineStyle

Specifies the style of the outline frame.

outlineWidth

Specifies the width of the outline frame.

overflow

Sets or retrieves a value indicating how to manage the content of the object when the content exceeds the height or width of the object.

overflowX

Sets or retrieves how to manage the content of the object when the content exceeds the width of the object.

overflowY

Sets or retrieves how to manage the content of the object when the content exceeds the height of the object.

padding

Sets or retrieves the amount of space to insert between the object and its margin or, if there is a border, between the object and its border.

paddingBottom

Sets or retrieves the amount of space to insert between the bottom border of the object and the content.

paddingLeft

Sets or retrieves the amount of space to insert between the left border of the object and the content.

paddingRight

Sets or retrieves the amount of space to insert between the right border of the object and the content.

paddingTop

Sets or retrieves the amount of space to insert between the top border of the object and the content.

pageBreakAfter

Sets or retrieves a value indicating whether a page break occurs after the object.

pageBreakBefore

Defines whether a page break occurs before the object.

pageBreakInside

Sets or retrieves a string indicating whether a page break is allowed to occur inside the object.

parentRule

Retrieves the containing rule, if the current rule is contained inside another rule.

perspective

Read/write

Gets or sets a value that represents the perspective from which all child elements of the object are viewed.

perspectiveOrigin

Read/write

Gets or sets one or two values that represent the origin (the vanishing point for the 3-D space) of an object with an perspective property declaration.

pointerEvents

Sets or retrieves a value that specifies under what circumstances a given graphics element can be the target element for a pointer event in SVG. Starting with IE11, this property also has basic support for HTML elements (see "Remarks" section).

position

Sets or retrieves the type of positioning used for the object.

quotes

Sets or retrieves the pairs of strings to be used as quotes in generated content.

right

Sets or retrieves the position of the object relative to the right edge of the next positioned object in the document hierarchy.

rubyAlign

Gets or sets a value that indicates how to align the ruby text content.

rubyOverhang

Gets or sets a value that indicates whether, and on which side, ruby text is allowed to partially overhang any adjacent text in addition to its own base, when the ruby text is wider than the ruby base

rubyPosition

Gets or sets a value that controls the position of the ruby text with respect to its base.

scrollbar3dLightColor

Specifies the color of the top and left edges of the scroll box and scroll arrows of a scroll bar.

scrollbarArrowColor

Specifies the color of the arrow elements of a scroll arrow.

scrollbarBaseColor

Specifies the base color of the main elements of a scroll bar.

scrollbarDarkShadowColor

Specifies the color of the gutter of a scroll bar.

scrollbarFaceColor

Specifies the color of the scroll box and scroll arrows of a scroll bar.

scrollbarHighlightColor

Specifies the color of the slider tray, and the top and left edges of the scroll box and scroll arrows of a scroll bar.

scrollbarShadowColor

Specifies the color of the bottom and right edges of the scroll box and scroll arrows of a scroll bar.

scrollbarTrackColor

Specifies the color of the track element of a scroll bar.

stopColor

Sets or retrieves a value that indicates what color to use at the current gradient stop.

stopOpacity

Sets or retrieves a value that defines the opacity of the current gradient stop.

stroke

Sets or retrieves a value that indicates the color to paint along the outline of a given graphical element.

strokeDasharray

Sets or retrieves one or more values that indicate the pattern of dashes and gaps used to stroke paths.

strokeDashoffset

Sets or retrieves a value that specifies the distance into the dash pattern to start the dash.

strokeLinecap

Sets or retrieves a value that specifies the shape to be used at the end of open subpaths when they are stroked.

strokeLinejoin

Sets or retrieves a value that specifies the shape to be used at the corners of paths or basic shapes when they are stroked.

strokeMiterlimit

Sets or retrieves a value that indicates the limit on the ratio of the length of miter joins (as specified in the strokeLinejoin property).

strokeOpacity

Sets or retrieves a value that specifies the opacity of the painting operation that is used to stroke the current object.

strokeWidth

Sets or retrieves a value that specifies the width of the stroke on the current object.

styleFloat

Sets or retrieves on which side of the object the text will flow.

tableLayout

Sets or retrieves a string that indicates whether the table layout is fixed.

textAlign

Specifies whether the text in the object is left-aligned, right-aligned, centered, or justified.

textAlignLast

Specifies a value that indicates how to align the last line or only line of text in the specified object.

textAutospace

Specifies the autospacing and narrow space width adjustment of text.

textDecoration

Specifies a value that indicates whether the text in the object has blink, line-through, overline, or underline decorations.

textIndent

Specifies the indentation of the first line of text in the object.

This property is not supported for Windows Store apps using JavaScript.

textJustify

Specifies the type of alignment used to justify text in the object.

textKashidaSpace

Deprecated. Specifies the ratio of kashida expansion to white space expansion when justifying lines of text in the object.

textOverflow

Specifies a value that indicates whether to render ellipses (...) to indicate text overflow.

textTransform

Specifies the rendering of the text in the object.

textUnderlinePosition

Specifies the position of the underline decoration that is set through the text-decoration property of the object.

top

Sets or retrieves the position of the object relative to the top of the next positioned object in the document hierarchy.

transform

Read/write

Gets or sets a list of one or more transform functions that specify how to translate, rotate, or scale an element in 2-D or 3-D space.

transformOrigin

Read/write

Gets or sets one or two values that establish the origin of transformation for an element.

transformStyle

Read/write

Gets or sets a value that specifies how child elements of the object are rendered in 3-D space.

transition

Read/write

Gets or sets one or more shorthand values that specify the transition properties for a set of corresponding object properties identified in the transition-property property.

transitionDelay

Read/write

Gets or sets one or more values that specify the offset within a transition (the amount of time from the start of a transition) before the transition is displayed for a set of corresponding object properties identified in the transition property.

transitionDuration

Read/write

Gets or sets one or more values that specify the durations of transitions on a set of corresponding object properties identified in the transition-property property.

transitionProperty

Read/write

Gets or sets a value that identifies the CSS property name or names to which the transition effect (defined by the transition-duration, transition-timing-function, and transition-delay properties) is applied when a new property value is specified.

transitionTimingFunction

Read/write

Gets or sets one or more values that specify the intermediate property values to be used during a transition on a set of corresponding object properties identified in the transition-property property.

unicodeBidi

Read/write

Specifies the level of embedding with respect to the bidirectional algorithm.

verticalAlign

Sets or retrieves the vertical alignment of the object.

visibility

Sets or retrieves whether the content of the object is displayed.

whiteSpace

Specifies a value that indicates whether lines are automatically broken inside the object.

widows

Sets or retrieves the minimum number of lines of a paragraph that must appear at the top of a document.

width

Specifies the width of the object.

wordBreak

Specifies line-breaking behavior within words, particularly where multiple languages appear in the object.

wordSpacing

Specifies the amount of additional space between words in the object.

wordWrap

Specifies whether to break words when the content exceeds the boundaries of its container.

writingMode

Specifies the direction and flow of the content in the object.

zIndex

Sets or retrieves the stacking order of positioned objects.

zoom

Specifies the magnification scale of the object.

 

Standards information

There are no standards that apply here.

Remarks

The currentStyle object returns the cascaded styles on an element, but the style object returns only the styles that have been applied inline on an element through the style attribute. Thus, the style values retrieved through the currentStyle object might differ from the style values retrieved through the style object. For example, if the color property is set on a paragraph only through a linked or embedded style sheet, and not inline, then object.currentStyle.color returns the color, whereas object.style.color does not return a value. If, however, the author specifies <p style="color:'red'", the currentStyle and style objects return the value .

The currentStyle object reflects the order of style precedence in CSS. The CSS order of precedence for the presentation of HTML is:

  1. Inline styles
  2. Style sheet rules
  3. Attributes on HTML tags
  4. Intrinsic definition of the HTML tag

Accordingly, the currentStyle object returns the fontWeight value normal on a bold tag if normal is specified in a style sheet.

The currentStyle object returns values that reflect the applied style settings for the page and might not reflect what is rendering at the time a value is retrieved. For example, an object that has "color:red; display:none" returns currentStyle.color as even though the object is not rendered on the page. The currentStyle object, then, is not affected by the rendering constraints. The third example in the Example section demonstrates this behavior. Disabled style sheets also do not affect currentStyle values.

The returned value is in the same units as those used to set the object. For example, if the color of an object is set inline using style="color:'green'", then currentStyle.color returns and not #00FF00 (the red-green-blue hexadecimal equivalent to green). However, capitalization and redundant white space that appear in the object values set by the author are lost when the currentStyle object returns the object values.

The currentStyle object supports user-defined properties in style rules. See the second example in the Example section.

The currentStyle object is asynchronous. This means a style cannot be set and then immediately queried—instead, the old value is returned. Thus, for a script to obtain the expected behavior of currentStyle with methods such as addImport, the script needs to include a function that calls the method and a function that checks currentStyle. For a script to check the current style while a page is loading, the script must wait until the body element is loaded and the page has rendered, or the value of currentStyle might not reflect what is being displayed.

Windows Internet Explorer 8 or later. The behavior of the setAttribute method and the default value of the zIndex property varies according to the current document compatibility mode. For more information, see Attribute Differences in Internet Explorer 8 and Defining Document Compatibility.

Examples

This example uses the currentStyle object to set the text color to brown. If you click a colored area and the background color is the same as the text color, the checkColor function changes the background color, allowing the text to be visible. Otherwise, the function takes no action.

This example works only if the body and text colors are set using either color names or red-green-blue hexadecimal values, but not a mix of the two.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/currentStyle_backgroundColor.htm



<head>
<script>
function checkColor(oObj)
{
  if (oObj.currentStyle.backgroundColor == 'brown') {
    oObj.style.backgroundColor = 'white';
	 }
  else
	:
}
</script>
</head>
:
<p style="background-color: 'brown'"
    onclick="checkColor(this)">Click me</p>

This example uses the currentStyle object to retrieve values of the user-defined property created in the style rule. The alert returns the value myvalue.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/currentStyle2.htm


<style>
  p { myproperty:myvalue }
</style>
<body>
<p id="oPrgrph" />
:
<script>
console.log(oPrgrph.currentStyle.myproperty);
</script>

This example shows that the td object width returned by the currentStyle object is its cascaded width value rather than the width rendered on the screen. Open the F12 developer tools and click Console before running this example.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/currentStyle_table.htm


<!DOCTYPE html>
<html>

<head>
  <title>Style</title>
  <style>
    td {
      border: 1px solid black;
      width: 1100px;
    }
  </style>
</head>
<body id="idBody">
  <p>The table will be rendered within the window regardless of the size of the window. 
    However, the <strong>currentStyle</strong>.width of the <strong>td</strong> object 
    will return the cascaded value (1100px) rather than the rendered value.</p>

  <table>
    <tr>
      <td id="oID_1">text</td>
    </tr>
  </table>

  <script>
    var oID_1 = document.getElementById('oID_1');
    var idBody = document.getElementById('idBody');

    console.log("The TD object width is " +
      oID_1.currentStyle.width + ".\nThe width of the window is " +
      idBody.clientWidth + "px.\nThe width of the screen is " + screen.width + "px.");
  </script>
</body>
</html>

See also

style

 

 

Show:
© 2014 Microsoft