Skip to main content

BaseLayoutItem Properties

Represents the base class for dock panels and groups.
Name Description
ActualCaption

Gets the item’s actual caption, taking into account the BaseLayoutItem.CaptionFormat. This is a dependency property.

ActualCaptionWidth

Gets the actual width of the item’s caption. This is a dependency property.

ActualHeight Gets the rendered height of this element. Inherited from FrameworkElement.
ActualMargin

Gets the actual margins (outer indents) for the current item. This is a dependency property.

ActualMaxSize This member supports the internal infrastructure, and is not intended to be used directly from your code.
ActualMinSize This member supports the internal infrastructure, and is not intended to be used directly from your code.
ActualPadding

Gets the actual padding (inner indents) for the current item. This is a dependency property.

ActualTabCaption Gets the actual text displayed in the tab (when the current item is represented as a tab page).
ActualWidth Gets the rendered width of this element. Inherited from FrameworkElement.
AllowActivate

Gets or sets whether the item can be activated. This is a dependency property.

AllowClose

Gets or sets whether the current dock item can be closed. This is a dependency property.

AllowContextMenu Gets or sets whether a context menu is enabled for the current layout item. This is a dependency property.
AllowDock

Gets or sets whether the dock item can be docked to another item (panel or group). This is a dependency property.

AllowDockToCurrentItem Gets or sets whether a panel can be merged as a tab into the current item. This is a dependency property.
AllowDrag

Gets or sets whether the layout item may be dragged. This is a dependency property.

AllowDrop Gets or sets a value indicating whether this element can be used as the target of a drag-and-drop operation. This is a dependency property. Inherited from UIElement.
AllowFloat

Gets or sets whether the dock item can float. This is a dependency property.

AllowHide Gets or sets whether the item can be hidden (auto-hidden, for dock items). This is a dependency property.
AllowMaximize Gets or sets whether the current item can be maximized. This property is supported for floating LayoutPanel and DocumentPanel objects.
AllowMinimize Gets or sets whether the current item can be minimized. This property is supported for floating DocumentPanel objects.
AllowMove

Gets or sets whether the item is allowed to be moved. This is a dependency property.

AllowRename

Allows you to prevent an item’s caption from being renamed when the DockLayoutManager.AllowLayoutItemRename option is enabled. This is a dependency property.

AllowRestore

Gets or sets whether the item can be restored from the hidden state. This is a dependency property.

AllowSelection

Gets or sets whether the current layout item can be selected in Customization Mode. This is a dependency property.

AllowSizing Gets or sets if the BaseLayoutItem resizing at runtime is enabled.
Appearance Gets or sets the object that provides appearance settings for the item’s captions. This is a dependency property.
AreAnyTouchesCaptured Gets a value that indicates whether at least one touch is captured to this element. Inherited from UIElement.
AreAnyTouchesCapturedWithin Gets a value that indicates whether at least one touch is captured to this element or to any child elements in its visual tree. Inherited from UIElement.
AreAnyTouchesDirectlyOver Gets a value that indicates whether at least one touch is pressed over this element. Inherited from UIElement.
AreAnyTouchesOver Gets a value that indicates whether at least one touch is pressed over this element or any child elements in its visual tree. Inherited from UIElement.
Background Gets or sets the layout item’s background color.
BindableName Gets or sets a value passed to the BaseLayoutItem Name property. This is a dependency property.
BindingGroup Gets or sets the BindingGroup that is used for the element. Inherited from FrameworkElement.
BitmapEffect Gets or sets a bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
BitmapEffectInput Gets or sets an input source for the bitmap effect that applies directly to the rendered content for this element. This is a dependency property. Inherited from UIElement.
BorderBrush Gets or sets a brush that describes the border background of a control. Inherited from Control.
BorderThickness Gets or sets the border thickness of a control. Inherited from Control.
CacheMode Gets or sets a cached representation of the UIElement. Inherited from UIElement.
Caption Gets or sets the layout item’s caption.
CaptionAlignMode

