GetBooleanSetting Method

Gets a bool value from the NodeSettings dictionary by setting name.

public string GetBooleanSetting(string name)

Classes: Settings

Parameters

value name

Setting name corresponding with the dictionary key inside of NodeSettings

Returns

bool

A boolean value.

Example

The following example demonstrates getting a boolean value from a boolean setting.

var boolSetting = Settings.GetBooleanSetting("Boolean Setting");

Remarks

Throws a KeyNotFoundException if no setting exists by the parameter name.

Throws an InvalidCastException if the target setting is not of SettingType.Boolean.

Throws an InvalidOperationException if the target setting has no BooleanValue.