Windward Studios API Reference
Parameters Property
See Also  Send comments on this topic.
net.windward.api.csharp Namespace > Report Class : Parameters Property




Glossary Item Box

Adds a map that is used for ${variable} substitution. The key values cannot have any of the characters ${} in them. When ${key} is found in any tag, it is replaced with the matching value. The key and value are not evaluated in any way, it is just a text substitution. This replace occurs before any other evaluation of a tag so the value can have ${variable} values that will then be evaluated. This call sets the map so calling it a second time replaces the map passed in the first time. The map is copied so on return changes to the passed in map will not affect the data source. You can pass in either DateTime or DateTime objects on the set call. However, when you call get, they will all be DateTimeOffset objects (the engine converts att DaleTime objects to DateTimeOffset).

Syntax

Visual Basic (Declaration) 
Public Property Parameters As IDictionary(Of String,Object)
Visual Basic (Usage)Copy Code
Dim instance As Report
Dim value As IDictionary(Of String,Object)
 
instance.Parameters = value
 
value = instance.Parameters
C# 
public IDictionary<string,object> Parameters {get; set;}
Managed Extensions for C++ 
public: __property IDictionary<string*,Object*>* get_Parameters();
public: __property void set_Parameters( 
   IDictionary<string*,Object*>* value
);
C++/CLI 
public:
property IDictionary<String^,Object^>^ Parameters {
   IDictionary<String^,Object^>^ get();
   void set (    IDictionary<String^,Object^>^ value);
}

Requirements

Platforms: Windows 10, Windows NT, Windows Server

See Also

Windward Studios - .NET Document Generation software