LayoutControl.GetCustomizationDefaultLabel(UIElement) Method

Gets the default label for a layout item, when this item is displayed in the Available Items List.

Namespace: DevExpress.Xpf.LayoutControl

Assembly: DevExpress.Xpf.LayoutControl.v20.1.dll

Declaration

public static string GetCustomizationDefaultLabel(
    UIElement element
)
Public Shared Function GetCustomizationDefaultLabel(
    element As UIElement
) As String

Parameters

Name Type Description
element UIElement

An element whose default customization label is to be returned.

Returns

Type Description
String

A string that specifies the default label for a layout item, when this item is displayed in the Available Items List.

Remarks

Default customization labels are calculated for items by the GetCustomizationDefaultLabel function. To provide custom customization labels, use the LayoutControl.CustomizationLabel attached property.

The following table shows the values returned by the GetCustomizationDefaultLabel function for various layout elements:

Element

Return Value

ContentControl

ContentControl.Content

If this value is null or an empty string, the name of the element's type is returned, wrapped with square brackets.

Descendants of DevExpress.Xpf.Core.ContentControlBase (e.g. GroupBox)

ContentControlBase.Content

If this value is null or an empty string, the name of the element's type is returned, wrapped with square brackets.

LayoutGroup

LayoutGroup.Header

If this value is null or an empty string, the name of the element's type is returned, wrapped with square brackets.

LayoutItem

LayoutItem.Label

If this value is null or an empty string, the name of the element's type is returned, wrapped with square brackets.

Other cases

The name of the element's type is returned, wrapped with square brackets.

See Also