2025-02-19 15:50:20.3672|DEBUG|OnDoc| 2025-02-19 15:50:20.3672|DEBUG|OnDoc| 2025-02-19 15:50:21.8605|DEBUG|OnDoc|Ende GetDocument DokumentID:OFFEDK0082025002489614 +2025-02-21 09:47:06.5367|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:1234234 +2025-02-21 09:47:06.5900|DEBUG|OnDoc| +2025-02-21 09:47:06.5990|DEBUG|OnDoc| +2025-02-21 09:47:06.6575|ERROR|OnDoc|An der Position 0 befindet sich keine Zeile. +2025-02-21 10:15:06.0987|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002490021 +2025-02-21 10:15:07.3428|DEBUG|OnDoc| +2025-02-21 10:15:07.3837|ERROR|OnDoc|Ungültiger Spaltenname "erstellunginoffice". +2025-02-21 10:15:19.4539|ERROR|OnDoc|Die Tabelle 0 kann nicht gefunden werden. +2025-02-21 10:18:08.1065|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002490021 +2025-02-21 10:18:10.6928|DEBUG|OnDoc| +2025-02-21 10:18:10.6928|DEBUG|OnDoc| +2025-02-21 10:18:19.1993|DEBUG|OnDoc| +2025-02-21 10:18:19.2360|DEBUG|OnDoc| +2025-02-21 10:18:23.5497|DEBUG|OnDoc|Start ArchivDocFromIRIS DokumentID: OFFEDK0082025002490021 +2025-02-21 10:18:28.1930|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002490021 +2025-02-21 10:18:29.2192|DEBUG|OnDoc| +2025-02-21 10:18:29.2286|DEBUG|OnDoc| +2025-02-21 10:18:34.4191|DEBUG|OnDoc| +2025-02-21 10:18:34.4554|DEBUG|OnDoc| +2025-02-21 10:18:37.1760|DEBUG|OnDoc|Start ArchivDocFromIRIS DokumentID: OFFEDK0082025002490021 +2025-02-21 10:18:47.3054|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002490021 +2025-02-21 10:18:49.3299|DEBUG|OnDoc| +2025-02-21 10:18:49.3395|DEBUG|OnDoc| +2025-02-21 10:18:52.1279|DEBUG|OnDoc| +2025-02-21 10:18:52.1369|DEBUG|OnDoc| +2025-02-21 10:18:53.8270|DEBUG|OnDoc|Start ArchivDocFromIRIS DokumentID: OFFEDK0082025002490021 +2025-02-21 10:19:04.0222|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002490021 +2025-02-21 10:19:04.6409|DEBUG|OnDoc| +2025-02-21 10:19:04.6500|DEBUG|OnDoc| +2025-02-21 10:19:05.7059|DEBUG|OnDoc| +2025-02-21 10:19:05.7157|DEBUG|OnDoc| +2025-02-21 10:27:01.6372|DEBUG|OnDoc|Start ArchiveDocFromDatabase: DokumentID:OFFEDK0082025002490021 +2025-02-21 10:27:02.6617|DEBUG|OnDoc| +2025-02-21 10:27:02.6617|DEBUG|OnDoc| +2025-02-21 10:27:05.6965|DEBUG|OnDoc| +2025-02-21 10:27:05.6965|DEBUG|OnDoc| +2025-02-21 10:27:08.4111|ERROR|OnDoc|OFFEDK0082025002490021 ErstellungInOffec - EDKB02DMS +2025-02-21 10:27:15.8300|DEBUG|OnDoc| +2025-02-21 10:27:15.8923|DEBUG|OnDoc| +2025-02-21 10:27:41.1719|INFO|OnDoc|Dokumentarchivierung via EDKB02_DMS ausgelöstOFFEDK0082025002490021 diff --git a/API_NetFramework/obj/Debug/API_NetFramework.csproj.AssemblyReference.cache b/API_NetFramework/obj/Debug/API_NetFramework.csproj.AssemblyReference.cache index c057552f..9caf32c0 100644 Binary files a/API_NetFramework/obj/Debug/API_NetFramework.csproj.AssemblyReference.cache and b/API_NetFramework/obj/Debug/API_NetFramework.csproj.AssemblyReference.cache differ diff --git a/API_NetFramework/obj/Debug/API_NetFramework.csproj.CoreCompileInputs.cache b/API_NetFramework/obj/Debug/API_NetFramework.csproj.CoreCompileInputs.cache index af19d725..755c0936 100644 --- a/API_NetFramework/obj/Debug/API_NetFramework.csproj.CoreCompileInputs.cache +++ b/API_NetFramework/obj/Debug/API_NetFramework.csproj.CoreCompileInputs.cache @@ -1 +1 @@ -1d5e7777976b1fcf427b978fd296839fb79b70f6485f6c476d89469696b7e7f2 +7f8c9856cb98bb8499b1ef573fed1bb3d0f9d701201fd94c6f47441aba795d03 diff --git a/API_NetFramework/obj/Debug/API_NetFramework.csproj.FileListAbsolute.txt b/API_NetFramework/obj/Debug/API_NetFramework.csproj.FileListAbsolute.txt index d698e60a..0d492795 100644 --- a/API_NetFramework/obj/Debug/API_NetFramework.csproj.FileListAbsolute.txt +++ b/API_NetFramework/obj/Debug/API_NetFramework.csproj.FileListAbsolute.txt @@ -313,3 +313,5 @@ E:\Software-Projekte\OnDoc\OnDoc\API_NetFramework\bin\Syncfusion.OfficeChart.Bas E:\Software-Projekte\OnDoc\OnDoc\API_NetFramework\bin\VBOffice.dll E:\Software-Projekte\OnDoc\OnDoc\API_NetFramework\bin\VBOffice.pdb E:\Software-Projekte\OnDoc\OnDoc\API_NetFramework\bin\VBOffice.xml +E:\Software-Projekte\OnDoc\OnDoc\API_NetFramework\bin\OfficeToPDFConverter.dll +E:\Software-Projekte\OnDoc\OnDoc\API_NetFramework\bin\OfficeToPDFConverter.pdb diff --git a/API_NetFramework/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/API_NetFramework/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache index a442d668..176638d1 100644 Binary files a/API_NetFramework/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache and b/API_NetFramework/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache differ diff --git a/API_NetFramework/obj/Debug/OnDoc_NetFramework.dll b/API_NetFramework/obj/Debug/OnDoc_NetFramework.dll index 04026895..3ca1ad4b 100644 Binary files a/API_NetFramework/obj/Debug/OnDoc_NetFramework.dll and b/API_NetFramework/obj/Debug/OnDoc_NetFramework.dll differ diff --git a/API_NetFramework/obj/Debug/OnDoc_NetFramework.pdb b/API_NetFramework/obj/Debug/OnDoc_NetFramework.pdb index 931e3c8f..d34e6a3f 100644 Binary files a/API_NetFramework/obj/Debug/OnDoc_NetFramework.pdb and b/API_NetFramework/obj/Debug/OnDoc_NetFramework.pdb differ diff --git a/API_NetFramework/obj/Debug/Package/PackageTmp/Web.config b/API_NetFramework/obj/Debug/Package/PackageTmp/Web.config index bb6803b1..35a70a63 100644 --- a/API_NetFramework/obj/Debug/Package/PackageTmp/Web.config +++ b/API_NetFramework/obj/Debug/Package/PackageTmp/Web.config @@ -32,6 +32,8 @@
-
+
-
+
Working with prepared pages after the report is finished: load + ( +) or save ( ) pages + from/to a .fpx file, get a page with specified index to work with its objects + ( ); modify specified page ( ). +
+ -
+
Using the +, , + methods while report is generating to produce an output. +
+
+ report1.Preview = previewControl1;
+ report1.Show();
+
+ -
+
-
+
To load a report, use the ++ method or call static method.
+ -
+
To save a report, call the +method.
+ -
+
To register application dataset for use it in a report, call one of the + RegisterData methods. +
+ -
+
To pass some parameter to a report, use the + +method.
+ -
+
To design a report, call the +method.
+ -
+
To run a report and preview it, call the +method. + Another way is to call the method, then call the + method.
+ -
+
To run a report and print it, call the +method. + Another way is to call the method, then call the + method.
+ -
+
To load/save prepared report, use one of the LoadPrepared and + SavePrepared methods. +
+ -
+
To set up some global properties, use the +static class + or component that you can use in the Visual Studio IDE. +
+
+ Report report = new Report();
+ report.Load("reportfile.frx");
+ report.RegisterData(application_dataset);
+ report.Show();
+
+
+ Report report = new Report();
+ // create the report page
+ ReportPage page = new ReportPage();
+ page.Name = "ReportPage1";
+ // set paper width and height. Note: these properties are measured in millimeters.
+ page.PaperWidth = 210;
+ page.PaperHeight = 297;
+ // add a page to the report
+ report.Pages.Add(page);
+ // create report title
+ page.ReportTitle = new ReportTitleBand();
+ page.ReportTitle.Name = "ReportTitle1";
+ page.ReportTitle.Height = Units.Millimeters * 10;
+ // create Text object and put it to the title
+ TextObject text = new TextObject();
+ text.Name = "Text1";
+ text.Bounds = new RectangleF(0, 0, Units.Millimeters * 100, Units.Millimeters * 5);
+ page.ReportTitle.Objects.Add(text);
+ // create data band
+ DataBand data = new DataBand();
+ data.Name = "Data1";
+ data.Height = Units.Millimeters * 10;
+ // add data band to a page
+ page.Bands.Add(data);
+
+
+ if (report.Prepare())
+ {
+ PrinterSettings printerSettings = null;
+ if (report.ShowPrintDialog(out printerSettings))
+ {
+ report.PrintPrepared(printerSettings);
+ }
+ }
+
+
+ if (report.Prepare())
+ {
+ PrinterSettings printerSettings = null;
+ if (report.ShowPrintDialog(out printerSettings))
+ {
+ report.PrintPrepared(printerSettings);
+ }
+ }
+
+
+ ReportPage page1 = report1.Pages[0] as ReportPage;
+
+
+ using System.Security;
+ using System.Security.Permissions;
+ ...
+ PermissionSet ps = new PermissionSet(PermissionState.None);
+ ps.AddPermission(new FileIOPermission(PermissionState.Unrestricted));
+ report1.ScriptRestrictions = ps;
+ report1.Prepare();
+
+
+ SimpleListReport report = new SimpleListReport();
+ report.RegisterData(your_dataset);
+ report.Show();
+
+
+ string employeeName = (string)report.GetColumnValue("Employees.FirstName");
+
+
+ // load the report
+ report1.Load("report.frx");
+ // setup the parameter
+ report1.SetParameterValue("MyParam", 10);
+ // show the report
+ report1.Show();
+
+ report.AddReferencedAssembly("Newtonsoft.Json.dll")
+
+ report1.Load("report.frx");
+ report1.RegisterData(dataSet1);
+
+
+ report1.Load("report.frx");
+ report1.RegisterData(dataSet1, true);
+
+
+ report1.Load("report.frx");
+ report1.RegisterData(dataSet1, "NorthWind");
+
+
+ report1.Load("report.frx");
+ report1.RegisterData(dataSet1, "NorthWind", true);
+
+
+ report1.Load("report.frx");
+ report1.RegisterData(dataSet1.Tables["Orders"], "Orders");
+
+
+ report1.Load("report.frx");
+ report1.RegisterData(myDataView, "OrdersView");
+
+
+ report1.Load("report.frx");
+ report1.RegisterData(myDataRelation, "myRelation");
+
+
+ report1.Load("report.frx");
+ report1.RegisterData(myBusinessObject, "Customers");
+
+
+ report1.Load("report.frx");
+ report1.RegisterData(myCubeLink, "Orders");
+
+
+ Report report = new Report();
+ report.Load("report1.frx");
+ report.Prepare();
+ report.Load("report2.frx");
+ report.Prepare(true);
+ report.ShowPrepared();
+
+ -
+
-
+
To select the type of barcode, use the +property. +
+ -
+
To specify a static barcode data, use the +property. + You also may use the or properties + to specify dynamic value for a barcode. +
+ -
+
To set a barcode orientation, use the +property. +
+ -
+
To specify the size of barcode, set the +property + to true and use the property to zoom the barcode. + If property is set to false, you need to specify the + size using the Width and +Height properties. +
+
+ BarcodeObject barcode;
+ ...
+ barcode.Barcode = new BarcodePDF417();
+ (barcode.Barcode as BarcodePDF417).CompactionMode = CompactionMode.Text;
+
+ -
+
"2/5 Interleaved"
+ "2/5 Industrial"
+ "2/5 Matrix"
+ "Codabar"
+ "Code128"
+ "Code39"
+ "Code39 Extended"
+ "Code93"
+ "Code93 Extended"
+ "EAN8"
+ "EAN13"
+ "MSI"
+ "PostNet"
+ "UPC-A"
+ "UPC-E0"
+ "UPC-E1"
+ "Supplement 2"
+ "Supplement 5"
+ "PDF417"
+ "Datamatrix"
+ "QRCode"
+
+ barcode.SymbologyName = "PDF417";
+ (barcode.Barcode as BarcodePDF417).CompactionMode = CompactionMode.Text;
+
+ Represents a 2D matrix of bits. In function arguments below, and throughout the common + module, x is the column position, and y is the row position. The ordering is always x, y. + The origin is at the top-left.
+Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins + with a new int. This is done intentionally so that we can copy out a row into a BitArray very + efficiently.
+The ordering of bits is row-major. Within each int, the least significant bits are used first, + meaning they represent lower x values. This is compatible with BitArray's implementation.
+Gets the requested bit, where true means black.
+ +Flips the given bit.
+ +Sets a square region of the bit matrix to true.
+ +This class contains utility methods for performing mathematical operations over + the Galois Fields. Operations use a given primitive polynomial in calculations.
+Throughout this package, elements of the GF are represented as an {@code int} + for convenience and speed (but at the cost of memory). +
+Represents a polynomial whose coefficients are elements of a GF. + Instances of this class are immutable.
+Much credit is due to William Rucklidge since portions of this code are an indirect + port of his C++ Reed-Solomon implementation.
+
+ BarcodeObject barcode;
+ ...
+ barcode.Barcode = new Barcode128();
+ (barcode.Barcode as Barcode128).AutoEncode = false;
+
+ -
+
-
+
&A; +START A / CODE A +
+ -
+
&B; +START B / CODE B +
+ -
+
&C; +START C / CODE C +
+
+ BarcodeObject barcode;
+ barcode.Barcode = new Barcode128();
+ (barcode.Barcode as Barcode128).AutoEncode = false;
+ barcode.Text = "&C;1234&A;ABC";
+
+ 1.
+
+ @return the position of this MaxiCode symbol in a series of symbols using structured append
+ 1.
+
+ @return size of the series that this symbol is part of
+ | Characters | Meaning |
|---|---|
| 1-9 | Postal code data which can consist of up to 9 digits (for mode 2) or up to 6 + alphanumeric characters (for mode 3). Remaining unused characters should be + filled with the SPACE character (ASCII 32). |
| 10-12 | Three-digit country code according to ISO-3166. |
| 13-15 | Three digit service code. This depends on your parcel courier. |
+ BarcodeObject barcode;
+ ...
+ barcode.Barcode = new BarcodePDF417();
+ (barcode.Barcode as BarcodePDF417).CompactionMode = PDF417CompactionMode.Text;
+
+ Config.PreviewSettings.Exports &= ~PreviewExports.PDFExport;
+ Doing so before state is restored may not take an effect.
+
+ // register own wizard
+ RegisteredObjects.AddWizard(typeof(MyWizard), myWizBmp, "My Wizard", true);
+ // register own export filter
+ RegisteredObjects.AddExport(typeof(MyExport), "My Export");
+ // register own report object
+ RegisteredObjects.Add(typeof(MyObject), "ReportPage", myObjBmp, "My Object");
+
+
+ // register own cloud storage client
+ RegisteredObjects.AddCloud(typeof(MyCloud), "My Cloud");
+
+
+ // register own messenger
+ RegisteredObjects.AddMessenger(typeof(MyMessenger), "My Messenger");
+
+
+ // register own wizard
+ RegisteredObjects.AddWizard(typeof(MyWizard), myWizBmp, "My Wizard", true);
+
+
+ // register data connection
+ RegisteredObjects.AddConnection(typeof(MyDataConnection), "My Data Connection");
+
+
+ // register the report object
+ RegisteredObjects.Add(typeof(MyReportObject), "ReportPage", myReportObjectBmp, "My Report Object");
+ // register the dialog control
+ RegisteredObjects.Add(typeof(MyDialogControl), "DialogPage", myDialogControlBmp, "My Dialog Control");
+ // add a category and register an object inside it
+ RegisteredObjects.AddCategory("ReportPage,MyCategory", myCategoryBmp, "My Category");
+ // register another report object in MyCategory
+ RegisteredObjects.Add(typeof(MyReportObject), "ReportPage,MyCategory",
+ anotherReportObjectBmp, "Another Report Object");
+
+ -
+
-
+
"Math" +
+ -
+
"Text" +
+ -
+
"DateTime" +
+ -
+
"Formatting" +
+ -
+
"Conversion" +
+ -
+
"ProgramFlow" +
+
+ RegisteredObjects.AddFunctionCategory("MyFuncs", "My Functions");
+
+ -
+
-
+
"Math" +
+ -
+
"Text" +
+ -
+
"DateTime" +
+ -
+
"Formatting" +
+ -
+
"Conversion" +
+ -
+
"ProgramFlow" +
+
+ public static class MyFunctions
+ {
+ /// <summary>
+ /// Converts a specified string to uppercase.
+ /// </summary>
+ /// <param name="s">The string to convert.</param>
+ /// <returns>A string in uppercase.</returns>
+ public static string MyUpperCase(string s)
+ {
+ return s == null ? "" : s.ToUpper();
+ }
+
+ /// <summary>
+ /// Returns the larger of two 32-bit signed integers.
+ /// </summary>
+ /// <param name="val1">The first of two values to compare.</param>
+ /// <param name="val2">The second of two values to compare.</param>
+ /// <returns>Parameter val1 or val2, whichever is larger.</returns>
+ public static int MyMaximum(int val1, int val2)
+ {
+ return Math.Max(val1, val2);
+ }
+
+ /// <summary>
+ /// Returns the larger of two 64-bit signed integers.
+ /// </summary>
+ /// <param name="val1">The first of two values to compare.</param>
+ /// <param name="val2">The second of two values to compare.</param>
+ /// <returns>Parameter val1 or val2, whichever is larger.</returns>
+ public static long MyMaximum(long val1, long val2)
+ {
+ return Math.Max(val1, val2);
+ }
+ }
+
+ // register a category
+ RegisteredObjects.AddFunctionCategory("MyFuncs", "My Functions");
+
+ // obtain MethodInfo for our functions
+ Type myType = typeof(MyFunctions);
+ MethodInfo myUpperCaseFunc = myType.GetMethod("MyUpperCase");
+ MethodInfo myMaximumIntFunc = myType.GetMethod("MyMaximum", new Type[] { typeof(int), typeof(int) });
+ MethodInfo myMaximumLongFunc = myType.GetMethod("MyMaximum", new Type[] { typeof(long), typeof(long) });
+
+ // register simple function
+ RegisteredObjects.AddFunction(myUpperCaseFunc, "MyFuncs");
+
+ // register overridden functions
+ RegisteredObjects.AddFunction(myMaximumIntFunc, "MyFuncs,MyMaximum");
+ RegisteredObjects.AddFunction(myMaximumLongFunc, "MyFuncs,MyMaximum");
+
+
+ <Objects>
+ <Report Text="Report"/>
+ <Bands Text="Bands">
+ <ReportTitle Text="Report Title"/>
+ </Bands>
+ </Objects>
+
+ To get the localized "ReportTitle" value, you should pass the following ID
+ to this method: "Objects,Bands,ReportTitle".
+
+ Res.Set("Messages,SaveChanges", "My text that will appear when you close the designer");
+
+
+ <?xml version="1.0" encoding="utf-8"?>
+ <Config>
+ <Plugins>
+ <Plugin Name="c:\Program Files\MyProgram\MyPlugin.dll"/>
+ </Plugins>
+ </Config>
+
+ When you run your application and use the Report object first time, all plugins will be loaded.
+ To register objects contained in a plugin, FastReport searches for classes of type
+ AssemblyInitializerBase and instantiates them.
+
+ public class MyAssemblyInitializer : AssemblyInitializerBase
+ {
+ public MyAssemblyInitializer()
+ {
+ // register own wizard
+ RegisteredObjects.AddWizard(typeof(MyWizard), myWizBmp, "My Wizard", true);
+ // register own export filter
+ RegisteredObjects.AddExport(typeof(MyExport), "My Export");
+ // register own report object
+ RegisteredObjects.Add(typeof(MyObject), "ReportPage", myObjBmp, "My Object");
+ }
+ }
+
+ + Then the resulting array of patterns is converted to the
+ If the pattern is empty or not specified, + the method sets the style of the dotted line of the
+ FastNameCreator nameCreator = new FastNameCreator(Report.AllObjects);
+ foreach (Base c in Report.AllObjects)
+ {
+ if (c.Name == "")
+ nameCreator.CreateUniqueName(c);
+ }
+
+
+ public void Deserialize(FRReader reader)
+ {
+ // read simple properties like "Text", complex properties like "Border.Lines"
+ reader.ReadProperties(this);
+
+ // moves the current reader item
+ while (reader.NextItem())
+ {
+ // read the "Styles" collection
+ if (String.Compare(reader.ItemName, "Styles", true) == 0)
+ reader.Read(Styles);
+ else if (reader.ReadChildren)
+ {
+ // if read of children is enabled, read them
+ Base obj = reader.Read();
+ if (obj != null)
+ obj.Parent = this;
+ }
+ }
+ }
+
+
+ public void Deserialize(FRReader reader)
+ {
+ // read simple properties like "Text", complex properties like "Border.Lines"
+ reader.ReadProperties(this);
+
+ // moves the current reader item
+ while (reader.NextItem())
+ {
+ // read the "Styles" collection
+ if (String.Compare(reader.ItemName, "Styles", true) == 0)
+ reader.Read(Styles);
+ else if (reader.ReadChildren)
+ {
+ // if read of children is enabled, read them
+ Base obj = reader.Read();
+ if (obj != null)
+ obj.Parent = this;
+ }
+ }
+ }
+
+
+ public void Deserialize(FRReader reader)
+ {
+ // read simple properties like "Text", complex properties like "Border.Lines"
+ reader.ReadProperties(this);
+
+ // moves the current reader item
+ while (reader.NextItem())
+ {
+ // read the "Styles" collection
+ if (String.Compare(reader.ItemName, "Styles", true) == 0)
+ reader.Read(Styles);
+ else if (reader.ReadChildren)
+ {
+ // if read of children is enabled, read them
+ Base obj = reader.Read();
+ if (obj != null)
+ obj.Parent = this;
+ }
+ }
+ }
+
+
+ public void Deserialize(FRReader reader)
+ {
+ // read simple properties like "Text", complex properties like "Border.Lines"
+ reader.ReadProperties(this);
+
+ // moves the current reader item
+ while (reader.NextItem())
+ {
+ // read the "Styles" collection
+ if (String.Compare(reader.ItemName, "Styles", true) == 0)
+ reader.Read(Styles);
+ else if (reader.ReadChildren)
+ {
+ // if read of children is enabled, read them
+ Base obj = reader.Read();
+ if (obj != null)
+ obj.Parent = this;
+ }
+ }
+ }
+
+
+ public void Serialize(FRWriter writer)
+ {
+ // get the etalon object. It will be used to write changed properties only.
+ Base c = writer.DiffObject as Base;
+
+ // write the type name
+ writer.ItemName = ClassName;
+
+ // write properties
+ if (Name != "")
+ writer.WriteStr("Name", Name);
+ if (Restrictions != c.Restrictions)
+ writer.WriteValue("Restrictions", Restrictions);
+
+ // write child objects if allowed
+ if (writer.SaveChildren)
+ {
+ foreach (Base child in ChildObjects)
+ {
+ writer.Write(child);
+ }
+ }
+ }
+
+
+ // using the Res.Get method
+ miKeepTogether = new ToolStripMenuItem(Res.Get("ComponentMenu,HeaderBand,KeepTogether"));
+ miResetPageNumber = new ToolStripMenuItem(Res.Get("ComponentMenu,HeaderBand,ResetPageNumber"));
+ miRepeatOnEveryPage = new ToolStripMenuItem(Res.Get("ComponentMenu,HeaderBand,RepeatOnEveryPage"));
+
+ // using MyRes.Get method
+ MyRes res = new MyRes("ComponentMenu,HeaderBand");
+ miKeepTogether = new ToolStripMenuItem(res.Get("KeepTogether"));
+ miResetPageNumber = new ToolStripMenuItem(res.Get("ResetPageNumber"));
+ miRepeatOnEveryPage = new ToolStripMenuItem(res.Get("RepeatOnEveryPage"));
+
+
+
+ foreach (AdvancedTextRenderer.Paragraph paragraph in renderer.Paragraphs)
+ {
+ foreach (AdvancedTextRenderer.Line line in paragraph.Lines)
+ {
+ foreach (AdvancedTextRenderer.Word word in line.Words)
+ {
+ if (renderer.HtmlTags)
+ {
+ foreach (AdvancedTextRenderer.Run run in word.Runs)
+ {
+ using (Font f = run.GetFont())
+ using (Brush b = run.GetBrush())
+ {
+ g.DrawString(run.Text, f, b, run.Left, run.Top, renderer.Format);
+ }
+ }
+ }
+ else
+ {
+ g.DrawString(word.Text, renderer.Font, renderer.Brush, word.Left, word.Top, renderer.Format);
+ }
+ }
+ }
+ }
+
+ valueInMillimeters = valueInPixels / Units.Millimeters;
+ To convert millimeters to pixels, use the following code:
+ valueInPixels = valueInMillimeters * Units.Millimeters;
+ + You need only refresh token (
+ This method is used to save time for starting a designer. +
+ Designer designer = new Designer();
+ designer.Parent = form1;
+ designer.Report = report1;
+
+
+ DesignerControl designer = new DesignerControl();
+ designer.MdiMode = true;
+ designer.ShowDialog();
+
+
+ // add an event handler that will be fired when the designer is run
+ Config.DesignerSettings.DesignerLoaded += new EventHandler(DesignerSettings_DesignerLoaded);
+
+ void DesignerSettings_DesignerLoaded(object sender, EventArgs e)
+ {
+ // override "New..." command behavior
+ (sender as Designer).cmdNew.CustomAction += new EventHandler(cmdNew_CustomAction);
+ }
+
+ void cmdNew_CustomAction(object sender, EventArgs e)
+ {
+ // show the "Label" wizard instead of standard "Add New Item" dialog
+ Designer designer = sender as Designer;
+ LabelWizard wizard = new LabelWizard();
+ wizard.Run(designer);
+ }
+
+
+ Config.DesignerSettings.DesignerLoaded += new EventHandler(DesignerSettings_DesignerLoaded);
+
+ void DesignerSettings_DesignerLoaded(object sender, EventArgs e)
+ {
+ (sender as DesignerControl).MainMenu.miFileSelectLanguage.Visible = false;
+ }
+
+
+ Config.DesignerSettings.PageAdded += new EventHandler(DesignerSettings_PageAdded);
+
+ void DesignerSettings_PageAdded(object sender, EventArgs e)
+ {
+ if (sender is ReportPage)
+ (sender as ReportPage).TopMargin = 0;
+ }
+
+
+ private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (OpenFileDialog dialog = new OpenFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (SaveFileDialog dialog = new SaveFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+ // get default file name from e.FileName
+ dialog.FileName = e.FileName;
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // load the report from the given e.FileName
+ e.Report.Load(e.FileName);
+ }
+
+ private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // save the report to the given e.FileName
+ e.Report.Save(e.FileName);
+ }
+
+
+ private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (OpenFileDialog dialog = new OpenFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (SaveFileDialog dialog = new SaveFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+ // get default file name from e.FileName
+ dialog.FileName = e.FileName;
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // load the report from the given e.FileName
+ e.Report.Load(e.FileName);
+ }
+
+ private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // save the report to the given e.FileName
+ e.Report.Save(e.FileName);
+ }
+
+
+ private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (OpenFileDialog dialog = new OpenFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (SaveFileDialog dialog = new SaveFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+ // get default file name from e.FileName
+ dialog.FileName = e.FileName;
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // load the report from the given e.FileName
+ e.Report.Load(e.FileName);
+ }
+
+ private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // save the report to the given e.FileName
+ e.Report.Save(e.FileName);
+ }
+
+
+ private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (OpenFileDialog dialog = new OpenFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (SaveFileDialog dialog = new SaveFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+ // get default file name from e.FileName
+ dialog.FileName = e.FileName;
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // load the report from the given e.FileName
+ e.Report.Load(e.FileName);
+ }
+
+ private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // save the report to the given e.FileName
+ e.Report.Save(e.FileName);
+ }
+
+
+ Config.DesignerSettings.CustomPreviewReport += new EventHandler(MyPreviewHandler);
+
+ private void MyPreviewHandler(object sender, EventArgs e)
+ {
+ Report report = sender as Report;
+ using (MyPreviewForm form = new MyPreviewForm())
+ {
+ report.Preview = form.previewControl1;
+ report.ShowPreparedReport();
+ form.ShowDialog();
+ }
+ }
+
+
+ Config.DesignerSettings.FilterConnectionTables += DesignerSettings_FilterConnectionTables;
+
+ private void DesignerSettings_FilterConnectionTables(object sender, FilterConnectionTablesEventArgs e)
+ {
+ if (e.TableName == "Table 1")
+ e.Skip = true;
+ }
+
+
+ Config.DesignerSettings.AddCustomConnection(typeof(MsAccessDataConnection), @"Data Source=c:\data.mdb");
+
+
+ public void SaveState()
+ {
+ XmlItem xi = Config.Root.FindItem("Designer").FindItem(Name);
+ xi.SetProp("ShowGrid", DialogWorkspace.ShowGrid ? "1" : "0");
+ }
+
+
+ public void RestoreState()
+ {
+ XmlItem xi = Config.Root.FindItem("Designer").FindItem(Name);
+ DialogWorkspace.ShowGrid = xi.GetProp("ShowGrid") != "0";
+ }
+
+
+ DesignerPlugins.Add(typeof(MyToolbar));
+
+
+ MessagesWindow window = designer.Plugins.Find("MessagesWindow") as MessagesWindow;
+
+
+ MessagesWindow window = designer.Plugins.FindType("MessagesWindow") as MessagesWindow;
+
+
+ DesignerPlugins.Add(typeof(MyToolbar));
+
+
+ Designer designer;
+ MessagesWindow window = designer.Plugins.FindType("MessagesWindow") as MessagesWindow;
+
+ +
+ DesignerPlugins.Add(typeof(MyToolWindow));
+
+ -
+
-
+
create an instance of this class; +
+ -
+
set the Designer.Report property to report that you need to design; +
+ -
+
call either ShowModal or Show methods to display a form. +
+
+ Designer designer;
+ DesignerMenu menu = designer.Plugins.FindType("DesignerMenu") as DesignerMenu;
+
+ -
+
-
+
create an instance of the AdvMatrixObject and add it to the report; +
+ -
+
create descriptors for columns and rows and add it to the + root descriptor using the matrix.Data.Columns.Descriptor and matrix.Data.Rows.Descriptor respectively; +
+ -
+
call the +method to create the matrix template + that will be used to create a result;
+ -
+
set the data cells content; +
+ -
+
modify the matrix template (change captions, set the visual appearance). +
+
+ // create an instance of AdvMatrixObject
+ AdvMatrixObject matrix = new AdvMatrixObject();
+ matrix.Name = "Matrix1";
+ // add it to the report title band of the first report page
+ matrix.Parent = (Report.Pages[0] as ReportPage).ReportTitle;
+
+ // create two nested column descriptors and a total
+ HeaderDescriptor column = new HeaderDescriptor("[MatrixDemo.Year]");
+ matrix.Data.Columns.Descriptor.Add(column);
+ HeaderDescriptor nestedColumn = new HeaderDescriptor("[MatrixDemo.Month]");
+ column.Add(nestedColumn);
+ HeaderDescriptor columnTotal = new HeaderDescriptor();
+ columnTotal.DisplayText = "Total";
+ matrix.Data.Columns.Descriptor.Add(columnTotal);
+
+ // create one row descriptor and a total
+ HeaderDescriptor row = new HeaderDescriptor("[MatrixDemo.Name]");
+ matrix.Data.Rows.Descriptor.Add(row);
+ HeaderDescriptor rowTotal = new HeaderDescriptor();
+ rowTotal.DisplayText = "Total";
+ matrix.Data.Rows.Descriptor.Add(rowTotal);
+
+ // connect matrix to a datasource
+ matrix.DataSource = Report.GetDataSource("MatrixDemo");
+
+ // create the matrix template
+ matrix.BuildTemplate();
+
+ // change the style
+ matrix.Style = "Gray";
+
+ // create data cells
+ string cellText = "[Sum([MatrixDemo.Revenue])]";
+ for (int i = matrix.Data.Rows.Size; i < matrix.ColumnCount; i++)
+ for (int j = matrix.Data.Columns.Size; j < matrix.RowCount; j++)
+ matrix[i, j].Text = cellText;
+
+ -
+
-
+
select the cell that you need to highlight; +
+ -
+
click the "Highlight" button on the "Text" toolbar; +
+ -
+
add a new highlight condition. Use the Matrix.ColumnValues to + refer to the value you need to analyze. Note: these values are array of dynamic, + so you don't need to cast it to actual type before making any comparisons. Example of highlight + condition: +Matrix1.ColumnValues[0] == 2000 . +
+
-
+
-
+
select the cell that you need to highlight; +
+ -
+
click the "Highlight" button on the "Text" toolbar; +
+ -
+
add a new highlight condition. Use the Matrix.RowValues to + refer to the value you need to analyze. Note: these values are arrays of dynamic, + so you don't need to cast it to actual type before making any comparisons. Example of highlight + condition: +Matrix1.RowValues[0] == "Andrew Fuller" . +
+
-
+
-
+
select the cell that you need to highlight; +
+ -
+
click the "Highlight" button on the "Text" toolbar; +
+ -
+
add a new highlight condition that uses the Matrix.ColumnIndex, + for example: +Matrix1.ColumnIndex % 2 == 1 . +
+
-
+
-
+
select the cell that you need to highlight; +
+ -
+
click the "Highlight" button on the "Text" toolbar; +
+ -
+
add a new highlight condition that uses the Matrix.RowIndex, + for example: +Matrix1.RowIndex % 2 == 1 . +
+
+ EmailExport export = new EmailExport();
+ export.Account.Address = "my@address.net";
+ export.Account.Host = "myhost";
+ export.Address = "recipient@address.net";
+ export.Subject = "Re: analysis report";
+ // the report1 report must be prepared at this moment
+ export.SendEmail(report1);
+
+ TextExport.Encoding = Encoding.Default;
+ Unicode UTF-8 encoding
+ TextExport.Encoding = Encoding.UTF8;
+ OEM encoding for current system locale sessings
+ TextExport.Encoding = Encoding.GetEncoding(CultureInfo.CurrentCulture.TextInfo.OEMCodePage);
+
+ TextExportPrint.PrintStream("EPSON FX-1000", "My Report", 1, txtStream)
+ inches = pixels / SizeUnitsP.Inch;
+ To convert inches to pixels, use the code:
+ pixels = inches * SizeUnitsP.Inch;
+ inches = millimeters / SizeUnitsM.Inch;
+ To convert inches to millimeters, use the code:
+ millimeters = inches * SizeUnitsM.Inch;
+
+ Report report1;
+ XmlDataConnection conn = new XmlDataConnection();
+ conn.XmlFile = @"c:\data.xml";
+ report1.Dictionary.Connections.Add(conn);
+ conn.CreateAllTables();
+
+
+ Report report1;
+ DataConnectionBase conn = report1.Dictionary.Connections.FindByName("Connection1");
+ TableDataSource table = new TableDataSource();
+ table.TableName = "Employees";
+ table.Name = "Table1";
+ conn.Tables.Add(table);
+
+
+ TableDataSource ds = report.GetDataSource("My DataSource Name") as TableDataSource;
+ ds.Parameters[0].Value = 10;
+
+ This way is not good because you hardcode the report object's name.
+
+ Report report1;
+ DataSourceBase customersTable = report1.Dictionary.DataSources.FindByAlias("Customers");
+ DataSourceBase ordersTable = report1.Dictionary.DataSources.FindByAlias("Orders");
+ Relation rel = new Relation();
+ rel.Name = "customersOrders";
+ rel.ParentDataSource = customersTable;
+ rel.ChildDataSource = ordersTable;
+ rel.ParentColumns = new string[] { "CustomerID" };
+ rel.ChildColumns = new string[] { "CustomerID" };
+ report1.Dictionary.Relations.Add(rel);
+
+
+ Report report1;
+ OleDbDataConnection conn = new OleDbDataConnection();
+ conn.ConnectionString = "your_connection_string";
+ report1.Dictionary.Connections.Add(conn);
+ conn.CreateAllTables();
+
+
+ Report report1;
+ OdbcDataConnection conn = new OdbcDataConnection();
+ conn.ConnectionString = "your_connection_string";
+ report1.Dictionary.Connections.Add(conn);
+ conn.CreateAllTables();
+
+
+ Report report1;
+ MsSqlDataConnection conn = new MsSqlDataConnection();
+ conn.ConnectionString = "your_connection_string";
+ report1.Dictionary.Connections.Add(conn);
+ conn.CreateAllTables();
+
+
+ Report report1;
+ MsAccessDataConnection conn = new MsAccessDataConnection();
+ conn.DataSource = @"c:\data.mdb";
+ report1.Dictionary.Connections.Add(conn);
+ conn.CreateAllTables();
+
+
+ Report report1;
+ MsAccessDataConnection conn = new MsAccessDataConnection();
+ conn.DataSource = @"c:\data.mdb";
+ report1.Dictionary.Connections.Add(conn);
+ conn.CreateAllTables();
+
+
+ OleDbConnectionStringBuilder builder = new OleDbConnectionStringBuilder(oleDbConnection1.ConnectionString);
+ builder.PersistSecurityInfo = false;
+ oleDbConnection1.ConnectionString = builder.ToString();
+
+
+ public override Type GetConnectionType()
+ {
+ return typeof(OleDbConnection);
+ }
+
+
+ public override DbDataAdapter GetAdapter(string selectCommand, DbConnection connection,
+ CommandParameterCollection parameters)
+ {
+ OleDbDataAdapter adapter = new OleDbDataAdapter(selectCommand, connection as OleDbConnection);
+ foreach (CommandParameter p in parameters)
+ {
+ OleDbParameter parameter = adapter.SelectCommand.Parameters.Add(p.Name, (OleDbType)p.DataType, p.Size);
+ parameter.Value = p.Value;
+ }
+ return adapter;
+ }
+
+
+ Report report1;
+ CsvDataConnection conn = new CsvDataConnection();
+ conn.CsvFile = @"c:\data.csv";
+ report1.Dictionary.Connections.Add(conn);
+ conn.CreateAllTables();
+
+
+ dataSource.Init();
+ while (dataSource.HasMoreRows)
+ {
+ // do something...
+ dataSource.Next();
+ }
+
+
+ Report report1;
+ Parameter par = new Parameter();
+ par.Name = report1.Dictionary.CreateUniqueName("Parameter");
+ report1.Parameters.Add(par);
+
+
+ Report report1;
+ DataConnectionBase conn = report1.Dictionary.Connections.FindByName("Connection1");
+ TableDataSource table = new TableDataSource();
+ table.TableName = "Employees";
+ table.Name = report1.Dictionary.CreateUniqueName("EmployeesTable");
+ table.Alias = report1.Dictionary.CreateUniqueAlias("Employees");
+ conn.Tables.Add(table);
+
+
+ private void report1_DatabaseLogin(object sender, DatabaseLoginEventArgs e)
+ {
+ using (MyLoginDialog dialog = new MyLoginDialog())
+ {
+ if (dialog.ShowDialog() == DialogResult.OK)
+ {
+ e.UserName = dialog.UserName;
+ e.Password = dialog.Password;
+ }
+ }
+ }
+
+
+ private void report1_DatabaseLogin(object sender, DatabaseLoginEventArgs e)
+ {
+ e.ConnectionString = my_connection_string;
+ }
+
+
+ RegisteredObjects.Add(typeof(ShapeObject), "ReportPage,Shapes", 108, "Objects,Shapes,Rectangle", 0);
+ RegisteredObjects.Add(typeof(ShapeObject), "ReportPage,Shapes", 109, "Objects,Shapes,RoundRectangle", 1);
+ RegisteredObjects.Add(typeof(ShapeObject), "ReportPage,Shapes", 110, "Objects,Shapes,Ellipse", 2);
+
+
+ public override void OnBeforeInsert(int flags)
+ {
+ FShape = (ShapeKind)flags;
+ }
+
+
+ TextObject text1 = report1.FindObject("Text1") as TextObject;
+
+
+ Report report1;
+ ReportPage page = new ReportPage();
+ page.Parent = report1;
+
+ public DataHeaderBand Header
+ {
+ get { return FHeader; }
+ set
+ {
+ SetProp(FHeader, value);
+ FHeader = value;
+ }
+ }
+
+ <TextObject Name="Text2" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+
+
+ <DataBand Name="Data1" Top="163" Width="718.2" Height="18.9">
+ <TextObject Name="Text3" Left="18.9" Top="37.8" Width="283.5" Height="28.35"/>
+ </DataBand>
+
+
+ protected override void DeserializeSubItems(FRReader reader)
+ {
+ if (String.Compare(reader.ItemName, "Styles", true) == 0)
+ reader.Read(Styles);
+ else
+ base.DeserializeSubItems(reader);
+ }
+
+
+ TextObject text1 = report1.FindObject("Text1") as TextObject;
+ if (text1 != null)
+ {
+ // object found
+ }
+
+
+ TextObject textObj = new TextObject();
+ dataBand1.Objects.Add(textObj);
+ textObj.CreateUniqueName();
+
+ -
+
-
+
saving the report to the file or stream; +
+ -
+
saving the report to the designer's undo buffer; +
+ -
+
+ assigning the object to another object using the + +or AssignAll methods; +
+ -
+
saving the object to the designer's clipboard; +
+ -
+
saving the object to the preview (when run a + report). +
+
-
+
-
+
loading the report from a file or stream; +
+ -
+
loading the report from the designer's undo + buffer; +
+ -
+
assigning another object to this object using the + +or AssignAll methods;
+ -
+
loading the object from the designer's + clipboard; +
+ - loading the object from the preview pages. +
+ Report report1;
+ Report report2 = new Report();
+ // copy all report settings, do not copy report objects
+ report2.Assign(report1);
+
+ Report report1;
+ Report report2 = new Report();
+ // copy all report settings and objects
+ report2.AssignAll(report1);
+
+ public void OnBeforePrint(EventArgs e)
+ {
+ if (BeforePrint != null)
+ BeforePrint(this, e);
+ InvokeEvent(BeforePrintEvent, e);
+ }
+ -
+
- checks if the mouse pointer is inside the object; +
- add an object to the selected objects list of the designer; +
- sets the e.Handled flag to true. +
-
+
- checks if the mouse pointer is inside the object; +
- changes the cursor shape (e.Cursor property); +
- sets the e.Handled flag to true. +
-
+
-
+ if mouse button is not pressed, check that mouse pointer is inside one of
+ the selection points returned by the
+ method and set the e.SizingPoint member to the corresponding sizing + point; +
+ - if mouse button is pressed, and e.SizingPoint member is not + SizingPoint.None, resize the object. +
-
+
- if e.Mode is WorkspaceMode2.SelectionRect, checks if object + is inside the selection rectangle and sets e.Handled flag if so; +
-
+ checks that object is inside its parent (calls the
+
method). +
+
+ TextObject text1;
+ // set Height to 10mm
+ text1.Height = Units.Millimeters * 10;
+ // convert a value to millimeters
+ MessageBox.Show("Height = " + (text1.Height / Units.Millimeters).ToString() + "mm");
+
+ TextObject text1;
+ // set Left to 10mm
+ text1.Left = Units.Millimeters * 10;
+ // convert a value to millimeters
+ MessageBox.Show("Left = " + (text1.Left / Units.Millimeters).ToString() + "mm");
+
+ TextObject text1;
+ // set Top to 10mm
+ text1.Top = Units.Millimeters * 10;
+ // convert a value to millimeters
+ MessageBox.Show("Top = " + (text1.Top / Units.Millimeters).ToString() + "mm");
+
+ private void Data1_BeforePrint(object sender, EventArgs e)
+ {
+ Text1.Visible = [Orders.Shipped] == true;
+ }
+
+ TextObject text1;
+ // set Width to 10mm
+ text1.Width = Units.Millimeters * 10;
+ // convert a value to millimeters
+ MessageBox.Show("Width = " + (text1.Width / Units.Millimeters).ToString() + "mm");
+ -
+
-
+
To define own open/save dialogs that will be used in the report designer, + use the +, , + , events; +
+ -
+
To pass connection string to the connection object defined in a report, + or to define own database login dialog, use the +event; +
+ -
+
To adjust the connection object after it is opened, + use the +event; +
+ -
+
To define own progress window, use the +, + and events; +
+ -
+
To setup some common properties of the report, designer and preview, + use properties defined in this class; + +
+ -
+
To set UI style of the designer and preview window, + use +property. +
+
+ private void report1_DatabaseLogin(object sender, DatabaseLoginEventArgs e)
+ {
+ using (MyLoginDialog dialog = new MyLoginDialog())
+ {
+ if (dialog.ShowDialog() == DialogResult.OK)
+ {
+ e.UserName = dialog.UserName;
+ e.Password = dialog.Password;
+ }
+ }
+ }
+
+
+ private void report1_DatabaseLogin(object sender, DatabaseLoginEventArgs e)
+ {
+ e.ConnectionString = my_connection_string;
+ }
+
+
+ environmentSettings1.DesignerLoaded += new EventHandler(DesignerSettings_DesignerLoaded);
+
+ void DesignerSettings_DesignerLoaded(object sender, EventArgs e)
+ {
+ (sender as DesignerControl).MainMenu.miFileSelectLanguage.Visible = false;
+ }
+
+
+ private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (OpenFileDialog dialog = new OpenFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (SaveFileDialog dialog = new SaveFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+ // get default file name from e.FileName
+ dialog.FileName = e.FileName;
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // load the report from the given e.FileName
+ e.Report.Load(e.FileName);
+ }
+
+ private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // save the report to the given e.FileName
+ e.Report.Save(e.FileName);
+ }
+
+
+ private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (OpenFileDialog dialog = new OpenFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (SaveFileDialog dialog = new SaveFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+ // get default file name from e.FileName
+ dialog.FileName = e.FileName;
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // load the report from the given e.FileName
+ e.Report.Load(e.FileName);
+ }
+
+ private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // save the report to the given e.FileName
+ e.Report.Save(e.FileName);
+ }
+
+
+ private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (OpenFileDialog dialog = new OpenFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (SaveFileDialog dialog = new SaveFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+ // get default file name from e.FileName
+ dialog.FileName = e.FileName;
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // load the report from the given e.FileName
+ e.Report.Load(e.FileName);
+ }
+
+ private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // save the report to the given e.FileName
+ e.Report.Save(e.FileName);
+ }
+
+
+ private void CustomOpenDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (OpenFileDialog dialog = new OpenFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomSaveDialog_Handler(object sender, OpenSaveDialogEventArgs e)
+ {
+ using (SaveFileDialog dialog = new SaveFileDialog())
+ {
+ dialog.Filter = "Report files (*.frx)|*.frx";
+ // get default file name from e.FileName
+ dialog.FileName = e.FileName;
+
+ // set e.Cancel to false if dialog was succesfully executed
+ e.Cancel = dialog.ShowDialog() != DialogResult.OK;
+ // set e.FileName to the selected file name
+ e.FileName = dialog.FileName;
+ }
+ }
+
+ private void CustomOpenReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // load the report from the given e.FileName
+ e.Report.Load(e.FileName);
+ }
+
+ private void CustomSaveReport_Handler(object sender, OpenSaveReportEventArgs e)
+ {
+ // save the report to the given e.FileName
+ e.Report.Save(e.FileName);
+ }
+
+
+ environmentSettings1.CustomPreviewReport += new EventHandler(MyPreviewHandler);
+
+ private void MyPreviewHandler(object sender, EventArgs e)
+ {
+ Report report = sender as Report;
+ using (MyPreviewForm form = new MyPreviewForm())
+ {
+ report.Preview = form.previewControl1;
+ report.ShowPreparedReport();
+ form.ShowDialog();
+ }
+ }
+
+
+ environmentSettings1.FilterConnectionTables += DesignerSettings_FilterConnectionTables;
+
+ private void DesignerSettings_FilterConnectionTables(object sender, FilterConnectionTablesEventArgs e)
+ {
+ if (e.TableName == "Table 1")
+ e.Skip = true;
+ }
+
+
+ ReportPage page = report.Pages[0] as ReportPage;
+
+ // create the main group
+ GroupHeaderBand mainGroup = new GroupHeaderBand();
+ mainGroup.Height = Units.Millimeters * 10;
+ mainGroup.Name = "MainGroup";
+ mainGroup.Condition = "[Orders.CustomerName]";
+ // add a group to the page
+ page.Bands.Add(mainGroup);
+
+ // create the nested group
+ GroupHeaderBand nestedGroup = new GroupHeaderBand();
+ nestedGroup.Height = Units.Millimeters * 10;
+ nestedGroup.Name = "NestedGroup";
+ nestedGroup.Condition = "[Orders.OrderDate]";
+ // add it to the main group
+ mainGroup.NestedGroup = nestedGroup;
+
+ // create a data band
+ DataBand dataBand = new DataBand();
+ dataBand.Height = Units.Millimeters * 10;
+ dataBand.Name = "GroupData";
+ dataBand.DataSource = report.GetDataSource("Orders");
+ // connect the databand to the nested group
+ nestedGroup.Data = dataBand;
+
+
+ ReportPage page;
+ GroupHeaderBand group = new GroupHeaderBand();
+ group.NestedGroup = new GroupHeaderBand();
+ group.NestedGroup.Data = new DataBand();
+ page.Bands.Add(group);
+
+
+ ReportPage page;
+ GroupHeaderBand group = new GroupHeaderBand();
+ group.Data = new DataBand();
+ page.Bands.Add(group);
+
+ -
+
-
+
picture that is embedded in the report file. Use the ++ property to do this;
+ -
+
picture that is stored in the database BLOb field. Use the ++ property to specify the name of data column you want to show;
+ -
+
picture that is stored in the local disk file. Use the ++ property to specify the name of the file;
+ -
+
picture that is stored in the Web. Use the ++ property to specify the picture's URL.
+
+ myPictureObject.Image = new Bitmap("file.bmp");
+ myPictureObject.ShouldDisposeImage = true;
+
+
+ Config.PreviewSettings.Buttons = PreviewButtons.Open |
+ PreviewButtons.Save |
+ PreviewButtons.Find |
+ PreviewButtons.Zoom |
+ PreviewButtons.Outline |
+ PreviewButtons.PageSetup |
+ PreviewButtons.Edit |
+ PreviewButtons.Watermark |
+ PreviewButtons.Navigator |
+ PreviewButtons.Close;
+
+
+ textObject1.Fill = new SolidFill(Color.Green);
+ (textObject1.Fill as SolidFill).Color = Color.Red;
+
+ reportComponent1.Fill = new SolidFill(color);
+
+ ReportPage page = new ReportPage();
+ // set the paper in millimeters
+ page.PaperWidth = 210;
+ page.PaperHeight = 297;
+ // create report title
+ page.ReportTitle = new ReportTitleBand();
+ page.ReportTitle.Name = "ReportTitle1";
+ page.ReportTitle.Height = Units.Millimeters * 10;
+ // create data band
+ DataBand data = new DataBand();
+ data.Name = "Data1";
+ data.Height = Units.Millimeters * 10;
+ // add data band to the page
+ page.Bands.Add(data);
+ // add page to the report
+ report.Pages.Add(page);
+
+
+ // create the main report page
+ ReportPage reportPage = new ReportPage();
+ reportPage.Name = "Page1";
+ report.Pages.Add(reportPage);
+ // create report title band
+ reportPage.ReportTitle = new ReportTitleBand();
+ reportPage.ReportTitle.Name = "ReportTitle1";
+ reportPage.ReportTitle.Height = Units.Millimeters * 10;
+ // add subreport on it
+ SubreportObject subreport = new SubreportObject();
+ subreport.Name = "Subreport1";
+ subreport.Bounds = new RectangleF(0, 0, Units.Millimeters * 25, Units.Millimeters * 5);
+ reportPage.ReportTitle.Objects.Add(subreport);
+ // create subreport page
+ ReportPage subreportPage = new ReportPage();
+ subreportPage.Name = "SubreportPage1";
+ report.Pages.Add(subreportPage);
+ // connect the subreport to the subreport page
+ subreport.ReportPage = subreportPage;
+
+
+ text1.TextFill = new HatchFill(Color.Black, Color.White, HatchStyle.Cross);
+
+ Use the textObject1.TextFill = new SolidFill(color);
+
+ TextObject text1;
+ HighlightCondition highlight = new HighlightCondition();
+ highlight.Expression = "Value < 0";
+ highlight.Fill = new SolidFill(Color.Red);
+ highlight.ApplyFill = true;
+ text1.Highlight.Add(highlight);
+
+
+ TextObject text1;
+ text1.Format = new CurrencyFormat();
+
+ -
+
-
+
print the object (with wrong value); +
+ -
+
print all related data rows; +
+ -
+
calculate the correct object's value and replace old (wrong) value with the new one. +
+
+ text1.Formats.Clear();
+ text1.Formats.Add(new DateFormat());
+ text1.Formats.Add(new NumberFormat());
+
+
+ protected override void Done()
+ {
+ base.Done();
+ ImageExport imageExport = Export as ImageExport;
+ imageExport.ImageFormat = (ImageExportFormat)cbxImageFormat.SelectedIndex;
+ imageExport.Resolution = (int)udResolution.Value;
+ imageExport.JpegQuality = (int)udQuality.Value;
+ imageExport.SeparateFiles = cbSeparateFiles.Checked;
+ }
+
+
+ public override void Init(ExportBase export)
+ {
+ base.Init(export);
+ ImageExport imageExport = Export as ImageExport;
+ cbxImageFormat.SelectedIndex = (int)imageExport.ImageFormat;
+ udResolution.Value = imageExport.Resolution;
+ udQuality.Value = imageExport.JpegQuality;
+ cbSeparateFiles.Checked = imageExport.SeparateFiles;
+ }
+
+
+ public DialogPageOptions(DialogPageDesigner pd) : base()
+ {
+ FPageDesigner = pd;
+ InitializeComponent();
+ }
+
+
+ CrossViewObject crossView;
+ // change the fill color of the first matrix cell
+ crossView.Data.Cells[0].TemplateCell.Fill = new SolidFill(Color.Red);
+
+
+ DialogPage form = new DialogPage();
+ // set the width and height in pixels
+ form.Width = 200;
+ form.Height = 200;
+ form.Name = "Form1";
+ // create a button
+ ButtonControl button = new ButtonControl();
+ button.Location = new Point(20, 20);
+ button.Size = new Size(75, 25);
+ button.Text = "The button";
+ // add the button to the form
+ form.Controls.Add(button);
+
+
+ protected override void AttachEvents()
+ {
+ base.AttachEvents();
+ CheckBox.CheckedChanged += new EventHandler(CheckBox_CheckedChanged);
+ }
+
+ private void CheckBox_CheckedChanged(object sender, EventArgs e)
+ {
+ if (CheckedChanged != null)
+ CheckedChanged(this, e);
+ InvokeEvent(CheckedChangedEvent, e);
+ }
+
+
+ protected override void DetachEvents()
+ {
+ base.DetachEvents();
+ CheckBox.CheckedChanged -= new EventHandler(CheckBox_CheckedChanged);
+ }
+
+
+ protected override void FillData(DataSourceBase dataSource, Column column)
+ {
+ Items.Clear();
+ dataSource.First();
+ while (dataSource.HasMoreRows)
+ {
+ Items.Add(dataSource[column].ToString());
+ dataSource.Next();
+ }
+ }
+
+ -
+
-
+
create an instance of the MatrixObject and add it to the report; +
+ -
+
create descriptors for columns, rows and cells and add it to the + collections inside the +property;
+ -
+
call the +method to create the matrix template + that will be used to create a result;
+ -
+
modify the matrix template (change captions, set the visual appearance). +
+
+ // create an instance of MatrixObject
+ MatrixObject matrix = new MatrixObject();
+ matrix.Name = "Matrix1";
+ // add it to the report title band of the first report page
+ matrix.Parent = (report.Pages[0] as ReportPage).ReportTitle;
+
+ // create two column descriptors
+ MatrixHeaderDescriptor column = new MatrixHeaderDescriptor("[MatrixDemo.Year]");
+ matrix.Data.Columns.Add(column);
+ column = new MatrixHeaderDescriptor("[MatrixDemo.Month]");
+ matrix.Data.Columns.Add(column);
+
+ // create one row descriptor
+ MatrixHeaderDescriptor row = new MatrixHeaderDescriptor("[MatrixDemo.Name]");
+ matrix.Data.Rows.Add(row);
+
+ // create one data cell
+ MatrixCellDescriptor cell = new MatrixCellDescriptor("[MatrixDemo.Revenue]", MatrixAggregateFunction.Sum);
+ matrix.Data.Cells.Add(cell);
+
+ // connect matrix to a datasource
+ matrix.DataSource = Report.GetDataSource("MatrixDemo");
+
+ // create the matrix template
+ matrix.BuildTemplate();
+
+ // change the style
+ matrix.Style = "Green";
+
+ // change the column and row total's text to "Grand Total"
+ matrix.Data.Columns[0].TemplateTotalCell.Text = "Grand Total";
+ matrix.Data.Rows[0].TemplateTotalCell.Text = "Grand Total";
+
+
+ // suppose we have a matrix with one column, row and data cell.
+ // provide 3 one-dimensional arrays with one element in each to the AddValue method
+ Matrix1.Data.AddValue(
+ new object[] { 1996 },
+ new object[] { "Andrew Fuller" },
+ new object[] { 123.45f });
+ Matrix1.Data.AddValue(
+ new object[] { 1997 },
+ new object[] { "Andrew Fuller" },
+ new object[] { 21.35f });
+ Matrix1.Data.AddValue(
+ new object[] { 1997 },
+ new object[] { "Nancy Davolio" },
+ new object[] { 421.5f });
+
+ // this code will produce the following matrix:
+ // | 1996 | 1997 |
+ // --------------+--------+--------+
+ // Andrew Fuller | 123.45| 21.35|
+ // --------------+--------+--------+
+ // Nancy Davolio | | 421.50|
+ // --------------+--------+--------+
+
+ -
+
-
+
select the cell that you need to highlight; +
+ -
+
click the "Highlight" button on the "Text" toolbar; +
+ -
+
add a new highlight condition. Use the Matrix.ColumnValues to + refer to the value you need to analyze. Note: these values are arrays of System.Object, + so you need to cast it to actual type before making any comparisons. Example of highlight + condition: +(int)Matrix1.ColumnValues[0] == 2000 . +
+
-
+
-
+
select the cell that you need to highlight; +
+ -
+
click the "Highlight" button on the "Text" toolbar; +
+ -
+
add a new highlight condition. Use the Matrix.RowValues to + refer to the value you need to analyze. Note: these values are arrays of System.Object, + so you need to cast it to actual type before making any comparisons. Example of highlight + condition: +(string)Matrix1.RowValues[0] == "Andrew Fuller" . +
+
-
+
-
+
select the cell that you need to highlight; +
+ -
+
click the "Highlight" button on the "Text" toolbar; +
+ -
+
add a new highlight condition that uses the Matrix.ColumnIndex, + for example: +Matrix1.ColumnIndex % 2 == 1 . +
+
-
+
-
+
select the cell that you need to highlight; +
+ -
+
click the "Highlight" button on the "Text" toolbar; +
+ -
+
add a new highlight condition that uses the Matrix.RowIndex, + for example: +Matrix1.RowIndex % 2 == 1 . +
+
+ MatrixObject matrix;
+ matrix.Data.AddValue(
+ new object[] { 1996 },
+ new object[] { "Andrew Fuller" },
+ new object[] { 123.45f });
+
+ // this will produce the following result:
+ // | 1996 |
+ // --------------+----------+
+ // Andrew Fuller | 123.45|
+ // --------------+----------+
+
+
+ MatrixObject matrix;
+ // change the fill color of the first matrix cell
+ matrix.Data.Cells[0].TemplateCell.Fill = new SolidFill(Color.Red);
+
+
+ MatrixObject matrix;
+ matrix.Data.Rows[0].TemplateTotalCell.Text = "Grand Total";
+
+
+ MatrixObject matrix;
+ matrix.Data.Rows[0].TemplateTotalCell.Text = "Grand Total";
+ matrix.Data.Rows[0].TemplateTotalCell.Fill = new SolidFill(Color.Green);
+
+ -
+
-
+
the Series that is handled by MS Chart. It is stored in the + Chart.Series collection; +
+ -
+
the +object that provides data for MS Chart series. + It is stored in the collection.
+
+ report.Load("...");
+ MSChartObject reportChart = report.FindObject("MSChart1") as MSChartObject;
+ reportChart.AssignChart(applicationChart);
+ report.Show();
+
+ -
+
-
+
Sum(cell) +Calculates the sum of values in specified table cell. +
+ -
+
Min(cell) +Calculates the minimum of values in specified table cell. +
+ -
+
Max(cell) +Calculates the maximum of values in specified table cell. +
+ -
+
Avg(cell) +Calculates the average of values in specified table cell. +
+ -
+
Count(cell) +Calculates the number of repeats of a specified table cell. +
+
+ // print table header (the first row)
+ Table1.PrintRow(0);
+ Table1.PrintColumns();
+ // print table body (the second row)
+ for (int i = 0; i < 10; i++)
+ {
+ Table1.PrintRow(1);
+ Table1.PrintColumns();
+ }
+ // print table footer (the third row)
+ Table1.PrintRow(2);
+ Table1.PrintColumns();
+
+
+
+ // print table header (the first column)
+ Table1.PrintColumn(0);
+ Table1.PrintRows();
+ // print table body (the second column)
+ for (int i = 0; i < 10; i++)
+ {
+ Table1.PrintColumn(1);
+ Table1.PrintRows();
+ }
+ // print table footer (the third column)
+ Table1.PrintColumn(2);
+ Table1.PrintRows();
+
+
+
+ // print the first row with all its columns
+ Table1.PrintRow(0);
+ // print header column
+ Table1.PrintColumn(0);
+ // print 10 data columns
+ for (int i = 0; i < 10; i++)
+ {
+ Table1.PrintColumn(1);
+ }
+ // print footer column
+ Table1.PrintColumn(2);
+
+ // print table body (the second row)
+ for (int i = 0; i < 10; i++)
+ {
+ // print data row with all its columns
+ Table1.PrintRow(1);
+ Table1.PrintColumn(0);
+ for (int j = 0; j < 10; j++)
+ {
+ Table1.PrintColumn(1);
+ }
+ Table1.PrintColumn(2);
+ }
+
+ // print table footer (the third row)
+ Table1.PrintRow(2);
+ // again print all columns in the table footer
+ Table1.PrintColumn(0);
+ for (int i = 0; i < 10; i++)
+ {
+ Table1.PrintColumn(1);
+ }
+ Table1.PrintColumn(2);
+
+
+ TableCell cell1;
+ PictureObject picture1 = new PictureObject();
+ picture1.Bounds = new RectangleF(0, 0, 32, 32);
+ picture1.Name = "Picture1";
+ cell1.Objects.Add(picture1);
+
+
+ // right-align the table
+ Table1.ResultTable.Left = Engine.PageWidth - Table1.ResultTable.CalcWidth() - 1;
+
+ -
+
0 $n
+ 1 n$
+ 2 $ n
+ 3 n $
+
-
+
0 ($n)
+ 1 -$n
+ 2 $-n
+ 3 $n-
+ 4 (n$)
+ 5 -n$
+ 6 n-$
+ 7 n$-
+ 8 -n $
+ 9 -$ n
+ 10 n $-
+ 11 $ n-
+ 12 $ -n
+ 13 n- $
+ 14 ($ n)
+ 15 (n $)
+
-
+
0 (n)
+ 1 -n
+ 2 - n
+ 3 n-
+ 4 n -
+
-
+
0 n %
+ 1 n%
+ 2 %n
+ 3 % n
+
-
+
0 -n %
+ 1 -n%
+ 2 -%n
+ 3 %-n
+ 4 %n-
+ 5 n-%
+ 6 n%-
+ 7 -%n
+ 8 n %-
+ 9 % n-
+ 10 % -n
+ 11 n- %
+
+ public void Draw(FRPaintEventArgs e)
+ {
+ Brush brush = e.Cache.GetBrush(BackColor);
+ Pen pen = e.Cache.GetPen(BorderColor, 1, BorderStyle);
+ e.Graphics.FillRectangle(brush, Bounds);
+ e.Graphics.DrawRectangle(pen, Bounds);
+ }
+
+ -
+
System.Data.SqlClient -SQL Sever Client
+ System.Data.SqlServerCe.3.5 -SQL Sever Compact 3.5
+ System.Data.OracleClient -Oracle Client from Microsoft (deprecated in .NET Framework 4)
+ Oracle.DataAccess.Client -ODP.NET provider from Oracle
+ System.Data.SQLite -System.Data.SQLite driver for SQLite
+ Npgsql -Npgsql driver for PostgreSQL
+ MySql.Data.MySqlClient -MySQL Connector/Net
+
-
+
sqlserver ,mssql ,microsoft ormsde - SQL Server Data Provider
+ oledb - OLEDB Data Provider
+ odbc - ODBC Data Provider
+
+ <configSections>
+ <section name="NLog" type="NLog.Config.ConfigSectionHandler, NLog" />
+ </configSections>
+ -
+
- if
is null => returns (never matches)
+ - if
doesn't contains any '*' nor '?' => returns (matches only on case sensitive equals)
+ - if
== '*' => returns (always matches)
+ - if
doesn't contain '?' + -
+
- if
contains exactly 2 '*' one at the beginning and one at the end (i.e. "*foobar*) => returns
+ - if
contains exactly 1 '*' at the beginning (i.e. "*foobar") => returns
+ - if
contains exactly 1 '*' at the end (i.e. "foobar*") => returns
+
+ - if
- returns
-
+
- '*' means zero or more occurrences of any character +
- '?' means exactly one occurrence of any character +
-
+
- '*' means zero or more occurrences of any character +
- '?' means exactly one occurrence of any character +
-
+
- '*' means zero or more occurrences of any character +
- '?' means exactly one occurrence of any character +
+
+
+ .
+
+
+ .
+ ${appsetting:item=mysetting:default=mydefault} - produces "mydefault" if no appsetting
+
+ See NLog Wiki
+ -
+
- CommonApplicationData - application data for all users. +
- ApplicationData - roaming application data for current user. +
- LocalApplicationData - non roaming application data for current user +
- UserProfile - Profile folder for current user +
- DesktopDirectory - Desktop-directory for current user +
- MyDocuments - My Documents-directory for current user +
- System - System directory +
+ -
+ -
+ -
+ -
+ -
+ -
+
+ [Target("MyFirst")]
+ public sealed class MyFirstTarget : AsyncTaskTarget
+ {
+ public MyFirstTarget()
+ {
+ this.Host = "localhost";
+ }
+
+ [RequiredParameter]
+ public Layout Host { get; set; }
+
+ protected override Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token)
+ {
+ string logMessage = this.RenderLogEvent(this.Layout, logEvent);
+ string hostName = this.RenderLogEvent(this.Host, logEvent);
+ return SendTheMessageToRemoteHost(hostName, logMessage);
+ }
+
+ private async Task SendTheMessageToRemoteHost(string hostName, string message)
+ {
+ // To be implemented
+ }
+ }
+
+ protected override Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token)
+ {
+ return CustomWriteAsync(logEvent, token);
+ }
+
+ private async Task CustomWriteAsync(LogEventInfo logEvent, CancellationToken token)
+ {
+ await MyLogMethodAsync(logEvent, token).ConfigureAwait(false);
+ }
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ | Condition | +Foreground Color | +Background Color | +
|---|---|---|
| level == LogLevel.Fatal | +Red | +NoChange | +
| level == LogLevel.Error | +Yellow | +NoChange | +
| level == LogLevel.Warn | +Magenta | +NoChange | +
| level == LogLevel.Info | +White | +NoChange | +
| level == LogLevel.Debug | +Gray | +NoChange | +
| level == LogLevel.Trace | +DarkGray | +NoChange | +
+ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${basedir}/${level}.log
+ All + KeepFileOpen = false gives the best compability, but slow performance and lead to file-locking issues with other applications. +
+ a random value between 0 and 20 milliseconds - 2nd attempt
+ a random value between 0 and 40 milliseconds - 3rd attempt
+ a random value between 0 and 80 milliseconds - 4th attempt
+ ... + and so on. +
+ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
++ Mail target works best when used with BufferingWrapper target + which lets you send multiple log messages in single mail +
++ To set up the buffered mail target in the configuration file, + use the following syntax: +
++ To set up the buffered mail target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ tags. +
+ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
++ To print the results, use any application that's able to receive messages over + TCP or UDP. NetCat is + a simple but very powerful command-line tool that can be used for that. This image + demonstrates the NetCat tool receiving log messages from Network target. +
+
+ + There are two specialized versions of the Network target: Chainsaw + and NLogViewer which write to instances of Chainsaw log4j viewer + or NLogViewer application respectively. +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ -
+
- tcp://host:port - TCP (auto select IPv4/IPv6) +
- tcp4://host:port - force TCP/IPv4 +
- tcp6://host:port - force TCP/IPv6 +
- udp://host:port - UDP (auto select IPv4/IPv6) +
- udp4://host:port - force UDP/IPv4 +
- udp6://host:port - force UDP/IPv6 +
- http://host:port/pageName - HTTP using POST verb +
- https://host:port/pageName - HTTPS using POST verb +
+ - When connection-list is full and
+ - When message is too big and
+
+ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+
+ [Target("MyFirst")]
+ public sealed class MyFirstTarget : TargetWithContext
+ {
+ public MyFirstTarget()
+ {
+ this.Host = "localhost";
+ }
+
+ [RequiredParameter]
+ public Layout Host { get; set; }
+
+ protected override void Write(LogEventInfo logEvent)
+ {
+ string logMessage = this.RenderLogEvent(this.Layout, logEvent);
+ string hostName = this.RenderLogEvent(this.Host, logEvent);
+ return SendTheMessageToRemoteHost(hostName, logMessage);
+ }
+
+ private void SendTheMessageToRemoteHost(string hostName, string message)
+ {
+ // To be implemented
+ }
+ }
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+ ${longdate}|${level:uppercase=true}|${logger}|${message:withexception=true}
+
+ <system.net>
+ <defaultProxy enabled = "true" useDefaultCredentials = "true" >
+ <proxy usesystemdefault = "True" />
+ </defaultProxy>
+ </system.net>
+
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+The example web service that works with this example is shown below
++ Asynchronous target wrapper allows the logger code to execute more quickly, by queuing + messages and processing them in a separate thread. You should wrap targets + that spend a non-trivial amount of time in their Write() method with asynchronous + target to speed up logging. +
++ Because asynchronous logging is quite a common scenario, NLog supports a + shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to + the <targets/> element in the configuration file. +
+
+
+ ... your targets go here ...
+
+ ]]>
+ + To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+This example causes the messages to be written to server1, + and if it fails, messages go to server2.
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+This example causes the messages not contains the string '1' to be ignored.
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
++ This example works like this. If there are no Warn,Error or Fatal messages in the buffer + only Info messages are written to the file, but if there are any warnings or errors, + the output includes detailed trace (levels >= Debug). +
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+This example causes the messages to be written to either file1.txt or file2.txt + chosen randomly on a per-message basis. +
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+This example causes each log message to be repeated 3 times.
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+This example causes each write attempt to be repeated 3 times, + sleeping 1 second between attempts if first one fails.
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+This example causes the messages to be written to either file1.txt or file2.txt. + Each odd message is written to file2.txt, each even message goes to file1.txt. +
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+This example causes the messages to be written to both file1.txt or file2.txt +
++ To set up the target in the configuration file, + use the following syntax: +
++ To set up the log target programmatically use code like this: +
+
+ [CanBeNull] object Test() => null;
+
+ void UseTest() {
+ var p = Test();
+ var s = p.ToString(); // Warning: Possible 'System.NullReferenceException'
+ }
+
+ [NotNull] object Foo() {
+ return null; // Warning: Possible 'null' assignment
+ }
+
+ public void Foo([ItemNotNull]List<string> books)
+ {
+ foreach (var book in books) {
+ if (book != null) // Warning: Expression is always true
+ Console.WriteLine(book.ToUpper());
+ }
+ }
+
+ public void Foo([ItemCanBeNull]List<string> books)
+ {
+ foreach (var book in books)
+ {
+ // Warning: Possible 'System.NullReferenceException'
+ Console.WriteLine(book.ToUpper());
+ }
+ }
+
+ [StringFormatMethod("message")]
+ void ShowError(string message, params object[] args) { /* do something */ }
+
+ void Foo() {
+ ShowError("Failed: {0}"); // Warning: Non-existing argument in format string
+ }
+
+ void LogInfo([StructuredMessageTemplate]string message, params object[] args) { /* do something */ }
+
+ void Foo() {
+ LogInfo("User created: {username}"); // Warning: Non-existing argument in format string
+ }
+
+ namespace TestNamespace
+ {
+ public class Constants
+ {
+ public static int INT_CONST = 1;
+ public const string STRING_CONST = "1";
+ }
+
+ public class Class1
+ {
+ [ValueProvider("TestNamespace.Constants")] public int myField;
+ public void Foo([ValueProvider("TestNamespace.Constants")] string str) { }
+
+ public void Test()
+ {
+ Foo(/*try completion here*/);//
+ myField = /*try completion here*/
+ }
+ }
+ }
+
+ void Foo([ValueRange(0, 100)] int value) {
+ if (value == -1) { // Warning: Expression is always 'false'
+ ...
+ }
+ }
+
+ void Foo([NonNegativeValue] int value) {
+ if (value == -1) { // Warning: Expression is always 'false'
+ ...
+ }
+ }
+
+ void Foo(string param) {
+ if (param == null)
+ throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol
+ }
+ -
+
NotifyChanged(string)
+ NotifyChanged(params string[])
+ NotifyChanged{T}(Expression{Func{T}})
+ NotifyChanged{T,U}(Expression{Func{T,U}})
+ SetProperty{T}(ref T, T, string)
+
+ public class Foo : INotifyPropertyChanged {
+ public event PropertyChangedEventHandler PropertyChanged;
+
+ [NotifyPropertyChangedInvocator]
+ protected virtual void NotifyChanged(string propertyName) { ... }
+
+ string _name;
+
+ public string Name {
+ get { return _name; }
+ set { _name = value; NotifyChanged("LastName"); /* Warning */ }
+ }
+ }
+
+ Examples of generated notifications:
+ -
+
NotifyChanged("Property")
+ NotifyChanged(() => Property)
+ NotifyChanged((VM x) => x.Property)
+ SetProperty(ref myField, value, "Property")
+
Function Definition Table syntax:
+-
+
- FDT ::= FDTRow [;FDTRow]* +
- FDTRow ::= Input => Output | Output <= Input +
- Input ::= ParameterName: Value [, Input]* +
- Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} +
- Value ::= true | false | null | notnull | canbenull +
+ Using
+ Value
+ You can use multiple
+
-
+
+ [ContractAnnotation("=> halt")] + public void TerminationMethod() +
+ + [ContractAnnotation("null <= param:null")] // reverse condition syntax + public string GetName(string surname) +
+ + [ContractAnnotation("s:null => true")] + public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() +
+ + // A method that returns null if the parameter is null, + // and not null if the parameter is not null + [ContractAnnotation("null => null; notnull => notnull")] + public object Transform(object data) +
+ + [ContractAnnotation("=> true, result: notnull; => false, result: null")] + public bool TryParse(string s, out Person result) +
+
+ [LocalizationRequiredAttribute(true)]
+ class Foo {
+ string str = "my string"; // Warning: Localizable string
+ }
+
+ [CannotApplyEqualityOperator]
+ class NoEquality { }
+
+ class UsesNoEquality {
+ void Test() {
+ var ca1 = new NoEquality();
+ var ca2 = new NoEquality();
+ if (ca1 != null) { // OK
+ bool condition = ca1 == ca2; // Warning
+ }
+ }
+ }
+
+ [BaseTypeRequired(typeof(IComponent)] // Specify requirement
+ class ComponentAttribute : Attribute { }
+
+ [Component] // ComponentAttribute requires implementing IComponent interface
+ class MyComponent : IComponent { }
+ + You can use
+ [UsedImplicitly]
+ public class TypeConverter {}
+
+ public class SummaryData
+ {
+ [UsedImplicitly(ImplicitUseKindFlags.InstantiatedWithFixedConstructorSignature)]
+ public SummaryData() {}
+ }
+
+ [UsedImplicitly(ImplicitUseTargetFlags.WithInheritors | ImplicitUseTargetFlags.Default)]
+ public interface IService {}
+
+ [Pure] int Multiply(int x, int y) => x * y;
+
+ void M() {
+ Multiply(123, 42); // Warning: Return value of pure method is not used
+ }
+ + Similarly to
[MustUseReturnValue("Use the return value to...")].
+
+ class Foo {
+ [ProvidesContext] IBarService _barService = ...;
+
+ void ProcessNode(INode node) {
+ DoSomething(node, node.GetGlobalServices().Bar);
+ // ^ Warning: use value of '_barService' field
+ }
+ }
+
+ [SourceTemplate]
+ public static void forEach<T>(this IEnumerable<T> xs) {
+ foreach (var x in xs) {
+ //$ $END$
+ }
+ }
+
+
+ [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")]
+ public static void forEach<T>(this IEnumerable<T> collection) {
+ foreach (var item in collection) {
+ //$ $END$
+ }
+ }
+
+ Applying the attribute on a template method parameter:
+
+ [SourceTemplate]
+ public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) {
+ /*$ var $x$Id = "$newguid$" + x.ToString();
+ x.DoSomething($x$Id); */
+ }
+
+
+ public class MyStringCollection : List<string>
+ {
+ [CollectionAccess(CollectionAccessType.Read)]
+ public string GetFirstString()
+ {
+ return this.ElementAt(0);
+ }
+ }
+ class Test
+ {
+ public void Foo()
+ {
+ // Warning: Contents of the collection is never updated
+ var col = new MyStringCollection();
+ string x = col.GetFirstString();
+ }
+ }
+
+ static void ThrowIfNull<T>([NoEnumeration] T v, string n) where T : class
+ {
+ // custom check for null but no enumeration
+ }
+
+ void Foo(IEnumerable<string> values)
+ {
+ ThrowIfNull(values, nameof(values));
+ var x = values.ToList(); // No warnings about multiple enumeration
+ }
+
+ void Foo([LanguageInjection(InjectedLanguage.CSS, Prefix = "body{", Suffix = "}")] string cssProps)
+ {
+ // cssProps should only contains a list of CSS properties
+ }
+
+ [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
+
+
+ [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })]
+
+
+ [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
+
+
+ [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })]
+
+