Back to Devexpress

LayoutControl Properties

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

latest44.9 KB
Original Source

LayoutControl Properties

Creates and maintains a consistent layout of controls. See Layout and Data Layout Controls.

NameDescription
AccessibilityObjectGets the AccessibleObject assigned to the control. Inherited from Control.
AccessibleDefaultActionDescriptionGets or sets the default action description of the control for use by accessibility client applications. Inherited from Control.
AccessibleDescriptionGets or sets the description of the control used by accessibility client applications. Inherited from Control.
AccessibleNameGets or sets the name of the control used by accessibility client applications. Inherited from Control.
AccessibleRoleGets or sets the accessible role of the control. Inherited from Control.
ActiveControlGets or sets the active control on the container control. Inherited from ContainerControl.
AllowCustomizationGets or sets whether users can change the layout.
AllowCustomizationDefaultValue staticGets or sets a default value for the AllowCustomization property. The default value is true.
AllowCustomizationMenuObsolete. Gets or sets whether the customization menu can be invoked by end-users.
AllowDropGets or sets a value indicating whether the control can accept data that the user drags onto it. Inherited from Control.
AllowTouchGesturesGets or sets whether the LayoutControl allows touch gestures.
AnchorGets or sets the edges of the container to which a control is bound and determines how a control is resized with its parent. Inherited from Control.
AppearanceProvides access to the properties that control the appearance of the controls located within the layout control.
AppearanceControllerGets an object that calculates appearances for layout items based on the appearance settings of items and their parent layout groups.
AutoScaleDimensionsGets or sets the dimensions that the control was designed to. Inherited from ContainerControl.
AutoScaleFactor protectedGets the scaling factor between the current and design-time automatic scaling dimensions. Inherited from ContainerControl.
AutoScaleModeGets or sets the automatic scaling mode of the control. Inherited from ContainerControl.
AutoScrollGets or sets whether the layout control will allow an end-user to scroll to any controls placed outside of its visible boundaries.
AutoScrollMarginNot supported.
AutoScrollMinSizeNot supported.
AutoScrollOffsetGets or sets where this control is scrolled to in ScrollControlIntoView(Control). Inherited from Control.
AutoScrollPositionThis property is not supported by the LayoutControl class.
AutoSizeGets or sets whether the control’s size is automatically calculated based on its content.
AutoSizeModeGets or sets how the control is resized when automatic resizing is enabled.
AutoValidateGets or sets a value that indicates whether controls in this container will be automatically validated when the focus changes. Inherited from ContainerControl.
BackColorGets or sets the control’s background color.
BackgroundImageGets or sets the layout control’s background image. This property is obsolete.
BackgroundImageLayoutGets or sets the background image layout. This property is obsolete. Use the BackgroundImageOptions property instead.
BindingContextGets or sets the BindingContext for the control.
BottomGets the distance, in pixels, between the bottom edge of the control and the top edge of its container’s client area. Inherited from Control.
BoundsGets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. Inherited from Control.
CanEnableIme protectedGets a value indicating whether the ImeMode property can be set to an active value, to enable IME support. Inherited from ContainerControl.
CanFocusGets a value indicating whether the control can receive focus. Inherited from Control.
CanRaiseEvents protectedDetermines if events can be raised on the control. Inherited from Control.
CanSelectGets a value indicating whether the control can be selected. Inherited from Control.
CaptionImagesObsolete. Gets or sets a collection of images that can be displayed within layout group captions.
CaptureGets or sets a value indicating whether the control has captured the mouse. Inherited from Control.
CausesValidationGets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. Inherited from Control.
CheckForIllegalCrossThreadCalls staticGets or sets a value indicating whether to catch calls on the wrong thread that access a control’s Handle property when an application is being debugged. Inherited from Control.
ClientHeightGets the layout control’s client height.
ClientRectangleGets the rectangle that represents the client area of the control. Inherited from Control.
ClientSizeGets or sets the height and width of the client area of the control. Inherited from Control.
ClientWidthGets the layout control’s client width.
CompanyNameGets the name of the company or creator of the application containing the control. Inherited from Control.
ConstraintsManagerGets the constraints manager.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ContainsFocusGets a value indicating whether the control, or one of its child controls, currently has the input focus. Inherited from Control.
ContextMenuGets or sets the shortcut menu associated with the control. Inherited from Control.
ControlsGets the collection of controls contained within the control. Inherited from Control.
CreatedGets a value indicating whether the control has been created. Inherited from Control.
CreateParams protectedGets the required creation parameters when the control handle is created. Inherited from ContainerControl.
CurrentAutoScaleDimensionsGets the current run-time dimensions of the screen. Inherited from ContainerControl.
CursorGets or sets the cursor that is displayed when the mouse pointer is over the control.
CustomizationFormProvides access to the Customization Form.
CustomizationFormBoundsGets or sets the boundaries of the Customization Form.
CustomizationMenuManagerAn object which provides the Context Menu.
CustomizationModeGets or sets whether users customize the layout in default mode via context menus or in quick mode via the customization form.
DataBindingsGets the data bindings for the control. Inherited from Control.
DefaultBackColor staticGets the default background color of the control. Inherited from Control.
DefaultCursor protectedGets or sets the default cursor for the control. Inherited from Control.
DefaultFont staticGets the default font of the control. Inherited from Control.
DefaultForeColor staticGets the default foreground color of the control. Inherited from Control.
DefaultImeMode protectedGets the default Input Method Editor (IME) mode supported by the control. Inherited from Control.
DefaultMargin protectedGets the space, in pixels, that is specified by default between controls. Inherited from Control.
DefaultMaximumSize protectedGets the length and height, in pixels, that is specified as the default maximum size of a control. Inherited from Control.
DefaultMinimumSize protectedGets the length and height, in pixels, that is specified as the default minimum size of a control. Inherited from Control.
DefaultPadding protectedGets the internal spacing, in pixels, of the contents of a control. Inherited from Control.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayRectangleGets the rectangle that represents the virtual display area of the control. Inherited from ScrollableControl.
DisposingGets a value indicating whether the base Control class is in the process of disposing. Inherited from Control.
DockGets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. Inherited from Control.
DockPaddingGets the dock padding settings for all edges of the control. Inherited from ScrollableControl.
DoubleBuffered protectedGets or sets a value indicating whether this control should redraw its surface using a secondary buffer to reduce or prevent flicker. Inherited from Control.
EnabledGets or sets a value indicating whether the control can respond to user interaction. Inherited from Control.
EnabledStateControllerGets an object that calculates the enabled states for layout items based on the enabled states of layout groups and controls.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FocusedGets a value indicating whether the control has input focus. Inherited from Control.
FocusHelperFor internal use.
FontGets or sets the font of the text displayed by the control. Inherited from Control.
FontHeight protectedGets or sets the height of the font of the control. Inherited from Control.
ForeColorGets or sets the foreground color of the control. Inherited from Control.
HandleGets the window handle that the control is bound to. Inherited from Control.
HasChildrenGets a value indicating whether the control contains one or more child controls. Inherited from Control.
HeightGets or sets the height of the control. Inherited from Control.
HiddenItemsProvides access to a collection of hidden layout items.
HiddenItemsSortComparerAllows you to specify a comparer object for sorting hidden items within the Customization Form.
HorizontalScrollGets the characteristics associated with the horizontal scroll bar. Inherited from ScrollableControl.
HScroll protectedGets or sets a value indicating whether the horizontal scroll bar is visible. Inherited from ScrollableControl.
HtmlImagesGets or sets a collection of images that you can embed into captions/messages/tooltips in the control using the image HTML-inspired tag.
ImagesGets or sets a collection of icons that can be displayed in a layout item, group, or tab’s label.
ImeModeGets or sets the Input Method Editor (IME) mode of the control. Inherited from Control.
ImeModeBase protectedGets or sets the IME mode of a control. Inherited from Control.
InvokeRequiredGets a value indicating whether the caller must call an invoke method when making method calls to the control because the caller is on a different thread than the one the control was created on. Inherited from Control.
IsAccessibleGets or sets a value indicating whether the control is visible to accessibility applications. Inherited from Control.
IsDisposedGets a value indicating whether the control has been disposed of. Inherited from Control.
IsHandleCreatedGets a value indicating whether the control has a handle associated with it. Inherited from Control.
IsInitializedIndicates whether the LayoutControl has been initialized.
IsLayoutModifiedGets whether the layout has been modified. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
IsMirroredGets a value indicating whether the control is mirrored. Inherited from Control.
IsModifiedGets whether the layout has been changed.
IsPrintingAvailableIndicates whether the LayoutControl can be printed.
IsUpdateLockedGets whether the layout control has been locked for updating.
ItemsProvides access to all the layout items owned by the LayoutControl.
LayoutEngineGets a cached instance of the control’s layout engine. Inherited from Control.
LayoutVersionGets or sets the version of the layout.
LeftGets or sets the distance, in pixels, between the left edge of the control and the left edge of its container’s client area. Inherited from Control.
LocationGets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. Inherited from Control.
LookAndFeelProvides access to the settings that control the layout control’s look and feel.
MarginGets or sets the space between controls. Inherited from Control.
MaximumSizeGets or sets the size that is the upper limit that GetPreferredSize(Size) can specify. Inherited from Control.
MenuManagerGets or sets an object that controls the look and feel of the popup menus.
MinimumSizeGets or sets the size that is the lower limit that GetPreferredSize(Size) can specify. Inherited from Control.
ModifierKeys staticGets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. Inherited from Control.
MouseButtons staticGets a value indicating which of the mouse buttons is in a pressed state. Inherited from Control.
MousePosition staticGets the position of the mouse cursor in screen coordinates. Inherited from Control.
NameGets or sets the name of the control. Inherited from Control.
OptionsCustomizationFormProvides access to the options which control the appearance and behavior of the Customization Form.
OptionsFocusProvides access to the layout control’s focus options.
OptionsItemTextProvides access to the default alignment settings of the controls displayed in the LayoutControl.
OptionsPrintThe Layout Control’s print/export options. This object’s settings affect all layout items and groups.
OptionsSerializationContains options that specify how the LayoutControl’s layout is saved to and restored from a data store (an XML file, a stream or the system registry).
OptionsViewProvides access to the display options of the LayoutControl.
PaddingGets or sets padding within the control. Inherited from Control.
PaintStylesProvides access to the paint style collection.
ParentGets or sets the parent container of the control. Inherited from Control.
ParentFormGets the form that the container control is assigned to. Inherited from ContainerControl.
PreferredSizeGets the size of a rectangular area into which the control can fit. Inherited from Control.
ProductNameGets the product name of the assembly containing the control. Inherited from Control.
ProductVersionGets the version of the assembly containing the control. Inherited from Control.
PropagatingImeMode protected staticGets an object that represents a propagating IME mode. Inherited from Control.
RecreatingHandleGets a value indicating whether the control is currently re-creating its handle. Inherited from Control.
RegionGets or sets the window region associated with the control. Inherited from Control.
RenderRightToLeft protectedThis property is now obsolete. Inherited from Control.
RepositoryItems
ResizeRedraw protectedGets or sets a value indicating whether the control redraws itself when resized. Inherited from Control.
RightGets the distance, in pixels, between the right edge of the control and the left edge of its container’s client area. Inherited from Control.
RightToLeftGets or sets a value indicating whether control’s elements are aligned to support locales using right-to-left fonts. Inherited from Control.
RootGets or sets the LayoutControl’s root group.
ShowFocusCues protectedGets a value indicating whether the control should display focus rectangles. Inherited from Control.
ShowKeyboardCues protectedGets a value indicating whether the user interface is in the appropriate state to show or hide keyboard accelerators. Inherited from Control.
SiteGets or sets the site of the control. Inherited from Control.
SizeGets or sets the height and width of the control. Inherited from Control.
StyleControllerGets or sets the style controller component that provides appearance settings for the control.
TabIndexGets or sets the tab order of the control within its container. Inherited from Control.
TabStopGets or sets a value indicating whether the user can give the focus to this control using the TAB key. Inherited from Control.
TagGets or sets the object that contains data about the control. Inherited from Control.
TextGets or sets the text associated with this control. Inherited from Control.
ToolTipControllerGets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for layout items.
TopGets or sets the distance, in pixels, between the top edge of the control and the top edge of its container’s client area. Inherited from Control.
TopLevelControlGets the parent control that is not parented by another Windows Forms control. Typically, this is the outermost Form that the control is contained in. Inherited from Control.
UndoManagerGets the manager that handles undo/redo operations via the Customization Form.
UseLocalBindingContextGets or sets whether controls within the current LayoutControl use the local BindingContext, or the form’s BindingContext.
UseWaitCursorGets or sets a value indicating whether to use the wait cursor for the current control and all child controls. Inherited from Control.
VerticalScrollGets the characteristics associated with the vertical scroll bar. Inherited from ScrollableControl.
VisibleGets or sets a value indicating whether the control and all its child controls are displayed. Inherited from Control.
VScroll protectedGets or sets a value indicating whether the vertical scroll bar is visible. Inherited from ScrollableControl.
WidthGets or sets the width of the control. Inherited from Control.
WindowTargetThis property is not relevant for this class. Inherited from Control.

See Also

LayoutControl Class

LayoutControl Members

DevExpress.XtraLayout Namespace