Replaces the 'NA' padding within an Excel range with a user defined string.

This function will increase the size of the range returned.

You specify the extra number of columns and rows (via the nDepth parameter) which will be applied to the range object.

this function is really only useful from Excel as usually the user does not know the size of the range returned and can thus format the unwanted 'NA' values to the right and bottom of a range with friendly values.

within the Visual Basic, VBA, C++, Java and .NET APIs, a range object is returned and there are functions that can be used to determine the size of the range object returned.

Variant CTUtils.CleanXLRange( _
Variant XLRange, _
String szPadString, _
Long nDepth)

=CT.UTIL.CleanXLRange(
XLRange XLRange,
Excel String Cell szPadString,
Excel Numeric Cell nDepth)

static CTRangeDataCPP CleanXLRange(
CTRangeDataCPP XLRange,
std::string szPadString,
long nDepth);

CTRangeData CTUtilsSA.CleanXLRange(
CTRangeData XLRange,
System.String szPadString,
System.Int32 nDepth);

CTQL.CTRangeData CleanXLRange_XLRange = new CTQL.CTRangeData();

System.Text.StringBuilder CleanXLRange_XLRange_builder =
new System.Text.StringBuilder(100);

CleanXLRange_XLRange_builder.Append("{");
CleanXLRange_XLRange_builder.Append("'1M'	 | '2M'	 | '3M' ;");
CleanXLRange_XLRange_builder.Append("2.0	 | 5.0	 | 7.0");
CleanXLRange_XLRange_builder.Append("}");

// Parse the string into the Range object.
CleanXLRange_XLRange.RangeFromStr( CleanXLRange_XLRange_builder.ToString() );

The C# example below contains all the sub-function calls leading up to this function call. As a result, the example can contain a lot of code.

The VB.NET, J#, C++.NET, Java, Excel VBA, Visual Basic 6 (via COM) and C++ examples below contain function code stubs for the calls leading up to this function call. However, the function call for this function is displayed.
You can easily reproduce the stub functions code from the C# example.