ServiceLookupEditorBaseAttribute class

namespace: Serenity.ComponentModel   assemblySerenity.Net.Core

Base class for service lookup based editor types

[AttributeUsage(AttributeTargets.All)]
public abstract class ServiceLookupEditorBaseAttribute : CustomEditorAttribute

Public Members

name description
AutoComplete { get; set; } Allows dynamically creating new options from text input by the user in the search box. This option should only be used for free text inputs, not ID / Text pairs. When this option is enabled InplaceAdd cannot be used. Newly created option will have same ID / Text which is user entered text.
CascadeField { get; set; } Cascade filtering field (items will be filtered on this key, e.g. CountryID)
CascadeFrom { get; set; } ID (can be relative) of the editor that this editor will cascade from, e.g. Country
CascadeValue { get; set; } Cascade filtering value, usually set by CascadeFrom editor, e.g. the integer value of CountryID If null or empty, and CascadeField is set, all items are filtered
ColumnSelection { get; set; } Column selection, defaults to KeyOnly
Delimited { get; set; } Use comma separated string instead of an array to serialize values.
DialogType { get; set; } This property is meaningful when InplaceAdd is true. By default, dialog type name is determined by service, e.g. if service is "Northwind/CustomerCity/List", a dialog class named "Northwind.CustomerCityDialog" is used. If dialog type is different than the service, set this to classname, e.g. "MyModule.MyDialog"
ExcludeColumns { get; set; } Exclude columns list
FilterField { get; set; } Optional filtering field (items will be filtered on this key, e.g. GroupID)
FilterValue { get; set; } Optional filtering value, e.g. the integer value of GroupID. If null or empty string no filtering occurs.
IdField { get; set; } Name of the id field
IncludeColumns { get; set; } Include columns list, defaults to id, text, and [LookupInclude] columns.
IncludeDeleted { get; set; } Include deleted, defaults to false
InplaceAdd { get; set; } Enable inplace add / edit functionality
InplaceAddPermission { get; set; } Permission required to use inplace add / edit
ItemType { get; set; } Gets/sets row type related with this service lookup editor
MinimumResultsForSearch { get; set; } The minimum number of results that must be initially (after opening the dropdown for the first time) populated in order to keep the search field. This is useful for cases where local data is used with just a few results, in which case the search box is not very useful and wastes screen space. The option can be set to a negative value to permanently hide the search field.
Multiple { get; set; } Allow multiple selection. Make sure your field is a List. You may also set CommaSeparated to use a string field.
OpenDialogAsPanel { get; set; } Open dialogs as panel (default value is null, which uses panel attribute on dialog class)
PageSize { get; set; } Page size used while loading records, default 100
Service { get; set; } List service url, e.g. Northwind/Customer/List. It can be an absolute or relative URL to ~/Services
Sort { get; set; } Sort order for records, defaults to text field
TextField { get; set; } Name of the text field

Protected Members

name description
ServiceLookupEditorBaseAttribute(…) Initializes a new instance of the ServiceLookupEditorBaseAttribute class.

See Also