TeamWiSE.CTV.ctvEnv

Dieser Klasse bietet Zugriff auf einige Funktionen der CTV Engine

TeamWiSE.CTV.Document CreateDocument(string sAppl, string sType, string sModl, string sBundle)

Erstellt ein neues Dokument gemäß den angegebenen Vorgaben.

bool SelectDocument(Document doc, bool bSelect)

Selektiert oder deselektiert das gegebene Dokument.

bool SelectBundle(string sBundle, bool bSelect)

Selektiert oder deselektiert alle derzeit bekannten Dokumente die zum angegebenen Bündel gehören.

bool SelectAllDocuments(bool bSelect)

Selektiert oder deselektiert alle derzeit bekannten Dokumente.

bool SelectDocuments()

Selektiert und deselektiert Dokumente gemäß der vorgenommenen Markierung im CTV-Objekt.

bool RemoveSelectedDocuments()

Verwirft alle derzeit selektierten Dokumente.

TeamWiSE.CTV.Document CombineSelectedDocuments(string sName, string sDescription)

Kombiniert alle derzeit selektierten Dokumente in ein neues Dokument.

bool Evaluate(bool bAlways)
bool Evaluate()

Evaluiert die derzeit selektierten Dokumente neu, auf Wunsch auch dann, wenn nicht unbedingt nötig.

bool Print()

Druckt die derzeit selektierten Dokumente gemäß der aktuellen Einstellungen aus.

string LastPrintError [ get ]

Falls der Print False zurück liefert, steht hier eine Beschreibung mit mehr Infomationen zu den Fehler. Eine Übersicht mit mögliche Fehlermeldungen gibt es hier.

string PDFBundleURL()

Liefert URL zurück der auf ein Temporär erstellten Bundle von alle selektierten Dokumenten in ein PDF-Dokument dargestellt werden. Die auf diese Art erstellten PDF-Dateien werden weder automatisch aufgeräumt, noch archiviert. Die Dateien werden in das Verzeichnis gestellt, das im Config-Abschnitt der TAA-Registry mit TempURLDir angegeben wurde. Die konstruierte URL wird aus dem Dateinamen mit einem vorangestellten Base erstellt. Der Base wird aus dem Eintrag TempURLBase aus dem Config-Abschnitt der TAA-Registry ermittelt. Es versteht sich, dass die Einträge so gestaltet sein sollten, dass die beiden Angaben zu der physisch gleichen Datei führen.

string PDFBundleFile()

Liefert Dateiname zurück der auf ein Temporär erstelltes PDF-Dokument mit hier drin alle selektierte Dokumente. Diese Datei wird beim Beenden der CTV-Engine automatisch gelöscht.

Format1:

TeamWiSE.CTV.Document AddDocument ( System.String sFile , System.String sName , System.String sBundle )

Format2:

TeamWiSE.CTV.Document AddDocument ( System.String sType , System.String sName , System.String sBundle , byte[] Bytes )

Format3: (ab TAA 8.16)

TeamWiSE.CTV.Document AddDocument ( System.String sType , System.String sName , System.String sBundle , Stream DataStream )

Format1 fügt ein unter dem angegebenen Pfadnamen gespeichertes Dokument zu der Schriftgut-Sammlung hinzu. Der Typ des Dokuments wird dabei aus dem Suffix des Dateinamens abgeleitet.

Format2 und Format 3 fügen ein Dokument des angegebenen Typs zu der Schriftgut-Sammlung hinzu; der Inhalt des Dokuments wird hier nicht wie bei Format 1 aus einer Datei gelesen, sondern als Bytes (Format 2) oder Stream (Format 3) übergeben. Hierfür ist zusätzlich die Angabe notwendig, von welchem Typ der Inhalt ist, um eine korrekte Interpretation des Dokumentinhalts zu ermöglichen. Der Typ wird definiert durch den Suffix, den Dokumente des betreffenden Typs üblicherweise haben, z.B. „rtf“, „xml“, „doc“.

Es ist nicht möglich, einmal hinzugefügte Dokumente zu entfernen; es ist lediglich möglich, sie zu deselektieren.

TeamWiSE.CTV.Documents Documents ( )

Liefert die Liste aller Dokuments (Klasse Documents), die zu dem Zeitpunkt in der Schriftgut-Sammlung enthalten sind.

Die einzelnen Dokumente aus dieser Liste können dann wie folgt angesprochen werden:

TeamWiSE.CTV.Documents MyDocs = MyCTV.Documents();
 
TeamWiSE.CTV.Document  MyDoc  = MyDocs["BRIEF1"];

string TeamWiSE.CTV.LocalPrinterSelect()

Zeigt Dialog mit Auswahl an zur Verfügung stehende Dezentrale Drucker (Nutzt AF-Drucksteuerung). Gibt selektierten Drucker zurück wenn ein Drucker ausgewählt wurde.

string TeamWiSE.CTV.LocalPrinter [get, set]

Eigenschaft um Dezentrale Drucker abzufragen oder zu setzen.

String Tag [ get, set ]

Erlaubt die Abfrage und auch Ablage eines frei definierbaren Strings assoziiert mit der aktuellen CTV-Engine.

bool AllDocumentsApproved [ get, set ]

Gibt an, ob alle in der Engine selektierten Dokumente fachlich freigegeben wurden.

bool ContainsDocumentWithMissingRequiredSelection [ get ]

Gibt an, ob es in der Engine selektierte Dokumente gibt, für die eine notwendige Selektion fehlt.