/ doc / DocFrag / ARCDoc.Extensions.DescribeValue / Description

Description

Edit keys at this level only

= Describes the value contained withing an -IKIP- (-P-).0x000D0x000A0x000D0x000AUseful in drill-down situations, where -P- has no intrinsic value itself but contains properties / links to new values. In that case the description could for instance include list of keys found 'one level further down' (assuming not too may of them present).0x000D0x000A0x000D0x000ACan in a worst case scenario return an empty string, for instance if no intrinsic value, no description and noe keys to list.0x000D0x000A0x000D0x000AIf parameter prepareForLinkInsertion is given then will attempt to do -LinkInsertionInDocumentation- if there is a high probability that the returned value is a link This is somewhat experimental as of May 2020.0x000D0x000AAn example for when this is relevant is for a documentation page like0x000D0x000AAssembly/ARCCore/AREnumType/DocumentationOnlyEnum/ARComponents/_Member/ARADB.html0x000D0x000AHere values like EnumMember and EnumType should link to actual values,0x000D0x000Aso instead of a table-row (key value) listing like0x000D0x000A  EnumMember   ARADB0x000D0x000A  EnumType     ARCCore.ARComponents0x000D0x000AThis method describes the values as0x000D0x000A  EnumMember   -ARADB-0x000D0x000A  EnumType     -ARCCore.ARComponents-0x000D0x000Afor later link insertion.0x000D0x000A0x000D0x000ATODO: Add parameters describing when to list keys or not, and when to use linking.TODO: Also, ensure that can link values like Customer/42 (but calling method should do that?)0x000D0x000A

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

Generated 2025-08-26 04:47:59.536 UTC