DataStandard Class

Data basic fields and inherited class DbContext and used inerface IDataStandard

Inheritance Hierarchy

SystemObject
  DbContext
    SOWIDataDataStandard
      More...

Namespace: SOWIData
Assembly: SOWIData (in SOWIData.dll) Version: 19.1.23.1 (19.1.23.622)

Syntax

Copy

public abstract class DataStandard : DbContext, 
	IDataStandard

Public MustInherit Class DataStandard
	Inherits DbContext
	Implements IDataStandard

The DataStandard type exposes the following members.

Constructors

	Name	Description
	DataStandard	Standard fields

Top

Properties

	Name	Description
	ActionDB	Value of Actions enumeration (value without database saved is saved in ActionText)
	ActionText	Action text of Actions enumeration (value database saved)
	Archive	Is value false then active record Is value true then archived record
	ChangeTracker	Provides access to features of the context that deal with change tracking of entities. (Inherited from DbContext.)
	Checked	Use for user interface handling by checkbox (true or false)
	ClientID	Record on this client
	ColorUI	Color handling for user interface e. g. row table
	Configuration	Provides access to configuration options for the context. (Inherited from DbContext.)
	CreateDate	Date created data record is set by method Insert
	CreateUser	User who created data record is set by method Insert
	Database	Creates a Database instance for this context that allows for creation/deletion/existence checks for the underlying database. (Inherited from DbContext.)
	DateTimeValue	Use for application
	DeleteDate	Date as deleted data record is set by method Delete
	DeleteUser	User who deleted data record is set by method Delete
	Description	Use for application
	Flag	Use for application
	GUID	GUID for export import
	Help	no function
	ID	Unique identifier of record
	Item	Index handling example this[FieldName]
	Label	Use for application
	LastEditDate	Date last change is set by method Update
	LastEditUser	User who made last change on data record is set by method Update.
	LastUser	Gives user name who last work with this data item (create or edit)
	Name	Optional whether required. Setting at class constructor SOWIData.Database.Connector
	NameOriginalValue	Orginal value of field Name
	Selection	Use for user interface handling selection (options) Integer value example selection by ID
	Status	Value of Statuses enumeration (without database saved is saved in StatusText)
	StatusText	Status text of Statuses enumeration (database saved)
	Task	Value of Tasks enumeration (without database saved is saved in TaskText)
	TaskText	Task text of Tasks enumeration (database saved)
	Text	Use for application
	Value	Use for application

Top

