PlugIn.ReadDocument Method

PlugInReadDocument Method

Called whenever a Rhino document is being loaded and plug-in user data was encountered written by a plug-in with this plug-in's GUID.

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

Parameters

doc
Type: RhinoRhinoDoc
A Rhino document that is being loaded.
archive
Type: Rhino.FileIOBinaryArchiveReader
OpenNURBS file archive object Rhino is using to read this file. Use BinaryArchiveReader.Read*() functions to read plug-in data. If any BinaryArchive.Read*() functions throws an exception then archive.ReadErrorOccurve will be true and you should immediately return.
options
Type: Rhino.FileIOFileReadOptions
Describes what is being written.
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.8
See Also

M:Rhino.PlugIns.PlugIn.ReadDocument(Rhino.RhinoDoc,Rhino.FileIO.BinaryArchiveReader,Rhino.FileIO.FileReadOptions)