C# Class TShockAPI.PaginationTools

Provides tools for sending paginated output.

Mostra file Open project: NyxStudios/TShock Class Usage Examples

Public Methods

Method	Description
BuildLinesFromTerms ( IEnumerable terms, string>.Func termFormatter = null, string separator = ", ", int maxCharsPerLine = 80 ) : List
SendPage ( TShockAPI.TSPlayer player, int pageNumber, IEnumerable dataToPaginate, int dataToPaginateCount, Settings settings = null ) : void
SendPage ( TShockAPI.TSPlayer player, int pageNumber, IList dataToPaginate, Settings settings = null ) : void
TryParsePageNumber ( List commandParameters, int expectedParameterIndex, TShockAPI.TSPlayer errorMessageReceiver, int &pageNumber ) : bool

Method Details

BuildLinesFromTerms() public static method

public static BuildLinesFromTerms ( IEnumerable terms, string>.Func termFormatter = null, string separator = ", ", int maxCharsPerLine = 80 ) : List
terms	IEnumerable
termFormatter	string>.Func
separator	string
maxCharsPerLine	int
return	List

SendPage() public static method

public static SendPage ( TShockAPI.TSPlayer player, int pageNumber, IEnumerable dataToPaginate, int dataToPaginateCount, Settings settings = null ) : void
player	TShockAPI.TSPlayer
pageNumber	int
dataToPaginate	IEnumerable
dataToPaginateCount	int
settings	Settings
return	void

SendPage() public static method

public static SendPage ( TShockAPI.TSPlayer player, int pageNumber, IList dataToPaginate, Settings settings = null ) : void
player	TShockAPI.TSPlayer
pageNumber	int
dataToPaginate	IList
settings	Settings
return	void

TryParsePageNumber() public static method

public static TryParsePageNumber ( List commandParameters, int expectedParameterIndex, TShockAPI.TSPlayer errorMessageReceiver, int &pageNumber ) : bool
commandParameters	List
expectedParameterIndex	int
errorMessageReceiver	TShockAPI.TSPlayer
pageNumber	int
return	bool