AppearanceSettings

public static class AppearanceSettings
Provides static methods and properties to deal with the appearance of the application.

Properties

BlackWhiteSwitching

#Since v9.0
public static bool BlackWhiteSwitching { get; set; }
Mode where white objects are drawn black when on a light background and black objects are drawn white when on a dark background

CommandPromptBackgroundColor

#Since v5.0
public static Color CommandPromptBackgroundColor { get; set; }
Gets or sets the color of the command prompt background.

CommandPromptFontSize

#Since v7.0
public static int CommandPromptFontSize { get; set; }
Size of font used in command prompt (in points)

CommandPromptHypertextColor

#Since v5.0
public static Color CommandPromptHypertextColor { get; set; }
Gets or sets the color of the command prompt hypertext.

CommandPromptPosition

#Since v5.0
public static CommandPromptPosition CommandPromptPosition { get; set; }
Gets or sets the command prompt position.

CommandPromptTextColor

#Since v5.0
public static Color CommandPromptTextColor { get; set; }
Gets or sets the color of the command prompt text.

CrosshairColor

#Since v5.0
public static Color CrosshairColor { get; set; }
Gets or sets the color of the crosshair icon.

CrosshairsAlignedToScreen

#Since v9.0
public static bool CrosshairsAlignedToScreen { get; set; }
Gets or sets a value that determines if the cross hairs are drawn horizontally and vertically on the screen (as if fixed to the camera) instead of running along the construction plane's x and y axes. When enabled, the cross hairs stay vertical and horizontal as the view is rotated, for example in a perspective viewport.

CrosshairScreenLength

#Since v9.0
public static double CrosshairScreenLength { get; set; }
Gets or sets a value that determines the length, in pixels, of the cross hairs if they are visible.

CurrentLayerBackgroundColor

#Since v5.0
public static Color CurrentLayerBackgroundColor { get; set; }
Gets or sets the color used by the layer manager dialog as the background color for the current layer.

DefaultFontFaceName

#Since v5.0
public static string DefaultFontFaceName { get; }
Gets or sets the default font face name used in Rhino.

DefaultLayerColor

#Since v5.0
public static Color DefaultLayerColor { get; set; }
Gets or sets the default layer color.

DefaultObjectColor

#Since v5.0
public static Color DefaultObjectColor { get; set; }
Gets or sets the default color for new objects.

DirectionArrowIconHeadSize

#Since v8.0
public static int DirectionArrowIconHeadSize { get; set; }
length of direction arrowhead icon in pixels.

DirectionArrowIconShaftSize

#Since v8.0
public static int DirectionArrowIconShaftSize { get; set; }
length of direction arrow shaft icon in pixels.

EchoCommandsToHistoryWindow

#Since v5.0
public static bool EchoCommandsToHistoryWindow { get; set; }
Gets or sets a value that determines if command names are written to the history window.

EchoPromptsToHistoryWindow

#Since v5.0
public static bool EchoPromptsToHistoryWindow { get; set; }
Gets or sets a value that determines if prompt messages are written to the history window.

EditCandidateColor

#Since v6.0
public static Color EditCandidateColor { get; set; }
Gets or sets the color of objects that are eligible to be edited.

EffectiveHelpLanguageIdentifier

#Since v9.0
public static int EffectiveHelpLanguageIdentifier { get; }
Gets the language identifier the Help system uses. This is HelpLanguageIdentifier when it has been set, otherwise LanguageIdentifier. Never returns zero.

FeedbackColor

#Since v5.0
public static Color FeedbackColor { get; set; }
Gets or sets the feedback color.

FrameBackgroundColor

#Since v5.0
public static Color FrameBackgroundColor { get; set; }
Gets or sets the background color of the frame.

GridThickLineColor

#Since v5.0
public static Color GridThickLineColor { get; set; }
Gets or sets the color of the thick line of the grid.

GridThinLineColor

#Since v5.0
public static Color GridThinLineColor { get; set; }
Gets or sets the color of the thin line of the grid.

GridXAxisLineColor

#Since v5.0
public static Color GridXAxisLineColor { get; set; }
Gets or sets the color of the X axis of the grid.

GridYAxisLineColor

#Since v5.0
public static Color GridYAxisLineColor { get; set; }
Gets or sets the color of the Y axis of the grid.

GridZAxisLineColor

#Since v5.0
public static Color GridZAxisLineColor { get; set; }
Gets or sets the color of the Z axis of the grid.

