FileReadOptions
Inheritance Hierarchy
System.Object
Rhino.FileIO.FileReadOptions
Namespace: Rhino.FileIO
Assembly: RhinoCommon (in RhinoCommon.dll)
Syntax
public class FileReadOptions : IDisposableThe FileReadOptions type exposes the following members.
Constructors
Name
Description
Public Method
FileReadOptions
Initializes a new instance of the FileReadOptions class
Properties
Name
Description
Public Property
BatchMode
true means you cannot ask questions during reading. (no dialogs, no “getters”, etc.)
Public Property
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.
Public Property
ImportReferenceMode
true means we are reading information for a work session reference model or a linked instance definition.
Public Property
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.
Public Property
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;
Public Property
NewMode
true means we are reading template information in something like a OnFileNew event.
Public Property
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.
Public Property
OptionsDictionary
Additional read options.
Public Property
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.
Public Property
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.
Public Property
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.
Public Property
WorkSessionReferenceModelSerialNumber
If a worksession reference model is being read, then a value >= 1000 will be returned. Otherwise, this value will be 0;
Methods
Name
Description
Public Method
Dispose.
Releases all resources used by the FileReadOptions
Protected Method
Dispose(Boolean)
Releases the unmanaged resources used by the FileReadOptions and optionally releases the managed resources
Public Method
Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected Method
Finalize
(Overrides Object.Finalize..)
Public Method
GetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public Method
GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected Method
MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public Method
ToString
Returns a string that represents the current object.
(Inherited from Object.)