FileFormat
File formats.
| Full name | MFiles.FileFormat |
|---|---|
| Proto file | mfiles/enums.proto |
Values
| Name | Number | Description |
|---|---|---|
FILE_FORMAT_NATIVE | 0 | Native file format. |
FILE_FORMAT_PDF | 1 | PDF. |
FILE_FORMAT_DISPLAY_ONLY_PDF | 2 | PDF for display only (printing, copying, etc. disabled). |
FILE_FORMAT_PLAIN_TEXT | 3 | Plain text (e.g., for full-text indexing or text analytics purposes). |
FILE_FORMAT_MARKDOWN | 4 | Markdown (structured text, e.g., for AI/agent consumption). |
Used by methods
- IRPCIndexingDataSource.CacheFileForIndexing -- Writes a file version, in the requested format, to a temporary folder on the server computer and returns its local path.
- IRPCIndexingDataSource2.GetTextContentForFileForIX -- Gets the text that the server extracts from a file version for indexing, in the response.
- IRPCObjectOperations.DownloadFile -- Not available over native gRPC: the server answers "Not implemented.". Used by the M-Files HTTP gateway.
- IRPCObjectOperations.DownloadFileWithDownloadKey -- Not available over native gRPC: the server answers "Not implemented.". Used by the M-Files HTTP gateway.
- IRPCObjectOperations.DownloadFile_Begin -- Opens a download session for a file version and returns its ID, the content size and, on request, its MD5 checksum.
- IRPCObjectOperations.DownloadTempFileFromUpload_Begin -- Opens a download session for a committed upload, to read it back or as a PDF, without creating an object.
- IRPCObjectOperations.GetTextContentForFileWithFormat -- Gets the text content of a file version as plain text or Markdown, and reports which format was produced.
- IRPCObjectOperations.PrepareFile -- Prepares a PDF rendition of a file version and reports its size, extension and timestamp.
Used in fields
CacheFileForIndexingCollectiveResponseElement.file_format-- The actual file format received.CacheFileForIndexingElement.file_format-- Specifies the requested file format to cache.CacheFileForIndexingRequest.file_format-- Specifies the requested file format to cache.CacheFileForIndexingResponse.file_format-- The format actually produced, which can differ from the requested one.GetTextContentForFileForIXRequest.file_format--FILE_FORMAT_PLAIN_TEXTorFILE_FORMAT_MARKDOWN; unset (FILE_FORMAT_NATIVE) means plain text. A Markdown request falls back to plain text when the server cannot produce Markdown.GetTextContentForFileForIXResponse.file_format-- The format actually produced.PrepareFileRequest.fileformat--FILE_FORMAT_PDForFILE_FORMAT_DISPLAY_ONLY_PDF.DownloadFile_BeginRequest.format--FILE_FORMAT_NATIVE(default),FILE_FORMAT_PDForFILE_FORMAT_DISPLAY_ONLY_PDF.DownloadFileRequest.format-- Specifies the file format to download.DownloadFileWithDownloadKeyRequest.format-- Specifies the file format to download.DownloadTempFileFromUpload_BeginRequest.file_format--FILE_FORMAT_NATIVE(default) orFILE_FORMAT_PDF.GetTextContentForFileWithFormatRequest.requested_format--FILE_FORMAT_MARKDOWNorFILE_FORMAT_PLAIN_TEXT.GetTextContentForFileWithFormatResponse.format_produced-- The format oftext_content.