Interface IPreview

All Superinterfaces:
AutoDeleteParameter, IDispatch, IUnknown
All Known Implementing Classes:
EloComServer

public interface IPreview
extends IDispatch

Überschrift: IPreview

Beschreibung: COM-Schnittstelle für die Dokumentenvorschau

Copyright: Copyright (c) ELO Digital Office GmbH 2007

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static String INTERFACE_IDENTIFIER
    IID für ComfyJ
  • Method Summary

    Modifier and Type Method Description
    void clear()
    Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Kein Dokument zur Ansicht ausgewählt." an.
    void deactivate()
    Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Dokument extern geöffnet, Preview deaktiviert." an.
    void displayLocalFile​(BStr filePath)
    Stellt die Dokumentenvorschau auf eine lokale Datei, z.B. aus der Postbox ein.
    void reactivate()
    Stellt das vor der Deaktivierung angezeigte Dokument wieder in die Dokumentenvorschau.
    void showId​(Int32 id)
    Stellt die Dokumentenvorschau auf eine neue ObjektId ein.

    Methods inherited from interface AutoDeleteParameter

    isAutoDelete, setAutoDelete

    Methods inherited from interface IDispatch

    getIDsOfNames, getTypeInfo, getTypeInfoCount, invoke

    Methods inherited from interface IUnknown

    addRef, isNull, queryInterface, release, setNull
  • Field Details

  • Method Details

    • showId

      void showId​(Int32 id)

      Stellt die Dokumentenvorschau auf eine neue ObjektId ein. Das Sord Objekt wird dann vom Indexserver gelesen und die Verschlagwortungsvorschau und die Dokumentenanzeige aktualisiert.

      Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv.

      Nachbedingung: Das Objekt mit der angegebenen ID wird angezeigt, falls vorhanden.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
       Elo.login
       Elo.showId 1198436
       
      Parameters:
      id - Objekt Id des Sord Objekts
    • displayLocalFile

      void displayLocalFile​(BStr filePath)

      Stellt die Dokumentenvorschau auf eine lokale Datei, z.B. aus der Postbox ein. Es wird geprüft, ob es zu dieser Datei eine ESW Verschlagwortungsdatei gibt, diese wird dann mit eingelesen und im Dokumentenvorschau Fenster angezeigt.

      Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv.

      Nachbedingung: Die Datei mit dem angegebenen Pfad wird angezeigt, falls vorhanden.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
       Elo.login
       Elo.displayLocalFile "C:/foo/bar/test.txt"
       
      Parameters:
      filePath - Pfad der Datei die angezeigt werden soll
    • deactivate

      void deactivate()

      Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Dokument extern geöffnet, Preview deaktiviert." an.

      Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv.

      Nachbedingung: Die Dokumentenvorschau ist gelöscht und zeigt die Meldung "Dokument extern geöffnet, Preview deaktiviert." an.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
       Elo.login
       Elo.deactivate
       
    • reactivate

      void reactivate()

      Stellt das vor der Deaktivierung angezeigte Dokument wieder in die Dokumentenvorschau.

      Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv. Die Methode deactivate() wurde aufgerufen.

      Nachbedingung: Das vor der Deaktivierung angezeigte Dokument wird in der Dokumentenvorschau angezeigt.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
       Elo.login
       Elo.showId 12345
       Elo.deactivate
       ...
       ...
       Elo.reactivate
       
    • clear

      void clear()

      Löscht die aktuelle Dokumentenvorschau und zeigt die Meldung "Kein Dokument zur Ansicht ausgewählt." an.

      Vorbedingung: Ein Login wurde durchgeführt bzw. die Methode login() wurde aufgerufen. Eine Workspace Ansicht ist aktiv.

      Nachbedingung: Die aktuelle Dokumentenvorschau wurde gelöscht. Die Meldung "Kein Dokument zur Ansicht ausgewählt." wird angezeigt.

      Beispiel mit Visual Basic:

       set Elo = CreateObject("elo.enterprise")
       Elo.login
       Elo.clear