5.2.2 Metody

 

 

AddChart

 

ReportChart AddChart(int aLeft, int aWidth, int aHeight,

MigraDoc.DocumentObjectModel.Color aLineColor, MigraDoc.DocumentObjectModel.Color

aFillColor);

 

ReportChart AddChart(intaLeft, int aWidth, intaHeight);

 

 

 

Function AddChart(ByVal aLeft As  Integer, ByVal aWidth As Integer, ByVal aHeight As Integer, ByVal aLineColor As MigraDoc.DocumentObjectModel.Color, ByVal aFillColor AsMigraDoc.DocumentObjectModel.Color) As ReportChart  

 

Function AddChart(ByVal aLeft As  Integer, ByVal aWidth As  Integer, ByVal aHeight As Integer) As ReportChart

 

 

Metoda dodaje do raportu wykres. Dane wyświetlanych na wykresie serii będą pochodziły z zapytania o dane archiwalne, którego parametry należy ustawić przy pomocy wywołania metody SetQueryData obiektu wykresu.

 

Parametr aLeft określa wyrażone w milimetrach przesunięcie całego wykresu w lewo. Parametry aWidth  i aHeight określają szerokość i wysokość obszaru zajmowanego przez wykres.

 

Parametr aLineColor określa kolor linii obramowania wykresu, a parametr aFillColor kolor wypełnienia tła wykresu.

 

Metoda zwraca obiekt utworzonego wykresu.

 

 

 

ReportChart AddChart(object aData, int aLeft, int aWidth, int aHeight,

MigraDoc.DocumentObjectModel.Color aLineColor, MigraDoc.DocumentObjectModel.Color  

aFillColor);

 

ReportChart AddChart(object aData, int aLeft, int aWidth, int aHeight);

 

 

Function AddChart(ByVal aData As  Object, ByVal aLeft As  Integer, ByVal aWidth As  Integer, ByVal aHeight As Integer, ByVal aLineColor As  MigraDoc.DocumentObjectModel.Color, ByVal aFillColor As MigraDoc.DocumentObjectModel.Color) As ReportChart

 

Function AddChart(ByVal aData As  Object, ByVal aLeft As  Integer, ByVal aWidth As  Integer, ByVal aHeight As Integer) As ReportChart

 

 

Metoda dodaje do raportu wykres, w którym wartości pokazywanych serii danych pochodzą z kolekcji przekazanej poprzez parametr aData. Obiekt danych serii musi być typu System.Collections.ICollection lub System.Data.DataTable.

Pozostałe parametry mają identyczne znaczenie, jak w przypadku metod tworzących wykres dla danych archiwalnych.

 

 

 

AddHorizontalTable

 

 

ReportTable AddHorizontalTable(bool aShowHeader, int aFirstWidth, int aNextWidth, string  aFirstHeader, string  aNextFormat);

ReportTable AddHorizontalTable(bool aShowHeader, int aFirstWidth, int aNextWidth, string  aFirstHeader, string  aNextFormat, string  aFirstStyle, string  aNextStyle);

 

 

Function AddHorizontalTable(ByVal aShowHeader As  Boolean, ByVal aFirstWidth As  Integer, ByVal aNextWidth As  Integer, ByVal aFirstHeader As  String, ByVal aNextFormat As  String) As ReportTable  

 

Function AddHorizontalTable(ByVal aShowHeader As  Boolean, ByVal aFirstWidth As  Integer, ByVal aNextWidth As  Integer, ByVal aFirstHeader As  String, ByVal aNextFormat As  String, ByVal aFirstStyle As  String, ByVal aNextStyle As  String) As ReportTable   

 

 

Metoda dodaje do raportu tabelę w układzie poziomym, w którym serie danych pokazane są w pojedynczych wierszach. Dane serii będą pochodziły z zapytania o dane archiwalne, którego parametry należy ustawić przy pomocy wywołania metody SetQueryData obiektu tabeli.

Parametr aShowHeader określa, czy tabela będzie posiadała wiersz nagłówka. Parametry aFirstWidth i aNextWidth określają szerokość kolumn (w milimetrach), odpowiednio: pierwszej i wszystkich kolejnych kolumn tabeli.

Parametr aFirstHeader określa tekst w pierwszej kolumnie wiersza nagłówka. Parametr aNextFormat określa sposób formatowania wartości w kolumnach linii nagłówka. W kolumnach linii nagłówka tabeli poziomej wyświetlane są czasy przyporządkowane do poszczególnych kolumn. Na przykład, format hh:mm powoduje wyświetlenie czasu w formacie godziny:minuty (np. 10:45).

Parametry  aFirstStyle i aNextStyle określają nazwy stylów stosowanych dla pierwszej i wszystkich kolejnych kolumn nagłówka. Jeżeli parametry nie zostaną podane, to stosowany jest standardowy styl nagłówka.

