Anhand der Klasse CTV.Document können Eigenschaften eines im Schriftgut enthaltenen Dokuments gesetzt und abgefragt werden.

Alle nachfolgend beschriebenen Eigenschaften und Methoden gehören zu dieser Klasse.

  bool ArgumentSet(string sName, TAAObject hObj)
  bool ArgumentSet(string sName, TAAObject hObj, bool bByValue)

Bestückt das benannte Argument (Parameterobjekt) des Dokuments mit den Daten des übergebenen Objekts.

  String Name [ get ]

Liefert den Namen des Dokuments.

  String Type [ get ]

Liefert den CTV-Typ des Dokuments.

  String Appl [ get ]

Liefert den Namen der Anwendung, zu der das Dokument gehört.

  String Tag [ get, set ]
  
  string UserData [ get, set ]

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

  TeamWiSE.CTV.Documents Documents ( )

Liefert eine Auflistung von allen Schriftgutobjekten, aus denen das aktuelle Dokument besteht. Die einzelnen Objekte sind Instanzen der Klasse Document.

  String DisplayName[ get ]

Liefert eine garantiert nicht-leere, ggf. technische Überschrift des Dokumentes.

  uint Handle [ get]

Liefert den Schriftgut-Handle.

  uint ID [ get]

Liefert eine eindeutige numerische ID des Dokumentes. Die ID ist nur innerhalb der instanziierten CTV-Engine eindeutig.

  bool IsCombined [ get]

Gibt an, ob es sich bei dem Dokument um eine Zusammenfügung mehrerer Dokumente handelt (Schriftsatz).

  bool IsDirty [ get]

Gibt an, ob es seit der letzten Auswertung des Dokuments Änderungen gab, durch die eine Neuauswertung notwendig wurde.

  bool IsDocument [ get]

Gibt an, ob es sich um ein „echtes“, druckbares Dokument handelt.

  bool IsDynamic [ get]

Gibt an, ob es sich um ein dynamisches Dokument handelt (Default, z.B. Typ SSTK, SSBS), im Gegensatz zu Dokumenten mit festem Text (Typ SSTF).

  bool IsEvaluated [ get]

Gibt an, ob das Dokument bereits ausgewertet wurde.

  bool IsImmutable [ get]

Gibt an, ob das Dokument veränderbar ist. Dokumente, die als Anhang eines Start-Requests empfangen wurden, sind immer unveränderbar.

  bool IsLocked [ get]

Gibt an, ob das An- oder Abwählen des Dokumentes geschützt ist.

  bool IsSelected [ get, set ]

Über diese Eigenschaft können Sie bestimmen oder abfragen, ob ein Dokument, das in der Schriftgut-Sammlung enthalten ist, bei der Auswertung (z.B. für Druck) oder bei der Übergabe des Schriftguts an einen Start-Request berücksichtigt werden soll oder nicht.

  System.Int32 PageCount ( )

Ermittelt die Anzahl Seiten, die dieses Dokument lang wäre, wenn es zum aktuellen Zeitpunkt gedruckt würde.

  System.String PDFFile ( )

Liefert den Namen der PDF-Datei für dieses Dokument. Wenn noch keine PDF-Datei vorhanden ist, und das Dokument im PDF-Format vorliegt, wird eine temporäre PDF-Datei erstellt.

  String RichText [ get ]

Liefert - falls vorhanden - den Inhalt des Dokuments als String im RTF-Format.

  String PDFURL [ get ]
  
  String RTFURL [ get ]

Diese Methoden stehen nur dann zur Verfügung, wenn IsDocument=true. Die Methoden liefern eine URL, unter der das aktuelle Dokument im PDF/RTF-Format abgerufen werden kann. In der Version 7.05 wird die PDF/RTF-Datei für das aktuelle Dokument sofort erstellt und zum Abruf in ein Web gestellt. Die auf diese Art erstellten PDF/RTF-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.

In einem späteren Release soll die verzögerte Dokumenterstellung realisiert werden. Dann soll bei Abfrage dieser Eigenschaft ein PDF/RTF-Abruf-Auftrag für das aktuelle Dokument in der Druckauftragsdatenbank eingestellt werden und eine ISAPI-Methode für den Abruf des formatierten Dokuments realisiert werden. Damit kann dann ein dedizierter Server für die PDF/RTF-Erstellung konfiguriert werden und wird auch erst dann Aufwand zur Erstellung der PDF/RTF-Daten geleistet, wenn diese Daten wirklich verlangt/gebraucht werden. Vor allem die PDF-Erstellung ist, wegen der Nutzung von Office-Komponenten im Batchmodus, kritisch.