MaxCustomControls::ColumnSortState Class Reference

---

Detailed Description

A State class that represents the sort state of a specific tree list column.

This is used for implementing save/load mechanism of the tree list sort states.

List of all members.

Public Member Functions
	ColumnSortState (string fieldName, SortOrder sortOrder)
	Constructor which accepts the fieldname and sortOrder of a given tree list column.
override string	ToString ()
	Format the ColumnSortState object to a string.
Static Public Member Functions
static ColumnSortState	Parse (string s)
	Convert a formated string (usually comes from ColumnSortState.ToString()) to a ColumnSortState object.
Properties
string	FieldName [get]
	The field name that used to identify the tree list column.
SortOrder	SortOrder [get]
	The sort order of the tree list column.

---

Constructor & Destructor Documentation

MaxCustomControls::ColumnSortState::ColumnSortState	(	string	fieldName,
		SortOrder	sortOrder
	)		[inline]

Constructor which accepts the fieldname and sortOrder of a given tree list column.

Parameters:

fieldName	The fieldname of the tree list column
sortOrder	The sort order of the tree list column. (Ascending/Descending/None)

---

Member Function Documentation

override string MaxCustomControls::ColumnSortState::ToString

(

)

[inline]

Format the ColumnSortState object to a string.

static ColumnSortState MaxCustomControls::ColumnSortState::Parse

(

string

s

)

[inline, static]

Convert a formated string (usually comes from ColumnSortState.ToString()) to a ColumnSortState object.

Exceptions:

System.ArgumentException

Thrown when the string can not be parsed to a ColumnSortState object. i.e. the format of the string is incorrect. e.g. the string is either an empty string ("") or only contains white space.

Parameters:

s	The string which contains serialized ColumnSortState

---

Property Documentation

string MaxCustomControls::ColumnSortState::FieldName [get]

The field name that used to identify the tree list column.

SortOrder MaxCustomControls::ColumnSortState::SortOrder [get]

The sort order of the tree list column.