rules Collection (styleSheet, CSSStyleSheet Constructor)

Switch View :
ScriptFree
rules Collection

Retrieves a collection of rules defined in a style sheet.

Syntax

[ oColl = ] object .rules
[ oObject = ] object .rules( iIndex )

Possible Values

oColl Array of rules.
oObject Reference to an individual item in the array of elements contained by the object.
iIndex Required. Integer that specifies the zero-based index of the item to be returned.

Members Table

The following table lists the members exposed by the rules object.

Attributes/Properties
Property Description
length New for Windows Internet Explorer 9  Gets the number of properties that are explicitly set on the parent object.
length Gets or sets the number of objects in a collection.
Methods
Method Description
item Retrieves an object from the rules collection.
Prototypes
Object Description
CSSRuleList Constructor Defines the properties and methods inherited by objects in the CSSRuleList Constructor prototype chain.

Remarks

This collection is always accessible, even if the style sheet is not enabled. Rules are added to the rules collection with the addRule method on the individual style sheet. A rule that is added to a disabled style sheet does not apply to the document unless the style sheet is enabled. Rules are deleted with the removeRule method.

The rules in this collection are in the source order of the document. As rules are added or deleted through the Cascading Style Sheets (CSS) Object Model, a rule's absolute position in the rules collection might change, but its position relative to other rules remains the same. When you add rules without specifying an index, the rule gets added to the document last. If you specify an index, however, the rule is inserted before the rule currently in that ordinal position in the collection. If the specified index is greater than the number of rules in the collection, the rule is added to the end.

Example

This example shows how to use the rules collection to identify the color specified in style sheet rules.


<HTML>
<HEAD>
<SCRIPT>
function ruleColor(ruleIndex) {
    alert("The color of rule " + ruleIndex + " is " +
        document.styleSheets[0].rules.item(ruleIndex).style.color + ".");
}
</SCRIPT>

<STYLE>
.rule0 {color:"red"}
.rule1 {color:"blue"} 
</STYLE>
</HEAD>

<BODY>
<P class="rule0" id="oRule0Span">
    Rule 0 is applied to this line.
</P>
<P class="rule1" id="oRule1Span">
    Rule 1 is applied to this line.
</P>

<BUTTON onclick="ruleColor(0)">Color of Rule 0</BUTTON> 
<BUTTON onclick="ruleColor(1)">Color of Rule 1</BUTTON>

</BODY>
</HTML>

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

Standards Information

This collection is defined in Document Object Model (DOM) Level 1.

Applies To

styleSheet, CSSStyleSheet Constructor