Back to Devexpress

BaseLayoutItem Members

windowsforms-devexpress-dot-xtralayout-dot-baselayoutitem-dot-underscore-members.md

latest21.0 KB
Original Source

BaseLayoutItem Members

Represents the base class for layout items.

Properties

NameDescription
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications.
AccessibleNameGets or sets the object’s name used by accessibility client applications.
AccessibleRoleGets or sets the object’s accessible role.
AllowHideGets or sets whether the item can be hidden to the Customization Form.
AppearanceItemCaptionGets the appearance settings used to paint a layout item’s caption.
BestFitWeightGets or sets the width of the current BaseLayoutItem relative to other items’ width after the LayoutControl.BestFit method has been called.
BindingContextGets or sets the BindingContext for the item.
BoundsGets the layout item’s bounding rectangle.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CustomizationFormTextGets or sets the layout item’s caption within the Customization Form.
DataBindingsGets the data bindings for the layout item.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpandedNot supported.
HeightGets or sets the layout item’s height.
IsDisposingGets whether the current item is being disposed of.
IsGroupGets whether the current layout item represents a Layout Group.
IsHiddenGets whether the layout item is hidden.
IsUpdateLockedGets whether the layout item has been locked for updating.
LocationGets or sets the coordinates of the layout item’s top left corner.
MaxSizeGets or sets the maximum size of the layout item.
MinSizeGets or sets the item’s minimum size.
NameGets or sets the layout item’s name.
OptionsCustomizationContains options that specify which operations can be performed on the layout item at runtime.
OptionsIconToolTipObsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead.
OptionsItemToolTipObsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead.
OptionsTableLayoutItemProvides access to the options that specify how a layout item is arranged within a table layout.
OptionsToolTipContains options that allow tooltips to be assigned to layout items and their images.
OwnerGets or set the LayoutControl that owns the current layout item.
PaddingGets or sets the amount of space in pixels between the item’s borders and its contents.
PaintAppearanceItemCaptionProvides access to the appearance settings currently used to paint the layout item.
ParentGets or sets the group that owns the current item.
ParentNameGets or sets the name of the item’s parent.
SelectedGets or sets the selection state of the current item.
ShowInCustomizationFormGets or sets whether the layout item is displayed within the Customization Form when the item is hidden.
SiteGets or sets the ISite of the Component. Inherited from Component.
SizeGets or sets the layout item’s size.
SpacingGets or sets the outer indents of the item’s borders.
StartNewLineGets or sets whether the current item starts a new row within a flow layout.
TagGets or sets an object that contains data on the current layout item.
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.
TextLocationGets or sets the item caption position.
TextSizeGets or sets the size of the text region.
TextToControlDistanceGets or sets the distance between the control displayed within the layout item and the text region.
TextVisibleGets or sets whether the text region is visible.
TypeNameGets the name of the current layout item’s type.
ViewInfoGets the object which contains the information used to render the layout item.
VisibilityAllows you to hide the item from the Layout Control and Customization Form.
VisibleGets whether the layout item is visible.
WidthGets or sets the layout item’s width.
XGets or sets the X coordinate of the item’s top left corner relative to the parent’s top left corner.
YGets or sets the Y coordinate of the item’s top left corner relative to the parent’s top left corner.

Methods

NameDescription
Accept(BaseVisitor)Invokes the Visit method of the specified visitor for each layout item that belongs to the current layout item.
Assign(BaseLayoutItem)Assigns the specified object’s property values to the current object’s corresponding properties.
BeginInit()Starts the component’s initialization.
CanMove(LayoutItemDragController)Returns whether the layout item can be moved to a specific position.
Clone(LayoutGroup, ILayoutControl)Creates a copy of the current layout item.
CreateObjRef(Type)Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose()Releases all resources used by the Component. Inherited from Component.
EndInit()Finishes the component’s initialization.
Equals(Object, Object) staticDetermines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object)Determines whether the specified object is equal to the current object. Inherited from Object.
GetDefaultText()Gets the default value of the BaseLayoutItem.Text property.
GetDisplayText()Returns the BaseLayoutItem‘s BaseLayoutItem.Text value without HTML tags and hotkey prefixes (the “&” symbol).
GetHashCode()Serves as the default hash function. Inherited from Object.
GetLifetimeService()Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetPaintAppearanceItemCaptionByState(ObjectState)
GetService(Type) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType()Gets the Type of the current instance. Inherited from Object.
HideToCustomization()Hides the item to the Customization Form.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
Invalidate()Invalidates the region which is occupied by the layout item.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
Move(BaseLayoutItem, InsertType, MoveType)Moves the item to the specified visual position within the LayoutControl.
Move(BaseLayoutItem, InsertType)Moves the item to the specified visual position within the LayoutControl.
Move(LayoutItemDragController)Moves the item to the specified position within the LayoutControl.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RestoreFromCustomization()Restores the current layout item from the Customization Form and adds it to the root group with the default layout type.
RestoreFromCustomization(BaseLayoutItem, InsertType)Restores the current layout item from the Customization Form and adds it to the parent group of the specified item at the specified visual position.
RestoreFromCustomization(LayoutItemDragController)Restores the current layout item from the Customization Form and displays it at the specified position within the LayoutControl.
RestoreFromCustomization(LayoutGroup)Restores the current layout item from the Customization Form and adds it to the specified group with the default layout type.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.
Update()Updates the region occupied by the layout item.

Events

NameDescription
ClickFires when the current item is clicked.
CustomDrawAllows you to custom paint the current item.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DoubleClickFires when the current item is clicked.
HiddenFires after an item has been hidden.
HidingFires when the item is about to be hidden (when dragging the item and dropping it onto on the Customization Form).
MouseDownOccurs when the mouse pointer is over a layout item and a mouse button is pressed.
MouseUpOccurs when the mouse button is released if it was pressed within a layout item.
ShowingFires when the item is about to be added to the layout (by dragging it from the Customization Form).
ShownFires after an item has been made visible.
TextChangedFires after the layout item’s text has been changed.

See Also

BaseLayoutItem Class

DevExpress.XtraLayout Namespace