ViewComponentDescriptor.ShortName Property

Definition

Namespace:

Microsoft.AspNetCore.Mvc.ViewComponents

Assembly:

Microsoft.AspNetCore.Mvc.ViewFeatures.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Gets or sets the short name.

public:
 property System::String ^ ShortName { System::String ^ get(); void set(System::String ^ value); };

public string ShortName { get; set; }

member this.ShortName : string with get, set

Public Property ShortName As String

Property Value

String

Remarks

The short name is defaulted to the name of the view component class. If the view component class uses ViewComponent as a suffix, the suffix will be omitted from the ShortName.

Class Name: Contoso.Products.LoginViewComponent View Component ShortName: Login

Class Name: Contoso.Blog.Tags View Component ShortName: Tags

If Name is used to set a name, then the last segment of the value (using '.' as a separate) will be used as the ShortName.

[ViewComponent(Name = "Contoso.Forum.UsersOnline")] public class OnlineUsersViewComponent { } View Component ShortName: UsersOnline