Gets or sets the alignment settings of a control(s) displayed by a LayoutControlItem object(s). This is a dependency property.

CaptionFormat

Gets or sets the format string used to format the layout item’s caption. This is a dependency property.

CaptionHorizontalAlignment Gets or sets the item Caption‘s horizontal alignment. This is a dependency property.
CaptionImage Gets or sets the image displayed within the item’s Caption. This is a dependency property.
CaptionImageLocation

Gets or sets the relative position of an image within the item’s caption. This is a dependency property.

CaptionImageStyle Gets or sets the caption image style. This is a dependency property.
CaptionLocation Gets or sets the position of the item’s Caption. This is a dependency property.
CaptionTemplate Gets or sets the template used to visualize the current item’s BaseLayoutItem.Caption.
CaptionTemplateSelector Gets or sets an object that chooses a template applied to the BaseLayoutItem.CaptionTemplate property. This is a dependency property.
CaptionVerticalAlignment

Gets or sets the vertical alignment of the item’s caption. This is a dependency property.

CaptionWidth Gets or sets the width of the item’s Caption area. This is a dependency property.
Clip Gets or sets the geometry used to define the outline of the contents of an element. This is a dependency property. Inherited from UIElement.
ClipToBounds Gets or sets a value indicating whether to clip the content of this element (or content coming from the child elements of this element) to fit into the size of the containing element. This is a dependency property. Inherited from UIElement.
CloseCommand Gets or sets a command that is executed when the current item’s close button (‘x’) is clicked. This is a dependency property.
CloseCommandParameter Gets or sets the parameter to pass to the BaseLayoutItem.CloseCommand. This is a dependency property.
Closed

Gets or sets whether a Dock Item is closed. This is a dependency property.

ClosingBehavior Gets or sets the way the current item acts if closed.
CommandBindings Gets a collection of CommandBinding objects associated with this element. A CommandBinding enables command handling for this element, and declares the linkage between a command, its events, and the handlers attached by this element. Inherited from UIElement.
ContextMenu Gets or sets the context menu element that should appear whenever the context menu is requested through user interface (UI) from within this element. Inherited from FrameworkElement.
ContextMenuCustomizations Allows you to add new menu items or remove existing items from the layout item’s context menu.
ContextMenuCustomizationsTemplate Gets or sets a template used to customize menu items in all affected dock layout items. This is a dependency property.
ControlBoxContent

Gets or sets the content of the control box region. This is a dependency property.

ControlBoxContentTemplate Gets or sets the template that defines how the object assigned to the BaseLayoutItem.ControlBoxContent property is displayed onscreen. This is a dependency property.
Cursor Gets or sets the cursor that displays when the mouse pointer is over this element. Inherited from FrameworkElement.
CustomizationCaption Gets or sets the BaseLayoutItem’s caption that is displayed in the Customization Window. This is a dependency property.
DataContext Gets or sets the data context for an element when it participates in data binding. Inherited from FrameworkElement.
DefaultStyleKey protected Gets or sets the key to use to reference the style for this control, when theme styles are used or defined. Inherited from FrameworkElement.
DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance. Inherited from DependencyObject.
Description

Gets or sets the item’s description displayed within the header of the Document Selector window. This is a dependency property.

DesiredCaptionWidth This member supports the internal infrastructure, and is not intended to be used directly from your code.
DesiredSize Gets the size that this element computed during the measure pass of the layout process. Inherited from UIElement.
Dispatcher Gets the Dispatcher this DispatcherObject is associated with. Inherited from DispatcherObject.
DockingViewStyle Gets a value that specifies how the current layout item displays its borders.
Effect Gets or sets the bitmap effect to apply to the UIElement. This is a dependency property. Inherited from UIElement.
FloatOnDoubleClick

Gets or sets whether an end-user can double-click the item’s caption to float it. This is a dependency property.

