Skip to main content

LayoutControlItem Members

A layout item.

Constructors

Name Description
LayoutControlItem() Initializes a new instance of the LayoutControlItem class with default settings.
LayoutControlItem(LayoutControl, Control) Initializes a new instance of the LayoutControlItem class.
LayoutControlItem(LayoutControlGroup, Boolean) Initializes a new instance of the LayoutControlItem class with specified settings.

Properties

Name Description
AccessibleDescription Gets or sets the object’s description used by accessibility client applications. Inherited from BaseLayoutItem.
AccessibleName Gets or sets the object’s name used by accessibility client applications. Inherited from BaseLayoutItem.
AccessibleRole Gets or sets the object’s accessible role. Inherited from BaseLayoutItem.
AllowAutoAlignment Obsolete. Gets or sets whether the auto-alignment feature is enabled for the item.
AllowGlyphSkinning Gets or sets whether a label’s icon is filled with the label’s foreground color.
AllowHide Gets or sets whether the item can be hidden to the Customization Form. Inherited from BaseLayoutItem.
AllowHotTrack Gets or sets whether the layout item’s borders are highlighted when the mouse cursor hovers over it.
AllowHtmlStringInCaption Gets or sets whether HTML formatting is allowed in the text that is associated with the layout item.
AppearanceItemCaption Gets the appearance settings used to paint a layout item’s caption. Inherited from BaseLayoutItem.
AppearanceItemCaptionDisabled Gets appearance settings used to paint the caption of a layout item when the item is disabled.
BestFitWeight Gets or sets the width of the current BaseLayoutItem relative to other items’ width after the LayoutControl.BestFit method has been called. Inherited from BaseLayoutItem.
BindingContext Gets or sets the BindingContext for the item. Inherited from BaseLayoutItem.
Bounds Gets the layout item’s bounding rectangle. Inherited from BaseLayoutItem.
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.
ContentHorzAlignment Gets or sets the horizontal alignment of a control inside this layout item. This property is in effect when the control’s maximum width is limited, and is less than the layout item currently provides.
ContentVertAlignment Gets or sets the vertical alignment of a control inside this layout item. This property is in effect when the control’s maximum height is limited, and is less than the layout item currently provides.
ContentVisible Gets or sets whether the layout item’s contents are visible.
Control Gets or sets the control which is owned by the layout item.
ControlAlignment Gets or sets the alignment of the LayoutControlItem‘s control within the layout item. This setting is not intended to be used for version 19.2 and newer.
ControlMaxSize Gets or sets the client area’s maximum size.
ControlMinSize Gets or sets the control’s minimum size.
ControlName This property is for internal use only. It is used in serialization. Do not change it.
CustomizationFormText Gets or sets the layout item’s caption within the Customization Form. Inherited from BaseLayoutItem.
DataBindings Gets the data bindings for the layout item. Inherited from BaseLayoutItem.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Enabled Gets or sets whether the layout item and its control are enabled.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Expanded Not supported.
FillControlToClientArea Gets or sets whether the control occupies the layout item’s maximum allowed client area. This setting is not intended to be used for version 19.2 and newer.
Height Gets or sets the layout item’s height. Inherited from BaseLayoutItem.
HighlightFocusedItem Gets or sets whether the current layout item is highlighted according to the current skin when focused.
Image Gets or sets the icon displayed in the item’s label.
ImageAlignment Gets or sets the alignment of the icon in the label.
ImageIndex Gets or sets the index of the icon displayed in the item’s label.
ImageOptions Gets options that allow you to display an icon in the item’s label.
Images Gets a collection of icons that can be displayed in the item’s label.
ImageToTextDistance Gets or sets the distance between the label’s text and icon.
IsAccessible
IsDisposing Gets whether the current item is being disposed of. Inherited from BaseLayoutItem.
IsGroup Gets whether the current layout item represents a Layout Group. Inherited from BaseLayoutItem.
IsHidden Gets whether the layout item is hidden. Inherited from BaseLayoutItem.
IsUpdateLocked Gets whether the layout item has been locked for updating. Inherited from BaseLayoutItem.
ItemImages Gets a collection of icons that can be displayed in the item’s label.
Location Gets or sets the coordinates of the layout item’s top left corner. Inherited from BaseLayoutItem.
MaxSize Gets or sets the layout item’s maximum size.
MinSize Gets or sets the item’s minimum size.
Name Gets or sets the layout item’s name. Inherited from BaseLayoutItem.
OptionsCustomization Contains options that specify which operations can be performed on the layout item at runtime. Inherited from BaseLayoutItem.
OptionsIconToolTip Obsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. Inherited from BaseLayoutItem.
OptionsItemToolTip Obsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. Inherited from BaseLayoutItem.
OptionsPrint The item’s print/export options.
OptionsTableLayoutItem Provides access to the options that specify how a layout item is arranged within a table layout. Inherited from BaseLayoutItem.
OptionsToolTip Contains options that allow tooltips to be assigned to layout items and their images. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
PaintAppearanceItemCaption Provides access to the appearance settings currently used to paint the layout item. Inherited from BaseLayoutItem.
Parent Gets or sets the group that owns the current item. Inherited from BaseLayoutItem.
ParentName Gets or sets the name of the item’s parent. Inherited from BaseLayoutItem.
Selected Gets or sets the selection state of the current item. Inherited from BaseLayoutItem.
ShowInCustomizationForm Gets or sets whether the layout item is displayed within the Customization Form when the item is hidden. Inherited from BaseLayoutItem.
Site Gets or sets the ISite of the Component. Inherited from Component.
Size Gets or sets the layout item’s size. Inherited from BaseLayoutItem.
SizeConstraintsType Gets or sets the size constraints type.
Spacing Gets or sets the outer indents of the item’s borders. Inherited from BaseLayoutItem.
StartNewLine Gets or sets whether the current item starts a new row within a flow layout. Inherited from BaseLayoutItem.
SvgImage Gets or sets the vector image for this item’s label.
SvgImageSize Gets or sets the size of vector image for this item’s label.
Tag Gets or sets an object that contains data on the current layout item. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
TextAlignMode Gets or sets the alignment settings of the item’s control.
TextLocation Gets or sets the item caption position. Inherited from BaseLayoutItem.
TextSize Gets or sets the size of the text region. Inherited from BaseLayoutItem.
TextToControlDistance Gets or sets the distance between the control displayed within the layout item and the text region. Inherited from BaseLayoutItem.
TextVisible Gets or sets whether the text region is visible. Inherited from BaseLayoutItem.
TrimClientAreaToControl Gets or sets whether the client region’s height is trimmed to match the control’s height. This setting is not intended to be used for version 19.2 and newer.
TypeName Gets the name of the item’s type.
ViewInfo Gets the object which contains information used to render the layout item.
Visibility Allows you to hide the item from the Layout Control and Customization Form. Inherited from BaseLayoutItem.
Visible Gets whether the layout item is visible. Inherited from BaseLayoutItem.
Width Gets or sets the layout item’s width. Inherited from BaseLayoutItem.
X Gets or sets the X coordinate of the item’s top left corner relative to the parent’s top left corner. Inherited from BaseLayoutItem.
Y Gets or sets the Y coordinate of the item’s top left corner relative to the parent’s top left corner. Inherited from BaseLayoutItem.

