DockablePaneState

Public Class

Describes where a dockable pane window should appear in the Revit user interface.

Inheritance Hierarchy

System.Object
Autodesk.Revit.UI.DockablePaneState

Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class DockablePaneState : IDisposable

The DockablePaneState type exposes the following members.

Constructors

Name

Description

Public Method
DockablePaneState.

Creates a new DockablePaneState object.

Public Method
DockablePaneState(DockablePaneState)

Constructs a new copy of the input DockablePaneState object.

Properties

Name

Description

Public Property

DockPosition

Which part of the Revit application frame the pane should dock to.

Public Property

FloatingRectangle

When %dockPosition% is Floating, this rectangle determines the size and position of the pane. Coordinates are relative to the upper-left-hand corner of the main Revit window. Note: the returned Rectangle is a copy. In order to change the pane state, you must call SetFloatingRectangle with a modified rectangle.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Public Property

MinimumHeight

When %dockPosition% is anything other than floating, the minimum height to use for the pane. Default is 200 pixels.

Public Property

MinimumWidth

When %dockPosition% is anything other than floating, the minimum width to use for the pane. Default is 200 pixels.

Public Property

TabBehind

Ignored unless %dockPosition% is Tabbed. The new pane will appear in a tab behind the specified existing pane ID.

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the DockablePaneState

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method

SetFloatingRectangle

When %dockPosition% is Floating, sets the rectangle used to determine the size and position of the pane when %dockPosition% is Floating. Coordinates are relative to the upper-left-hand corner of the main Revit window.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)