[DataContract]
public class CustomViewControl : BaseEntity, ICustomViewControl, IShareAcrossAccounts, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<ICustomViewControl>

Constructors

CustomViewControl()

Declaration

public CustomViewControl()

Properties

CustomLookupQueryFilterID

[Key] Links to ICustomLookupQuery. The custom lookup query to use for selecting this value

Declaration

public Guid? CustomLookupQueryFilterID { get; set; }

Property Value

Type	Description
Guid?

CustomLookupQueryFilterID_Label

Declaration

public string CustomLookupQueryFilterID_Label { get; set; }

Property Value

Type	Description
string

CustomLookupQueryFilterID_Label_Silent

Declaration

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

Property Value

Type	Description
string

CustomViewID

[Key] Links to ICustomView. The parent view this entity belongs to

Declaration

public Guid? CustomViewID { get; set; }

Property Value

Type	Description
Guid?

CustomViewID_Label

Declaration

public string CustomViewID_Label { get; set; }

Property Value

Type	Description
string

CustomViewID_Label_Silent

Declaration

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

Property Value

Type	Description
string

Format

Any custom formatting to apply to the display for this control.

Declaration

[StringLength(50)]
public string Format { get; set; }

Property Value

Type	Description
string

FormulaValue

The formula to use to evaluate the value that should be displayed against this control

Declaration

[PropertyValidation("!string.IsNullOrEmpty(MyItem.PropertyType)", "!string.IsNullOrEmpty(MyItem.FormulaValue)", "You must enter a FormulaValue for use with a PropertyType.")]
public string FormulaValue { get; set; }

Property Value

Type	Description
string

Height

Optional. Specifies the height to use for this control.If 0 the default control height is used to ensure all controls are inline.

Declaration

public int Height { get; set; }

Property Value

Type	Description
int

IsEditable

Indicates if the user has permission that they can edit the data in this control. If they do not have permissions they will be unable to edit this field regardless if it is true or not.

Declaration

public bool IsEditable { get; set; }

Property Value

Type	Description
bool

IsEditableFormula

A formula, that evaluates to true or false, to use to indicate if this control should be editable or not

Declaration

public string IsEditableFormula { get; set; }

Property Value

Type	Description
string

IsHtmlContent

Indicates that the control should be rendered as a HTML page. Will resize the control to take up all available space within the view.

Declaration

public bool IsHtmlContent { get; set; }

Property Value

Type	Description
bool

IsMultiline

Indicates that the text control should allow multi-line input. Will resize the control to take up all available space within the view.

Declaration

public bool IsMultiline { get; set; }

Property Value

Type	Description
bool

IsRichText

Indicates that the text control should allow rich text.

Declaration

public bool IsRichText { get; set; }

Property Value

Type	Description
bool

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

IsUri

Indicates that the control should be rendered as a HTML page. Will resize the control to take up all available space within the view.

Declaration

public bool IsUri { get; set; }

Property Value

Type	Description
bool

IsVisible

Indicates if this control should initially be visible to the user.

The control can also have a formula against it for conditional visibility should you require it.

Declaration

public bool IsVisible { get; set; }

Property Value

Type	Description
bool

IsVisibleFormula

A formula, that evaluates to true or false, to use to indicate if this control should be visible or not

Declaration

public string IsVisibleFormula { get; set; }

Property Value

Type	Description
string

PropName

The name of the property you want to appear as a control in the view. Can be blank if using a PropertyType and Formula value instead.

Declaration

[PropertyValidation("string.IsNullOrEmpty(MyItem.PropName)", "!string.IsNullOrEmpty(MyItem.PropertyType)", "You must select PropertyName or a PropertyType with a FormulaValue.")]
[StringLength(500)]
public string PropName { get; set; }

Property Value

Type	Description
string

PropertyEntityType

The type of entity if this control is using a formula that returns an id to a unique entity in the system

Declaration

public Guid? PropertyEntityType { get; set; }

Property Value

Type	Description
Guid?

PropertyType

The type of property for this control if using a formula. Can be blank if using a direct Property instead

Declaration

[PropertyValidation("string.IsNullOrEmpty(MyItem.PropertyType)", "!string.IsNullOrEmpty(MyItem.PropName)", "You must select PropertyName or a PropertyType with a FormulaValue.")]
[StringLength(500)]
public string PropertyType { get; set; }

Property Value

Type	Description
string

Sequence

[Key] The sequence specifies which order this control should appear in the grid.

Declaration

public short Sequence { get; set; }

Property Value

Type	Description
short

By default the tooltip will be the description (if any) of this property against the entity in the design. You can override that by putting a custom tooltip here.

Declaration

[StringLength(500)]
public string Tooltip { get; set; }

Property Value

Type	Description
string

TransactionCodeID

Declaration

public Guid? TransactionCodeID { get; set; }

Property Value

Type	Description
Guid?

TransactionCodeID_Label

Declaration

public string TransactionCodeID_Label { get; set; }

Property Value

Type	Description
string

TransactionCodeID_Label_Silent

Declaration

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

Property Value

Type	Description
string

UserFriendlyLabel

The control label will by default be the property name or the user friendly version of it. You can override that by putting a custom control header name here.

Declaration

[StringLength(500)]
public string UserFriendlyLabel { get; set; }

Property Value

Type	Description
string

Width

Optional - Specifies the width to use for this control.If 0 the default control width for this type of control is used.The defaults used in the system are as follows:

Small: 100
Normal: 175
Large: 400

Declaration

public int Width { get; set; }

Property Value

Type	Description
int

Methods

CopyFromEntity(IBaseEntity)

Declaration

protected override void CopyFromEntity(IBaseEntity src)

Parameters

Type	Name	Description
IBaseEntity	src

Overrides

BaseEntity.CopyFromEntity(IBaseEntity)

CopyFromSource(ICustomViewControl)

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

Declaration

public void CopyFromSource(ICustomViewControl source)

Parameters

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

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string