Table of Contents

Class UserParameterVO

Namespace
PHCBusinessLayer
Assembly
PHCBusinessLayer.dll

Add-on parameter

[AttTable("UserParameter", 20220526)]
[AttTableTarget(DBTarget.Home)]
[AttTableFlags(new TableFlags[] { TableFlags.MasterEntity, TableFlags.TableForJorge, TableFlags.FullTextSearchable, TableFlags.AddOnNotCustomizable, TableFlags.AddOnFramework, TableFlags.StudioOnly })]
[AttTableVOInfo(typeof(UserParameterAttInfo))]
public class UserParameterVO : BusinessVO, IBaseSerialization, ICloneVO, ICloneable, IChange, IParent, IGenericVO
Inheritance
UserParameterVO

Properties

defaultvalue

Default Value

[AttLenght(100)]
public string defaultvalue { get; set; }

Property Value

string

defaultvaluebool

Default Value

[AttFieldType(AttFieldType.InputTypes.boolean)]
public bool defaultvaluebool { get; set; }

Property Value

bool

defaultvaluedate

Default Value

[AttFieldType(AttFieldType.InputTypes.date)]
public DateTime defaultvaluedate { get; set; }

Property Value

DateTime

defaultvaluememo

Default Value

public string defaultvaluememo { get; set; }

Property Value

string

defaultvaluenumber

Default Value

[AttLenght(19, 6)]
[AttFieldType(AttFieldType.InputTypes.decimal)]
public decimal defaultvaluenumber { get; set; }

Property Value

decimal

description

Description given by developer

[AttList]
public string description { get; set; }

Property Value

string

design

Title

[AttLenght(100)]
[AttMandatory]
public string design { get; set; }

Property Value

string

dytableId

Dytable ID

[AttLenght(60)]
public string dytableId { get; set; }

Property Value

string

idname

Parameter unique ID

[AttLenght(60)]
[AttPrimaryKey]
[AttMandatory]
[AttLogInfo(0)]
[AttList]
public string idname { get; set; }

Property Value

string

length

Value length, for numeric values it´s only the lenght of integer part

[AttLenght(3)]
public int length { get; set; }

Property Value

int

lengthdec

For numeric values it´s the lenght of decimal part

[AttLenght(2)]
public int lengthdec { get; set; }

Property Value

int

listtitles

For list types, it's the titles itens separated by comma, if is empty the system assumes the same as listvalues

[AttFieldType(AttFieldType.InputTypes.memo)]
public string listtitles { get; set; }

Property Value

string

listvalues

For list types, it's the values itens separated by comma

[AttFieldType(AttFieldType.InputTypes.memo)]
public string listvalues { get; set; }

Property Value

string

mandatory

Can not be empty

[AttFieldType(AttFieldType.InputTypes.boolean)]
public bool mandatory { get; set; }

Property Value

bool

maxvalue

Maximum value

[AttLenght(10)]
[AttFieldType(AttFieldType.InputTypes.integer)]
public int maxvalue { get; set; }

Property Value

int

minvalue

Minimum value

[AttLenght(10)]
[AttFieldType(AttFieldType.InputTypes.integer)]
public int minvalue { get; set; }

Property Value

int

newFormat

New Format Identify if the parameter is in the new format

[AttFieldType(AttFieldType.InputTypes.boolean, new AttFieldType.FieldFlags[] { AttFieldType.FieldFlags.isReadOnly })]
public bool newFormat { get; set; }

Property Value

bool

optiontext

Default Value

[AttFieldType(AttFieldType.InputTypes.memo)]
public string optiontext { get; set; }

Property Value

string

optionvalue

Default Value

[AttFieldType(AttFieldType.InputTypes.memo)]
public string optionvalue { get; set; }

Property Value

string

order

Order of viewing within the respective Add-on group

[AttLenght(4)]
[AttFieldType(AttFieldType.InputTypes.integer)]
public int order { get; set; }

Property Value

int

paratype

Value type

[AttLenght(2)]
[AttMandatory]
public UserParameterBiz.ParameterTypes paratype { get; set; }

Property Value

UserParameterBiz.ParameterTypes

paratypetoparam

[AttVirtualField]
public string paratypetoparam { get; }

Property Value

string

rulecode

save validation

[AttList(Hidden = true)]
public string rulecode { get; set; }

Property Value

string

searchquery

Default Value

[AttFieldType(AttFieldType.InputTypes.memo)]
[AttList(Hidden = true)]
public string searchquery { get; set; }

Property Value

string

subgroup

Default Value

[AttMandatory]
public string subgroup { get; set; }

Property Value

string

subgrouptoparam

[AttVirtualField]
public string subgrouptoparam { get; }

Property Value

string

toolDescription

Virtual use only for "recent" tab @frontend Do not forget to include AttList for fields that are included in virtual

[AttVirtualField]
public string toolDescription { get; set; }

Property Value

string

toolName

Virtual use only for "recent" tab @frontend Do not forget to include AttList for fields that are included in virtual

[AttVirtualField]
public string toolName { get; set; }

Property Value

string

tooltip

User help text

[AttFieldType(AttFieldType.InputTypes.memo)]
public string tooltip { get; set; }

Property Value

string

translations

[AttCollection(typeof(UserLocaleVO), new string[] { "[UserLocale].[parentStamp]", "[UserParameter].[userparameterstamp]" })]
public List<UserLocaleVO> translations { get; set; }

Property Value

List<UserLocaleVO>

userparameterstamp

Record unique ID

[AttLenght(25)]
public string userparameterstamp { get; set; }

Property Value

string

Explicit Interface Implementations

AsStudioTool()

StudioToolVO AsStudioTool()

Returns

StudioToolVO

CanDeleteTool()

bool CanDeleteTool()

Returns

bool

ToolMainFields()

List<string> ToolMainFields()

Returns

List<string>