.NET Framework Class Library
Document.CreatePreviewFile Method

<< Click to Display Table of Contents >>

Navigation:  MwPDMApi Namespace > Document Class > Document Methods >

.NET Framework Class Library
Document.CreatePreviewFile Method

Creates a preview file for the specified document

Namespace: MwPDMApi
Assembly:  MwPDMApi (in MwPDMApi.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

Visual Basic

Public Function CreatePreviewFile ( _

 uid As Integer, _
 imgExt As String, _
 Optional outputFolder As String = "" _
) As String

C#

public string CreatePreviewFile(

 int uid,
 string imgExt,
 string outputFolder = ""
)

Visual C++

public:

String^ CreatePreviewFile(
 int uid,
 String^ imgExt,
 String^ outputFolder = L""
)

JavaScript

function createPreviewFile(uid, imgExt, outputFolder);

Parameters

uid

Type: System.Int32
Unique ID of the document

imgExt

Type: System.String
Image extension of the preview file. Possible values are: BMP, JPG (or JPEG), TIF (or TIFF), DWG

outputFolder (Optional)

Type: System.String
Output folder where to save the preview file

Return Value

Full path of the created preview file, or an empty string if the operation failed

See Also

Document Class

Document Members

MwPDMApi Namespace