[ROOT] doc DocFrag SELECT Assembly, DocFragType, Description.FirstLine() < SKIP 2 > < TAKE 112 >
112 items
| DocFragId | Assembly | DocFragType | Description.FirstLine() |
|---|---|---|---|
| ARCCore.BaseAttribute | ARCCore | Class | Instances of this class are used as source of documentation and data for the API. |
| ARCCore.ClassAttribute.GetAttribute | ARCCore | ClassMember | Throws exception if type implements -IP- and no corresponding enum found (enum ending with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance) |
| ARCCore.BasePKAttribute | ARCCore | Class | The class containing the actual attributes used for -TaggingOfPropertyKeys-. |
| ARCCore.ClassAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.BasePKAttribute.GetAttributes | ARCCore | ClassMember | Note that illegal to call for other than -PropertyKeyEnum-. |
| ARCCore.ClassMemberAttribute | ARCCore | Class | Describes a member of a class (a method). |
| ARCCore.BasePKAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.ClassMemberAttribute.IsDefault | ARCCore | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCCore.BasePKAttribute.IsDefault | ARCCore | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCCore.EnumAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.ClassAttribute.TryGetAsTypeScript | ARCCore | ClassMember | Generates typescript code corresponding to the class which this instance describes. |
| ARCCore.EnumMemberAttribute.GetAttribute | ARCCore | ClassMember | Note that illegal to call for -PropertyKeyEnum-. |
| ARCCore.ClassMemberAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.EnumMemberAttribute.IsDefault | ARCCore | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCCore.EnumAttribute | ARCCore | Class | Describes an enum. |
| ARCCore.CardinalityExtensions.IsMultiple | ARCCore | ClassMember | Returns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage. |
| ARCCore.EnumAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.Extensions | ARCCore | Class | Contains a few general nice to have extensions methods. |
| ARCCore.EnumAttribute.TryGetAsTypeScript | ARCCore | ClassMember | Generates typescript code corresponding to the enum which this instance describes. |
| ARCCore.Extensions.KeysAsString | ARCCore | ClassMember | Gives a compressed overview of keys in a dictionary. Helpful for building exception messages. |
| ARCCore.ParseResult.Result | ARCCore | ClassMember | Will be null if ErrorResponse is set. |
| ARCCore.EnumMemberAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.Extensions.GetValue | ARCCore | ClassMember | Gives better error messages when reading value from directory if key does not exist |
| ARCCore.ParseResult.ErrorResponse | ARCCore | ClassMember | Will be null if Result is set |
| ARCCore.EnumMemberAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.Extensions.Result | ARCCore | ClassMember | Returns heading plus return-value of function (calls function). If function == null then empty string is returned |
| ARCCore.PK | ARCCore | Class | PK = AgoRapide PropertyKey. |
| ARCCore.Extensions.ToStringShort | ARCCore | ClassMember | Returns a shorter representation than -ToStringDB-. |
| ARCCore.Extensions.ToStringDateAndTime | ARCCore | ClassMember | Uses format 'yyyy-MM-dd HH:mm:ss.fff'. |
| ARCCore.PK.GetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails |
| ARCCore.Extensions.ToStringVeryShort | ARCCore | ClassMember | Returns same as -ToStringShort- but without any generics information at all. |
| ARCCore.IK | ARCCore | Class | IK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-. |
| ARCCore.PK.TryCleanValidateAndParse | ARCCore | ClassMember | Cleans and parses the value according to specifications for this property key. |
| ARCCore.Extensions.Use | ARCCore | ClassMember | Convenience method that shortens down code in cases where an instance of an object must be created first in order to use that same variable multiple times |
| ARCCore.IKCoded | ARCCore | Class | Understands coded and unencoded variants of -IK-. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload2 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.Extensions.AddValue | ARCCore | ClassMember | Gives better error messages compared to 'original' Add when adding a value to a directory if key already exists |
| ARCCore.IKCoded.ToString | ARCCore | ClassMember | Returns -Encoded-'s string representation. |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload1 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.Extensions.ToStringWithMS | ARCCore | ClassMember | Uses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not. |
| ARCCore.IKCoded.Encoded | ARCCore | ClassMember | This string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary. |
| ARCCore.PK.GetAllPKForEntityType | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
| ARCCore.IKIP | ARCCore | Class | Container class for key (-IK-), and value (-IP-). |
| ARCCore.IKDate.ValidDateTimeFormats | ARCCore | ClassMember | Note: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK. |
| ARCCore.PK.Equals | ARCCore | ClassMember | Note that ToString is only based on __enum, meaning that two enum members / enum values with same name but different type, like CustomerP.Name and OrderP.Name, will be considered equal. |
| ARCCore.IKCoded.FromCacheEncoded | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.IKLong | ARCCore | Class | A more memory efficient alternative to -IKString-. |
| ARCCore.PK.TryGetP | ARCCore | ClassMember | Made virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway. |
| ARCCore.IKCoded.FromCacheUnencoded | ARCCore | ClassMember | Reduces number of objects generated by caching those known to be within a limited range |
| ARCCore.ITypeDescriber.GetSyntaxHelp | ARCCore | ClassMember | Enables explanation of syntax in different contexts from one source: |
| ARCCore.PK.ValidatorAndParser | ARCCore | ClassMember | Validates and parses a value. |
| ARCCore.IKCoded.AllowedEncodedCharacters | ARCCore | ClassMember | The character set 'A...Za...z0...9-_().,='. |
| ARCCore.ParseResult | ARCCore | Class | NOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement. |
| ARCCore.PK.Cleaner | ARCCore | ClassMember | Cleanup of values, to be used before value is attempted validated. |
| ARCCore.IKDate | ARCCore | Class | A more memory efficient alternative to -IKString- (together with -IKLong-). |
| ARCCore.PK.TryGetEnum | ARCCore | ClassMember | Note that usually you will not have to ask for this value, usually in AgoRapide it goes the other way around, you have the enum member / enum value and want the corresponding property key. |
| ARCCore.PKHTMLAttribute.Encode | ARCCore | ClassMember | Encodes the given string to HTML format through the static method implemented in class -Encoder-. |
| ARCCore.IKLong.op_Equality | ARCCore | ClassMember | It is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here. |
| ARCCore.PK.TryGetV | ARCCore | ClassMember | Only type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter). |
| ARCCore.PKHTMLAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.IKLong.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.PK.PackParseResultForStorageInEntityObject | ARCCore | ClassMember | Packs result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-. |
| ARCCore.PKLogAttribute | ARCCore | Class | Explains how logging of changes to a property should be done. |
| ARCCore.IKString.EnrichKey | ARCCore | ClassMember | 'Implementing' -ITypeDescriber-. |
| ARCCore.PK.PackObjectForStorageInEntityObject | ARCCore | ClassMember | See -PackParseResultForStorageInEntityObject- for documentation. |
| ARCCore.PKLogAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.IKType | ARCCore | Class | Index key used when storing a collection of a given type, like 'Customer'. |
| ARCCore.BaseAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.PK.FromEnum | ARCCore | ClassMember | Returns the corresponding -PK- instance from the given -PropertyKeyEnum-. |
| ARCCore.PKRelAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.IKType.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
| ARCCore.BaseAttribute.IsDefault | ARCCore | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCCore.PK.TryGetFromTypeAndFieldName Overload3 | ARCCore | ClassMember | Returns property key based on type and field name. |
| ARCCore.PKRelAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.ITypeDescriber | ARCCore | Class | Provides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance). |
| ARCCore.BasePKAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.PK..ctor | ARCCore | ClassMember | Constructor with 'object _enum' is necessary in order for ToString to work. |
| ARCCore.PKTypeAttribute | ARCCore | Class | Contains the most basic essential information about a property key, like its description, -Type-, -Cardinality-, -IsObligatory- and -DefaultValue-. |
| ARCCore.PK.TryGetA | ARCCore | ClassMember | Convenience method for easy access to -BasePKAttribute-. |
| ARCCore.ClassAttribute | ARCCore | Class | Describes a class. |
| ARCCore.PK.Type | ARCCore | ClassMember | Returns type from -PKTypeAttribute-'s -Type-. |
| ARCCore.PKTypeAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinality | ARCCore | ClassMember | Called from -Initialize- after _cleaner and _validatorAndParser have been set. |
| ARCCore.ClassAttribute.Initialize | ARCCore | ClassMember | To be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization. |
| ARCCore.PK.Cardinality | ARCCore | ClassMember | Returns cardinality from -PKTypeAttribute-'s -Cardinality-. |
| ARCCore.PKTypeAttribute.Cardinality | ARCCore | ClassMember | See -Cardinality-. |
| ARCCore.PK.ToString | ARCCore | ClassMember | Caching is supposed to be useful because may be called quite often. |
| ARCCore.ClassAttribute.IsDefault | ARCCore | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCCore.PK.CorrespondingClass | ARCCore | ClassMember | Returns -CorrespondingClass- based on -__enum-. |
| ARCCore.PKTypeAttribute.DefaultValue | ARCCore | ClassMember | See -DefaultValue-. |
| ARCCore.PK.TryValidateAndParse | ARCCore | ClassMember | Parses the value according to specifications for this property key. |
| ARCCore.ClassMemberAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.PKHTMLAttribute.TryRemoveP | ARCCore | ClassMember | Should probably never be used. |
| ARCCore.IP.HandleException | ARCCore | ClassMember | Note that most relevant to use for -PConcurrent-. |
| ARCCore.PK.GetAllPKForEntityTypeString | ARCCore | ClassMember | Returns all property keys relevant for the given entity type, |
| ARCCore.EnumAttribute.GetAttribute | ARCCore | ClassMember | Throws exception if tagged as -PropertyKeyEnum- and name of type does not end with capital letter 'P' (like 'CustomerP' for enum describing class 'Customer' for instance). |
| ARCCore.PKHTMLAttribute.Encoder | ARCCore | ClassMember | See -Encoder-. |
| ARCCore.IP.TryParseDtr | ARCCore | ClassMember | Parses a PropertyStreamLine- beginning with -dtr-. |
| ARCCore.PK.BuildFromStringCache | ARCCore | ClassMember | Builds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-. |
| ARCCore.EnumAttribute.IsDefault | ARCCore | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCCore.PKHTMLAttribute.IsDefault | ARCCore | ClassMember | Does not have a corresponding -BaseAttributeP- since all attributes relevant for querying (for instance in the documentation) will be IsDefault = FALSE anyway. (if we had included it in -BaseAttributeP- it would just have led to a lot of confusing IsDefault = FALSE key-values showing up.) |
| ARCCore.IP.Initialize | ARCCore | ClassMember | Note that has a default implementation (doing nothing). |
| ARCCore.PK.GetTypeMapping | ARCCore | ClassMember | Returns the relevant property key for a given type entity-type and field-type. |
| ARCCore.EnumMemberAttribute | ARCCore | Class | Describes an enum's value. |
| ARCCore.IHTMLEncoder | ARCCore | Class | Pseudo-interface signifying that implementing class has a static metod called 'Encode' for encoding a string to HTML. |
| ARCCore.IP.AssertIntegrity | ARCCore | ClassMember | See -TryAssertIntegrity-. |
| ARCCore.PK.GetObligatoryValuesForEntityType | ARCCore | ClassMember | Returns all obligatory values (based on -IsObligatory-) |
| ARCCore.IPAttribute | ARCCore | Class | Describes -IP- classes (describes at class-level) |
| ARCCore.PKRelAttribute.ForeignEntity | ARCCore | ClassMember | See -ForeignEntity-. |
| ARCCore.IP.TryAssertIntegrity | ARCCore | ClassMember | Asserts the integrity of this entity. |
| ARCCore.PK.AllEnums | ARCCore | ClassMember | All enums for the whole application. |
| ARCCore.CardinalityExtensions | ARCCore | Class |
Generated 2025-08-08 16:48:32.210 UTC