Interface IViewModelProperty
- Namespace
- GroupeIsa.Neos.Designer.UIAbstractions
- Assembly
- GroupeIsa.Neos.Designer.UIAbstractions.dll
Represents the MVVM ViewModel of an UIView Property.
public interface IViewModelProperty
Properties
Caption
Gets or sets the caption of the property.
string Caption { get; set; }
Property Value
DataType
Gets the data type of the property. null
for embedded references.
DataType? DataType { get; }
Property Value
DatagridCaption
Gets or sets the caption of the property in a datagrid.
string DatagridCaption { get; set; }
Property Value
DatagridFrozen
Gets or sets a value indicating whether the property column in a datagrid is frozen.
bool DatagridFrozen { get; set; }
Property Value
DatagridMaxWidth
Gets or sets the datagrid max width.
int? DatagridMaxWidth { get; set; }
Property Value
- int?
DatagridMinWidth
Gets or sets the datagrid min width.
int? DatagridMinWidth { get; set; }
Property Value
- int?
DatagridPosition
Gets or sets the position of the property column in a datagrid.
int DatagridPosition { get; set; }
Property Value
DatagridVisible
Gets or sets a value indicating whether the property column is visible in a datagrid.
bool DatagridVisible { get; set; }
Property Value
DatagridWidth
Gets or sets the width of the property column in a datagrid. Set null for auto sizing.
string? DatagridWidth { get; set; }
Property Value
Displayable
Gets or sets a value indicating whether the property is displayable.
bool Displayable { get; set; }
Property Value
Documentation
Gets or sets the documentation of the property.
string? Documentation { get; set; }
Property Value
EnumTypeName
Gets the enumeration type of the property if its datatype is Enum
; otherwise null
.
string? EnumTypeName { get; }
Property Value
FilterDefaultOperator
Gets or sets the default filter operator for the property.
FilterOperator FilterDefaultOperator { get; set; }
Property Value
FilterPosition
Gets or sets the position of the property in the filter.
int FilterPosition { get; set; }
Property Value
FilterVisible
Gets or sets a value indicating whether the property is visible in the filter bar.
bool FilterVisible { get; set; }
Property Value
FilterVisibleInPanel
Gets or sets a value indicating whether the property is visible in the filter panel.
bool FilterVisibleInPanel { get; set; }
Property Value
Filterable
Gets or sets a value indicating whether the property is filterable.
bool Filterable { get; set; }
Property Value
Format
Gets or sets the format used to display the number or date and time being edited.
string? Format { get; set; }
Property Value
GroupSummaryType
Gets or sets the group summary type.
SummaryType? GroupSummaryType { get; set; }
Property Value
MaxLength
Gets or sets maximum text value length the property accepts.
int? MaxLength { get; set; }
Property Value
- int?
Multiline
Gets or sets a value indicating whether the property accepts multiline text.
bool Multiline { get; set; }
Property Value
Name
Gets the name of the property.
string Name { get; }
Property Value
Scale
Gets or sets the scale for a property with a Decimal
data type.
int? Scale { get; set; }
Property Value
- int?
Sortable
Gets or sets a value indicating whether the property is sortable.
bool Sortable { get; set; }
Property Value
TotalSummaryType
Gets or sets the total summary type.
SummaryType? TotalSummaryType { get; set; }
Property Value
Methods
EnableWatcher(bool)
Enables a watcher on the property of each element in the data source. This method is only necessary in specific cases, such as when a property with a complex getter is not reactive in the datagrid.
void EnableWatcher(bool deep = false)
Parameters
deep
boolValue indicating whether the watcher must observe changes of all nested properties. Deep watch can be expensive when used on large data structures.
GetEnumMember(string)
Gets the enum member.
IEnumMember GetEnumMember(string name)
Parameters
name
stringThe enum member name.
Returns
- IEnumMember
The enum member.
Exceptions
- Exception
The enum member does not exist.
GetEnumMembers()
Gets the enum members.
IEnumMember[] GetEnumMembers()
Returns
- IEnumMember[]
The enum members.
GetFormVisible(object)
Gets a value indicating whether the input for the property is visible in a form.
bool GetFormVisible(object item)
Parameters
item
objectItem for which the value is obtained.
Returns
- bool
Value.
GetMaxValue(object)
Gets the maximum numeric value the property accepts.
object? GetMaxValue(object item)
Parameters
item
objectItem for which the value is obtained.
Returns
- object
Value.
GetMinValue(object)
Gets the minimum numeric value the property accepts.
object? GetMinValue(object item)
Parameters
item
objectItem for which the value is obtained.
Returns
- object
Value.
GetReadOnly(object)
Gets a value indicating whether the input for the property can only be readen.
bool GetReadOnly(object item)
Parameters
item
objectItem for which the value is obtained.
Returns
- bool
Value.
GetRequired(object)
Gets a value indicating whether the property requires a value.
bool GetRequired(object item)
Parameters
item
objectItem for which the value is obtained.
Returns
- bool
Value.
GetTabStop(object)
Gets a value indicating whether the input for the property can be focused using the Tab key.
bool GetTabStop(object item)
Parameters
item
objectItem for which the value is obtained.
Returns
- bool
Value.
GetValue(object)
Gets the value of the property of an item.
object? GetValue(object item)
Parameters
item
objectItem for which the value is obtained.
Returns
- object
Value.
IsFormVisibleExpression()
Checks if the form visible property is an expression.
bool IsFormVisibleExpression()
Returns
- bool
True
if the form visible is an expression;False
otherwise.
IsReadOnlyExpression()
Checks if the readonly property is an expression.
bool IsReadOnlyExpression()
Returns
- bool
True
if the readonly is an expression;False
otherwise.
IsRequiredExpression()
Checks if the required property is an expression.
bool IsRequiredExpression()
Returns
- bool
True
if the required is an expression;False
otherwise.
IsTabStopExpression()
Checks if the tab stop property is an expression.
bool IsTabStopExpression()
Returns
- bool
True
if the tab stop is an expression;False
otherwise.
ResetValue(object)
Sets the value of the property of an item to the default value.
void ResetValue(object item)
Parameters
item
objectItem for which the value is reset.
SetFormVisible(bool)
Sets a value indicating whether the input for the property is visible in a form.
void SetFormVisible(bool value)
Parameters
value
boolValue to set.
SetMaxValue(object?)
Sets the maximum numeric value the property accepts.
void SetMaxValue(object? value)
Parameters
value
objectValue to set.
SetMinValue(object?)
Sets the minimum numeric value the property accepts.
void SetMinValue(object? value)
Parameters
value
objectValue to set.
SetReadOnly(bool)
Sets a value indicating whether the input for this property can only be readen.
void SetReadOnly(bool value)
Parameters
value
boolValue to set.
SetRequired(bool)
Sets a value indicating whether the property requires a value.
void SetRequired(bool value)
Parameters
value
boolValue to set.
SetTabStop(bool)
Sets a value whether the input for the property can be focused using the Tab key.
void SetTabStop(bool value)
Parameters
value
boolValue to set.
SetValue(object, object?)
Sets the value of the property of an item.
void SetValue(object item, object? value)