Table of Contents

Class List

Namespace
TimeCockpit.Data.DataModel.View
Assembly
TimeCockpit.Data.dll

Represents the definition of a list.

public class List : View, INotifyPropertyChanged
Inheritance
Object
List
Implements
INotifyPropertyChanged
Inherited Members
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()

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.

public List()

Properties

Actions

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

public ObservableCollection<ListAction> Actions { get; }

Property Value

ObservableCollection<ListAction>

AllowAdd

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

public bool? AllowAdd { get; set; }

Property Value

Nullable<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.

public bool? AllowCopy { get; set; }

Property Value

Nullable<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.

public bool AllowDelete { get; set; }

Property Value

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.

public bool AllowEdit { get; set; }

Property Value

Boolean

Remarks

The default value for this property is false.

AllowSort

Gets or sets a value indicating if sorting is allowed.

public string AllowSort { get; set; }

Property Value

String

AutoGenerateColumns

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

public bool AutoGenerateColumns { get; set; }

Property Value

Boolean

Remarks

The default value for this property is false.

Columns

Gets a list of columns in the list.

public ObservableCollection<Cell> Columns { get; }

Property Value

ObservableCollection<Cell>

EditFormName

Gets or sets the name of the edit form.

public string EditFormName { get; set; }

Property Value

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.

public EditMode EditMode { get; set; }

Property Value

EditMode

EditModelEntityName

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

public string EditModelEntityName { get; set; }

Property Value

String

EditProperty

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

public string EditProperty { get; set; }

Property Value

String

EncodedSignature

Gets or sets the encoded signature.

[Obsolete("Use embedded python signatures instead")]
public string EncodedSignature { get; set; }

Property Value

String

The encoded signature.

ExecuteOnOpen

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

public bool ExecuteOnOpen { get; set; }

Property Value

Boolean

Filter

Gets or sets the filter form for the List.

public Form Filter { get; set; }

Property Value

Form

Groups

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

public ObservableCollection<Group> Groups { get; }

Property Value

ObservableCollection<Group>

Query

Gets or sets the underlying query.

public string Query { get; set; }

Property Value

String

Remarks

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

RowBackground

Gets or sets the background color for rows.

public string RowBackground { get; set; }

Property Value

String

ScriptSource

Gets or sets the underlying script source.

public string ScriptSource { get; set; }

Property Value

String

Remarks

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

Signature

Gets or sets the signature.

[Obsolete("Use embedded signatures instead.")]
public byte[] Signature { get; set; }

Property Value

Byte[]

The signature.

SortDirection

Gets or sets the default sort direction for the list.

public SortDirection? SortDirection { get; set; }

Property Value

Nullable<SortDirection>

SortExpression

Gets or sets the default sort order for the list.

public string SortExpression { get; set; }

Property Value

String

Thumbprint

Gets or sets the thumbprint.

[Obsolete("Use embedded python signatures instead")]
public string Thumbprint { get; set; }

Property Value

String

The thumbprint.

ViewActions

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

public ObservableCollection<ViewAction> ViewActions { get; }

Property Value

ObservableCollection<ViewAction>