Class Form

Represents a "model" (in MVC terms) of a data-entry form. Form models are statically typed - contain fields and can contain "extra amorphous" data

Inheritance
System.Object
Doc
TypedDoc
AmorphousTypedDoc
Form
Implements
System.IEquatable<Doc>
System.Collections.Generic.IEnumerable<System.Object>
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Azos.Data
Assembly: Azos.dll
Syntax
[Serializable]
public abstract class Form : AmorphousTypedDoc, IConfigurable, IConfigurationPersistent, IEquatable<Doc>, IEnumerable<object>, IEnumerable, IValidatable, IJSONWritable, IAmorphousData

Constructors

Form()

Declaration
protected Form()

Fields

CSRFToken

Gets/sets CSRF token

Declaration
public string CSRFToken
Field Value
Type Description
System.String

FormMode

Gets/sets form mode - unspecified|insert|edit. This field may be queried by validate and save, i.e. Validate may perform extra cross checks on Insert - i.e. check whether some other user is already registered with the specified email in this form etc.

Declaration
public FormMode FormMode
Field Value
Type Description
FormMode

JSON_CSRF_PROPERTY

Declaration
public const string JSON_CSRF_PROPERTY = "__CSRFToken"
Field Value
Type Description
System.String

JSON_MODE_PROPERTY

Declaration
public const string JSON_MODE_PROPERTY = "__FormMode"
Field Value
Type Description
System.String

JSON_ROUNDTRIP_PROPERTY

Declaration
public const string JSON_ROUNDTRIP_PROPERTY = "__Roundtrip"
Field Value
Type Description
System.String

Properties

AmorphousDataEnabled

False by default for forms, safer for web. For example, no injection of unexpected fields can be done via web form post

Declaration
public override bool AmorphousDataEnabled { get; }
Property Value
Type Description
System.Boolean
Overrides

DataStoreTargetName

Override to supply target name used for validation

Declaration
public abstract string DataStoreTargetName { get; }
Property Value
Type Description
System.String

HasRoundtripBag

True if RoundtripBag is allocated

Declaration
public bool HasRoundtripBag { get; }
Property Value
Type Description
System.Boolean

RoundtripBag

Returns lazily-allocated RoundtripBag. Use HasRoundtripBag to see if it is allocated not to allocate on get

Declaration
public JSONDataMap RoundtripBag { get; }
Property Value
Type Description
JSONDataMap

Methods

DoSave(out Object)

Override to save model into data store. Return "predictable" exception (such as key violation) as a value instead of throwing. Throw only in "unpredictable" cases (such as DB connection is down, not enough space etc...). Return extra result obtained during save i.e. a db-assigned auto-inc field

Declaration
protected abstract Exception DoSave(out object saveResult)
Parameters
Type Name Description
System.Object saveResult
Returns
Type Description
System.Exception

Save(out Object)

Saves form into data store. The form is validated first and validation error is returned which indicates that save did not succeed due to validation error/s. The core implementation is in DoSave() that can also abort by either returning exception when predictable failure happens on save (i.e. key violation). Other exceptions are thrown. Returns extra result obtained during save i.e. a db-assigned auto-inc field

Declaration
public virtual Exception Save(out object saveResult)
Parameters
Type Name Description
System.Object saveResult
Returns
Type Description
System.Exception

Save<TSaveResult>(out TSaveResult)

Saves form into data store. The form is validated first and validation error is returned which indicates that save did not succeed due to validation error/s. The core implementation is in DoSave() that can also abort by either returning exception when predictable failure happens on save (i.e. key violation). Other exceptions are thrown. Returns extra result obtained during save i.e. a db-assigned auto-inc field

Declaration
public virtual Exception Save<TSaveResult>(out TSaveResult saveResult)
Parameters
Type Name Description
TSaveResult saveResult
Returns
Type Description
System.Exception
Type Parameters
Name Description
TSaveResult

SetRoundtripBagFromJSONString(String)

If non null or empty parses JSON content and sets the RoundtripBag

Declaration
public void SetRoundtripBagFromJSONString(string content)
Parameters
Type Name Description
System.String content

Implements

System.IEquatable<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods