Difference between revisions of "TruxtonFileType"
| Line 36: | Line 36: | ||
Setting this value is mandatory. | Setting this value is mandatory. | ||
| − | ==<code>save() -> | + | ==<code>save() -> boolean</code>== |
This will commit the information to the <code>[FileType]</code> table. | This will commit the information to the <code>[FileType]</code> table. | ||
It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error. | It will return [https://docs.python.org/3/library/constants.html#True True] if the record was saved to the database, [https://docs.python.org/3/library/constants.html#False False] if there was an error. | ||
Revision as of 17:00, 16 September 2022
This class lets you add to the [FileType] table in Truxton from Python.
It is how you add your own file types to Truxton.
Contents
Attributes and Methods
extension: str
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: int
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: str
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: str
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: int
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: str
A short name for the file type.
This corresponds to the [ShortName] column of the [FileType] table.
Setting this value is mandatory.
save() -> boolean
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()