Metoda zwraca obiekt utworzonej tabeli.

 

 

ReportTable AddHorizontalTable(object aData, int aFirstWidth, int aNextWidth);

 

Function AddHorizontalTable(ByVal aData As  Object, ByVal aFirstWidth As  Integer, ByVal aNextWidth As  Integer )

 

 

Metoda dodaje do raportu tabelę w układzie poziomym, w którym serie danych pokazane są w pojedynczych wierszach. Dane serii przekazane są poprzez parametr aData. Obiekt danych serii musi być typu System.Collections.ICollection lub System.Data.DataTable.

 

Parametry aFirstWidth i aNextWidth określają szerokość kolumn (w milimetrach), odpowiednio: pierwszej i wszystkich kolejnych kolumn tabeli.

 

Metoda zwraca obiekt utworzonej tabeli.

 

 


 

AddImage

 

 

ReportImage AddImage(string  aImageName, MigraDoc.DocumentObjectModel.WrapStyle aWrap, MigraDoc.DocumentObjectModel.ShapePosition aLeft, MigraDoc.DocumentObjectModel.ShapePosition aTop);

ReportImage AddImage(string  aImageName, MigraDoc.DocumentObjectModel.WrapStyle aWrap, MigraDoc.DocumentObjectModel.ShapePosition aLeft);

ReportImage AddImage(string  aImageName, MigraDoc.DocumentObjectModel.WrapStyle aWrap, int  aLeft, int  aTop);

 

Function AddImage(ByVal aImageName As  String, aWrap As MigraDoc.DocumentObjectModel.WrapStyle , aLeft As MigraDoc.DocumentObjectModel.ShapePosition, aTop As MigraDoc.DocumentObjectModel.ShapePosition)  As ReportImage      

Function AddImage(ByVal aImageName As  String, aWrap As MigraDoc.DocumentObjectModel.WrapStyle, aLeft As MigraDoc.DocumentObjectModel.ShapePosition)  As ReportImage      

Function AddImage(ByVal aImageName As  String, aWrap As MigraDoc.DocumentObjectModel.WrapStyle, aLeft As Integer, aTop As Integer)  As ReportImage      

 

 

Metoda wstawia obrazek do treści raportu. Parametr aImageName określa nazwę pliku graficznego obrazka. Zalecane jest podawanie tylko nazwy pliku, bez podawania pełnej ścieżki dostępu. W takim przypadku zakłada się, że plik obrazka znajduje się w podkatalogu Addons katalogu definicyjnego aplikacji.

 

Parametr aWrap określa, w jaki sposób obrazek powinien być umieszczony między innymi elementami. Parametry aLeft  i aTop określają położenie obrazka, podawane jako stałe typu ShapePosition lub bezwzględnie w milimetrach.

 

Metoda zwraca obiekt wstawionego obrazka.

 

 

     


 

AddPageBreak

 

void AddPageBreak();

Sub AddPageBreak( )

 

 

Metoda służy do przejścia do kolejnej strony raportu.

 

 

 

 

 

AddParagraph

 

 

ReportParagraph AddParagraph(string  aContent);

ReportParagraph AddParagraph(string  aContent, string  aStyle);

Function AddParagraph(ByVal aContent As  String) As ReportParagraph      

Function AddParagraph(ByVal aContent As  String, ByVal aStyle As  String) As ReportParagraph    

 

 

 

Metoda wstawia paragraf tekstowy do treści raportu. Parametr aContent określa treść paragrafu, a parametr aStyle nazwę stylu użytego w paragrafie. Jeżeli styl nie jest podany, to stosowany jest styl domyślny (Normal).

 

Metoda zwraca obiekt utworzonego paragrafu. Korzystając z tego obiektu, można do paragrafu dodać dodatkowy tekst lub pola specjalne.

 

 

 

 

 

AddVerticalTable

 

 

ReportTable AddVerticalTable(bool aShowHeader);

Function AddVerticalTable(ByVal aShowHeader As  Boolean) As ReportTable       

 

Metoda dodaje do raportu tabelę w układzie pionowym, w którym serie danych pokazane są w kolumnach. Dane serii będą pochodziły z zapytania o dane archiwalne, którego parametry należy ustawić przy pomocy wywołania metody SetQueryData obiektu tabeli.

 

Parametr aShowHeader określa, czy tabela będzie posiadała wiersz nagłówka.

 

Metoda zwraca obiekt utworzonej tabeli.

 

 

ReportTable AddVerticalTable(object aData, bool aShowHeader);

Function AddVerticalTable(ByVal aData As  Object, ByVal aShowHeader As  Boolean) As ReportTable     

 

 

