Class Layout

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

Constructors

Layout()

Declaration
public Layout()

Properties

LayoutConfig

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

Declaration
public 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
[StringLength(2500)]
public 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
[StringLength(250)]
public string LayoutParam { get; set; }
Property Value
Type Description
string

LayoutParamComboItems

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

Name

[Key] The unique user friendly name for this layout

Declaration
[Unique]
[Required]
[StringLength(500)]
public 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
[StringLength(250)]
public string UniqueLayoutName { 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(ILayout)

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

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

The source object to copy all values from.

SetLayoutParamComboItems(Func<Layout, KeyValuePair<string, string>[]>)

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

ToString()

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

Implements

Extension Methods