Class ArchiveOrderByInfo
This class carries information about an ordering criterion for an archive
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoCore.dll
Syntax
public class ArchiveOrderByInfoConstructors
ArchiveOrderByInfo()
Construct the object with a blank name and ascending sort
Declaration
public ArchiveOrderByInfo()ArchiveOrderByInfo(String)
Construct the object with the given name and ascending sort
Declaration
public ArchiveOrderByInfo(string name)Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Programmatic name of the column to order by, semantically the same as the ArchiveColumnInfo Name |
ArchiveOrderByInfo(String, OrderBySortType)
Construct the object with the given name and sort order
Declaration
public ArchiveOrderByInfo(string name, OrderBySortType direction)Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Programmatic name of the column to order by, semantically the same as the ArchiveColumnInfo Name |
| OrderBySortType | direction | Direction of sort |
Properties
Direction
Direction to order
Declaration
public OrderBySortType Direction { get; set; }Property Value
| Type | Description |
|---|---|
| OrderBySortType |
Name
Programmatic name of the column to order by, semantically the same as the ArchiveColumnInfo Name.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Methods
FromDelimitedString(String)
Converts a string with format: columnName,direction1;columnName2,direction2 to an enumerable of ArchiveOrderByInfo
Declaration
public static ArchiveOrderByInfo[] FromDelimitedString(string s)Parameters
| Type | Name | Description |
|---|---|---|
| String | s | Delimited string |
Returns
| Type | Description |
|---|---|
| ArchiveOrderByInfo[] |
ToNameArray(ArchiveOrderByInfo[])
Utility method to convert an array of ArchiveRestrictionInfo into a string array containing the names only
Declaration
public static string[] ToNameArray(params ArchiveOrderByInfo[] orderByInfos)Parameters
| Type | Name | Description |
|---|---|---|
| ArchiveOrderByInfo[] | orderByInfos |
Returns
| Type | Description |
|---|---|
| String[] | Array of names, in original order |
ToString()
Convert this instance to a string for debug display
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |
Overrides
ToString(String)
Declaration
public string ToString(string prefix)Parameters
| Type | Name | Description |
|---|---|---|
| String | prefix |
Returns
| Type | Description |
|---|---|
| String |