FileReadOptions Class

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
  NameDescription
Public methodFileReadOptions
Initializes a new instance of the FileReadOptions class
Top
Properties
  NameDescription
Public propertyBatchMode
true means you cannot ask questions during reading. (no dialogs, no "getters", etc.)
Public propertyImportMode
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.

Public propertyImportReferenceMode
true means we are reading information for a work session reference model or a linked instance definition.
Public propertyInsertMode
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.
Public propertyNewMode
true means we are reading template information in something like a OnFileNew event.
Public propertyOpenMode
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.
Public propertyScaleGeometry

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.

Public propertyUseScaleGeometry
If this parameter is true, then no questions are asked when unit conversion scaling is optional and the setting specified by ScaleGeometry is used.
Top
Methods
  NameDescription
Public methodDispose
Releases all resources used by the FileReadOptions
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the FileReadOptions and optionally releases the managed resources
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Overrides ObjectFinalize.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodToString (Inherited from Object.)
Top
Version Information

Rhino for Mac

Supported in: 5.4

Rhino for Windows

Supported in: 6.8
See Also

T:Rhino.FileIO.FileReadOptions