Interface ILayout

The system entity for a custom layout, which holds custom layouts for displaying views against entities in the ui

See https://help.lemonedge.com/help/api/ui/layouts/intro.html for more information

Inherited Members
Namespace: LemonEdge.API.Entities.Design
Assembly: LemonEdge.API.dll
Syntax
[EntityDefinition(EntityID.Layouts, "dbo.LT_Layouts", "Layout", LabelColumn = "Name", IsStandingDataEntity = true, HelpURL = "help/api/ui/layouts/intro.html")]
[DefaultEntityIcon(ImageType.Layouts)]
public interface ILayout : IBaseEntityWithPermissions, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ISetCopier

Properties

LayoutConfig

This is the layout itself. You can customise this using the Layout Designer Tool Window

Declaration
[EntityProperty(SQLType.VarBinary, false)]
[EntityDescription("The layout for this object.")]
byte[] LayoutConfig { get; set; }
Property Value
Type Description
byte[]

LayoutHelpURL

Layouts can have help specific web pages. This appears in the Help button Context area when a user is looking at an item using your created layout.

Declaration
[EntityProperty(SQLType.NVarChar, 2500, true)]
[EntityDescription("Holds the help url for this layout.")]
string LayoutHelpURL { get; set; }
Property Value
Type Description
string

LayoutParam

Some layouts have parameters that further define which layout to use for this Type. This control lists all available parameters so you can create the correct layout.

Declaration
[EntityProperty(SQLType.NVarChar, 250, true, FriendlyLabel = "Params")]
[EntityDescription("Additional parameters identifying the object this is a layout for.")]
string LayoutParam { get; set; }
Property Value
Type Description
string

Name

[Key] The unique user friendly name for this layout

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

UniqueLayoutName

The type of object this layout will be used to display.

This lists all entities in the system as singular(for displaying an instance of that individual entity) and plural(for display the collection of that entity).

Changing this value results in the system wiping out the Layout property and setting it to contain the current system default layout so you can use that as a base to design from.
Declaration
[EntityProperty(SQLType.NVarChar, 250, false, FriendlyLabel = "Type")]
[EntityDescription("The object this is a layout for.")]
string UniqueLayoutName { get; set; }
Property Value
Type Description
string

Extension Methods