[ROOT]  doc  DocFrag  SELECT Assembly, DocFragType, Description.FirstLine()   <  SKIP 11  >   <  TAKE 96  >   

96 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.ClassAttributeARCCoreClassDescribes a class.
ARCCore.ClassAttribute.GetAttributeARCCoreClassMemberThrows 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.ClassMemberAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.ClassAttribute.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.ClassAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.ClassMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.ClassAttribute.IsDefaultARCCoreClassMemberDoes 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.ClassMemberAttributeARCCoreClassDescribes a member of a class (a method).
ARCCore.EnumAttributeARCCoreClassDescribes an enum.
ARCCore.ClassMemberAttribute.IsDefaultARCCoreClassMemberDoes 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.InitializeARCCoreClassMemberTo be overridden in sub-classes, but do note that sub-classes are supposed to call base.Initialize() at end of their own initialization.
ARCCore.EnumAttribute.GetAttributeARCCoreClassMemberThrows 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.EnumAttribute.TryGetAsTypeScriptARCCoreClassMemberGenerates typescript code corresponding to the enum which this instance describes.
ARCCore.EnumAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.EnumAttribute.IsDefaultARCCoreClassMemberDoes 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.EnumMemberAttribute.GetAttributeARCCoreClassMemberNote that illegal to call for -PropertyKeyEnum-.
ARCCore.EnumMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.EnumMemberAttributeARCCoreClassDescribes an enum's value.
ARCCore.EnumMemberAttribute.InitializeARCCoreClassMemberTo 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.IsDefaultARCCoreClassMemberDoes 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.CardinalityExtensions.IsMultipleARCCoreClassMemberReturns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.ExtensionsARCCoreClassContains a few general nice to have extensions methods.
ARCCore.CardinalityExtensionsARCCoreClass 
ARCCore.Extensions.ForEachARCCoreClassMemberUseful when we want to write collection.ForEach( ... ) instead of
ARCCore.Extensions.UseARCCoreClassMemberConvenience 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.Extensions.ToStringShortARCCoreClassMemberReturns a shorter representation than -ToStringDB-.
ARCCore.Extensions.SingleARCCoreClassMemberSame as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.Extensions.AddValueARCCoreClassMemberGives better error messages compared to 'original' Add when adding a value to a directory if key already exists
ARCCore.Extensions.ToStringVeryShortARCCoreClassMemberReturns same as -ToStringShort- but without any generics information at all.
ARCCore.Extensions.SingleOrDefaultARCCoreClassMemberSame as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.IKIP.AssertTypeIntegrityARCCoreClassMemberSee -TryAssertTypeIntegrity- for documentation.
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.Extensions.ToStringWithMSARCCoreClassMemberUses either format 'd\.hh\:mm\:ss\.fff' or 'hh\:mm\:ss\.fff' depending on TotalHours >=24 hours or not.
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.IKIPARCCoreClassContainer class for key (-IK-), and value (-IP-).
ARCCore.IKCoded.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.Extensions.ResultARCCoreClassMemberReturns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCCore.IKCoded.FromEncodedARCCoreClassMemberNote how uses instance cache if already exists there.
ARCCore.IKCoded.TryCheckValidEncodedValueARCCoreClassMemberChecks if encoded value is valid.
ARCCore.Extensions.ToStringDateAndTimeARCCoreClassMemberUses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.IKCoded.TryEncodeARCCoreClassMemberReturns a string containing only characters in -AllowedEncodedCharacters-.
ARCCore.IKCoded.ToStringARCCoreClassMemberReturns -Encoded-'s string representation.
ARCCore.IKARCCoreClassIK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.IKDate.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.IKCoded.EncodedARCCoreClassMemberThis string value can be used directly in folder names, file names and HTTP URL's without any further encoding being necessary.
ARCCore.IKCodedARCCoreClassUnderstands coded and unencoded variants of -IK-.
ARCCore.IKDate.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.IKDate.ValidDateTimeFormatsARCCoreClassMemberNote: Be very careful about expanding this array. ToString must be considered, and also how Equals should work with other sub classes of IK.
ARCCore.IKCoded.FromCacheEncodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IKString.FromStringARCCoreClassMemberNote how uses instance cache if already exists there
ARCCore.IKLongARCCoreClassA more memory efficient alternative to -IKString-.
ARCCore.IKCoded.FromCacheUnencodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IKString.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.IKType.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.IKCoded.AllowedEncodedCharactersARCCoreClassMemberThe character set 'A...Za...z0...9-_().,='.
ARCCore.IKString.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.ITypeDescriberARCCoreClassProvides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.IKDateARCCoreClassA more memory efficient alternative to -IKString- (together with -IKLong-).
ARCCore.IKTypeARCCoreClassIndex key used when storing a collection of a given type, like 'Customer'.
ARCCore.PK.TryGetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute-.
ARCCore.IKLong.op_EqualityARCCoreClassMemberIt is quite natural in the code to write code like "if (a.CustomerId == b.CustomerId)", therefore the need to implement == and != operators here.
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.PK.ModifyCleanerAndValidatorAndParserForCardinalityARCCoreClassMemberCalled from -Initialize- after _cleaner and _validatorAndParser have been set.
ARCCore.IKLong.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.PK.TryGetEnumARCCoreClassMemberNote 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.PK.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
ARCCore.PK.TryGetVARCCoreClassMemberOnly type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
ARCCore.PK.TryValidateAndParseARCCoreClassMemberParses the value according to specifications for this property key.
ARCCore.IKString.FromCacheARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.PK.GetAllPKForEntityTypeStringARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.PK.TryGetFromTypeAndFieldName Overload3ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.BuildFromStringCacheARCCoreClassMemberBuilds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.PK.TryGetFromTypeAndFieldName Overload2ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.GetTypeMappingARCCoreClassMemberReturns the relevant property key for a given type entity-type and field-type.
ARCCore.ParseResult.ResultARCCoreClassMemberWill be null if ErrorResponse is set.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.GetObligatoryValuesForEntityTypeARCCoreClassMemberReturns all obligatory values (based on -IsObligatory-)
ARCCore.ParseResult.ErrorResponseARCCoreClassMemberWill be null if Result is set
ARCCore.PK.GetAllPKForEntityTypeARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.PK.AllEnumsARCCoreClassMemberAll enums for the whole application.
ARCCore.PK.TryCleanValidateAndParseARCCoreClassMemberCleans and parses the value according to specifications for this property key.
ARCCore.PK.CardinalityARCCoreClassMemberReturns cardinality from -PKTypeAttribute-'s -Cardinality-.
ARCCore.PK.AllPKEnumsARCCoreClassMemberAll -PropertyKeyEnum--tagged enums for the whole application.
ARCCore.PK.PackParseResultForStorageInEntityObjectARCCoreClassMemberPacks result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.PK.CorrespondingClassARCCoreClassMemberReturns -CorrespondingClass- based on -__enum-.
ARCCore.PK.__enumARCCoreClassMemberThis information is also found as EnumMember.
ARCCore.PK.PackObjectForStorageInEntityObjectARCCoreClassMemberSee -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PK.ValidatorAndParserARCCoreClassMemberValidates and parses a value.
ARCCore.PKHTMLAttributeARCCoreClassContains pointer to HTML encoder for a property.

Generated 2025-12-20 07:17:42.575 UTC