FloatSize Gets or sets the size of the item when it is floating. This is a dependency property.
FlowDirection Gets or sets the direction that text and other user interface (UI) elements flow within any parent element that controls their layout. Inherited from FrameworkElement.
Focusable Gets or sets a value that indicates whether the element can receive focus. This is a dependency property. Inherited from UIElement.
FocusVisualStyle Gets or sets a property that enables customization of appearance, effects, or other style characteristics that will apply to this element when it captures keyboard focus. Inherited from FrameworkElement.
FontFamily Gets or sets the font family of the control. Inherited from Control.
FontSize Gets or sets the font size. Inherited from Control.
FontStretch Gets or sets the degree to which a font is condensed or expanded on the screen. Inherited from Control.
FontStyle Gets or sets the font style. Inherited from Control.
FontWeight Gets or sets the weight or thickness of the specified font. Inherited from Control.
FooterDescription

Gets or sets the item’s description displayed within the footer of the Document Selector window. This is a dependency property.

ForceCursor Gets or sets a value that indicates whether this FrameworkElement should force the user interface (UI) to render the cursor as declared by the Cursor property. Inherited from FrameworkElement.
Foreground Gets or sets a brush that describes the foreground color. Inherited from Control.
HandlesScrolling protected Gets a value that indicates whether a control supports scrolling. Inherited from Control.
HasAnimatedProperties Gets a value indicating whether this element has any animated properties. Inherited from UIElement.
HasCaption

Gets whether a non-empty caption is assigned to the BaseLayoutItem.Caption property. This is a dependency property.

HasCaptionTemplate Gets whether a DataTemplate is used to render the caption. This is a dependency property.
HasDesiredCaptionWidth This member supports the internal infrastructure, and is not intended to be used directly from your code.
HasEffectiveKeyboardFocus protected Gets a value that indicates whether the UIElement has focus. Inherited from UIElement.
HasImage

Gets whether a caption image is assigned to the BaseLayoutItem.CaptionImage property. This is a dependency property.

HasTabCaption Gets if the BaseLayoutItem object has a non-empty BaseLayoutItem.TabCaption property value.
HeaderBarContainerControlAllowDrop

Gets or sets whether a bar can be dropped onto the bar container displayed in the current panel. This is a dependency property.

HeaderBarContainerControlName

Gets or sets the name of the bar container, used to embed bars from the DXBars library. This is a dependency property.

Height Gets or sets the suggested height of the element. Inherited from FrameworkElement.
HorizontalAlignment Gets or sets the horizontal alignment characteristics applied to this element when it is composed within a parent element, such as a panel or items control. Inherited from FrameworkElement.
HorizontalContentAlignment Gets or sets the horizontal alignment of the control’s content. Inherited from Control.
ImageToTextDistance

Gets or sets the distance between the item’s caption and image. This is a dependency property.

InheritanceBehavior protected Gets or sets the scope limits for property value inheritance, resource key lookup, and RelativeSource FindAncestor lookup. Inherited from FrameworkElement.
InputBindings Gets the collection of input bindings associated with this element. Inherited from UIElement.
InputScope Gets or sets the context for input used by this FrameworkElement. Inherited from FrameworkElement.
IsActive

Gets or sets whether the item is active. This is a dependency property.

IsArrangeValid Gets a value indicating whether the computed size and position of child elements in this element’s layout are valid. Inherited from UIElement.
IsAutoHidden Gets whether the item is auto-hidden.
IsCaptionImageVisible

Gets whether the caption image (BaseLayoutItem.CaptionImage) is visible. This is a dependency property.

IsCaptionVisible

Gets whether the item’s caption is visible. This is a dependency property.

IsCloseButtonVisible

Gets whether the Close (‘x’) button is visible for the current item. This is a dependency property.

IsClosed

Gets whether the item is closed. This is a dependency property.

IsControlBoxVisible

Gets whether the control box region is visible. This is a dependency property.

IsControlItemsHost

This member supports the internal infrastructure, and is not intended to be used directly from your code. This is a dependency property.

