NumericRange2Str




http://www.QuantTools.com
CapeTools Range Utils function list

Welcome | Documentation format | QuantTools Groups | QuantTools Categories | Licence

Key TAGs | Excel Index | API Index


Given a range object, (Excel range if using Excel, 2D Variant if using Visual Basic or VBA and finally CTRangeData if using C++, Java or any of the .NET languages), this function will convert a range object into a string representation.

This string representation can be passed to the RangeFromStr function to recreate the range.

Currently this function has the same functionality as Range2Str(), it is however optimised for numeric data.



Note: Within Excel, the function is named - CT.Range.NumericRange2Str


High level graphic of NumericRange2Str() function with parameters. Blue square node is the actual function with the parameters ordered.



Parameter Description


  1. Range parameter

    The range you wish to convert to a string representation.


Extended information

Function Syntax

VB Syntax 


String CTRange.NumericRange2Str( _
Variant Range)


Excel Spreadsheet Syntax 


=CT.Range.NumericRange2Str(
XLRange Range)


C++ Syntax 


static std::string NumericRange2Str(
CTRangeDataCPP Range);


DotNET Syntax 


System.String CTRangeSA.NumericRange2Str(
CTRangeData Range);

Parameter data types

ArgNameArgTypeIsKey
RangeRangeFALSE

Example Inputs

The first column represents the name of the parameters. The second column specifies whether the parameters are optional or not. Finally the last column provides some sample input data.
Function call input string-keys are always in the format : "NAME.EXTTAG.TICKER" The "EXTTAG.TICKER" part is determined from the output of other, capetools, object creation functions.


ArgNameIsOptional (Excel only)Example
RangeFALSENumericRange2Str_Range_Range (creates a range object)


Example range for parameter : Range

Within Excel, a range such as this can be passed directly into the Range parameter.

2015.3
2026.4
203100.8
204-62.0

Example C# API usage for setting the range data for parameter : Range 


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

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

NumericRange2Str_Range_builder.Append("{");
NumericRange2Str_Range_builder.Append("20	 | 1	 | 5.3 ;");
NumericRange2Str_Range_builder.Append("20	 | 2	 | 6.4 ;");
NumericRange2Str_Range_builder.Append("20	 | 3	 | 100.8 ;");
NumericRange2Str_Range_builder.Append("20	 | 4	 | -62.0");
NumericRange2Str_Range_builder.Append("}");

// Parse the string into the Range object.
NumericRange2Str_Range.RangeFromStr( NumericRange2Str_Range_builder.ToString() );


Example function usage


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.


If you are accessing this functrion via the MiniXL libraries, this function is present within the CT.QL.Utils20 MiniXL Excel Addin.

Within our Excel Example Addin Generator, we have used the following QuantTools sub-functions in order to prepare the arguments needed to call the NumericRange2Str() function. If you are executing this function via the MiniXL libraries, the module addin name, (in brackets, to the right of the sub-functions listed below), indicates the MiniXL library in which the sub-function is held. You will need to load this library into your Excel session (along with any other libraries that the sub-function call within the addin requires (ie - CT.QT.Utils20 addin in almost all cases) in order for the example to compute successfully.


The following four examples demostrate calling this function within a Microsoft .NET environment

The following four examples demostrate calling this function within a non .NET environment

The following is a sample output from executing the NumericRange2Str() function call


Example
2015.3
2026.4
203100.8
204-62.0



Copyright (c) 2003-2007 CapeTools - All Rights Reserved.