[EntityDefinition(EntityID.CustomTree, "dbo.LT_CustomTrees", "CustomTree", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "")]
[DefaultEntityIcon(ImageType.FolderTree)]
public interface ICustomTree : IBaseEntityWithPermissions, ISetCopier, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

AutoOpenNewItems

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

Declaration

[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("This indicates when a new item is created in the tree if it should open in its own tab too.")]
bool AutoOpenNewItems { get; set; }

Property Value

Type	Description
bool

DefaultColumnToSortBy

Name of column to sort by

Declaration

[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("Name of column to sort by default.")]
string DefaultColumnToSortBy { get; set; }

Property Value

Type	Description
string

DefaultSortDirection

The default order to sort the default column by.

Declaration

[EntityProperty(SQLType.SmallInt, false)]
[EntityDescription("The default order to sort the default column by.")]
Order DefaultSortDirection { get; set; }

Property Value

Type	Description
Order

Description

A user friendly description of this tree

Declaration

[EntityProperty(SQLType.NVarChar, 2000, true)]
[EntityDescription("A user friendly description of this custom tree.")]
string Description { get; set; }

Property Value

Type	Description
string

EntityTypeID

Indicates which entity you want to design a tree for.

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false, IsEntityTypeLink = true)]
[RequiredNoDefaultIDValidation]
[EntityDescription("Holds the entity type this view can display information for.")]
Guid EntityTypeID { get; set; }

Property Value

Type	Description
Guid

HelpURL

A custom url for help on this view

Declaration

[EntityProperty(SQLType.NVarChar, 500, true)]
string HelpURL { get; set; }

Property Value

Type	Description
string

IconID

The icon for this tree

Declaration

[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("The icon for this tree.")]
Guid IconID { get; set; }

Property Value

Type	Description
Guid

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

[EntityProperty(SQLType.Bit, false, "0")]
[EntityDescription("Indicates this custom tree definition is to be dynamically loaded into the system. When set to false, you can export the code and incorporate into your own addin dll.")]
bool LoadDynamically { get; set; }

Property Value

Type	Description
bool

Name

[Key] A friendly uniquely identifying name for this tree

Declaration

[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityKeyProperty]
[EntityDescription("The unique name of this custom tree.")]
[Unique]
[Required]
string Name { get; set; }

Property Value

Type	Description
string

RelatedParentEntityTypeID

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

Declaration

[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("Indicates the parent entity these entites in the tree are related to.")]
Guid? RelatedParentEntityTypeID { get; set; }

Property Value

Type	Description
Guid?

RelatedParentEntityTypeIDProperty

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

Declaration

[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("Indicates the property on these tree entites that relates them to the RelatedParentEntityTypeID.")]
[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.")]
string RelatedParentEntityTypeIDProperty { get; set; }

Property Value

Type	Description
string

TreeLabelProperty

The property to use as the label of each tree node

Declaration

[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityDescription("The property to use as the label of each tree node")]
[Required]
string TreeLabelProperty { get; set; }

Property Value

Type	Description
string

TreeParentNodeProperty

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

Declaration

[EntityProperty(SQLType.NVarChar, 500, false)]
[EntityDescription("The property to use as holding the id of the parent tree node")]
[Required]
string TreeParentNodeProperty { get; set; }

Property Value

Type	Description
string

Extension Methods

LinqExtensions.AsArray<T>(T)

LinqExtensions.ToArrayOfOne<T>(T)

LinqExtensions.ToListOfOne<T>(T)

MiscExtensions.SetIfNotEqual<T, TP>(T, Expression<Func<T, TP>>, TP)

WeakReferenceExtensions.WeakReference(object)

SQLExtensions.ToSQLValue(object, bool)

ReflectionExtensions.ClearEventInvocations(object, string)

StringExtensions.ToCSVFormatString(object, Type)