Iris Filter

This topic documents a feature of Visual Filters and Transitions, which is deprecated as of Windows Internet Explorer 9.

Reveals new content of the object with an iris effect, similar to the opening of a camera aperture.

Syntax

HTML	<ELEMENT STYLE="filter:progid:DXImageTransform.Microsoft.Iris(sProperties)" ... >	Internet Explorer 5.5 or later
Scripting	object.style.filter ="progid:DXImageTransform.Microsoft.Iris(sProperties)"	Internet Explorer 5.5 or later

Possible Values

sProperties

String that specifies one or more properties exposed by the filter.

Members Table

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

Attribute	Property	Description
duration	Duration	Sets or retrieves the length of time the transition takes to complete.
enabled	Enabled	Sets or retrieves a value that indicates whether the filter is enabled.
irisStyle	IrisStyle	Sets or retrieves the shape of the Iris filter aperture.
motion	Motion	Sets or retrieves the value that indicates whether new content is revealed from the outside or the inside first.
	Percent	Sets or retrieves the point in a transition at which to capture the display for a static filter output.
	status	Retrieves the state of the transition.

Method	Description
apply	Captures the initial display of an object's content for a transition.
play	Plays the transition.
stop	Stops the transition playback.

Remarks

The object that the filter is applied to must have layout before the filter effect displays. You can give the object layout by setting the height or width property, setting the position property to absolute, setting the writingMode property to tb-rl, or setting the contentEditable property to true.

You can assign multiple filters or transitions to an object by declaring each in the filter property of the object. The following div declaration assigns two filters and a Wheel transition to a div element.

<DIV STYLE="width:100%; filter:
    progid:DXImageTransform.Microsoft.MotionBlur(strength=13, direction=310)
    progid:DXImageTransform.Microsoft.Blur(pixelradius=2)
    progid:DXImageTransform.Microsoft.Wheel(duration=3);">
        Blurry text with smudge of gray.</div>     

When multiple filters are applied to an object, each filter is processed in source order, with the exception of procedural surfaces, which are computed first. To emphasize a filter's effect, place it last in source order or on the object's parent. Always place transitions last in source order.

Examples

The following example shows how to change the effects of this transition by modifying its properties.

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/filter/Iris.htm

This example cycles through each IrisStyle property option.

<SCRIPT>
<!-- Declare an array and index counter to access IrisStyles. -->
var arrIrisStyles = new Array();
arrIrisStyles = ['DIAMOND','CIRCLE','CROSS','PLUS','SQUARE','STAR'];
var iIndexCount = 0;

var bToggle = 0;

function fnToggle() {

<!-- Use the array index to update and display  the IrisStyle used. -->
var  iStyleIndex = iIndexCount%6 ;  // MOD function avoids resetting the counter.
    oDiv.filters[0].irisstyle = arrIrisStyles[iStyleIndex];
    oSpan.innerText = 'IrisStyle = "' + arrIrisStyles[iStyleIndex] + '"';
    
    oDiv.filters[0].Apply();                   
// After setting Apply, changes to the oDiv object 
//  are not displayed until Play is called.

    if (bToggle) {                                                        
        bToggle = 0;
        oDiv.style.backgroundColor="gold"; 
    }
    else {
        bToggle = 1;
        oDiv.style.backgroundColor="green";    
    }  
        
    oDiv.filters[0].Play();
    iIndexCount += 1;
}
</SCRIPT>
<BUTTON onclick="fnToggle()">Toggle Transition</BUTTON><BR/><BR/>

<FONT SIZE="+4" >
<!-- This DIV is the target of the transition. -->
    <DIV ID="oDiv" STYLE="height:250px; width:250px; background-color: gold;
                filter:progid:DXImageTransform.Microsoft.Iris(
                duration=3);">
        TEXT<BR/>TEXT<BR/>TEXT<BR/>TEXT<BR/>
    </DIV>

<SPAN ID="oSpan"></SPAN> 

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/filter/shortSamples/irisEX1.htm

Applies To

A, ABBR, ACRONYM, ADDRESS, B, BDO, BIG, BLOCKQUOTE, BODY, BUTTON, CAPTION, CENTER, CITE, CODE, CUSTOM, DD, DEL, DFN, DIR, DIV, DL, DT, EM, FIELDSET, FONT, FORM, FRAME, hn, IFRAME, FRAMESET, I, INS, IMG, INPUT type=button, INPUT type=checkbox, INPUT type=file, INPUT type=image, INPUT type=password, INPUT type=radio, INPUT type=reset, INPUT type=submit, INPUT type=text, KBD, LABEL, LEGEND, LI, MARQUEE, MENU, NOBR, OL, OBJECT, P, PLAINTEXT, PRE, Q, RT, RUBY, S, SAMP, SMALL, SPAN, STRIKE, STRONG, SUB, SUP, TABLE, TEXTAREA, TH, TD, TT, U, UL, VAR, XMP

See Also

Transitions, Transition Design Considerations