Class SoListItem

Default ListProvider item

Inheritance
System.Object
SoListItem
MenuListItem
SelectableListItem
SoListItemDeep
Implements
System.IComparable<ISoListItem>
System.IComparable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Lists
Assembly: SoCore.dll
Syntax
public class SoListItem : ISoListItem, IComparable<ISoListItem>, IComparable

Constructors

SoListItem()

Default constructor

Declaration
public SoListItem()

SoListItem(ISoListItem)

'Copy' constructor to make a deep copy of a list item.

Declaration
public SoListItem(ISoListItem item)
Parameters
Type Name Description
ISoListItem item

SoListItem(Int32, String, String, Int16, Boolean, String, Int32, String, String, String, String)

Default constructor

Declaration
public SoListItem(int Id, string Name, string Tooltip, short Rank, bool Deleted, string Type, int Color, string IconHint, string StyleHint, string ExtraInfo, string FullName = "")
Parameters
Type Name Description
System.Int32 Id

Primary key
System.String Name

Visible item name
System.String Tooltip

Visible item tooltip
System.Int16 Rank

Item rank (lowest first in sort order)
Boolean Deleted

Deleted flag (deleted if true)
System.String Type

Item type, interpretation depends on list
System.Int32 Color

Item color
System.String IconHint

Suggested item icon
System.String StyleHint
System.String ExtraInfo
System.String FullName

SoListItem(Int32, String, String, String)

Simplified constructor, where everything except id, name and tooltip defaults to empty. The rank is set the same as the ID, and deleted is set to false.

Declaration
public SoListItem(int Id, string Name, string Tooltip, string ExtraInfo)
Parameters
Type Name Description
System.Int32 Id

Primary key
System.String Name

Visible item name
System.String Tooltip

Visible item tooltip
System.String ExtraInfo

Properties

Color

Declaration
public int Color { get; set; }
Property Value
Type Description
System.Int32

Deleted

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

ExtraInfo

Declaration
public string ExtraInfo { get; set; }
Property Value
Type Description
System.String

FullName

Declaration
public string FullName { get; set; }
Property Value
Type Description
System.String

IconHint

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

Id

Declaration
public int Id { get; set; }
Property Value
Type Description
System.Int32

Name

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

Rank

Declaration
public short Rank { get; set; }
Property Value
Type Description
System.Int16

StyleHint

Declaration
public string StyleHint { get; set; }
Property Value
Type Description
System.String

Tooltip

Declaration
public string Tooltip { get; set; }
Property Value
Type Description
System.String

Type

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

Methods

CompareTo(ISoListItem)

Compare the rank of this item to the rank of another item.

Declaration
public int CompareTo(ISoListItem other)
Parameters
Type Name Description
ISoListItem other

Item to compare Rank with.
Returns
Type Description
System.Int32

Rank compared to other's rank.

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Object.GetHashCode()

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()

Explicit Interface Implementations

IComparable.CompareTo(Object)

Declaration
int IComparable.CompareTo(object obj)
Parameters
Type Name Description
System.Object obj
Returns
Type Description
System.Int32

Implements

System.IComparable<T>
System.IComparable

Extension Methods

EnumUtil.MapEnums<From, To>(From)