Skin

References
public abstract class Skin
Represents a customized environment that changes the appearance of Rhino.

Skin DLLs must contain a single class that derives from the Skin class.

Constructors

Skin

#
Initializes a new instance of the Skin class.
protected Skin()

Properties

ActiveSkin

#Since v5.0
Any time Rhino is running there is at most one skin being used (and possibly no skin). If a RhinoCommon based Skin class is being used, use ActiveSkin to get at the instance of this Skin class. May return null if no Skin is being used or if the skin is not a RhinoCommon based skin.
public static Skin ActiveSkin { get; }

ApplicationName

#
If you want to provide a custom name for your skin.
protected virtual string ApplicationName { get; }

HasBootSplash

#Since v9.0
True when the platform's native boot splash is compiled in and shown at startup.
protected static bool HasBootSplash { get; }

MainRhinoIcon

#
If you want to provide a custom icon for your skin.
protected virtual Bitmap MainRhinoIcon { get; }

Settings

#Since v5.0
Gets access to the skin persistent settings.
public PersistentSettings Settings { get; }

SettingsDirectory

#Since v9.0
Get the skin's settings directory. This is the directory where the skin's persistent settings files are saved, matching the location used by Settings. Note, this does not verify the directory exists.
public string SettingsDirectory { get; }

Methods

DismissBootSplash

#Since v9.0
Tells the platform's boot splash to dismiss, if one is up. Call this from a Skin subclass once its own window is on screen. No-op on platforms that have no boot splash.
protected static void DismissBootSplash()

HideSplash

#
Is called when the splash screen should be hidden.
protected virtual void HideSplash()

OnBeginLoadAtStartPlugIns

#
Is called when the first plug-in that loads at start-up is going to be loaded.
protected virtual void OnBeginLoadAtStartPlugIns(
int
expectedCount
The complete amount of plug-ins.
)

OnBeginLoadPlugIn

#
Is called when a specific plug-in is going to be loaded.
protected virtual void OnBeginLoadPlugIn(
string
description
The plug-in description.
)

OnBuiltInCommandsRegistered

#
Is called when built-in commands are registered.
protected virtual void OnBuiltInCommandsRegistered()

OnEndLoadAtStartPlugIns

#
Is called after all of the load at start plug-ins have been loaded.
protected virtual void OnEndLoadAtStartPlugIns()

OnEndLoadPlugIn

#
Is called after each plug-in has been loaded.
protected virtual void OnEndLoadPlugIn()

OnLicenseCheckCompleted

#
Is called when the license check is completed.
protected virtual void OnLicenseCheckCompleted()

OnMainFrameWindowCreated

#
Is called when the main frame window is created.
protected virtual void OnMainFrameWindowCreated()

OpenNewDocument

#Since v9.0
Creates a new RhinoDoc from the given template (or a blank document when the path is null/empty/missing) and brings up its document window. Must be called on the main UI thread.
protected static RhinoDoc OpenNewDocument(
string
templatePath
Path to a template file, or null/empty for a blank document.
)
Returns: The new RhinoDoc, or null on failure.

SetBootSplashProgress

#Since v9.0
Pushes a progress value to the platform's boot splash so it can paint a progress bar. The value is treated as a percentage and clamped to 0..100 on the native side. No-op on platforms that have no boot splash, and harmless if the splash is already gone.
protected static void SetBootSplashProgress(
int
value
Progress percentage in the range 0..100.
)

ShowChooseRecent

#Since v9.0
Called when the host requests the Skin's "choose recent" UI. Default implementation is empty.
protected virtual void ShowChooseRecent()

ShowChooseTemplate

#Since v9.0
Called when the host requests the Skin's "choose template" UI (e.g. from the File > New Using Template menu item). Default implementation is empty.
protected virtual void ShowChooseTemplate()

ShowHelp

#
Called when the "help" splash screen should be shown. Default implementation just calls ShowSplash()
protected virtual void ShowHelp()

ShowSplash

#
Is called when the splash screen should be shown.
protected virtual void ShowSplash()