Click or drag to resize

QuantityWithUnitGuiEnvironment Class

Provides the units that are recognized when entering a quantity with a unit in GUI elements. This class is designed to support fast cloning, where the fixed units are shared among the clones, and the additional units can be set freely in each clone.
Inheritance Hierarchy
SystemObject
  Altaxo.GuiQuantityWithUnitGuiEnvironment

Namespace: Altaxo.Gui
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
public class QuantityWithUnitGuiEnvironment

The QuantityWithUnitGuiEnvironment type exposes the following members.

Constructors
 NameDescription
Public methodQuantityWithUnitGuiEnvironment Initializes a new instance of the QuantityWithUnitGuiEnvironment class.
Public methodQuantityWithUnitGuiEnvironment(IEnumerableIUnit) Initializes a new instance of the QuantityWithUnitGuiEnvironment class.
Public methodQuantityWithUnitGuiEnvironment(IEnumerableIUnit, IUnit) Initializes a new instance of the QuantityWithUnitGuiEnvironment class.
Public methodQuantityWithUnitGuiEnvironment(IEnumerableIUnit, IEnumerableIUnit) Initializes a new instance of the QuantityWithUnitGuiEnvironment class.
Public methodQuantityWithUnitGuiEnvironment(QuantityWithUnitGuiEnvironment, IEnumerableIUnit) Initializes a new instance of the QuantityWithUnitGuiEnvironment class by reusing the fixed-unit configuration of another environment.
Top
Properties
 NameDescription
Public propertyAdditionalUnits Gets the additional units that are available in this environment.
Public propertyDefaultUnit Gets or sets the default unit displayed in GUI elements.
Public propertyFixedUnits Gets the fixed units that are always available in this environment.
Public propertyNumberOfDisplayedDigits Gets or sets the number of digits displayed in GUI boxes.
Public propertyUnitsSortedByShortcutLengthDescending Gets all available units sorted by descending shortcut length.
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnDefaultUnitChanged Raises the DefaultUnitChanged event.
Protected methodOnNumberOfDisplayedDigitsChanged Raises the NumberOfDisplayedDigitsChanged event.
Public methodStatic memberRegisterEnvironment Registers a named quantity-with-unit environment.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodStatic memberTryGetEnvironment Tries to get a registered quantity-with-unit environment by name.
Public methodTryGetPrefixedUnitFromShortcut Tries to get a prefixed unit from a shortcut, considering all units in this environment.
Top
Events
 NameDescription
Public eventDefaultUnitChanged Triggered when the default unit that is displayed in Gui boxes changed.
Public eventNumberOfDisplayedDigitsChanged Triggered when the number of digits that should be displayed (in Gui boxes) changed.
Top
See Also