The basic usage of AvalonDock

1 year ago
Noah Thompson
2 minutes

AvalonDock is an open-source WPF control library used to create customizable multiple window user interfaces in applications. Here is a basic usage of AvalonDock:

  1. Utilize the AvalonDock library: In your project, incorporate a reference to the AvalonDock library. You can download and install AvalonDock from NuGet.
  2. Create a layout file: Use XAML to create a layout file that defines the structure and layout of the AvalonDock container. You can utilize layout controls provided by AvalonDock, such as DockingManager, LayoutAnchorablePane, and LayoutDocumentPane.
<avalonDock:DockingManager x:Name="dockManager">
    <avalonDock:LayoutRoot>
        <avalonDock:LayoutPanel Orientation="Horizontal">
            <avalonDock:LayoutDocumentPaneGroup>
                <avalonDock:LayoutDocumentPane>
                    <avalonDock:LayoutDocument Title="Document 1">
                        <TextBlock Text="Content of Document 1"/>
                    </avalonDock:LayoutDocument>
                </avalonDock:LayoutDocumentPane>
            </avalonDock:LayoutDocumentPaneGroup>
            <avalonDock:LayoutAnchorablePaneGroup>
                <avalonDock:LayoutAnchorablePane>
                    <avalonDock:LayoutAnchorable Title="Tool Window 1">
                        <TextBlock Text="Content of Tool Window 1"/>
                    </avalonDock:LayoutAnchorable>
                </avalonDock:LayoutAnchorablePane>
            </avalonDock:LayoutAnchorablePaneGroup>
        </avalonDock:LayoutPanel>
    </avalonDock:LayoutRoot>
</avalonDock:DockingManager>
  1. Load layout in code: loading layout file in code.
dockManager.LoadLayout(layoutFilePath);
  1. Save layout: At the appropriate time, the current layout can be saved to a file.
dockManager.SaveLayout(layoutFilePath);
  1. Dynamically create and remove layouts: Layouts can be created and removed dynamically at runtime.
// 创建一个LayoutDocument
var document = new LayoutDocument();
document.Title = "New Document";
document.Content = new TextBlock() { Text = "Content of New Document" };

// 将LayoutDocument添加到LayoutDocumentPane中
var documentPane = dockManager.Layout.Descendents().OfType<LayoutDocumentPane>().FirstOrDefault();
documentPane.Children.Add(document);

// 移除一个LayoutDocument
var documentToRemove = dockManager.Layout.Descendents().OfType<LayoutDocument>().FirstOrDefault(x => x.Title == "Document 1");
documentToRemove.Parent.Children.Remove(documentToRemove);

The above is the basic usage of AvalonDock, you can further customize and expand according to your own needs.

bannerAds