[This is preliminary documentation and is subject to change.]

Returns the first alphabets of the first name or the last name depending on the value of orderBy argument for a particular group.

Namespace:  OfficeClip.DBLayer.Desktop
Assembly:  OfficeClip.DBLayer (in OfficeClip.DBLayer)
Version: 8.1.1.0

Syntax

C#
public List<AlphabetListItem> GetAlphabetLinks(
	SortByName orderBy,
	int addressbookId
)
Visual Basic (Declaration)
Public Function GetAlphabetLinks ( _
	orderBy As SortByName, _
	addressbookId As Integer _
) As List(Of AlphabetListItem)
Visual C++
public:
List<AlphabetListItem^>^ GetAlphabetLinks(
	SortByName orderBy, 
	int addressbookId
)

Parameters

orderBy
Type: OfficeClip.Utils..::.SortByName
Enumerated value determining whether to sort the user list by the first character of the first name or last name. SortByName
addressbookId
Type: System..::.Int32
The unique id of the address book

Return Value

DataSet containing the list of alphabets for which there are users in the particular group. This DataSet consists of a single DataTable with the following columns.
  • Alphabet (System.String)Single character alphabet signifying that there are users in the list who have either their first name or last name starting with it.
  • isPresent (System.Boolean)Flag indicating whether the users corresponding to that particular alphabet are present or not.

See Also