FileReadOptions Class

[Missing <summary> documentation for "T:Rhino.FileIO.FileReadOptions"]

Inheritance Hierarchy

SystemObject
Rhino.FileIOFileReadOptions

Namespace: Rhino.FileIO
Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

Copy

public class FileReadOptions : IDisposable

Public Class FileReadOptions
	Implements IDisposable

The FileReadOptions type exposes the following members.

Constructors

	Name	Description
	FileReadOptions	Initializes a new instance of the FileReadOptions class

Top

Properties

	Name	Description
	BatchMode	true means you cannot ask questions during reading. (no dialogs, no "getters", etc.)
	ImportMode	true means we are merging whatever is being read into an existing document. This means you need to consider things like: If the information being read is in a different unit system, it should be scaled if UseScaleGeometry is true. There can be existing layers, fonts, materials, dimension styles, hatch patterns, and so on with the same name as items being read from the file.
	ImportReferenceMode	true means we are reading information for a work session reference model or a linked instance definition.
	InsertMode	true means we are reading information that will be used to create an instance definition or some other type of "inserting" that is supported by Rhino's "Insert" command.
	LinkedInstanceDefinitionSerialNumber	If a file is being read to create an instance definition, then this value will be the serial number of the instance definition being created. Otherwise, this value will be 0;
	NewMode	true means we are reading template information in something like a OnFileNew event.
	OpenMode	true means we are reading the information into an empty document. This means you need to consider things like: Setting the unit system (if the file has a unit system) Creating a default layer if one is not there. Setting up appropriate views when you're finished reading.
	OptionsDictionary	Additional read options.
	ReferenceModelGrandParentLayerId	Information that ultimately is part of a worksession reference model or linked instance definition model is being read, all layers are added as sub-layers of a grand-parent layer.When the information being read is destined for the active model, no grandparent layer is used. Value is Guid.Empty if no grandparent layer is in use.
	ScaleGeometry	true: If ImportMode is true and the geometry in the file being read has a unit system different from the model's unit system, then apply the unit conversion scale to the file's geometry before adding it to the model. false: Do not scale. Once case where this happens is when an instance definition is read from a file and the model space instance references have been scaled. In case the instance definition geometry cannot be scaled or the net result is that the size of the instance reference object is scaled by the square of the scale factor.
	UseScaleGeometry	If this parameter is true, then no questions are asked when unit conversion scaling is optional and the setting specified by ScaleGeometry is used.
	WorkSessionReferenceModelSerialNumber	If a worksession reference model is being read, then a value >= 1000 will be returned. Otherwise, this value will be 0;

Top

Methods

	Name	Description
	Dispose	Releases all resources used by the FileReadOptions
	Dispose(Boolean)	Releases the unmanaged resources used by the FileReadOptions and optionally releases the managed resources
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Overrides ObjectFinalize.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

Rhino.FileIO Namespace