ColumnView.OptionsLayout Property

Provides options which control how the current View’s layout is stored to/restored from a data store (a stream, xml file or system registry).

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v20.2.dll

NuGet Package: DevExpress.Win.Grid

Declaration

C#

[DXCategory("Options")]
public OptionsLayoutGrid OptionsLayout { get; }

VB.NET

<DXCategory("Options")>
Public ReadOnly Property OptionsLayout As OptionsLayoutGrid

Property Value

Type	Description
OptionsLayoutGrid	A OptionsLayoutGrid descendant which provides options for controlling how the layout is stored and restored.

Remarks

The OptionsLayout object provides a number of options that control how the current View’s layout is stored to and restored from a data store (a stream, xml file or system registry).

The LayoutView doesn’t support restoring a field if there is no corresponding bound column. The OptionsColumnLayout.RemoveOldColumns option must be set to true.

Note

All objects (columns, bands, etc) in the layout are identified by their names.

See the Layout Options (XtraGrid, XtraPivotGrid) topic, for information on the options.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the OptionsLayout 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-restore-only-specific-views-settings-from-the-previously-stored-layout-file-e2841/CS/FilterDeserializer/FilterDeserializer.cs#L21

    IXtraPropertyCollection collection = Instance.Deserialize(file, "View", null);
    Instance.DeserializeObject(view, GetFilterCollection(view, collection), view.OptionsLayout);
}

VB.NET

how-to-restore-only-specific-views-settings-from-the-previously-stored-layout-file-e2841/VB/FilterDeserializer/FilterDeserializer.vb#L24

    Dim collection As IXtraPropertyCollection = Instance.Deserialize(file, "View", Nothing)
    Instance.DeserializeObject(view, GetFilterCollection(view, collection), view.OptionsLayout)
End Sub