Class FieldSpec

Namespace

The.Web.Entities

Assembly

Instagile.Web.Client.dll

Describes how one edit-form field renders and behaves: its component, label, height and visibility/editability combinators. Paired with a PropertyBinding in a RowSpec and resolved into a FieldModel by the edit components - the edit-view analog of CellSpec. Most fields are the generic FieldSpec<T, U, V>.

public abstract class FieldSpec

Inheritance

object

FieldSpec

Derived

FieldSpec<T, U, V>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

FieldSpec(string?, string?, int, int?, bool, bool, IEnumerable<IFieldParameter>?)

public FieldSpec(string? label, string? helpText = null, int rows = 1, int? maxlength = null, bool isReadOnly = false, bool isAdminOnly = false, IEnumerable<IFieldParameter>? parameters = null)

Parameters

label string

helpText string

rows int

maxlength int?

isReadOnly bool

isAdminOnly bool

parameters IEnumerable<IFieldParameter>

Methods

CreateModel(FieldContext, PropertyBinding)

public abstract FieldModel CreateModel(FieldContext context, PropertyBinding binding)

Parameters

context FieldContext

binding PropertyBinding

Returns

FieldModel

Height(Func<FieldContext, FieldModel, int>)

Set the field height from its FieldContext and resolved FieldModel, so it can depend on chrome state (e.g. low density) or the field's resolved IsReadOnly.

public FieldSpec Height(Func<FieldContext, FieldModel, int> getRows)

Parameters

getRows Func<FieldContext, FieldModel, int>

Returns

FieldSpec

Height(Func<FieldContext, FieldModel, FieldHeight>)

Set the field height from its FieldContext and resolved FieldModel, so it can depend on chrome state (e.g. low density) or the field's resolved IsReadOnly.

public FieldSpec Height(Func<FieldContext, FieldModel, FieldHeight> getRows)

Parameters

getRows Func<FieldContext, FieldModel, FieldHeight>

Returns

FieldSpec

Height(Func<IServices, int>)

public FieldSpec Height(Func<IServices, int> getRows)

Parameters

getRows Func<IServices, int>

Returns

FieldSpec

Height(Func<IServices, IEntity, int>)

public FieldSpec Height(Func<IServices, IEntity, int> getRows)

Parameters

getRows Func<IServices, IEntity, int>

Returns

FieldSpec

Height(Func<IServices, IEntity, FieldHeight>)

public FieldSpec Height(Func<IServices, IEntity, FieldHeight> getRows)

Parameters

getRows Func<IServices, IEntity, FieldHeight>

Returns

FieldSpec

Height(Func<IServices, FieldHeight>)

public FieldSpec Height(Func<IServices, FieldHeight> getRows)

Parameters

getRows Func<IServices, FieldHeight>

Returns

FieldSpec

Height(int)

public FieldSpec Height(int rows)

Parameters

rows int

Returns

FieldSpec

Height(FieldHeight)

public FieldSpec Height(FieldHeight height)

Parameters

height FieldHeight

Returns

FieldSpec

Height<T>(Func<IServices, T, int>)

public FieldSpec Height<T>(Func<IServices, T, int> getRows) where T : IEntity

Parameters

getRows Func<IServices, T, int>

Returns

FieldSpec

Type Parameters

T

Height<T>(Func<IServices, T, FieldHeight>)

public FieldSpec Height<T>(Func<IServices, T, FieldHeight> getRows) where T : IEntity

Parameters

getRows Func<IServices, T, FieldHeight>

Returns

FieldSpec

Type Parameters

T

Hidden()

public FieldSpec Hidden()

Returns

FieldSpec

HiddenIf(Func<FieldContext, bool>)

public FieldSpec HiddenIf(Func<FieldContext, bool> predicate)

Parameters

predicate Func<FieldContext, bool>

Returns

FieldSpec

HiddenIf(Func<IServices, IEntity, bool>)

public FieldSpec HiddenIf(Func<IServices, IEntity, bool> predicate)

Parameters

predicate Func<IServices, IEntity, bool>

Returns

FieldSpec

HiddenIf<T>(Func<IServices, T, bool>)

public FieldSpec HiddenIf<T>(Func<IServices, T, bool> predicate) where T : IEntity

Parameters

predicate Func<IServices, T, bool>

Returns

FieldSpec

Type Parameters

T

ReadOnly()

public FieldSpec ReadOnly()

Returns

FieldSpec

ReadOnlyIf(Func<FieldContext, bool>)

public FieldSpec ReadOnlyIf(Func<FieldContext, bool> predicate)

Parameters

