Class LocatorDef

Namespace

Tripous.Data

Assembly

Tripous.Data.dll

Declarative definition of a locator resolution process.

public class LocatorDef : BaseDef, IDef, IJsonLoadable, INotifyPropertyChanged

Inheritance

object

BaseDef

LocatorDef

Implements

IDef

IJsonLoadable

INotifyPropertyChanged

Inherited Members

BaseDef.fTitleKey

BaseDef.fName

BaseDef.NotifyPropertyChanged(string)

BaseDef.GetTitleKey()

BaseDef.ToString()

BaseDef.JsonLoaded()

BaseDef.CreateNew()

BaseDef.Assign(IDef)

BaseDef.Clone()

BaseDef.Clear()

BaseDef.SplitTitleKeyToWordsWithPluralEnding()

BaseDef.Name

BaseDef.TitleKey

BaseDef.IsTitleKeyEmpty

BaseDef.Title

BaseDef.Tag

BaseDef.IsSerializable

BaseDef.PropertyChanged

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

TypeExtensions.InheritsFrom(object, Type)

Constructors

LocatorDef()

Constructor.

public LocatorDef()

Properties

ClassName

Gets or sets the class name of the locator implementation.

public string ClassName { get; set; }

Property Value

string

Fields

Gets or sets the fields that may participate in locator input, output or display.

public DefList<LocatorFieldDef> Fields { get; set; }

Property Value

DefList<LocatorFieldDef>

Form

Gets or sets the desktop form name used by reference menus.

public string Form { get; set; }

Property Value

string

KeyField

Gets or sets the field that provides the canonical identity returned by this locator.

public string KeyField { get; set; }

Property Value

string

ListVisibleFields

Gets or sets the fields displayed by locator list UIs.

public List<string> ListVisibleFields { get; set; }

Property Value

List<string>

MaximumResultCount

Gets or sets the maximum number of result rows returned before a result is considered too broad.

public int MaximumResultCount { get; set; }

Property Value

int

MinimumSearchLength

Gets or sets the minimum search text length required before resolution may run.

public int MinimumSearchLength { get; set; }

Property Value

int

MultiRowSearchFields

Gets or sets the business reference fields used for resolution by a multi-row locator UI.

public List<string> MultiRowSearchFields { get; set; }

Property Value

List<string>

OrderBy

Gets or sets the ORDER BY clause.

public string OrderBy { get; set; }

Property Value

string

ResultFields

Gets or sets the fields returned as locator output.

public List<string> ResultFields { get; set; }

Property Value

List<string>

SingleRowSearchFields

Gets or sets the business reference fields used for resolution by a single-row locator UI.

public List<string> SingleRowSearchFields { get; set; }

Property Value

List<string>

Source

Gets or sets the provider-neutral source reference used by the locator.

Depending on the locator implementation it may be a table name, SELECT statement, service URL, object list name, or any other source reference.

public string Source { get; set; }

Property Value

string

WebForm

Gets or sets the web form name used by web reference menus.

public string WebForm { get; set; }

Property Value

string

Methods

Add(string)

Adds a string field to the locator.

public LocatorFieldDef Add(string Name)

Parameters

Name string

Returns

LocatorFieldDef

Add(string, DataFieldType)

Adds a field to the locator.

public LocatorFieldDef Add(string Name, DataFieldType DataType)

Parameters

Name string

DataType DataFieldType

Returns

LocatorFieldDef

AddFields(params string[])

Adds string fields to the locator.

public void AddFields(params string[] Names)

Parameters

Names string[]

AddListVisibleFields(params string[])

Adds fields to the list-visible field list.

public void AddListVisibleFields(params string[] Names)

Parameters

Names string[]

AddMultiRowSearchFields(params string[])

Adds fields to the multi-row search field list.

public void AddMultiRowSearchFields(params string[] Names)

Parameters

Names string[]

AddResultFields(params string[])

Adds fields to the result field list.

public void AddResultFields(params string[] Names)

Parameters

Names string[]

AddSearchFields(params string[])

Adds fields to both single-row and multi-row search field lists.

public void AddSearchFields(params string[] Names)

Parameters

Names string[]

AddSingleRowSearchFields(params string[])

Adds fields to the single-row search field list.

public void AddSingleRowSearchFields(params string[] Names)

Parameters

Names string[]

CheckDescriptor()

Throws an exception if this descriptor is not fully defined.

public override void CheckDescriptor()

GetAllSearchFields()

Returns the union of all search fields.

public List<string> GetAllSearchFields()

Returns

List<string>

GetListVisibleFields()

Returns the fields displayed by locator list UIs.

public List<string> GetListVisibleFields()

Returns

List<string>

GetResultFields()

Returns the result fields.

public List<string> GetResultFields()

Returns

List<string>

GetSearchFields(bool)

Returns the search fields to use for single-row or multi-row locator resolution.

public List<string> GetSearchFields(bool IsMultiRow)

Parameters

IsMultiRow bool

Returns

List<string>

UpdateReferences()

Updates references such as when an instance has references to other instances.

public override void UpdateReferences()