PreferenceSettings
PreferenceSettings is a class for GUI to persist certain settings. Upon running of the GUI, those settings that are persistent will be loaded from a XML file from DYNAMO_SETTINGS_FILE. When GUI is closed, the settings into the XML file.
Constructors
No public constructors defined
Methods
| Boolean Save(String filePath) |
stability index:1 |
| Return Value: Whether file is saved or error occurred. |
|
| Save PreferenceSettings in XML File Path if possible, else return false |
|
| filePath |
|
| Path of the XML File |
|
| Boolean SaveInternal(String preferenceFilePath) |
stability index:1 |
| Return Value: Whether file is saved or error occurred. |
|
| Save PreferenceSettings in a default directory when no path is specified. |
|
| preferenceFilePath |
|
| The file path to save preference settings to. If this parameter is null or empty string, preference settings will be saved to the default path. |
|
| PreferenceSettings Load(String filePath) |
stability index:1 |
| Return Value: Stored PreferenceSettings from xml file or Default PreferenceSettings if xml file is not found. |
|
| Return PreferenceSettings from XML path if possible, else return PreferenceSettings with default values |
|
| filePath |
|
| Path of the XML File |
|
Properties
| Int32 LibraryWidth {get;set;} |
stability index:1 |
| The width of the library pane. |
|
| Int32 ConsoleHeight {get;set;} |
stability index:1 |
| The height of the console display. |
|
| Boolean ShowConnector {get;set;} |
stability index:1 |
| Should connectors be visible? |
|
| ConnectorType ConnectorType {get;set;} |
stability index:1 |
| The types of connector: Bezier or Polyline. |
|
| Boolean IsBackgroundPreviewActive {get;set;} |
stability index:1 |
| Should the background 3D preview be shown? |
|
| String NumberFormat {get;set;} |
stability index:1 |
| The decimal precision used to display numbers. |
|
| Int32 MaxNumRecentFiles {get;set;} |
stability index:1 |
| The maximum number of recent file paths to be saved. |
|
| List<String> RecentFiles {get;set;} |
stability index:1 |
| A list of recently opened file paths. |
|
| List<String> BackupFiles {get;set;} |
stability index:1 |
| A list of backup file paths. |
|
| List<String> CustomPackageFolders {get;set;} |
stability index:1 |
| A list of folders containing zero-touch nodes and custom nodes. |
|
| List<String> PackageDirectoriesToUninstall {get;set;} |
stability index:1 |
| A list of packages used by the Package Manager to determine which packages are marked for deletion. |
|
| Double WindowX {get;set;} |
stability index:1 |
| The last X coordinate of the Dynamo window. |
|
| Double WindowY {get;set;} |
stability index:1 |
| The last Y coordinate of the Dynamo window. |
|
| Double WindowW {get;set;} |
stability index:1 |
| The last width of the Dynamo window. |
|
| Double WindowH {get;set;} |
stability index:1 |
| The last height of the Dynamo window. |
|
| Boolean UseHardwareAcceleration {get;set;} |
stability index:1 |
| Should Dynamo use hardware acceleration if it is supported? |
|
| Int32 BackupInterval {get;set;} |
stability index:1 |
| This defines how long (in milliseconds) will the graph be automatically saved. |
|
| Int32 BackupFilesCount {get;set;} |
stability index:1 |
| This defines how many files will be backed up. |
|
| Boolean PackageDownloadTouAccepted {get;set;} |
stability index:1 |
| Indicates if the user has accepted the terms of use for downloading packages from package manager. |
|
| Boolean ShowEdges {get;set;} |
stability index:1 |
| Indicates whether surface and solid edges will be rendered. |
|
Events
No public events defined
