PlugIn.WriteDocument Method

PlugInWriteDocument Method

Called when Rhino is saving a .3dm file to allow the plug-in to save document user data.

Namespace:  Rhino.PlugIns
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
protected virtual void WriteDocument(
	RhinoDoc doc,
	BinaryArchiveWriter archive,
	FileWriteOptions options
)
Protected Overridable Sub WriteDocument ( 
	doc As RhinoDoc,
	archive As BinaryArchiveWriter,
	options As FileWriteOptions
)

Parameters

doc
Type: RhinoRhinoDoc
The Rhino document instance that is being saved.
archive
Type: Rhino.FileIOBinaryArchiveWriter
OpenNURBS file archive object Rhino is using to write the file. Use BinaryArchiveWriter.Write*() functions to write plug-in data. OR use the ArchivableDictionary If any BinaryArchiveWriter.Write*() functions throw an exception, then archive.WriteErrorOccured will be true and you should immediately return. Setting archive.WriteErrorOccured to true will cause Rhino to stop saving the file.
options
Type: Rhino.FileIOFileWriteOptions
The file write options, such as "include preview image" and "include render meshes".
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.14
See Also

M:Rhino.PlugIns.PlugIn.WriteDocument(Rhino.RhinoDoc,Rhino.FileIO.BinaryArchiveWriter,Rhino.FileIO.FileWriteOptions)