OptionsLayoutBase Class

Represents the base class for classes which contain the options that are responsible for how the control’s layout is stored to and restored from storage (a stream, xml file or system registry).

Namespace: DevExpress.Utils

Assembly: DevExpress.Data.v18.1.dll

Declaration

C#

public class OptionsLayoutBase :
    BaseOptions

VB.NET

Public Class OptionsLayoutBase
    Inherits BaseOptions

Related API Members

The following members accept/return OptionsLayoutBase objects:

Library	Related API Members
Cross-Platform Class Library	OptionsLayoutBase.FullLayout
WinForms Controls	BaseView.OptionsLayout
	SchedulerControl.OptionsLayout

Remarks

Specific controls provide options that determine how the control’s layout is stored to and restored from storage (a stream, xml file or system registry). OptionsLayoutBase is the base class for the classes that encapsulate such options.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the OptionsLayoutBase class.

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-include-custom-data-in-the-gridviews-saving-and-restoring-layout-mechanism-e2522/CS/Serialization/MyXmlXtraSerializer.cs#L19

protected override void DeserializeObject(object obj, IXtraPropertyCollection store, OptionsLayoutBase options)
{

how-to-save-load-field-values-collapsed-states-together-with-pivot-grids-layout-e20014/CS/XtraPivotGrid_SaveLoadCollapsedState/Form1.cs#L24

layoutStream = new MemoryStream();
pivotGridControl1.SaveLayoutToStream(layoutStream, OptionsLayoutBase.FullLayout);
collapseStateStream.Dispose();

how-to-customize-the-resulting-file-during-printing-exporting-gridcontrol-e2722/CS/WindowsApplication1/GridExportHelper.cs#L60

    layoutStream.Position = 0;
    ExportedView.RestoreLayoutFromStream(layoutStream, OptionsLayoutBase.FullLayout);
}

how-to-prevent-pivotgridfieldoptions-property-from-being-serialized-e2230/CS/DxSample/MyPivotGrid.cs#L21

protected override bool OnAllowSerializationProperty(DevExpress.Utils.OptionsLayoutBase options, string propertyName, int id) {
    if(propertyName == "Options")

how-to-save-a-layout-of-layoutcontrol-together-with-its-child-controls-t131174/CS/WindowsApplication3/Serializer.cs#L195

protected override void SerializeProperty(XtraPropertyInfoCollection store, object obj, SerializablePropertyDescriptorPair pair, XtraSerializationFlags parentFlags, DevExpress.Utils.OptionsLayoutBase options)
{

VB.NET

how-to-include-custom-data-in-the-gridviews-saving-and-restoring-layout-mechanism-e2522/VB/Serialization/MySerializeHelper.vb#L18

Protected Overrides Function SerializeObjectCore(ByVal obj As Object, ByVal parentFlags As XtraSerializationFlags, ByVal options As OptionsLayoutBase) As IXtraPropertyCollection
    If rootObject Is Nothing OrElse Not(TypeOf rootObject Is MyGridView) Then

how-to-save-load-field-values-collapsed-states-together-with-pivot-grids-layout-e20014/VB/XtraPivotGrid_SaveLoadCollapsedState/Form1.vb#L24

layoutStream = New MemoryStream()
pivotGridControl1.SaveLayoutToStream(layoutStream, OptionsLayoutBase.FullLayout)
collapseStateStream.Dispose()

how-to-customize-the-resulting-file-during-printing-exporting-gridcontrol-e2722/VB/GridExportHelper.vb#L49

    layoutStream.Position = 0
    ExportedView.RestoreLayoutFromStream(layoutStream, OptionsLayoutBase.FullLayout)
End Sub

how-to-prevent-pivotgridfieldoptions-property-from-being-serialized-e2230/VB/DxSample/MyPivotGrid.vb#L32

Protected Overrides Function OnAllowSerializationProperty(ByVal options As DevExpress.Utils.OptionsLayoutBase, ByVal propertyName As String, ByVal id As Integer) As Boolean
    If propertyName = "Options" Then

how-to-save-a-layout-of-layoutcontrol-together-with-its-child-controls-t131174/VB/WindowsApplication3/Serializer.vb#L189

Protected Overrides Sub SerializeProperty(ByVal store As XtraPropertyInfoCollection, ByVal obj As Object, ByVal pair As SerializablePropertyDescriptorPair, ByVal parentFlags As XtraSerializationFlags, ByVal options As DevExpress.Utils.OptionsLayoutBase)
    Dim prop As PropertyDescriptor = pair.Property

Inheritance

Show 11 items

Object

ViewStatePersisterCore

BaseOptions

OptionsLayoutBase

OptionsLayoutGrid

PivotGridOptionsLayout

VGridOptionsLayout

OptionsLayoutTreeList

WinExplorerViewOptionsLayout

BarManagerOptionsLayout

PivotGridWebOptionsLayout