DocumentFormat Property

Defines the format of the Office document.

Syntax

 officeencryptor.getDocumentFormat([callback])

Possible Values

  0 (odfUnknown), 
  1 (odfBinary), 
  2 (odfOpenXML), 
  3 (odfOpenXPS), 
  4 (odfOpenDocument)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getDocumentFormat([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setDocumentFormat([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property contains the Office document format.

This property is read-only and not available at design time.

Data Type

Integer