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

125 items

DocFragIdAssemblyDocFragTypeDescription.FirstLine()
ARCCore.PKTypeAttribute.StandardCleanerARCCoreClassMemberReturns a cleaner for well known types like bool
ARCCore.IP.DecARCCoreClassMemberDecrements given property key by 1. Sets to -1 if not found. Uses long, not integer.
ARCCore.IP.LogARCCoreClassMemberThe 'final' overload of -Log- that is called by the other overloads.
ARCCore.IP.LogExecuteTimeARCCoreClassMemberTimes the execution of the given function and logs details about elapsed time.
ARCCore.IP.HandleExceptionARCCoreClassMemberNote that most relevant to use for -PConcurrent-.
ARCCore.IP.InitializeARCCoreClassMemberNote that has a default implementation (doing nothing).
ARCCore.IP.AssertIntegrityARCCoreClassMemberSee -TryAssertIntegrity-.
ARCCore.IP.TryAssertIntegrityARCCoreClassMemberAsserts the integrity of this entity.
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.BaseAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.BaseAttribute.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.BasePKAttribute.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.BasePKAttribute.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.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.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.TryRemovePARCCoreClassMemberShould probably never be used.
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.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.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.EnumMemberAttribute.GetAttributeARCCoreClassMemberNote that illegal to call for -PropertyKeyEnum-.
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.IPAttributeARCCoreClassDescribes -IP- classes (describes at class-level)
ARCCore.CardinalityExtensionsARCCoreClass 
ARCCore.CardinalityExtensions.IsMultipleARCCoreClassMemberReturns TRUE if given cardinality implies that multiple items are stored simultaneously in a typical in-memory data storage.
ARCCore.ExtensionsARCCoreClassContains a few general nice to have extensions methods.
ARCCore.Extensions.ToStringDBARCCoreClassMemberGives the minimum representation of type as string suitable for later reconstruction by -GetType-.
ARCCore.Extensions.ForEachARCCoreClassMemberUseful when we want to write collection.ForEach( ... ) instead of
ARCCore.Extensions.KeysAsStringARCCoreClassMemberGives a compressed overview of keys in a dictionary. Helpful for building exception messages.
ARCCore.Extensions.GetValueARCCoreClassMemberGives better error messages when reading value from directory if key does not exist
ARCCore.Extensions.ResultARCCoreClassMemberReturns heading plus return-value of function (calls function). If function == null then empty string is returned
ARCCore.Extensions.ToStringDateAndTimeARCCoreClassMemberUses format 'yyyy-MM-dd HH:mm:ss.fff'.
ARCCore.IKIP.AssertTypeIntegrityARCCoreClassMemberSee -TryAssertTypeIntegrity- for documentation.
ARCCore.IKIP.TryAssertTypeIntegrityARCCoreClassMemberAsserts that value is of correct type as specified by the key.
ARCCore.IKCoded.FromCacheEncodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IKCoded.FromCacheUnencodedARCCoreClassMemberReduces number of objects generated by caching those known to be within a limited range
ARCCore.IKCoded.FromEncodedARCCoreClassMemberNote how uses instance cache if already exists there.
ARCCore.IKCoded.TryEncodeARCCoreClassMemberReturns a string containing only characters in -AllowedEncodedCharacters-.
ARCCore.IKLong.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.IKStringARCCoreClassIndex key for any general id, like primary-key or sequence-number or similar.
ARCCore.IKString.FromCacheARCCoreClassMemberReduces 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.PK.FromEnumARCCoreClassMemberReturns the corresponding -PK- instance from the given -PropertyKeyEnum-.
ARCCore.PK.TryGetFromTypeAndFieldName Overload3ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.TryGetFromTypeAndFieldName Overload2ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.TryGetFromTypeAndFieldName Overload1ARCCoreClassMemberReturns property key based on type and field name.
ARCCore.PK.GetObligatoryValuesForEntityTypeARCCoreClassMemberReturns all obligatory values (based on -IsObligatory-)
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.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).
ARCCore.PK..ctorARCCoreClassMemberConstructor with 'object _enum' is necessary in order for ToString to work.
ARCCore.PKHTMLAttributeARCCoreClassContains pointer to HTML encoder for a property.
ARCCore.PKHTMLAttribute.EncodeARCCoreClassMemberEncodes the given string to HTML format through the static method implemented in class -Encoder-.
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.PKHTMLAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKRelAttributeARCCoreClassDescribes relationships between entities (between tables in RDBMS terms).
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.PKRelAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PKRelAttribute.ForeignEntityARCCoreClassMemberSee -ForeignEntity-.
ARCCore.PKTypeAttribute.CardinalityARCCoreClassMemberSee -Cardinality-.
ARCCore.PKTypeAttribute.DefaultValueARCCoreClassMemberSee -DefaultValue-.
ARCCore.PKTypeAttribute.IsObligatoryARCCoreClassMemberSee -IsObligatory-.
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.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.IP.OnTrySetPARCCoreClassMemberEvent handler to be called by -TrySetP- before it changes a property value (but AFTER it has done any validity checks, that is, after it has 'decided' to return TRUE, in other words, event handler should be called when change is guaranteed to go through, but before it actually has been done).
ARCCore.IP.TryGetP Overload1ARCCoreClassMemberGets a single property for this object
ARCCore.IP.ToPropertyStreamARCCoreClassMemberTurns object into a -PropertyStream-
ARCCore.IP.DeepCopyARCCoreClassMemberCreates a deep copy of this object instance, that is, a copy with all new object instances (except for immutable objects).
ARCCore.IP.AddPVARCCoreClassMemberAdds a property value (as a -PValue-) for this objectThrows -KeyAlreadyExistsException- when relevant.
ARCCore.IP.AddPARCCoreClassMemberAdds a property for this object.
ARCCore.IP.AddOrUpdatePARCCoreClassMemberDuplicates functionality of SetP.
ARCCore.IP.GetOrAddPVARCCoreClassMemberGets value. If not set then value will be added
ARCCore.IP.GetPARCCoreClassMemberGets a single property for this object.
ARCCore.IP.TryGetP Overload2ARCCoreClassMemberNote that not relevant for single-value properties like -PValue-.
ARCCore.IP.GetPVARCCoreClassMemberGets a single property's value for this object. Returns default value if not successful.
ARCCore.IP.KeysARCCoreClassMemberReturns all the keys for this instance.
ARCCore.IKString.EnrichKeyARCCoreClassMember'Implementing' -ITypeDescriber-.
ARCCore.IP.ValuesARCCoreClassMemberReturns all the values (all the properties) for this instance.
ARCCore.ParseResultARCCoreClassNOTE: Concept is very old, from the dark ages of AgoRapide's very first inception. There might be room for improvement.
ARCCore.IP.LoggerARCCoreClassMemberDescribes a logger.
ARCCore.ParseResult.ResultARCCoreClassMemberWill be null if ErrorResponse is set.
ARCCore.IP.AllIPDerivedTypesARCCoreClassMemberAll relevant -IP--derived types for the whole application.
ARCCore.ParseResult.ErrorResponseARCCoreClassMemberWill be null if Result is set
ARCCore.IP.AllIPDerivedTypesWithPKEnumARCCoreClassMemberAll relevant -IP--derived types for the whole application for which the also is defined a -PropertyKeyEnum-.
ARCCore.PKARCCoreClassPK = AgoRapide PropertyKey.
ARCCore.IP.AllIPDerivedTypesWithPKEnumApplicationSpecificARCCoreClassMemberAll relevant -IP--derived types for the -ApplicationSpecificCode- part of the application for which also is defined a -PropertyKeyEnum-.
ARCCore.PK.ToStringARCCoreClassMemberCaching is supposed to be useful because may be called quite often.
ARCCore.IP.AllIPDerivedEntityCollectionClassesDictARCCoreClassMemberAll -IP--derived types for which is found a corresponding class with name like '{EntityType}Collection'
ARCCore.PK.TryValidateAndParseARCCoreClassMemberParses the value according to specifications for this property key.
ARCCore.IP.AllIPDerivedTypesInludingGenericAndAbstractARCCoreClassMemberAll relevant -IP--derived types (except the interface -IP- itself) known to the application.
ARCCore.PK.TryCleanValidateAndParseARCCoreClassMemberCleans and parses the value according to specifications for this property key.
ARCCore.PCollectionARCCoreClassA class useful for storing a collection of entities (a table in RDBMS-terms) because it implements -Indexing-.
ARCCore.PK.PackParseResultForStorageInEntityObjectARCCoreClassMemberPacks result of parsing into a -IP--derived class, suitable for sending to -AddOrUpdateP-.
ARCCore.PCollection.TrySetPPARCCoreClassMemberReplaces default interface method -TrySetPP-.
ARCCore.PK.PackObjectForStorageInEntityObjectARCCoreClassMemberSee -PackParseResultForStorageInEntityObject- for documentation.
ARCCore.PCollection.GetKeysEqualToValueARCCoreClassMemberReturns properties which themselves again have key and value equal to the given key and value.
ARCCore.PK.GetAllPKForEntityTypeARCCoreClassMemberReturns all property keys relevant for the given entity type,
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).
ARCCore.PK.GetAllPKForEntityTypeStringARCCoreClassMemberReturns all property keys relevant for the given entity type,
ARCCore.PCollection.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PK.BuildFromStringCacheARCCoreClassMemberBuilds the content of -_fromStringCache- and also -_allPKForEntityTypeCache-.
ARCCore.IGetKeysEqualToValueARCCoreClassInterface stating that implementing class does not use the default implementation of -GetKeysEqualToValue- (which does not use -Indexing-) but has replaced it with a more efficient implementation assumed to utilize -Indexing-.
ARCCore.PK.GetTypeMappingARCCoreClassMemberReturns the relevant property key for a given type entity-type and field-type.
ARCCore.PConcurrentARCCoreClassA (somewhat) thread-safe alternative to -PRich- which also supports -ExposingApplicationState- (through -Logger-).
ARCCore.PKLogAttribute.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.PConcurrent.ToStringARCCoreClassMemberTODO: Decide on what we actually want with ToString for this class.
ARCCore.PKLogAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PValue<T>ARCCoreClassSingle value storage.
ARCCore.PKLogAttribute.DoNotLogAtAllARCCoreClassMemberSee -DoNotLogAtAll-.
ARCCore.PValue<T>.TrySetPARCCoreClassMemberNOTE: -TryStore- is explicit aware that -PValue- and -PValueEmpty-
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.PValue<T>.TryGetVARCCoreClassMemberSupports duck typing.
ARCCore.PKRelAttribute.EnforceReferentialIntegrityARCCoreClassMemberSee -EnforceReferentialIntegrity-.
ARCCore.PValue<T>.ConvertObjectToStringARCCoreClassMemberConverts object to string.
ARCCore.PKRelAttribute.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.PValue<T>.ToStringARCCoreClassMemberDo no cache this value, because memory consumption would then increase significantly in your applicationj
ARCCore.PKTypeAttribute.TryRemovePARCCoreClassMemberShould probably never be used.
ARCCore.PValue<T>.DeepCopyARCCoreClassMemberNote that if the generic type (T) is not immutable, then what we return will not be a truly deep copy
ARCCore.PKTypeAttribute.TypeARCCoreClassMemberSee -Type-.
ARCCore.PValue<T>..ctorARCCoreClassMemberNote how this class does not have a parameter-less constructor (unlike all other -IP--derived classes in AgoRapide)
ARCCore.IPARCCoreClassIP = IProperty.
ARCCore.PValueEmptyARCCoreClassRepresents the 'no value'.
ARCCore.IP.TryGetV Overload2ARCCoreClassMemberThe actual value of the property. Mostly relevant for single-value properties like -PValue-.
ARCCore.ClientUpdatePosition.IsAtEndOfStreamARCCoreClassMemberNecessary in order to implement -AdHocQuery-.
ARCCore.IP.ToJSONSerializeableARCCoreClassMemberPrepares the data into a format acceptable for System.Text.Json.JsonSerializer.Serialize.
ARCCore.ClientUpdatePosition.ClientDatastoreIsEmptyInstanceARCCoreClassMemberSee also -ClientDatastoreIsEmpty.
ARCCore.IP.GetValueForJSONSerializerARCCoreClassMemberMakes the following modifications to the data:

Generated 2026-11-05 19:28:49.677 UTC