Class SoListItem
Default ListProvider item
Inherited Members
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(int, string, string, short, bool, string, int, 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 |
---|---|---|
int | Id | Primary key |
string | Name | Visible item name |
string | Tooltip | Visible item tooltip |
short | Rank | Item rank (lowest first in sort order) |
bool | Deleted | Deleted flag (deleted if true) |
string | Type | Item type, interpretation depends on list |
int | Color | Item color |
string | IconHint | Suggested item icon |
string | StyleHint | |
string | ExtraInfo | |
string | FullName |
SoListItem(int, 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 |
---|---|---|
int | Id | Primary key |
string | Name | Visible item name |
string | Tooltip | Visible item tooltip |
string | ExtraInfo |
Properties
Color
Default ListProvider item
Declaration
public int Color { get; set; }
Property Value
Type | Description |
---|---|
int |
Deleted
Default ListProvider item
Declaration
public bool Deleted { get; set; }
Property Value
Type | Description |
---|---|
bool |
ExtraInfo
Default ListProvider item
Declaration
public string ExtraInfo { get; set; }
Property Value
Type | Description |
---|---|
string |
FullName
The name of the ListItem in its context
Declaration
public string FullName { get; set; }
Property Value
Type | Description |
---|---|
string |
IconHint
Default ListProvider item
Declaration
public string IconHint { get; set; }
Property Value
Type | Description |
---|---|
string |
Id
Default ListProvider item
Declaration
public int Id { get; set; }
Property Value
Type | Description |
---|---|
int |
Name
Default ListProvider item
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Rank
Default ListProvider item
Declaration
public short Rank { get; set; }
Property Value
Type | Description |
---|---|
short |
StyleHint
Default ListProvider item
Declaration
public string StyleHint { get; set; }
Property Value
Type | Description |
---|---|
string |
Tooltip
Default ListProvider item
Declaration
public string Tooltip { get; set; }
Property Value
Type | Description |
---|---|
string |
Type
Default ListProvider item
Declaration
public string Type { get; set; }
Property Value
Type | Description |
---|---|
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 |
---|---|
int | Rank compared to other's rank. |
GetHashCode()
Default ListProvider item
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int |
Overrides
ToString()
Default ListProvider item
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |