FileWriteOptions

References
public class FileWriteOptions : IDisposable

Constructors

FileWriteOptions

#Since v5.0
public FileWriteOptions()

Finalizer

~FileWriteOptions

#
~FileWriteOptions()

Properties

AllowUserInterfaceWithHeadlessDocument

#Since v9.0
public bool AllowUserInterfaceWithHeadlessDocument { get; set; }
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.
Remarks: Added 2026-07-10 by wfcook for RH-95100

BackupFileFolder

#Since v6.3
public string BackupFileFolder { get; set; }
For use on Apple frameworks only. Returns the final destination file name.

CreateBackupFiles

#Since v9.0
public bool CreateBackupFiles { get; set; }

CreateOtherBackupFiles

#Since v9.0
public bool CreateOtherBackupFiles { get; set; }

DestinationFileName

#Since v6.3
public string DestinationFileName { get; }
For use on Apple frameworks only. Returns the final destination file name.

FileTypeId

#Since v9.0
public Guid FileTypeId { get; }
Returns nil for a Rhino .3dm file or the GUID of the plugin that wrote the file

FileTypeIndex

#Since v9.0
public int FileTypeIndex { get; }
Returns the FileTypeIndex that identifies the extension the file writing plugin will create.

FileTypeIs3dm

#Since v9.0
public bool FileTypeIs3dm { get; }
True if the file time is some version of a Rhino 3dm file.

FileTypeIsComplete3dm

#Since v9.0
public bool FileTypeIsComplete3dm { get; }
True if the the file type is the current 3dm file version and everything in the document will be saved.

FileVersion

#Since v5.0
public int FileVersion { get; set; }

IncludeBitmapTable

#Since v5.0
public bool IncludeBitmapTable { get; set; }
The file written should include the bitmap table if your File Writing Plug-in supports it.

IncludeHistory

#Since v5.0
public bool IncludeHistory { get; set; }
The file written should include history information if your File Writing Plug-In supports it.

IncludePreviewImage

#Since v5.0
public bool IncludePreviewImage { get; set; }
The file written should include a preview image if your File Writing Plug-in supports it.

IncludeRenderMeshes

#Since v5.0
public bool IncludeRenderMeshes { get; set; }
The file written should include the render meshes if your File Writing Plug-in supports it.

OptionsDictionary

#Since v8.0
public ArchivableDictionary OptionsDictionary { get; }
Additional read options.

Rhino3dmVersion

#Since v9.0
public int Rhino3dmVersion { get; }
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.

RhinoDoc

#Since v7.7
public RhinoDoc RhinoDoc { get; }
Source RhinoDoc that is being written

SuppressAllInput

#Since v7.0
public bool SuppressAllInput { get; set; }

SuppressDialogBoxes

#Since v5.0
public bool SuppressDialogBoxes { get; set; }
If true, it means the command has been run with a '-', meaning you should not ask questions during writing. (no dialogs, no "getters", etc.)

UpdateDocumentPath

#Since v6.7
public bool UpdateDocumentPath { get; set; }
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.

UseCompression

#Since v9.0
public bool UseCompression { get; set; }

WriteAsTemplate

#Since v5.0
public bool WriteAsTemplate { get; }
Write as template

WriteGeometryOnly

#Since v5.0
public bool WriteGeometryOnly { get; set; }
If true, the file written should include only geometry File Writing Plug-in supports it.

WriteSelectedObjectsOnly

#Since v5.0
public bool WriteSelectedObjectsOnly { get; set; }
If true, this command should export only the objects currently selected in the Rhino model.

WriteUserData

#Since v5.0
public bool WriteUserData { get; set; }
If true, the file written should include User Data if your File Writing Plug-in supports it.

Xform

#Since v5.0
public Transform Xform { get; set; }

Methods

Dispose

#Since v5.0
public void Dispose()

Dispose

#
protected virtual void Dispose(bool disposing)
Parameters:
disposing (bool)

GetFileName

#Since v9.0
public string GetFileName()