GetPreviewOfEntities Method (IApplication)

GetPreviewOfEntities Method (IApplication) | Send Feedback
See Also

RetVal[out]
  True if the preview bitmap is created, false if not

EntitiesArray
  Array of entities for the preview bitmap

Format
  Format of the preview bitmap as defined in dsBitmapFormat_e

PreviewRange
  Preview bitmap range as defined in dsPreviewRange_e

NamedView
  Name of the view if PreviewRange is set to dsPreviewRange_NamedView

WinMin
  Corner of the window area if PreviewRange is set to dsPreviewRange_SpecifyWindow; otherwise, a null value

WinMax
  Opposite corner of the window area if PreviewRange is set to dsPreviewRange_SpecifyWindow; otherwise, a null value

Width
  Width of the preview bitmap

Height
  Height of the preview bitmap

BitmapByteArray[out]
  Byte array of the preview bitmap

Creates a preview bitmap of the specified entities and returns a byte array of the bitmap.

# Syntax

Visual Basic |
--- | ---
    Function GetPreviewOfEntities( _
       ByVal EntitiesArray As System.Object, _
       ByVal Format As dsBitmapFormat_e, _
       ByVal PreviewRange As dsPreviewRange_e, _
       ByVal NamedView As System.String, _
       ByVal WinMin As MathPoint, _
       ByVal WinMax As MathPoint, _
       ByVal Width As System.Integer, _
       ByVal Height As System.Integer, _
       ByRef BitmapByteArray As System.Object _
    ) As System.Boolean

C# |
--- | ---
    System.bool GetPreviewOfEntities(
       System.object EntitiesArray,
       dsBitmapFormat_e Format,
       dsPreviewRange_e PreviewRange,
       System.string NamedView,
       MathPoint WinMin,
       MathPoint WinMax,
       System.int Width,
       System.int Height,
       out System.object BitmapByteArray
    )

JavaScript |
--- | ---
    GetPreviewOfEntities(
       EntitiesArray : Array,
       Format : String,
       PreviewRange : String,
       NamedView : String,
       WinMin : dsMathPoint,
       WinMax : dsMathPoint,
       Width : Number,
       Height : Number
    ) : {
       BitmapByteArray : Array,
       RetVal : Boolean
    }

COM native C++ |
--- | ---
    HRESULT GetPreviewOfEntities(
       VARIANT EntitiesArray,
       dsBitmapFormat_e Format,
       dsPreviewRange_e PreviewRange,
       BSTR NamedView,
       IMathPoint* WinMin,
       IMathPoint* WinMax,
       LONG Width,
       LONG Height,
       VARIANT* BitmapByteArray,
       VARIANT_BOOL* RetVal
    )

C++ |
--- | ---
    DSRESULT GetPreviewOfEntities(
       const dsObjectPtrArray& EntitiesArray,
       dsBitmapFormat_e Format,
       dsPreviewRange_e PreviewRange,
       const dsString& NamedView,
       dsMathPoint* WinMin,
       dsMathPoint* WinMax,
       long Width,
       long Height,
       dsByteArray* BitmapByteArray,
       bool* RetVal
    )

#### Parameters

EntitiesArray
  Array of entities for the preview bitmap
Format
  Format of the preview bitmap as defined in dsBitmapFormat_e
PreviewRange
  Preview bitmap range as defined in dsPreviewRange_e
NamedView
  Name of the view if PreviewRange is set to dsPreviewRange_NamedView
WinMin
  Corner of the window area if PreviewRange is set to dsPreviewRange_SpecifyWindow; otherwise, a null value
WinMax
  Opposite corner of the window area if PreviewRange is set to dsPreviewRange_SpecifyWindow; otherwise, a null value
Width
  Width of the preview bitmap
Height
  Height of the preview bitmap
BitmapByteArray[out]
  Byte array of the preview bitmap
RetVal[out] or Return Value
  True if the preview bitmap is created, false if not

# See Also

####

IApplication Interface
IApplication Members
IApplication::GetPreviewBitmap Method ()
IApplication::GetPreviewBitmapBytes Method ()
IApplication::GetPreviewBitmapFile Method ()

# Availability

DraftSight V1R4.0