predicate Func<FieldContext, bool>

Returns

FieldSpec

ReadOnlyIf(Func<IServices, IEntity, bool>)

public FieldSpec ReadOnlyIf(Func<IServices, IEntity, bool> predicate)

Parameters

predicate Func<IServices, IEntity, bool>

Returns

FieldSpec

ReadOnlyIf<T>(Func<IServices, T, bool>)

public FieldSpec ReadOnlyIf<T>(Func<IServices, T, bool> predicate) where T : IEntity

Parameters

predicate Func<IServices, T, bool>

Returns

FieldSpec

Type Parameters

T

ReadWrite()

public FieldSpec ReadWrite()

Returns

FieldSpec

ReadWriteIf(Func<FieldContext, bool>)

public FieldSpec ReadWriteIf(Func<FieldContext, bool> predicate)

Parameters

predicate Func<FieldContext, bool>

Returns

FieldSpec

ReadWriteIf(Func<IServices, IEntity, bool>)

public FieldSpec ReadWriteIf(Func<IServices, IEntity, bool> predicate)

Parameters

predicate Func<IServices, IEntity, bool>

Returns

FieldSpec

ReadWriteIf<T>(Func<IServices, T, bool>)

public FieldSpec ReadWriteIf<T>(Func<IServices, T, bool> predicate) where T : IEntity

Parameters

predicate Func<IServices, T, bool>

Returns

FieldSpec

Type Parameters

T

Rename()

Removes the label from a field, making it nameless and full-width

public FieldSpec Rename()

Returns

FieldSpec

Rename(Func<IServices, string?>)

Sets the label for a field

public FieldSpec Rename(Func<IServices, string?> getLabel)

Parameters

getLabel Func<IServices, string>

Returns

FieldSpec

Rename(Func<IServices, IEntity, string?>)

Sets the label for a field at runtime based on entity data

public FieldSpec Rename(Func<IServices, IEntity, string?> getLabel)

Parameters

getLabel Func<IServices, IEntity, string>

Returns

FieldSpec

Rename(string?)

Sets the label for a field

public FieldSpec Rename(string? label)

Parameters

label string

Returns

FieldSpec

Rename<T>(Func<IServices, T, string?>)

Sets the label for a field at runtime based on entity data

public FieldSpec Rename<T>(Func<IServices, T, string?> getLabel) where T : IEntity

Parameters

getLabel Func<IServices, T, string>

Returns

FieldSpec

Type Parameters

T

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Visible()

public FieldSpec Visible()

Returns

FieldSpec

VisibleIf(Func<FieldContext, bool>)

public FieldSpec VisibleIf(Func<FieldContext, bool> predicate)

Parameters

predicate Func<FieldContext, bool>

Returns

FieldSpec

VisibleIf(Func<IServices, IEntity, bool>)

public FieldSpec VisibleIf(Func<IServices, IEntity, bool> predicate)

Parameters

predicate Func<IServices, IEntity, bool>

Returns

FieldSpec

VisibleIf<T>(Func<IServices, T, bool>)

public FieldSpec VisibleIf<T>(Func<IServices, T, bool> predicate) where T : IEntity

Parameters

predicate Func<IServices, T, bool>

Returns

FieldSpec

Type Parameters

T

WithHelpText(string)

public FieldSpec WithHelpText(string helpText)

Parameters

helpText string

Returns

FieldSpec

WithLabelComponent<TFieldLabel>()

public FieldSpec WithLabelComponent<TFieldLabel>() where TFieldLabel : FieldLabel

Returns

FieldSpec

Type Parameters

TFieldLabel

WithMaxLength(int)

public FieldSpec WithMaxLength(int maxLength)

Parameters

maxLength int

Returns

FieldSpec

WithParameters(params IFieldParameter[])

public FieldSpec WithParameters(params IFieldParameter[] parameters)

Parameters

parameters IFieldParameter[]

Returns

FieldSpec

WithRowOrDefault<T>(Func<IServices, IEntity, T>, FieldContext, T)

protected static T WithRowOrDefault<T>(Func<IServices, IEntity, T> f, FieldContext ctx, T fallback)

Parameters

f Func<IServices, IEntity, T>

ctx FieldContext

fallback T

Returns

T

Type Parameters

T

WithRowOrDefault<T, U>(Func<IServices, U, T>, FieldContext, T)

protected static T WithRowOrDefault<T, U>(Func<IServices, U, T> f, FieldContext ctx, T fallback)

Parameters

f Func<IServices, U, T>

ctx FieldContext

fallback T

Returns

T

Type Parameters

T

U