Class SQLTypeWrapper
Inheritance
SQLTypeWrapper
Assembly: LemonEdge.API.Entities.Auto.dll
Syntax
[DataContract]
public class SQLTypeWrapper : BaseEntity, ISQLTypeWrapper, IBaseEntity, IEquatable<IBaseEntity>, INotifyPropertyChanged, INotifyPropertyChanging, ICloneableAsync, ICanTrackProperties, ICloneableAsync<ISQLTypeWrapper>
Constructors
SQLTypeWrapper()
Declaration
Properties
Aggregate
The aggregate function to use against this data, all non-aggregated columns will be grouped by aggregated ones.
Declaration
[EnumDataType(typeof(AggregateFunction))]
public AggregateFunction Aggregate { get; set; }
Property Value
Declaration
[NotMapped]
public string Aggregate_Tooltip { get; set; }
Property Value
AllowMultiSelect
If this parameter is an id of an entity (uniqueidentifier type with an entity type and entity property) then this indicates the user should be able to select
multiple items instead of just one.
Declaration
public bool AllowMultiSelect { get; set; }
Property Value
ApiQueryID
[Key] Links to IAPIQuery. The parent entity this belongs to.
Declaration
public Guid? ApiQueryID { get; set; }
Property Value
ApiQueryID_Label
Declaration
public string ApiQueryID_Label { get; set; }
Property Value
ApiQueryID_Label_Silent
Declaration
[NotMapped]
public string ApiQueryID_Label_Silent { get; set; }
Property Value
CanEditFromIDLink
Declaration
public Guid? CanEditFromIDLink { get; set; }
Property Value
CanEditFromIDLink_Label
Declaration
public string CanEditFromIDLink_Label { get; set; }
Property Value
CanEditFromIDLink_Label_Silent
Declaration
[NotMapped]
public string CanEditFromIDLink_Label_Silent { get; set; }
Property Value
CodeSnippetID
[Key] Links to ICodeSnippet. The parent snippet this belongs to.
Declaration
public Guid? CodeSnippetID { get; set; }
Property Value
CodeSnippetID_Label
Declaration
public string CodeSnippetID_Label { get; set; }
Property Value
CodeSnippetID_Label_Silent
Declaration
[NotMapped]
public string CodeSnippetID_Label_Silent { get; set; }
Property Value
Color
Declaration
[NotMapped]
public Color Color { get; set; }
Property Value
ColumnUserFriendlyLabel
The user friendly heading of this column.
Declaration
public string ColumnUserFriendlyLabel { get; set; }
Property Value
DataSetID
[Key] Links to IDataset. The Data set item this belongs to.
Declaration
public Guid? DataSetID { get; set; }
Property Value
DataSetID_Label
Declaration
public string DataSetID_Label { get; set; }
Property Value
DataSetID_Label_Silent
Declaration
[NotMapped]
public string DataSetID_Label_Silent { get; set; }
Property Value
DataSetQueryableItemID
[Key] Links to IDataSetQueryableItem. The Data set queryable item this belongs to.
Declaration
public Guid? DataSetQueryableItemID { get; set; }
Property Value
DataSetQueryableItemID_Label
Declaration
public string DataSetQueryableItemID_Label { get; set; }
Property Value
DataSetQueryableItemID_Label_Silent
Declaration
[NotMapped]
public string DataSetQueryableItemID_Label_Silent { get; set; }
Property Value
DataSetShortcutID
Declaration
public Guid? DataSetShortcutID { get; set; }
Property Value
DataSetShortcutID_Label
Declaration
public string DataSetShortcutID_Label { get; set; }
Property Value
DataSetShortcutID_Label_Silent
Declaration
[NotMapped]
public string DataSetShortcutID_Label_Silent { get; set; }
Property Value
Description
A user friendly description of this column
Declaration
[StringLength(2000)]
public string Description { get; set; }
Property Value
EntityParamComboItems
Declaration
[NotMapped]
public KeyValuePair<string, string>[] EntityParamComboItems { get; set; }
Property Value
EntityPropertyName
If this type wraps a system property, this indicates the property of the type of entity the type wraps.
Declaration
[StringLength(100)]
public string EntityPropertyName { get; set; }
Property Value
EntityTypeID
If this type wraps a system property, this indicates the type of entity the type wraps.
Declaration
public Guid? EntityTypeID { get; set; }
Property Value
EnumPropertyType
If this property is an enum type this holds the type of enum to be used for displaying in grids.
Declaration
[StringLength(500)]
public string EnumPropertyType { get; set; }
Property Value
ExcludeFromResultSet
Indicates this column should be included in the result set. You can add columns that are only included in
calculations, and not in the actual result set
Declaration
public bool ExcludeFromResultSet { get; set; }
Property Value
Applies any custom formatting you want to the result when displayed in a grid.
Declaration
[StringLength(20)]
public string Format { get; set; }
Property Value
FrameworkType
The .net framework equivelant type of this sql type.
Declaration
[StringLength(500)]
public string FrameworkType { get; set; }
Property Value
GridAggregate
The aggregate function to use when displaying these results in a grid.
Declaration
[EnumDataType(typeof(AggregateFunction))]
public AggregateFunction GridAggregate { get; set; }
Property Value
Declaration
[NotMapped]
public string GridAggregate_Tooltip { get; set; }
Property Value
GridDefaultWidth
The default width for the column when displayed in a grid. Left blank the system default is used, otherwise the specified amount is used.
Declaration
public short? GridDefaultWidth { get; set; }
Property Value
GridFreezeUpTo
Indicates when these results are displayed in a grid the columns should be frozen up to this one.
Declaration
public bool GridFreezeUpTo { get; set; }
Property Value
GridGroupBy
Indicates when these results are displayed in a grid the column should automatically be grouped.
Declaration
public bool GridGroupBy { get; set; }
Property Value
The group header to use when displaying these results in a grid.
Declaration
[StringLength(50)]
public string GridGroupHeader { get; set; }
Property Value
GridIsDefaultSearch
Indicates when these results are displayed in a grid this column is the one that is automatically used when
searching.
Declaration
public bool GridIsDefaultSearch { get; set; }
Property Value
Indicates when these results are displayed in a grid this column forms part of the row header when scrolling
through large sets of results.
Declaration
public bool GridPartOfRowHeader { get; set; }
Property Value
The sub group header to use when displaying these results in a grid.
Declaration
[StringLength(50)]
public string GridSubGroupHeader { get; set; }
Property Value
HasCustomAggregate
Indicates this column has a custom aggregate function using a ISQLFunction
Declaration
public bool HasCustomAggregate { get; set; }
Property Value
Index
The order this column will appear in the result set. This can be moved up and down using the standard grid
commands.
Declaration
public short Index { get; set; }
Property Value
IsNullable
Indicates if this type is nullable.
Declaration
public bool IsNullable { get; set; }
Property Value
IsPostProcess
Declaration
[NotMapped]
public bool IsPostProcess { get; set; }
Property Value
MaxLength
The max length to use if this column is a text type such as nvarchar. If blank it is the equivalent to
nvarchar(max).
Declaration
public short? MaxLength { get; set; }
Property Value
Name
[Key] The name of this column. This is the name used as column headers in csv exports.
Declaration
[Required]
[StringLength(500)]
public string Name { get; set; }
Property Value
ParamCustomLookupQueryID
[Key] Links to ICustomLookupQuery. The custom lookup query to use for selecting this parameter
Declaration
public Guid? ParamCustomLookupQueryID { get; set; }
Property Value
ParamCustomLookupQueryID_Label
Declaration
public string ParamCustomLookupQueryID_Label { get; set; }
Property Value
ParamCustomLookupQueryID_Label_Silent
Declaration
[NotMapped]
public string ParamCustomLookupQueryID_Label_Silent { get; set; }
Property Value
ParameterDefaultValue
If this type is a parameter, this indicates a constant default value to provide as the value.
Declaration
[StringLength(500)]
public string ParameterDefaultValue { get; set; }
Property Value
If this type is a parameter, this indicates a formula to evaluate and use as the default value.
Declaration
public string ParameterFormulaValue { get; set; }
Property Value
ParameterName
If this type is a parameter, this holds the name of the variable, must include @.
Declaration
[FileSafeNameValidation(AllowParamAtSign = true, AllowNulls = true)]
[StringLength(500)]
public string ParameterName { get; set; }
Property Value
ParameterRequired
If this type is a parameter, this indicates if the parameter must have a value.
Declaration
public bool ParameterRequired { get; set; }
Property Value
ParentIndex
The parent index is used for columns that display labels for unique identifiers. If you have a column that holds a
unique identifier key, you can set the label of that column to have a parent index of the uniqueidentifier column.
The system will then know how to display the label in the grid for the user rather than a list of
uniqueidentifiers the user won't be able to recognize.
Declaration
public short? ParentIndex { get; set; }
Property Value
PostProcessCalculation
Custom code to run as part of a post process when evaluating this column
Declaration
public string PostProcessCalculation { get; set; }
Property Value
Precision
If this is a decimal sql type this holds the precision amount as in decimal(18,2)
Declaration
public short? Precision { get; set; }
Property Value
QueryRunnerID
[Key] Links to IQueryRunner. The parent query runner this belongs to.
Declaration
public Guid? QueryRunnerID { get; set; }
Property Value
QueryRunnerID_Label
Declaration
public string QueryRunnerID_Label { get; set; }
Property Value
QueryRunnerID_Label_Silent
Declaration
[NotMapped]
public string QueryRunnerID_Label_Silent { get; set; }
Property Value
ReportID
[Key] Links to IReport. The parent report this belongs to.
Declaration
public Guid? ReportID { get; set; }
Property Value
ReportID_Label
Declaration
public string ReportID_Label { get; set; }
Property Value
ReportID_Label_Silent
Declaration
[NotMapped]
public string ReportID_Label_Silent { get; set; }
Property Value
SQLType
Indicates the actual underlying sql type this column holds
Declaration
[EnumDataType(typeof(SQLType))]
public SQLType SQLType { get; set; }
Property Value
Declaration
[NotMapped]
public string SQLType_Tooltip { get; set; }
Property Value
SQLWrapperID
[Key] Links to ISQLWrapper. The parent sql wrapper this belongs to.
Declaration
public Guid? SQLWrapperID { get; set; }
Property Value
SQLWrapperID_Label
Declaration
public string SQLWrapperID_Label { get; set; }
Property Value
SQLWrapperID_Label_Silent
Declaration
[NotMapped]
public string SQLWrapperID_Label_Silent { get; set; }
Property Value
Scale
If this is a decimal sql type this holds the scale amount as in decimal(18,2)
Declaration
public short? Scale { get; set; }
Property Value
SortOrder
Can only be used in queries with a Top/Skip setting. Results are otherwise always unordered and are only ordered by the callee.
Declaration
[EnumDataType(typeof(Order))]
public Order SortOrder { get; set; }
Property Value
Declaration
[NotMapped]
public string SortOrder_Tooltip { get; set; }
Property Value
Type
Indicates what type of data this is to wrap. i.e. parameter or return column type.
Declaration
[EnumDataType(typeof(SQLTypeWrapperType))]
public SQLTypeWrapperType Type { get; set; }
Property Value
Declaration
[NotMapped]
public string Type_Tooltip { get; set; }
Property Value
VennSetID
[Key] Links to IVennset. The Venn set item this belongs to.
Declaration
public Guid? VennSetID { get; set; }
Property Value
VennSetID_Label
Declaration
public string VennSetID_Label { get; set; }
Property Value
VennSetID_Label_Silent
Declaration
[NotMapped]
public string VennSetID_Label_Silent { get; set; }
Property Value
VennSetQueryableItemID
Declaration
public Guid? VennSetQueryableItemID { get; set; }
Property Value
VennSetQueryableItemID_Label
Declaration
public string VennSetQueryableItemID_Label { get; set; }
Property Value
VennSetQueryableItemID_Label_Silent
Declaration
[NotMapped]
public string VennSetQueryableItemID_Label_Silent { get; set; }
Property Value
Visible
Indicates if this column is visible by default when the results are displayed in a grid. The user can always make
the column visible if it is hidden, and will always see the column in result exports too.
Declaration
public bool Visible { get; set; }
Property Value
Methods
CopyFromEntity(IBaseEntity)
Declaration
protected override void CopyFromEntity(IBaseEntity src)
Parameters
Overrides
CopyFromSource(ISQLTypeWrapper)
Updates all properties in this item to have the same properties as the source object.
Declaration
public void CopyFromSource(ISQLTypeWrapper source)
Parameters
| Type |
Name |
Description |
| ISQLTypeWrapper |
source |
The source object to copy all values from.
|
GetFrameworkTypeType()
Declaration
public Type GetFrameworkTypeType()
Returns
SetEntityParamComboItems(Func<SQLTypeWrapper, KeyValuePair<string, string>[]>)
Declaration
public void SetEntityParamComboItems(Func<SQLTypeWrapper, KeyValuePair<string, string>[]> comboItems)
Parameters
SetFrameworkTypeType(Type)
Declaration
public void SetFrameworkTypeType(Type type)
Parameters
| Type |
Name |
Description |
| Type |
type |
|
ToString()
Declaration
public override string ToString()
Returns
Overrides
UpdateFrameworkType()
Declaration
public void UpdateFrameworkType()
Implements
Extension Methods