Back to Devexpress

LayoutGroup Properties

windowsforms-devexpress-dot-xtralayout-dot-layoutgroup-dot-underscore-properties.md

latest25.5 KB
Original Source

LayoutGroup Properties

A base class for regular layout groups.

NameDescription
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications. Inherited from BaseLayoutItem.
AccessibleNameGets or sets the object’s name used by accessibility client applications. Inherited from BaseLayoutItem.
AccessibleRoleGets or sets the object’s accessible role. Inherited from BaseLayoutItem.
AllowBorderColorBlendingGets or sets whether to colorize the layout group border and caption using the LayoutGroup.AppearanceGroup.BorderColor setting in skinning paint schemes. This property is ignored by default starting from v18.2.
AllowCustomizeChildrenGets or sets whether the layout of the current container can be customized using drag and drop. Inherited from LayoutItemContainer.
AllowDrawBackgroundGets or sets whether to paint the group’s background when the LayoutGroup.GroupBordersVisible property is set to false.
AllowGlyphSkinningGets or sets whether the group or tab’s icon is filled with the control’s foreground color.
AllowHideGets or sets whether the item can be hidden to the Customization Form. Inherited from BaseLayoutItem.
AllowHtmlStringInCaptionGets or sets whether HTML formatting is allowed within the layout group caption.
AppearanceGroupProvides access to the properties that control the group’s appearance. Inherited from LayoutItemContainer.
AppearanceItemCaptionGets the appearance settings used to paint a layout item’s caption. Inherited from BaseLayoutItem.
AppearanceTabPageProvides access to a tabbed group’s appearance settings. Inherited from LayoutItemContainer.
BackgroundImageGets or sets the group’s background image that can be stretched across the group, tiled, centered, etc. This property is obsolete. Use the BackgroundImageOptions property instead.
BackgroundImageLayoutGets or sets the position and behavior of the background image. This property is obsolete. Use the BackgroundImageOptions property instead.
BackgroundImageOptionsProvides access to all properties that allow you to assign and customize this group’s background image at the bottom layer.
BackgroundImageVisibleGets or sets whether to display the background image. This property is obsolete. Use the BackgroundImageOptions property instead.
BestFitWeightGets or sets the width of the current BaseLayoutItem relative to other items’ width after the LayoutControl.BestFit method has been called. Inherited from BaseLayoutItem.
BindingContextGets or sets the BindingContext for the item. Inherited from BaseLayoutItem.
BoundsGets the layout item’s bounding rectangle. Inherited from BaseLayoutItem.
CanChangeLayoutModeForChildSelectedGroupReturns whether the layout mode can be changed for a LayoutGroup.
CanCreateTabbedGroupForSelectedGroupReturns whether a new tabbed group can be created within the current group which will display a selected child group.
CanGroupSelectedItemsReturns whether a new group can be created within the current group which will display selected child items.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CaptionImageUse the Image option accessible in CaptionImageOptions to specify the image displayed within the group’s caption area.
CaptionImageIndexGets or sets the index of an image in the LayoutControl.Images or LayoutView.Images collection that is displayed in the group or tab’s label.
CaptionImageLocationGets or sets the icon’s alignment relative to the text.
CaptionImageOptionsGets options that specify the label’s icon.
CaptionImagePaddingGets or sets the amount of space between the icon and the label’s bounds.
CaptionImageVisibleGets or sets whether the label’s icon is visible.
CellSizeObsolete. Not supported.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContentImageGets or sets the group’s background image that is displayed “as is”, and can be aligned to any group’s edge. This property is obsolete. Use the ContentImageOptions property instead.
ContentImageAlignmentGets or sets the content image’s alignment within the group. This property is obsolete. Use the ContentImageOptions property instead.
ContentImageOptionsProvides access to all properties that allow you to assign and customize this group’s background image at the top layer.
CountGets the number of items that the current group owns.
CustomHeaderButtonsGets or sets the collection of custom buttons displayed in the group header.
CustomizationFormTextGets or sets the layout item’s caption within the Customization Form. Inherited from BaseLayoutItem.
DataBindingsGets the data bindings for the layout item. Inherited from BaseLayoutItem.
DefaultLayoutTypeGets or sets the default layout type for newly created items within the current group.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
EnabledGets or sets whether layout items that belong to the current group are enabled.
EnableIndentsWithoutBordersGets or sets whether a layout group’s indents, specified by its BaseLayoutItem.Spacing and BaseLayoutItem.Padding properties, are applied when the group’s borders are hidden.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpandButtonLocationObsolete. Gets or sets the position of the expand button within the group header.
ExpandButtonModeGets or sets the direction of the expand button’s arrow.
ExpandButtonVisibleGets or sets whether the group’s expand button is visible.
ExpandedGets or sets whether the current group is expanded.
ExpandOnDoubleClickGets or sets whether the group is expanded/collapsed on double-clicking its caption.
FlowDirectionGets or sets the direction according to which the LayoutGroup arranges its child elements.
GroupBordersVisibleGets whether the group’s borders are visible.
GroupStyleGets or sets the border and the header style of this LayoutGroup.
HeaderButtonsLocationGets or sets whether the group header buttons are displayed before or after text.
HeightGets or sets the layout item’s height. Inherited from BaseLayoutItem.
ImageListGets a collection of images that can be displayed in the group’s label.
IsDisposingGets whether the current item is being disposed of. Inherited from BaseLayoutItem.
IsGroupGets whether the current layout item represents a Layout Group. Inherited from BaseLayoutItem.
IsHiddenGets whether the layout item is hidden. Inherited from BaseLayoutItem.
IsInTabbedGroupGets whether the current group is displayed as a tab within a tabbed group.
IsUpdateLockedGets whether the layout item has been locked for updating. Inherited from BaseLayoutItem.
Item[Int32]Provides indexed access to the items that belong to the current group.
ItemsProvides access to the collection of items owned by the current group.
LayoutModeGets or sets the layout mode for a LayoutGroup.
LocationGets or sets the coordinates of the layout item’s top left corner. Inherited from BaseLayoutItem.
MaxSizeGets the maximum size of the group.
MinSizeGets the minimum size of the group.
MoveFocusDirectionGets or sets whether, in Automatic Tab Order mode when TAB is pressed, the focus moves across grouped controls and then down, or first down and then across.
MoveFocusRightToLeftGets or sets whether, in Automatic Tab Order mode when TAB is pressed, the focus moves across grouped controls from right to left.
NameGets or sets the layout item’s name. Inherited from BaseLayoutItem.
OptionsCustomizationContains options that specify which operations can be performed on the layout item at runtime. Inherited from BaseLayoutItem.
OptionsIconToolTipObsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. Inherited from BaseLayoutItem.
OptionsItemTextGets the options that determine how the controls displayed within the current group are aligned.
OptionsItemToolTipObsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. Inherited from BaseLayoutItem.
OptionsPrintThe group’s print/export options. This object’s settings affect all layout items owned by the group.
OptionsTableLayoutGroupProvides settings and events for table layout customization.
OptionsTableLayoutItemProvides access to the options that specify how a layout item is arranged within a table layout. Inherited from BaseLayoutItem.
OptionsToolTipContains options that allow tooltips to be assigned to layout items and their images. Inherited from BaseLayoutItem.
OwnerGets or set the LayoutControl that owns the current layout item. Inherited from BaseLayoutItem.
PaddingGets or sets the amount of space in pixels between the item’s borders and its contents. Inherited from BaseLayoutItem.
PageEnabledGets or sets whether the tab that corresponds to the current group is enabled. This property is in effect when the group is represented as a tab page within a TabbedControlGroup.
PaintAppearanceGroupProvides access to the appearance settings currently used to paint the layout group. Inherited from LayoutItemContainer.
PaintAppearanceItemCaptionProvides access to the appearance settings currently used to paint layout items that belong to the current container. Inherited from LayoutItemContainer.
ParentGets or sets the group that owns the current group.
ParentNameGets or sets the name of the item’s parent. Inherited from BaseLayoutItem.
ParentTabbedGroupGets the parent tabbed group if the current group is displayed as a tab.
SelectedGets or sets the selection state of the current item. Inherited from BaseLayoutItem.
SelectedItemsProvides access to the collection of selected items within the current group.
ShowInCustomizationFormGets or sets whether the layout item is displayed within the Customization Form when the item is hidden. Inherited from BaseLayoutItem.
ShowTabPageCloseButtonGets or sets whether a Close button is displayed within a group when it’s embedded into a TabbedGroup.
SiteGets or sets the ISite of the Component. Inherited from Component.
SizeGets or sets the group’s size.
SpacingGets or sets the outer indents of the item’s borders. Inherited from BaseLayoutItem.
StartNewLineGets or sets whether the current item starts a new row within a flow layout. Inherited from BaseLayoutItem.
TabbedGroupParentNameGets the name of the group’s parent if the current group is displayed as a tab.
TabPageWidthGets or sets the width, in pixels, of tab headers. Inherited from LayoutItemContainer.
TagGets or sets an object that contains data on the current layout item. Inherited from BaseLayoutItem.
TextGets or sets the caption of this layout item. If the Text property is null (Nothing in VB.NET) or String.Empty, this property returns the item name. Inherited from BaseLayoutItem.
TextLocationGets or sets the container’s side along which its caption is displayed. Inherited from LayoutItemContainer.
TextSizeNot supported. Inherited from LayoutItemContainer.
TextToControlDistanceNot supported. Inherited from LayoutItemContainer.
TextVisibleGets or sets whether the text region is visible. Inherited from BaseLayoutItem.
TypeNameGets the name of the item’s type.
ViewInfoGets the object which contains the information used to render the layout group.
VisibilityAllows you to hide the item from the Layout Control and Customization Form. Inherited from BaseLayoutItem.
VisibleGets whether the layout item is visible. Inherited from BaseLayoutItem.
WidthGets or sets the layout item’s width. Inherited from BaseLayoutItem.
XGets or sets the X coordinate of the item’s top left corner relative to the parent’s top left corner. Inherited from BaseLayoutItem.
YGets or sets the Y coordinate of the item’s top left corner relative to the parent’s top left corner. Inherited from BaseLayoutItem.

See Also

LayoutGroup Class

LayoutGroup Members

DevExpress.XtraLayout Namespace