.. highlightlang:: us

.. index:: PageSaveAsBitmap

.. _pagesaveasbitmap:

PageSaveAsBitmap
================

.. us.tag  PageSaveAsBitmap GERMAN PageSet New300 Changed400 Changed6000

:ref:`PageSaveAsBitmap` erzeugt eine Bitmap-Datei einer Dokumentseite in 
verschiedenen Formaten.

.. function::  bool = PageSaveAsBitmap(hPage, ssFilename)
               bool = PageSaveAsBitmap(hPage, ssFilename, dpi)
               bool = PageSaveAsBitmap(hPage, ssFilename, dpi, quality, nClip)

.. us.return

**Returnwert**

*bool* ist TRUE (1), wenn die Funktion erfolgreich war und sonst FALSE (0).

.. us.params

**Parameter**

.. uparam:: hPage

   *hPage* ist die Zugriffsnummer (Handle) der Seite.

.. uparam:: ssFilename

   *ssFilename* ist der vollständige Dateiname unter der die Datei gespeichert
   werden soll. Das Dateiformat wird aus der Datei-Extension bestimmt.

   .. list-table::
      :header-rows: 1

      * - Extension
        - Bedeutung
      * - ``.png``
        - 
      * - ``.jpg``
        - 
      * - ``.tif``
        - 
      * - ``.gif``
        - 
      * - ``.bmp``
        - 
      * - ``.bmz``
        - 

.. uparam:: dpi

   Ist ein Wert zwischen 96 und 3000 und gibt die dots per inch (dpi) an. 1 inch 
   gleich 2.54 cm. Typische Werte sind 150 (für Bildschirmausgabe), 300, 600 für 
   Drucker, 1200, 1440 für Fotodrucker.

.. uparam:: quality

   Wird nur bei Jpeg verwendet: 0 bis 100. Typische Werte Norrmal = 75, 
   Low = 25, High = 100.

.. uparam:: nClip

   Legt fest, wie die Größe der Seite berechnet wird.

   .. list-table::
      :header-rows: 1

      * - Wert
        - Beschreibung
      * - 0
        - Boundig Box: Größtes Rechteck, das alle Elemente der Seite umschließt.
          (Default Wert)
      * - 1
        - Boundig Box: Größtes Rechteck. Das Rechteck wird an den Seitengrenzen
          abgeschnitten.
      * - 2
        - Seitengröße.

.. us.history

**History**

.. list-table::
   :header-rows: 1

   * - Version
     - Beschreibung
   * - R2018
     - Bis zur Version R2018 konnten mit dieser Funktion nur bmp-, jpg- und
       png-Dateien in Bildschirmauflösung erzeugt werden. Für weitere Formate und
       andere Auslösungen konnte die Funktion :ref:`PageSaveAsBitmapEx` verwendet 
       werden. :ref:`PageSaveAsBitmapEx` ist nun nicht mehr erforderlich. 
   * - 5.30.9
     - Neuer Parameter *nClip*
   * - 4.0
     - Neu.

.. seealso::
   :ref:`uberblick-dokument-seiten`,
   :ref:`PageSaveAsMetafile`

:sub:`id-1214590`