CaptionHelper.GetClassCaption(String) Method

Returns the display caption corresponding to a business class.

Namespace: DevExpress.ExpressApp.Utils

Assembly: DevExpress.ExpressApp.v25.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public static string GetClassCaption(
    string classFullName
)

VB.NET

Public Shared Function GetClassCaption(
    classFullName As String
) As String

Parameters

Name	Type	Description
classFullName	String	A string representing the fully-qualified name of a business class.

Returns

Type	Description
String	A string representing the display caption corresponding to the specified business class.

Remarks

For business classes used in an XAF application, this method returns the IModelClass.Caption property value of the corresponding Class node. For all the other classes, the GetClassCaption method returns the fully-qualified name of the class.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetClassCaption(String) method.

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#

XAF-search-objects-using-complex-criterion/CS/Dennis.Search.Win/SearchObjectViewController.cs#L95

if (genericType.IsAssignableFrom(typeInfo.Type) && !typeInfo.IsAbstract) {
    ChoiceActionItem item = new ChoiceActionItem(CaptionHelper.GetClassCaption(typeInfo.FullName), typeInfo.Type);
    item.ImageName = imageName;

VB.NET

XAF-search-objects-using-complex-criterion/VB/Dennis.Search.Win/SearchObjectViewController.vb#L117

If genericType.IsAssignableFrom(typeInfo.Type) AndAlso Not typeInfo.IsAbstract Then
    Dim item As ChoiceActionItem = New ChoiceActionItem(CaptionHelper.GetClassCaption(typeInfo.FullName), typeInfo.Type)
    item.ImageName = imageName