Click or drag to resize

FileWriteOptions Properties

The FileWriteOptions type exposes the following members.

Properties
  NameDescription
Public propertyAllowUserInterfaceWithHeadlessDocument
If true, file writing plug-ins may show user interface (a dialog when SuppressDialogBoxes is false, command line getters when it is true) even though the document being written is headless.
Public propertyBackupFileFolder
For use on Apple frameworks only. Returns the final destination file name.
Public propertyCreateBackupFiles
Public propertyCreateOtherBackupFiles
Public propertyDestinationFileName
For use on Apple frameworks only. Returns the final destination file name.
Public propertyFileTypeId
Returns nil for a Rhino .3dm file or the GUID of the plugin that wrote the file
Public propertyFileTypeIndex
Returns the FileTypeIndex that identifies the extension the file writing plugin will create.
Public propertyFileTypeIs3dm
True if the file time is some version of a Rhino 3dm file.
Public propertyFileTypeIsComplete3dm
True if the the file type is the current 3dm file version and everything in the document will be saved.
Public propertyFileVersion
Public propertyIncludeBitmapTable
The file written should include the bitmap table if your File Writing Plug-in supports it.
Public propertyIncludeHistory
The file written should include history information if your File Writing Plug-In supports it.
Public propertyIncludePreviewImage
The file written should include a preview image if your File Writing Plug-in supports it.
Public propertyIncludeRenderMeshes
The file written should include the render meshes if your File Writing Plug-in supports it.
Public propertyOptionsDictionary
Additional read options.
Public propertyRhino3dmVersion
Returns the version of the saved Rhino file 0: The file type is non-3dm file identified by FileTypeId() and FileTypeIndex(). >= 2: The file type is a 3dm file and the number specifies the earliest version of Rhino that will be able to read the 3dm file.
Public propertyRhinoDoc
Source RhinoDoc that is being written
Public propertySuppressAllInput
Public propertySuppressDialogBoxes
If true, it means the command has been run with a '-', meaning you should not ask questions during writing. (no dialogs, no "getters", etc.)
Public propertyUpdateDocumentPath
If a complete, current version, 3dm file is successfully saved, then the name of the file will be used to update the document's default file path and title and document will be marked as not modified.
Public propertyUseCompression
Public propertyWriteAsTemplate
Write as template
Public propertyWriteGeometryOnly
If true, the file written should include only geometry File Writing Plug-in supports it.
Public propertyWriteSelectedObjectsOnly
If true, this command should export only the objects currently selected in the Rhino model.
Public propertyWriteUserData
If true, the file written should include User Data if your File Writing Plug-in supports it.
Public propertyXform
Top
See Also