Difference between revisions of "TruxtonFileType"

From truxwiki.com
Jump to navigation Jump to search
Line 1: Line 1:
This class lets you add to the <code>[FileType]</code> table in Truxton.
+
This class lets you add to the <code>[FileType]</code> table in Truxton from [https://www.python.org/ Python].
This is how you add your own file types to Truxton.
+
It is how you add your own file types to Truxton.
  
 
=Attributes and Methods=
 
=Attributes and Methods=

Revision as of 02:13, 5 April 2021

This class lets you add to the [FileType] table in Truxton from Python. It is how you add your own file types to Truxton.

Attributes and Methods

extension

The most common file name extension associated with this file type. Setting this value is optional. This corresponds to the [Extension] column of the [FileType] table.

id

An 16-bit integer value for the file type. Setting this value is optional. If you don't, one will be randomly chosen for you during the save() call. This corresponds to the [ID] column of the [FileType] table. The valid range of values is 11,000 through 32,767.

longname

A description of the file type. This corresponds to the [LongName] column of the [FileType] table. Setting this field is optional, if it is not set, the value of shortname will be used.

mimetype

The MIME type most commonly associated with the file type. This corresponds to the [MIME] column of the [FileType] table. Setting this field is optional, the default is application/octet-stream

parentid

An 16-bit integer value for the more generic type of this file type. Setting this value is optional. This corresponds to the [ParentFileTypeID] column of the [FileType] table. If you do set this value, it should appear in the [ID] column of the [FileType] table.

shortname

A short name for the file type. This corresponds to the [ShortName] column of the [FileType] table. Setting this value is mandatory.

save()

This will commit the information to the [FileType] table. It will return True if the record was saved to the database, False if there was an error.

Sample

import sys
sys.path.append('C:/Program Files/Truxton/SDK')
import truxton

def main():
  t = truxton.create()

  file_type = t.newfiletype()

  file_type.parentid = truxton.Type_XML
  file_type.shortname = "MyType"
  file_type.longname = "A custom file type derived from XML for demo purposes"
  file_type.extension = "xm2"
  file_type.mimetype = "text/xml"

  file_type.save()

  print( "ID is " + str(file_type.id))

if __name__ == "__main__":
  main()