IsEnabled Gets or sets a value indicating whether this element is enabled in the user interface (UI). This is a dependency property. Inherited from UIElement.
IsFloating Gets whether the item floats.
IsFloatingRootItem This member supports the internal infrastructure, and is not intended to be used directly from your code.
IsFocused Gets a value that determines whether this element has logical focus. This is a dependency property. Inherited from UIElement.
IsHidden

Gets whether the current Layout Item is hidden. This is a dependency property.

IsHitTestVisible Gets or sets a value that declares whether this element can possibly be returned as a hit test result from some portion of its rendered content. This is a dependency property. Inherited from UIElement.
IsInitialized Gets a value that indicates whether this element has been initialized, either during processing by a XAML processor, or by explicitly having its EndInit() method called. Inherited from FrameworkElement.
IsInitializing Gets whether the item is being initialized.
IsInputMethodEnabled Gets a value indicating whether an input method system, such as an Input Method Editor (IME), is enabled for processing the input to this element. Inherited from UIElement.
IsKeyboardFocused Gets a value indicating whether this element has keyboard focus. This is a dependency property. Inherited from UIElement.
IsKeyboardFocusWithin Gets a value indicating whether keyboard focus is anywhere within the element or its visual tree child elements. This is a dependency property. Inherited from UIElement.
IsLoaded Gets a value that indicates whether this element has been loaded for presentation. Inherited from FrameworkElement.
IsManipulationEnabled Gets or sets a value that indicates whether manipulation events are enabled on this UIElement. Inherited from UIElement.
IsMeasureValid Gets a value indicating whether the current size returned by layout measure is valid. Inherited from UIElement.
IsMouseCaptured Gets a value indicating whether the mouse is captured to this element. This is a dependency property. Inherited from UIElement.
IsMouseCaptureWithin Gets a value that determines whether mouse capture is held by this element or by child elements in its visual tree. This is a dependency property. Inherited from UIElement.
IsMouseDirectlyOver Gets a value that indicates whether the position of the mouse pointer corresponds to hit test results, which take element compositing into account. This is a dependency property. Inherited from UIElement.
IsMouseOver Gets a value indicating whether the mouse pointer is located over this element (including child elements in the visual tree). This is a dependency property. Inherited from UIElement.
IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). Inherited from DependencyObject.
IsSelected

Gets whether the item is selected in Customization Mode. This is a dependency property.

IsSelectedItem Gets or sets whether the current item is selected within any LayoutGroup. This is a dependency property.
IsStylusCaptured Gets a value indicating whether the stylus is captured by this element. This is a dependency property. Inherited from UIElement.
IsStylusCaptureWithin Gets a value that determines whether stylus capture is held by this element, or an element within the element bounds and its visual tree. This is a dependency property. Inherited from UIElement.
IsStylusDirectlyOver Gets a value that indicates whether the stylus position corresponds to hit test results, which take element compositing into account. This is a dependency property. Inherited from UIElement.
IsStylusOver Gets a value indicating whether the stylus cursor is located over this element (including visual child elements). This is a dependency property. Inherited from UIElement.
IsTabPage

Gets whether the current item is represented as a tab page. This is a dependency property.

IsTabStop Gets or sets a value that indicates whether a control is included in tab navigation. Inherited from Control.
IsVisible Gets a value indicating whether this element is visible in the user interface (UI). This is a dependency property. Inherited from UIElement.
ItemHeight Gets or sets the height for the specified BaseLayoutItem object. This is a dependency property.
ItemType Gets the current item’s type.
ItemWidth Gets or sets the width for the specified BaseLayoutItem object. This is a dependency property.
Language Gets or sets localization/globalization language information that applies to an element. Inherited from FrameworkElement.
LayoutSize This member supports the internal infrastructure, and is not intended to be used directly from your code.
LayoutTransform Gets or sets a graphics transformation that should apply to this element when layout is performed. Inherited from FrameworkElement.
LogicalParent Gets the logical parent element of this element.
Margin

Gets or sets the outer indents of the item’s borders. This is a dependency property.

