Returns a formatted string. This method is used by the methods Print(String) and PrintHTML(PrintMatrixFormat, Object, Int32, Int32). This method can be overridden to gain finer control over printing.

Namespace: Imsl.Math
Assembly: ImslCS (in ImslCS.dll) Version: 6.5.0.0

Syntax

C#
public virtual string Format(
	PrintMatrixFormat..::.FormatType type,
	Object entry,
	int row,
	int col,
	PrintMatrixFormat..::.ParsePosition pos
)
Visual Basic (Declaration)
Public Overridable Function Format ( _
	type As PrintMatrixFormat..::.FormatType, _
	entry As Object, _
	row As Integer, _
	col As Integer, _
	pos As PrintMatrixFormat..::.ParsePosition _
) As String
Visual C++
public:
virtual String^ Format(
	PrintMatrixFormat..::.FormatType type, 
	Object^ entry, 
	int row, 
	int col, 
	PrintMatrixFormat..::.ParsePosition^ pos
)

Parameters

type
Type: Imsl.Math..::.PrintMatrixFormat..::.FormatType
The type of string requested. See PrintMatrixFormat.FormatType Enumeration.
entry
Type: System..::.Object
The entry to be formatted. This is only used if type equals Entry. For other values of type, this can be set to null.
row
Type: System..::.Int32
The (0-based) row number of the element to be formatted. This is -1 if there is no row number associated with this request.
col
Type: System..::.Int32
The (0-based) column number of the element to be formatted. This is -1 if there is no column number associated with this request.
pos
Type: Imsl.Math..::.PrintMatrixFormat..::.ParsePosition
A ParsePosition object used to indicate the alignment center of the return string. This is used only if type is Entry.

Return Value

A String to be put into the printed table.

Remarks

Note, if type is not FormatType.Entry, pos will be set based on the following criteria.

entry behavior
double The index is the position of the decimal point.
int The index is the position of the end of the formatted integer.

See Also