LayoutViewOptionsBehavior.AllowPanCards Property

Gets or sets whether the card panning feature can be enabled.

Namespace: DevExpress.XtraGrid.Views.Layout

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

[DefaultValue(true)]
[XtraSerializableProperty]
public virtual bool AllowPanCards { get; set; }

VB.NET

<DefaultValue(True)>
<XtraSerializableProperty>
Public Overridable Property AllowPanCards As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true if card panning is supported; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to AllowPanCards
LayoutView	.OptionsBehavior.AllowPanCards

Remarks

The panning feature makes it easy to scroll cards that are partially visible. When card panning is active, the mouse cursor changes its image to a ‘hand’, and an end-user can scroll the View by clicking it and dragging in the desired direction. In panning mode, data editing is disabled.

The LayoutView.PanModeActive property returns whether the panning mode is currently active. To enable or disable card panning, use the LayoutView.PanModeSwitch method.

The panning feature is supported when any card is partially visible, and the AllowPanCards property is set to true.

A card can be partially visible in the following instances:

• there is not enough space to display the card in its entirety (when the LayoutViewOptionsView.CardArrangeRule is set to LayoutCardArrangeRule.ShowWholeCards);
• the LayoutViewOptionsView.CardArrangeRule property is set to LayoutCardArrangeRule.AllowPartialCards.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowPanCards property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-provide-the-capability-of-adding-custom-buttons-to-the-layoutview-header-panel-e3692/CS/LayoutViewCustomButtonContent/LayoutViewCustomButtonPainter.cs#L31

PrepareCarouselModeButton(e, buttons);
if (View.OptionsBehavior.AllowPanCards) PreparePanButton(e, buttons);
if (View.OptionsBehavior.AllowRuntimeCustomization) PrepareCustomizeButton(e, buttons);