TdxCustomDockControl.CanMaximize Method

Returns a value indicating whether the dock control can be maximized.

Declaration

function CanMaximize: Boolean; virtual;

Returns

Type
Boolean

Remarks

When dock controls are within a side container, they can be maximized to fill the entire container’s client area. End-users can perform this by clicking the maximize button displayed within the control’s caption (see the CaptionButtons property for details). This can also be performed via code by assigning the control’s DockIndex property value to the ActiveChildIndex property of the owning side container.

The CanMaximize method’s return value indicates whether the maximize button can be displayed within the control’s caption. If this method returns True, the maximize button is displayed when the control is within a side container.

As implemented in the TdxCustomDockControl class, the CanMaximize method simply returns False. The TdxDockPanel and TdxTabContainerDockSite classes override this method to return True when the control is within a side container.

Normally, you will have no need to use this method in applications.