It stores or references all file types (image, audio, video, pdf, excel, etc.), regardless of their format. The data can be stored locally or by using any external storage media.
The properties and methods are similar to those available for Image data type, Audio data type and Video data type.
| FileName |
Gets the file name (Character). It refers to the base name of the file, i.e. it does not return the extension. |
| FileType |
Gets the file Type. It indicates the extension of the file: txt, jpg, pdf, etc.
You should keep in mind that the extension is not the same as the ContentType. ContentType is an HTTP Header for the browser to interpret. For example: application/json, image/jpg, text/javascript, text/css.
In addition, you can programmatically set the ContentType based on the FileType. (e.g. If FileType="html" then ContentType="text/html"). |
| FileURI |
Sets/Gets the FileURI
Set:
You can set a relative path. It will be solved within the current host.
You can set a local path by using file:// protocol.
When you set the URI property, the internal binary file stored in the DB will be set to empty.
Example:
&Blobfile.FromURL(myFileWillbeErasedInNextLine)
&Blobfile.FileURI = "http://www.myfiles/file.pdf"
In this case, the .pdf file will be the file in the data.
Get:
It always returns the absolute URI to the file.
|
| FromURL(FileURL) |
It loads the current instance with the file given in parameter FileURL.
The internal binary holding the file is loaded from the FileURL indicated.
After calling this method, the URI property has the filename and extension of the FileURL specified.
For example:
&Blobfile.FromURL('www.myfiles.com/myfile.pdf')
msg(&Blobfile.FileURI) // will print myfile.pdf
|
| SetEmpty/IsEmpty |
|
The File can be loaded from a URI (local or remote) using the FromURL method. If the value passed to FromURL is a remote URL, then the file is downloaded (and saved to the DB if necessary).
If you simply want to have a reference to the file that is somewhere, remote or local, all you needto do is assign the URI property.
The BlobFile data type is automatically stored as more than one field in the DB (similar to the way in which Image data type, Audio data type and Video data type are stored).
The structure saved in the DB is the following:
- Attribute_Name (Binary is stored here)
- Attribute_Name_GXI (where the URI is stored) (GXI = GeneXus Identifier)
When the URI is assigned, Attribute_Name_GXI is assumed to be an external file (in this case the full URI is stored). If the file was loaded using the FromURL method, then the relative path is saved there (so the file name and type are known).
When a file is stored, the file name is stored in the GXI field as follows:
gxdbfile: <file name> _ <token>. <file extension>
The prefix "gxdbfile:" indicates to GeneXus that it is a file, and not a relative URL.
The token allows you to identify the file univocally. GeneXus generates a GUID.
The difference between Blob and BlobFile data types is the way in which they are stored in the database. As a result, BlobFile may be stored in any external storage, whereas Blob data type may not.
The following reorganizations are supported:
- From Blob to BlobFile -> The binary file is copied, and the GXI_Attribute_Name is obtained through the name of the original blob file.
- From Character to BlobFile -> The GXI_Attribute_Name is set from the character attribute.
- From BlobFile to Blob -> The GXI_Attribute_Name field is removed.
- From BlobFile to Character -> The field is assigned, if possible, using the GXI_Attribute_Name value. Otherwise, it's left empty.