HelpLanguageIdentifier

#Since v9.0
public static int HelpLanguageIdentifier { get; set; }
Gets or sets the language identifier used by the Help system (the Help panel, F1 context help and the online help web site). This is independent of LanguageIdentifier, which is the language used by the user interface. A value of zero, the default, means the Help follows the user interface language. See EffectiveHelpLanguageIdentifier for the identifier the Help system actually uses.

LanguageIdentifier

#Since v5.0
public static int LanguageIdentifier { get; set; }
Gets or sets the language identifier.

LockedObjectColor

#Since v5.0
public static Color LockedObjectColor { get; set; }
color used to draw locked objects.

PageviewPaperColor

#Since v5.0
public static Color PageviewPaperColor { get; set; }
Gets or sets the paper background. A rectangle is drawn into the background of page views to represent the printed area. The alpha portion of the color is used to draw the paper blended into the background

PreviousLanguageIdentifier

#Since v5.0
public static int PreviousLanguageIdentifier { get; set; }
Gets or sets the previous language identifier.

SelectedObjectColor

#Since v5.0
public static Color SelectedObjectColor { get; set; }
The color used to draw selected objects. The default is yellow, but this can be customized by the user.

SelectionWindowCrossingFillColor

#Since v7.0
public static Color SelectionWindowCrossingFillColor { get; set; }
Color used to fill selection crossing window

SelectionWindowCrossingStrokeColor

#Since v7.0
public static Color SelectionWindowCrossingStrokeColor { get; set; }
Color used to draw stroke for selection crossing window

SelectionWindowFillColor

#Since v7.0
public static Color SelectionWindowFillColor { get; set; }
Color used to fill selection window

SelectionWindowStrokeColor

#Since v7.0
public static Color SelectionWindowStrokeColor { get; set; }
Color used to draw stroke for selection window

ShowCrosshairs

#Since v5.0
public static bool ShowCrosshairs { get; set; }
Gets or sets a value that determines if cross hairs are visible.

ShowCursorWhenCrosshairsVisible

#Since v9.0
public static bool ShowCursorWhenCrosshairsVisible { get; set; }

ShowFullPathInTitleBar

#Since v5.0
public static bool ShowFullPathInTitleBar { get; set; }
Gets or sets a value that determines if the full path of the document is shown in the Rhino title bar.

ShowLayoutDropShadow

#Since v8.0
public static bool ShowLayoutDropShadow { get; set; }
Display the drop shadow of layouts

ShowOsnapBar

#Since v7.0
public static bool ShowOsnapBar { get; set; }
Shows or hides the object snap user interface.

ShowSelectionFilterBar

#Since v8.2
public static bool ShowSelectionFilterBar { get; set; }
Shows or hides the selection filter user interface.

ShowSideBar

#Since v6.0
public static bool ShowSideBar { get; set; }
Shows or hides the side bar user interface.

ShowStatusBar

#Since v7.0
public static bool ShowStatusBar { get; set; }
Shows or hides the status bar user interface.

ShowTitleBar

#Since v8.0
public static bool ShowTitleBar { get; set; }
Shows or hides title bar.

ShowViewportTitles

#Since v8.0
public static bool ShowViewportTitles { get; set; }
Shows or hides viewport titles.

TrackingColor

#Since v5.0
public static Color TrackingColor { get; set; }
Gets or sets the tracking color.

UsePaintColors

#Since v5.0
public static bool UsePaintColors { get; }
obsoletecustom colors are always used
Gets or sets a value indicating if logical paint colors should be used.

ViewportBackgroundColor

#Since v5.0
public static Color ViewportBackgroundColor { get; set; }
Gets or sets the viewport background color.

ViewportTabsVisibleAtStart

#Since v8.0
public static bool ViewportTabsVisibleAtStart { get; set; }
Display viewport tabs at start

WorldCoordIconXAxisColor

#Since v5.0
public static Color WorldCoordIconXAxisColor { get; set; }
Gets or sets the color of the world coordinate X axis.

WorldCoordIconYAxisColor

#Since v5.0
public static Color WorldCoordIconYAxisColor { get; set; }
Gets or sets the color of the world coordinate Y axis.

WorldCoordIconZAxisColor

#Since v5.0
public static Color WorldCoordIconZAxisColor { get; set; }
Gets or sets the color of the world coordinate Z axis.

Methods

DefaultPaintColor

