Interface ICustomView

The system entity for a Custom View, which holds the design for a view in the UI

See https://help.lemonedge.com/help/api/auto-code-designers/custom-views/intro.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.CustomView, "dbo.LT_CustomViews", "CustomView", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "help/api/auto-code-designers/custom-views/intro.html")]
[DefaultEntityIcon(ImageType.CustomView)]
public interface ICustomView : IBaseEntityWithPermissions, ISetCopier, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties

Properties

CodeSnippetID

[Key] Links to ICodeSnippet. An optional code snippet for processing custom process in this custom view

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true)]
[EntityRelationship(EntityID.CodeSnippet, "ID", SingleJoinType.ZeroToOne, "Code Snippet", "Custom Views", DeleteWithRelationship = false, PartOfParentSet = false, InheritPermissions = false, LinkToItemInSet = true)]
Guid? CodeSnippetID { get; set; }
Property Value
Type Description
Guid?

Description

A user friendly description of this view

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

EntityTypeID

Indicates which entity you want to design a view for

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false, IsEntityTypeLink = true)]
[RequiredNoDefaultIDValidation]
[EntityDescription("Holds the entity type this view ccan 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 id of a system or ImageID

Declaration
[EntityProperty(SQLType.UniqueIdentifier, false)]
[EntityDescription("The icon for this view.")]
Guid IconID { get; set; }
Property Value
Type Description
Guid

LoadDynamically

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

The alternative is the designer can provide you the actual code for this view.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 view 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

MaxHeight

Optional. Provides a maximum height the controls will take up.Even if the view itself is bigger than this height the controls will not be and will wrap, stack or otherwise conform to this max height. Mostly used when the panel type for the view is a Grid.

Declaration
[EntityProperty(SQLType.Int, true)]
[EntityDescription("Maximum width this view should take up..")]
int? MaxHeight { get; set; }
Property Value
Type Description
int?

MaxWidth

Optional. Provides a maximum width the controls will take up.Even if the view itself is bigger than this width the controls will not be and will wrap, stack or otherwise conform to this max width. Mostly used when the panel type for the view is a Grid.

Declaration
[EntityProperty(SQLType.Int, true)]
[EntityDescription("Maximum width this view should take up..")]
int? MaxWidth { get; set; }
Property Value
Type Description
int?

Name

[Key] A friendly uniquely identifying name for this view

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

RelatedParentEntityTypeID

Indicates the parent entity this enitiy in the view is related to.

Declaration
[EntityProperty(SQLType.UniqueIdentifier, true, IsEntityTypeLink = true)]
[EntityDescription("Indicates the parent entity this enitiy in the view is related to..")]
Guid? RelatedParentEntityTypeID { get; set; }
Property Value
Type Description
Guid?

RelatedParentEntityTypeIDProperty

Indicates the property on this eniy that relates them to the RelatedParentEntityTypeID.

Declaration
[EntityProperty(SQLType.NVarChar, 500, true)]
[EntityDescription("Indicates the property on this eniy 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

ReplaceCoreView

Provides a list of other views in the system for this Entity Type. You can override any of those views with this Custom View. Whenever the system would load that view, if you've overridden it, then it will load this one instead.

Declaration
[EntityProperty(SQLType.NVarChar, 250, true, FriendlyLabel = "Replace System View")]
[EntityDescription("Indicates this view should replace the specified system view, whenever it is referenced in a layout, this view will be used instead.")]
string ReplaceCoreView { get; set; }
Property Value
Type Description
string

ViewDisplayType

The type of layout used for displaying the controls in this view

Declaration
[EntityProperty(SQLType.SmallInt, false, "0")]
[EntityDescription("The type of layout used for displaying the controls in this view.")]
CustomViewDisplayType ViewDisplayType { get; set; }
Property Value
Type Description
CustomViewDisplayType

Extension Methods

See Also