Back to Devexpress

Document.MaximizedControl Property

windowsforms-devexpress-dot-xtrabars-dot-docking2010-dot-views-dot-widget-dot-document-9f797547.md

latest4.4 KB
Original Source

Document.MaximizedControl Property

Gets or sets the control displayed within this Document in its maximized state.

Namespace : DevExpress.XtraBars.Docking2010.Views.Widget

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue(null)]
[DXCategory("Behavior")]
public Control MaximizedControl { get; set; }
vb
<DefaultValue(Nothing)>
<DXCategory("Behavior")>
Public Property MaximizedControl As Control

Property Value

TypeDefaultDescription
Controlnull

A Control that is the Document‘s content in its maximized state.

|

Remarks

End-users can maximize Documents at runtime by double-clicking Document Headers, or clicking the corresponding Maximize button at the Document’s top right corner. To enable or disable this behavior, use the IDocumentDefaultProperties.CanMaximize property. While in their normal state, Widget Documents display the content assigned to the BaseDocument.Control property, and maximized Documents can display other content, assigned to the MaximizedControl property. You can use this feature to display a content preview for normal state Documents and full content for maximized Documents. If the MaximizedControl property is not specified, a maximized Document receives the same content as in its normal state. The animation below illustrates a Document displaying different content in its normal and maximized states.

See the Widget View topic for the details.

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the MaximizedControl 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.

winforms-create-widgetview-runtime/CS/WidgetViewExample/Form1.cs#L56

csharp
Document document = view.AddDocument(new ucPreview()) as Document;
document.MaximizedControl = new ucMaximizedContent();
count++;

winforms-create-widgetview-runtime/VB/WidgetViewExample/Form1.vb#L57

vb
Dim document As Document = TryCast(view.AddDocument(New ucPreview()), Document)
document.MaximizedControl = New ucMaximizedContent()
count += 1

See Also

CanMaximize

Widget View

Document Class

Document Members

DevExpress.XtraBars.Docking2010.Views.Widget Namespace