/ doc / tocInheritance / IP / BaseAttribute / EnumMemberAttribute / BasePKAttribute

BasePKAttribute

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 = ARCCore
__TOCDet/Description = The class containing the actual attributes used for -TaggingOfPropertyKeys-. 0x000D0x000ATODO: Rename into PKBaseAttribute?.0x000D0x000A0x000D0x000AInstances of this class are accessed through -PK-.0x000D0x000A0x000D0x000ASome sub-classes included in -ARCCore- are:0x000D0x000A-PKTypeAttribute-: Contains the most basic essential information about a property key.0x000D0x000A-PKRelAttribute-: Describes relationships between entities.0x000D0x000A-PKHTMLAttribute-: Contains pointer to HTML encoder for a property.0x000D0x000A-PKLogAttribute-: Explains how logging of changes to a property should be done.0x000D0x000A0x000D0x000AOther -ARComponents- define their own sub-classes like:0x000D0x000A-ARCDoc-: -PKDocAttribute-,0x000D0x000A0x000D0x000AYou are also encouraged to create your own instances in your -ApplicationSpecificCode- for special needs.0x000D0x000ATODO: One idea is a TTL (Time-to-live) tag for a property when that property constitues a command to do something0x000D0x000ATODO: for instance turning on a switch in a IoT system (in case of communications failure somewhere in the system, queuing a series0x000D0x000ATODO: of turn-on, turn-off, turn-on attempts would have little meaning.0x000D0x000A0x000D0x000ANOTE / TODO: Having this class inherit EnumMemberAttribute makes for a complicated inheritance hierarchy. It might therefore be a good idea to just duplicate the function of EnumMemberAttribute into this class and letting it inherit BaseAttribute directly.0x000D0x000A0x000D0x000ASee also analogue -IPAttribute- which describes classes (describes at class levels).
__TOCDet/DocFragType = Class
__TOCDet/Name = BasePKAttribute
__TOCDet/Namespace = ARCCore
__TOCDet/Type = BasePKAttribute
__TOCDet/Attribute/AssemblyName = ARCCore
__TOCDet/Attribute/BaseTypes = Attribute0x003BBaseAttribute0x003BEnumMemberAttribute
__TOCDet/Attribute/ClassNamespace = ARCCore
__TOCDet/Attribute/ClassType = BasePKAttribute
__TOCDet/Attribute/Description = The class containing the actual attributes used for -TaggingOfPropertyKeys-. 0x000D0x000ATODO: Rename into PKBaseAttribute?.0x000D0x000A0x000D0x000AInstances of this class are accessed through -PK-.0x000D0x000A0x000D0x000ASome sub-classes included in -ARCCore- are:0x000D0x000A-PKTypeAttribute-: Contains the most basic essential information about a property key.0x000D0x000A-PKRelAttribute-: Describes relationships between entities.0x000D0x000A-PKHTMLAttribute-: Contains pointer to HTML encoder for a property.0x000D0x000A-PKLogAttribute-: Explains how logging of changes to a property should be done.0x000D0x000A0x000D0x000AOther -ARComponents- define their own sub-classes like:0x000D0x000A-ARCDoc-: -PKDocAttribute-,0x000D0x000A0x000D0x000AYou are also encouraged to create your own instances in your -ApplicationSpecificCode- for special needs.0x000D0x000ATODO: One idea is a TTL (Time-to-live) tag for a property when that property constitues a command to do something0x000D0x000ATODO: for instance turning on a switch in a IoT system (in case of communications failure somewhere in the system, queuing a series0x000D0x000ATODO: of turn-on, turn-off, turn-on attempts would have little meaning.0x000D0x000A0x000D0x000ANOTE / TODO: Having this class inherit EnumMemberAttribute makes for a complicated inheritance hierarchy. It might therefore be a good idea to just duplicate the function of EnumMemberAttribute into this class and letting it inherit BaseAttribute directly.0x000D0x000A0x000D0x000ASee also analogue -IPAttribute- which describes classes (describes at class levels).
__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
__TOCDet/Attribute/SubTypes = PKDocAttribute
PKDocAttribute/__TOCDet/Assembly = ARCDoc
PKDocAttribute/__TOCDet/Description = Describes documentation and presentation of a property.0x000D0x000ANote: As of Mar 2021 only in use by -DescribeValue-.0x000D0x000A0x000D0x000ASee also -PKDocAttributeP-.
PKDocAttribute/__TOCDet/DocFragType = Class
PKDocAttribute/__TOCDet/Name = PKDocAttribute
PKDocAttribute/__TOCDet/Namespace = ARCDoc
PKDocAttribute/__TOCDet/Type = PKDocAttribute
PKDocAttribute/__TOCDet/Attribute/AssemblyName = ARCDoc
PKDocAttribute/__TOCDet/Attribute/BaseTypes = Attribute0x003BBaseAttribute0x003BEnumMemberAttribute0x003BBasePKAttribute
PKDocAttribute/__TOCDet/Attribute/ClassNamespace = ARCDoc
PKDocAttribute/__TOCDet/Attribute/ClassType = PKDocAttribute
PKDocAttribute/__TOCDet/Attribute/CorrespondingEnumType = PKDocAttributeP
PKDocAttribute/__TOCDet/Attribute/Description = Describes documentation and presentation of a property.0x000D0x000ANote: As of Mar 2021 only in use by -DescribeValue-.0x000D0x000A0x000D0x000ASee also -PKDocAttributeP-.
PKDocAttribute/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
PKHTMLAttribute/__TOCDet/Assembly = ARCCore
PKHTMLAttribute/__TOCDet/Description = Contains pointer to HTML encoder for a property.0x000D0x000A0x000D0x000AThe encoder replaces any standard mechanism used for HTML encoding a single property.0x000D0x000AIt is useful for instance for showing images, where the property value can be for instance a Base64-encoding of the binary data which the encoder converts into an HTML 0x003CIMG0x003E tag.0x000D0x000A0x000D0x000AUsed in -ARCCore- by class -Extensions- method -ToHTMLSimpleAsTableRow-.0x000D0x000AUsed in -ARCQuery- by class -QueryProgressDetails- method -ToHTMLSimpleSingle-.0x000D0x000A0x000D0x000AThis attribute can be used in two distinct manners:0x000D0x000A0x000D0x000A1) Manually in C#, that is, at -TaggingOfPropertyKeys- like:0x000D0x000A   0x005BPKHtml(Encoder = typeof(PictureEncoder))0x005D0x000D0x000A   Picture,0x000D0x000Afor a specific property called 'Picture'.0x000D0x000Aor0x000D0x000A2) Use a class implementing -ITypeDescriber- which through the EnrichKey-principle in that interface, supplies this attribute (PKHTMLAttribute) with the necessary encoder.0x000D0x000AIn this manner (with a class called 'Picture', you only have to write:0x000D0x000A  0x005BPKType(type=typeof(Picture))0x005D0x000D0x000A  Picture,0x000D0x000ANote: In the last case, the class 'Picture' also have to set -ValidatorAndParser- and implement ToString().0x000D0x000A
PKHTMLAttribute/__TOCDet/DocFragType = Class
PKHTMLAttribute/__TOCDet/Name = PKHTMLAttribute
PKHTMLAttribute/__TOCDet/Namespace = ARCCore
PKHTMLAttribute/__TOCDet/Type = PKHTMLAttribute
PKHTMLAttribute/__TOCDet/Attribute/AssemblyName = ARCCore
PKHTMLAttribute/__TOCDet/Attribute/BaseTypes = Attribute0x003BBaseAttribute0x003BEnumMemberAttribute0x003BBasePKAttribute
PKHTMLAttribute/__TOCDet/Attribute/ClassNamespace = ARCCore
PKHTMLAttribute/__TOCDet/Attribute/ClassType = PKHTMLAttribute
PKHTMLAttribute/__TOCDet/Attribute/CorrespondingEnumType = PKHTMLAttributeP
PKHTMLAttribute/__TOCDet/Attribute/Description = Contains pointer to HTML encoder for a property.0x000D0x000A0x000D0x000AThe encoder replaces any standard mechanism used for HTML encoding a single property.0x000D0x000AIt is useful for instance for showing images, where the property value can be for instance a Base64-encoding of the binary data which the encoder converts into an HTML 0x003CIMG0x003E tag.0x000D0x000A0x000D0x000AUsed in -ARCCore- by class -Extensions- method -ToHTMLSimpleAsTableRow-.0x000D0x000AUsed in -ARCQuery- by class -QueryProgressDetails- method -ToHTMLSimpleSingle-.0x000D0x000A0x000D0x000AThis attribute can be used in two distinct manners:0x000D0x000A0x000D0x000A1) Manually in C#, that is, at -TaggingOfPropertyKeys- like:0x000D0x000A   0x005BPKHtml(Encoder = typeof(PictureEncoder))0x005D0x000D0x000A   Picture,0x000D0x000Afor a specific property called 'Picture'.0x000D0x000Aor0x000D0x000A2) Use a class implementing -ITypeDescriber- which through the EnrichKey-principle in that interface, supplies this attribute (PKHTMLAttribute) with the necessary encoder.0x000D0x000AIn this manner (with a class called 'Picture', you only have to write:0x000D0x000A  0x005BPKType(type=typeof(Picture))0x005D0x000D0x000A  Picture,0x000D0x000ANote: In the last case, the class 'Picture' also have to set -ValidatorAndParser- and implement ToString().0x000D0x000A
PKHTMLAttribute/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
PKLogAttribute/__TOCDet/Assembly = ARCCore
PKLogAttribute/__TOCDet/Description = Explains how logging of changes to a property should be done.0x000D0x000ADescribes mostly occasions where logging shall be restricted.0x000D0x000A0x000D0x000ANormally when a class like -PConcurrent- is set up to log (through -Logger-), then every property's changes will be logged. In some cases this is too much, for instance if -CountReceiveMessage- was to be logged for every -PropertyStream--line received, that would generate another property stream line which again would update the -CountReceiveMessage- value.0x000D0x000A0x000D0x000AUtilized by for instance -ActualConnection-.0x000D0x000A0x000D0x000ASee also -ExposingApplicationState-.0x000D0x000A0x000D0x000ASee also -PKLogAttributeP-.
PKLogAttribute/__TOCDet/DocFragType = Class
PKLogAttribute/__TOCDet/Name = PKLogAttribute
PKLogAttribute/__TOCDet/Namespace = ARCCore
PKLogAttribute/__TOCDet/Type = PKLogAttribute
PKLogAttribute/__TOCDet/Attribute/AssemblyName = ARCCore
PKLogAttribute/__TOCDet/Attribute/BaseTypes = Attribute0x003BBaseAttribute0x003BEnumMemberAttribute0x003BBasePKAttribute
PKLogAttribute/__TOCDet/Attribute/ClassNamespace = ARCCore
PKLogAttribute/__TOCDet/Attribute/ClassType = PKLogAttribute
PKLogAttribute/__TOCDet/Attribute/CorrespondingEnumType = PKLogAttributeP
PKLogAttribute/__TOCDet/Attribute/Description = Explains how logging of changes to a property should be done.0x000D0x000ADescribes mostly occasions where logging shall be restricted.0x000D0x000A0x000D0x000ANormally when a class like -PConcurrent- is set up to log (through -Logger-), then every property's changes will be logged. In some cases this is too much, for instance if -CountReceiveMessage- was to be logged for every -PropertyStream--line received, that would generate another property stream line which again would update the -CountReceiveMessage- value.0x000D0x000A0x000D0x000AUtilized by for instance -ActualConnection-.0x000D0x000A0x000D0x000ASee also -ExposingApplicationState-.0x000D0x000A0x000D0x000ASee also -PKLogAttributeP-.
PKLogAttribute/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
PKRelAttribute/__TOCDet/Assembly = ARCCore
PKRelAttribute/__TOCDet/Description = Describes relationships between entities (between tables in RDBMS terms).0x000D0x000A0x000D0x000ANote than in general relationsships are picked up automatically in AgoRapide through standardized naming of keys.0x000D0x000A0x000D0x000AFor instance, for 'Order', key 'CustomerId' is automatically assumed to point to a -ForeignEntity- of type 'Customer', so this attribute does not have to be specified.0x000D0x000A0x000D0x000AHowever, for 'Employee', key 'SupervisorId' where the supervisor is another 'Employee', -ForeignEntity- has to be explicitly specified in order for the system to understand that 'SupervisorId' is actually a foreign key pointing to another 'Employee'.0x000D0x000A(this is not necessarily limited to self-referencing tables, another example could be 'Transaction' with 'FromAccountId' and 'ToAccountId' both pointing to an 'Account'.)0x000D0x000A0x000D0x000AUsed by -ARCQuery- (in -QueryExpressionRel- and -ForeignKey-) in order to enable queries like:0x000D0x000A"Employee/WHERE DepartmentId = 'Sales'/REL Supervisor" (all Supervisors of Employees in Sales) and0x000D0x000A"Employee/WHERE DepartmentId = 'Sales'/SELECT Name, Supervisor.Name).0x000D0x000A0x000D0x000AIn addition to explicit stating -ForeignEntity-, this attribute is also used to -EnforceReferentialIntegrity-0x000D0x000A.0x000D0x000ASee also -IPRelationsKeysPointingTo- and -IPRelationsKeysPointingFrom- in -ARCQuery-.0x000D0x000A
PKRelAttribute/__TOCDet/DocFragType = Class
PKRelAttribute/__TOCDet/Name = PKRelAttribute
PKRelAttribute/__TOCDet/Namespace = ARCCore
PKRelAttribute/__TOCDet/Type = PKRelAttribute
PKRelAttribute/__TOCDet/Attribute/AssemblyName = ARCCore
PKRelAttribute/__TOCDet/Attribute/BaseTypes = Attribute0x003BBaseAttribute0x003BEnumMemberAttribute0x003BBasePKAttribute
PKRelAttribute/__TOCDet/Attribute/ClassNamespace = ARCCore
PKRelAttribute/__TOCDet/Attribute/ClassType = PKRelAttribute
PKRelAttribute/__TOCDet/Attribute/CorrespondingEnumType = PKRelAttributeP
PKRelAttribute/__TOCDet/Attribute/Description = Describes relationships between entities (between tables in RDBMS terms).0x000D0x000A0x000D0x000ANote than in general relationsships are picked up automatically in AgoRapide through standardized naming of keys.0x000D0x000A0x000D0x000AFor instance, for 'Order', key 'CustomerId' is automatically assumed to point to a -ForeignEntity- of type 'Customer', so this attribute does not have to be specified.0x000D0x000A0x000D0x000AHowever, for 'Employee', key 'SupervisorId' where the supervisor is another 'Employee', -ForeignEntity- has to be explicitly specified in order for the system to understand that 'SupervisorId' is actually a foreign key pointing to another 'Employee'.0x000D0x000A(this is not necessarily limited to self-referencing tables, another example could be 'Transaction' with 'FromAccountId' and 'ToAccountId' both pointing to an 'Account'.)0x000D0x000A0x000D0x000AUsed by -ARCQuery- (in -QueryExpressionRel- and -ForeignKey-) in order to enable queries like:0x000D0x000A"Employee/WHERE DepartmentId = 'Sales'/REL Supervisor" (all Supervisors of Employees in Sales) and0x000D0x000A"Employee/WHERE DepartmentId = 'Sales'/SELECT Name, Supervisor.Name).0x000D0x000A0x000D0x000AIn addition to explicit stating -ForeignEntity-, this attribute is also used to -EnforceReferentialIntegrity-0x000D0x000A.0x000D0x000ASee also -IPRelationsKeysPointingTo- and -IPRelationsKeysPointingFrom- in -ARCQuery-.0x000D0x000A
PKRelAttribute/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable
PKTypeAttribute/__TOCDet/Assembly = ARCCore
PKTypeAttribute/__TOCDet/Description = Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-.0x000D0x000A0x000D0x000ADoes also contain -StandardCleaner- (for cleaning up input-values from the user) and -StandardValidatorAndParser- for validating and parsing common types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.0x000D0x000A0x000D0x000AWill always be present within an instance of -PK-, with default type set to 'typeof(string)'.0x000D0x000A0x000D0x000ASee also -PKTypeAttributeP-.
PKTypeAttribute/__TOCDet/DocFragType = Class
PKTypeAttribute/__TOCDet/Name = PKTypeAttribute
PKTypeAttribute/__TOCDet/Namespace = ARCCore
PKTypeAttribute/__TOCDet/Type = PKTypeAttribute
PKTypeAttribute/__TOCDet/Attribute/AssemblyName = ARCCore
PKTypeAttribute/__TOCDet/Attribute/BaseTypes = Attribute0x003BBaseAttribute0x003BEnumMemberAttribute0x003BBasePKAttribute
PKTypeAttribute/__TOCDet/Attribute/ClassNamespace = ARCCore
PKTypeAttribute/__TOCDet/Attribute/ClassType = PKTypeAttribute
PKTypeAttribute/__TOCDet/Attribute/CorrespondingEnumType = PKTypeAttributeP
PKTypeAttribute/__TOCDet/Attribute/Description = Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-.0x000D0x000A0x000D0x000ADoes also contain -StandardCleaner- (for cleaning up input-values from the user) and -StandardValidatorAndParser- for validating and parsing common types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.0x000D0x000A0x000D0x000AWill always be present within an instance of -PK-, with default type set to 'typeof(string)'.0x000D0x000A0x000D0x000ASee also -PKTypeAttributeP-.
PKTypeAttribute/__TOCDet/Attribute/Interfaces = IP0x003BIEnumerable0xoooo003CIKIP0xoooo003E0x003BIEnumerable

Edit single sub keys only: __TOCDet / PKDocAttribute / PKHTMLAttribute / PKLogAttribute / PKRelAttribute / PKTypeAttribute

Generated 2025-06-19 08:11:58.176 UTC