[ROOT] / doc / toc / ARCDoc / Class / DocLink
AHrefEndPart , Filename , LinkWordHTML , LinkWordHTMLBeforeLt , LinkWordHTMLBeforeLtWithHyphens , LinkWordHTMLWithHyphens , Location , ToString , TryGetP , TryGetV
Describes to where a single HTML link points.
By link we mean a link according to LinkInsertionInDocumentation, that is words in an HTML-document like -MyCustomerClass-.
This class works with HTML, like LinkWordHTML being encoded in HTML, so for instance a link to a generic class like -MyCustomerClass<T>- actually looks like -MyCustomerClass<T>-.
Used as input to InsertLinks (telling it what to look for, and how to replace the text with a corresponding '<a href = ...' tag)
Note how there is almost a one-to-one match between HLocation and DocLink with the latter pointing to a corresponding instance of the former. It is only when we have duplicate filenames that DocLink will instead point to a dedicated DocLinkResolution page for that filename.
Note that out of performance needs this class has a duplicate storage of properties.
(Ordinary IP for debugging / querying needs, and traditional C# properties for higher performance).
This class should therefore not be changed after initialization (nor is it any need to), as it can easily lead to out-of-sync issues.
NOTE: / TODO: One might argue for leaving out LinkWordHTMLBeforeLt
NOTE: / TODO: and instead use TWO instances of DocLink when '<' is encountered when creating instances of this class.
NOTE: / TODO: There are both pros and cons for this approach.
| AHrefEndPart | 'Filename.Encoded + "> + LinkWordHTML + </a>' |
| Filename | Copy of LinkWordHTML. |
| LinkWordHTML | Copy of LinkWordHTML. |
| LinkWordHTMLBeforeLt | If -LinkWordHTML contains '<' (really '<') (for generic types, like 'PValue<TValue>') then this will contain the part before '<' like 'PValue'. |
| LinkWordHTMLBeforeLtWithHyphens | LinkWordHTMLBeforeLt with '-' (minus sign / hyphen) prepended and appended. |
| LinkWordHTMLWithHyphens | LinkWordHTML with '-' (minus sign / hyphen) prepended and appended. |
| Location | Copy of Location. |
| ToString | TODO: Decide on what we actually want with ToString for this class. |
| TryGetP | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| TryGetV | 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). |
Generated 2025-05-22 18:50:56.227 UTC