Types marked with this attribute are considered immutable by the fail-early check that requires
that all values used in the document are immutable.
IMPORTANT NOTE: Do not mark a type with an ImmutableAttribute if the state of an
instance of the type can be manipulated after the instance has been constructed. Failure to follow this
guideline may lead to undo/redo bugs and crashes.
Inheritance Hierarchy
SystemAttribute
Spotfire.Dxp.Framework.DocumentModelImmutableAttribute
Namespace: Spotfire.Dxp.Framework.DocumentModel
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct, AllowMultiple = false, Inherited = false)] public sealed class ImmutableAttribute : Attribute
The ImmutableAttribute type exposes the following members.
Constructors
Name | Description | |
---|---|---|
ImmutableAttribute |
Initializes a new instance of the ImmutableAttribute class.
|
Properties
Name | Description | |
---|---|---|
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
Methods
Name | Description | |
---|---|---|
Equals | Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) | |
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) | |
Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
_AttributeGetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) | |
_AttributeGetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) | |
_AttributeGetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) | |
_AttributeInvoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
Version Information
Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also