FileWriteOptions

References

Constructors

FileWriteOptions

#Since v5.0
public FileWriteOptions()

Finalizer

~FileWriteOptions

#
~FileWriteOptions()

Properties

AllowUserInterfaceWithHeadlessDocument

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

BackupFileFolder

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

CreateBackupFiles

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

CreateOtherBackupFiles

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

DestinationFileName

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

FileTypeId

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

FileTypeIndex

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

FileTypeIs3dm

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

FileTypeIsComplete3dm

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

FileVersion

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

IncludeBitmapTable

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

IncludeHistory

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

IncludePreviewImage

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

IncludeRenderMeshes

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

OptionsDictionary

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

Rhino3dmVersion

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

RhinoDoc

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

SuppressAllInput

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

SuppressDialogBoxes

#Since v5.0
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 bool SuppressDialogBoxes { get; set; }

UpdateDocumentPath

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

UseCompression

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

WriteAsTemplate

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

WriteGeometryOnly

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

WriteSelectedObjectsOnly

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

WriteUserData

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

Xform

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

Methods

Dispose

#Since v5.0
public void Dispose()

Dispose

#
protected virtual void Dispose(
disposing
)

GetFileName

#Since v9.0
public string GetFileName()