SettingsBase.Name Property

Gets or sets the unique identifier name for the extension.

Namespace: DevExpress.Web.Mvc

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

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
PivotGridSettings	.PivotCustomizationExtensionSettings.Name
ReportToolbarExtension	.Settings.Name
ReportViewerExtension	.Settings.Name
SchedulerSettings	.DateNavigatorExtensionSettings.Name
SchedulerStorageControlSettings	.DateNavigatorExtensionSettings.Name

Remarks

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

Example

View code (ASPX):

C#

...
<script type="text/javascript">
    var tbValue;

    function preserveTextBoxValue(){
        tbValue = textBox1.GetText();
    }
</script>

...

        <% 
            Html.DevExpress().TextBox(
                settings => {
                    settings.Name = "textBox1";
                    settings.Text = "some text";
                }
            )
            .Render();
        %>

View code (Razor):

C#

...
<script type="text/javascript">
    var tbValue;

    function preserveTextBoxValue(){
        tbValue = textBox1.GetText();
    }
</script>

...

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

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

Note

If the Name property contains special characters, use the approach described in the following Knowledge Base Article to access the client-side programmatic object.

KA18687: How to use the ClientInstanceName and Name properties when they contain special characters

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.

VB.NET

how-to-export-gridview-data-to-different-text-formats-e3898/VB/DXWebApplication1/Controllers/HomeController.vb#L60

settings.Name = "gvTypedListDataBinding"
settings.CallbackRouteValues = New With { _

scheduler-best-practices-e4877/VB/Code/SchedulerHelper.vb#L24

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

mvc-scheduler-simplest-implementation-of-an-appointment-editing-form-e4676/VB/Code/SchedulerHelper.vb#L25

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

how-to-filter-resources-in-scheduler-via-checkboxlist-e4717/VB/Code/SchedulerHelper.vb#L25

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

how-to-bind-scheduler-to-xpo-e4731/VB/Helpers/SchedulerHelper.vb#L23

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

C#

mvc-responsive-web-application/CS/MvcResponsiveWebApplication/Models/Scheduler/SchedulerHelper.cs#L17

SchedulerSettings settings = new SchedulerSettings();
settings.Name = "scheduler";

scheduler-best-practices-e4877/CS/Code/SchedulerHelper.cs#L21

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

how-to-filter-resources-in-scheduler-via-checkboxlist-e4717/CS/Code/SchedulerHelper.cs#L20

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

how-to-bind-scheduler-to-xpo-e4731/CS/Helpers/SchedulerHelper.cs#L20

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

how-to-use-devexpress-callback-extensions-without-creating-a-separate-partial-view-e5027/CS/DynamicView/Helpers/GridHelper.cs#L18

var settings = new GridViewSettings();
settings.Name = "gridView";
settings.CallbackRouteValues = new { Controller = "Home", Action = "GridViewPartial" };