Skip to content

EnableDocking Method

Description

Enables docking of the Ribbon Bar to different edges of the form.

Syntax

Public Sub EnableDocking( _
    ByVal dwFlags As XTPToolBarFlags _
)

Parameters

  • dwFlags: Specifies the edges of the form to which the Ribbon Bar can be docked.

Flag Descriptions

  • xtpFlagAlignTop
  • For a Toolbar: Specifies that the command bar can be docked to the top edge of the form.
  • For a DialogBar: Specifies that the dialog bar can be docked to the top edge of the form.

  • For a RibbonBar: Specifies that the Ribbon Bar can be docked to the top edge of the form.

  • xtpFlagAlignBottom

  • For a Toolbar: Specifies that the command bar can be docked to the bottom edge of the form.
  • For a DialogBar: Specifies that the dialog bar can be docked to the bottom edge of the form.

  • For a RibbonBar: Specifies that the Ribbon Bar can be docked to the bottom edge of the form.

  • xtpFlagAlignLeft

  • For a Toolbar: Specifies that the command bar can be docked to the left edge of the form.
  • For a DialogBar: Specifies that the dialog bar can be docked to the left edge of the form.

  • For a RibbonBar: Not used with Ribbon Bar.

  • xtpFlagAlignRight

  • For a Toolbar: Specifies that the command bar can be docked to the right edge of the form.
  • For a DialogBar: Specifies that the dialog bar can be docked to the right edge of the form.

  • For a RibbonBar: Not used with Ribbon Bar.

  • xtpFlagAlignAny

  • For a Toolbar: Specifies that the command bar can be docked to any edge of the form. When the command bar width is larger than the window width, the controls that cannot be displayed WILL wrap below the command bar.
  • For a DialogBar: Specifies that the dialog bar can be docked to any edge of the form.

  • For a RibbonBar: Not used with Ribbon Bar.

  • xtpFlagFloating

  • For a Toolbar: Specifies that the command bar can be a floating command bar.
  • For a DialogBar: Specifies that the dialog bar can be a floating dialog bar.

  • For a RibbonBar: Not used with Ribbon Bar.

  • xtpFlagHideWrap

  • For a Toolbar: Specifies that when the command bar width is larger than the window width, the controls that cannot be displayed will NOT wrap below the command bar. A chevron control will be placed at the end of the command bar to allow you to access the hidden controls.
  • For a DialogBar: Not used in dialog bar.

  • For a RibbonBar: Not used with Ribbon Bar.

  • xtpFlagStretched

  • For a Toolbar: Specifies that the command bar is stretched across the entire window. Only one Toolbar can occupy a row with the xtpFlagStretched flag.
  • For a DialogBar: The CaptionPopupBar is stretched within the dialog bar and cannot be changed. This flag is not used in the dialog bar.

  • For a RibbonBar: Specifies that the Ribbon Bar is stretched across the entire window. Only the Ribbon Bar can occupy the row with the xtpFlagStretched flag.

  • xtpFlagStretchedShared

  • For a Toolbar: Specifies that the ToolBar will stretch the entire available width. If the Toolbar is the only Toolbar on the row, then it will stretch the entire row. If there are multiple Toolbars on the row, then the Toolbar will stretch the remaining available area. This is different from the xtpFlagStretched flag in that it allows multiple Toolbars on a row, whereas the xtpFlagStretched flag only allows one.

  • xtpFlagSmartLayout: Enables smart layout.

Remarks

After adding a RibbonBar, the EnableDocking method should be used to disable docking by using the xtpFlagStretched flag or by using a zero (0). If docking is desired, the Ribbon Bar can only be docked to the top or bottom of the application.

See Also

Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.