MaxHeight Gets or sets the maximum height constraint of the element. Inherited from FrameworkElement.
MaxWidth Gets or sets the maximum width constraint of the element. Inherited from FrameworkElement.
MinHeight Gets or sets the minimum height constraint of the element. Inherited from FrameworkElement.
MinWidth Gets or sets the minimum width constraint of the element. Inherited from FrameworkElement.
Name Gets or sets the identifying name of the element. The name provides a reference so that code-behind, such as event handler code, can refer to a markup element after it is constructed during processing by a XAML processor. Inherited from FrameworkElement.
Opacity Gets or sets the opacity factor applied to the entire UIElement when it is rendered in the user interface (UI). This is a dependency property. Inherited from UIElement.
OpacityMask Gets or sets an opacity mask, as a Brush implementation that is applied to any alpha-channel masking for the rendered content of this element. This is a dependency property. Inherited from UIElement.
OverridesDefaultStyle Gets or sets a value that indicates whether this element incorporates style properties from theme styles. Inherited from FrameworkElement.
Padding

Gets or sets the amount of space between the item’s borders and its contents. This is a dependency property.

Parent Gets the item’s parent group.
ParentCollectionName This member supports the internal infrastructure, and is not intended to be used directly from your code.
ParentName Gets or sets the name of the item’s parent. This member supports the internal infrastructure, and is not intended to be used directly from your code.
PersistId Gets a value that uniquely identifies this element. Inherited from UIElement.
RenderSize Gets (or sets) the final render size of this element. Inherited from UIElement.
RenderTransform Gets or sets transform information that affects the rendering position of this element. This is a dependency property. Inherited from UIElement.
RenderTransformOrigin Gets or sets the center point of any possible render transform declared by RenderTransform, relative to the bounds of the element. This is a dependency property. Inherited from UIElement.
Resources Gets or sets the locally-defined resource dictionary. Inherited from FrameworkElement.
SerializableDockSituation This member supports the internal infrastructure, and is not intended to be used directly from your code.
SerializationInfo For internal use only.
ShowCaption

Gets or sets whether the item’s caption is visible. This is a dependency property.

ShowCaptionImage Gets or sets whether the BaseLayoutItem.CaptionImage is visible. This is a dependency property.
ShowCloseButton Allows you to hide the current item’s Close button. This property is only supported for LayoutPanel and DocumentPanel objects. This is a dependency property.
ShowControlBox

Gets or sets whether the object assigned to the BaseLayoutItem.ControlBoxContent property is visible. This is a dependency property.

ShowTabCaptionImage Gets or sets whether to show an image within a tab caption of the layout item. This is a dependency property.
SnapsToDevicePixels Gets or sets a value that determines whether rendering for this element should use device-specific pixel settings during rendering. This is a dependency property. Inherited from UIElement.
Style Gets or sets the style used by this element when it is rendered. Inherited from FrameworkElement.
StylusPlugIns protected Gets a collection of all stylus plug-in (customization) objects associated with this element. Inherited from UIElement.
TabCaption Gets or sets the layout item’s tab caption.
TabCaptionFormat

Gets or sets the format string used to format the layout item’s tab caption. This is a dependency property.

TabCaptionHorizontalAlignment Gets or sets the horizontal alignment of the item’s tab caption. This is a dependency property.
TabCaptionImage Gets or sets an image displayed within the layout item caption in a tabbed layout. This is a dependency property.
TabCaptionTemplate Gets or sets a template that defines the tab caption presentation. This is a dependency property.
TabCaptionTemplateSelector Gets or sets an object that chooses a tab caption template based on custom logic. This is a dependency property.
TabCaptionVerticalAlignment Gets or sets the vertical alignment of the item’s tab caption. This is a dependency property.
TabCaptionWidth

Gets or sets the width of the corresponding tab. This property is in effect when the current object represents items as tabs or when it represents one of the tabs. This is a dependency property.

