BaseLayoutItem.Text Property

Gets or sets the text associated with the layout item.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v19.2.dll

Declaration

C#

[XtraSerializableProperty]
[Bindable(true)]
[DXCategory("Text")]
public virtual string Text { get; set; }

VB.NET

<XtraSerializableProperty>
<Bindable(True)>
<DXCategory("Text")>
Public Overridable Property Text As String

Property Value

Type	Description
String	A string that specifies the layout item’s text.

Remarks

This property specifies the text that is associated with the layout item. For LayoutControlItem items this text is displayed next to the item’s control. For LayoutControlGroup items the Text string represents the group’s caption.

To hide or display the text, use the BaseLayoutItem.TextVisible Boolean property. For LayoutControlItem items, the text region’s size can be modified with the BaseLayoutItem.TextSize property. For instance, you can use this property to allocate more space to the text region.

A LayoutControlItem‘s text can be displayed at the left, top, right or bottom edge of the item’s control. To change the text position, use the BaseLayoutItem.TextLocation property.

The Text property allows you to specify a hotkey (ALT+Character) a user can press to focus the layout item’s control. Prefix the target Character with the ampersand symbol (‘&’). This character is underscored when the ALT key is pressed at runtime. For the following layout item, the Text property is set to “Contact &Name”:

If the LayoutControlItem.AllowHtmlStringInCaption property is set to true, you can use HTML tags to format the Text. For detailed information, see HTML Text Formatting.

To get the plain display text (without HTML tags and the ampersand symbols, if any), use the BaseLayoutItem.GetDisplayText method.

Example

The following example shows how to format the BaseLayoutItem.Text using HTML tags. HTML formatting is enabled via the LayoutControlItem.AllowHtmlStringInCaption property.

C#

layoutControlItem1.Text = "<size=14>Size = 14 <u>Underline</u> <br> <size=11>Size = 11 <color=255, 0, 0>Red";
layoutControlItem1.AllowHtmlStringInCaption = true;
// Increase the control's height
layoutControlItem1.SizeConstraintsType = DevExpress.XtraLayout.SizeConstraintsType.Custom;
layoutControlItem1.MinSize = new Size(layoutControlItem1.MinSize.Width, 50);
layoutControlItem1.AppearanceItemCaption.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap;

VB.NET

LayoutControlItem1.Text = "<size=14>Size = 14 <u>Underline</u> <br> <size=11>Size = 11 <color=255, 0, 0>Red"
LayoutControlItem1.AllowHtmlStringInCaption = True
' Increase the control's height
LayoutControlItem1.SizeConstraintsType = DevExpress.XtraLayout.SizeConstraintsType.Custom
LayoutControlItem1.MinSize = New Size(LayoutControlItem1.MinSize.Width, 50)
LayoutControlItem1.AppearanceItemCaption.TextOptions.WordWrap = DevExpress.Utils.WordWrap.Wrap

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Text property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-async-mode-get-item-data/CS/ViewerForm1.cs#L17

async void OnDashboardViewerInitialized(object sender, EventArgs e) {
    simpleLabelItem1.Text = await GetLabelText("choroplethMapDashboardItem1", "Map");
    simpleLabelItem2.Text = await GetLabelText("gridDashboardItem1", "Grid");

how-to-create-and-place-the-emptyspaceitem-at-runtime-e1514/CS/WindowsApplication1/Form1.cs#L26

labelItem1.Control.Size = new Size(100, 100);
labelItem1.Text = "1";

XAF_how-to-show-a-custom-window-with-an-embedded-xaf-view-t483300/CS/SolutionWithCustomWindow.Module.Win/Controllers/LinkViewController.cs#L24

TextBox textBox1 = new TextBox();
item1.Text = "Company";
item1.Control = textBox1;

Reporting_embedded-end-user-report-designer-demonstration-e20017/CS/Contacts/Controls/PersonControl.cs#L100

SaveCategories();
layoutImage.Text = Person.Greeting.Replace("&", "and");
Person.Modified = DateTime.Now;

how-to-translate-non-localizable-elements-in-the-layoutview-customization-form-e3241/CS/TemplateCardCaptionLocalization/MyLayoutViewDesignerHelper.cs#L12

    base.SynchronizeDesignerFromView(view);
    DesignerControl.Root.Text = Resources.LayoutViewDesignerHelper_DesigherControl_Root_Text;
}

VB.NET

winforms-dashboard-async-mode-get-item-data/VB/ViewerForm1.vb#L18

Private Async Sub OnDashboardViewerInitialized(ByVal sender As Object, ByVal e As EventArgs)
    simpleLabelItem1.Text = Await GetLabelText("choroplethMapDashboardItem1", "Map")
    simpleLabelItem2.Text = Await GetLabelText("gridDashboardItem1", "Grid")

Reporting_embedded-end-user-report-designer-demonstration-e20017/VB/Contacts/Controls/PersonControl.vb#L99

    p.Modified = p.Added
    layoutImage.Text = "Picture"
Else

how-to-create-and-place-the-emptyspaceitem-at-runtime-e1514/VB/WindowsApplication1/Form1.vb#L28

labelItem1.Control.Size = New Size(100, 100)
labelItem1.Text = "1"

XAF_how-to-show-a-custom-window-with-an-embedded-xaf-view-t483300/VB/SolutionWithCustomWindow.Module.Win/Controllers/LinkViewController.vb#L26

Dim textBox1 As New TextBox()
item1.Text = "Company"
item1.Control = textBox1

how-to-translate-non-localizable-elements-in-the-layoutview-customization-form-e3241/VB/TemplateCardCaptionLocalization/MyLayoutViewDesignerHelper.vb#L15

    MyBase.SynchronizeDesignerFromView(view)
    DesignerControl.Root.Text = Global.Resources.LayoutViewDesignerHelper_DesigherControl_Root_Text
End Sub