Click or drag to resize

IMcGraphOverlay2LayerOpacity Property

Reflects and sets the opacity of one or all Layers.

Namespace:  MediaCy.IQL.Display.Overlays
Assembly:  MediaCy.IQL.Display.Overlays (in MediaCy.IQL.Display.Overlays.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Property LayerOpacity ( 
	Optional Layer As Integer = -1
) As Object
	Get
	Set

Parameters

Layer (Optional)
Type: SystemInt32
If given, the Layer number, from 0 through 9, for which the opacity is being accessed or set. If not given or given as -1 or -2, then the opacity of all layers is being accessed or set. In this case on access, the property value will be an array of long values, one for each layer. On assignment, either a scalar long value or an array of values may be supplied; if a scalar value is supplied, it is applied to all layers; if an array is supplied array values are applied to each layer, starting with layer zero. If necessary, this argument is silently clipped to the range from -2 to 9. On assignment, the LastTargetLayer property is set to this value. If the Layer is -2, then no PropertyChanged notification will be set. This is used where a temporary dimming of the overlay is desired.

Property Value

Type: Object
Remarks
LayerOpacity is expressed as a percentage from zero (invisible) to 100 (opaque, which is the usual state). Values assigned outside the range from zero to 100 are silently truncated to those limits. Assigning a value of zero is legal, but renders the layer completely invisible; this has the same effect as setting the LayerVisible property False for the layer (but is much less efficient and potentially much more confusing). Each McGraphObj has its own McGraphObj.Opacity property which is combined with its Layer's LayerOpacity to determine the overall opacity of the object. The formula used is (fLayerOpacity*fOpacity)*100, where fLayerOpacity is LayerOpacity/100 and fOpacity is McGraphObj.Opacity/100. So if LayerOpacity and McGraphObj.Opacity are both 100, overall opacity is 100 (opaque) if either LayerOpacity or McGraphObj.Opacity is zero, then overall opacity is zero (invisible). If LayerOpacity and McGraphObj.Opacity are both 50, then overall opacity is 25 (very wispy) if either one is 100 and the other is less than 100, then overall opacity will be the less than 100 value. This property takes an argument to specify which layer (or all layers) are being accessed or set. Thus, on assignment it is possible to set the LayerOpacity of all layers to the same value.
See Also