PlugIn.ShouldCallWriteDocument Method

PlugInShouldCallWriteDocument Method

Called whenever a Rhino is about to save a .3dm file. If you want to save plug-in document data when a model is saved in a version 5 .3dm file, then you must override this function to return true and you must override WriteDocument().

Namespace:  Rhino.PlugIns
Assembly:  RhinoCommon (in RhinoCommon.dll)
Syntax
Copy
protected virtual bool ShouldCallWriteDocument(
	FileWriteOptions options
)
Protected Overridable Function ShouldCallWriteDocument ( 
	options As FileWriteOptions
) As Boolean

Parameters

options
Type: Rhino.FileIOFileWriteOptions
The file write options, such as "include preview image" and "include render meshes".

Return Value

Type: Boolean
true if the plug-in wants to save document user data in the version 5 .3dm file. The default returns false.
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.8
See Also

M:Rhino.PlugIns.PlugIn.ShouldCallWriteDocument(Rhino.FileIO.FileWriteOptions)