Methods

Name Description
Accept(BaseVisitor) Invokes the Visit method of the specified visitor for each layout item that belongs to the current layout item. Inherited from BaseLayoutItem.
Assign(BaseLayoutItem) Assigns the specified object’s property values to the current object’s corresponding properties.
BeginInit() Starts the component’s initialization. Inherited from BaseLayoutItem.
CanMove(LayoutItemDragController) Returns whether the layout item can be moved to a specific position. Inherited from BaseLayoutItem.
Clone(LayoutGroup, ILayoutControl) Creates a copy of the current layout item. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
GetDisplayText() Returns the BaseLayoutItem‘s BaseLayoutItem.Text value without HTML tags and hotkey prefixes (the “&” symbol). Inherited from BaseLayoutItem.
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) Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
Move(BaseLayoutItem, InsertType) Moves the item to the specified visual position within the LayoutControl. Inherited from BaseLayoutItem.
Move(LayoutItemDragController) Moves the item to the specified position within the LayoutControl. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
RestoreFromCustomization(LayoutItemDragController) Restores the current layout item from the Customization Form and displays it at the specified position within the LayoutControl. Inherited from BaseLayoutItem.
RestoreFromCustomization(LayoutGroup) Restores the current layout item from the Customization Form and adds it to the specified group with the default layout type. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.

Events

Name Description
Click Fires when the current item is clicked. Inherited from BaseLayoutItem.
CustomDraw Allows you to custom paint the current item. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
Hidden Fires after an item has been hidden. Inherited from BaseLayoutItem.
Hiding Fires when the item is about to be hidden (when dragging the item and dropping it onto on the Customization Form). Inherited from BaseLayoutItem.
MouseDown Occurs when the mouse pointer is over a layout item and a mouse button is pressed. Inherited from BaseLayoutItem.
MouseUp Occurs when the mouse button is released if it was pressed within a layout item. Inherited from BaseLayoutItem.
Showing Fires when the item is about to be added to the layout (by dragging it from the Customization Form). Inherited from BaseLayoutItem.
Shown Fires after an item has been made visible. Inherited from BaseLayoutItem.
TextChanged Fires after the layout item’s text has been changed. Inherited from BaseLayoutItem.
See Also