Class OverlayEffect
Implements functionality to overlay wpf controls of type System.
Inheritance
Implements
Namespace: Sartorius.SAF.Presentation.Controls
Assembly: Sartorius.SAF.Presentation.Controls.dll
Syntax
public sealed class OverlayEffect : DependencyObject, IOverlayEffect
Remarks
The Overlay
The Overlay
The instance of the Overlay
See IOverlay
Examples
The following example shows how a style can manipulate the layout of a control when it is overlaid by an Overlay
<Style x:Key="DataGridStyle" TargetType="DataGrid">
<Style.Triggers>
<Trigger Property="SAF:OverlayEffect.IsOverlayed" Value="True">
<Setter Property="IsEnabled" Value="False" />
<Setter Property="CellStyle" Value="{StaticResource OverlayedCellStyle}" />
</Trigger>
</Style.Triggers>
</Style>
Fields
View SourceIsAllowedProperty
Identifies the System.
Declaration
public static readonly DependencyProperty IsAllowedProperty
Field Value
Type | Description |
---|---|
System. |
IsOverlayedProperty
Identifies the System.
Declaration
public static readonly DependencyProperty IsOverlayedProperty
Field Value
Type | Description |
---|---|
System. |
Properties
View SourceInstance
Gets the singleton instance of the Overlay
Declaration
public static IOverlayEffect Instance { get; }
Property Value
Type | Description |
---|---|
IOverlay |
Methods
View SourceApply()
Applies an overlay effect to all application windows that don't have an overlay effect yet.
Declaration
public IDisposable Apply()
Returns
Type | Description |
---|---|
System. |
An instance of System. |
Remarks
Windows that have Overlayfalse
will not get overlaid.
Apply(OverlayArguments)
Applies an overlay according to the specified Overlay
Declaration
public IDisposable Apply(OverlayArguments arguments)
Parameters
Type | Name | Description |
---|---|---|
Overlay |
arguments | The Overlay |
Returns
Type | Description |
---|---|
System. |
An instance of System. |
Remarks
In MVVM scenarios consider to use the Overlay
See Also
View SourceGetIsAllowed(Window)
Gets a System.
Declaration
[AttachedPropertyBrowsableForType(typeof(Window))]
public static bool GetIsAllowed(Window window)
Parameters
Type | Name | Description |
---|---|---|
System. |
window | The element. |
Returns
Type | Description |
---|---|
System. |
a System. |
See Also
View SourceGetIsOverlayed(DependencyObject)
Gets a value indicating whether the element
is currently overlaid by an overlay effect.
Declaration
public static bool GetIsOverlayed(DependencyObject element)
Parameters
Type | Name | Description |
---|---|---|
System. |
element | The element. |
Returns
Type | Description |
---|---|
System. |
SetIsAllowed(Window, Boolean)
Sets a System.
Declaration
[AttachedPropertyBrowsableForType(typeof(Window))]
public static void SetIsAllowed(Window window, bool value)
Parameters
Type | Name | Description |
---|---|---|
System. |
window | The window for which to set the Sartorius. |
System. |
value | If set to |
Remarks
The default is true
.
When an overlay effect is configured to use the window as source window by setting Source