[DataContract]
public class CustomGrid : BaseEntityWithPermissions, ICustomGrid, IBaseEntityWithPermissions, ISetCopier, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<ICustomGrid>

Constructors

CustomGrid()

Declaration

public CustomGrid()

Properties

AllowAutoCreateLookupEntity

Indicates user should be allowed to create a new row linked to the lookup column, or provided an option to create a new instance of the lookup item and link to the new instance.

Declaration

public bool AllowAutoCreateLookupEntity { get; set; }

Property Value

Type	Description
bool

AutoOpenNewItems

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

Declaration

public bool AutoOpenNewItems { get; set; }

Property Value

Type	Description
bool

CodeSnippetID

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

Declaration

public Guid? CodeSnippetID { get; set; }

Property Value

Type	Description
Guid?

CodeSnippetID_Label

Declaration

public string CodeSnippetID_Label { get; set; }

Property Value

Type	Description
string

CodeSnippetID_Label_Silent

Declaration

[NotMapped]
public string CodeSnippetID_Label_Silent { get; set; }

Property Value

Type	Description
string

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

Declaration

[NotMapped]
public string DefaultSortDirection_Tooltip { get; set; }

Property Value

Type	Description
string

Description

A user friendly description of this grid

Declaration

[StringLength(2000)]
public string Description { get; set; }

Property Value

Type	Description
string

EnableCreateNewItem

This indicates if create new item option is enabled or not in the grid

Declaration

public bool EnableCreateNewItem { get; set; }

Property Value

Type	Description
bool

EnableDeleteItem

This indicates if delete item option is enabled or not in the grid

Declaration

public bool EnableDeleteItem { get; set; }

Property Value

Type	Description
bool

EntityTypeID

Indicates which entity you want to design a grid 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 grid

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 Grid into UI client applications immediately.

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

Declaration

[Unique]
[Required]
[StringLength(500)]
public string Name { get; set; }

Property Value

Type	Description
string

PopulateNewFromLookupColumnName

Indicates a popup should auto display allow selection of the item for any new item.

Declaration

[StringLength(500)]
public string PopulateNewFromLookupColumnName { 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 grid are related to.

Declaration

public Guid? RelatedParentEntityTypeID { get; set; }

Property Value

Type	Description
Guid?

RelatedParentEntityTypeIDProperty

Indicates the property on these grid 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

ReplaceCoreView

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

Declaration

[StringLength(250)]
public string ReplaceCoreView { get; set; }

Property Value

Type	Description
string

Methods

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(ICustomGrid)

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

Declaration

public void CopyFromSource(ICustomGrid source)

Parameters

Type	Name	Description
ICustomGrid	source	The source object to copy all values from.

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

Declaration

public void SetTypePropertyComboItems(Func<CustomGrid, KeyValuePair<string, string>[]> comboItems)

Parameters

Type	Name	Description
Func<CustomGrid, KeyValuePair<string, string>[]>	comboItems

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string