/ doc / toc / ARCDoc / Class / DocLinkCollection

DocLinkCollection

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 = Contains a collection of -DocLink- objects.0x000D0x000A
__TOCDet/DocFragType = Class
__TOCDet/Name = DocLinkCollection
__TOCDet/Namespace = ARCDoc
__TOCDet/Type = DocLinkCollection
__TOCDet/Attribute/AssemblyName = ARCDoc
__TOCDet/Attribute/BaseTypes = PRich
__TOCDet/Attribute/ClassNamespace = ARCDoc
__TOCDet/Attribute/ClassType = DocLinkCollection
__TOCDet/Attribute/Description = Contains a collection of -DocLink- objects.0x000D0x000A
__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
Create/__TOCDet/Assembly = ARCDoc
Create/__TOCDet/Description = Notes all locations and their positions in the hierarchical directory structure. 0x000D0x000ACreates one or more -DocLink- for every -HLocation- given.0x000D0x000A0x000D0x000AFor instance, if sees a location called 'Assembly/ARCDoc/Class/Apple.html', that is a file 'Apple.html' in location ''Assembly/ARCDoc/Class' it will will create a potential link to that location for -Apple-.0x000D0x000A0x000D0x000AOnly the first word in the filename will be used.0x000D0x000A0x000D0x000AThe result is used by -InsertLinks- which whenever it sees -Apple- in the given HTML, will replace it with the corresponding link.0x000D0x000A0x000D0x000ADuplicate potential links are linked to a resolution page (See -DocLinkResolution-).0x000D0x000ASo for instance if multiple files have -ARCDoc- as a potential link, then it will resolve to such a resolution page.0x000D0x000A0x000D0x000AThe parameter specialPrefixes contains prefixes for which links are also desired for potential links without the prefix.0x000D0x000ASee -ARCQuery-.-QUtil- for example of use.0x000D0x000A0x000D0x000ASee also -DescribeValue, inner function prepareForLinkInsertionIfNoWhitespace.0x000D0x000A
Create/__TOCDet/DocFragType = ClassMember
Create/__TOCDet/IsInherited = False
Create/__TOCDet/IsInheritedDoc = False
Create/__TOCDet/Lines = 17
Create/__TOCDet/Name = Create
Create/__TOCDet/Namespace = ARCDoc
Create/__TOCDet/Type = DocLinkCollection
Create/__TOCDet/Attribute/DeclaringType = DocLinkCollection
Create/__TOCDet/Attribute/Description = Notes all locations and their positions in the hierarchical directory structure. 0x000D0x000ACreates one or more -DocLink- for every -HLocation- given.0x000D0x000A0x000D0x000AFor instance, if sees a location called 'Assembly/ARCDoc/Class/Apple.html', that is a file 'Apple.html' in location ''Assembly/ARCDoc/Class' it will will create a potential link to that location for -Apple-.0x000D0x000A0x000D0x000AOnly the first word in the filename will be used.0x000D0x000A0x000D0x000AThe result is used by -InsertLinks- which whenever it sees -Apple- in the given HTML, will replace it with the corresponding link.0x000D0x000A0x000D0x000ADuplicate potential links are linked to a resolution page (See -DocLinkResolution-).0x000D0x000ASo for instance if multiple files have -ARCDoc- as a potential link, then it will resolve to such a resolution page.0x000D0x000A0x000D0x000AThe parameter specialPrefixes contains prefixes for which links are also desired for potential links without the prefix.0x000D0x000ASee -ARCQuery-.-QUtil- for example of use.0x000D0x000A0x000D0x000ASee also -DescribeValue, inner function prepareForLinkInsertionIfNoWhitespace.0x000D0x000A
Create/__TOCDet/Attribute/MethodName = Create
Create/__TOCDet/Attribute/MethodSignature = System.ValueTuple0x006020x005BARCDoc.DocLinkCollection,ARCDoc.DocLinkResolutionCollection0x005D Create(ARCDoc.HLocationCollection, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.Collections.Generic.List0x006010x005BSystem.String0x005D)
InsertLinks/__TOCDet/_Description = 2 items
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Assembly = ARCDoc
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Description = Does -LinkInsertionInDocumentation- on the given HTML content.0x000D0x000A0x000D0x000AReplaces all occurrences of any -0x005BHTMLLink0x005D- with corresponding '0x003Ca href = "...' tag.0x000D0x000A0x000D0x000ANOTE: Only works when documentation is in the same root as the current location,0x000D0x000ANOTE: typically when current location starts with RQ, like RQ/dt/Customer/42 and documentation is under RQ/doc/...0x000D0x000ANOTE:0x000D0x000ANOTE: See overload with 'toDoc' parameter for use when caller 'knows' how to navigate to -doc-.0x000D0x000A0x000D0x000ATODO: Possible easy improvement for better performance:0x000D0x000ATODO: DocLinks could be grouped by first letters or similar0x000D0x000ATODO: If hyphen + that letter do not exist, then we can skip that group altogether.0x000D0x000ATDDO: This should greatly speed up insertion of links in small documents.
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/DocFragType = ClassMember
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/IsInherited = False
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/IsInheritedDoc = False
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Lines = 13
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Name = InsertLinks
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Namespace = ARCDoc
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Type = DocLinkCollection
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Attribute/DeclaringType = DocLinkCollection
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Attribute/Description = Does -LinkInsertionInDocumentation- on the given HTML content.0x000D0x000A0x000D0x000AReplaces all occurrences of any -0x005BHTMLLink0x005D- with corresponding '0x003Ca href = "...' tag.0x000D0x000A0x000D0x000ANOTE: Only works when documentation is in the same root as the current location,0x000D0x000ANOTE: typically when current location starts with RQ, like RQ/dt/Customer/42 and documentation is under RQ/doc/...0x000D0x000ANOTE:0x000D0x000ANOTE: See overload with 'toDoc' parameter for use when caller 'knows' how to navigate to -doc-.0x000D0x000A0x000D0x000ATODO: Possible easy improvement for better performance:0x000D0x000ATODO: DocLinks could be grouped by first letters or similar0x000D0x000ATODO: If hyphen + that letter do not exist, then we can skip that group altogether.0x000D0x000ATDDO: This should greatly speed up insertion of links in small documents.
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Attribute/MethodName = InsertLinks
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload1/__TOCDet/Attribute/MethodSignature = System.String InsertLinks(System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.String)
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Assembly = ARCDoc
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Description = See overload with 'contentLocation' as parameter for documentation.0x000D0x000A0x000D0x000AThe toDoc parameter will typically look like "/RQ"/ when "doc" is residing under "RQ" like "RQ/doc/...".0x000D0x000A0x000D0x000A
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/DocFragType = ClassMember
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/IsInherited = False
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/IsInheritedDoc = False
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Lines = 5
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Name = InsertLinks
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Namespace = ARCDoc
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Type = DocLinkCollection
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Attribute/DeclaringType = DocLinkCollection
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Attribute/Description = See overload with 'contentLocation' as parameter for documentation.0x000D0x000A0x000D0x000AThe toDoc parameter will typically look like "/RQ"/ when "doc" is residing under "RQ" like "RQ/doc/...".0x000D0x000A0x000D0x000A
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Attribute/MethodName = InsertLinks
InsertLinks/ARCDoc.DocLinkCollection.InsertLinks Overload2/__TOCDet/Attribute/MethodSignature = System.String InsertLinks(System.String, System.String)
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 = DocLinkCollection
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 = DocLinkCollection
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 = DocLinkCollection
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 / Create / InsertLinks / ToString / TryGetP / TryGetV

Generated 2024-06-02 22:45:57.597 UTC