Methods

	Name	Description
	Dispose	Calls the protected Dispose method. (Inherited from DbContext.)
	Dispose(Boolean)	Disposes the context. The underlying ObjectContext is also disposed if it was created is by this context or ownership was passed to this context when this context was created. The connection to the database (DbConnection object) is also disposed if it was created is by this context or ownership was passed to this context when this context was created. (Inherited from DbContext.)
	Entry(Object)	Gets a DbEntityEntry object for the given entity providing access to information about the entity and the ability to perform actions on the entity. (Inherited from DbContext.)
	Entry``1(UMP)	Gets a DbEntityEntry object for the given entity providing access to information about the entity and the ability to perform actions on the entity. (Inherited from DbContext.)
	Equals	(Inherited from DbContext.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	(Inherited from DbContext.)
	GetType	(Inherited from DbContext.)
	GetValidationErrors	Validates tracked entities and returns a Collection of DbEntityValidationResult containing validation results. (Inherited from DbContext.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnModelCreating	This method is called when the model for a derived context has been initialized, but before the model has been locked down and used to initialize the context. The default implementation of this method does nothing, but it can be overridden in a derived class such that the model can be further configured before it is locked down. (Inherited from DbContext.)
	SaveChanges	Saves all changes made in this context to the underlying database. (Inherited from DbContext.)
	Set(Type)	Returns a non-generic DbSet instance for access to entities of the given type in the context, the ObjectStateManager, and the underlying store. (Inherited from DbContext.)
	Set``1	Returns a DbSet instance for access to entities of the given type in the context, the ObjectStateManager, and the underlying store. (Inherited from DbContext.)
	ShouldValidateEntity	Extension point allowing the user to override the default behavior of validating only added and modified entities. (Inherited from DbContext.)
	ToString	(Inherited from DbContext.)
	ValidateEntity	Extension point allowing the user to customize validation of an entity or filter out validation results. Called by GetValidationErrors. (Inherited from DbContext.)

Top

Extension Methods

	Name	Description
	GetObjectToBytes	Convert an object to byte array (Defined by Extensions.)
	IsNumber	Check is value a number (Defined by Convert.)
	ToHTMLDisplay(DataGrid, TempDataDictionary)	Overloaded. Gives HTML code for display. Details see ToHTMLDisplay(Object, String, DataGridDataTypes, String, String, String, String, TempDataDictionary). (Defined by Extensions.)
	ToHTMLDisplay(String, DataGridDataTypes, String, String, String, String, TempDataDictionary)	Overloaded. Gives HTML code for display. (Defined by Extensions.)
	ToHTMLEditor(DataGrid, TempDataDictionary, String)	Overloaded. Gives HTML code for Input field. Call method ToHTMLEditor(Object, String, DataGridDataTypes, String, String, String, TempDataDictionary, Boolean, String, DataPlacements, String, String) (Defined by Extensions.)
	ToHTMLEditor(String, DataGridDataTypes, String, String, String, TempDataDictionary, Boolean, String, DataPlacements, String, String)	Overloaded. Gives HTML code for Input field (Defined by Extensions.)
	ToHTMLHidden(String)	Overloaded. Gives HTML code for hidden data (Defined by Extensions.)
	ToHTMLHidden(DataGrid)	Overloaded. Gives HTML code for hidden data (Defined by Extensions.)
	XMLWrite	Gives XML string from data item (Defined by Helper.)

Top

Explicit Interface Implementations

	Name	Description
	System#Data#Entity#Infrastructure#IObjectContextAdapter#ObjectContext	Returns the Entity Framework ObjectContext that is underlying this context. (Inherited from DbContext.)

Top

Examples

Simple implementation

Copy

using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace SOWIData.App
{
    [Table("Activity")]
    public class Activity : SOWIData.DataStandard
    {
        #region --- Constructor ---
        public Activity() : base() { }
        #endregion

        #region --- Relations ---
        //public virtual ICollection<SOWIData.App.Report> Report { get; set; }
        #endregion

        #region --- Fields ---
        //* Standard fields see SOWIData.DataStandard *

        #endregion

    }
}

This template comment documentation the standard fields used to in a table. Placed in comment section Remarks.

Copy

<h3>Table fields</h3>
Note: include declaring standard fields
<list type="table">
<listheader><term>Field</term><description>Description</description></listheader>
<item><term>ClientID</term><description>Foreign key</description></item>
<item><term>Name</term><description>-</description></item>
<item><term>Label</term><description>-</description></item>
<item><term>Description</term><description>-</description></item>
<item><term>DateTimeValue</term><description>-</description></item>
<item><term>Value</term><description>-</description></item>
<item><term>Text</term><description>-</description></item>
<item><term>Flag</term><description>-</description></item>
</list>

This example implementation a enumeration field

Copy

#region --- Task ---

/// <summary>
/// Task text of Tasks enumeration (database saved)
/// </summary>
[DefaultValue("None")]
[Column("TaskText")]
public String TaskText
{
    get { return Task.ToString(); }
    set
    {
        if (value == "")
        {
            Task = Tasks.None;
        }
        else
        {
            Task = SOWIData.Helper.Enumeration.Parse<Tasks>(value);
        }
    }
}

/// <summary>
/// Value of Tasks enumeration (without database saved is saved in TaskText)
/// </summary>
[DefaultValue(Tasks.None)]
[NotMapped]
public SOWIData.Tasks Task { get; set; }

#endregion

Reference

SOWIData Namespace

SOWIDataIDataStandard

Inheritance Hierarchy