API/CodeSamples/HelpText.md
... ...
@@ -0,0 +1,66 @@
1
+#HelpText
2
+
3
+[[_TOC_]]
4
+
5
+##About
6
+
7
+Gets or sets the collection of key-value pairs where the key is the tab name and the value is a hint that will be shown when mouse is over the appropriate tab.
8
+Can be seen in the ReportDesigner if ShowSideHelp is enabled.
9
+
10
+Note: You can also enable/disable side help by clicking Help button (AdHocSettings.ShowHelpButton should be enabled).
11
+
12
+##Global.asax (C♯)
13
+
14
+```csharp
15
+ public class CustomAdHocConfig : Izenda.AdHoc.DatabaseAdHocConfig
16
+ {
17
+ // Configure settings
18
+ // Add Custom Setting below license key and connection string setting
19
+ public override void ConfigureSettings()
20
+ {
21
+ AdHocSettings.SqlServerConnectionString = "INSERT_CONNECTION_STRING_HERE";
22
+ //AdHocSettings.VisibleTables = new string[] { "VIEW1", "TABLE2" };
23
+ Izenda.AdHoc.AdHocSettings.HelpText["Fields"] = "Some help for fields"; //The relevant setting
24
+ }
25
+
26
+ // Control what reports are visible for the current user
27
+ public override Izenda.AdHoc.ReportInfo[] ListReports()
28
+ {
29
+ return base.ListReports();
30
+ }
31
+
32
+ // Customize a report on the fly prior to execution on a per user basis
33
+ public override void PreExecuteReportSet(Izenda.AdHoc.ReportSet reportSet)
34
+ {
35
+
36
+ }
37
+
38
+ }
39
+```
40
+
41
+##VisualBasic
42
+
43
+```visualbasic
44
+Public Class CustomAdHocConfig
45
+ Inherits Izenda.AdHoc.DatabaseAdHocConfig
46
+
47
+ ' Configure settings
48
+ ' Add Custom Setting below license key and connection string setting
49
+ Public Overrides Sub ConfigureSettings()
50
+ AdHocSettings.SqlServerConnectionString = "INSERT_CONNECTION_STRING_HERE"
51
+ 'AdHocSettings.VisibleTables = New String() { "VIEW1", "TABLE2" }
52
+ Izenda.AdHoc.AdHocSettings.HelpText("Fields") = "Some help for fields" ' The relevant setting
53
+ End Sub
54
+
55
+ ' Control what reports are visible for the current user
56
+ Public Overrides Function ListReports() As Izenda.AdHoc.ReportInfo()
57
+ Return MyBase.ListReports
58
+ End Function
59
+
60
+ ' Customize a report on the fly prior to execution on a per user basis
61
+ Public Overrides Sub PreExecuteReportSet(ByVal reportSet As Izenda.AdHoc.ReportSet)
62
+
63
+ End Sub
64
+
65
+ End Class
66
+```
... ...
\ No newline at end of file