Class CriteriaInfo

Inheritance
Object
CriteriaInfo
Implements
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public class CriteriaInfo : Object, ICloneable

Constructors

CriteriaInfo()

Default constructor

Declaration
public CriteriaInfo()

CriteriaInfo(Int32, String, String, String, String, Boolean, Boolean, String, String)

Constructor

Declaration
public CriteriaInfo(int id, string name, string displayName, string displayTooltip, string displayType, bool canOrderBy, bool isVisible, string width, string restrictionType)
Parameters
Type Name Description
Int32 id
String name
String displayName
String displayTooltip
String displayType
Boolean canOrderBy
Boolean isVisible
String width
String restrictionType

CriteriaInfo(Int32, String, String, String, String, Boolean, Boolean, String, String, String)

Constructor

Declaration
public CriteriaInfo(int id, string name, string displayName, string displayTooltip, string displayType, bool canOrderBy, bool isVisible, string width, string restrictionType, string restrictionListName)
Parameters
Type Name Description
Int32 id
String name
String displayName
String displayTooltip
String displayType
Boolean canOrderBy
Boolean isVisible
String width
String restrictionType
String restrictionListName

Properties

ArchiveColumnInfo

The decorated ArchiveColumnInfo property

Declaration
public ArchiveColumnInfo ArchiveColumnInfo { get; set; }
Property Value
Type Description
ArchiveColumnInfo

CanOrderBy

Can this column be used for sorting?

Declaration
public bool CanOrderBy { get; set; }
Property Value
Type Description
Boolean

CanRestrictBy

Can this column be used as a restriction

Declaration
public bool CanRestrictBy { get; set; }
Property Value
Type Description
Boolean

CriteriaId

Declaration
public int CriteriaId { get; set; }
Property Value
Type Description
Int32

DisplayName

The column name to show, can be a resource identifier string

Declaration
public string DisplayName { get; set; }
Property Value
Type Description
String

DisplayTooltip

The column tooltip, used in the column list and in the column headings

Declaration
public string DisplayTooltip { get; set; }
Property Value
Type Description
String

DisplayType

Type of column, so that the archive knows how to display it (actual display values are always strings, invariant-culture formatted). This name can contain resource tags.

Declaration
public string DisplayType { get; set; }
Property Value
Type Description
String

HeadingIconHint

Icon hint for the archive heading only. If this is a nonempty string, the archive header should use this icon and ignore the DisplayName. Otherwise, the DisplayName should be used as the heading.

Declaration
public string HeadingIconHint { get; set; }
Property Value
Type Description
String

IconHint

Icon hint corresponding to the display name; this icon hint is used in the configuration dialog and other places where we 'talk about' the columns of the archive. The actual heading of the archive may also contain icons in lieu of textual names, the icon hint for that is specified in HeadingIconHint and is a different one.

Declaration
public string IconHint { get; set; }
Property Value
Type Description
String

IsVisible

Is this column visible to the user in configuration dialogs etc

Declaration
public bool IsVisible { get; set; }
Property Value
Type Description
Boolean

Name

Unique identity of this column (in this particular context); the name to be used when requesting the column from a provider, setting restrictions or order by criteria

Declaration
public string Name { get; set; }
Property Value
Type Description
String

RestrictionListName

If the restriction data type is 'list', this property contains the name of the SoList so that choices can be shown

Declaration
public string RestrictionListName { get; set; }
Property Value
Type Description
String

RestrictionType

The data type of the restriction; use this to retrieve the legal operators for the restriction

Declaration
public string RestrictionType { get; set; }
Property Value
Type Description
String

Width

The width specification, if the column info has been extended with GUI-based information. It is either "n%" or "nc", where n is an integer. Percent-formatted fields grow and shrink; number-of-characters formatted fields have constant width when the whole archive width changes.

Declaration
public string Width { get; set; }
Property Value
Type Description
String

Methods

Clone()

Declaration
public object Clone()
Returns
Type Description
Object

Operators

Implicit(CriteriaInfo to ArchiveColumnInfo)

Implicit cast from CriteriaInfo to ArchiveColumnInfo

Declaration
public static implicit operator ArchiveColumnInfo(CriteriaInfo criteriaInfo)
Parameters
Type Name Description
CriteriaInfo criteriaInfo
Returns
Type Description
ArchiveColumnInfo

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)