CIB CoMod.NET wrapper technischer Leitfaden

1. Lieferumfang

2. Einführung

Dieser Leitfaden bietet eine kompakte Übersicht über verschiedene Möglichkeiten, um aus .Net die CIB office Module (CoMod) in Ihre Anwendungen zu integrieren. Dabei werden, aufbauend auf beispielhaften Anwendungsarchitekturen, praxisnahe Einsatzszenarien für die CIB office Module in .Net-Anwendungen aufgezeigt. Der Schwerpunkt bei den beschriebenen Einsatzszenarien auf dem Server liegt auf den CoMod-Komponenten ohne Benutzeroberfläche, während die Client-Einsatzszenarien die Integration der oberflächenbasierten CoMod-Komponenten demonstrieren.

Der .Net CIB office Module Wrapper (CoMod.Net) besteht aus .Net-Klassen zur Ansteuerung der CIB office Module (CIB merge, CIB format inkl. output [ascii, html, pcl, pdf, postscript, print, tiff], CIB dialog, CIB view und CIB rec). Das Paket umfasst einzelne Jobklassen, die je einen Job (merge, format/output, view, dialog oder rec) nach Wünschen des Anwenders konfigurieren und ausführen.

Die CoMod.net Jobklassen sind ab Framework 2.0 einsetzbar.

Die vorliegende Dokumentation gibt einen Überblick über die Eigenschaften und das Konzept der CoMod Jobklassen. Detaillierte technische Schnittstellen und Aufrufparameter der einzelnen Jobklassen entnehmen Sie der technischen Referenz des Produkts.

3. Schneller Einstieg

Dieses Kapitel zeigt Ihnen mit kleineren CoMod.Net Codebeispielen verschiedenste Anwendungsfälle zur Nutzung der CIB office Module.

Die ausführliche Beschreibung der technischen Schnittstellen entnehmen Sie bitte den technischen Leitfäden der einzelnen CIB office Module. Damit Sie in VisualStudio im ObjectBrowser sowie bei AutoCompletion die Beschreibung der Methoden angezeigt bekommen, müssen die mitgelieferten XML-Dateien im gleichen Verzeichnis wie die DLL-Dateien liegen

