FileSettings
Contains static methods and properties relating Rhino files.
Inheritance Hierarchy
System.Object
Rhino.ApplicationSettings.FileSettings
Namespace: Rhino.ApplicationSettings
Assembly: RhinoCommon (in RhinoCommon.dll)
Syntax
public static class FileSettings
The FileSettings type exposes the following members.
Properties
Name
Description
Public Property
Static Member
AutoSaveEnabled
Enables or disables Rhino’s automatic file saving mechanism.
Public Property
Static Member
AutoSaveFile
the file name used by Rhino’s automatic file saving mechanism.
Public Property
Static Member
AutoSaveInterval
how often the document will be saved when Rhino’s automatic file saving mechanism is enabled.
Public Property
Static Member
AutoSaveMeshes
save render and display meshes in autosave file.
Public Property
Static Member
ClipboardCopyToPreviousRhinoVersion
Gets or sets a value that decides if copies to the clipboard are performed in both the current and previous Rhino clipboard formats. This means you will double the size of what is saved in the clipboard but will be able to copy from the current to the previous version using the clipboard.
Public Property
Static Member
ClipboardOnExit
Gets or sets a value that determines what to do with clipboard data on exit.
Public Property
Static Member
CreateBackupFiles
Gets or sets a value that controls the creation of backup files.
Public Property
Static Member
DefaultRuiFile
Gets the path to the default RUI file.
Public Property
Static Member
ExecutableFolder
Returns the directory where the main Rhino executable is located.
Public Property
Static Member
FileLockingEnabled
Ensure that only one person at a time can have a file open for saving.
Public Property
Static Member
FileLockingOpenWarning
Gets or sets whether to display the information dialog which identifies computer files.
Public Property
Static Member
HelpFilePath
Gets the Rhino help file path.
Public Property
Static Member
InstallFolder
Returns Rhino’s installation folder.
Public Property
Static Member
LocalProfileDataFolder
Get full path to a Rhino specific sub-folder under the per-user Local (non-roaming) Profile folder. This is the folder where user-specific data is stored. On Windows 7, 8, usually someplace like: “C:\Users\[USERNAME]\AppData\Local\McNeel\Rhinoceros\[VERSION_NUMBER]\“
Public Property
Static Member
SaveViewChanges
true for users who consider view changes a document change.
Public Property
Static Member
SearchPathCount
Gets the amount of search paths that are currently defined.
Public Property
Static Member
TemplateFile
Returns or sets the location of Rhino’s template file.
Public Property
Static Member
TemplateFolder
Returns or sets the location of Rhino’s template files.
Public Property
Static Member
WorkingFolder
Returns or sets Rhino’s working directory, or folder. The working folder is the default folder for all file operations.
Methods
Name
Description
Public Method
Static Member
AddSearchPath
Adds a new imagePath to Rhino’s search imagePath list. See “Options Files settings” in the Rhino help file for more details.
Public Method
Static Member
AutoSaveBeforeCommands
Input list of commands that force AutoSave prior to running.
Public Method
Static Member
DefaultTemplateFolderForLanguageID
Returns the default template folder for a given language id.
Public Method
Static Member
DeleteSearchPath
Removes an existing imagePath from Rhino’s search imagePath list. See “Options Files settings” in the Rhino help file for more details.
Public Method
Static Member
FindFile
Searches for a file using Rhino’s search imagePath. Rhino will look for a file in the following locations: 1. The current document’s folder. 2. Folder’s specified in Options dialog, File tab. 3. Rhino’s System folders.
Public Method
Static Member
GetCurrentState
Returns the current state.
Public Method
Static Member
GetDataFolder
Gets the data folder for machine or current user.
Public Method
Static Member
GetDefaultState
Returns the default state.
Public Method
Static Member
GetSearchPaths
Returns all of the imagePath items in Rhino’s search imagePath list. See “Options Files settings” in the Rhino help file for more details.
Public Method
Static Member
RecentlyOpenedFiles
Returns a list of recently opened files. Note that this function does not check to make sure that these files still exist.
Public Method
Static Member
SetAutoSaveBeforeCommands
Set list of commands that force AutoSave prior to running.
Public Method
Static Member
UpdateFromState
Sets all settings to a particular defined joined state.