ReportTableCalcColumn AddCalculatedColumn(string aHeaderText, CalculationType aCalcType, int aWidth, string aFormat = null, CellCallback aCallback = null, string aHeaderStyle = null, string aColumnStyle = null, string aColumnAltStyle = null, string aErrorStyle = null);
Function AddCalculatedColumn(ByVal aHeaderText As String, , ByVal aCalclType As CalculationType, ByVal aWidth As Integer, ByVal aFormat As String = Nothing, ByVal aCallback As CellCalback = Nothing, ByVal aHeaderStyle As String = Nothing, ByVal aColumnStyle As String = Nothing, ByVal aColumnAltStyle As String = Nothing, ByVal aErrorStyle As String = Nothing) As ReportTableCalcColumn
Metoda służy do dodania wyliczanej kolumny do tabeli raportowej. Wyliczenie odbywa się na podstawie wartości komórek poszczególnych wierszy tabeli.
Parametr aHeaderText określa tekst wyświetlany w linii nagłówka tabeli.
Parametr aCalcType określa sposób wyliczenia zawartości komórek kolumny. Możliwe są następujące wartości:
CalculationType.Custom – wyliczenie niestandardowe wykonywane w funkcji zwrotnej aCallback
CalculationType.Sum – suma wartości komórek wiersza
CalculationType.Min – minimalna wartość komórek wiersza
CalculationType.Max – maksymalna wartość komórek wiersza
CalculationType.Avg – średnia wartość komórek wiersza
Parametr aWidth określa szerokość kolumny w milimetrach, a parametr aFormat sposób formatowania wartości wyświetlanych w komórkach kolumny.
Parametr aCallback pozwala na zadeklarowanie funkcji zwrotnej, która będzie wykonywana dla każdej komórki kolumny w momencie generowania jej zawartości. Mechanizm ten pozwala na implementację własnej metody wyliczania wartości, kontroli i dodatkowego formatowania wartości wynikowej. Funkcja zwrotna może zmienić zarówno treść komórki jak i styl generacji. Funkcja zwrotna musi być zgodna z poniższym delegatem:
delegate bool CellCallback(ReportTableCell aCell);
Delegate Sub CellCallback(ByVal aCell As IReportTableCell)
Parametr aCell służy do identyfikacji komórki. Pozwala on też na dostęp do proponowanej zawartości komórki i jej ewentualnej modyfikacji. Poprzez parametr aCall można także dostać się do wartości wszystkich komórek wiersza, którego dane wywołanie funkcji zwrotnej dotyczy. Na podstawie tych wartości można zaimplementować własny sposób wyliczania wartości agregowanej wiersza. Funkcja zwrotna zwraca wartość true, gdy utworzyła samodzielnie zawartość komórki. Wartość powrotna false oznacza, że należy wygenerować zawartość komórki na podstawie danych zawartych w obiekcie komórki aCell.
Opcjonalne parametry aHeaderStyle, aColumnStyle, aColumnAltStyle, aErrorStyle pozwalają na indywidualne określenie nazwy stylów dla: komórki nagłówka, komórek wartości, komórek wartości w wierszach parzystych, komórek wartości z niepoprawnym statusem danych.
ReportTableCalcRow AddCalculatedRow(string aFirstColumnText, CalculationType aCalcType, string aFormat = null, CellCallback aCallback = null, string aFirstStyle = null, string aNextStyle = null, string aErrorStyle = null);
Function AddCalculatedRow(ByVal aFirstColumnText As String, , ByVal aCalclType As CalculationType,, ByVal aFormat As String = Nothing, ByVal aCallback As CellCalback = Nothing, ByVal aFirstStyle As String = Nothing, ByVal aNextStyle As String = Nothing, ByVal aErrorStyle As String = Nothing) As ReportTableCalcRow
Metoda służy do dodania wyliczanego wiersza do tabeli raportowej. Wyliczenie odbywa się na podstawie wartości komórek poszczególnych kolumn tabeli.
Parametr aFirstColumnText określa tekst wyświetlany w pierwszej kolumnie wiersza.
Parametr aCalcType określa sposób wyliczenia zawartości komórek wiersza. Możliwe są następujące wartości:
CalculationType.Custom – wyliczenie niestandardowe wykonywane w funkcji zwrotnej aCallback
CalculationType.Sum – suma wartości komórek kolumny
CalculationType.Min – minimalna wartość komórek kolumny
CalculationType.Max – maksymalna wartość komórek kolumny
CalculationType.Avg – średnia wartość komórek kolumny
Parametr parametr aFormat określa sposób formatowania wartości wyświetlanych w komórkach wiersza.
Parametr aCallback pozwala na zadeklarowanie funkcji zwrotnej, która będzie wykonywana dla każdej komórki wiersza w momencie generowania jej zawartości. Mechanizm ten pozwala na implementację własnej metody wyliczania wartości oraz kontroli i dodatkowego formatowania wartości wynikowej. Funkcja zwrotna może zmienić zarówno treść komórki jak i styl generacji. Funkcja zwrotna musi być zgodna z poniższym delegatem:
delegate bool CellCallback(ReportTableCell aCell);
Delegate Sub CellCallback(ByVal aCell As IReportTableCell)
Parametr aCell służy do identyfikacji komórki. Pozwala on też na dostęp do proponowanej zawartości komórki i jej ewentualnej modyfikacji. Poprzez parametr aCall można także dostać się do wartości wszystkich komórek kolumny, którego dane wywołanie funkcji zwrotnej dotyczy. Na podstawie tych wartości można zaimplementować własny sposób wyliczania wartości agregowanej wiersza. Funkcja zwrotna zwraca wartość true, gdy utworzyła samodzielnie zawartość komórki. Wartość powrotna false oznacza, że należy wygenerować zawartość komórki na podstawie danych zawartych w obiekcie komórki aCell.
Opcjonalne parametry aFirstStyle, aNextStyle, aErrorStyle pozwalają na indywidualne określenie nazwy stylów dla: pierwszej komórki wiersza(opisu wiersza), komórek wartości, komórek wartości z niepoprawnym statusem.
ReportTableColumn AddColumn(string aHeaderText, string aVarName, string aAggrName, int aWidth, string aFormat = null, ReportTableCellErrorBehavior aErrorMode = ReportTableCellErrorBehavior.Normal, CellCallback aCallback = null, string aHeaderStyle = null, string aColumnStyle = null, string aColumnAltStyle = null, string aErrorStyle = null);
Function AddColumn(ByVal aHeaderText As String, ByVal aVarName As String, ByVal aAggrName As String, ByVal aWidth As Integer, ByVal aFormat As String = Nothing, ByVal aErrorMode As ReportTableCellErrorBehavior = ReportTableCellErrorBehavior.Normal, ByVal aCallback As CellCalback = Nothing, ByVal aHeaderStyle As String = Nothing, ByVal aColumnStyle As String = Nothing, ByVal aColumnAltStyle As String = Nothing, ByVal aErrorStyle As String = Nothing) As ReportTableColumn
Metoda służy do dodania kolumny do tabeli pionowej tworzonej na podstawie danych archiwalnych zmiennych procesowych.
Parametr aHeaderText określa tekst wyświetlany w linii nagłówka tabeli.
Parametry aVarName i aAggrName określają nazwę zmiennej procesowej oraz nazwę wyliczanego agregatu. W miejscu atrybutu aVarName można użyć dwóch specjalnych nazw: ReportTable.StartTimeColumn lub ReportTableEndTimeColumn. Pozwala to na zdefiniowanie kolumn, w których pokazywane będą czasy początków i końców poszczególnych okresów wyliczania wartości agregatów.
Parametr aWidth określa szerokość kolumny w milimetrach, a parametr aFormat sposób formatowania wartości wyświetlanych w komórkach kolumny. Jeżeli parametr aFormat nie zostanie podany, to zostanie użyty atrybut formatu wartości pobrany z bazy definicji zmiennych.
Parametr aErrorMode określa sposób tworzenia zawartości komórek wartości, dla których brak danych lub ich status jest niepoprawny. Możliwe są następujące wartości:
ReportTableCellErrorBehavior.Empty - pusta zawartość komórki
ReportTableCellErrorBehavior.Normal - ignoruj wszystkie błędy
ReportTableCellErrorBehavior.Normal_EmptyIfNoData - ignoruj błędy statusu, pusta zawartość gdy brak danych
ReportTableCellErrorBehavior.AddQuestion - dodaj znak zapytania
ReportTableCellErrorBehavior.AddQuestion_EmptyIfNoData - dodaj znak zapytania przy błędach statusu, pusta zawartość gdy brak danych
Parametr aCallback pozwala na zadeklarowanie funkcji zwrotnej, która będzie wykonywana dla każdej komórki wartości w momencie generowania jej zawartości. Mechanizm ten pozwala na implementację własnej metody reakcji na błędy lub kontroli wartości zmiennych. Funkcja zwrotna może zmienić zarówno treść komórki jak i styl generacji. Funkcja zwrotna musi być zgodna z poniższym delegatem:
delegate bool CellCallback(ReportTableCell aCell);
Delegate Sub CellCallback(ByVal aCell As IReportTableCell)
Parametr aCell służy do identyfikacji komórki. Pozwala on też na dostęp do proponowanej zawartości komórki i jej ewentualnej modyfikacji. Funkcja zwrotna zwraca wartość true, gdy utworzyła samodzielnie zawartość komórki. Wartość powrotna false oznacza, że należy wygenerować zawartość komórki na podstawie danych zawartych w obiekcie komórki aCell.
Opcjonalne parametry aHeaderStyle, aColumnStyle, aColumnAltStyle, aErrorStyle pozwalają na indywidualne określenie nazwy stylów dla: komórki nagłówka, komórek wartości, komórek wartości w wierszach parzystych, komórek wartości z niepoprawnym statusem danych.
ReportTableColumn AddColumn(string aHeaderText, string aFieldName, int aWidth, string aFormat = null, CellCallback aCallback = null, string aHeaderStyle = null, string aColumnStyle = null, string aColumnAltStyle = null);
Function AddColumn(ByVal aHeaderText As String, ByVal aFieldName As String, ByVal aWidth As Integer, ByVal aFormat As String = Nothing, ByVal aCallback As CellCalback = Nothing, ByVal aHeaderStyle As String = Nothing, ByVal aColumnStyle As String = Nothing, ByVal aColumnAltStyle As String = Nothing) As ReportTableColumn
Metoda służy do dodania kolumny do tabeli pionowej tworzonej na podstawie danych przekazanych w momencie tworzenia tabeli (poprzez obiekt typu DataTable lub ICollection).
Parametr aHeaderText określa tekst wyświetlany w linii nagłówka tabeli.
Parametry aFieldName określa nazwę elementu używanego przez kolumnę. Jest to nazwa kolumny w obiekcie typy DataTable lub nazwa właściwości obiektów przekazanych w kolekcji ICollection.
Parametr aWidth określa szerokość kolumny w milimetrach, a parametr aFormat sposób formatowania wartości wyświetlanych w komórkach kolumny.
Parametr aCallback pozwala na zadeklarowanie funkcji zwrotnej, która będzie wykonywana dla każdej komórki wartości w momencie generowania jej zawartości. Mechanizm ten pozwala na implementację własnej metody reakcji na błędy lub kontroli wartości zmiennych.
Opcjonalne parametry aHeaderStyle, aColumnStyle, aColumnAltStyle pozwalają na indywidualne określenie nazwy stylów dla: komórki nagłówka, komórek wartości, komórek wartości w wierszach parzystych.
ReportTableColumn AddRow(string aFirstColumnText, string aVarName, string aAggrName, string aFormat = null, ReportTableCellErrorBehavior aErrorMode = ReportTableCellErrorBehavior.Normal, CellCallback aCallback = null, string aFirstStyle = null, string aNextStyle = null, string aErrorStyle = null);
Function AddRow(ByVal aFirstColumnText As String, ByVal aVarName As String, ByVal aAggrName As String, ByVal aFormat As String = Nothing, ByVal aErrorMode As ReportTableCellErrorBehavior = ReportTableCellErrorBehavior.Normal, ByVal aCallback As CellCalback = Nothing, ByVal aFirstStyle As String = Nothing, ByVal aNextStyle As String = Nothing, ByVal aErrorStyle As String = Nothing) As ReportTableColumn
Metoda służy do dodania wiersza do tabeli poziomej tworzonej na podstawie danych archiwalnych zmiennych procesowych.
Parametr aFirstColumnText określa tekst wyświetlany w pierwszej kolumnie wiersza.
Parametry aVarName i aAggrName określają nazwę zmiennej procesowej oraz nazwę wyliczanego agregatu.
Parametr aFormat określa sposób formatowania wartości wyświetlanych w komórkach wiersza. Jeżeli parametr aFormat nie zostanie podany, to zostanie użyty atrybut formatu wartości pobrany z bazy definicji zmiennych.
Parametr aErrorMode określa sposób tworzenia zawartości komórek wartości, dla których brak danych lub ich status jest niepoprawny. Szczegóły użycia znajdują się w opisie metody AddColumn.
Parametr aCallback pozwala na zadeklarowanie funkcji zwrotnej, która będzie wykonywana dla każdej komórki wartości w momencie generowania jej zawartości. Szczegóły użycia znajdują się w opisie metody AddColumn.
Opcjonalne parametry aFirstStyle, aNextStyle, aErrorStyle pozwalają na indywidualne określenie nazwy stylów dla: komórek w pierwszej kolumnie wiersza, komórek w drugiej i następnych kolumnach wiersza, komórek wartości z niepoprawnym statusem danych.
ReportTableColumn AddRow(string aFirstColumnText, string aFieldName, string aFormat = null, CellCallback aCallback = null, string aFirstStyle = null, string aNextStyle = null);
Function AddRow(ByVal aFirstColumnText As String, ByVal aFieldName As String, ByVal aFormat As String = Nothing, ByVal aCallback As CellCalback = Nothing, ByVal aFirstStyle As String = Nothing, ByVal aNextStyle As String = Nothing) As ReportTableColumn
Metoda służy do dodania wiersza do tabeli poziomej tworzonej na podstawie danych przekazanych w momencie tworzenia tabeli (poprzez obiekt typu DataTable lub ICollection).
Metoda służy do dodania wiersza do tabeli poziomej tworzonej na podstawie danych archiwalnych zmiennych procesowych.
Parametr aFirstColumnText określa tekst wyświetlany w pierwszej kolumnie wiersza.
Parametry aVarName i aAggrName określają nazwę zmiennej procesowej oraz nazwę wyliczanego agregatu.
Parametry aFieldName określa nazwę elementu używanego w wierszu. Jest to nazwa kolumny w obiekcie typy DataTable lub nazwa właściwości obiektów przekazanych w kolekcji ICollection.
Parametr aFormat określa sposób formatowania wartości wyświetlanych w komórkach wiersza.
Parametr aCallback pozwala na zadeklarowanie funkcji zwrotnej, która będzie wykonywana dla każdej komórki wartości w momencie generowania jej zawartości. Szczegóły użycia znajdują się w opisie metody AddColumn.
Opcjonalne parametry aFirstStyle, aNextStyle pozwalają na indywidualne określenie nazwy stylów dla: komórek w pierwszej kolumnie wiersza, komórek w drugiej i następnych kolumnach wiersza.
void GenerateContent ();
Sub GenerateContent ()
Metoda służy do wygenerowanie kompletnej zawartości tabeli na podstawie dostępnych danych. Użycie metody nie jest obowiązkowe. Metoda Render klasy Report automatycznie wywołuje metodę GenerateContent dla wszystkich tabel, dla których metoda nie była jeszcze wykonana.
void LeftIndent(int aIndent);
Sub LeftIndent(ByVal aIndent As Integer)
Metoda pozwala przesunąć położenie całej tabeli w prawo o liczbę milimetrów podaną w parametrze aIndent.
void SetEdgeStyle(ReportTableEdgeType aEdgeType, MigraDoc.DocumentObjectModel.Color aColor);
Sub SetEdgeStyle(ByVal aEdgeType As ReportTableEdgeType, ByVal aColor As MigraDoc.DocumentObjectModel.Color)
Metoda służy do ustawienia sposobu rysowania krawędzi komórek tabeli. Parametr aEdgeType określa, które krawędzie należy rysować. Możliwe są poniższe wartości:
ReportTableEdgeStyle.None - brak krawędzi
ReportTableEdgeStyle.Outline - tylko zewnętrzne krawędzie tabeli
ReportTableEdgeStyle.Columns - krawędzie wokół kolumn
ReportTableEdgeStyle.Rows - krawędzie wokół wierszy
ReportTableEdgeStyle.Cell - krawędzie wokół każdej komórki
Parametr aColor określa kolor krawędzi. Określając kolor czcionki, można stosować predefiniowane kolory zdefiniowane w klasie MigraDoc.DocumentObjectModel.Colors (np. Colors.Orange).
void SetQueryData(DateTime aStartTime, DateTime aStartTime, string aAggrInterval);
Sub SetQueryData(ByVal aStartTime As Date, ByVal aEndTime As Date, ByVal aAggrInterval As String)
void SetQueryData(DateTime aStartTime, DateTime aStartTime, TimeSpan aAggrInterval);
Sub SetQueryData(ByVal aStartTime As Date, ByVal aEndTime As Date, ByVal aAggrInterval As System.TimeSpan)
Metoda określa parametry zapytania o dane w przypadku tabel tworzonych na podstawie odczytu danych archiwalnych zmiennych procesowych.
Parametry aStartTime i aEndTime określają czasy początku i końca zapytania o dane. Parametr aAggrInterval określa okres agregacji danych.
Zalecane jest stosowanie wersji z parametrem aAggrInterval w postaci tekstowej. Okres podawany jest w standardzie OPC, np. ”1D”, ”3H”. Tylko ta wersja metody rozwiązuje problemy z określeniem prawidłowego okresu czasu i przedziałów wartości w przypadku wykonywania zapytań obejmujących moment zmiany czasu zimowy-letni.