GridSplitter.ShowsPreview Property

Definition

Gets or sets a value that indicates whether the GridSplitter control updates the column or row size as the user drags the control.

public:
 property bool ShowsPreview { bool get(); void set(bool value); };
public bool ShowsPreview { get; set; }
member this.ShowsPreview : bool with get, set
Public Property ShowsPreview As Boolean

Property Value

true if a GridSplitter preview is displayed; otherwise, false. The default is false.

Examples

The following example shows how to set the ShowsPreview property.

myGridSplitter.ShowsPreview = true;
myGridSplitter.ShowsPreview = True
<GridSplitter ShowsPreview="True" Width="5"
              Grid.Column="4" Grid.RowSpan="2"/>

Remarks

A GridSplitter requires an AdornerDecorator object to be present in its parent tree in order to display drag preview feedback. This requirement is typically met by the AdornerDecorator object that is available in the default style for the Window or in the AdornerDecorator object that is created by a ScrollViewer object. However, if neither of these is available, the GridSplitter control must define its own AdornerDecorator object.

Dependency Property Information

Item Value
Identifier field ShowsPreviewProperty
Metadata properties set to true None

When the ShowsPreview property is set to true, a preview of the change in the row or column sizes is shown. The actual size changes when the GridSplitter is released. If the property is set to false, the column or row sizes are updated in real time as the user drags the GridSplitter control.

If the keyboard is used to move the GridSplitter control, column or row sizes are updated in real time even if the ShowsPreview property is set to true.

Applies to