WriteXLRange




http://www.QuantTools.com
CapeTools QueryDB function list

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

Key TAGs | Excel Index | API Index


Writes a single range object to a XML file.

Returns a string mode of success of failure.

This function is useful, for example from an Excel environment, if you wish to store ranges independently from a spreadsheet.

XML files can be saved to a central location where other users can also read these ranges back in via the ReadXLRange() function.



Note: Within Excel, the function is named - CT.XML.WriteXLRange


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



Parameter Description


  1. FileName parameter

    Name of the file to write to (can include path).
  2. Path parameter

    Optional directory path. Will be pre-pended to the FileName parameter.
  3. Range parameter

    Range to write.


Extended information

Function Syntax

VB Syntax 


String CTQueryDB.WriteXLRange( _
String FileName, _
String Path, _
Variant Range)


Excel Spreadsheet Syntax 


=CT.XML.WriteXLRange(
Excel String Cell FileName,
Excel String Cell Path,
XLRange Range)


C++ Syntax 


static std::string WriteXLRange(
std::string FileName,
std::string Path,
CTRangeDataCPP Range);


DotNET Syntax 


System.String CTQueryDBSA.WriteXLRange(
System.String FileName,
System.String Path,
CTRangeData Range);

Parameter data types

ArgNameArgTypeIsKey
FileNameStringFALSE
PathStringFALSE
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
FileNameFALSEMyXLData
PathTRUEC:\
RangeFALSEWriteXLRange_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.

17
28
39
410
511
612

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


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

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

WriteXLRange_Range_builder.Append("{");
WriteXLRange_Range_builder.Append("1	 | 7 ;");
WriteXLRange_Range_builder.Append("2	 | 8 ;");
WriteXLRange_Range_builder.Append("3	 | 9 ;");
WriteXLRange_Range_builder.Append("4	 | 10 ;");
WriteXLRange_Range_builder.Append("5	 | 11 ;");
WriteXLRange_Range_builder.Append("6	 | 12");
WriteXLRange_Range_builder.Append("}");

// Parse the string into the Range object.
WriteXLRange_Range.RangeFromStr( WriteXLRange_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 WriteXLRange() 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 WriteXLRange() function call


OK

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