forked from Excel-DNA/Samples
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ParameterConversionExamples.cs
364 lines (318 loc) · 11.3 KB
/
ParameterConversionExamples.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
using System;
using System.Collections.Generic;
using ExcelDna.Integration;
using System.Numerics;
using ExcelDna.Registration;
namespace Registration.Sample
{
// TODO: Fix double->int and similar conversions when objects are received
// Test multi-hop return type conversions
// Test ExcelArgumentAttributes are preserved.
public static class ParameterConversionExamples
{
// Explore conversions from object -> different types
[ExcelFunction(IsMacroType=true)]
public static string dnaConversionTest([ExcelArgument(AllowReference=true)] object arg)
{
// This is the full gamut we need to support
if (arg is double)
return "Double: " + (double)arg;
else if (arg is string)
return "String: " + (string)arg;
else if (arg is bool)
return "Boolean: " + (bool)arg;
else if (arg is ExcelError)
return "ExcelError: " + arg.ToString();
else if (arg is object[,])
// The object array returned here may contain a mixture of different types,
// reflecting the different cell contents.
return string.Format("Array[{0},{1}]", ((object[,])arg).GetLength(0), ((object[,])arg).GetLength(1));
else if (arg is ExcelMissing)
return "<<Missing>>";
else if (arg is ExcelEmpty)
return "<<Empty>>";
else if (arg is ExcelReference)
// Calling xlfRefText here requires IsMacroType=true for this function.
return "Reference: " + XlCall.Excel(XlCall.xlfReftext, arg, true);
else
return "!? Unheard Of ?!";
}
[Flags]
internal enum XlType12 : uint
{
XlTypeNumber = 0x0001,
XlTypeString = 0x0002,
XlTypeBoolean = 0x0004,
XlTypeReference = 0x0008,
XlTypeError = 0x0010,
XlTypeArray = 0x0040,
XlTypeMissing = 0x0080,
XlTypeEmpty = 0x0100,
XlTypeInt = 0x0800, // int16 in XlOper, int32 in XlOper12, never passed into UDF
}
[ExcelFunction]
public static string dnaConversionToString([ExcelArgument(AllowReference = true)] object arg)
{
return (string)XlCall.Excel(XlCall.xlCoerce, arg, (int)XlType12.XlTypeString);
}
[ExcelFunction]
public static string dnaDirectString(string arg)
{
return arg;
}
[ExcelFunction]
public static double dnaConversionToDouble([ExcelArgument(AllowReference = true)] object arg)
{
return (double)XlCall.Excel(XlCall.xlCoerce, arg, (int)XlType12.XlTypeNumber);
}
[ExcelFunction]
public static double dnaDirectDouble(double arg)
{
return arg;
}
[ExcelFunction]
public static int dnaConversionToInt32([ExcelArgument(AllowReference = true)] object arg)
{
// The explicit conversion to Int does truncation, which is different to how functions registered
// as taking an int argument (type "J") are handled.
object result = XlCall.Excel(XlCall.xlCoerce, arg, (int)XlType12.XlTypeInt);
double numResult = (double)XlCall.Excel(XlCall.xlCoerce, arg, (int)XlType12.XlTypeNumber);
return (int)Math.Round(numResult, MidpointRounding.AwayFromZero);
}
[ExcelFunction]
public static int dnaDirectInt32(int arg)
{
return arg;
}
[ExcelFunction]
public static long dnaConversionToInt64([ExcelArgument(AllowReference = true)] object arg)
{
double numResult = (double)XlCall.Excel(XlCall.xlCoerce, arg, (int)XlType12.XlTypeNumber);
return (long)Math.Round(numResult, MidpointRounding.AwayFromZero);
}
[ExcelFunction]
public static long dnaDirectInt64(long arg)
{
return arg;
}
[ExcelFunction]
public static DateTime dnaConversionToDateTime([ExcelArgument(AllowReference = true)] object arg)
{
return DateTime.FromOADate((double)XlCall.Excel(XlCall.xlCoerce, arg, (int)XlType12.XlTypeNumber));
}
[ExcelFunction]
public static DateTime dnaDirectDateTime(DateTime arg)
{
return arg;
}
[ExcelFunction]
public static bool dnaConversionToBoolean([ExcelArgument(AllowReference = true)] object arg)
{
// This is the full gamut we need to support
return (bool)XlCall.Excel(XlCall.xlCoerce, arg, (int)XlType12.XlTypeBoolean);
}
[ExcelFunction]
public static bool dnaDirectBoolean(bool arg)
{
return arg;
}
[ExcelFunction]
public static string dnaParameterConvertTest(double? optTest)
{
if (!optTest.HasValue) return "NULL!!!";
return optTest.Value.ToString("F1");
}
[ExcelFunction]
public static string dnaDoubleNullableOptional(double? arg = double.NaN)
{
return arg.ToString();
}
[ExcelFunction]
public static string dnaParameterConvertOptionalTest(double optOptTest = 42.0)
{
return "VALUE: " + optOptTest.ToString("F1");
}
[ExcelFunction]
public static string dnaMultipleOptional(double optOptTest1 = 3.14159265, string optOptTest2 = "@42@")
{
return "VALUES: " + optOptTest1.ToString("F7") + " & " + optOptTest2;
}
// Problem function
// This function cannot be called yet, since the cast from what Excel passes in (object) to the int we expect fails.
// It will need some improved conversion function in the OptionalParameterConversion.
[ExcelFunction]
public static string dnaOptionalInt(int optOptTest = 42)
{
return "VALUE: " + optOptTest.ToString("F1");
}
[ExcelFunction]
public static string dnaOptionalString(string optOptTest = "Hello World!")
{
return optOptTest;
}
[ExcelFunction]
public static string dnaNullableDouble(double? val)
{
return val.HasValue ? "VAL: " + val : "NULL";
}
[ExcelFunction]
public static string dnaNullableInt(int? val)
{
return val.HasValue ? "VAL: " + val : "NULL";
}
[ExcelFunction]
public static string dnaNullableLong(long? val)
{
return val.HasValue ? "VAL: " + val : "NULL";
}
[ExcelFunction]
public static string dnaNullableDateTime(DateTime? val)
{
return val.HasValue ? "VAL: " + val : "NULL";
}
[ExcelFunction]
public static string dnaNullableBoolean(bool? val)
{
return val.HasValue ? "VAL: " + val : "NULL";
}
[ExcelFunction]
public static string dnaNullableOptionalDateTime(DateTime? val = null)
{
return val.HasValue ? "VAL: " + val : "NULL";
}
public enum TestEnum1
{
Negative,
Zero,
Positive
}
public enum TestEnum2
{
Real,
Imaginary
}
[ExcelFunction]
public static TestEnum1 dnaReturnEnum1(string val)
{
//return val.HasValue ? val.Value : TestEnum.Zero;
return (TestEnum1)Enum.Parse(typeof(TestEnum1), val, true);
}
[ExcelFunction]
public static TestEnum2 dnaReturnEnum2(string val)
{
//return val.HasValue ? val.Value : TestEnum.Zero;
return (TestEnum2)Enum.Parse(typeof(TestEnum2), val, true);
}
[ExcelFunction]
public static Complex dnaEnumParameters(TestEnum1 val1, TestEnum2 val2)
{
//return val.HasValue ? val.Value : TestEnum.Zero;
double r = 0;
if (val1 == TestEnum1.Negative)
r = -1;
else if (val1 == TestEnum1.Positive)
r = +1;
double c = 0;
if (val2 == TestEnum2.Imaginary)
c = 1;
return new Complex(r, c);
}
[ExcelFunction]
public static Complex dnaNullableEnum(TestEnum1? val1, TestEnum2? val2)
{
//return val.HasValue ? val.Value : TestEnum.Zero;
double r = 0;
if (val1.HasValue && val1 == TestEnum1.Negative)
r = -1;
else if (val1 == TestEnum1.Positive)
r = +1;
double c = 0;
if (val2.HasValue && val2 == TestEnum2.Imaginary)
c = 1;
return new Complex(r, c);
}
[ExcelFunction]
public static Complex dnaComplex(Complex c)
{
//return val.HasValue ? val.Value : TestEnum.Zero;
return c;
}
[ExcelFunction]
public static Complex dnaNullableComplex(Complex? c)
{
//return val.HasValue ? val.Value : TestEnum.Zero;
return c ?? new Complex(111,222);
}
[ExcelMapArrayFunction]
public static IEnumerable<TestEnum1> dnaEnumsEnumerated(IEnumerable<TestEnum2> v)
{
foreach(var i in v)
{
switch (i)
{
case TestEnum2.Imaginary:
yield return TestEnum1.Negative;
break;
case TestEnum2.Real:
yield return TestEnum1.Positive;
break;
}
}
}
}
// Here I test some custom conversions, including a two-hop conversion
public class TestType1
{
public string Value;
public TestType1(string value)
{
Value = value;
}
public override string ToString()
{
return "From Type 1 with " + Value;
}
[ExcelFunction]
public static string dnaTestFunction1(TestType1 tt)
{
return "The Test (1) value is " + tt.Value;
}
}
public class TestType2
{
readonly TestType1 _value;
public TestType2(TestType1 value)
{
_value = value;
}
// Must be converted using TestType1 => TestType2, then string => TestType1
[ExcelFunction]
public static string dnaTestFunction2(TestType2 tt)
{
return "The Test (2) value is " + tt._value.Value;
}
[ExcelFunction]
public static TestType1 dnaTestFunction2Ret1(TestType2 tt)
{
return new TestType1("The Test (2) value is " + tt._value.Value);
}
[ExcelFunction]
public static string dnaJoinStrings(string separator, string[] values)
{
return string.Join(separator, values);
}
}
public class ReturnTests
{
//[ExcelFunction]
//public static object GetErrorNA()
//{
// return ExcelError.ExcelErrorNA;
//}
[ExcelFunction]
public static System.Threading.Tasks.Task<string> GetErrorNA(string s1)
{
return System.Threading.Tasks.Task.FromResult(s1);
}
}
}