Back to Devexpress

ToolbarFormControl.TitleItemLinks Property

windowsforms-devexpress-dot-xtrabars-dot-toolbarform-dot-toolbarformcontrol-1ea7a3b2.md

latest4.0 KB
Original Source

ToolbarFormControl.TitleItemLinks Property

Provides access to bar item links displayed in this ToolbarFormControl.

Namespace : DevExpress.XtraBars.ToolbarForm

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[XtraSerializableProperty(XtraSerializationVisibility.Collection, true, false, true, true, 0, XtraSerializationFlags.None)]
public ToolbarFormLinkCollection TitleItemLinks { get; }
vb
<XtraSerializableProperty(XtraSerializationVisibility.Collection, True, False, True, True, 0, XtraSerializationFlags.None)>
Public ReadOnly Property TitleItemLinks As ToolbarFormLinkCollection

Property Value

TypeDescription
DevExpress.XtraBars.ToolbarForm.ToolbarFormLinkCollection

The collection of bar item links.

|

Remarks

Both sides of a ToolbarFormControl have areas that can host bar items and links. These areas display items from the same TitleItemLinks collection. To specify whether an item should be aligned to the ToolbarFormControl’s left or right edge, specify the BarItem.Alignment property.

csharp
ToolbarForm myForm = new ToolbarForm();
 myForm.Size = new Size(800, 600);
 myForm.Text = "Toolbar Form";
 ToolbarFormManager tfcManager = new ToolbarFormManager() { Form = myForm };
 ToolbarFormControl tfcHeader = new ToolbarFormControl() { ToolbarForm = myForm, Manager = tfcManager};
 myForm.Controls.Add(tfcHeader);
 myForm.ToolbarFormControl = tfcHeader;

 //create four buttons
 BarButtonItem item1 = new BarButtonItem(tfcManager, "Button 1");
 BarButtonItem item2 = new BarButtonItem(tfcManager, "Button 2");
 BarButtonItem item3 = new BarButtonItem(tfcManager, "Button 3");
 BarButtonItem item4 = new BarButtonItem(tfcManager, "Button 4");
 //buttons 3 and 4 will be docked to the ToolbarFormControl's right edge
 item3.Alignment = item4.Alignment = BarItemLinkAlignment.Right;

 //Out of two items added to the TitleItemLinks collection, the item that was added first
 //will be closer to the form edge. For that reason, you need to populate the right area
 //backwards, i.e. start with rightmost item 
 tfcHeader.TitleItemLinks.AddRange(new BarItem[] { item1, item2, item4, item3});

 myForm.Show();
vb
Dim myForm As New ToolbarForm()
 myForm.Size = New Size(800, 600)
 myForm.Text = "Toolbar Form"
 Dim tfcManager As New ToolbarFormManager() With {.Form = myForm}
 Dim tfcHeader As New ToolbarFormControl() With {.ToolbarForm = myForm, .Manager = tfcManager}
 myForm.Controls.Add(tfcHeader)
 myForm.ToolbarFormControl = tfcHeader

 'create four buttons
 Dim item1 As New BarButtonItem(tfcManager, "Button 1")
 Dim item2 As New BarButtonItem(tfcManager, "Button 2")
 Dim item3 As New BarButtonItem(tfcManager, "Button 3")
 Dim item4 As New BarButtonItem(tfcManager, "Button 4")
 'buttons 3 and 4 will be docked to the ToolbarFormControl's right edge
 item4.Alignment = BarItemLinkAlignment.Right
 item3.Alignment = item4.Alignment

 'Out of two items added to the TitleItemLinks collection, the item that was added first
 'will be closer to the form edge. For that reason, you need to populate the right area
 'backwards, i.e. start with rightmost item 
 tfcHeader.TitleItemLinks.AddRange(New BarItem() { item1, item2, item4, item3})

 myForm.Show()

See Also

ToolbarFormControl Class

ToolbarFormControl Members

DevExpress.XtraBars.ToolbarForm Namespace