Class CustomTree

Inheritance
object
BaseEntity
BaseEntityWithPermissions
CustomTree
Implements
Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class CustomTree : BaseEntityWithPermissions, ICustomTree, IBaseEntityWithPermissions, ISetCopier, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<ICustomTree>

Constructors

CustomTree()

Declaration
public CustomTree()

Properties

AutoOpenNewItems

This indicates when a new item is created in the tree if it should open in its own tab too

Declaration
public bool AutoOpenNewItems { get; set; }
Property Value
Type Description
bool

DefaultColumnToSortBy

Name of column to sort by

Declaration
[StringLength(500)]
public string DefaultColumnToSortBy { get; set; }
Property Value
Type Description
string

DefaultSortDirection

The default order to sort the default column by.

Declaration
[EnumDataType(typeof(Order))]
public Order DefaultSortDirection { get; set; }
Property Value
Type Description
Order

DefaultSortDirection_Tooltip

Declaration
[NotMapped]
public string DefaultSortDirection_Tooltip { get; set; }
Property Value
Type Description
string

Description

A user friendly description of this tree

Declaration
[StringLength(2000)]
public string Description { get; set; }
Property Value
Type Description
string

EntityTypeID

Indicates which entity you want to design a tree for.

Declaration
[RequiredNoDefaultIDValidation]
public Guid EntityTypeID { get; set; }
Property Value
Type Description
Guid

HelpURL

A custom url for help on this view

Declaration
[StringLength(500)]
public string HelpURL { get; set; }
Property Value
Type Description
string

IconID

The icon for this tree

Declaration
public Guid IconID { get; set; }
Property Value
Type Description
Guid

IsShared

Indicates this record is a shared record. Only the root account can edit items that are shared records

Declaration
public bool IsShared { get; set; }
Property Value
Type Description
bool

LoadDynamically

This indicates the system will dynamically load your tree into UI client applications immediately.

The alternative is the designer can provide you the actual code for this tree. You can incorporate that code in your own DLL and add that as an Add-In to the platform itself using our Add-In Modules.

Declaration
public bool LoadDynamically { get; set; }
Property Value
Type Description
bool

Name

[Key] A friendly uniquely identifying name for this tree

Declaration
[Unique]
[Required]
[StringLength(500)]
public string Name { get; set; }
Property Value
Type Description
string

RelatedEntityTypePropertyComboItems

Declaration
[NotMapped]
public KeyValuePair<string, string>[] RelatedEntityTypePropertyComboItems { get; set; }
Property Value
Type Description
KeyValuePair<string, string>[]

RelatedParentEntityTypeID

Indicates the parent entity these entites in the tree are related to.

Declaration
public Guid? RelatedParentEntityTypeID { get; set; }
Property Value
Type Description
Guid?

RelatedParentEntityTypeIDProperty

Indicates the property on these tree entites that relates them to the RelatedParentEntityTypeID.

Declaration
[PropertyValidation("MyItem.RelatedParentEntityTypeID.HasValue", "!string.IsNullOrEmpty(MyItem.RelatedParentEntityTypeIDProperty)", "The related parent entity property must have a relationship value selected from the EntityType to the RelatedParentEntityType.")]
[StringLength(500)]
public string RelatedParentEntityTypeIDProperty { get; set; }
Property Value
Type Description
string

TreeLabelProperty

The property to use as the label of each tree node

Declaration
[Required]
[StringLength(500)]
public string TreeLabelProperty { get; set; }
Property Value
Type Description
string

TreeParentNodeProperty

The property to use as holding the id of the parent tree node

Declaration
[Required]
[StringLength(500)]
public string TreeParentNodeProperty { get; set; }
Property Value
Type Description
string

Methods

CopyFromEntity(IBaseEntity)

Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Type Name Description
IBaseEntity src
Overrides

CopyFromSource(ICustomTree)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(ICustomTree source)
Parameters
Type Name Description
ICustomTree source

The source object to copy all values from.

SetTypePropertyComboItems(Func<CustomTree, KeyValuePair<string, string>[]>)

Declaration
public void SetTypePropertyComboItems(Func<CustomTree, KeyValuePair<string, string>[]> comboItems)
Parameters
Type Name Description
Func<CustomTree, KeyValuePair<string, string>[]> comboItems

ToString()

Declaration
public override string ToString()
Returns
Type Description
string
Overrides

Implements

Extension Methods