3.1. Abstraktes CoMod.Net Wrapper-Beispiel (C#)

Prinzipielle Vorgehensweise (am Beispiel CibFormat)

• Verweis zu benötigtem Wrapper im Projekt hinzufügen
• Verweis hinzufügen, ComodNet.dll auswählen
• Using Anweisung de.cib.comod und ev. de.cib.comod.native hinzufügen

using de.cib.comod;
usingde.cib.comod.native;

• Neue Instanz der Klasse WrapperKlasse anlegen

CibFormat format = new CibFormat();

• Eigenschaften setzen

format.SetProperty("Eigenschaft","Wert");

• Ausführen

format.Load();
format.Save();

3.2. Abstraktes CoMod.Net Wrapper-Beispiel (VB.net)

Prinzipielle Vorgehensweise (am Beispiel CibFormat)

• Verweis zu benötigtem Wrapper im Projekt hinzufügen
• Verweis hinzufügen, ComodNet.dll auswählen
• Using Anweisung de.cib.comod und ev. de.cib.comod.native hinzufügen

Imports de.cib.comod
Imports de.cib.comod.native

• Neue Instanz der Klasse WrapperKlasse anlegen

Dim format As New CibFormat

• Eigenschaften setzen

format.SetProperty("Eigenschaft","Wert")

• Ausführen

format.Load()
format.Save()

3.3. CoMod.Net Wrapper-Beispiel für CIB format (C#):

Das nachfolgende Beispiel benutzt die CIB format Komponente um ein RTF Wurzeldokument in ein PDF zu konvertieren.

using System;
using System.Text;
using de.cib.comod;
using de.cib.comod.native;
 
namespace de.cib.comod.sample.native
{
    Class TestFormatStep
    {
public static string m_workingDir = @".\..\..\..\";
 
    static void main(String[] args){
      private static void TestFormatStep()
    {
            Console.WriteLine("Testing CIB format step.");
      try
    {
    CibFormat format = new CibFormat();
 
    //General example of how to get the version of CIB format library
    //UInt32 version = format.GetVersion();
 
    //General example of how to get the version text of CIB format library
    String formatVersionText = format.GetVersionText();
    Console.WriteLine("Version: " + formatVersionText);
    format.ClearProperties();
    format.SetProperty("TraceFilename", m_workingDir + "format.log");
    format.SetProperty("InputFilename", m_workingDir + "out.rtf");
    format.SetProperty("OutputFilename", m_workingDir + "out.pdf");
    format.SetProperty("OutputFormat", "FormatPdf");
 
    //General example of how to load a file into internal data structure
    //of CIB format library
    format.Load();
    format.Save();
    }
    catch (Exception e)
    {     
       Console.WriteLine("CIB format error:'{0}'", e);
    }
   }
  }
 }

3.4. CoMod.Net Wrapper-Beispiel für CIB pdf toolbox (C#):

using System;
using System.Text;
using de.cib.comod;
using de.cib.comod.native;

namespace de.cib.comod.sample.native
{
    Class TestPdfToolboxStep
    {
public static string m_workingDir = @".\..\..\..\";

    static void main(String[] args)
{
 	private static void TestPdfToolboxStep()
{
Console.WriteLine("Testing CIB pdf toolbox step.");
    try
    {

    //Load library
    CibPdfToolbox pdfToolboxStep = new CibPdfToolbox();

    //Get version
    String pdfToolboxVersion = pdfToolboxStep.GetVersionText();
    Console.WriteLine("Version: " + pdfToolboxVersion);

    //CIB pdf toolbox: Join step
    pdfToolbox.ClearProperties();
pdfToolbox.SetProperty(ICibPdfToolbox.Property_TraceFilename, m_workingDir + "toolbox.log");
pdfToolbox.SetProperty(ICibPdfToolbox.Property_InputFilename, m_workingDir + "out.pdf;" + m_workingDir + "out.pdf");
pdfToolbox.SetProperty(ICibPdfToolbox.Property_OutputFilename, m_workingDir + "final_out.pdf");
pdfToolbox.SetProperty(ICibPdfToolbox.Property_LicenseCompany, "Master");
pdfToolbox.SetProperty(ICibPdfToolbox.Property_LicenseKey, "acaa-c09f-43cc4ecd");

pdfToolbox.Join();
    }
catch (Exception e)
{
Console.WriteLine("CIB pdf toolbox error:'{0}'", e);
        }
       }
      }
    }

3.5. CoMod.Net Wrapper-Beispiel für CIB view (C#):

Das nachfolgende Beispiel benutzt die Komponente CIB view zum Anzeigen eines RTF-Dokumentes.

using System;
using System.Text;
using de.cib.comod;
using de.cib.comod.native;

namespace de.cib.comod.sample.native
{
    class Test
    {
        Public void main(){
        CibView view = new CibView();
        //set input file
        view.SetProperty("CVWInputFilename", rtfFile);
        //set window handle
        view.SetProperty("CVWParentHwnd", panel1.Handle.ToInt32());
        //reset
        view.SetProperty("CVWOwnerHwnd", 0);
        view.SetProperty("CVWUseModalWindow", "0");
        //start view
        view.View();
        }
    }
}

3.6. CoMod.Net Wrapper-Beispiel für CIB dialog browser(C#):

Das nachfolgende Beispiel benutzt die Komponente CIB dialog zum Anzeigen und Bearbeiten einer HTML-Seite mit Regelwerk und CSV-Dateien.

using de.cib.comod;

public void doDialog()
{
    browser = dialog.NewBrowser();
    dialog.SetDGWorkSpace(browser, workSpace);
    dialog.LoadHtml(browser, panel1.Handle.ToInt32(), htmlFile, rulFile, 0, 0);
    //start cib dialog
    int bufferSize = 256;
    StringBuilder buttonName = new StringBuilder(bufferSize);
    dialog.DoModal(browser, buttonName, bufferSize-1);
}