Method RemoveOverlay

Namespace

Alternet.UI

Assembly

Alternet.UI.Common.dll

RemoveOverlay(ref ObjectUniqueId?, bool)

Removes the overlay with the specified identifier from the collection. After removal, sets the identifier to null.

public bool RemoveOverlay(ref ObjectUniqueId? overlayId, bool invalidate = true)

Parameters

overlayId ObjectUniqueId?

A reference to the unique identifier of the overlay to remove. The value is set to null if the overlay is successfully removed.

invalidate bool

true to invalidate the display after removing the overlay; otherwise, false. The default is true.

Returns

bool

true if the overlay was found and removed; otherwise, false.

RemoveOverlay(ObjectUniqueId?, bool)

Removes an overlay with the specified unique identifier from the overlays collection.

public virtual bool RemoveOverlay(ObjectUniqueId? overlayId, bool invalidate = true)

Parameters

overlayId ObjectUniqueId?

The unique identifier of the overlay to remove.

invalidate bool

A value indicating whether to invalidate the control after removing the overlay. If true, the control is invalidated; otherwise, it is not.

Returns

bool

true if the overlay was successfully removed; otherwise, false.

RemoveOverlay(IControlOverlay, bool)

Removes the specified overlay from the control.

public virtual bool RemoveOverlay(IControlOverlay overlay, bool invalidate = true)

Parameters

overlay IControlOverlay

The overlay to remove.

invalidate bool

The bool indicating whether to invalidate the control.

Returns

bool

true if the overlay was successfully removed; otherwise, false.