Advance Method

FileNavigator Advance Method

CleanCode C# Libraries v1.2.03 API

Advances the FileNavigator to the preceding or following file, depending upon the specified Online

IComparer.

Namespace: CleanCode.IO
Assembly: CleanCode (in CleanCode.dll) Version: 1.2.3.0 (1.2.03)

Syntax

C++

Copy to Clipboard Print

public int Advance(
	IComparer comparer
)

public int Advance(
	IComparer comparer
)

Public Function Advance ( _
	comparer As IComparer _
) As Integer

Public Function Advance ( _
	comparer As IComparer _
) As Integer

public:
int Advance(
	IComparer^ comparer
)

public:
int Advance(
	IComparer^ comparer
)

Parameters

comparer: Type: System.Collections IComparer
The IComparer to use for ordering files.

Return Value

0 if successful, -1 if no directory selected, -2 if no files found, or -3 if the current file is not found (in which case the first file in the directory will be returned).

Remarks

Locates the currently selected file name from the Online

ComboBox and goes to the "next" file, where the next one is typically the the preceding one or the following one, depending on the comparer. The progression wraps around either end of the list of files in the current directory.

Examples

This example shows how to instrument previous and next buttons on a Windows form.

Copy to Clipboard Print

private void prevFileButton_Click(object sender, EventArgs e)
{
    fileNavigator.Advance(new CleanCode.IO.DateComparerAscending());
}

private void nextFileButton_Click(object sender, EventArgs e)
{
    fileNavigator.Advance(new CleanCode.IO.DateComparerDescending());
}

private void prevFileButton_Click(object sender, EventArgs e)
{
    fileNavigator.Advance(new CleanCode.IO.DateComparerAscending());
}

private void nextFileButton_Click(object sender, EventArgs e)
{
    fileNavigator.Advance(new CleanCode.IO.DateComparerDescending());
}