/ doc / toc / ARCCore / Class / IKString

IKString

Edit keys at this level only

Edit keys at all sub levels.
NOTE: Edits are always additive. Use 'Invalid' in order to delete keys.

__TOCDet/Assembly = ARCCore
__TOCDet/Description = Index key for any general id, like primary-key or sequence-number or similar.0x000D0x000A(in RDBMS-terms a primary key)0x000D0x000A0x000D0x000ANote that if the actual id is an integer, then -IKLong- should be used instead of -IKString-, because the former is more memory efficient0x000D0x000A0x000D0x000AThe actual id is not expected to be unique throughout the database, but rather unique within a context, for example the value '42' could be unique within the context of 'Customer'.0x000D0x000A0x000D0x000ANote how constructor allows an empty string, but -TryParse- does not.0x000D0x000A0x000D0x000AThis class is immutable.
__TOCDet/DocFragType = Class
__TOCDet/LongDescription = Note that although this class does not specify any maximum length of the string representation of the key, keys should be kept reasonable short in order to be practical in URL's and as file and folder names when storing on disk.0x000D0x000ASee -IKCoded- which specifies a maximum of 250 characters in an encoded string representation of a key.
__TOCDet/Name = IKString
__TOCDet/Namespace = ARCCore
__TOCDet/Type = IKString
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/ClassNamespace = ARCCore
__TOCDet/Attribute/ClassType = IKString
__TOCDet/Attribute/Description = Index key for any general id, like primary-key or sequence-number or similar.0x000D0x000A(in RDBMS-terms a primary key)0x000D0x000A0x000D0x000ANote that if the actual id is an integer, then -IKLong- should be used instead of -IKString-, because the former is more memory efficient0x000D0x000A0x000D0x000AThe actual id is not expected to be unique throughout the database, but rather unique within a context, for example the value '42' could be unique within the context of 'Customer'.0x000D0x000A0x000D0x000ANote how constructor allows an empty string, but -TryParse- does not.0x000D0x000A0x000D0x000AThis class is immutable.
__TOCDet/Attribute/Interfaces = IK0x003BIEquatable0xoooo003CIK0xoooo003E0x003BITypeDescriber
__TOCDet/Attribute/InterfacesDirectlyImplemented = IK0x003BIEquatable0xoooo003CIK0xoooo003E0x003BITypeDescriber
__TOCDet/Attribute/LongDescription = Note that although this class does not specify any maximum length of the string representation of the key, keys should be kept reasonable short in order to be practical in URL's and as file and folder names when storing on disk.0x000D0x000ASee -IKCoded- which specifies a maximum of 250 characters in an encoded string representation of a key.
EnrichKey/__TOCDet/Assembly = ARCCore
EnrichKey/__TOCDet/Description = 'Implementing' -ITypeDescriber-.
EnrichKey/__TOCDet/DocFragType = ClassMember
EnrichKey/__TOCDet/IsInherited = False
EnrichKey/__TOCDet/IsInheritedDoc = False
EnrichKey/__TOCDet/Lines = 1
EnrichKey/__TOCDet/Name = EnrichKey
EnrichKey/__TOCDet/Namespace = ARCCore
EnrichKey/__TOCDet/Type = IKString
EnrichKey/__TOCDet/Attribute/DeclaringType = IKString
EnrichKey/__TOCDet/Attribute/Description = 'Implementing' -ITypeDescriber-.
EnrichKey/__TOCDet/Attribute/MethodName = EnrichKey
EnrichKey/__TOCDet/Attribute/MethodSignature = Void EnrichKey(ARCCore.PK)
FromCache/__TOCDet/Assembly = ARCCore
FromCache/__TOCDet/Description = Reduces number of objects generated by caching those known to be within a limited range0x000D0x000A0x000D0x000AUse this method when you know that the given string is within a limited range.0x000D0x000A0x000D0x000AAn example of when to use this method would be when you know that the string key represents an object type (and you are unable to use -IKType- because you do not have the actual type instance, only its string representation).
FromCache/__TOCDet/DocFragType = ClassMember
FromCache/__TOCDet/IsInherited = False
FromCache/__TOCDet/IsInheritedDoc = False
FromCache/__TOCDet/Lines = 5
FromCache/__TOCDet/Name = FromCache
FromCache/__TOCDet/Namespace = ARCCore
FromCache/__TOCDet/Type = IKString
FromCache/__TOCDet/Attribute/DeclaringType = IKString
FromCache/__TOCDet/Attribute/Description = Reduces number of objects generated by caching those known to be within a limited range0x000D0x000A0x000D0x000AUse this method when you know that the given string is within a limited range.0x000D0x000A0x000D0x000AAn example of when to use this method would be when you know that the string key represents an object type (and you are unable to use -IKType- because you do not have the actual type instance, only its string representation).
FromCache/__TOCDet/Attribute/MethodName = FromCache
FromCache/__TOCDet/Attribute/MethodSignature = ARCCore.IKString FromCache(System.String)
FromString/__TOCDet/Assembly = ARCCore
FromString/__TOCDet/Description = Note how uses instance cache if already exists there
FromString/__TOCDet/DocFragType = ClassMember
FromString/__TOCDet/IsInherited = False
FromString/__TOCDet/IsInheritedDoc = False
FromString/__TOCDet/Lines = 1
FromString/__TOCDet/Name = FromString
FromString/__TOCDet/Namespace = ARCCore
FromString/__TOCDet/Type = IKString
FromString/__TOCDet/Attribute/DeclaringType = IKString
FromString/__TOCDet/Attribute/Description = Note how uses instance cache if already exists there
FromString/__TOCDet/Attribute/MethodName = FromString
FromString/__TOCDet/Attribute/MethodSignature = ARCCore.IKString FromString(System.String)
op_Equality/__TOCDet/Assembly = ARCCore
op_Equality/__TOCDet/Description = It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
op_Equality/__TOCDet/DocFragType = ClassMember
op_Equality/__TOCDet/IsInherited = False
op_Equality/__TOCDet/IsInheritedDoc = False
op_Equality/__TOCDet/Lines = 1
op_Equality/__TOCDet/Name = op_Equality
op_Equality/__TOCDet/Namespace = ARCCore
op_Equality/__TOCDet/Type = IKString
op_Equality/__TOCDet/Attribute/DeclaringType = IKString
op_Equality/__TOCDet/Attribute/Description = It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
op_Equality/__TOCDet/Attribute/MethodName = op_Equality
op_Equality/__TOCDet/Attribute/MethodSignature = Boolean op_Equality(ARCCore.IKString, ARCCore.IKString)

Edit single sub keys only: __TOCDet / EnrichKey / FromCache / FromString / op_Equality

Generated 2025-04-16 11:53:52.169 UTC