Class LookUpBase

Namespace

ToSic.Eav.LookUp

Assembly

ToSic.Eav.Core.dll

Base Class to create your own LookUp Class - used by all Look-Ups.
Read more about this in LookUp System

[PublicApi]
public abstract class LookUpBase : ILookUp

Inheritance

object

LookUpBase

Implements

ILookUp

Derived

LookUpInDictionary

LookUpInLookUps

LookUpInNameValueCollection

LookUpIn<T>

Constructors

LookUpBase(string, string)

Base Class to create your own LookUp Class - used by all Look-Ups.
Read more about this in LookUp System

protected LookUpBase(string name, string description = "")

Parameters

name string

description string

Properties

Description

Additional description to better understand what each LookUp is for.

public virtual string Description { get; }

Property Value

string

Name

Gets the Name of this LookUp, e.g. QueryString or PipelineSettings

public string Name { get; }

Property Value

string

The name which is used to identify this LookUp, like in a ILookUpEngine

Methods

Format(bool)

public static string Format(bool value)

Parameters

value bool

Returns

string

Format(DateTime)

public static string Format(DateTime value)

Parameters

value DateTime

Returns

string

FormatValue(object, string, string[])

Take a specific result object (usually from an IEntity property) and format as needed.

protected string FormatValue(object valueObject, string format, string[] dimensions)

Parameters

valueObject object

format string

dimensions string[]

Returns

string

Get(string)

Gets a value by Name/key, will simply return the string or an empty string, in rare cases a null-value.

public virtual string Get(string key)

Parameters

key string

Returns

string

The resolved value, or an empty string if not found. Note that it could also resolve to an empty string if found - use Has to check for that case.

Get(string, string)

Gets a value by Name/key and tries to format it in a special way (like for dates)

public abstract string Get(string key, string format)

Parameters

key string

Name of the Property

format string

Format String

Returns

string

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.