SettingsBase.Name Property

Specifies the unique identifier name for the extension.

Namespace: DevExpress.Web.Mvc

Assembly: DevExpress.Web.Mvc5.v23.2.dll

NuGet Package: DevExpress.Web.Mvc5

Declaration

C#

public string Name { get; set; }

VB.NET

Public Property Name As String

Property Value

Type	Description
String	The extension name.

Property Paths

You can access this nested property as listed below:

Object Type	Path to Name
MVCxFormLayoutItem	.NestedExtensionSettings .Name

Remarks

The extension name defined by the Name property can be used to access the extension client object on the client side.

var tbValue;
function preserveTextBoxValue(){
    tbValue = textBox1.GetText();
}

@Html.DevExpress().TextBox(
    settings => {
        settings.Name = "textBox1";
        settings.Text = "some text";
    }
).GetHtml()

Special Characters in the Name

If the Name property contains special characters, for instance, the dot (.), you cannot access a client object by this name. Call the GetByName(name) method to retrieve the client-side object instead.

@Html.DevExpress().TextBox(settings => {  
    settings.Name = "SomeType.SomeProp";  
}).GetHtml()  

var txt = ASPxClientControl.GetControlCollection().GetByName("SomeType.SomeProp");  
txt.SetText("Some Text");  

For more information, see the Client-Side API help topic.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Name 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#

asp-net-mvc-scheduler-use-checkboxlist-to-filter-resources/CS/Code/SchedulerHelper.cs#L20

SchedulerSettings settings = new SchedulerSettings();
settings.Name = "scheduler";
settings.CallbackRouteValues = new { Controller = "Home", Action = "SchedulerPartial" };

asp-net-mvc-scheduler-appointment-edit-form/CS/Code/SchedulerHelper.cs#L21

SchedulerSettings settings = new SchedulerSettings();
settings.Name = "scheduler";
settings.CallbackRouteValues = new { Controller = "Home", Action = "SchedulerPartial" };

asp-net-mvc-scheduler-fetch-appointment-event/CS/DevExpressMvcSchedulerFetchAppointments/Models/SchedulerSettingsHelper.cs#L22

SchedulerSettings settings = new SchedulerSettings();
settings.Name = "scheduler";
settings.CallbackRouteValues = new { Controller = "Home", Action = "SchedulerPartial" };

asp-net-mvc-grid-export-colored-grid-in-wysiwyg-mode/CS/Controllers/HomeController.cs#L44

settings.Name = "gvProducts";
settings.CallbackRouteValues = new { Controller = "Home", Action = "GridViewPartialProducts" };

spellchecker-customizing-built-in-dialogs-t316492/CS/SpellCheckerCustomDialogs/Helpers/SpellCheckerHelper.cs#L26

SpellCheckerSettings settings = new SpellCheckerSettings();
settings.Name = "SpellChecker";
settings.CallbackRouteValues = new { Action = "IndexPartial", Controller = "Home" };

VB.NET

asp-net-mvc-scheduler-use-checkboxlist-to-filter-resources/VB/Code/SchedulerHelper.vb#L25

Dim settings As New SchedulerSettings()
settings.Name = "scheduler"
settings.CallbackRouteValues = New With {Key .Controller = "Home", Key .Action = "SchedulerPartial"}

asp-net-mvc-scheduler-appointment-edit-form/VB/Code/SchedulerHelper.vb#L24

Dim settings As DevExpress.Web.Mvc.SchedulerSettings = New DevExpress.Web.Mvc.SchedulerSettings()
settings.Name = "scheduler"
settings.CallbackRouteValues = New With {.Controller = "Home", .Action = "SchedulerPartial"}

asp-net-mvc-scheduler-fetch-appointment-event/VB/DevExpressMvcSchedulerFetchAppointments/Models/SchedulerSettingsHelper.vb#L20

Dim settings As New SchedulerSettings()
settings.Name = "scheduler"
settings.CallbackRouteValues = New With {Key .Controller = "Home", Key .Action = "SchedulerPartial"}

asp-net-mvc-grid-export-colored-grid-in-wysiwyg-mode/VB/Controllers/HomeController.vb#L51

settings.Name = "gvProducts"
settings.CallbackRouteValues = New With {Key .Controller = "Home", Key .Action = "GridViewPartialProducts"}

spellchecker-customizing-built-in-dialogs-t316492/VB/SpellCheckerCustomDialogs_vb/Helpers/SpellCheckerHelper.vb#L28

Dim settings As New SpellCheckerSettings()
settings.Name = "SpellChecker"
settings.CallbackRouteValues = New With {Key .Action = "IndexPartial", Key .Controller = "Home"}