/ doc / toc / ARCDoc / Class / HLocation

HLocation

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 = ARCDoc
__TOCDet/Description = Simple class describing the location of a single -IP- instance within some hierarhical context.0x000D0x000A0x000D0x000AThe hierarchical context can be a folder / file structure on disk, or some in-memory structure.0x000D0x000A0x000D0x000ACreated in order to facilitate0x000D0x000A1) -LinkInsertionInDocumentation- and0x000D0x000A2) Storing of static HTML files to disk.0x000D0x000A0x000D0x000AUsed in conjunction with -HLocationCollection-.0x000D0x000A0x000D0x000AUsed by -ARCDoc- in order to document application.0x000D0x000A0x000D0x000ASee -DocLink- for information about how references to instances of this class is expected to turn up as references in other instances of this class.0x000D0x000ATODO: Clarify this sentence.0x000D0x000A0x000D0x000AThis class is immutable.
__TOCDet/DocFragType = Class
__TOCDet/Name = HLocation
__TOCDet/Namespace = ARCDoc
__TOCDet/Type = HLocation
__TOCDet/Attribute/AssemblyName = ARCDoc
__TOCDet/Attribute/BaseTypes = PRich
__TOCDet/Attribute/ClassNamespace = ARCDoc
__TOCDet/Attribute/ClassType = HLocation
__TOCDet/Attribute/CorrespondingEnumType = HLocationP
__TOCDet/Attribute/Description = Simple class describing the location of a single -IP- instance within some hierarhical context.0x000D0x000A0x000D0x000AThe hierarchical context can be a folder / file structure on disk, or some in-memory structure.0x000D0x000A0x000D0x000ACreated in order to facilitate0x000D0x000A1) -LinkInsertionInDocumentation- and0x000D0x000A2) Storing of static HTML files to disk.0x000D0x000A0x000D0x000AUsed in conjunction with -HLocationCollection-.0x000D0x000A0x000D0x000AUsed by -ARCDoc- in order to document application.0x000D0x000A0x000D0x000ASee -DocLink- for information about how references to instances of this class is expected to turn up as references in other instances of this class.0x000D0x000ATODO: Clarify this sentence.0x000D0x000A0x000D0x000AThis class is immutable.
__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
Content/__TOCDet/Assembly = ARCDoc
Content/__TOCDet/Description = The Content object is not stored within the standard -IP--mechanism.0x000D0x000AThe reason is that the object may be anything, even something pointing back to this class.0x000D0x000A(introducing a cycle and making -ToPropertyStream- dangerous to call for instance)
Content/__TOCDet/DocFragType = ClassMember
Content/__TOCDet/IsInherited = False
Content/__TOCDet/IsInheritedDoc = False
Content/__TOCDet/Lines = 3
Content/__TOCDet/Name = Content
Content/__TOCDet/Namespace = ARCDoc
Content/__TOCDet/Type = HLocation
Content/__TOCDet/Attribute/DeclaringType = HLocation
Content/__TOCDet/Attribute/Description = The Content object is not stored within the standard -IP--mechanism.0x000D0x000AThe reason is that the object may be anything, even something pointing back to this class.0x000D0x000A(introducing a cycle and making -ToPropertyStream- dangerous to call for instance)
Content/__TOCDet/Attribute/MethodName = Content
Content/__TOCDet/Attribute/MethodSignature = ARCCore.IP Content
ToString/__TOCDet/Assembly = ARCDoc
ToString/__TOCDet/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
ToString/__TOCDet/DocFragType = ClassMember
ToString/__TOCDet/IsInherited = True
ToString/__TOCDet/IsInheritedDoc = True
ToString/__TOCDet/Name = ToString
ToString/__TOCDet/Namespace = ARCDoc
ToString/__TOCDet/Type = HLocation
ToString/__TOCDet/Attribute/DeclaringType = PRich
ToString/__TOCDet/Attribute/Description = TODO: Decide on what we actually want with ToString for this class.0x000D0x000ATODO: For instance, a list of id-related fields would be useful, or tagging av properties which kind of define the entity
ToString/__TOCDet/Attribute/MethodName = ToString
ToString/__TOCDet/Attribute/MethodSignature = System.String ToString()
TryGetP/__TOCDet/Assembly = ARCDoc
TryGetP/__TOCDet/Description = Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
TryGetP/__TOCDet/DocFragType = ClassMember
TryGetP/__TOCDet/IsInherited = True
TryGetP/__TOCDet/IsInheritedDoc = True
TryGetP/__TOCDet/Name = TryGetP
TryGetP/__TOCDet/Namespace = ARCDoc
TryGetP/__TOCDet/Type = HLocation
TryGetP/__TOCDet/Attribute/DeclaringType = PRich
TryGetP/__TOCDet/Attribute/Description = Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
TryGetP/__TOCDet/Attribute/MethodName = TryGetP
TryGetP/__TOCDet/Attribute/MethodSignature = Boolean TryGetP0x005BT0x005D(ARCCore.IK, T ByRef, System.String ByRef)
TryGetV/__TOCDet/Assembly = ARCDoc
TryGetV/__TOCDet/Description = Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).0x000D0x000A0x000D0x000ASee -Value- for information about when this method IS relevant (when storing metadata about a property).
TryGetV/__TOCDet/DocFragType = ClassMember
TryGetV/__TOCDet/IsInherited = True
TryGetV/__TOCDet/IsInheritedDoc = True
TryGetV/__TOCDet/Name = TryGetV
TryGetV/__TOCDet/Namespace = ARCDoc
TryGetV/__TOCDet/Type = HLocation
TryGetV/__TOCDet/Attribute/DeclaringType = PRich
TryGetV/__TOCDet/Attribute/Description = Note that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).0x000D0x000A0x000D0x000ASee -Value- for information about when this method IS relevant (when storing metadata about a property).
TryGetV/__TOCDet/Attribute/MethodName = TryGetV
TryGetV/__TOCDet/Attribute/MethodSignature = Boolean TryGetV0x005BTRequest0x005D(TRequest ByRef, System.String ByRef)

Edit single sub keys only: __TOCDet / Content / ToString / TryGetP / TryGetV

Generated 2025-05-23 01:21:33.303 UTC