Metoda dodaje do raportu tabelę w układzie pionowym, w którym serie danych pokazane są w kolumnach. Dane serii przekazane są poprzez parametr aData. Obiekt danych serii musi być typu System.Collections.ICollection lub System.Data.DataTable.

 

Parametr aShowHeader określa, czy tabela będzie posiadała wiersz nagłówka.

 

Metoda zwraca obiekt utworzonej tabeli.

 

 

 

NewSection

 

void NewSection();

 Sub NewSection()

Rozpoczyna nową sekcję dokumentu.

 

 

 

Render

 

 

  void Render(string  aOutputFileName)

 Sub Render(ByVal aOutputFileName As  String)

 

 

Metoda służy do wygenerowania treści raportu i zapisania go do pliku o nazwie określonej przez parametr aOutputFileName. Raport jest tworzony w formacie PDF.

 

 

 

 

 

SetPageSetup

 

 

void SetPageSetup(int aLeftMargin, int aRightMargin, int aTopMargin, int aBottomMargin, int aHeaderDistance, int aFooterDistance);

Sub SetPageSetup(ByVal aLeftMargin As  Integer, ByVal aRightMargin As  Integer, ByVal aTopMargin As  Integer, ByVal aBottomMargin As  Integer, ByVal aHeaderDistance As  Integer, ByVal aFooterDistance As  Integer ) 

 

Metoda ustawia parametry strony raportu poprzez określenie wielkości marginesów, oraz odległości nagłówka i stopki od krawędzi strony. Wszystkie argumenty podawane są w milimetrach.

 

 

void SetPageSetup(bool aLandscapeOrientation, MigraDoc.DocumentObjectModel.PageFormat aFormat);

Sub SetPageSetup(ByVal aLandscapeOrientation As  Boolean, ByVal aFormat As MigraDoc.DocumentObjectModel.PageFormat ) 

 

Metoda ustawia parametry strony raportu poprzez określenie orientacji oraz formatu strony. Wartość true parametru aLandscapeOrientation oznacza poziome ułożenie strony.

 

Przykład:

report.SetPageSetup(true, PageFormat.A4)

 

Powyższe wywołanie wybiera stronę w formacie A4 i orientacji poziomej.

 

 

 

SetSectionPageSetup

 

void SetSectionPageSetup(Int32 aLeftMargin, Int32 aRightMargin, Int32 aTopMargin, Int32 aBottomMargin, Int32 aHeaderDistance, Int32 aFooterDistance);

 Sub SetSectionPageSetup(aLeftMargin As Int32, aRightMargin As Int32, aTopMargin As Int32, aBottomMargin As Int32, aHeaderDistance As Int32, aFooterDistance As Int32)

Pozwala ustawić format sekcji raportu.

 

 

 

SetStyle

 

ReportStyle SetStyle(string aName, string aFontName, double aFontSize,

MigraDoc.DocumentObjectModel.Color aFontColor, boolaBold, boolaItalic,

MigraDoc.DocumentObjectModel.ParagraphAlignment aAlignment,

MigraDoc.DocumentObjectModel.Color aShaderColor);

 

Function SetStyle(ByVal aName As String, ByVal aFontName As  String, ByVal aFontSize As

Double, ByVal aFontColor As  MigraDoc.DocumentObjectModel.Color, ByVal aBold As  

Boolean, ByVal aIatlic As  Boolean, ByVal aAlignment As  

MigraDoc.DocumentObjectModel.ParagraphAlignment, ByVal aShaderColor As  

MigraDoc.DocumentObjectModel.Color) As ReportStyle      

 

 

Metoda służy do zdefiniowania stylu, który może być później użyty przy tworzeniu elementów raportu.

 

Parametr aName określa nazwę stylu. Można używać nazw predefiniowanych, zdefiniowanych w klasie ReportStyleStandardNames lub dowolnych własnych nazw. Style o nazwach predefiniowanych mają z góry określone znaczenie i po ich utworzeniu są automatycznie używane przy konstruowaniu odpowiednich elementów raportu.

 

Parametr aFontName określa nazwę stylu czcionki, aFontSize rozmiar czcionki w punktach,  aFontColor kolor czcionki, aBold pozwala wybrać czcionkę pogrubioną, a aItalic wybiera czcionkę pochyloną. Określając kolor czcionki można stosować predefiniowane kolory zdefiniowane w klasie MigraDoc.DocumentObjectModel.Colors (np. Colors.Orange).

  

Parametr aAlignment określa sposób pozycjonowania tekstu w ramach elementu, w którym tekst został umieszczony (np. wewnątrz paragrafu).

 

Parametr aShaderColor określa kolor tła elementu, dla którego styl zostanie zastosowany. Dla tła przeźroczystego (pustego) należy podać stałą Color.Empty.

 

Metoda zwraca obiekt utworzonego stylu.