Class OverlayArguments

Arguments for the overlay effect

Inheritance

System.Object

OverlayArguments

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Sartorius.SAF.Presentation.Controls

Assembly: Sartorius.SAF.Presentation.Controls.dll

Syntax

public class OverlayArguments

Constructors

OverlayArguments()

Initializes a new empty instance of the OverlayArguments class.

Declaration

public OverlayArguments()

OverlayArguments(IEnumerable<FrameworkElement>)

Initializes a new instance of the OverlayArguments class with the specified excluded elements.

Declaration

public OverlayArguments(IEnumerable<FrameworkElement> excludedElements)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Windows.FrameworkElement>	excludedElements	The excluded elements.

OverlayArguments(FrameworkElement)

Initializes a new instance of the OverlayArguments class that use the specified source reference to only overlay the source window.

Declaration

public OverlayArguments(FrameworkElement sourceReference)

Parameters

Type	Name	Description
System.Windows.FrameworkElement	sourceReference	The source reference.

OverlayArguments(FrameworkElement, IEnumerable<FrameworkElement>)

Initializes a new instance of the OverlayArguments class that use the specified source reference to only overlay the source window and excludes the specified excluded elements.

Declaration

public OverlayArguments(FrameworkElement sourceReference, IEnumerable<FrameworkElement> excludedElements)

Parameters

Type	Name	Description
System.Windows.FrameworkElement	sourceReference	The source reference.
System.Collections.Generic.IEnumerable<System.Windows.FrameworkElement>	excludedElements	The excluded elements.

Properties

ExcludedElements

Gets the excluded elements.

Declaration

public ICollection<FrameworkElement> ExcludedElements { get; }

Property Value

Type	Description
System.Collections.Generic.ICollection<System.Windows.FrameworkElement>	The excluded elements.

Remarks

These elements will not be overlaid.

Force

Gets or sets a value indicating whether this OverlayArguments is forcing overlay over windows that do not allow an overlay.

Declaration

public bool Force { get; set; }

Property Value

Type	Description
System.Boolean	true if force; otherwise, false.

SourceReference

Gets or sets the source reference.

Declaration

public FrameworkElement SourceReference { get; set; }

Property Value

Type	Description
System.Windows.FrameworkElement

Remarks

This element is used to find the source window when Type is set to SourceWindow.

Type

Gets or sets the type of overlay.

Declaration

public OverlayType Type { get; set; }

Property Value

Type	Description
OverlayType	The type of overlay.

Remarks

When this is set to SourceWindow the SourceReference is used to find the source window to overlay.

Extension Methods

CollectionExtensions.AddRange<T, TCollection>(TCollection, IEnumerable<T>)

SerializableObjectCloneExtension.Clone<T>(T)

See Also

IOverlayEffect

OverlayType