GradientWipe 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 by passing a gradient band over the original content.

Syntax

HTML	<ELEMENT STYLE="filter:progid:DXImageTransform.Microsoft.GradientWipe(sProperties)" ... >	Internet Explorer 5.5 or later
Scripting	object.style.filter ="progid:DXImageTransform.Microsoft.GradientWipe(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 GradientWipe 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.
gradientSize	GradientSize	Sets or retrieves the percentage of the object that is covered by the gradient band.
motion	Motion	Sets or retrieves a value that indicates whether content is revealed as defined by the WipeStyle property setting, or in the opposite direction.
	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.
	WipeStyle	Sets or retrieves a value that indicates whether the gradient band moves vertically or horizontally.

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 will display. 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/Wipe.htm

This example uses the backgroundColor property to change the display before each transition is played.

<SCRIPT>
var bToggle = 0;
function fnToggle() {
    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="orange";}
    else {
        bToggle = 1;
        oDiv.style.backgroundColor="blue";}  
    oDiv.filters[0].Play();
}
</SCRIPT>

<BUTTON onclick="fnToggle()">Toggle Transition</BUTTON><BR/><BR/>
<DIV ID="oDiv" STYLE="height:250px; width:250px; background-color: orange;
                filter:progid:DXImageTransform.Microsoft.gradientWipe(
                duration=3, gradientsize=0.5);">
</DIV>

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/filter/shortsamples/gradientWipeEX1.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