Skybound VisualTips

VisualTipRenderer.CreateMaskRegion Method 

Creates a new Region used as the visible window region for a tip window. A return value of null indicates that no special masking region is required by the tip.

[Visual Basic]
Public Function CreateMaskRegion( _
   ByVal tip As VisualTip, _
   ByVal layout As VisualTipLayout _
) As Region
[C#]
public Region CreateMaskRegion(
   VisualTip tip,
   VisualTipLayout layout
);

Parameters

tip
The VisualTip whose mask region is returned.
layout
A VisualTipLayout which defines the location of various elements on the tip -or- a null reference to use the default layout (obtained by calling CreateLayout).

Return Value

The Region used as the visible window region for the tip window, or a null reference.

Remarks

This method may not be overridden; to provide a custom mask region, override the OnCreateMaskRegion method instead.

Exceptions

Exception Type Condition
ArgumentNullException The tip parameter may not be a null reference.
ArgumentException The specified tip must be associated with a VisualTipProvider before it is rendered.

See Also

VisualTipRenderer Class | Skybound.VisualTips.Rendering Namespace