Skip to main content

BaseLayoutItem Members

Represents the base class for layout items.

Properties

Name Description
AccessibleDescription Gets or sets the object’s description used by accessibility client applications.
AccessibleName Gets or sets the object’s name used by accessibility client applications.
AccessibleRole Gets or sets the object’s accessible role.
AllowHide Gets or sets whether the item can be hidden to the Customization Form.
AppearanceItemCaption Gets the appearance settings used to paint a layout item’s caption.
BestFitWeight Gets or sets the width of the current BaseLayoutItem relative to other items’ width after the LayoutControl.BestFit method has been called.
BindingContext Gets or sets the BindingContext for the item.
Bounds Gets the layout item’s bounding rectangle.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Container Gets the IContainer that contains the Component. Inherited from Component.
CustomizationFormText Gets or sets the layout item’s caption within the Customization Form.
DataBindings Gets the data bindings for the layout item.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Expanded Not supported.
Height Gets or sets the layout item’s height.
IsDisposing Gets whether the current item is being disposed of.
IsGroup Gets whether the current layout item represents a Layout Group.
IsHidden Gets whether the layout item is hidden.
IsUpdateLocked Gets whether the layout item has been locked for updating.
Location Gets or sets the coordinates of the layout item’s top left corner.
MaxSize Gets or sets the maximum size of the layout item.
MinSize Gets or sets the item’s minimum size.
Name Gets or sets the layout item’s name.
OptionsCustomization Contains options that specify which operations can be performed on the layout item at runtime.
OptionsIconToolTip Obsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead.
OptionsItemToolTip Obsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead.
OptionsTableLayoutItem Provides access to the options that specify how a layout item is arranged within a table layout.
OptionsToolTip Contains options that allow tooltips to be assigned to layout items and their images.
Owner Gets or set the LayoutControl that owns the current layout item.
Padding Gets or sets the amount of space in pixels between the item’s borders and its contents.
PaintAppearanceItemCaption Provides access to the appearance settings currently used to paint the layout item.
Parent Gets or sets the group that owns the current item.
ParentName Gets or sets the name of the item’s parent.
Selected Gets or sets the selection state of the current item.
ShowInCustomizationForm Gets or sets whether the layout item is displayed within the Customization Form when the item is hidden.
Site Gets or sets the ISite of the Component. Inherited from Component.
Size Gets or sets the layout item’s size.
Spacing Gets or sets the outer indents of the item’s borders.
StartNewLine Gets or sets whether the current item starts a new row within a flow layout.
Tag Gets or sets an object that contains data on the current layout item.
Text Gets 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.
TextLocation Gets or sets the item caption position.
TextSize Gets or sets the size of the text region.
TextToControlDistance Gets or sets the distance between the control displayed within the layout item and the text region.
TextVisible Gets or sets whether the text region is visible.
TypeName Gets the name of the current layout item’s type.
ViewInfo Gets the object which contains the information used to render the layout item.
Visibility Allows you to hide the item from the Layout Control and Customization Form.
Visible Gets whether the layout item is visible.
Width Gets or sets the layout item’s width.
X Gets or sets the X coordinate of the item’s top left corner relative to the parent’s top left corner.
Y Gets or sets the Y coordinate of the item’s top left corner relative to the parent’s top left corner.

Methods

Name Description
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) static Determines 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) protected Returns 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() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates 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) static Determines 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

Name Description
Click Fires when the current item is clicked.
CustomDraw Allows you to custom paint the current item.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
DoubleClick Fires when the current item is clicked.
Hidden Fires after an item has been hidden.
Hiding Fires when the item is about to be hidden (when dragging the item and dropping it onto on the Customization Form).
MouseDown Occurs when the mouse pointer is over a layout item and a mouse button is pressed.
MouseUp Occurs when the mouse button is released if it was pressed within a layout item.
Showing Fires when the item is about to be added to the layout (by dragging it from the Customization Form).
Shown Fires after an item has been made visible.
TextChanged Fires after the layout item’s text has been changed.
See Also