Class List

Represents the definition of a list.

Inheritance
System.Object
View
List
Implements
System.ComponentModel.INotifyPropertyChanged
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: TimeCockpit.Data.DataModel.View
Assembly: TimeCockpit.Data.dll
Syntax
public class List : View, INotifyPropertyChanged
Remarks

The user interface layer interprets the definitions in this class and displays a list of EntityObject objects accordingly.

Constructors

List()

Initializes a new instance of the List class.

Declaration
public List()

Properties

Actions

Gets a list of actions that are directly offered for execution.

Declaration
public ObservableCollection<ListAction> Actions { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<ListAction>

AllowAdd

Gets or sets a value indicating whether the user can add records to the list.

Declaration
public bool? AllowAdd { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
Remarks

The default value for this property is false.

AllowCopy

Gets or sets a value indicating whether the user can copy records in the list.

Declaration
public bool? AllowCopy { get; set; }
Property Value
Type Description
System.Nullable<System.Boolean>
Remarks

The default value for this property is false.

AllowDelete

Gets or sets a value indicating whether the user can delete records in the list.

Declaration
public bool AllowDelete { get; set; }
Property Value
Type Description
System.Boolean
Remarks

The default value for this property is false.

AllowEdit

Gets or sets a value indicating whether the user can edit records in the list.

Declaration
public bool AllowEdit { get; set; }
Property Value
Type Description
System.Boolean
Remarks

The default value for this property is false.

AllowSort

Gets or sets a value indicating if sorting is allowed.

Declaration
public string AllowSort { get; set; }
Property Value
Type Description
System.String

AutoGenerateColumns

Gets or sets a value indicating whether the columns should be generated from the underlying query or model entity.

Declaration
public bool AutoGenerateColumns { get; set; }
Property Value
Type Description
System.Boolean
Remarks

The default value for this property is false.

Columns

Gets a list of columns in the list.

Declaration
public ObservableCollection<Cell> Columns { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<Cell>

EditFormName

Gets or sets the name of the edit form.

Declaration
public string EditFormName { get; set; }
Property Value
Type Description
System.String
Remarks

Whenever the user wants to edit an existing row or add a new row a form has to be opened. You can specify the name of the form that should be opened in this property. If this property is not specified a default form is generated based on the underlying model.

See Also

EditMode

Gets or sets the edit mode for the list.

Declaration
public EditMode EditMode { get; set; }
Property Value
Type Description
EditMode

EditModelEntityName

Gets or sets the name of the ModelEntityBase that is used to edit.

Declaration
public string EditModelEntityName { get; set; }
Property Value
Type Description
System.String

EditProperty

Gets or sets the name of the ModelProperty. TODO: find a better name for EditProperty.

Declaration
public string EditProperty { get; set; }
Property Value
Type Description
System.String

EncodedSignature

Gets or sets the encoded signature.

Declaration
[Obsolete("Use embedded python signatures instead")]
public string EncodedSignature { get; set; }
Property Value
Type Description
System.String

The encoded signature.

ExecuteOnOpen

Gets or sets a value indicating whether the list should be executed immediately when opened.

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

Filter

Gets or sets the filter form for the List.

Declaration
public Form Filter { get; set; }
Property Value
Type Description
Form

Groups

Gets a list of groups that are applied when opening a list.

Declaration
public ObservableCollection<Group> Groups { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<Group>

Query

Gets or sets the underlying query.

Declaration
public string Query { get; set; }
Property Value
Type Description
System.String
Remarks

Only one of the properties ScriptSource, Query and ModelEntityName must be set.

RowBackground

Gets or sets the background color for rows.

Declaration
public string RowBackground { get; set; }
Property Value
Type Description
System.String

ScriptSource

Gets or sets the underlying script source.

Declaration
public string ScriptSource { get; set; }
Property Value
Type Description
System.String
Remarks

Only one of the properties ScriptSource, Query and ModelEntityName must be set.

Signature

Gets or sets the signature.

Declaration
[Obsolete("Use embedded signatures instead.")]
public byte[] Signature { get; set; }
Property Value
Type Description
System.Byte[]

The signature.

SortDirection

Gets or sets the default sort direction for the list.

Declaration
public SortDirection? SortDirection { get; set; }
Property Value
Type Description
System.Nullable<SortDirection>

SortExpression

Gets or sets the default sort order for the list.

Declaration
public string SortExpression { get; set; }
Property Value
Type Description
System.String

Thumbprint

Gets or sets the thumbprint.

Declaration
[Obsolete("Use embedded python signatures instead")]
public string Thumbprint { get; set; }
Property Value
Type Description
System.String

The thumbprint.

ViewActions

Gets a list of actions that are directly offered for execution.

Declaration
public ObservableCollection<ViewAction> ViewActions { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<ViewAction>