Back to Devexpress

SplitterItem Members

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

latest37.0 KB
Original Source

SplitterItem Members

Allows you to resize and optionally collapse/expand adjacent layout items. Not supported in Table Layout and Flow Layout modes.

Constructors

NameDescription
SplitterItem()Initializes a new instance of the SplitterItem class.
SplitterItem(LayoutControlGroup)Initializes a new instance of the SplitterItem class with the specified parent.

Properties

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.
AllowAutoAlignmentObsolete. Gets or sets whether the auto-alignment feature is enabled for the item. Inherited from LayoutControlItem.
AllowGlyphSkinningGets or sets whether a label’s icon is filled with the label’s foreground color. This property is obsolete. Use the LayoutControlItem.ImageOptions.AllowGlyphSkinning property instead. Inherited from LayoutControlItem.
AllowHideGets or sets whether the item can be hidden to the Customization Form. Inherited from BaseLayoutItem.
AllowHotTrackGets whether the layout item’s borders are highlighted when the mouse cursor hovers over the layout items
AllowHtmlStringInCaptionThis member supports the internal infrastructure, and is not intended to be used directly from your code.
AppearanceItemCaptionGets the appearance settings used to paint an item’s caption. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
AppearanceItemCaptionDisabledGets appearance settings used to paint the caption of a layout item when the item is disabled. Inherited from LayoutControlItem.
BestFitWeightThis member supports the internal infrastructure, and is not intended to be used directly from your code.
BindingContextGets or sets the BindingContext for the item. Inherited from BaseLayoutItem.
BoundsGets the layout item’s bounding rectangle. Inherited from BaseLayoutItem.
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.
ContentHorzAlignmentFor internal use. Inherited from EmptySpaceItem.
ContentVertAlignmentFor internal use. Inherited from EmptySpaceItem.
ContentVisibleThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
ControlNot supported. Inherited from EmptySpaceItem.
ControlAlignmentThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
ControlMaxSizeNot supported. Inherited from EmptySpaceItem.
ControlMinSizeNot supported. Inherited from EmptySpaceItem.
ControlNameThis property is for internal use only. It is used in serialization. Do not change it. Inherited from LayoutControlItem.
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.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
EnabledGets or sets whether the layout item and its control are enabled. Inherited from LayoutControlItem.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpandedNot supported. Inherited from LayoutControlItem.
FillControlToClientAreaThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
FixedStyleGets or sets whether and which layout item/group is fixed.
HeightGets or sets the layout item’s height. Inherited from BaseLayoutItem.
HighlightFocusedItemThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
ImageThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
ImageAlignmentThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
ImageIndexThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
ImageOptionsThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
ImagesGets a collection of icons that can be displayed in the item’s label. Inherited from LayoutControlItem.
ImageToTextDistanceThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
InvertedGets or sets whether the splitter collapses leftwards (for the vertically oriented splitter) and upwards (for the horizontally oriented splitter), or in the opposite directions (rightwards and downwards, respectively).
IsAccessibleInherited from LayoutControlItem.
IsCollapsedGets or sets whether the layout content is collapsed using the current splitter.
IsCollapsibleGets or sets whether the layout content can be collapsed using the current splitter.
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.
IsHorizontalGets whether the splitter item is oriented horizontally.
IsUpdateLockedGets whether the layout item has been locked for updating. Inherited from BaseLayoutItem.
IsVerticalGets whether the splitter item is oriented vertically.
ItemImagesGets a collection of icons that can be displayed in the item’s label. Inherited from LayoutControlItem.
LocationGets or sets the coordinates of the layout item’s top left corner. Inherited from BaseLayoutItem.
MaxSizeGets or set the maximum size of the splitter item. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
MinSizeGets or sets the minimum size of the splitter item. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
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.
OptionsItemToolTipObsolete. This member is obsolete. Use the BaseLayoutItem.OptionsToolTip property instead. Inherited from BaseLayoutItem.
OptionsPrintThe item’s print/export options. Inherited from LayoutControlItem.
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 LayoutControlItem.
PaddingGets or sets the amount of space in pixels between the item’s borders and its contents. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
PaintAppearanceItemCaptionProvides access to the appearance settings currently used to paint the layout item. Inherited from BaseLayoutItem.
ParentGets or sets the group that owns the current item. Inherited from BaseLayoutItem.
ParentNameGets or sets the name of the item’s parent. Inherited from BaseLayoutItem.
PositionGets or sets the vertical (horizontal) separator position relative to the layout group left (top) edge.
ResizeModeGets or sets the splitter’s resize mode.
SelectedGets or sets the selection state of the current item. Inherited from BaseLayoutItem.
ShowInCustomizationFormGets or sets whether the layout item is displayed within the Customization Form when the item is hidden. Inherited from BaseLayoutItem.
ShowSplitGlyphGets or sets whether to display the split glyph.
SiteGets or sets the ISite of the Component. Inherited from Component.
SizeGets or sets the splitter item’s size.
SizeConstraintsTypeGets or sets the size constraints type. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
SpacingGets or sets the outer indents of the item’s borders. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
SplitterWidthGets or sets the splitter’s width.
StartNewLineGets or sets whether the current item starts a new row within a flow layout. Inherited from BaseLayoutItem.
SvgImageGets or sets the vector image for this item’s label. This property is obsolete. Use the LayoutControlItem.ImageOptions.SvgImage property instead. Inherited from LayoutControlItem.
SvgImageSizeGets or sets the size of vector image for this item’s label. Inherited from LayoutControlItem.
TagGets or sets an object that contains data on the current layout item. Inherited from BaseLayoutItem.
TextGets or sets the item’s text. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
TextAlignModeThis member supports the internal infrastructure and is not intended to be used directly from your code.
TextLocationNot supported. Inherited from EmptySpaceItem.
TextSizeGets or sets the size of the text region. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
TextToControlDistanceNot supported. Inherited from EmptySpaceItem.
TextVisibleGets whether the text region is visible. This member supports the .NET Framework infrastructure and is not intended to be used directly from your code.
TrimClientAreaToControlThis member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from EmptySpaceItem.
TypeNameGets the name of the item’s type.
ViewInfoGets the object which contains information used to render the layout item. Inherited from LayoutControlItem.
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.

Methods

NameDescription
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. Inherited from LayoutControlItem.
BeginInit()Starts the item’s initialization.
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()Ends the item’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()Returns the splitter item’s name.
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) protectedReturns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetSizingRect()Returns the bounds of the region used to drag the splitter item. This method supports the internal infrastructure and is not intended to be used directly from your code.
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() 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. 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) 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. 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

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

See Also

SplitterItem Class

DevExpress.XtraLayout Namespace