CwSetRegion

Syntax:

call CwSetRegion hEffect, sRegionName

        hEffect         (handle) Handle to the effect to change.

        sRegionName     (string) Name of the region to switch to.

Description:

This procedure replaces the region of an effect with another region. The new region has all of its properties set to default values. If the requested region is the same as the current region, nothing is done.

Available region names are:

"Custom Region" "User Draw" "Ramp" "Ellipse Fade" "Headline Text" "Block Text" "Rectangle" "Ellipse" "Shape"

Example:

/* Create an effect, then change its region to "Block Text". */
w1 = CwCreateEffect("headline text", "color fade")
call CwSetPosition w1, 5.5, 4.25, 5, 4, 0, 0
call CwSetRegion w1, "block text"

Remarks:

If the current region is the same as the requested region, CwSetRegion does nothing. There is a subtle trap here, since the new region is usually reset to its default settings. Since CwSetRegion does nothing if the desired region is already in place, the region retains its old settings.

Functions by NAME

Index

Functions by PURPOSE