#Since v8.0
public static Color DefaultPaintColor(PaintColor whichColor, bool darkMode)
Get a default paint color for Rhino. The current paint color may be different than the default
whichColor (PaintColor)The color to retrieve
darkMode (bool)If true gets the default dark mode color otherwise return the default light mode color

DefaultPaintColor

#Since v7.0
public static Color DefaultPaintColor(PaintColor whichColor)
Get a default paint color for Rhino. The current paint color may be different than the default
whichColor (PaintColor)The color to retrieve

DefaultWidgetColor

#Since v8.0
public static Color DefaultWidgetColor(WidgetColor whichColor)
Get a default widget color for Rhino. The current widget color may be different than the default
whichColor (WidgetColor)The color to retrieve
A .Net library color.

GetCurrentState

#Since v5.0
public static AppearanceSettingsState GetCurrentState()
Gets the current settings of the application.
An instance of a class that represents all the settings as they appear in the Rhino _Options dialog, joined in a single class.

GetDefaultState

#Since v5.0
public static AppearanceSettingsState GetDefaultState()
Gets the factory settings of the application.
An instance of a class that represents all the default settings joined together.

GetDefaultState

#Since v8.0
public static AppearanceSettingsState GetDefaultState(bool darkMode)
Gets the factory settings of the application.
darkMode (bool)
An instance of a class that represents all the default settings joined together.

GetPaintColor

#Since v7.1
public static Color GetPaintColor(PaintColor whichColor, bool compute)
Gat a paint color. This overload provides a compute option for cases where colors are computed when they are "unset" colors.
whichColor (PaintColor)
compute (bool)if true, a color is computed in some cases

GetPaintColor

#Since v5.0
public static Color GetPaintColor(PaintColor whichColor)
Gets the color that is currently associated with a paint color.
whichColor (PaintColor)A color association.
A .Net library color.

GetWidgetColor

#Since v6.0
public static Color GetWidgetColor(WidgetColor whichColor)
Gets the .Net library color that is currently associated with a widget color.
whichColor (WidgetColor)A color association.
A .Net library color.

InitialMainWindowPosition

#Since v6.0
public static bool InitialMainWindowPosition(out Rectangle bounds)
Location where the Main Rhino window attempts to show when the application is first started.
bounds (out Rectangle)The rectangle in which the main window attempts to shows is assigned to this out parameter during the call.
false if the information could not be retrieved.

RestoreDefaults

#Since v5.0
public static void RestoreDefaults()
Commits the default settings as the current settings.

SetPaintColor

#Since v5.0
public static void SetPaintColor(PaintColor whichColor, Color c, bool forceUiUpdate)
Sets the logical paint color association to a specific .Net library color.
whichColor (PaintColor)A logical color association.
c (Color)A .Net library color.
forceUiUpdate (bool)true if the UI should be forced to update.

SetPaintColor

#Since v5.0
public static void SetPaintColor(PaintColor whichColor, Color c)
Sets the logical paint color association to a specific .Net library color, without forced UI update.
whichColor (PaintColor)A logical color association.
c (Color)A .Net library color.

SetToDarkMode

#Since v8.2
public static bool SetToDarkMode()
Set UI to the default dark mode color scheme
true on sucess

SetToLightMode

#Since v8.2
public static bool SetToLightMode()
Set UI to the default light mode color scheme
true on sucess

SetWidgetColor

#Since v6.0
public static void SetWidgetColor(WidgetColor whichColor, Color c, bool forceUiUpdate)
Sets the logical widget color association to a specific .Net library color.
whichColor (WidgetColor)A logical color association.
c (Color)A .Net library color.
forceUiUpdate (bool)true if the UI should be forced to update.

SetWidgetColor

#Since v6.0
public static void SetWidgetColor(WidgetColor whichColor, Color c)
Sets the logical widget color association to a specific .Net library color, without forced UI update.
whichColor (WidgetColor)A logical color association.
c (Color)A .Net library color.

UpdateFromState

#Since v5.0
public static void UpdateFromState(AppearanceSettingsState state)
Sets all settings to a particular defined joined state.
state (AppearanceSettingsState)A joined settings object.

UsingDefaultDarkModeColors

#Since v8.2
public static bool UsingDefaultDarkModeColors()
Determine if Rhino is running with default dark mode color settings

UsingDefaultLightModeColors

#Since v8.2
public static bool UsingDefaultLightModeColors()
Determine if Rhino is running with default light mode color settings