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

128 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.ClassMemberAttributeARCCoreClassDescribes a member of a class (a method).
ARCCore.ClassAttribute.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.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.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.EnumAttributeARCCoreClassDescribes an enum.
ARCCore.EnumMemberAttributeARCCoreClassDescribes an enum's value.
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.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.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.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.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
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.Extensions.SingleARCCoreClassMemberSame as inbuilt LINQ's Single except that gives a more friendly exception message
ARCCore.CardinalityExtensionsARCCoreClass 
ARCCore.EnumMemberAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.Extensions.SingleOrDefaultARCCoreClassMemberSame as inbuilt LINQ's SingleOrDefault except that gives a more friendly exception message
ARCCore.ExtensionsARCCoreClassContains a few general nice to have extensions methods.
ARCCore.Extensions.ToStringVeryShortARCCoreClassMemberReturns same as -ToStringShort- but without any generics information at all.
ARCCore.IKIP.AssertTypeIntegrityARCCoreClassMemberSee -TryAssertTypeIntegrity- for documentation.
ARCCore.Extensions.ToStringShortARCCoreClassMemberReturns a shorter representation than -ToStringDB-.
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
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.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.Extensions.ToStringDateAndTimeARCCoreClassMemberUses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.IKCoded.TryEncodeARCCoreClassMemberReturns a string containing only characters in -AllowedEncodedCharacters-.
ARCCore.IKARCCoreClassIK = Interface Key / Index key. Key used to lookup 'inside' an instance of -IP-.
ARCCore.IKCoded.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
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.IKCodedARCCoreClassUnderstands coded and unencoded variants of -IK-.
ARCCore.IKCoded.TryCheckValidEncodedValueARCCoreClassMemberChecks if encoded value is valid.
ARCCore.IKDate.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.IKCoded.AllowedEncodedCharactersARCCoreClassMemberThe character set 'A...Za...z0...9-_().,='.
ARCCore.IKCoded.ToStringARCCoreClassMemberReturns -Encoded-'s string representation.
ARCCore.IKString.FromStringARCCoreClassMemberNote how uses instance cache if already exists there
ARCCore.IKDateARCCoreClassA more memory efficient alternative to -IKString- (together with -IKLong-).
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.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.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
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.IKType.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.IKString.FromCacheARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IKLongARCCoreClassA more memory efficient alternative to -IKString-.
ARCCore.ITypeDescriberARCCoreClassProvides a standardized mechanism for describing single-property values (like 'PhoneNumber' of 'Customer' for instance).
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.ITypeDescriber.GetSyntaxHelpARCCoreClassMemberEnables explanation of syntax in different contexts from one source:
ARCCore.PK.TryGetVARCCoreClassMemberOnly type of PK, string or type of __enum is allowed to ask for (as TRequest generic type parameter).
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.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.PK.GetAARCCoreClassMemberConvenience method for easy access to -BasePKAttribute- with corresponding explaining exception if fails
ARCCore.PK.TryCleanValidateAndParseARCCoreClassMemberCleans and parses the value according to specifications for this property key.
ARCCore.PK.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.PackParseResultForStorageInEntityObjectARCCoreClassMemberPacks result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.PK.TryValidateAndParseARCCoreClassMemberParses the value according to specifications for this property key.
ARCCore.PK.GetAllPKForEntityTypeARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.PK.GetAllPKForEntityTypeStringARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.PK.PackObjectForStorageInEntityObjectARCCoreClassMemberSee -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PK.EqualsARCCoreClassMemberNote 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.PK.BuildFromStringCacheARCCoreClassMemberBuilds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.PK.FromEnumARCCoreClassMemberReturns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.PK.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.PK.GetTypeMappingARCCoreClassMemberReturns the relevant property key for a given type entity-type and field-type.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK..ctorARCCoreClassMemberConstructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PK.GetObligatoryValuesForEntityTypeARCCoreClassMemberReturns all obligatory values (based on -IsObligatory-)
ARCCore.PK.TryGetFromTypeAndFieldName Overload2ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.TypeARCCoreClassMemberReturns type from -PKTypeAttribute-'s -Type-.
ARCCore.PKRelAttribute.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.PK.ValidatorAndParserARCCoreClassMemberValidates and parses a value.
ARCCore.PKHTMLAttribute.EncodeARCCoreClassMemberEncodes the given string to HTML format through the static method implemented in class -Encoder-.
ARCCore.PKRelAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PK.CleanerARCCoreClassMemberCleanup of values, to be used before value is attempted validated.
ARCCore.PKHTMLAttribute.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.PKRelAttribute.ForeignEntityARCCoreClassMemberSee -ForeignEntity-.
ARCCore.PK.AllEnumsARCCoreClassMemberAll enums for the whole application.
ARCCore.PKHTMLAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKRelAttribute.OppositeTermARCCoreClassMemberSee -OppositeTerm-.
ARCCore.PK.AllPKEnumsARCCoreClassMemberAll -PropertyKeyEnum--tagged enums for the whole application.
ARCCore.PKHTMLAttribute.EncoderARCCoreClassMemberSee -Encoder-.
ARCCore.IPARCCoreClassIP = IProperty.
ARCCore.PKLogAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKTypeAttribute.StandardValidatorAndParserARCCoreClassMemberReturns validator and parser for well known types like string, int, long, bool, DateTime, TimeSpan, Type, Uri.
ARCCore.IP.TryGetV Overload2ARCCoreClassMemberThe actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.PKLogAttribute.DoNotLogAtAllARCCoreClassMemberSee -DoNotLogAtAll-.
ARCCore.PKTypeAttribute.StandardCleanerARCCoreClassMemberReturns a cleaner for well known types like bool
ARCCore.IP.IncARCCoreClassMemberIncrements given property key by 1. Sets to 1 if not found. Uses long, not integer.
ARCCore.PKLogAttribute.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.PKTypeAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.PKRelAttributeARCCoreClassDescribes relationships between entities (between tables in RDBMS terms).
ARCCore.PKTypeAttribute.TypeARCCoreClassMemberSee -Type-.
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCCore.PKTypeAttribute.CardinalityARCCoreClassMemberSee -Cardinality-.
ARCCore.IP.LogARCCoreClassMemberThe 'final' overload of -Log- that is called by the other overloads.
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.PKTypeAttribute.DefaultValueARCCoreClassMemberSee -DefaultValue-.
ARCCore.IP.LogExecuteTimeARCCoreClassMemberTimes the execution of the given function and logs details about elapsed time.
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberPractical approach to serializing of -IP- based values to JSON.
ARCCore.PKTypeAttribute.IsObligatoryARCCoreClassMemberSee -IsObligatory-.
ARCCore.IP.HandleExceptionARCCoreClassMemberNote that most relevant to use for -PConcurrent-.
ARCCore.IP.TrySetPARCCoreClassMemberSet property regardless of whether exists or not.
ARCCore.PKTypeAttribute.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.IP.TryParseDtrARCCoreClassMemberParses a PropertyStreamLine- beginning with -dtr-.
ARCCore.IP.ValuesARCCoreClassMemberReturns all the values (all the properties) for this instance.
ARCCore.IP.InitializeARCCoreClassMemberNote that has a default implementation (doing nothing).
ARCCore.IP.TryGetPVARCCoreClassMemberGets a single property's value for the given property key.
ARCCore.IP.LoggerARCCoreClassMemberDescribes a logger.
ARCCore.IP.AssertIntegrityARCCoreClassMemberSee -TryAssertIntegrity-.
ARCCore.IP.IsValidARCCoreClassMemberNote that by default all properties are 'valid' but because of -NoRealDeletion-, we must have a mechanism for invalidating properties. This property returns FALSE if property has been invalidated and timestamp for invalidation is not '0001-01-01'.
ARCCore.IP.AllIPDerivedTypesARCCoreClassMemberAll relevant -IP--derived types for the whole application.
ARCCore.IP.TryAssertIntegrityARCCoreClassMemberAsserts the integrity of this entity.
ARCCore.IP.ItemARCCoreClassMemberOffers string-based direct indexing.
ARCCore.IP.AllIPDerivedTypesWithPKEnumARCCoreClassMemberAll relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.IP.ToStringARCCoreClassMemberThe ToString()-implementation in the classes implementing this interface is supposed to give a short concise representation of the object for debugging and logging purposes, that is, intended for human consumption. The most 'important' implementation is probably the one in -PRich- (-ToString-) because that one is often the basis for your entity classes like 'Customer', 'Order' and so on
ARCCore.IP.KeysARCCoreClassMemberReturns all the keys for this instance.
ARCCore.PCollection.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.IP.AddPARCCoreClassMemberAdds a property for this object.
ARCCore.IP.AllIPDerivedTypesDictIKTypeARCCoreClassMemberSame as -AllIPDerivedTypesDict- except that value is -IKType-, not string.
ARCCore.PCollection.TryGetPARCCoreClassMemberMade virtual 13 Jan 2022. Possibly the same could be done for all other methods here since _properties is Protected anyway.
ARCCore.IP.AddOrUpdatePARCCoreClassMemberDuplicates functionality of SetP.
ARCCore.PARCCoreClass'Dummy'-class, not necessarily in use. See -PP- for more information. Created because of the concept of CorrespondingClass which is strictly enforced
ARCCore.PCollection.TryGetVARCCoreClassMemberNote that 'normally' this method would be irrelevant for a -PRich- object because we will usually be an entity object (like 'Customer') not having an intrinsic value ourselves per se (because we will instead be containing a list of values).

Generated 2026-03-02 13:51:11.964 UTC