Back to Devexpress

TabbedGroup Members

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

latest35.2 KB
Original Source

TabbedGroup Members

Represents the base class for tabbed layout groups.

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.
AllowCustomizeChildrenGets or sets whether the layout of the current container can be customized using drag and drop. Inherited from LayoutItemContainer.
AllowHideGets or sets whether the item can be hidden to the Customization Form. Inherited from BaseLayoutItem.
AllowHtmlDrawGets or sets whether or not tabbed group captions can be formatted using HTML tags.
AppearanceGroupProvides access to the properties that control the group’s appearance. Inherited from LayoutItemContainer.
AppearanceItemCaptionGets the appearance settings used to paint a layout item’s caption. Inherited from BaseLayoutItem.
AppearanceTabPageProvides access to a tabbed group’s appearance settings. Inherited from LayoutItemContainer.
BestFitWeightGets or sets the width of the current BaseLayoutItem relative to other items’ width after the LayoutControl.BestFit method has been called. Inherited from BaseLayoutItem.
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.
CaptionImagePaddingGets or sets default padding for images displayed in the page headers belonging to the current group.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CustomHeaderButtonsProvides access to the collection of custom buttons displayed in the tabbed group header.
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.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
ExpandedNot supported. Inherited from BaseLayoutItem.
HeaderAutoFillGets or sets whether tab headers are stretched to the width of the TabbedGroup‘s header region.
HeaderOrientationGets or sets the orientation of tab headers.
HeightGets or sets the layout item’s height. Inherited from BaseLayoutItem.
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.
IsUpdateLockedGets whether the layout item has been locked for updating. Inherited from BaseLayoutItem.
LocationGets or sets the coordinates of the layout item’s top left corner. Inherited from BaseLayoutItem.
MaxSizeGets the maximum size of the tabbed group.
MinSizeGets the minimum size of the tabbed group.
MultiLineGets or sets whether more than one row of tabs can be displayed.
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.
OptionsTableLayoutItemProvides access to the options that specify how a layout item is arranged within a table layout. Inherited from BaseLayoutItem.
OptionsToolTipThis property is not supported by the TabbedGroup class.
OwnerGets or set the LayoutControl that owns the current tabbed group.
PaddingGets or sets the amount of space in pixels between the item’s borders and its contents. Inherited from BaseLayoutItem.
PageImagePositionGets or sets the alignment of images displayed within headers of pages that belong to the current group.
PaintAppearanceGroupProvides access to the appearance settings currently used to paint the layout group. Inherited from LayoutItemContainer.
PaintAppearanceItemCaptionProvides access to the appearance settings currently used to paint layout items that belong to the current container. Inherited from LayoutItemContainer.
ParentGets or sets the layout group that owns the LayoutItemContainer. Inherited from LayoutItemContainer.
ParentNameGets or sets the name of the item’s parent. Inherited from BaseLayoutItem.
SelectedGets or sets the selection state of the current item. Inherited from BaseLayoutItem.
SelectedTabPageGets or sets the currently selected layout group within the tabbed group.
SelectedTabPageIndexGets or sets the index of the currently selected tab page.
SelectedTabPageNameGets or sets the name of the tab page currently being selected.
ShowInCustomizationFormGets or sets whether the layout item is displayed within the Customization Form when the item is hidden. Inherited from BaseLayoutItem.
ShowTabHeaderGets or sets whether tab headers are shown.
SiteGets or sets the ISite of the Component. Inherited from Component.
SizeGets or sets the layout item’s size. Inherited from BaseLayoutItem.
SpacingGets or sets the outer indents of the item’s borders. Inherited from BaseLayoutItem.
StartNewLineGets or sets whether the current item starts a new row within a flow layout. Inherited from BaseLayoutItem.
TabPagesGets the collection of layout groups which is owned by the current tabbed group.
TabPageWidthGets or sets the width, in pixels, of tab headers. Inherited from LayoutItemContainer.
TagGets or sets an object that contains data on the current layout item. Inherited from BaseLayoutItem.
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. Inherited from BaseLayoutItem.
TextLocationGets or sets the container’s side along which its caption is displayed. Inherited from LayoutItemContainer.
TextSizeGets or sets the size of the text region.
TextToControlDistanceNot supported. Inherited from LayoutItemContainer.
TextVisibleGets or sets whether the current object’s text region is visible. This property is not supported by the TabbedGroup class.
TransitionProvides access to state animation parameters.
TypeNameGets the name of the item’s type.
ViewInfoGets the object which contains the information used to render the tabbed group.
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 item that belongs to the current layout tabbed group.
AddTabPage()Adds a new tabbed page to the current tabbed group.
AddTabPage(LayoutGroup, String, Boolean)Appends the specified tab page to the TabbedGroup.TabPages collection.
AddTabPage(LayoutGroup, String)Appends the specified tab page with the specified text to the TabbedGroup.TabPages collection.
AddTabPage(LayoutGroup)Appends the specified tab page to the TabbedGroup.TabPages collection.
AddTabPage(String)Creates a new tab page with the specified text and appends it to the TabbedGroup.TabPages collection.
Assign(BaseLayoutItem)Assigns the specified object’s property values to the current object’s corresponding properties. Inherited from BaseLayoutItem.
BeginInit()Starts the component’s initialization. Inherited from BaseLayoutItem.
BeginUpdate()Locks the LayoutItemContainer object by preventing visual updates of the object and its elements until the EndUpdate method is called. Inherited from LayoutItemContainer.
CanMove(LayoutItemDragController)Returns whether the layout item can be moved to a specific position. Inherited from BaseLayoutItem.
Clear()Removes all tab pages from the TabbedControlGroup.TabPages collection.
Clear(Boolean)Removes all tab pages from the TabbedControlGroup.TabPages collection.
Clone(LayoutGroup, ILayoutControl)Creates a copy of the current layout item. Inherited from BaseLayoutItem.
Contains(BaseLayoutItem)Gets whether the specified item belongs to the current container. Inherited from LayoutItemContainer.
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.
EndUpdate()Unlocks the LayoutItemContainer object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from LayoutItemContainer.
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. 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) 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. Inherited from BaseLayoutItem.
InitializeLifetimeService()Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
InsertTabPage(LayoutGroup, LayoutGroup, InsertLocation)Adds the page to the TabbedGroup.TabPages collection before or after the specified page.
InsertTabPage(Int32, LayoutGroup)Adds the specified page to the TabbedGroup.TabPages collection at the specified position.
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.
MoveTabPage(LayoutItemDragController)Moves the page to another position within the TabbedGroup.TabPages collection.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
RemoveTabPage(LayoutGroup)Removes the specified tab page from the TabbedControlGroup.TabPages collection.
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.
Ungroup()Ungroups the tabbed group.
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.
CustomDrawHeaderButtonAllows you to custom paint header buttons (TabbedGroup.CustomHeaderButtons).
CustomDrawTabHeaderAllows you to custom paint tabs.
CustomHeaderButtonClickOccurs when a custom header button is clicked.
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.
SelectedPageChangeAnimationCompleted
SelectedPageChangedOccurs when a tab page is activated.
SelectedPageChangingEnables you to prevent changing the selected page.
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

TabbedGroup Class

DevExpress.XtraLayout Namespace