/ doc / toc / ARCDoc / Class / Extensions

Extensions

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 various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML.0x000D0x000A0x000D0x000ASee for instance -ToHTMLSimpleSingle- which transforms any -IP- object into an HTML representation.0x000D0x000A
__TOCDet/DocFragType = Class
__TOCDet/Name = Extensions
__TOCDet/Namespace = ARCDoc
__TOCDet/Type = Extensions
__TOCDet/Attribute/AssemblyName = ARCDoc
__TOCDet/Attribute/ClassNamespace = ARCDoc
__TOCDet/Attribute/ClassType = Extensions
__TOCDet/Attribute/Description = Contains various extension methods for -IP- and -IKIP- related to documentating / reporting / HTML.0x000D0x000A0x000D0x000ASee for instance -ToHTMLSimpleSingle- which transforms any -IP- object into an HTML representation.0x000D0x000A
DescribeValue/__TOCDet/Assembly = ARCDoc
DescribeValue/__TOCDet/Description = 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
DescribeValue/__TOCDet/DocFragType = ClassMember
DescribeValue/__TOCDet/IsInherited = False
DescribeValue/__TOCDet/IsInheritedDoc = False
DescribeValue/__TOCDet/Lines = 20
DescribeValue/__TOCDet/Name = DescribeValue
DescribeValue/__TOCDet/Namespace = ARCDoc
DescribeValue/__TOCDet/Type = Extensions
DescribeValue/__TOCDet/Attribute/DeclaringType = Extensions
DescribeValue/__TOCDet/Attribute/Description = 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
DescribeValue/__TOCDet/Attribute/MethodName = DescribeValue
DescribeValue/__TOCDet/Attribute/MethodSignature = System.String DescribeValue(ARCCore.IKIP, Boolean)
GetHelptextHTML/__TOCDet/Assembly = ARCDoc
GetHelptextHTML/__TOCDet/Description = Returns content of -Description- and -LongDescription-.0x000D0x000A0x000D0x000AReturns text suitable for including within a 0x003Cspan title = "..." ... 0x003C/span0x003E0x000D0x000A0x000D0x000ANote how removes all hypens, that is, disables -LinkInsertionInDocumentation- because -InsertLinks- would have blindly destroyed the 0x003Cspan title = "..." ... 0x003C/span0x003E with 0x003Ca href="..."0x003E inside.
GetHelptextHTML/__TOCDet/DocFragType = ClassMember
GetHelptextHTML/__TOCDet/IsInherited = False
GetHelptextHTML/__TOCDet/IsInheritedDoc = False
GetHelptextHTML/__TOCDet/Lines = 5
GetHelptextHTML/__TOCDet/Name = GetHelptextHTML
GetHelptextHTML/__TOCDet/Namespace = ARCDoc
GetHelptextHTML/__TOCDet/Type = Extensions
GetHelptextHTML/__TOCDet/Attribute/DeclaringType = Extensions
GetHelptextHTML/__TOCDet/Attribute/Description = Returns content of -Description- and -LongDescription-.0x000D0x000A0x000D0x000AReturns text suitable for including within a 0x003Cspan title = "..." ... 0x003C/span0x003E0x000D0x000A0x000D0x000ANote how removes all hypens, that is, disables -LinkInsertionInDocumentation- because -InsertLinks- would have blindly destroyed the 0x003Cspan title = "..." ... 0x003C/span0x003E with 0x003Ca href="..."0x003E inside.
GetHelptextHTML/__TOCDet/Attribute/MethodName = GetHelptextHTML
GetHelptextHTML/__TOCDet/Attribute/MethodSignature = System.String GetHelptextHTML(ARCCore.BaseAttribute)
KeyToHTMLSimpleWithTooltip/__TOCDet/Assembly = ARCDoc
KeyToHTMLSimpleWithTooltip/__TOCDet/Description = Creates a simple HTML representation of the Key with description as a 'tooltip'.
KeyToHTMLSimpleWithTooltip/__TOCDet/DocFragType = ClassMember
KeyToHTMLSimpleWithTooltip/__TOCDet/IsInherited = False
KeyToHTMLSimpleWithTooltip/__TOCDet/IsInheritedDoc = False
KeyToHTMLSimpleWithTooltip/__TOCDet/Lines = 1
KeyToHTMLSimpleWithTooltip/__TOCDet/Name = KeyToHTMLSimpleWithTooltip
KeyToHTMLSimpleWithTooltip/__TOCDet/Namespace = ARCDoc
KeyToHTMLSimpleWithTooltip/__TOCDet/Type = Extensions
KeyToHTMLSimpleWithTooltip/__TOCDet/Attribute/DeclaringType = Extensions
KeyToHTMLSimpleWithTooltip/__TOCDet/Attribute/Description = Creates a simple HTML representation of the Key with description as a 'tooltip'.
KeyToHTMLSimpleWithTooltip/__TOCDet/Attribute/MethodName = KeyToHTMLSimpleWithTooltip
KeyToHTMLSimpleWithTooltip/__TOCDet/Attribute/MethodSignature = System.String KeyToHTMLSimpleWithTooltip(ARCCore.IK)
ToHTMLSimpleAsTableRow/__TOCDet/Assembly = ARCDoc
ToHTMLSimpleAsTableRow/__TOCDet/Description = Creates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table.0x000D0x000A0x000D0x000ABy simple we mean that no Javascript library is involved, only standard HTML, CSS and Javascript.0x000D0x000A0x000D0x000ABy single we mean that no recursion will be performed (for recursion see -Create-.0x000D0x000AIt is assumed that the actual property can be linked to with the given link context and -Key- as reference.0x000D0x000A0x000D0x000AIf the key ends with Id and value is in the form '(key minus Id) plus slash plus value', like CustomerId = Customer/42, then will assume that can create link of value.0x000D0x000ANote how this is totally independent of any predefined structure.0x000D0x000A0x000D0x000ANote that -ARCAPI- offers additional functionality for generating HTML views.
ToHTMLSimpleAsTableRow/__TOCDet/DocFragType = ClassMember
ToHTMLSimpleAsTableRow/__TOCDet/IsInherited = False
ToHTMLSimpleAsTableRow/__TOCDet/IsInheritedDoc = False
ToHTMLSimpleAsTableRow/__TOCDet/Lines = 11
ToHTMLSimpleAsTableRow/__TOCDet/Name = ToHTMLSimpleAsTableRow
ToHTMLSimpleAsTableRow/__TOCDet/Namespace = ARCDoc
ToHTMLSimpleAsTableRow/__TOCDet/Type = Extensions
ToHTMLSimpleAsTableRow/__TOCDet/Attribute/DeclaringType = Extensions
ToHTMLSimpleAsTableRow/__TOCDet/Attribute/Description = Creates a simple HTML representation of the given parameter as a single two column row (Key, Value) in a table.0x000D0x000A0x000D0x000ABy simple we mean that no Javascript library is involved, only standard HTML, CSS and Javascript.0x000D0x000A0x000D0x000ABy single we mean that no recursion will be performed (for recursion see -Create-.0x000D0x000AIt is assumed that the actual property can be linked to with the given link context and -Key- as reference.0x000D0x000A0x000D0x000AIf the key ends with Id and value is in the form '(key minus Id) plus slash plus value', like CustomerId = Customer/42, then will assume that can create link of value.0x000D0x000ANote how this is totally independent of any predefined structure.0x000D0x000A0x000D0x000ANote that -ARCAPI- offers additional functionality for generating HTML views.
ToHTMLSimpleAsTableRow/__TOCDet/Attribute/MethodName = ToHTMLSimpleAsTableRow
ToHTMLSimpleAsTableRow/__TOCDet/Attribute/MethodSignature = System.String ToHTMLSimpleAsTableRow(ARCCore.IKIP, System.String, Boolean, System.String)
ToHTMLSimpleSingle/__TOCDet/Assembly = ARCDoc
ToHTMLSimpleSingle/__TOCDet/Description = Creates a simple HTML representation of the given parameter.0x000D0x000A0x000D0x000AThe properties are shown as a two column table with heading Key and Value.0x000D0x000A0x000D0x000ABy simple we mean that no Javascript library is involved, only standard HTML, CSS and Javascript.0x000D0x000ABy single we mean that no recursion will be performed (for recursion see -Create-).0x000D0x000ALinks are attempted inserted using 'linkContext' in order to generate relative links.0x000D0x000A0x000D0x000AIf 'linkContext' is given then0x000D0x000A1) Its last value will be taken as the Key for what we is generated now.0x000D0x000A2) Backlinking will be done (linking one step up in hierarchical structure, for instance going from '.../Customer/42' to '.../Customer' (viewing all Customers).0x000D0x000A0x000D0x000AIf 'linkContext' is not given then links will be generated as '/RQ/dt/...',  that is, assuming a specific hierarchical structure. This usually works well.0x000D0x000A0x000D0x000A0x000D0x000AIf the link context contains a '*', it is assumed that from that level and down the hierarchical structure has been flattened into a single HTML page page, in other words, that the links are internally on the same page.This is in order to accompany wildcards in REST queries like 'RQ/Assembly/ARCCore/Class/ActualConnection/*.html'.0x000D0x000A0x000D0x000AIf you have a specific implementation of -IP- that needs a different HTML representation than what is offered by this method, then you can just implement a method with this same signature for that implementation.0x000D0x000AYou may also reuse functionality from here by calling -ToHTMLSimpleSingleInternal-.0x000D0x000A0x000D0x000ANote that -ARCAPI- offers additional functionality for generating HTML views.0x000D0x000AFor instance this method is not very well suited to represent a uniform collection of objects, something which -ARCAPI- offers.0x000D0x000AIn other words, this method is very suitable for representing a single 'Customer' object, but not a uniform collection of 'Customer' objects (a 'CustomerCollection').
ToHTMLSimpleSingle/__TOCDet/DocFragType = ClassMember
ToHTMLSimpleSingle/__TOCDet/IsInherited = False
ToHTMLSimpleSingle/__TOCDet/IsInheritedDoc = False
ToHTMLSimpleSingle/__TOCDet/Lines = 34
ToHTMLSimpleSingle/__TOCDet/LongDescription = NOTE: If you actually implement this method (-ToHTMLSimpleSingle-) in your own class0x000D0x000ANOTE: (something which you quite naturally will want to do).0x000D0x000ANOTE: then it would by default (in .NET) not be called if the (statically known) type of the object0x000D0x000ANOTE: at the time of invocation was -IP- (instead of the actual type).0x000D0x000ANOTE: 0x000D0x000ANOTE: This extension method therefore uses reflection in order to look for a specific implementation NOTE: in the (dynamically known) type of the -IP- parameter NOTE: and calls that method instead if found.0x000D0x000ANOTE: (this is also the reason for having -ToHTMLSimpleSingleInternal-.)0x000D0x000ANOTE: 0x000D0x000ANOTE: See this article for more information0x000D0x000ANOTE: https://stackoverflow.com/questions/30645441/extension-methods-with-base-and-sub-classes 0x000D0x000A
ToHTMLSimpleSingle/__TOCDet/Name = ToHTMLSimpleSingle
ToHTMLSimpleSingle/__TOCDet/Namespace = ARCDoc
ToHTMLSimpleSingle/__TOCDet/Type = Extensions
ToHTMLSimpleSingle/__TOCDet/Attribute/DeclaringType = Extensions
ToHTMLSimpleSingle/__TOCDet/Attribute/Description = Creates a simple HTML representation of the given parameter.0x000D0x000A0x000D0x000AThe properties are shown as a two column table with heading Key and Value.0x000D0x000A0x000D0x000ABy simple we mean that no Javascript library is involved, only standard HTML, CSS and Javascript.0x000D0x000ABy single we mean that no recursion will be performed (for recursion see -Create-).0x000D0x000ALinks are attempted inserted using 'linkContext' in order to generate relative links.0x000D0x000A0x000D0x000AIf 'linkContext' is given then0x000D0x000A1) Its last value will be taken as the Key for what we is generated now.0x000D0x000A2) Backlinking will be done (linking one step up in hierarchical structure, for instance going from '.../Customer/42' to '.../Customer' (viewing all Customers).0x000D0x000A0x000D0x000AIf 'linkContext' is not given then links will be generated as '/RQ/dt/...',  that is, assuming a specific hierarchical structure. This usually works well.0x000D0x000A0x000D0x000A0x000D0x000AIf the link context contains a '*', it is assumed that from that level and down the hierarchical structure has been flattened into a single HTML page page, in other words, that the links are internally on the same page.This is in order to accompany wildcards in REST queries like 'RQ/Assembly/ARCCore/Class/ActualConnection/*.html'.0x000D0x000A0x000D0x000AIf you have a specific implementation of -IP- that needs a different HTML representation than what is offered by this method, then you can just implement a method with this same signature for that implementation.0x000D0x000AYou may also reuse functionality from here by calling -ToHTMLSimpleSingleInternal-.0x000D0x000A0x000D0x000ANote that -ARCAPI- offers additional functionality for generating HTML views.0x000D0x000AFor instance this method is not very well suited to represent a uniform collection of objects, something which -ARCAPI- offers.0x000D0x000AIn other words, this method is very suitable for representing a single 'Customer' object, but not a uniform collection of 'Customer' objects (a 'CustomerCollection').
ToHTMLSimpleSingle/__TOCDet/Attribute/LongDescription = NOTE: If you actually implement this method (-ToHTMLSimpleSingle-) in your own class0x000D0x000ANOTE: (something which you quite naturally will want to do).0x000D0x000ANOTE: then it would by default (in .NET) not be called if the (statically known) type of the object0x000D0x000ANOTE: at the time of invocation was -IP- (instead of the actual type).0x000D0x000ANOTE: 0x000D0x000ANOTE: This extension method therefore uses reflection in order to look for a specific implementation NOTE: in the (dynamically known) type of the -IP- parameter NOTE: and calls that method instead if found.0x000D0x000ANOTE: (this is also the reason for having -ToHTMLSimpleSingleInternal-.)0x000D0x000ANOTE: 0x000D0x000ANOTE: See this article for more information0x000D0x000ANOTE: https://stackoverflow.com/questions/30645441/extension-methods-with-base-and-sub-classes 0x000D0x000A
ToHTMLSimpleSingle/__TOCDet/Attribute/MethodName = ToHTMLSimpleSingle
ToHTMLSimpleSingle/__TOCDet/Attribute/MethodSignature = System.String ToHTMLSimpleSingle(ARCCore.IP, Boolean, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D)
ToHTMLSimpleSingleInternal/__TOCDet/Assembly = ARCDoc
ToHTMLSimpleSingleInternal/__TOCDet/Description = Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-.
ToHTMLSimpleSingleInternal/__TOCDet/DocFragType = ClassMember
ToHTMLSimpleSingleInternal/__TOCDet/IsInherited = False
ToHTMLSimpleSingleInternal/__TOCDet/IsInheritedDoc = False
ToHTMLSimpleSingleInternal/__TOCDet/Lines = 1
ToHTMLSimpleSingleInternal/__TOCDet/Name = ToHTMLSimpleSingleInternal
ToHTMLSimpleSingleInternal/__TOCDet/Namespace = ARCDoc
ToHTMLSimpleSingleInternal/__TOCDet/Type = Extensions
ToHTMLSimpleSingleInternal/__TOCDet/Attribute/DeclaringType = Extensions
ToHTMLSimpleSingleInternal/__TOCDet/Attribute/Description = Hack in order to escape check for direct implementation in actual class of -ToHTMLSimpleSingle- in -ToHTMLSimpleSingle-.
ToHTMLSimpleSingleInternal/__TOCDet/Attribute/MethodName = ToHTMLSimpleSingleInternal
ToHTMLSimpleSingleInternal/__TOCDet/Attribute/MethodSignature = System.String ToHTMLSimpleSingleInternal(ARCCore.IP, Boolean, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D)
ToHTMLSimpleSingleRecursive/__TOCDet/Assembly = ARCDoc
ToHTMLSimpleSingleRecursive/__TOCDet/Description = Calls -ToHTMLSimpleSingle- recursively.0x000D0x000AIn other words, flattens out a hierarchical structure into one single 'flat' HTML file.0x000D0x000A0x000D0x000ATODO: See -ToHTMLSimpleSingle-, add use of reflection in order to call any class implementation of this method instead.
ToHTMLSimpleSingleRecursive/__TOCDet/DocFragType = ClassMember
ToHTMLSimpleSingleRecursive/__TOCDet/IsInherited = False
ToHTMLSimpleSingleRecursive/__TOCDet/IsInheritedDoc = False
ToHTMLSimpleSingleRecursive/__TOCDet/Lines = 4
ToHTMLSimpleSingleRecursive/__TOCDet/Name = ToHTMLSimpleSingleRecursive
ToHTMLSimpleSingleRecursive/__TOCDet/Namespace = ARCDoc
ToHTMLSimpleSingleRecursive/__TOCDet/Type = Extensions
ToHTMLSimpleSingleRecursive/__TOCDet/Attribute/DeclaringType = Extensions
ToHTMLSimpleSingleRecursive/__TOCDet/Attribute/Description = Calls -ToHTMLSimpleSingle- recursively.0x000D0x000AIn other words, flattens out a hierarchical structure into one single 'flat' HTML file.0x000D0x000A0x000D0x000ATODO: See -ToHTMLSimpleSingle-, add use of reflection in order to call any class implementation of this method instead.
ToHTMLSimpleSingleRecursive/__TOCDet/Attribute/MethodName = ToHTMLSimpleSingleRecursive
ToHTMLSimpleSingleRecursive/__TOCDet/Attribute/MethodSignature = System.String ToHTMLSimpleSingleRecursive(ARCCore.IP, Boolean, System.Collections.Generic.List0x006010x005BARCCore.IKCoded0x005D, System.Text.StringBuilder)
ValueToHTMLSimpleWithTooltip/__TOCDet/Assembly = ARCDoc
ValueToHTMLSimpleWithTooltip/__TOCDet/Description = Creates a simple HTML representation of the Value with description as a 'tooltip'.0x000D0x000A0x000D0x000AReturned value is intended for location inside a 0x003Ctd0x003E...0x003C/td0x003E or similiar (returned value is not enclosed within 0x003Cp0x003E...0x003C/p0x003E for instance.0x000D0x000A0x000D0x000AReturns '&nbsp0x003B' if no value found.0x000D0x000A0x000D0x000ANote: The tooltip is only relevant when value itself has a -BaseAttribute-, as of Apr 2020 this is only checked for enum members / enum values.
ValueToHTMLSimpleWithTooltip/__TOCDet/DocFragType = ClassMember
ValueToHTMLSimpleWithTooltip/__TOCDet/IsInherited = False
ValueToHTMLSimpleWithTooltip/__TOCDet/IsInheritedDoc = False
ValueToHTMLSimpleWithTooltip/__TOCDet/Lines = 7
ValueToHTMLSimpleWithTooltip/__TOCDet/Name = ValueToHTMLSimpleWithTooltip
ValueToHTMLSimpleWithTooltip/__TOCDet/Namespace = ARCDoc
ValueToHTMLSimpleWithTooltip/__TOCDet/Type = Extensions
ValueToHTMLSimpleWithTooltip/__TOCDet/Attribute/DeclaringType = Extensions
ValueToHTMLSimpleWithTooltip/__TOCDet/Attribute/Description = Creates a simple HTML representation of the Value with description as a 'tooltip'.0x000D0x000A0x000D0x000AReturned value is intended for location inside a 0x003Ctd0x003E...0x003C/td0x003E or similiar (returned value is not enclosed within 0x003Cp0x003E...0x003C/p0x003E for instance.0x000D0x000A0x000D0x000AReturns '&nbsp0x003B' if no value found.0x000D0x000A0x000D0x000ANote: The tooltip is only relevant when value itself has a -BaseAttribute-, as of Apr 2020 this is only checked for enum members / enum values.
ValueToHTMLSimpleWithTooltip/__TOCDet/Attribute/MethodName = ValueToHTMLSimpleWithTooltip
ValueToHTMLSimpleWithTooltip/__TOCDet/Attribute/MethodSignature = System.String ValueToHTMLSimpleWithTooltip(ARCCore.IP)

Edit single sub keys only: __TOCDet / DescribeValue / GetHelptextHTML / KeyToHTMLSimpleWithTooltip / ToHTMLSimpleAsTableRow / ToHTMLSimpleSingle / ToHTMLSimpleSingleInternal / ToHTMLSimpleSingleRecursive / ValueToHTMLSimpleWithTooltip

Generated 2025-03-26 10:01:30.889 UTC