TabIndex Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls by using the TAB key. Inherited from Control.
Tag Gets or sets an arbitrary object value that can be used to store custom information about this element. Inherited from FrameworkElement.
Template Gets or sets a control template. Inherited from Control.
TemplatedParent Gets a reference to the template parent of this element. This property is not relevant if the element was not created through a template. Inherited from FrameworkElement.
TextTrimming

Gets or sets text trimming options applied to the BaseLayoutItem.Caption. This is a dependency property.

TextWrapping

Gets or sets text wrapping options applied to the BaseLayoutItem.Caption. This is a dependency property.

ToolTip Gets or sets a tool tip, displayed at runtime when hovering a BaseLayoutItem‘s caption or tab caption. This is a dependency property.
TouchesCaptured Gets all touch devices that are captured to this element. Inherited from UIElement.
TouchesCapturedWithin Gets all touch devices that are captured to this element or any child elements in its visual tree. Inherited from UIElement.
TouchesDirectlyOver Gets all touch devices that are over this element. Inherited from UIElement.
TouchesOver Gets all touch devices that are over this element or any child elements in its visual tree. Inherited from UIElement.
Triggers Gets the collection of triggers established directly on this element, or in child elements. Inherited from FrameworkElement.
TypeName Gets the name of the item’s type.
Uid Gets or sets the unique identifier (for localization) for this element. This is a dependency property. Inherited from UIElement.
UseLayoutRounding Gets or sets a value that indicates whether layout rounding should be applied to this element’s size and position during layout. Inherited from FrameworkElement.
VerticalAlignment Gets or sets the vertical alignment characteristics applied to this element when it is composed within a parent element such as a panel or items control. Inherited from FrameworkElement.
VerticalContentAlignment Gets or sets the vertical alignment of the control’s content. Inherited from Control.
Visibility Gets or sets the user interface (UI) visibility of this element. This is a dependency property. Inherited from UIElement.
VisualBitmapEffect protected Gets or sets the BitmapEffect value for the Visual. Inherited from Visual.
VisualBitmapEffectInput protected Gets or sets the BitmapEffectInput value for the Visual. Inherited from Visual.
VisualBitmapScalingMode protected Gets or sets the BitmapScalingMode for the Visual. Inherited from Visual.
VisualCacheMode protected Gets or sets a cached representation of the Visual. Inherited from Visual.
VisualChildrenCount protected Gets the number of visual child elements within this element. Inherited from FrameworkElement.
VisualClearTypeHint protected Gets or sets the ClearTypeHint that determines how ClearType is rendered in the Visual. Inherited from Visual.
VisualClip protected Gets or sets the clip region of the Visual as a Geometry value. Inherited from Visual.
VisualEdgeMode protected Gets or sets the edge mode of the Visual as an EdgeMode value. Inherited from Visual.
VisualEffect protected Gets or sets the bitmap effect to apply to the Visual. Inherited from Visual.
VisualOffset protected Gets or sets the offset value of the visual object. Inherited from Visual.
VisualOpacity protected Gets or sets the opacity of the Visual. Inherited from Visual.
VisualOpacityMask protected Gets or sets the Brush value that represents the opacity mask of the Visual. Inherited from Visual.
VisualParent protected Gets the visual tree parent of the visual object. Inherited from Visual.
VisualScrollableAreaClip protected Gets or sets a clipped scrollable area for the Visual. Inherited from Visual.
VisualTextHintingMode protected Gets or sets the TextHintingMode of the Visual. Inherited from Visual.
VisualTextRenderingMode protected Gets or sets the TextRenderingMode of the Visual. Inherited from Visual.
VisualTransform protected Gets or sets the Transform value for the Visual. Inherited from Visual.
VisualXSnappingGuidelines protected Gets or sets the x-coordinate (vertical) guideline collection. Inherited from Visual.
VisualYSnappingGuidelines protected Gets or sets the y-coordinate (horizontal) guideline collection. Inherited from Visual.
Width Gets or sets the width of the element. Inherited from FrameworkElement.
See Also