Methods_T_Rhino_RhinoDoc - mcneel/rhinocommon-api-docs GitHub Wiki

RhinoDoc Methods

The RhinoDoc type exposes the following members.

Methods

 

Name Description
Public method AddCustomUndoEvent(String, EventHandler(CustomUndoEventArgs))
Public methodCode example AddCustomUndoEvent(String, EventHandler(CustomUndoEventArgs), Object) Add a custom undo event so you can undo private plug-in data when the user performs an undo or redo
Public method AdjustModelUnitSystem
Public method AdjustPageUnitSystem
Public method BeginUndoRecord Instructs Rhino to begin recording undo information when the document is changed outside of a command. We use this, e.g., to save changes caused by the modeless layer or object properties dialogs when commands are not running.
Public method ClearRedoRecords
Public method ClearUndoRecords(Boolean)
Public method ClearUndoRecords(UInt32, Boolean)
Public methodCode example CreateDefaultAttributes Gets the default object attributes for this document. The attributes will be linked to the currently active layer and they will inherit the Document WireDensity setting.
Public method EndUndoRecord
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodStatic member ExtractPreviewImage Extracts the bitmap preview image from the specified model (3DM).
Public method FindFile Search for a file using Rhino's search path. Rhino will look in the following places: 1. Current model folder 2. Path specified in options dialog/File tab 3. Rhino system folders 4. Rhino executable folder
Public methodStatic member FromFilePath Search the open document list for a document with a Path equal to the specified file path.
Public methodStatic member FromId **Obsolete. **
Public methodStatic member FromRuntimeSerialNumber
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetMeshingParameters Get MeshingParameters currently used by the document
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetUnitSystemName
Public methodStatic member Open Opens a 3dm file and makes it the active document. If called on windows the active document will be saved and closed and the new document will be opened and become the active document. If called on the Mac the file will be opened in a new document window.
Public methodStatic member OpenDocuments Returns a list of currently open Rhino documents
Public methodStatic member OpenFile **Obsolete. **
Public methodStatic member ReadFile
Public method ReadFileVersion Returns the file version of the current document. Use this function to determine which version of Rhino last saved the document.
Public method SetCustomMeshingParameters Set the custom meshing parameters that this document will use. You must also modify the MeshingParameterStyle property on the document to Custom if you want these meshing parameters to be used
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method WriteFile
  Back to Top

See Also

Reference

RhinoDoc Class
Rhino Namespace

⚠️ **GitHub.com Fallback** ⚠️